feat(ngsp): add POST /manifest (#790)

https://coveord.atlassian.net/browse/CDX-1509

src/resources/BaseInterfaces.ts

@@ -7,15 +7,6 @@ export type PageModel<T = any, TItemsKey extends string = 'items'> = {
 
 export type New<T, K extends keyof T | null = null> = Omit<T, 'id' | NonNullable<K>>;
 
-export type NewHostedInterface<T, K extends keyof T | null = null> = Omit<
-    Partial<T> & {name: string},
-    'id' | 'created' | 'createdBy' | 'updated' | 'updatedBy' | NonNullable<K>
->;
-export type ExistingHostedInterface<T, K extends keyof T | null = null> = Omit<
-    T,
-    'id' | 'created' | 'createdBy' | 'updated' | 'updatedBy' | NonNullable<K>
->;
-
 export interface IdAndDisplayNameModel {
     id: string;
     displayName?: string;

src/resources/HostedInterfacesCore/HostedInterfaceCoreConfig.model.ts

@@ -169,3 +169,59 @@ export interface HostedInterfaceConfiguration {
      */
     tabs: HostedInterfaceTab[];
 }
+
+export interface IManifestResponse<Configuration> {
+    /**
+     * The HTML markup of the search interface along with configured placeholders.
+     */
+    markup: string;
+    /**
+     * The Atomic results configuration information.
+     */
+    results: IPageManifestResults;
+    /**
+     * The Atomic related styling in CSS format.
+     */
+    style: IPageManifestStyle;
+    /**
+     * The complete search interface configuration.
+     */
+    config: Configuration;
+}
+
+export interface IPageManifestResultTemplate {
+    /**
+     * The HTML markup of the content of the result template.
+     */
+    markup: string;
+    /**
+     * The Atomic [result template component](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-result-template/)'s properties.
+     */
+    attributes: Record<string, string>;
+}
+
+export interface IPageManifestResults {
+    /**
+     * The placeholder for the result list and result templates.
+     */
+    placeholder?: string;
+    /**
+     * The Atomic [result list component](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-result-list/#properties)'s properties.
+     */
+    attributes: Record<string, string>;
+    /**
+     * The Atomic result template configuration information.
+     */
+    templates: IPageManifestResultTemplate[];
+}
+
+export interface IPageManifestStyle {
+    /**
+     * The CSS to set [Atomic theme variables](https://docs.coveo.com/en/atomic/latest/usage/themes-and-visual-customization/#theme-variables).
+     */
+    theme: string;
+    /**
+     * The page layout CSS.
+     */
+    layout: string;
+}

src/resources/HostedInterfacesCore/HostedInterfaceVersionsCore.ts

@@ -1,4 +1,5 @@
 import {Paginated} from '../BaseInterfaces.js';
+import {SortingBy, SortingOrder} from '../Enums.js';
 
 export interface HostedInterfaceChangeInfo {
     /**
@@ -126,3 +127,75 @@ export interface RestoreInterfaceVersionParams {
      */
     label?: string;
 }
+
+export type NewHostedInterface<T, K extends keyof T | null = null> = Omit<
+    Partial<T> & {name: string},
+    'id' | 'created' | 'createdBy' | 'updated' | 'updatedBy' | NonNullable<K>
+>;
+export type ExistingHostedInterface<T, K extends keyof T | null = null> = Omit<
+    T,
+    'id' | 'created' | 'createdBy' | 'updated' | 'updatedBy' | NonNullable<K>
+>;
+
+export interface IAccesses {
+    /**
+     * The list of users that are allowed to access the search interface.
+     */
+    users: string[];
+
+    /**
+     * The list of domains that are allowed to access the search interface.
+     */
+    domains: string[];
+
+    /**
+     * When set to true, all users can share and see the search page.
+     */
+    sharingLinkEnabled?: boolean;
+
+    /**
+     * When set to true, the domain sharing is enabled. Otherwise, only users that have explicitly access to the search page can access it.
+     */
+    sharingDomainEnabled?: boolean;
+}
+
+export interface ISortCriteria {
+    /**
+     * Indicates the kind of sort criterion.
+     */
+    by: SortingBy;
+
+    /**
+     * Label of the sort criterion.
+     */
+    label: string;
+
+    /**
+     * Specify the sort order if applicable.
+     * Default value when sorting by date is descending.
+     * Default value when sorting by field is ascending.
+     * No sort order value is applicable when sorting by relevancy.
+     */
+    order?: SortingOrder;
+
+    /**
+     * The [field](https://docs.coveo.com/en/200) on which the sort is based on. For example: filetype.
+     * Required when sorting by field.
+     * This property is ignored unless you are sorting by field.
+     */
+    field?: string;
+}
+
+export interface IManifestParameters {
+    /**
+     * The placeholders for the page.
+     */
+    pagePlaceholders?: IPagePlaceholders;
+}
+
+export interface IPagePlaceholders {
+    /**
+     * A placeholder for the result list and result templates.
+     */
+    results?: string;
+}

src/resources/IPXInterfaces/IPXInterface.ts

@@ -1,6 +1,10 @@
 import API from '../../APICore.js';
-import {ExistingHostedInterface, NewHostedInterface, PageModel} from '../BaseInterfaces.js';
-import {ListHostedInterfacesParams} from '../HostedInterfacesCore/index.js';
+import {PageModel} from '../BaseInterfaces.js';
+import {
+    ExistingHostedInterface,
+    ListHostedInterfacesParams,
+    NewHostedInterface,
+} from '../HostedInterfacesCore/index.js';
 import Resource from '../Resource.js';
 import {IPXInterfaceConfiguration} from './IPXInterface.model.js';
 

src/resources/NextGenSearchPages/NextGenSearchPages.model.ts

@@ -5,7 +5,7 @@ import {
     HostedInterfaceResultTemplateBadge,
     IAccesses,
     ISortCriteria,
-} from '../index.js';
+} from '../HostedInterfacesCore/index.js';
 
 export enum SearchPageResultActions {
     copyToClipboard = 'copyToClipboard',

src/resources/NextGenSearchPages/NextGenSearchPages.ts

@@ -1,12 +1,14 @@
 import API from '../../APICore.js';
 import Resource from '../Resource.js';
+import {PageModel} from '../BaseInterfaces.js';
 import {
     ExistingHostedInterface,
     IAccesses,
+    IManifestParameters,
+    IManifestResponse,
     ListHostedInterfacesParams,
     NewHostedInterface,
-    PageModel,
-} from '../index.js';
+} from '../HostedInterfacesCore/index.js';
 import {SearchPageInterfaceConfiguration} from './NextGenSearchPages.model.js';
 
 export default class NextGenSearchPages extends Resource {
@@ -107,4 +109,11 @@ export default class NextGenSearchPages extends Resource {
     requestAccess(searchPageId: string): Promise<void> {
         return this.api.post<void>(`${NextGenSearchPages.baseUrl}/${searchPageId}/accesses/request`);
     }
+
+    manifest(
+        interfaceId: string,
+        options?: IManifestParameters,
+    ): Promise<IManifestResponse<SearchPageInterfaceConfiguration>> {
+        return this.api.post(`${NextGenSearchPages.baseUrl}/${interfaceId}/manifest`, options);
+    }
 }

src/resources/NextGenSearchPages/tests/NextGenSearchPages.spec.ts

@@ -1,12 +1,12 @@
 import API from '../../../APICore.js';
+import {SortingBy} from '../../Enums.js';
 import {
     ExistingHostedInterface,
     HostedInterfaceConditionOperator,
-    SearchPageInterfaceConfiguration,
-    SearchPageLayout,
-    SortingBy,
-} from '../../../Entry.js';
+    IManifestParameters,
+} from '../../HostedInterfacesCore/index.js';
 import NextGenSearchPages from '../NextGenSearchPages.js';
+import {SearchPageInterfaceConfiguration, SearchPageLayout} from '../NextGenSearchPages.model.js';
 jest.mock('../../../APICore.js');
 
 const APIMock: jest.Mock<API> = API as any;
@@ -327,4 +327,24 @@ describe('NextGenSearchPages', () => {
             expect(api.post).toHaveBeenCalledWith(`${NextGenSearchPages.baseUrl}/${id}/accesses/request`);
         });
     });
