@sitecore-content-sdk/core 0.2.0-beta.3 → 0.2.0-beta.5

package/content.d.ts

@@ -0,0 +1 @@
+export * from './types/content/index';

package/content.js

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

package/dist/cjs/client/graphql-edge-proxy.js

@@ -2,14 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getEdgeProxyFormsUrl = exports.getEdgeProxyContentUrl = void 0;
 const constants_1 = require("../constants");
-const normalizeUrl = (url) => (url.endsWith('/') ? url.slice(0, -1) : url);
+const normalize_url_1 = require("../utils/normalize-url");
 /**
  * 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.
  */
-const getEdgeProxyContentUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${normalizeUrl(sitecoreEdgeUrl)}/v1/content/api/graphql/v1?sitecoreContextId=${sitecoreEdgeContextId}`;
+const getEdgeProxyContentUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${(0, normalize_url_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/content/api/graphql/v1?sitecoreContextId=${sitecoreEdgeContextId}`;
 exports.getEdgeProxyContentUrl = getEdgeProxyContentUrl;
 /**
  * Generates a URL for accessing Sitecore Edge Platform Forms using the provided form ID and context ID.
@@ -18,5 +18,5 @@ exports.getEdgeProxyContentUrl = getEdgeProxyContentUrl;
  * @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.
  */
