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

package/types/cache-client.d.ts

@@ -1,64 +1,68 @@
-/**
- * An interface for cache clients.
- * @template T The type of data being cached.
- */
-export interface CacheClient<T> {
-    /**
-     * Adds a value to the cache for the specified cache key.
-     * @param {string} key The cache key.
-     * @param {T} value The value to cache.
-     * @returns The value added to the cache.
-     */
-    setCacheValue(key: string, value: T): T;
-    /**
-     * Retrieves a value from the cache.
-     * @param {string} key The cache key.
-     * @returns The cache value as {T}, or null if the specified key was not found in the cache.
-     */
-    getCacheValue(key: string): T | null;
-}
-/**
- * Minimum configuration options for classes that implement @see CacheClient
- */
-export interface CacheOptions {
-    /**
-     * Enable/disable caching mechanism
-     * @default true
-     */
-    cacheEnabled?: boolean;
-    /**
-     * Cache timeout (sec)
-     * @default 60
-     */
-    cacheTimeout?: number;
-}
-/**
- * A cache client that uses the 'memory-cache' library (https://github.com/ptarjan/node-cache).
- * This class is meant to be extended or used as a mixin; it's not meant to be used directly.
- * @template T The type of data being cached.
- * @mixin
- */
-export declare class MemoryCacheClient<T> implements CacheClient<T> {
-    options: CacheOptions;
-    private cache;
-    /**
-     * Initializes a new instance of @see MemoryCacheClient using the provided @see CacheOptions
-     * @param {CacheOptions} options Configuration options
-     */
-    constructor(options: CacheOptions);
-    /**
-     * Retrieves a value from the cache.
-     * @template T The type of data being cached.
-     * @param {string} key The cache key.
-     * @returns The cache value as {T}, or null if the specified key is not found in the cache.
-     */
-    getCacheValue(key: string): T | null;
-    /**
-     * Adds a value to the cache for the specified cache key.
-     * @template T The type of data being cached.
-     * @param {string} key The cache key.
-     * @param {T} value The value to cache.
-     * @returns The value added to the cache.
-     */
-    setCacheValue(key: string, value: T): T;
-}
+/**
+ * An interface for cache clients.
+ * @template T The type of data being cached.
+ * @public
+ */
+export interface CacheClient<T> {
+    /**
+     * Adds a value to the cache for the specified cache key.
+     * @param {string} key The cache key.
+     * @param {T} value The value to cache.
+     * @returns The value added to the cache.
+     */
+    setCacheValue(key: string, value: T): T;
+    /**
+     * Retrieves a value from the cache.
+     * @param {string} key The cache key.
+     * @returns The cache value as {T}, or null if the specified key was not found in the cache.
+     */
+    getCacheValue(key: string): T | null;
+}
+/**
+ * Minimum configuration options for classes that implement @see CacheClient
+ * @public
+ */
+export interface CacheOptions {
+    /**
+     * Enable/disable caching mechanism
+     * @default true
+     */
+    cacheEnabled?: boolean;
+    /**
+     * Cache timeout (sec)
+     * @default 60
+     */
+    cacheTimeout?: number;
+}
+/**
+ * A cache client that uses the 'memory-cache' library (https://github.com/ptarjan/node-cache).
+ * This class is meant to be extended or used as a mixin; it's not meant to be used directly.
+ * @template T The type of data being cached.
+ * @mixin
+ * @public
+ */
+export declare class MemoryCacheClient<T> implements CacheClient<T> {
+    options: CacheOptions;
+    private cache;
+    /**
+     * Initializes a new instance of @see MemoryCacheClient using the provided @see CacheOptions
+     * @param {CacheOptions} options Configuration options
+     */
+    constructor(options: CacheOptions);
+    /**
+     * Retrieves a value from the cache.
+     * @template T The type of data being cached.
+     * @param {string} key The cache key.
+     * @returns The cache value as {T}, or null if the specified key is not found in the cache.
+     */
+    getCacheValue(key: string): T | null;
+    /**
+     * Adds a value to the cache for the specified cache key.
+     * @template T The type of data being cached.
+     * @param {string} key The cache key.
+     * @param {T} value The value to cache.
+     * @returns The value added to the cache.
+     */
+    setCacheValue(key: string, value: T): T;
+}
+//# sourceMappingURL=cache-client.d.ts.map