+
+    describe('manifest', () => {
+        it('makes a POST call (without a body) to the searchInterfaces accesses manifest url based on the interfaceId', () => {
+            const id = 'search-interface-id';
+
+            nextGenSearchPages.manifest(id);
+
+            expect(api.post).toHaveBeenCalledTimes(1);
+            expect(api.post).toHaveBeenCalledWith(`${NextGenSearchPages.baseUrl}/${id}/manifest`, undefined);
+        });
+
+        it('makes a POST call (with a body) to the searchInterfaces accesses manifest url based on the interfaceId', () => {
+            const id = 'search-interface-id';
+            const options: IManifestParameters = {pagePlaceholders: {results: 'myresults'}};
+            nextGenSearchPages.manifest(id, options);
+
+            expect(api.post).toHaveBeenCalledTimes(1);
+            expect(api.post).toHaveBeenCalledWith(`${NextGenSearchPages.baseUrl}/${id}/manifest`, options);
+        });
+    });
 });

src/resources/SearchInterfaces/SearchInterfaces.model.ts

@@ -1,27 +1,5 @@
 import {Paginated} from '../BaseInterfaces.js';
-import {SortingBy, SortingOrder} from '../Enums.js';
-
-export interface IAccesses {
-    /**
-     * The list of users that are allowed to access the search interface.
-     */
-    users: string[];
-
-    /**
-     * The list of domains that are allowed to access the search interface.
-     */
-    domains: string[];
-
-    /**
-     * When set to true, all users can share and see the search page.
-     */
-    sharingLinkEnabled?: boolean;
-
-    /**
-     * When set to true, the domain sharing is enabled. Otherwise, only users that have explicitly access to the search page can access it.
-     */
-    sharingDomainEnabled?: boolean;
-}
+import {IAccesses, ISortCriteria} from '../HostedInterfacesCore/index.js';
 
 export interface IFacet {
     /**
@@ -35,33 +13,6 @@ export interface IFacet {
     label: string;
 }
 
-export interface ISortCriteria {
-    /**
-     * Indicates the kind of sort criterion.
-     */
-    by: SortingBy;
-
-    /**
-     * Label of the sort criterion.
-     */
-    label: string;
-
-    /**
-     * Specify the sort order if applicable.
-     * Default value when sorting by date is descending.
-     * Default value when sorting by field is ascending.
-     * No sort order value is applicable when sorting by relevancy.
-     */
-    order?: SortingOrder;
-
-    /**
-     * The [field](https://docs.coveo.com/en/200) on which the sort is based on. For example: filetype.
-     * Required when sorting by field.
-     * This property is ignored unless you are sorting by field.
-     */
-    field?: string;
-}
-
 export interface ISearchInterfaceConfiguration {
     /**
      * The configuration identifier.
@@ -137,73 +88,3 @@ export interface IListSearchInterfacesParameters extends Paginated {
      */
     perPage?: number;
 }
