@sitecore-content-sdk/react 1.3.0-canary.9 → 1.4.0-canary.2

package/types/search/useSearch.d.ts

@@ -0,0 +1,107 @@
+import { SearchDocument, SearchParameters } from '@sitecore-content-sdk/search';
+import { SearchStatus } from './utils';
+/**
+ * Options for the useSearch hook.
+ * @public
+ */
+export interface UseSearchOptions<T extends SearchDocument = SearchDocument> {
+    /**
+     * The query string to search for.
+     * By default empty string is used.
+     */
+    query?: string;
+    /**
+     * The current page number (1-indexed).
+     * If not provided, the search will start on page 1.
+     */
+    page?: number;
+    /**
+     * The ID of the search index to use.
+     */
+    searchIndexId: string;
+    /**
+     * Number of results per page.
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * Specifies the sorting of the search results.
+     */
+    sort?: SearchParameters<T>['sort'];
+    /**
+     * Specifies whether the search should automatically run.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Specifies whether the previous search results should be kept when fetching new results.
+     * @default false
+     */
+    keepPreviousData?: boolean;
+}
+type InternalState<T extends SearchDocument = SearchDocument> = {
+    /**
+     * The search results.
+     */
+    results: T[];
+    /**
+     * Total number of results across all pages.
+     */
+    total: number;
+    /**
+     * Total number of pages available based on `total` and `pageSize`.
+     */
+    totalPages: number;
+    /**
+     * The error object if the last search request failed, or null if no error occurred.
+     */
+    error: Error | null;
+    /**
+     * The status of the search.
+     * It will be set to:
+     * - 'idle' if no search request has been made yet.
+     * - 'loading' if a search request is currently in progress.
+     * - 'success' if a search request was successful.
+     * - 'error' if a search request failed.
+     * @default 'idle'
+     */
+    status: SearchStatus;
+    /**
+     * The status of the previous search request.
+     * @default 'idle'
+     */
+    previousStatus: SearchStatus;
+};
+/**
+ * The state of the useSearch hook.
+ * @public
+ */
+export type UseSearchState<T extends SearchDocument = SearchDocument> = Omit<InternalState<T>, 'previousStatus'> & {
+    /**
+     * Whether a search request is currently in progress.
+     */
+    isLoading: boolean;
+    /**
+     * Whether the search request was successful.
+     */
+    isSuccess: boolean;
+    /**
+     * Whether the search request failed.
+     */
+    isError: boolean;
+    /**
+     * Whether the search results from the previous query are returned.
+     * Will be `true` if `keepPreviousData` is set.
+     */
+    isPreviousData: boolean;
+};
+/**
+ * React hook for performing search queries with pagination.
+ * @param {UseSearchOptions} options - Configuration options for the search hook.
+ * @returns {UseSearchState} The search state.
+ * @throws {Error} if the search index ID is not provided.
+ * @public
+ */
+export declare const useSearch: <T extends SearchDocument = SearchDocument>(options: UseSearchOptions<T>) => UseSearchState<T>;
+export {};
+//# sourceMappingURL=useSearch.d.ts.map

package/types/search/useSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSearch.d.ts","sourceRoot":"","sources":["../../src/search/useSearch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAgC,YAAY,EAAoB,MAAM,SAAS,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc;IACzE;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,KAAK,aAAa,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI;IAC9D;;OAEG;IACH,OAAO,EAAE,CAAC,EAAE,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB;;;;;;;;OAQG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,YAAY,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IAAI,IAAI,CAC1E,aAAa,CAAC,CAAC,CAAC,EAChB,gBAAgB,CACjB,GAAG;IACF;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,cAAc,GAAG,cAAc,EACjE,SAAS,gBAAgB,CAAC,CAAC,CAAC,KAC3B,cAAc,CAAC,CAAC,CAwHlB,CAAC"}

package/types/search/utils.d.ts

@@ -0,0 +1,19 @@
+import { SearchService } from '@sitecore-content-sdk/search';
+export declare const DEFAULT_PAGE_SIZE = 10;
+/**
+ * The status of a search request.
+ * @public
+ */
+export type SearchStatus = 'idle' | 'loading' | 'success' | 'error';
+/**
+ * Hook to initialize and manage SearchService.
+ */
+export declare function useSearchService(): SearchService | null;
+/**
+ * Calculates the number of items to skip before returning results.
+ * @param {number} page - The current page number (1-indexed).
+ * @param {number} pageSize - The number of results per page.
+ * @returns The number of items to skip before returning results.
+ */
+export declare const getOffset: (page: number, pageSize: number) => number;
+//# sourceMappingURL=utils.d.ts.map

