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

package/dist/cjs/tools/templating/utils.js

@@ -1,66 +1,67 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.matchPath = void 0;
-exports.getItems = getItems;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-/**
- * Compares two paths to determine if they match.
- * @param {string} itemPath base path to compare against, can be absolute or relative
- * @param {string} compare comparer, can be relate, absolute or regex string
- * @returns true if paths match, false otherwise
- */
-const matchPath = (itemPath, compare) => {
-    if (compare === itemPath ||
-        path_1.default.join(process.cwd(), itemPath) === compare ||
-        itemPath === path_1.default.join(process.cwd(), compare) ||
-        new RegExp(compare).test(itemPath)) {
-        return true;
-    }
-    return false;
-};
-exports.matchPath = matchPath;
-/**
- * Using @var path find all files and generate output using @var resolveItem function for each file
- * Can be used to generate list of components, templates, etc.
- * @param {GetItemsSettings} settings
- * @returns {Item[]} list of items
- */
-function getItems(settings) {
-    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), exclude, } = settings;
-    const items = [];
-    const folders = [];
-    if (!fs_1.default.existsSync(path))
-        return [];
-    if (exclude) {
-        for (const exclusion of exclude) {
-            if ((0, exports.matchPath)(path, exclusion))
-                return [];
-        }
-    }
-    fs_1.default.readdirSync(path, { withFileTypes: true }).forEach((item) => {
-        if (item.isDirectory()) {
-            folders.push(item);
-        }
-        if (fileFormat.test(item.name)) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const name = item.name.match(fileFormat)[1];
-            items.push(resolveItem(path, name));
-            cb && cb(name);
-        }
-    });
-    for (const folder of folders) {
-        recursive
-            ? items.push(...getItems({
-                path: `${path}/${folder.name}`,
-                resolveItem,
-                cb,
-                fileFormat,
-            }))
-            : items.push(resolveItem(`${path}/${folder.name}`, folder.name));
-    }
-    return items;
-}
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchPath = void 0;
+exports.getItems = getItems;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Compares two paths to determine if they match.
+ * @param {string} itemPath base path to compare against, can be absolute or relative
+ * @param {string} compare comparer, can be relate, absolute or regex string
+ * @returns true if paths match, false otherwise
+ * @public
+ */
+const matchPath = (itemPath, compare) => {
+    if (compare === itemPath ||
+        path_1.default.join(process.cwd(), itemPath) === compare ||
+        itemPath === path_1.default.join(process.cwd(), compare) ||
+        new RegExp(compare).test(itemPath)) {
+        return true;
+    }
+    return false;
+};
+exports.matchPath = matchPath;
+/**
+ * Using @var path find all files and generate output using @var resolveItem function for each file
+ * Can be used to generate list of components, templates, etc.
+ * @param {GetItemsSettings} settings
+ * @returns {Item[]} list of items
+ */
+function getItems(settings) {
+    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), exclude, } = settings;
+    const items = [];
+    const folders = [];
+    if (!fs_1.default.existsSync(path))
+        return [];
+    if (exclude) {
+        for (const exclusion of exclude) {
+            if ((0, exports.matchPath)(path, exclusion))
+                return [];
+        }
+    }
+    fs_1.default.readdirSync(path, { withFileTypes: true }).forEach((item) => {
+        if (item.isDirectory()) {
+            folders.push(item);
+        }
+        if (fileFormat.test(item.name)) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const name = item.name.match(fileFormat)[1];
+            items.push(resolveItem(path, name));
+            cb && cb(name);
+        }
+    });
+    for (const folder of folders) {
+        recursive
+            ? items.push(...getItems({
+                path: `${path}/${folder.name}`,
+                resolveItem,
+                cb,
+                fileFormat,
+            }))
+            : items.push(resolveItem(`${path}/${folder.name}`, folder.name));
+    }
+    return items;
+}

package/dist/cjs/utils/ensurePath.js

@@ -1,20 +1,20 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensurePathExists = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-/**
- * 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.
- */
-const ensurePathExists = (filePath) => {
-    const outputDir = path_1.default.dirname(filePath);
-    if (!fs_1.default.existsSync(outputDir)) {
-        fs_1.default.mkdirSync(outputDir, { recursive: true });
-    }
-};
-exports.ensurePathExists = ensurePathExists;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensurePathExists = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * 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.
+ */
+const ensurePathExists = (filePath) => {
+    const outputDir = path_1.default.dirname(filePath);
+    if (!fs_1.default.existsSync(outputDir)) {
+        fs_1.default.mkdirSync(outputDir, { recursive: true });
+    }
+};
+exports.ensurePathExists = ensurePathExists;

package/dist/cjs/utils/env.js