-const getEdgeProxyFormsUrl = (sitecoreEdgeContextId, formId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${normalizeUrl(sitecoreEdgeUrl)}/v1/forms/publisher/${formId}?sitecoreContextId=${sitecoreEdgeContextId}`;
+const getEdgeProxyFormsUrl = (sitecoreEdgeContextId, formId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${(0, normalize_url_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/forms/publisher/${formId}?sitecoreContextId=${sitecoreEdgeContextId}`;
 exports.getEdgeProxyFormsUrl = getEdgeProxyFormsUrl;

package/dist/cjs/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HIDDEN_RENDERING_NAME = exports.SITECORE_EDGE_URL_DEFAULT = exports.siteNameError = exports.SitecoreTemplateId = void 0;
+exports.DEFAULT_SITECORE_AUTH_AUDIENCE = exports.DEFAULT_SITECORE_AUTH_ENDPOINT = exports.HIDDEN_RENDERING_NAME = exports.SITECORE_EDGE_URL_DEFAULT = exports.siteNameError = exports.SitecoreTemplateId = void 0;
 var SitecoreTemplateId;
 (function (SitecoreTemplateId) {
     // /sitecore/templates/Foundation/JavaScript Services/App
@@ -11,3 +11,5 @@ var SitecoreTemplateId;
 exports.siteNameError = 'The siteName cannot be empty';
 exports.SITECORE_EDGE_URL_DEFAULT = 'https://edge-platform.sitecorecloud.io';
 exports.HIDDEN_RENDERING_NAME = 'Hidden Rendering';
+exports.DEFAULT_SITECORE_AUTH_ENDPOINT = 'https://auth.sitecorecloud.io/oauth/token';
+exports.DEFAULT_SITECORE_AUTH_AUDIENCE = 'https://api.sitecorecloud.io';

package/dist/cjs/content/content-client.js

@@ -0,0 +1,89 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentClient = void 0;
+const graphql_request_client_1 = require("../graphql-request-client");
+const utils_1 = require("./utils");
+const debug_1 = __importDefault(require("../debug"));
+const locales_1 = require("./locales");
+/**
+ * Class representing a client for interacting with the Content API.
+ */
+class ContentClient {
+    constructor({ url, tenant, environment, preview = false, token }) {
+        this.endpoint = (0, utils_1.getContentUrl)({
+            environment,
+            preview,
+            tenant,
+            url,
+        });
+        this.graphqlClient = new graphql_request_client_1.GraphQLRequestClient(this.endpoint, {
+            headers: {
+                Authorization: `Bearer ${token}`,
+            },
+            debugger: debug_1.default.content,
+        });
+    }
+    /**
+     * Factory method for creating a ContentClient instance. This method allows you to create a client with the values populated from environment variables or provided as arguments.
+     * @param {Partial<ContentClientOptions>} [options] - client configuration options
+     * @param {string} [options.url] - Content base graphql endpoint url. If not provided, it will be read from the SITECORE_CS_URL environment variable. Otherwise, it defaults to https://cs-graphqlapi-staging.sitecore-staging.cloud.
+     * @param {string} [options.tenant] - Tenant name. If not provided, it will be read from the SITECORE_CS_TENANT environment variable
+     * @param {string} [options.environment] - Environment name. If not provided, it will be read from the SITECORE_CS_ENVIRONMENT environment variable. Otherwise, it defaults to 'main'
+     * @param {boolean} [options.preview] - Indicates if preview mode is enabled. If not provided, it will be read from the SITECORE_CS_PREVIEW environment variable. Otherwise, it defaults to false
+     * @param {string} [options.token] - Token for authentication. If not provided, it will be read from the SITECORE_CS_TOKEN environment variable.
+     * @returns {ContentClient} ContentClient instance
+     * @throws {Error} If tenant or token is not provided
+     */
+    static createClient({ url, tenant, environment, preview, token, } = {}) {
+        const options = {
+            url: url || process.env.SITECORE_CS_URL,
+            tenant: tenant || process.env.SITECORE_CS_TENANT || '',
+            environment: environment || process.env.SITECORE_CS_ENVIRONMENT || 'main',
+            preview: preview || process.env.SITECORE_CS_PREVIEW === 'true',
+            token: token || process.env.SITECORE_CS_TOKEN || '',
+        };
+        if (!options.tenant) {
+            throw new Error('Tenant is required to be provided as an argument or as a SITECORE_CS_TENANT environment variable');
+        }
+        if (!options.token) {
+            throw new Error('Token is required to be provided as an argument or as a SITECORE_CS_TOKEN environment variable');
+        }
+        return new ContentClient(options);
+    }
+    /**
+     * Execute graphql request
+     * @param {string | DocumentNode} query graphql query
+     * @param {object} variables variables for the query
+     * @param {FetchOptions} options options for configuring the request
+     * @returns {T} response data
+     */
+    async get(query, variables = {}, options = {}) {
+        debug_1.default.content('fetching content data');
+        return this.graphqlClient.request(query, variables, options);
+    }
+    /**
+     * Retrieves the locale information for a given locale ID.
+     *
+     * @param id - The unique identifier of the locale item.
+     * @returns A promise that resolves to the locale information associated with the specified locale ID.
+     */
+    async getLocale(id) {
+        debug_1.default.content('Getting locale for id: %s', id);
+        const response = await this.get(locales_1.GET_LOCALE_QUERY, { id });
+        return response.locale;
+    }
+    /**
+     * Retrieves all available locales from the content service.
+     *
+     * @returns A promise that resolves to an array of locales.
+     */
+    async getLocales() {
+        debug_1.default.content('Getting all locales');
+        const response = await this.get(locales_1.GET_LOCALES_QUERY);
+        return response.manyLocale;
+    }
+}
+exports.ContentClient = ContentClient;

package/dist/cjs/content/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getContentUrl = exports.GET_LOCALES_QUERY = exports.GET_LOCALE_QUERY = exports.ContentClient = void 0;
+var content_client_1 = require("./content-client");
+Object.defineProperty(exports, "ContentClient", { enumerable: true, get: function () { return content_client_1.ContentClient; } });
+var locales_1 = require("./locales");
+Object.defineProperty(exports, "GET_LOCALE_QUERY", { enumerable: true, get: function () { return locales_1.GET_LOCALE_QUERY; } });
+Object.defineProperty(exports, "GET_LOCALES_QUERY", { enumerable: true, get: function () { return locales_1.GET_LOCALES_QUERY; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getContentUrl", { enumerable: true, get: function () { return utils_1.getContentUrl; } });

package/dist/cjs/content/locales.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GET_LOCALES_QUERY = exports.GET_LOCALE_QUERY = void 0;
+/**
+ * GraphQL query to retrieve a specific locale by its ID.
+ *
+ * Variables:
+ * - id: The ID of the locale to retrieve.
+ */
+exports.GET_LOCALE_QUERY = `
+  query GetLocaleById ($id: ID!) {
+    locale(id: $id) {
+      id
+      label
+    }
+  }
+`;
+/**
+ * GraphQL query to retrieve all available locales.
+ */
+exports.GET_LOCALES_QUERY = `
+  query GetAllLocales{
+    manyLocale {
+      id
+      label
+    }
+  }
+`;

package/dist/cjs/content/utils.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getContentUrl = getContentUrl;
+const normalize_url_1 = require("../utils/normalize-url");
+/**
+ * Get the Content graphql endpoint url
+ * @param {object} params Parameters
+ * @param {string} [params.url] Content base graphql endpoint url
+ * @param {string} params.tenant Tenant name
+ * @param {string} params.environment Environment name
+ * @param {boolean} params.preview Indicates if preview mode is enabled
+ * @returns {string} Content graphql endpoint url
+ */
+function getContentUrl({ url = 'https://cs-graphqlapi-staging.sitecore-staging.cloud', tenant, environment, preview, }) {
+    return `${(0, normalize_url_1.normalizeUrl)(url)}/api/graphql/v1/${tenant}/${environment}?preview=${preview}`;
+}

package/dist/cjs/debug.js

@@ -29,6 +29,7 @@ exports.enableDebug = enableDebug;
  */
 exports.default = {
     common: (0, debug_1.default)(`${rootNamespace}:common`),
+    content: (0, debug_1.default)(`${rootNamespace}:content`),
     form: (0, debug_1.default)(`${rootNamespace}:form`),
     http: (0, debug_1.default)(`${rootNamespace}:http`),
     layout: (0, debug_1.default)(`${rootNamespace}:layout`),

package/dist/cjs/editing/design-library.js

@@ -4,6 +4,7 @@ exports.updateComponentHandler = exports.addComponentUpdateHandler = exports.Des
 exports.getDesignLibraryStatusEvent = getDesignLibraryStatusEvent;
 exports.getDesignLibraryScriptLink = getDesignLibraryScriptLink;
 const constants_1 = require("../constants");
+const normalize_url_1 = require("../utils/normalize-url");
 /**
  * Event to be sent when report status to design library
  */
@@ -110,5 +111,5 @@ function getDesignLibraryStatusEvent(status, uid) {
  * @returns The full URL to the design library script.
  */
 function getDesignLibraryScriptLink(sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) {
-    return `${sitecoreEdgeUrl}/v1/files/designlibrary/lib/rh-lib-script.js`;
+    return `${(0, normalize_url_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/files/designlibrary/lib/rh-lib-script.js`;
 }

package/dist/cjs/index.js

@@ -38,9 +38,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineConfig = exports.constants = exports.NativeDataFetcher = exports.ClientError = exports.MemoryCacheClient = exports.DefaultRetryStrategy = exports.GraphQLRequestClient = exports.enableDebug = exports.debug = void 0;
+exports.defineConfig = exports.form = exports.constants = exports.NativeDataFetcher = exports.ClientError = exports.MemoryCacheClient = exports.DefaultRetryStrategy = exports.GraphQLRequestClient = exports.enableDebug = exports.debug = void 0;
 const constants = __importStar(require("./constants"));
 exports.constants = constants;
+const form = __importStar(require("./form"));
+exports.form = form;
 var debug_1 = require("./debug");
 Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return __importDefault(debug_1).default; } });
 Object.defineProperty(exports, "enableDebug", { enumerable: true, get: function () { return debug_1.enableDebug; } });

package/dist/cjs/layout/content-styles.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.traverseComponent = exports.traverseField = exports.traversePlaceholder = exports.getContentStylesheetUrl = exports.getContentStylesheetLink = void 0;
 const constants_1 = require("../constants");
+const normalize_url_1 = require("../utils/normalize-url");
 /**
  * Regular expression to check if the content styles are used in the field value
  */
@@ -26,7 +27,7 @@ const getContentStylesheetLink = (layoutData, sitecoreEdgeContextId, sitecoreEdg
     };
 };
 exports.getContentStylesheetLink = getContentStylesheetLink;
-const getContentStylesheetUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${sitecoreEdgeUrl}/v1/files/pages/styles/content-styles.css?sitecoreContextId=${sitecoreEdgeContextId}`;
+const getContentStylesheetUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => `${(0, normalize_url_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/files/pages/styles/content-styles.css?sitecoreContextId=${sitecoreEdgeContextId}`;
 exports.getContentStylesheetUrl = getContentStylesheetUrl;
 const traversePlaceholder = (components, config) => {
     if (config.loadStyles)

package/dist/cjs/layout/themes.js

@@ -4,6 +4,7 @@ exports.getStylesheetUrl = void 0;
 exports.getDesignLibraryStylesheetLinks = getDesignLibraryStylesheetLinks;
 const _1 = require(".");
 const constants_1 = require("../constants");
+const normalize_url_1 = require("../utils/normalize-url");
 /**
  * Pattern for library ids
  * @example -library--foo
@@ -27,7 +28,7 @@ function getDesignLibraryStylesheetLinks(layoutData, sitecoreEdgeContextId, site
     }));
 }
 const getStylesheetUrl = (id, sitecoreEdgeContextId, sitecoreEdgeUrl = constants_1.SITECORE_EDGE_URL_DEFAULT) => {
-    return `${sitecoreEdgeUrl}/v1/files/components/styles/${id}.css?sitecoreContextId=${sitecoreEdgeContextId}`;
+    return `${(0, normalize_url_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/files/components/styles/${id}.css?sitecoreContextId=${sitecoreEdgeContextId}`;
 };
 exports.getStylesheetUrl = getStylesheetUrl;
 /**

package/dist/cjs/tools/auth/fetch-bearer-token.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchBearerToken = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const constants_1 = require("../../constants");
+/**
+ * Connects to M2M endpoint and fetches the bearer token
+ * Uses client_id and client_secret from environment variables
+ * @param {FetchBearerTokenOptions} options client id, secret, and other parameters for connection to m2m endpoint
+ * @returns {string} bearer token string
+ */
+const fetchBearerToken = async (options) => {
+    const { clientId, clientSecret } = options;
+    const audience = options.audience || constants_1.DEFAULT_SITECORE_AUTH_AUDIENCE;
+    const endpoint = options.endpoint || constants_1.DEFAULT_SITECORE_AUTH_ENDPOINT;
+    try {
+        // TODO:adjust when M2M endpoint is live
+        const authenticateResponse = await fetch(endpoint, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify({
+                client_id: clientId,
+                client_secret: clientSecret,
+                audience: audience,
+                grant_type: 'client_credentials',
+            }),
+        });
+        const jsonResponse = await authenticateResponse.json();
+        return jsonResponse.access_token;
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('Error authenticating with Sitecore Auth endpoint:', error));
+        return null;
+    }
+};
+exports.fetchBearerToken = fetchBearerToken;

package/dist/cjs/tools/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.scaffoldComponent = exports.generateMetadata = exports.generateSites = void 0;
+exports.fetchBearerToken = exports.scaffoldComponent = exports.generateMetadata = exports.generateSites = void 0;
 var generateSites_1 = require("./generateSites");
 Object.defineProperty(exports, "generateSites", { enumerable: true, get: function () { return generateSites_1.generateSites; } });
 var generateMetadata_1 = require("./generateMetadata");
@@ -22,3 +22,5 @@ Object.defineProperty(exports, "generateMetadata", { enumerable: true, get: func
 var scaffold_1 = require("./scaffold");
 Object.defineProperty(exports, "scaffoldComponent", { enumerable: true, get: function () { return scaffold_1.scaffoldComponent; } });
 __exportStar(require("./templating"), exports);
+var fetch_bearer_token_1 = require("./auth/fetch-bearer-token");
+Object.defineProperty(exports, "fetchBearerToken", { enumerable: true, get: function () { return fetch_bearer_token_1.fetchBearerToken; } });

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

@@ -0,0 +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;

package/dist/cjs/utils/utils.js

@@ -173,7 +173,7 @@ exports.areURLSearchParamsEqual = areURLSearchParamsEqual;
  * @returns {string} - The modified string or regex with non-special "?" characters escaped.
  */
 const escapeNonSpecialQuestionMarks = (input) => {
-    const regexPattern = /(?<!\\)\?/g; // Match unescaped "?" characters
+    const regexPattern = /(\\)?\?/g; // Match "?" that may or may not be preceded by a backslash
     const negativeLookaheadPattern = /\(\?!$/; // Detect the start of a Negative Lookahead pattern
     const specialRegexSymbols = /[.*+)\[\]|\(]$/; // Check for special regex symbols before "?"
     let result = '';
@@ -182,12 +182,14 @@ const escapeNonSpecialQuestionMarks = (input) => {
     while ((match = regexPattern.exec(input)) !== null) {
         const index = match.index; // Position of the "?" in the string
         const before = input.slice(lastIndex, index); // Context before the "?"
+        // Check if "?" is preceded by a backslash (escaped)
+        const isEscaped = match[1] !== undefined; // match[1] is the backslash group
         // Check if "?" is part of a Negative Lookahead
         const isNegativeLookahead = negativeLookaheadPattern.test(before.slice(-3));
         // Check if "?" follows a special regex symbol
         const isSpecialRegexSymbol = specialRegexSymbols.test(before.slice(-1));
-        if (isNegativeLookahead || isSpecialRegexSymbol) {
-            // If it's a special case, keep the "?" as is
+        if (isEscaped || isNegativeLookahead || isSpecialRegexSymbol) {
+            // If it's escaped, part of a Negative Lookahead, or follows a special regex symbol, keep the "?" as is
             result += input.slice(lastIndex, index + 1);
         }
         else {

package/dist/esm/client/graphql-edge-proxy.js

@@ -1,5 +1,5 @@
 import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
-const normalizeUrl = (url) => (url.endsWith('/') ? url.slice(0, -1) : url);
+import { normalizeUrl } from '../utils/normalize-url';
 /**
  * Generates a URL for accessing Sitecore Edge Platform Content using the provided endpoint and context ID.
  * @param {string} sitecoreEdgeContextId - The unique context id.

package/dist/esm/constants.js

@@ -8,3 +8,5 @@ export var SitecoreTemplateId;
 export const siteNameError = 'The siteName cannot be empty';
 export const SITECORE_EDGE_URL_DEFAULT = 'https://edge-platform.sitecorecloud.io';
 export const HIDDEN_RENDERING_NAME = 'Hidden Rendering';
+export const DEFAULT_SITECORE_AUTH_ENDPOINT = 'https://auth.sitecorecloud.io/oauth/token';
+export const DEFAULT_SITECORE_AUTH_AUDIENCE = 'https://api.sitecorecloud.io';

package/dist/esm/content/content-client.js

@@ -0,0 +1,82 @@
+import { GraphQLRequestClient } from '../graphql-request-client';
+import { getContentUrl } from './utils';
+import debug from '../debug';
+import { GET_LOCALE_QUERY, GET_LOCALES_QUERY, } from './locales';
+/**
+ * Class representing a client for interacting with the Content API.
+ */
+export class ContentClient {
+    constructor({ url, tenant, environment, preview = false, token }) {
+        this.endpoint = getContentUrl({
+            environment,
+            preview,
+            tenant,
+            url,
+        });
+        this.graphqlClient = new GraphQLRequestClient(this.endpoint, {
+            headers: {
+                Authorization: `Bearer ${token}`,
+            },
+            debugger: debug.content,
+        });
+    }
+    /**
+     * Factory method for creating a ContentClient instance. This method allows you to create a client with the values populated from environment variables or provided as arguments.
+     * @param {Partial<ContentClientOptions>} [options] - client configuration options
+     * @param {string} [options.url] - Content base graphql endpoint url. If not provided, it will be read from the SITECORE_CS_URL environment variable. Otherwise, it defaults to https://cs-graphqlapi-staging.sitecore-staging.cloud.
+     * @param {string} [options.tenant] - Tenant name. If not provided, it will be read from the SITECORE_CS_TENANT environment variable
+     * @param {string} [options.environment] - Environment name. If not provided, it will be read from the SITECORE_CS_ENVIRONMENT environment variable. Otherwise, it defaults to 'main'
+     * @param {boolean} [options.preview] - Indicates if preview mode is enabled. If not provided, it will be read from the SITECORE_CS_PREVIEW environment variable. Otherwise, it defaults to false
+     * @param {string} [options.token] - Token for authentication. If not provided, it will be read from the SITECORE_CS_TOKEN environment variable.
+     * @returns {ContentClient} ContentClient instance
+     * @throws {Error} If tenant or token is not provided
+     */
+    static createClient({ url, tenant, environment, preview, token, } = {}) {
+        const options = {
+            url: url || process.env.SITECORE_CS_URL,
+            tenant: tenant || process.env.SITECORE_CS_TENANT || '',
+            environment: environment || process.env.SITECORE_CS_ENVIRONMENT || 'main',
+            preview: preview || process.env.SITECORE_CS_PREVIEW === 'true',
+            token: token || process.env.SITECORE_CS_TOKEN || '',
+        };
+        if (!options.tenant) {
+            throw new Error('Tenant is required to be provided as an argument or as a SITECORE_CS_TENANT environment variable');
+        }
+        if (!options.token) {
+            throw new Error('Token is required to be provided as an argument or as a SITECORE_CS_TOKEN environment variable');
+        }
+        return new ContentClient(options);
+    }
+    /**
+     * Execute graphql request
+     * @param {string | DocumentNode} query graphql query
+     * @param {object} variables variables for the query
+     * @param {FetchOptions} options options for configuring the request
+     * @returns {T} response data
+     */
+    async get(query, variables = {}, options = {}) {
+        debug.content('fetching content data');
+        return this.graphqlClient.request(query, variables, options);
+    }
+    /**
+     * Retrieves the locale information for a given locale ID.
+     *
+     * @param id - The unique identifier of the locale item.
+     * @returns A promise that resolves to the locale information associated with the specified locale ID.
+     */
+    async getLocale(id) {
+        debug.content('Getting locale for id: %s', id);
+        const response = await this.get(GET_LOCALE_QUERY, { id });
+        return response.locale;
+    }
+    /**
+     * Retrieves all available locales from the content service.
+     *
+     * @returns A promise that resolves to an array of locales.
+     */
+    async getLocales() {
+        debug.content('Getting all locales');
+        const response = await this.get(GET_LOCALES_QUERY);
+        return response.manyLocale;
+    }
+}

package/dist/esm/content/index.js

@@ -0,0 +1,3 @@
+export { ContentClient } from './content-client';
+export { GET_LOCALE_QUERY, GET_LOCALES_QUERY, } from './locales';
+export { getContentUrl } from './utils';

package/dist/esm/content/locales.js

@@ -0,0 +1,25 @@
+/**
+ * GraphQL query to retrieve a specific locale by its ID.
+ *
+ * Variables:
+ * - id: The ID of the locale to retrieve.
+ */
+export const GET_LOCALE_QUERY = `
+  query GetLocaleById ($id: ID!) {
+    locale(id: $id) {
+      id
+      label
+    }
+  }
+`;
+/**
+ * GraphQL query to retrieve all available locales.
+ */
+export const GET_LOCALES_QUERY = `
+  query GetAllLocales{
+    manyLocale {
+      id
+      label
+    }
+  }
+`;

package/dist/esm/content/utils.js

@@ -0,0 +1,13 @@
+import { normalizeUrl } from '../utils/normalize-url';
+/**
+ * Get the Content graphql endpoint url
+ * @param {object} params Parameters
+ * @param {string} [params.url] Content base graphql endpoint url
+ * @param {string} params.tenant Tenant name
+ * @param {string} params.environment Environment name
+ * @param {boolean} params.preview Indicates if preview mode is enabled
+ * @returns {string} Content graphql endpoint url
+ */
+export function getContentUrl({ url = 'https://cs-graphqlapi-staging.sitecore-staging.cloud', tenant, environment, preview, }) {
+    return `${normalizeUrl(url)}/api/graphql/v1/${tenant}/${environment}?preview=${preview}`;
+}

package/dist/esm/debug.js

@@ -22,6 +22,7 @@ export const enableDebug = (namespaces) => debug.enable(namespaces);
  */
 export default {
     common: debug(`${rootNamespace}:common`),
+    content: debug(`${rootNamespace}:content`),
     form: debug(`${rootNamespace}:form`),
     http: debug(`${rootNamespace}:http`),
     layout: debug(`${rootNamespace}:layout`),

package/dist/esm/editing/design-library.js

@@ -1,4 +1,5 @@
 import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
+import { normalizeUrl } from '../utils/normalize-url';
 /**
  * Event to be sent when report status to design library
  */
@@ -103,5 +104,5 @@ export function getDesignLibraryStatusEvent(status, uid) {
  * @returns The full URL to the design library script.
  */
 export function getDesignLibraryScriptLink(sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) {
-    return `${sitecoreEdgeUrl}/v1/files/designlibrary/lib/rh-lib-script.js`;
+    return `${normalizeUrl(sitecoreEdgeUrl)}/v1/files/designlibrary/lib/rh-lib-script.js`;
 }

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 // NOTE: all imports are now named as to not make breaking changes
 // and to keep react-native working with cjs modules.
 import * as constants from './constants';
+import * as form from './form';
 export { default as debug, enableDebug } from './debug';
 export { GraphQLRequestClient, } from './graphql-request-client';
 export { DefaultRetryStrategy } from './retries';
@@ -8,4 +9,5 @@ export { MemoryCacheClient } from './cache-client';
 export { ClientError } from 'graphql-request';
 export { NativeDataFetcher, } from './native-fetcher';
 export { constants };
+export { form };
 export { defineConfig } from './config';

package/dist/esm/layout/content-styles.js

@@ -1,4 +1,5 @@
 import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
+import { normalizeUrl } from '../utils/normalize-url';
 /**
  * Regular expression to check if the content styles are used in the field value
  */
@@ -22,7 +23,7 @@ export const getContentStylesheetLink = (layoutData, sitecoreEdgeContextId, site
         rel: 'stylesheet',
     };
 };
-export const getContentStylesheetUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) => `${sitecoreEdgeUrl}/v1/files/pages/styles/content-styles.css?sitecoreContextId=${sitecoreEdgeContextId}`;
+export const getContentStylesheetUrl = (sitecoreEdgeContextId, sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) => `${normalizeUrl(sitecoreEdgeUrl)}/v1/files/pages/styles/content-styles.css?sitecoreContextId=${sitecoreEdgeContextId}`;
 export const traversePlaceholder = (components, config) => {
     if (config.loadStyles)
         return;

package/dist/esm/layout/themes.js

@@ -1,5 +1,6 @@
 import { getFieldValue } from '.';
 import { SITECORE_EDGE_URL_DEFAULT } from '../constants';
+import { normalizeUrl } from '../utils/normalize-url';
 /**
  * Pattern for library ids
  * @example -library--foo
@@ -23,7 +24,7 @@ export function getDesignLibraryStylesheetLinks(layoutData, sitecoreEdgeContextI
     }));
 }
 export const getStylesheetUrl = (id, sitecoreEdgeContextId, sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) => {
-    return `${sitecoreEdgeUrl}/v1/files/components/styles/${id}.css?sitecoreContextId=${sitecoreEdgeContextId}`;
+    return `${normalizeUrl(sitecoreEdgeUrl)}/v1/files/components/styles/${id}.css?sitecoreContextId=${sitecoreEdgeContextId}`;
 };
 /**
  * Traverse placeholder and components to add library ids

package/dist/esm/tools/auth/fetch-bearer-token.js

@@ -0,0 +1,34 @@
+import chalk from 'chalk';
+import { DEFAULT_SITECORE_AUTH_AUDIENCE, DEFAULT_SITECORE_AUTH_ENDPOINT } from '../../constants';
+/**
+ * Connects to M2M endpoint and fetches the bearer token
+ * Uses client_id and client_secret from environment variables
+ * @param {FetchBearerTokenOptions} options client id, secret, and other parameters for connection to m2m endpoint
+ * @returns {string} bearer token string
+ */
+export const fetchBearerToken = async (options) => {
+    const { clientId, clientSecret } = options;
+    const audience = options.audience || DEFAULT_SITECORE_AUTH_AUDIENCE;
+    const endpoint = options.endpoint || DEFAULT_SITECORE_AUTH_ENDPOINT;
+    try {
+        // TODO:adjust when M2M endpoint is live
+        const authenticateResponse = await fetch(endpoint, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify({
+                client_id: clientId,
+                client_secret: clientSecret,
+                audience: audience,
+                grant_type: 'client_credentials',
+            }),
+        });
+        const jsonResponse = await authenticateResponse.json();
+        return jsonResponse.access_token;
+    }
+    catch (error) {
+        console.error(chalk.red('Error authenticating with Sitecore Auth endpoint:', error));
+        return null;
+    }
+};

package/dist/esm/tools/index.js

@@ -2,3 +2,4 @@ export { generateSites } from './generateSites';
 export { generateMetadata } from './generateMetadata';
 export { scaffoldComponent } from './scaffold';
 export * from './templating';
+export { fetchBearerToken } from './auth/fetch-bearer-token';

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

@@ -0,0 +1 @@
+export const normalizeUrl = (url) => (url.endsWith('/') ? url.slice(0, -1) : url);

package/dist/esm/utils/utils.js

@@ -160,7 +160,7 @@ export const areURLSearchParamsEqual = (params1, params2) => {
  * @returns {string} - The modified string or regex with non-special "?" characters escaped.
  */
 export const escapeNonSpecialQuestionMarks = (input) => {
-    const regexPattern = /(?<!\\)\?/g; // Match unescaped "?" characters
+    const regexPattern = /(\\)?\?/g; // Match "?" that may or may not be preceded by a backslash
     const negativeLookaheadPattern = /\(\?!$/; // Detect the start of a Negative Lookahead pattern
     const specialRegexSymbols = /[.*+)\[\]|\(]$/; // Check for special regex symbols before "?"
     let result = '';
@@ -169,12 +169,14 @@ export const escapeNonSpecialQuestionMarks = (input) => {
     while ((match = regexPattern.exec(input)) !== null) {
         const index = match.index; // Position of the "?" in the string
         const before = input.slice(lastIndex, index); // Context before the "?"
+        // Check if "?" is preceded by a backslash (escaped)
+        const isEscaped = match[1] !== undefined; // match[1] is the backslash group
         // Check if "?" is part of a Negative Lookahead
         const isNegativeLookahead = negativeLookaheadPattern.test(before.slice(-3));
         // Check if "?" follows a special regex symbol
         const isSpecialRegexSymbol = specialRegexSymbols.test(before.slice(-1));
-        if (isNegativeLookahead || isSpecialRegexSymbol) {
-            // If it's a special case, keep the "?" as is
+        if (isEscaped || isNegativeLookahead || isSpecialRegexSymbol) {
+            // If it's escaped, part of a Negative Lookahead, or follows a special regex symbol, keep the "?" as is
             result += input.slice(lastIndex, index + 1);
         }
         else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/core",
-  "version": "0.2.0-beta.3",
+  "version": "0.2.0-beta.5",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -15,7 +15,7 @@
     "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/form/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 --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 src/content/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=22"
@@ -58,7 +58,7 @@
     "nock": "14.0.0-beta.7",
     "nyc": "^17.1.0",
     "proxyquire": "^2.1.3",
-    "sinon": "^19.0.2",
+    "sinon": "^20.0.0",
     "tslib": "^2.8.1",
     "tsx": "^4.19.2",
     "typescript": "~5.7.3"
@@ -77,7 +77,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "7db8889529e2e1becdc47f1e7ec1962bbad3f47d",
+  "gitHead": "5d4eae78186f6b530f97fb516a5718651586b0bc",
   "files": [
     "dist",
     "types",

package/types/constants.d.ts

@@ -5,3 +5,5 @@ export declare enum SitecoreTemplateId {
 export declare const siteNameError = "The siteName cannot be empty";
 export declare const SITECORE_EDGE_URL_DEFAULT = "https://edge-platform.sitecorecloud.io";
 export declare const HIDDEN_RENDERING_NAME = "Hidden Rendering";
+export declare const DEFAULT_SITECORE_AUTH_ENDPOINT = "https://auth.sitecorecloud.io/oauth/token";
+export declare const DEFAULT_SITECORE_AUTH_AUDIENCE = "https://api.sitecorecloud.io";

package/types/content/content-client.d.ts

@@ -0,0 +1,59 @@
+import { DocumentNode } from 'graphql';
+import { GraphQLRequestClient } from '../graphql-request-client';
+import { FetchOptions } from '../models';
+/**
+ * Interface representing the options for the ContentClient.
+ */
+export interface ContentClientOptions {
+    /** The base URL for the Content API. */
+    url?: string;
+    /** The tenant name. */
+    tenant: string;
+    /** The environment name. */
+    environment: string;
+    /** Indicates if preview mode is enabled. */
+    preview?: boolean;
+    /** The authentication token. */
+    token: string;
+}
+/**
+ * Class representing a client for interacting with the Content API.
+ */
+export declare class ContentClient {
+    endpoint: string;
+    graphqlClient: GraphQLRequestClient;
+    constructor({ url, tenant, environment, preview, token }: ContentClientOptions);
+    /**
+     * Factory method for creating a ContentClient instance. This method allows you to create a client with the values populated from environment variables or provided as arguments.
+     * @param {Partial<ContentClientOptions>} [options] - client configuration options
+     * @param {string} [options.url] - Content base graphql endpoint url. If not provided, it will be read from the SITECORE_CS_URL environment variable. Otherwise, it defaults to https://cs-graphqlapi-staging.sitecore-staging.cloud.
+     * @param {string} [options.tenant] - Tenant name. If not provided, it will be read from the SITECORE_CS_TENANT environment variable
+     * @param {string} [options.environment] - Environment name. If not provided, it will be read from the SITECORE_CS_ENVIRONMENT environment variable. Otherwise, it defaults to 'main'
+     * @param {boolean} [options.preview] - Indicates if preview mode is enabled. If not provided, it will be read from the SITECORE_CS_PREVIEW environment variable. Otherwise, it defaults to false
+     * @param {string} [options.token] - Token for authentication. If not provided, it will be read from the SITECORE_CS_TOKEN environment variable.
+     * @returns {ContentClient} ContentClient instance
+     * @throws {Error} If tenant or token is not provided
+     */
+    static createClient({ url, tenant, environment, preview, token, }?: Partial<ContentClientOptions>): ContentClient;
+    /**
+     * Execute graphql request
+     * @param {string | DocumentNode} query graphql query
+     * @param {object} variables variables for the query
+     * @param {FetchOptions} options options for configuring the request
+     * @returns {T} response data
+     */
+    get<T>(query: string | DocumentNode, variables?: Record<string, unknown>, options?: FetchOptions): Promise<T>;
+    /**
+     * Retrieves the locale information for a given locale ID.
+     *
+     * @param id - The unique identifier of the locale item.
+     * @returns A promise that resolves to the locale information associated with the specified locale ID.
+     */
+    getLocale(id: string): Promise<import("./locales").Locale | null>;
+    /**
+     * Retrieves all available locales from the content service.
+     *
+     * @returns A promise that resolves to an array of locales.
+     */
+    getLocales(): Promise<import("./locales").Locale[]>;
+}

package/types/content/index.d.ts

@@ -0,0 +1,3 @@
+export { ContentClient, ContentClientOptions } from './content-client';
+export { GET_LOCALE_QUERY, GET_LOCALES_QUERY, LocaleQueryResponse, LocalesQueryResponse, Locale, } from './locales';
+export { getContentUrl } from './utils';

package/types/content/locales.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Represents the response structure for a query that retrieves a locale.
+ */
+export interface LocaleQueryResponse {
+    locale: Locale | null;
+}
+/**
+ * Represents the response structure for a query that retrieves multiple locales.
+ */
+export interface LocalesQueryResponse {
+    manyLocale: Locale[];
+}
+/**
+ * Represents a locale with an id and a label.
+ */
+export type Locale = {
+    /** The unique identifier for the locale. */
+    id: string;
+    /** The display name or label for the locale. */
+    label: string;
+};
+/**
+ * GraphQL query to retrieve a specific locale by its ID.
+ *
+ * Variables:
+ * - id: The ID of the locale to retrieve.
+ */
+export declare const GET_LOCALE_QUERY = "\n  query GetLocaleById ($id: ID!) {\n    locale(id: $id) {\n      id\n      label\n    }\n  }\n";
+/**
+ * GraphQL query to retrieve all available locales.
+ */
+export declare const GET_LOCALES_QUERY = "\n  query GetAllLocales{\n    manyLocale {\n      id\n      label\n    }\n  }\n";

package/types/content/utils.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Get the Content graphql endpoint url
+ * @param {object} params Parameters
+ * @param {string} [params.url] Content base graphql endpoint url
+ * @param {string} params.tenant Tenant name
+ * @param {string} params.environment Environment name
+ * @param {boolean} params.preview Indicates if preview mode is enabled
+ * @returns {string} Content graphql endpoint url
+ */
+export declare function getContentUrl({ url, tenant, environment, preview, }: {
+    url?: string;
+    tenant: string;
+    environment: string;
+    preview: boolean;
+}): string;

package/types/debug.d.ts

@@ -11,6 +11,7 @@ export declare const enableDebug: (namespaces: string) => void;
  */
 declare const _default: {
     common: debug.Debugger;
+    content: debug.Debugger;
     form: debug.Debugger;
     http: debug.Debugger;
     layout: debug.Debugger;

package/types/index.d.ts

@@ -1,4 +1,5 @@
 import * as constants from './constants';
+import * as form from './form';
 export { default as debug, Debugger, enableDebug } from './debug';
 export { GraphQLClient, GraphQLRequestClient, GraphQLRequestClientConfig, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, } from './graphql-request-client';
 export { DefaultRetryStrategy } from './retries';
@@ -7,4 +8,5 @@ export { ClientError } from 'graphql-request';
 export { NativeDataFetcher, NativeDataFetcherConfig, NativeDataFetcherError, NativeDataFetcherResponse, } from './native-fetcher';
 export { HTMLLink, RetryStrategy, GenericGraphQLClientError, StaticPath } from './models';
 export { constants };
+export { form };
 export { defineConfig } from './config';

package/types/tools/auth/fetch-bearer-token.d.ts

@@ -0,0 +1,13 @@
+export type FetchBearerTokenOptions = {
+    clientId: string;
+    clientSecret: string;
+    audience?: string;
+    endpoint?: string;
+};
+/**
+ * Connects to M2M endpoint and fetches the bearer token
+ * Uses client_id and client_secret from environment variables
+ * @param {FetchBearerTokenOptions} options client id, secret, and other parameters for connection to m2m endpoint
+ * @returns {string} bearer token string
+ */
+export declare const fetchBearerToken: (options: FetchBearerTokenOptions) => Promise<any>;

package/types/tools/index.d.ts

@@ -2,3 +2,4 @@ export { generateSites, GenerateSitesConfig } from './generateSites';
 export { generateMetadata } from './generateMetadata';
 export { scaffoldComponent } from './scaffold';
 export * from './templating';
+export { fetchBearerToken } from './auth/fetch-bearer-token';

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

@@ -0,0 +1 @@
+export declare const normalizeUrl: (url: string) => string;

package/form.d.ts

@@ -1 +0,0 @@
-export * from './types/form/index';

package/form.js

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