package/types/search/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/search/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAI7D,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAEpE;;GAEG;AACH,wBAAgB,gBAAgB,yBAa/B;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,MAAM,EAAE,UAAU,MAAM,WAEvD,CAAC"}

package/types/server-actions/update-server-component-action.d.ts

@@ -0,0 +1,25 @@
+import { ComponentRendering } from '@sitecore-content-sdk/core/layout';
+import { ComponentPreviewEventArgs } from '@sitecore-content-sdk/core/codegen';
+export type ComponentUpdateModel = {
+    /**
+     * Unique identifier of the component being updated.
+     */
+    uid: string;
+    /**
+     * The updated component rendering data.
+     */
+    updatedComponent?: ComponentRendering;
+    /**
+     * The preview component event arguments in variant generation mode.
+     */
+    previewComponent?: ComponentPreviewEventArgs;
+};
+/**
+ * Server action to update global cache with the provided component updates received from Design Library.
+ * Stores the given {@link ComponentUpdateModel} in the global cache using a key based on the component UID.
+ * This enables dynamic rendering of server components inside Design Library
+ * @param {ComponentUpdateModel} componentUpdate - The component update model containing the UID and optional updated or preview component data.
+ * @returns A Promise that resolves when the cache has been updated.
+ */
+export declare function updateServerComponentAction(componentUpdate: ComponentUpdateModel): Promise<void>;
+//# sourceMappingURL=update-server-component-action.d.ts.map

package/types/server-actions/update-server-component-action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-server-component-action.d.ts","sourceRoot":"","sources":["../../src/server-actions/update-server-component-action.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAI/E,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;CAC9C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,2BAA2B,CAC/C,eAAe,EAAE,oBAAoB,GACpC,OAAO,CAAC,IAAI,CAAC,CAGf"}

package/types/utils.d.ts

@@ -1,17 +1,18 @@
-import { ComponentFields } from '@sitecore-content-sdk/core/layout';
-/**
- * "class" property will be transformed into or appended to "className" instead.
- * @param {string} otherAttrs all other props included on the image component
- * @returns {void}
- */
-export declare const addClassName: (otherAttrs: {
-    [key: string]: unknown;
-}) => void;
-/**
- * Used in FEAAS and BYOC implementations to convert datasource item field values into component props
- * @param {ComponentFields} fields field collection from Sitecore
- * @returns JSON object that can be used as props
- */
-export declare const getDataFromFields: (fields: ComponentFields) => {
-    [key: string]: unknown;
-};
+import { ComponentFields } from '@sitecore-content-sdk/core/layout';
+/**
+ * "class" property will be transformed into or appended to "className" instead.
+ * @param {string} otherAttrs all other props included on the image component
+ * @returns {void}
+ */
+export declare const addClassName: (otherAttrs: {
+    [key: string]: unknown;
+}) => void;
+/**
+ * Used in FEAAS and BYOC implementations to convert datasource item field values into component props
+ * @param {ComponentFields} fields field collection from Sitecore
+ * @returns JSON object that can be used as props
+ */
+export declare const getDataFromFields: (fields: ComponentFields) => {
+    [key: string]: unknown;
+};
+//# sourceMappingURL=utils.d.ts.map

package/types/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAiB,MAAM,mCAAmC,CAAC;AAEnF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,YAAY;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,KAAG,IAYrE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,eAAe,KAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAOnF,CAAC"}

package/types/components/DesignLibrary.d.ts

@@ -1,26 +0,0 @@
-import React from 'react';
-import * as codegen from '@sitecore-content-sdk/core/codegen';
-export declare const __mockDependencies: (mocks: any) => void;
-export type ImportMapImport = {
-    default: codegen.ImportEntry[];
-};
-type DesignLibraryProps = {
-    /**
-     * The dynamic import for import map to be used in variant generation mode.
-     * Currently it's optional but it will be required in the next major version.
-     */
-    loadImportMap?: () => Promise<ImportMapImport>;
-};
-/**
- * Design Library component.
- *
- * Renders the **real** Sitecore component for `library` / `library-metadata` modes and,
- * when generation is enabled (`page.mode.designLibrary.isVariantGeneration === true`),
- * wires the **variant generation** handshake so the parent (DL Studio) can send
- * generated code to preview and iterate on.
- * @param {DesignLibraryProps} props
- * @param {() => Promise<{ default: import('../codegen').ImportEntry[] }>} [props.loadImportMap] Optional async loader that resolves to the import-map used to resolve the generated component’s imports. Required when `isVariantGeneration` is true.
- * @returns {JSX.Element} The preview surface, or `null` when not in Design Library mode.
- */
-export declare const DesignLibrary: ({ loadImportMap }: DesignLibraryProps) => React.JSX.Element;
-export {};