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

package/dist/esm/utils/utils.js

@@ -1,213 +1,238 @@
-import isServer from './is-server';
-/**
- * note: encodeURIComponent is available via browser (window) or natively in node.js
- * if you use another js engine for server-side rendering you may not have native encodeURIComponent
- * and would then need to install a package for that functionality
- * @param {ParsedUrlQueryInput} params query string parameters
- * @returns {string} query string
- */
-function getQueryString(params) {
-    return Object.keys(params)
-        .map((k) => `${encodeURIComponent(k)}=${encodeURIComponent(String(params[k]))}`)
-        .join('&');
-}
-/**
- * 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 function resolveUrl(urlBase, params = {}) {
-    if (!urlBase) {
-        throw new RangeError('url must be a non-empty string');
-    }
-    // This is a better way to work with URLs since it handles different user input
-    // edge cases. This works in Node and all browser except IE11.
-    // https://developer.mozilla.org/en-US/docs/Web/API/URL
-    // TODO: Verify our browser support requirements.
-    if (isServer()) {
-        const url = new URL(urlBase);
-        for (const key in params) {
-            if ({}.hasOwnProperty.call(params, key)) {
-                url.searchParams.append(key, String(params[key]));
-            }
-        }
-        const result = url.toString();
-        return result;
-    }
-    const qs = getQueryString(params);
-    const result = urlBase.indexOf('?') !== -1 ? `${urlBase}&${qs}` : `${urlBase}?${qs}`;
-    return result;
-}
-export const isAbsoluteUrl = (url) => {
-    if (!url) {
-        return false;
-    }
-    if (typeof url !== 'string') {
-        throw new TypeError('Expected a string');
-    }
-    return /^[a-z][a-z0-9+.-]*:/.test(url);
-};
-/**
- * Indicates whether the error is a timeout error
- * @param {unknown} error error
- * @returns {boolean} is timeout error
- */
-export const isTimeoutError = (error) => {
-    var _a;
-    return ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 408 || error.name === 'AbortError';
-};
-/**
- * Converts a string value in a regex pattern allowing wildcard matching
- * @param {string} pattern input with wildcards i.e. site.*.com
- * @returns {string} modified string that can be used as regexp input
- */
-const convertToWildcardRegex = (pattern) => {
-    return '^' + pattern.replace(/\//g, '\\/').replace(/\./g, '\\.').replace(/\*/g, '.*') + '$';
-};
-/**
- * Gets allowed origins from JSS_ALLOWED_ORIGINS env variable
- * @returns {string[]} list of allowed origins from JSS_ALLOWED_ORIGINS env variable
- */
-export const getAllowedOriginsFromEnv = () => process.env.JSS_ALLOWED_ORIGINS
-    ? process.env.JSS_ALLOWED_ORIGINS.replace(' ', '').split(',')
-    : [];
-/**
- * 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 const enforceCors = (req, res, allowedOrigins) => {
-    // origin in not present for non-CORS requests (e.g. server-side) - so we skip the checks
-    if (!req.headers.origin) {
-        return true;
-    }
-    // 3 sources of allowed origins are considered:
-    // the env value
-    const defaultAllowedOrigins = getAllowedOriginsFromEnv();
-    // the allowedOrigins prop
-    allowedOrigins = defaultAllowedOrigins.concat(allowedOrigins || []);
-    // and the existing CORS header, if present (i.e. set by nextjs config)
-    const presetCors = res.getHeader('Access-Control-Allow-Origin');
-    if (presetCors) {
-        allowedOrigins.push(presetCors);
-    }
-    const origin = req.headers.origin;
-    if (origin &&
-        allowedOrigins.some((allowedOrigin) => origin === allowedOrigin || new RegExp(convertToWildcardRegex(allowedOrigin)).test(origin))) {
-        res.setHeader('Access-Control-Allow-Origin', origin);
-        res.setHeader('Access-Control-Allow-Methods', 'GET, POST, OPTIONS, DELETE, PUT, PATCH');
-        // set the allowed headers for preflight requests
-        if (req.method === 'OPTIONS') {
-            res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');
-        }
-        return true;
-    }
-    return false;
-};
-export const getEnforcedCorsHeaders = ({ requestMethod, headers, presetCorsHeader, allowedOrigins = [], }) => {
-    // ugly but gotta satisfy both node.js and web fetch Headers interface somehow
-    const origin = headers.get
-        ? headers.get('origin')
-        : headers.origin;
-    if (!origin) {
-        return {};
-    }
-    // 3 sources of allowed origins are considered:
-    // the env value
-    const defaultAllowedOrigins = getAllowedOriginsFromEnv();
-    // the allowedOrigins prop
-    allowedOrigins = defaultAllowedOrigins.concat(allowedOrigins || []);
-    // and the existing CORS header, if provided (i.e. from nextjs config)
-    if (presetCorsHeader) {
-        allowedOrigins.push(presetCorsHeader);
-    }
-    if (origin &&
-        allowedOrigins.some((allowedOrigin) => origin === allowedOrigin || new RegExp(convertToWildcardRegex(allowedOrigin)).test(origin))) {
-        const corsHeaders = {
-            'Access-Control-Allow-Origin': origin,
-            'Access-Control-Allow-Methods': 'GET, POST, OPTIONS, DELETE, PUT, PATCH',
-        };
-        // set the allowed headers for preflight requests
-        if (requestMethod === 'OPTIONS') {
-            corsHeaders['Access-Control-Allow-Headers'] = 'Content-Type, Authorization';
-        }
-        return corsHeaders;
-    }
-    return 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 const isRegexOrUrl = (input) => {
-    // Remove the trailing slash.
-    input = input.slice(0, -1);
-    // Check if the string resembles a URL.
-    const isUrlLike = /^\/[a-zA-Z0-9\-\/]+(\?([a-zA-Z0-9\-_]+=[a-zA-Z0-9\-_]+)(&[a-zA-Z0-9\-_]+=[a-zA-Z0-9\-_]+)*)?$/.test(input);
-    if (isUrlLike) {
-        return 'url';
-    }
-    // If it doesn't resemble a URL, it's likely a regular expression.
-    return 'regex';
-};
-/**
- * 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 const areURLSearchParamsEqual = (params1, params2) => {
-    // Generates a sorted string representation of URL search parameters.
-    const getSortedParamsString = (params) => {
-        return [...params.entries()]
-            .sort(([keyA], [keyB]) => keyA.localeCompare(keyB))
-            .map(([key, value]) => `${key}=${value}`)
-            .join('&');
-    };
-    // Compare the sorted strings of both parameter sets.
-    return getSortedParamsString(params1) === getSortedParamsString(params2);
-};
-/**
- * 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 const escapeNonSpecialQuestionMarks = (input) => {
-    // If the input is already a regex pattern (starts with ^ or ends with $), return it unchanged
-    if (input.startsWith('^') || input.endsWith('$')) {
-        return input;
-    }
-    // For non-regex strings, escape literal "?" characters
-    return input.replace(/\?/g, '\\?');
-};
-/**
- * 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 const mergeURLSearchParams = (params1, params2) => {
-    const merged = new URLSearchParams();
-    // Add all keys and values from the first object.
-    for (const [key, value] of params1.entries()) {
-        merged.set(key, value);
-    }
-    // Add all keys and values from the second object, replacing existing ones.
-    for (const [key, value] of params2.entries()) {
-        merged.set(key, value);
-    }
-    return merged.toString();
-};
+import isServer from './is-server';
+/**
+ * note: encodeURIComponent is available via browser (window) or natively in node.js
+ * if you use another js engine for server-side rendering you may not have native encodeURIComponent
+ * and would then need to install a package for that functionality
+ * @param {ParsedUrlQueryInput} params query string parameters
+ * @returns {string} query string
+ */
+function getQueryString(params) {
+    return Object.keys(params)
+        .map((k) => `${encodeURIComponent(k)}=${encodeURIComponent(String(params[k]))}`)
+        .join('&');
+}
+/**
+ * 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 function resolveUrl(urlBase, params = {}) {
+    if (!urlBase) {
+        throw new RangeError('url must be a non-empty string');
+    }
+    // This is a better way to work with URLs since it handles different user input
+    // edge cases. This works in Node and all browser except IE11.
+    // https://developer.mozilla.org/en-US/docs/Web/API/URL
+    // TODO: Verify our browser support requirements.
+    if (isServer()) {
+        const url = new URL(urlBase);
+        for (const key in params) {
+            if ({}.hasOwnProperty.call(params, key)) {
+                url.searchParams.append(key, String(params[key]));
+            }
+        }
+        const result = url.toString();
+        return result;
+    }
+    const qs = getQueryString(params);
+    const result = urlBase.indexOf('?') !== -1 ? `${urlBase}&${qs}` : `${urlBase}?${qs}`;
+    return result;
+}
+/**
+ * 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 const isAbsoluteUrl = (url) => {
+    if (!url) {
+        return false;
+    }
+    if (typeof url !== 'string') {
+        throw new TypeError('Expected a string');
+    }
+    return /^[a-z][a-z0-9+.-]*:/.test(url);
+};
+/**
+ * Indicates whether the error is a timeout error
+ * @param {unknown} error error
+ * @returns {boolean} is timeout error
+ * @public
+ */
+export const isTimeoutError = (error) => {
+    var _a;
+    return ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 408 || error.name === 'AbortError';
+};
+/**
+ * Converts a string value in a regex pattern allowing wildcard matching
+ * @param {string} pattern input with wildcards i.e. site.*.com
+ * @returns {string} modified string that can be used as regexp input
+ */
+const convertToWildcardRegex = (pattern) => {
+    return '^' + pattern.replace(/\//g, '\\/').replace(/\./g, '\\.').replace(/\*/g, '.*') + '$';
+};
+/**
+ * Gets allowed origins from JSS_ALLOWED_ORIGINS env variable
+ * @returns {string[]} list of allowed origins from JSS_ALLOWED_ORIGINS env variable
+ * @public
+ */
+export const getAllowedOriginsFromEnv = () => process.env.JSS_ALLOWED_ORIGINS
+    ? process.env.JSS_ALLOWED_ORIGINS.replace(' ', '').split(',')
+    : [];
+/**
+ * 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 const enforceCors = (req, res, allowedOrigins) => {
+    // origin in not present for non-CORS requests (e.g. server-side) - so we skip the checks
+    if (!req.headers.origin) {
+        return true;
+    }
+    // 3 sources of allowed origins are considered:
+    // the env value
+    const defaultAllowedOrigins = getAllowedOriginsFromEnv();
+    // the allowedOrigins prop
+    allowedOrigins = defaultAllowedOrigins.concat(allowedOrigins || []);
+    // and the existing CORS header, if present (i.e. set by nextjs config)
+    const presetCors = res.getHeader('Access-Control-Allow-Origin');
+    if (presetCors) {
+        allowedOrigins.push(presetCors);
+    }
+    const origin = req.headers.origin;
+    if (origin &&
+        allowedOrigins.some((allowedOrigin) => origin === allowedOrigin || new RegExp(convertToWildcardRegex(allowedOrigin)).test(origin))) {
+        res.setHeader('Access-Control-Allow-Origin', origin);
+        res.setHeader('Access-Control-Allow-Methods', 'GET, POST, OPTIONS, DELETE, PUT, PATCH');
+        // set the allowed headers for preflight requests
+        if (req.method === 'OPTIONS') {
+            res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');
+        }
+        return true;
+    }
+    return false;
+};
+/**
+ * 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 const getEnforcedCorsHeaders = ({ requestMethod, headers, presetCorsHeader, allowedOrigins = [], }) => {
+    // ugly but gotta satisfy both node.js and web fetch Headers interface somehow
+    const origin = headers.get
+        ? headers.get('origin')
+        : headers.origin;
+    if (!origin) {
+        return {};
+    }
+    // 3 sources of allowed origins are considered:
+    // the env value
+    const defaultAllowedOrigins = getAllowedOriginsFromEnv();
+    // the allowedOrigins prop
+    allowedOrigins = defaultAllowedOrigins.concat(allowedOrigins || []);
+    // and the existing CORS header, if provided (i.e. from nextjs config)
+    if (presetCorsHeader) {
+        allowedOrigins.push(presetCorsHeader);
+    }
+    if (origin &&
+        allowedOrigins.some((allowedOrigin) => origin === allowedOrigin || new RegExp(convertToWildcardRegex(allowedOrigin)).test(origin))) {
+        const corsHeaders = {
+            'Access-Control-Allow-Origin': origin,
+            'Access-Control-Allow-Methods': 'GET, POST, OPTIONS, DELETE, PUT, PATCH',
+            'x-middleware-cache': 'no-cache',
+            'Cache-Control': 'no-store, must-revalidate',
+        };
+        // set the allowed headers for preflight requests
+        if (requestMethod === 'OPTIONS') {
+            corsHeaders['Access-Control-Allow-Headers'] = 'Content-Type, Authorization';
+        }
+        return corsHeaders;
+    }
+    return 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 const isRegexOrUrl = (input) => {
+    // Remove the trailing slash.
+    input = input.slice(0, -1);
+    // Check if the string resembles a URL.
+    const isUrlLike = /^\/[a-zA-Z0-9\-\/]+(\?([a-zA-Z0-9\-_]+=[a-zA-Z0-9\-_]+)(&[a-zA-Z0-9\-_]+=[a-zA-Z0-9\-_]+)*)?$/.test(input);
+    if (isUrlLike) {
+        return 'url';
+    }
+    // If it doesn't resemble a URL, it's likely a regular expression.
+    return 'regex';
+};
+/**
+ * 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 const areURLSearchParamsEqual = (params1, params2) => {
+    // Generates a sorted string representation of URL search parameters.
+    const getSortedParamsString = (params) => {
+        return [...params.entries()]
+            .sort(([keyA], [keyB]) => keyA.localeCompare(keyB))
+            .map(([key, value]) => `${key}=${value}`)
+            .join('&');
+    };
+    // Compare the sorted strings of both parameter sets.
+    return getSortedParamsString(params1) === getSortedParamsString(params2);
+};
+/**
+ * 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 const escapeNonSpecialQuestionMarks = (input) => {
+    // If the input is already a regex pattern (starts with ^ or ends with $), return it unchanged
+    if (input.startsWith('^') || input.endsWith('$')) {
+        return input;
+    }
+    // For non-regex strings, escape literal "?" characters
+    return input.replace(/\?/g, '\\?');
+};
+/**
+ * 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 const mergeURLSearchParams = (params1, params2) => {
+    const merged = new URLSearchParams();
+    // Add all keys and values from the first object.
+    for (const [key, value] of params1.entries()) {
+        merged.set(key, value);
+    }
+    // Add all keys and values from the second object, replacing existing ones.
+    for (const [key, value] of params2.entries()) {
+        merged.set(key, value);
+    }
+    return merged.toString();
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "1.3.0-canary.9",
+  "version": "1.4.0-canary.2",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -15,7 +15,9 @@
     "test": "mocha \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/core --entryPoints src/index.ts --entryPoints src/config/index.ts --entryPoints src/client/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --entryPoints src/tools/index.ts --entryPoints src/codegen/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/core --entryPoints src/index.ts --entryPoints src/config/index.ts --entryPoints src/client/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --entryPoints src/tools/index.ts --entryPoints src/codegen/index.ts --githubPages false",
+    "api-extractor": "npm run build && api-extractor run --local --verbose",
+    "api-extractor:verify": "api-extractor run"
   },
   "engines": {
     "node": ">=22"
@@ -85,11 +87,77 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "0d8d7e51f8e2936401b42dd3ace082abf748a27a",
+  "gitHead": "a566163f138188b5b3d22dbf2d87f373a1eb0715",
   "files": [
     "dist",
     "types",
-    "/*.js",
     "/*.d.ts"
-  ]
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./client": {
+      "import": "./dist/esm/client/index.js",
+      "require": "./dist/cjs/client/index.js",
+      "types": "./types/client/index.d.ts"
+    },
+    "./config": {
+      "import": "./dist/esm/config/index.js",
+      "require": "./dist/cjs/config/index.js",
+      "types": "./types/config/index.d.ts"
+    },
+    "./config-cli": {
+      "import": "./dist/esm/config-cli/index.js",
+      "require": "./dist/cjs/config-cli/index.js",
+      "types": "./types/config-cli/index.d.ts"
+    },
+    "./codegen": {
+      "import": "./dist/esm/editing/codegen/index.js",
+      "require": "./dist/cjs/editing/codegen/index.js",
+      "types": "./types/editing/codegen/index.d.ts"
+    },
+    "./editing": {
+      "import": "./dist/esm/editing/index.js",
+      "require": "./dist/cjs/editing/index.js",
+      "types": "./types/editing/index.d.ts"
+    },
+    "./i18n": {
+      "import": "./dist/esm/i18n/index.js",
+      "require": "./dist/cjs/i18n/index.js",
+      "types": "./types/i18n/index.d.ts"
+    },
+    "./layout": {
+      "import": "./dist/esm/layout/index.js",
+      "require": "./dist/cjs/layout/index.js",
+      "types": "./types/layout/index.d.ts"
+    },
+    "./media": {
+      "import": "./dist/esm/media/index.js",
+      "require": "./dist/cjs/media/index.js",
+      "types": "./types/media/index.d.ts"
+    },
+    "./personalize": {
+      "import": "./dist/esm/personalize/index.js",
+      "require": "./dist/cjs/personalize/index.js",
+      "types": "./types/personalize/index.d.ts"
+    },
+    "./site": {
+      "import": "./dist/esm/site/index.js",
+      "require": "./dist/cjs/site/index.js",
+      "types": "./types/site/index.d.ts"
+    },
+    "./tools": {
+      "import": "./dist/esm/tools/index.js",
+      "require": "./dist/cjs/tools/index.js",
+      "types": "./types/tools/index.d.ts"
+    },
+    "./utils": {
+      "import": "./dist/esm/utils/index.js",
+      "require": "./dist/cjs/utils/index.js",
+      "types": "./types/utils/index.d.ts"
+    }
+  }
 }