package/types/cache-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache-client.d.ts","sourceRoot":"","sources":["../src/cache-client.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B;;;;;OAKG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IAExC;;;;OAIG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC;CACtC;AAUD;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,qBAAa,iBAAiB,CAAC,CAAC,CAAE,YAAW,WAAW,CAAC,CAAC,CAAC;IAOtC,OAAO,EAAE,YAAY;IANxC,OAAO,CAAC,KAAK,CAAwB;IAErC;;;OAGG;gBACgB,OAAO,EAAE,YAAY;IAUxC;;;;;OAKG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAIpC;;;;;;OAMG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC;CAKxC"}

package/types/client/constants.d.ts

@@ -1,4 +1,5 @@
-/** @private */
-export declare const siteNameError = "The site name must be a non-empty string";
-/** @private */
-export declare const languageError = "The language must be a non-empty string";
+/** @private */
+export declare const siteNameError = "The site name must be a non-empty string";
+/** @private */
+export declare const languageError = "The language must be a non-empty string";
+//# sourceMappingURL=constants.d.ts.map

package/types/client/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/client/constants.ts"],"names":[],"mappings":"AAAA,eAAe;AACf,eAAO,MAAM,aAAa,6CAA6C,CAAC;AACxE,eAAe;AACf,eAAO,MAAM,aAAa,4CAA4C,CAAC"}

package/types/client/edge-proxy.d.ts

@@ -1,15 +1,18 @@
-/**
- * Generates a URL for accessing Sitecore Edge Platform Content using the provided endpoint and context ID.
- * @param {string} sitecoreEdgeContextId - The unique context id.
- * @param {string} [sitecoreEdgeUrl] - The base endpoint URL for the Edge Platform. Default is https://edge-platform.sitecorecloud.io
- * @returns {string} The complete URL for accessing content through the Edge Platform.
- */
-export declare const getEdgeProxyContentUrl: (sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string) => string;
-/**
- * Generates a URL for accessing Sitecore Edge Platform Forms using the provided form ID and context ID.
- * @param {string} sitecoreEdgeContextId - The unique context id.
- * @param {string} formId - The unique form id.
- * @param {string} [sitecoreEdgeUrl] - The base endpoint URL for the Edge Platform. Default is https://edge-platform.sitecorecloud.io
- * @returns {string} The complete URL for accessing forms through the Edge Platform.
- */
-export declare const getEdgeProxyFormsUrl: (sitecoreEdgeContextId: string, formId: string, sitecoreEdgeUrl?: string) => string;
+/**
+ * Generates a URL for accessing Sitecore Edge Platform Content using the provided endpoint and context ID.
+ * @param {string} sitecoreEdgeContextId - The unique context id.
+ * @param {string} [sitecoreEdgeUrl] - The base endpoint URL for the Edge Platform. Default is https://edge-platform.sitecorecloud.io
+ * @returns {string} The complete URL for accessing content through the Edge Platform.
+ * @public
+ */
+export declare const getEdgeProxyContentUrl: (sitecoreEdgeContextId: string, sitecoreEdgeUrl?: string) => string;
+/**
+ * Generates a URL for accessing Sitecore Edge Platform Forms using the provided form ID and context ID.
+ * @param {string} sitecoreEdgeContextId - The unique context id.
+ * @param {string} formId - The unique form id.
+ * @param {string} [sitecoreEdgeUrl] - The base endpoint URL for the Edge Platform. Default is https://edge-platform.sitecorecloud.io
+ * @returns {string} The complete URL for accessing forms through the Edge Platform.
+ * @internal
+ */
+export declare const getEdgeProxyFormsUrl: (sitecoreEdgeContextId: string, formId: string, sitecoreEdgeUrl?: string) => string;
+//# sourceMappingURL=edge-proxy.d.ts.map

