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

package/types/utils/ensurePath.d.ts

@@ -1,6 +1,7 @@
-/**
- * Ensures that the directory path for the given file path exists.
- * If the directory does not exist, it will be created recursively.
- * @param {string} filePath - The file path for which to ensure the directory exists.
- */
-export declare const ensurePathExists: (filePath: string) => void;
+/**
+ * Ensures that the directory path for the given file path exists.
+ * If the directory does not exist, it will be created recursively.
+ * @param {string} filePath - The file path for which to ensure the directory exists.
+ */
+export declare const ensurePathExists: (filePath: string) => void;
+//# sourceMappingURL=ensurePath.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ensurePath.d.ts","sourceRoot":"","sources":["../../src/utils/ensurePath.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,MAAM,SAKhD,CAAC"}

package/types/utils/env.d.ts

@@ -1,7 +1,9 @@
-/**
- * Method to parse JSON-formatted environment variables
- * @param {string} envValue - can be undefined when providing values via process.env
- * @param {T} defaultValue - default value
- * @returns {T | string} parsed value
- */
-export declare const tryParseEnvValue: <T>(envValue: string | undefined, defaultValue: T) => T;
+/**
+ * Method to parse JSON-formatted environment variables
+ * @param {string} envValue - can be undefined when providing values via process.env
+ * @param {T} defaultValue - default value
+ * @returns {T | string} parsed value
+ * @public
+ */
+export declare const tryParseEnvValue: <T>(envValue: string | undefined, defaultValue: T) => T;
+//# sourceMappingURL=env.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../src/utils/env.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAAE,UAAU,MAAM,GAAG,SAAS,EAAE,cAAc,CAAC,KAAG,CAiBnF,CAAC"}

package/types/utils/globalCache.d.ts

@@ -0,0 +1,37 @@
+declare global {
+    var __dlCache: Record<string, unknown>;
+}
+/**
+ * Stores a value in the global cache under the specified key.
+ * - Initializes the cache object on `globalThis` if it does not exist.
+ * - Overwrites any existing value for the given key.
+ * @param {string} key - The cache key to set.
+ * @param {unknown} data - The value to store in the cache.
+ * @internal
+ */
+export declare function setCache(key: string, data: unknown): void;
+/**
+ * Retrieves a value from the global cache by key.
+ *  - The cache is stored on `globalThis`
+ * @param {string} key - The cache key to retrieve and remove.
+ * @returns {T} - The cached value if present, otherwise undefined.
+ * @internal
+ */
+export declare function getCache<T>(key: string): T | undefined;
+/**
+ * Retrieves a value from the global cache by key and removes it from the cache.
+ *  - The cache is stored on `globalThis`
+ * @param {string} key - The cache key to retrieve and remove.
+ * @returns {T} - The cached value if present, otherwise undefined.
+ * @internal
+ */
+export declare function getCacheAndClean<T>(key: string): T | undefined;
+/**
+ * Determines whether a cached value exists for the provided key
+ *  - The cache is stored on `globalThis`
+ * @param {string} key - The cache key to test for existence.
+ * @returns {boolean} - true if a value is present for the given key; otherwise false.
+ * @internal
+ */
+export declare function hasCache(key: string): boolean;
+//# sourceMappingURL=globalCache.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"globalCache.d.ts","sourceRoot":"","sources":["../../src/utils/globalCache.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAKzD;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAGtD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAK9D;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAG7C"}

package/types/utils/index.d.ts

@@ -1,3 +1,5 @@
-export { default as isServer } from './is-server';
-export { resolveUrl, isAbsoluteUrl, isTimeoutError, enforceCors, getEnforcedCorsHeaders, EnhancedOmit, getAllowedOriginsFromEnv, isRegexOrUrl, areURLSearchParamsEqual, escapeNonSpecialQuestionMarks, mergeURLSearchParams, } from './utils';
-export { tryParseEnvValue } from './env';
+export { default as isServer } from './is-server';
+export { resolveUrl, isAbsoluteUrl, isTimeoutError, enforceCors, getEnforcedCorsHeaders, EnhancedOmit, getAllowedOriginsFromEnv, isRegexOrUrl, areURLSearchParamsEqual, escapeNonSpecialQuestionMarks, mergeURLSearchParams, } from './utils';
+export { hasCache, getCache, getCacheAndClean, setCache } from './globalCache';
+export { tryParseEnvValue } from './env';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EACL,UAAU,EACV,aAAa,EACb,cAAc,EACd,WAAW,EACX,sBAAsB,EACtB,YAAY,EACZ,wBAAwB,EACxB,YAAY,EACZ,uBAAuB,EACvB,6BAA6B,EAC7B,oBAAoB,GACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC"}