@@ -1,27 +1,28 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tryParseEnvValue = void 0;
-/**
- * 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
- */
-const tryParseEnvValue = (envValue, defaultValue) => {
-    if (!envValue) {
-        return defaultValue;
-    }
-    if (envValue.startsWith('{') && envValue.endsWith('}')) {
-        try {
-            return JSON.parse(envValue);
-            // eslint-disable-next-line no-unused-vars
-        }
-        catch (error) {
-            console.warn('Parsing of env variable failed');
-            console.warn(`Attempted to parse ${envValue}`);
-            return defaultValue;
-        }
-    }
-    return defaultValue;
-};
-exports.tryParseEnvValue = tryParseEnvValue;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tryParseEnvValue = void 0;
+/**
+ * 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
+ */
+const tryParseEnvValue = (envValue, defaultValue) => {
+    if (!envValue) {
+        return defaultValue;
+    }
+    if (envValue.startsWith('{') && envValue.endsWith('}')) {
+        try {
+            return JSON.parse(envValue);
+            // eslint-disable-next-line no-unused-vars
+        }
+        catch (error) {
+            console.warn('Parsing of env variable failed');
+            console.warn(`Attempted to parse ${envValue}`);
+            return defaultValue;
+        }
+    }
+    return defaultValue;
+};
+exports.tryParseEnvValue = tryParseEnvValue;

package/dist/cjs/utils/globalCache.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setCache = setCache;
+exports.getCache = getCache;
+exports.getCacheAndClean = getCacheAndClean;
+exports.hasCache = hasCache;
+/**
+ * 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
+ */
+function setCache(key, data) {
+    if (!globalThis.__dlCache) {
+        globalThis.__dlCache = {};
+    }
+    globalThis.__dlCache[key] = data;
+}
+/**
+ * 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
+ */
+function getCache(key) {
+    const cache = globalThis.__dlCache;
+    return cache === null || cache === void 0 ? void 0 : cache[key];
+}
+/**
+ * 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
+ */
+function getCacheAndClean(key) {
+    const cache = globalThis.__dlCache;
+    const data = cache === null || cache === void 0 ? void 0 : cache[key];
+    cache === null || cache === void 0 ? true : delete cache[key];
+    return data;
+}
+/**
+ * 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
+ */
+function hasCache(key) {
+    const cache = globalThis.__dlCache;
+    return (cache === null || cache === void 0 ? void 0 : cache[key]) !== undefined;
+}

package/dist/cjs/utils/index.js