package/types/client/edge-proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"edge-proxy.d.ts","sourceRoot":"","sources":["../../src/client/edge-proxy.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GACjC,uBAAuB,MAAM,EAC7B,wBAA2C,WAI6B,CAAC;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAC/B,uBAAuB,MAAM,EAC7B,QAAQ,MAAM,EACd,wBAA2C,WAIgC,CAAC"}

package/types/client/index.d.ts

@@ -1,7 +1,8 @@
-export { GraphQLClientError, GraphQLClient, GraphQLRequestClient, GraphQLRequestClientConfig, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, } from '../graphql-request-client';
-export { DefaultRetryStrategy } from '../retries';
-export { RetryStrategy, PageInfo, FetchOptions } from '../models';
-export { getEdgeProxyContentUrl, getEdgeProxyFormsUrl } from './edge-proxy';
-export { SitecoreClient, Page, PageOptions, SitemapXmlOptions, PageMode, ErrorPage, } from './sitecore-client';
-export { SitecoreClientInit } from './models';
-export { createGraphQLClientFactory, GraphQLClientOptions } from './utils';
+export { GraphQLClientError, GraphQLClient, GraphQLRequestClient, GraphQLRequestClientConfig, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, } from '../graphql-request-client';
+export { DefaultRetryStrategy } from '../retries';
+export { RetryStrategy, PageInfo, FetchOptions } from '../models';
+export { getEdgeProxyContentUrl, getEdgeProxyFormsUrl } from './edge-proxy';
+export { SitecoreClient, Page, PageOptions, SitemapXmlOptions, PageMode, ErrorPage, } from './sitecore-client';
+export { SitecoreClientInit } from './models';
+export { createGraphQLClientFactory, GraphQLClientOptions } from './utils';
+//# sourceMappingURL=index.d.ts.map

package/types/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,0BAA0B,EAC1B,2BAA2B,EAC3B,iCAAiC,GAClC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAC5E,OAAO,EACL,cAAc,EACd,IAAI,EACJ,WAAW,EACX,iBAAiB,EACjB,QAAQ,EACR,SAAS,GACV,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC"}

package/types/client/models.d.ts

@@ -1,19 +1,21 @@
-import { SitecoreConfig } from '../config';
-import { EditingService } from '../editing/editing-service';
-import { ComponentLayoutService } from '../editing/component-layout-service';
-import { DictionaryService } from '../i18n/dictionary-service';
-import { LayoutService } from '../layout/layout-service';
-import { ErrorPagesService, SitePathService } from '../site';
-/**
- * Init options for Sitecore Client that allows you to override services too
- */
-export type SitecoreClientInit = Omit<SitecoreConfig, 'multisite' | 'redirects' | 'personalize'> & {
-    custom?: {
-        layoutService?: LayoutService;
-        dictionaryService?: DictionaryService;
-        editingService?: EditingService;
-        errorPagesService?: ErrorPagesService;
-        componentService?: ComponentLayoutService;
-        sitePathService?: SitePathService;
-    };
-};
+import { SitecoreConfig } from '../config';
+import { EditingService } from '../editing/editing-service';
+import { ComponentLayoutService } from '../editing/component-layout-service';
+import { DictionaryService } from '../i18n/dictionary-service';
+import { LayoutService } from '../layout/layout-service';
+import { ErrorPagesService, SitePathService } from '../site';
+/**
+ * Init options for Sitecore Client that allows you to override services too
+ * @public
+ */
+export type SitecoreClientInit = Omit<SitecoreConfig, 'multisite' | 'redirects' | 'personalize'> & {
+    custom?: {
+        layoutService?: LayoutService;
+        dictionaryService?: DictionaryService;
+        editingService?: EditingService;
+        errorPagesService?: ErrorPagesService;
+        componentService?: ComponentLayoutService;
+        sitePathService?: SitePathService;
+    };
+};
+//# sourceMappingURL=models.d.ts.map

package/types/client/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/client/models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,cAAc,EAAE,WAAW,GAAG,WAAW,GAAG,aAAa,CAAC,GAAG;IACjG,MAAM,CAAC,EAAE;QACP,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;QAC1C,eAAe,CAAC,EAAE,eAAe,CAAC;KACnC,CAAC;CACH,CAAC"}