package/types/utils/is-server.d.ts

@@ -1,6 +1,8 @@
-/**
- * Determines whether the current execution context is server-side
- * @returns true if executing server-side
- */
-declare function isServer(): boolean;
-export default isServer;
+/**
+ * Determines whether the current execution context is server-side
+ * @returns true if executing server-side
+ * @public
+ */
+declare function isServer(): boolean;
+export default isServer;
+//# sourceMappingURL=is-server.d.ts.map

package/types/utils/is-server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-server.d.ts","sourceRoot":"","sources":["../../src/utils/is-server.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,iBAAS,QAAQ,IAAI,OAAO,CAE3B;AAED,eAAe,QAAQ,CAAC"}

package/types/utils/normalize-url.d.ts

@@ -1 +1,2 @@
-export declare const normalizeUrl: (url: string) => string;
+export declare const normalizeUrl: (url: string) => string;
+//# sourceMappingURL=normalize-url.d.ts.map

package/types/utils/normalize-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-url.d.ts","sourceRoot":"","sources":["../../src/utils/normalize-url.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,GAAI,KAAK,MAAM,WAAiD,CAAC"}

package/types/utils/timeout-promise.d.ts

@@ -1,17 +1,18 @@
-/**
- * A helper to assign timeouts to fetch or other promises
- * Useful in nextjs middleware until fetch.signal is fully supported by Vercel edge functions
- */
-export default class TimeoutPromise {
-    private timeout;
-    timeoutId: NodeJS.Timeout | undefined;
-    constructor(timeout: number);
-    /**
-     * Creates a timeout promise
-     */
-    get start(): Promise<unknown>;
-    /**
-     * Clears the timeout from timeout promise
-     */
-    clear(): void;
-}
+/**
+ * A helper to assign timeouts to fetch or other promises
+ * Useful in nextjs middleware until fetch.signal is fully supported by Vercel edge functions
+ */
+export default class TimeoutPromise {
+    private timeout;
+    timeoutId: NodeJS.Timeout | undefined;
+    constructor(timeout: number);
+    /**
+     * Creates a timeout promise
+     */
+    get start(): Promise<unknown>;
+    /**
+     * Clears the timeout from timeout promise
+     */
+    clear(): void;
+}
+//# sourceMappingURL=timeout-promise.d.ts.map

package/types/utils/timeout-promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeout-promise.d.ts","sourceRoot":"","sources":["../../src/utils/timeout-promise.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IAGrB,OAAO,CAAC,OAAO;IAF3B,SAAS,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;gBAElB,OAAO,EAAE,MAAM;IAInC;;OAEG;IACH,IAAI,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAQ5B;IAED;;OAEG;IACH,KAAK;CAGN"}

package/types/utils/utils.d.ts