@@ -1,21 +1,26 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tryParseEnvValue = exports.mergeURLSearchParams = exports.escapeNonSpecialQuestionMarks = exports.areURLSearchParamsEqual = exports.isRegexOrUrl = exports.getAllowedOriginsFromEnv = exports.getEnforcedCorsHeaders = exports.enforceCors = exports.isTimeoutError = exports.isAbsoluteUrl = exports.resolveUrl = exports.isServer = void 0;
-var is_server_1 = require("./is-server");
-Object.defineProperty(exports, "isServer", { enumerable: true, get: function () { return __importDefault(is_server_1).default; } });
-var utils_1 = require("./utils");
-Object.defineProperty(exports, "resolveUrl", { enumerable: true, get: function () { return utils_1.resolveUrl; } });
-Object.defineProperty(exports, "isAbsoluteUrl", { enumerable: true, get: function () { return utils_1.isAbsoluteUrl; } });
-Object.defineProperty(exports, "isTimeoutError", { enumerable: true, get: function () { return utils_1.isTimeoutError; } });
-Object.defineProperty(exports, "enforceCors", { enumerable: true, get: function () { return utils_1.enforceCors; } });
-Object.defineProperty(exports, "getEnforcedCorsHeaders", { enumerable: true, get: function () { return utils_1.getEnforcedCorsHeaders; } });
-Object.defineProperty(exports, "getAllowedOriginsFromEnv", { enumerable: true, get: function () { return utils_1.getAllowedOriginsFromEnv; } });
-Object.defineProperty(exports, "isRegexOrUrl", { enumerable: true, get: function () { return utils_1.isRegexOrUrl; } });
-Object.defineProperty(exports, "areURLSearchParamsEqual", { enumerable: true, get: function () { return utils_1.areURLSearchParamsEqual; } });
-Object.defineProperty(exports, "escapeNonSpecialQuestionMarks", { enumerable: true, get: function () { return utils_1.escapeNonSpecialQuestionMarks; } });
-Object.defineProperty(exports, "mergeURLSearchParams", { enumerable: true, get: function () { return utils_1.mergeURLSearchParams; } });
-var env_1 = require("./env");
-Object.defineProperty(exports, "tryParseEnvValue", { enumerable: true, get: function () { return env_1.tryParseEnvValue; } });
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tryParseEnvValue = exports.setCache = exports.getCacheAndClean = exports.getCache = exports.hasCache = exports.mergeURLSearchParams = exports.escapeNonSpecialQuestionMarks = exports.areURLSearchParamsEqual = exports.isRegexOrUrl = exports.getAllowedOriginsFromEnv = exports.getEnforcedCorsHeaders = exports.enforceCors = exports.isTimeoutError = exports.isAbsoluteUrl = exports.resolveUrl = exports.isServer = void 0;
+var is_server_1 = require("./is-server");
+Object.defineProperty(exports, "isServer", { enumerable: true, get: function () { return __importDefault(is_server_1).default; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "resolveUrl", { enumerable: true, get: function () { return utils_1.resolveUrl; } });
+Object.defineProperty(exports, "isAbsoluteUrl", { enumerable: true, get: function () { return utils_1.isAbsoluteUrl; } });
+Object.defineProperty(exports, "isTimeoutError", { enumerable: true, get: function () { return utils_1.isTimeoutError; } });
+Object.defineProperty(exports, "enforceCors", { enumerable: true, get: function () { return utils_1.enforceCors; } });
+Object.defineProperty(exports, "getEnforcedCorsHeaders", { enumerable: true, get: function () { return utils_1.getEnforcedCorsHeaders; } });
+Object.defineProperty(exports, "getAllowedOriginsFromEnv", { enumerable: true, get: function () { return utils_1.getAllowedOriginsFromEnv; } });
+Object.defineProperty(exports, "isRegexOrUrl", { enumerable: true, get: function () { return utils_1.isRegexOrUrl; } });
+Object.defineProperty(exports, "areURLSearchParamsEqual", { enumerable: true, get: function () { return utils_1.areURLSearchParamsEqual; } });
+Object.defineProperty(exports, "escapeNonSpecialQuestionMarks", { enumerable: true, get: function () { return utils_1.escapeNonSpecialQuestionMarks; } });
+Object.defineProperty(exports, "mergeURLSearchParams", { enumerable: true, get: function () { return utils_1.mergeURLSearchParams; } });
+var globalCache_1 = require("./globalCache");
+Object.defineProperty(exports, "hasCache", { enumerable: true, get: function () { return globalCache_1.hasCache; } });
+Object.defineProperty(exports, "getCache", { enumerable: true, get: function () { return globalCache_1.getCache; } });
+Object.defineProperty(exports, "getCacheAndClean", { enumerable: true, get: function () { return globalCache_1.getCacheAndClean; } });
+Object.defineProperty(exports, "setCache", { enumerable: true, get: function () { return globalCache_1.setCache; } });
+var env_1 = require("./env");
+Object.defineProperty(exports, "tryParseEnvValue", { enumerable: true, get: function () { return env_1.tryParseEnvValue; } });

package/dist/cjs/utils/is-server.js

@@ -1,10 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Determines whether the current execution context is server-side
- * @returns true if executing server-side
- */
-function isServer() {
-    return !(typeof window !== 'undefined' && window.document);
-}
-exports.default = isServer;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Determines whether the current execution context is server-side
+ * @returns true if executing server-side
+ * @public
+ */
+function isServer() {
+    return !(typeof window !== 'undefined' && window.document);
+}
+exports.default = isServer;

package/dist/cjs/utils/normalize-url.js

@@ -1,5 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeUrl = void 0;
-const normalizeUrl = (url) => (url.endsWith('/') ? url.slice(0, -1) : url);
-exports.normalizeUrl = normalizeUrl;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeUrl = void 0;
+const normalizeUrl = (url) => (url.endsWith('/') ? url.slice(0, -1) : url);
+exports.normalizeUrl = normalizeUrl;

package/dist/cjs/utils/timeout-promise.js

@@ -1,31 +1,31 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * A helper to assign timeouts to fetch or other promises
- * Useful in nextjs middleware until fetch.signal is fully supported by Vercel edge functions
- */
-class TimeoutPromise {
-    constructor(timeout) {
-        this.timeout = timeout;
-        this.timeoutId = undefined;
-    }
-    /**
-     * Creates a timeout promise
-     */
-    get start() {
-        return new Promise((_, reject) => {
-            this.timeoutId = setTimeout(() => {
-                const abortError = new Error(`Request timed out, timeout of ${this.timeout}ms is exceeded`);
-                abortError.name = 'AbortError';
-                reject(abortError);
-            }, this.timeout);
-        });
-    }
-    /**
-     * Clears the timeout from timeout promise
-     */
-    clear() {
-        this.timeoutId && clearTimeout(this.timeoutId);
-    }
-}
-exports.default = TimeoutPromise;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A helper to assign timeouts to fetch or other promises
+ * Useful in nextjs middleware until fetch.signal is fully supported by Vercel edge functions
+ */
+class TimeoutPromise {
+    constructor(timeout) {
+        this.timeout = timeout;
+        this.timeoutId = undefined;
+    }
+    /**
+     * Creates a timeout promise
+     */
+    get start() {
+        return new Promise((_, reject) => {
+            this.timeoutId = setTimeout(() => {
+                const abortError = new Error(`Request timed out, timeout of ${this.timeout}ms is exceeded`);
+                abortError.name = 'AbortError';
+                reject(abortError);
+            }, this.timeout);
+        });
+    }
+    /**
+     * Clears the timeout from timeout promise
+     */
+    clear() {
+        this.timeoutId && clearTimeout(this.timeoutId);
+    }
+}
+exports.default = TimeoutPromise;