-
-export interface IManifestParameters {
-    /**
-     * The placeholders for the page.
-     */
-    pagePlaceholders?: IPagePlaceholders;
-}
-
-export interface IPagePlaceholders {
-    /**
-     * A placeholder for the result list and result templates.
-     */
-    results?: string;
-}
-
-export interface IManifestResponse {
-    /**
-     * The HTML markup of the search interface along with configured placeholders.
-     */
-    markup: string;
-    /**
-     * The Atomic results configuration information.
-     */
-    results: IPageManifestResults;
-    /**
-     * The Atomic related styling in CSS format.
-     */
-    style: IPageManifestStyle;
-    /**
-     * The complete search interface configuration.
-     */
-    config: ISearchInterfaceConfigurationResponse;
-}
-
-export interface IPageManifestResultTemplate {
-    /**
-     * The HTML markup of the content of the result template.
-     */
-    markup: string;
-    /**
-     * The Atomic [result template component](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-result-template/)'s properties.
-     */
-    attributes: Record<string, string>;
-}
-
-export interface IPageManifestResults {
-    /**
-     * The placeholder for the result list and result templates.
-     */
-    placeholder?: string;
-    /**
-     * The Atomic [result list component](https://docs.coveo.com/en/atomic/latest/reference/components/atomic-result-list/#properties)'s properties.
-     */
-    attributes: Record<string, string>;
-    /**
-     * The Atomic result template configuration information.
-     */
-    templates: IPageManifestResultTemplate[];
-}
-
-export interface IPageManifestStyle {
-    /**
-     * The CSS to set [Atomic theme variables](https://docs.coveo.com/en/atomic/latest/usage/themes-and-visual-customization/#theme-variables).
-     */
-    theme: string;
-    /**
-     * The page layout CSS.
-     */
-    layout: string;
-}