@@ -1,79 +1,104 @@
-import { IncomingHttpHeaders, IncomingMessage, OutgoingMessage } from 'http';
-import { ParsedUrlQueryInput } from 'querystring';
-/**
- * Omit properties from T that are in K. This is a simplified version of TypeScript's built-in `Omit` utility type.
- * Since default `Omit` doesn't support indexing types, we had to introduce this custom implementation.
- */
-export type EnhancedOmit<T, K extends PropertyKey> = {
-    [P in keyof T as Exclude<P, K>]: T[P];
-};
-/**
- * Resolves a base URL that may contain query string parameters and an additional set of query
- * string parameters into a unified string representation.
- * @param {string} urlBase the base URL that may contain query string parameters
- * @param {ParsedUrlQueryInput} params query string parameters
- * @returns a URL string
- * @throws {RangeError} if the provided url is an empty string
- */
-export declare function resolveUrl(urlBase: string, params?: ParsedUrlQueryInput): string;
-export declare const isAbsoluteUrl: (url: string) => boolean;
-/**
- * Indicates whether the error is a timeout error
- * @param {unknown} error error
- * @returns {boolean} is timeout error
- */
-export declare const isTimeoutError: (error: unknown) => boolean;
-/**
- * Gets allowed origins from JSS_ALLOWED_ORIGINS env variable
- * @returns {string[]} list of allowed origins from JSS_ALLOWED_ORIGINS env variable
- */
-export declare const getAllowedOriginsFromEnv: () => string[];
-/**
- * Tests origin from incoming request against allowed origins list that can be
- * set in JSS's JSS_ALLOWED_ORIGINS env variable, passed via allowedOrigins param and/or
- * be already set in Access-Control-Allow-Origin by other logic.
- * Applies Access-Control-Allow-Origin and Access-Control-Allow-Methods on match
- * Also applies Access-Control-Allow-Headers for preflight requests
- * @param {IncomingMessage} req incoming request
- * @param {OutgoingMessage} res response to set CORS headers for
- * @param {string[]} [allowedOrigins] additional list of origins to test against
- * @returns true if incoming origin matches the allowed lists, false when it does not
- * @deprecated use getEnforcedCorsHeaders instead
- */
-export declare const enforceCors: (req: IncomingMessage, res: OutgoingMessage, allowedOrigins?: string[]) => boolean;
-export declare const getEnforcedCorsHeaders: ({ requestMethod, headers, presetCorsHeader, allowedOrigins, }: {
-    requestMethod: string | undefined;
-    headers: IncomingHttpHeaders | Headers;
-    presetCorsHeader?: string | string[];
-    allowedOrigins?: string[];
-}) => {
-    [key: string]: string;
-} | null;
-/**
- * Determines whether the given input is a regular expression or resembles a URL.
- * @param {string} input - The input string to evaluate.
- * @returns {'regex' | 'url'} - Returns 'url' if the input looks like a URL, otherwise 'regex'.
- */
-export declare const isRegexOrUrl: (input: string) => "regex" | "url";
-/**
- * Compares two URLSearchParams objects to determine if they are equal.
- * @param {URLSearchParams} params1 - The first set of URL search parameters.
- * @param {URLSearchParams} params2 - The second set of URL search parameters.
- * @returns {boolean} - Returns true if the parameters are equal, otherwise false.
- */
-export declare const areURLSearchParamsEqual: (params1: URLSearchParams, params2: URLSearchParams) => boolean;
-/**
- * Escapes non-special "?" characters in a string or regex.
- * - For regex patterns that start with `^` or end with `$`, it returns the pattern unchanged.
- * - For other strings, it escapes literal "?" characters but preserves regex quantifiers and special patterns.
- * @param {string} input - The input string or regex pattern.
- * @returns {string} - The modified string or regex with non-special "?" characters escaped.
- */
-export declare const escapeNonSpecialQuestionMarks: (input: string) => string;
-/**
- * Merges two URLSearchParams objects. If both objects contain the same key, the value from the second object overrides the first.
- * @param {URLSearchParams} params1 - The first set of URL search parameters.
- * @param {URLSearchParams} params2 - The second set of URL search parameters.
- * @returns {string} - A string representation of the merged URL search parameters.
- */
-export declare const mergeURLSearchParams: (params1: URLSearchParams, params2: URLSearchParams) => string;
+import { IncomingHttpHeaders, IncomingMessage, OutgoingMessage } from 'http';
+import { ParsedUrlQueryInput } from 'querystring';
+/**
+ * Omit properties from T that are in K. This is a simplified version of TypeScript's built-in `Omit` utility type.
+ * Since default `Omit` doesn't support indexing types, we had to introduce this custom implementation.
+ * @public
+ */
+export type EnhancedOmit<T, K extends PropertyKey> = {
+    [P in keyof T as Exclude<P, K>]: T[P];
+};
+/**
+ * Resolves a base URL that may contain query string parameters and an additional set of query
+ * string parameters into a unified string representation.
+ * @param {string} urlBase the base URL that may contain query string parameters
+ * @param {ParsedUrlQueryInput} params query string parameters
+ * @returns a URL string
+ * @throws {RangeError} if the provided url is an empty string
+ * @public
+ */
+export declare function resolveUrl(urlBase: string, params?: ParsedUrlQueryInput): string;
+/**
+ * Checks if the given URL is an absolute URL
+ * @param {string} url - The URL to check.
+ * @returns {boolean} - Returns true if the URL is an absolute URL, otherwise false.
+ * @public
+ */
+export declare const isAbsoluteUrl: (url: string) => boolean;
+/**
+ * Indicates whether the error is a timeout error
+ * @param {unknown} error error
+ * @returns {boolean} is timeout error
+ * @public
+ */
+export declare const isTimeoutError: (error: unknown) => boolean;
+/**
+ * Gets allowed origins from JSS_ALLOWED_ORIGINS env variable
+ * @returns {string[]} list of allowed origins from JSS_ALLOWED_ORIGINS env variable
+ * @public
+ */
+export declare const getAllowedOriginsFromEnv: () => string[];
+/**
+ * Tests origin from incoming request against allowed origins list that can be
+ * set in JSS's JSS_ALLOWED_ORIGINS env variable, passed via allowedOrigins param and/or
+ * be already set in Access-Control-Allow-Origin by other logic.
+ * Applies Access-Control-Allow-Origin and Access-Control-Allow-Methods on match
+ * Also applies Access-Control-Allow-Headers for preflight requests
+ * @param {IncomingMessage} req incoming request
+ * @param {OutgoingMessage} res response to set CORS headers for
+ * @param {string[]} [allowedOrigins] additional list of origins to test against
+ * @returns true if incoming origin matches the allowed lists, false when it does not
+ * @deprecated use getEnforcedCorsHeaders instead
+ * @public
+ */
+export declare const enforceCors: (req: IncomingMessage, res: OutgoingMessage, allowedOrigins?: string[]) => boolean;
+/**
+ * Gets enforced CORS headers
+ * @param {string} requestMethod - The HTTP method of the request.
+ * @param {IncomingHttpHeaders | Headers} headers - The headers of the request.
+ * @param {string | string[]} presetCorsHeader - The preset CORS header.
+ * @param {string[]} [allowedOrigins] - The allowed origins.
+ * @returns {Record<string, string>} - The enforced CORS headers.
+ * @public
+ */
+export declare const getEnforcedCorsHeaders: ({ requestMethod, headers, presetCorsHeader, allowedOrigins, }: {
+    requestMethod: string | undefined;
+    headers: IncomingHttpHeaders | Headers;
+    presetCorsHeader?: string | string[];
+    allowedOrigins?: string[];
+}) => {
+    [key: string]: string;
+} | null;
+/**
+ * Determines whether the given input is a regular expression or resembles a URL.
+ * @param {string} input - The input string to evaluate.
+ * @returns {'regex' | 'url'} - Returns 'url' if the input looks like a URL, otherwise 'regex'.
+ * @public
+ */
+export declare const isRegexOrUrl: (input: string) => "regex" | "url";
+/**
+ * Compares two URLSearchParams objects to determine if they are equal.
+ * @param {URLSearchParams} params1 - The first set of URL search parameters.
+ * @param {URLSearchParams} params2 - The second set of URL search parameters.
+ * @returns {boolean} - Returns true if the parameters are equal, otherwise false.
+ * @public
+ */
+export declare const areURLSearchParamsEqual: (params1: URLSearchParams, params2: URLSearchParams) => boolean;
+/**
+ * Escapes non-special "?" characters in a string or regex.
+ * - For regex patterns that start with `^` or end with `$`, it returns the pattern unchanged.
+ * - For other strings, it escapes literal "?" characters but preserves regex quantifiers and special patterns.
+ * @param {string} input - The input string or regex pattern.
+ * @returns {string} - The modified string or regex with non-special "?" characters escaped.
+ * @public
+ */
+export declare const escapeNonSpecialQuestionMarks: (input: string) => string;
+/**
+ * Merges two URLSearchParams objects. If both objects contain the same key, the value from the second object overrides the first.
+ * @param {URLSearchParams} params1 - The first set of URL search parameters.
+ * @param {URLSearchParams} params2 - The second set of URL search parameters.
+ * @returns {string} - A string representation of the merged URL search parameters.
+ * @public
+ */
+export declare const mergeURLSearchParams: (params1: URLSearchParams, params2: URLSearchParams) => string;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAGlD;;;;GAIG;AAEH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAe/F;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,mBAAwB,GAAG,MAAM,CAuBpF;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,KAAK,MAAM,YAUxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,YAE5C,CAAC;AAWF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,gBAG7B,CAAC;AAET;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,GACtB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,iBAAiB,MAAM,EAAE,KACxB,OAmCF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,GAAI,+DAKpC;IACD,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC;IACvC,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;;QAuCA,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,KAAG,OAAO,GAAG,KAgBtD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,GAClC,SAAS,eAAe,EACxB,SAAS,eAAe,KACvB,OAWF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,GAAI,OAAO,MAAM,KAAG,MAQ7D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAC/B,SAAS,eAAe,EACxB,SAAS,eAAe,KACvB,MAcF,CAAC"}

package/client.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/client/index');

package/codegen.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/editing/codegen/index');

package/config-cli.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/config-cli/index');

package/config.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/config/index');

package/editing.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/editing/index');

package/i18n.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/i18n/index');

package/layout.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/layout/index');

package/media.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/media/index');

package/personalize.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/personalize/index');

package/site.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/site/index');

package/tools.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/tools/index');

package/utils.js

@@ -1 +0,0 @@
-module.exports = require('./dist/cjs/utils/index');