@exdst-sitecore-content-sdk/astro 0.0.16 → 0.0.19

package/src/components/Text.astro.test.ts

@@ -0,0 +1,273 @@
+import { describe, test, expect } from 'vitest';
+import { renderAstroComponent } from '../tests/astro-helpers';
+import Text, { TextField } from './Text.astro';
+import EmptyFieldEditingComponent from '../tests/test-components/EmptyFieldEditingComponent.astro';
+
+describe('<Text />', () => {
+  test('should render nothing with missing field', async () => {
+    const field: TextField = null!;
+    const rendered = await renderAstroComponent(Text, {
+      props: { field: field },
+    });
+    expect(rendered.innerHTML).to.equal('');
+  });
+
+  test('should render nothing with missing field', async () => {
+    const field = {
+      value: '',
+    };
+    const rendered = await renderAstroComponent(Text, {
+      props: { field: field },
+    });
+    expect(rendered.innerHTML).to.equal('');
+  });
+
+  test('should render nothing with missing value', async () => {
+    const field = {};
+    const rendered = await renderAstroComponent(Text, {
+      props: { field: field },
+    });
+    expect(rendered.innerHTML).to.equal('');
+  });
+
+  test('should render value with editing explicitly disabled', async () => {
+    const field = {
+      value: 'value',
+    };
+    const rendered = (
+      await renderAstroComponent(Text, {
+        props: { field: field, tag: 'span', editable: false },
+      })
+    ).querySelector('span');
+
+    expect(rendered?.innerHTML).to.contain('value');
+  });
+
+  test('should encode values with editing explicitly disabled', async () => {
+    const field = {
+      value: 'value < >',
+    };
+    const rendered = (
+      await renderAstroComponent(Text, {
+        props: { field: field, tag: 'span', editable: false },
+      })
+    ).querySelector('span');
+    expect(rendered?.innerHTML).to.contain('&lt; &gt;');
+  });
+
+  test('should render value with just a value', async () => {
+    const field = {
+      value: 'value',
+    };
+    const rendered = (
+      await renderAstroComponent(Text, {
+        props: { field: field, tag: 'span' },
+      })
+    ).querySelector('span');
+    expect(rendered?.innerHTML).to.contain('value');
+  });
+
+  test('should render value without tag', async () => {
+    const field = {
+      value: 'value',
+    };
+    const rendered = await renderAstroComponent(Text, {
+      props: { field: field },
+    });
+    expect(rendered.innerHTML).to.equal('value');
+  });
+
+  test('should render number value', async () => {
+    const field = {
+      value: 1.23,
+    };
+    const rendered = await renderAstroComponent(Text, {
+      props: { field: field },
+    });
+    expect(rendered.innerHTML).to.equal('1.23');
+  });
+
+  test('should render zero number value', async () => {
+    const field = {
+      value: 0,
+    };
+    const rendered = await renderAstroComponent(Text, {
+      props: { field: field },
+    });
+    expect(rendered?.innerHTML).to.equal('0');
+  });
+
+  test('should render negative number value', async () => {
+    const field = {
+      value: -1.23,
+    };
+    const rendered = await renderAstroComponent(Text, {
+      props: { field: field },
+    });
+    expect(rendered?.innerHTML).to.equal('-1.23');
+  });
+
+  test('should render value without tag', async () => {
+    const field = {
+      value: 'value',
+    };
+    const rendered = await renderAstroComponent(Text, {
+      props: { field: field },
+    });
+    expect(rendered?.innerHTML).to.contain('value');
+  });
+
+  test('should render value with just a value that contains line breaks', async () => {
+    const field = {
+      value: 'xxx\n\naa\nbbb\ndd',
+    };
+    const rendered = (
+      await renderAstroComponent(Text, {
+        props: { field: field, tag: 'span' },
+      })
+    ).querySelector('span');
+    expect(rendered?.innerHTML).to.contain('xxx<br><br>aa<br>bbb<br>dd');
+  });
+
+  test('should render value with just a value that contains only one line break', async () => {
+    const field = {
+      value: '\n',
+    };
+    const rendered = (
+      await renderAstroComponent(Text, {
+        props: { field: field, tag: 'span' },
+      })
+    ).querySelector('span');
+    expect(rendered?.outerHTML).to.contain('<span><br></span>');
+  });
+
+  test('should render embedded html as-is when encoding is disabled', async () => {
+    const field = {
+      value: '<input type="text">some crazy stuff<script code="whaaaat">uh oh</script>',
+    };
+    const rendered = (
+      await renderAstroComponent(Text, {
+        props: { field: field, encode: false },
+      })
+    ).querySelector('span');
+    expect(rendered?.innerHTML).to.contain(field.value);
+  });
+
+  test('should render tag with a tag provided', async () => {
+    const field = {
+      value: 'value',
+    };
+    const rendered = (
+      await renderAstroComponent(Text, {
+        props: { field: field, tag: 'h1' },
+      })
+    ).querySelector('h1');
+    expect(rendered?.innerHTML).to.contain('value');
+  });
+
+  test('should render other attributes with other props provided', async () => {
+    const field = {
+      value: 'value',
+    };
+    const rendered = (
+      await renderAstroComponent(Text, {
+        props: { field: field, tag: 'h1', class: 'cssClass', id: 'lorem' },
+      })
+    ).querySelector('h1');
+    expect(rendered?.outerHTML).to.contain('<h1 class="cssClass" id="lorem">');
+    expect(rendered?.outerHTML).to.contain('value');
+  });
+
+  describe('edit mode', () => {
+    const testMetadata = {
+      contextItem: {
+        id: '{09A07660-6834-476C-B93B-584248D3003B}',
+        language: 'en',
+        revision: 'a0b36ce0a7db49418edf90eb9621e145',
+        version: 1,
+      },
+      fieldId: '{414061F4-FBB1-4591-BC37-BFFA67F745EB}',
+      fieldType: 'single-line',
+      rawValue: 'Test1',
+    };
+
+    test('should render field metadata component when metadata property is present', async () => {
+      const field = {
+        value: 'value',
+        metadata: testMetadata,
+      };
+
+      const rendered = await renderAstroComponent(Text, {
+        props: { field: field },
+      });
+
+      expect(rendered.innerHTML).to.equal(
+        [
+          `<code type="text/sitecore" chrometype="field" class="scpm" kind="open">${JSON.stringify(
+            testMetadata
+          )}</code>`,
+          '<span>value</span>',
+          '<code type="text/sitecore" chrometype="field" class="scpm" kind="close"></code>',
+        ].join('')
+      );
+    });
+
+    test('should render default empty field component when field value is empty in edit mode metadata', async () => {
+      const field = {
+        value: '',
+        metadata: testMetadata,
+      };
+
+      const rendered = await renderAstroComponent(Text, {
+        props: { field: field },
+      });
+
+      expect(rendered.innerHTML).to.equal(
+        [
+          `<code type="text/sitecore" chrometype="field" class="scpm" kind="open">${JSON.stringify(
+            testMetadata
+          )}</code>`,
+          '<span>[No text in field]</span>',
+          '<code type="text/sitecore" chrometype="field" class="scpm" kind="close"></code>',
+        ].join('')
+      );
+    });
+
+    test('should render custom empty field component when provided, when field value is empty in edit mode metadata', async () => {
+      const field = {
+        value: '',
+        metadata: testMetadata,
+      };
+
+      const rendered = await renderAstroComponent(Text, {
+        props: {
+          field: field,
+          emptyFieldEditingComponent: EmptyFieldEditingComponent,
+        },
+      });
+
+      expect(rendered.innerHTML).to.equal(
+        [
+          `<code type="text/sitecore" chrometype="field" class="scpm" kind="open">${JSON.stringify(
+            testMetadata
+          )}</code>`,
+          '<span class="empty-field-value-placeholder">Custom Empty field value</span>',
+          '<code type="text/sitecore" chrometype="field" class="scpm" kind="close"></code>',
+        ].join('')
+      );
+    });
+
+    test('should render nothing when field value is empty, when editing is explicitly disabled in edit mode metadata ', async () => {
+      const field = {
+        value: '',
+        metadata: testMetadata,
+      };
+
+      const rendered = await renderAstroComponent(Text, {
+        props: { field: field, editable: false },
+      });
+
+      expect(rendered.innerHTML).to.equal('');
+    });
+  });
+});

package/src/config/define-config.test.ts

@@ -17,7 +17,7 @@ describe('defineConfig', () => {
   beforeEach(() => {
     defineConfigCoreStub = sandbox.stub();
     defineConfigModule = proxyquire('./define-config', {
-      '@sitecore-content-sdk/core/config': {
+      '@sitecore-content-sdk/content/config': {
         defineConfig: defineConfigCoreStub,
       },
     });
@@ -150,10 +150,10 @@ describe('defineConfig', () => {
 
   describe('config.api.edge.edgeUrl', () => {
     describe('environment variable is not set', () => {
-      it('should default to undefined', () => {
+      it('should default to Edge Platform URL', () => {
         defineConfigModule.defineConfig(defaultConfig());
         const resultConfig = defineConfigCoreStub.getCalls()[0].args[0];
-        expect(resultConfig.api?.edge?.edgeUrl).to.be.undefined;
+        expect(resultConfig.api?.edge?.edgeUrl).to.equal('https://edge-platform.sitecorecloud.io');
       });
 
       it('should use the value from the config', () => {
@@ -167,11 +167,11 @@ describe('defineConfig', () => {
     });
     describe('environment variable is set', () => {
       before(() => {
-        process.env.PUBLIC_SITECORE_EDGE_URL = 'next-public-sitecore-edgeUrl';
+        process.env.PUBLIC_SITECORE_EDGE_PLATFORM_HOSTNAME = 'next-public-sitecore-edgeUrl';
       });
 
       after(() => {
-        delete process.env.PUBLIC_SITECORE_EDGE_URL;
+        delete process.env.PUBLIC_SITECORE_EDGE_PLATFORM_HOSTNAME;
       });
 
       it('should use the value from the config if present', () => {

package/src/config/define-config.ts

@@ -3,16 +3,18 @@ import {
   DeepRequired,
   defineConfig as defineConfigCore,
   SitecoreConfigInput as SitecoreConfigInputCore,
-} from '@sitecore-content-sdk/core/config';
+} from '@sitecore-content-sdk/content/config';
+import { resolveEdgeUrl } from '@sitecore-content-sdk/core/tools';
+
+/** Env var for Edge hostname; exposed to the browser so client code can use it. */
+const PUBLIC_SITECORE_EDGE_PLATFORM_HOSTNAME_ENV = 'PUBLIC_SITECORE_EDGE_PLATFORM_HOSTNAME';
 
 /**
  * Provides default Astro initial values from env variables for SitecoreConfig
  * @param {SitecoreConfigInput} config optional override values to be written over default config settings
  * @returns default Astro input config
  */
-export const getAstroFallbackConfig = (
-  config?: SitecoreConfigInput
-): SitecoreConfigInput => {
+export const getAstroFallbackConfig = (config?: SitecoreConfigInput): SitecoreConfigInput => {
   return {
     ...config,
     api: {
@@ -21,64 +23,40 @@ export const getAstroFallbackConfig = (
         ...config?.api?.edge,
         contextId: config?.api?.edge?.contextId || '',
         clientContextId:
-          config?.api?.edge?.clientContextId ||
-          import.meta.env?.PUBLIC_SITECORE_EDGE_CONTEXT_ID ||
-          process.env.PUBLIC_SITECORE_EDGE_CONTEXT_ID,
-        edgeUrl:
-          config?.api?.edge?.edgeUrl ||
-          import.meta.env?.PUBLIC_SITECORE_EDGE_URL ||
-          process.env.PUBLIC_SITECORE_EDGE_URL,
+          config?.api?.edge?.clientContextId || process.env.PUBLIC_SITECORE_EDGE_CONTEXT_ID,
+        edgeUrl: resolveEdgeUrl(
+          config?.api?.edge?.edgeUrl ?? process.env.PUBLIC_SITECORE_EDGE_PLATFORM_HOSTNAME_ENV
+        ),
       },
       local: {
         ...config?.api?.local,
-        apiKey:
-          config?.api?.local?.apiKey ||
-          import.meta.env?.PUBLIC_SITECORE_API_KEY ||
-          process.env.PUBLIC_SITECORE_API_KEY ||
-          '',
-        apiHost:
-          config?.api?.local?.apiHost ||
-          import.meta.env?.PUBLIC_SITECORE_API_HOST ||
-          process.env.PUBLIC_SITECORE_API_HOST ||
-          '',
+        apiKey: config?.api?.local?.apiKey || process.env.PUBLIC_SITECORE_API_KEY || '',
+        apiHost: config?.api?.local?.apiHost || process.env.PUBLIC_SITECORE_API_HOST || '',
       },
     },
-    defaultSite:
-      config?.defaultSite ||
-      import.meta.env?.PUBLIC_DEFAULT_SITE_NAME ||
-      process.env.PUBLIC_DEFAULT_SITE_NAME ||
-      '',
-    defaultLanguage:
-      config?.defaultLanguage ||
-      import.meta.env?.PUBLIC_DEFAULT_LANGUAGE ||
-      process.env.PUBLIC_DEFAULT_LANGUAGE ||
-      'en',
+    defaultSite: config?.defaultSite || process.env.PUBLIC_DEFAULT_SITE_NAME || '',
+    defaultLanguage: config?.defaultLanguage || process.env.PUBLIC_DEFAULT_LANGUAGE || 'en',
     multisite: {
       ...config?.multisite,
       useCookieResolution:
-        config?.multisite?.useCookieResolution ??
-        (() => (import.meta.env?.VERCEL_ENV || process.env.VERCEL_ENV) === 'preview'),
+        config?.multisite?.useCookieResolution ?? (() => process.env.VERCEL_ENV === 'preview'),
     },
     personalize: {
       ...config?.personalize,
-      scope:
-        config?.personalize?.scope ||
-        import.meta.env?.PUBLIC_PERSONALIZE_SCOPE ||
-        process.env.PUBLIC_PERSONALIZE_SCOPE,
+      scope: config?.personalize?.scope || process.env.PUBLIC_PERSONALIZE_SCOPE,
     },
     generateStaticPaths:
-      (import.meta.env?.GENERATE_STATIC_PATHS ?? process.env.GENERATE_STATIC_PATHS) !== undefined
-        ? (import.meta.env?.GENERATE_STATIC_PATHS || process.env.GENERATE_STATIC_PATHS).toLowerCase() === 'true'
+      process.env.GENERATE_STATIC_PATHS !== undefined
+        ? process.env.GENERATE_STATIC_PATHS.toLowerCase() === 'true'
         : config?.generateStaticPaths ?? true,
     sitecoreInternalEditingHostUrl:
-      config?.sitecoreInternalEditingHostUrl ||
-      import.meta.env?.SITECORE_INTERNAL_EDITING_HOST_URL ||
-      process.env.SITECORE_INTERNAL_EDITING_HOST_URL,
+      config?.sitecoreInternalEditingHostUrl || process.env.SITECORE_INTERNAL_EDITING_HOST_URL,
   };
 };
 
 /**
  * Type to be used as config input in sitecore.config
+ * @public
  */
 export type SitecoreConfigInput = SitecoreConfigInputCore & {
   /**
@@ -102,6 +80,7 @@ export type SitecoreConfigInput = SitecoreConfigInputCore & {
 
 /**
  * Final sitecore config type used at runtime Every property should be populated, either from sitecore.config or built-in fallback values
+ * @public
  */
 export type SitecoreConfig = DeepRequired<SitecoreConfigInput>;
 
@@ -109,6 +88,7 @@ export type SitecoreConfig = DeepRequired<SitecoreConfigInput>;
  * Accepts a SitecoreConfigInput object and returns full sitecore configuration
  * @param {SitecoreConfigInput} config override values to be written over default config settings
  * @returns {SitecoreConfig} full sitecore configuration to use in application
+ * @public
  */
 export const defineConfig = (config?: SitecoreConfigInput): SitecoreConfig => {
   return defineConfigCore(getAstroFallbackConfig(config)) as SitecoreConfig;

package/src/config-cli/define-cli-config.test.ts

@@ -4,16 +4,13 @@ import {
   SitecoreCliConfigInput,
   SitecoreCliConfig,
   ComponentTemplateType,
-} from '@sitecore-content-sdk/core/config';
+} from '@sitecore-content-sdk/content/config';
 import chalk from 'chalk';
 
 describe('defineCliConfig', () => {
   const validateDefaultTemplates = (result: SitecoreCliConfig) => {
-    expect(result.scaffold.templates[0].name).to.equal(
-      ComponentTemplateType.DEFAULT
-    );
-    const defaultTemplate =
-      result.scaffold.templates[0].generateTemplate('ComponentName');
+    expect(result.scaffold.templates[0].name).to.equal(ComponentTemplateType.DEFAULT);
+    const defaultTemplate = result.scaffold.templates[0].generateTemplate('ComponentName');
     // expect(defaultTemplate).to.contain(
     //   // eslint-disable-next-line quotes
     //   `import { ComponentParams, ComponentRendering } from '@sitecore-content-sdk/nextjs';`
@@ -21,9 +18,7 @@ describe('defineCliConfig', () => {
     expect(defaultTemplate).to.contain('ComponentName');
     if (result.scaffold.templates[0].getNextSteps) {
       const componentpath = 'src/components/ComponentName.astro';
-      expect(
-        result.scaffold.templates[0].getNextSteps(componentpath)[0]
-      ).to.contain(
+      expect(result.scaffold.templates[0].getNextSteps(componentpath)[0]).to.contain(
         `* Implement the Astro component in ${chalk.green(componentpath)}`
       );
     }
@@ -59,9 +54,7 @@ describe('defineCliConfig', () => {
         ],
       },
       scaffold: {
-        templates: [
-          { name: 'existing template', generateTemplate: () => 'test' },
-        ],
+        templates: [{ name: 'existing template', generateTemplate: () => 'test' }],
       },
     };
 

package/src/config-cli/define-cli-config.ts

@@ -1,8 +1,5 @@
-import {
-  SitecoreCliConfigInput,
-  SitecoreCliConfig,
-} from '@sitecore-content-sdk/core/config';
-import { defineCliConfig as defineCliConfigCore } from '@sitecore-content-sdk/core/config-cli';
+import { SitecoreCliConfigInput, SitecoreCliConfig } from '@sitecore-content-sdk/content/config';
+import { defineCliConfig as defineCliConfigCore } from '@sitecore-content-sdk/content/config-cli';
 // import { byocTemplate } from '../tools/templating/byoc-component';
 import { defaultTemplate } from '../tools/templating/default-component';
 import { generateMap } from '../tools/generate-map';
@@ -12,10 +9,9 @@ import { generateMap } from '../tools/generate-map';
  * updated with the required default values.
  * @param {SitecoreCliConfigInput} cliConfig the cli configuration provided by the application
  * @returns {SitecoreCliConfig} full sitecore cli configuration to use with cli
+ * @public
  */
-export const defineCliConfig = (
-  cliConfig: SitecoreCliConfigInput
-): SitecoreCliConfig => {
+export const defineCliConfig = (cliConfig: SitecoreCliConfigInput): SitecoreCliConfig => {
   addDefaultScaffoldTemplates(cliConfig);
   addDefaultComponentMapGenerator(cliConfig);
   return defineCliConfigCore(cliConfig);

package/src/context.ts

@@ -1,11 +1,19 @@
 import { map } from 'nanostores';
 import { ComponentMap } from './sharedTypes/component-props';
-import { Page } from '@sitecore-content-sdk/core/client';
-import { SitecoreConfig } from '@sitecore-content-sdk/core/config';
-import { DictionaryPhrases } from '@sitecore-content-sdk/core/types/i18n';
+import { Page } from '@sitecore-content-sdk/content/client';
+import { SitecoreConfig } from '@sitecore-content-sdk/content/config';
+import { DictionaryPhrases } from '@sitecore-content-sdk/content/types/i18n';
 
+/**
+ * Nanostore map holding Sitecore page, API config, component map, and dictionary for the current request or app scope.
+ * @internal
+ */
 export const SitecoreContext: any = map({});
 
+/**
+ * Shape of values passed when updating {@link SitecoreContext} (page, API, and optional component map).
+ * @internal
+ */
 export interface SitecoreContextProps {
   /**
    * The API configuration defined in the `SitecoreConfig`.
@@ -21,6 +29,10 @@ export interface SitecoreContextProps {
   page: Page;
 }
 
+/**
+ * Shape of values passed when updating dictionary phrases on {@link SitecoreContext}.
+ * @internal
+ */
 export interface SitecoreDictionarytProps {
   /**
    * The dictionary data.
@@ -28,22 +40,33 @@ export interface SitecoreDictionarytProps {
   dictionary: DictionaryPhrases;
 }
 
-export const updateSitecoreContext = ({
-  page,
-  api,
-  componentMap,
-}: SitecoreContextProps) => {
+/**
+ * Writes page data, API config, and optional component map into {@link SitecoreContext}.
+ * @param {Page} props.page - The page data.
+ * @param {SitecoreConfig['api']} props.api - The API configuration.
+ * @param {ComponentMap} [props.componentMap] - Component map.
+ * @internal
+ */
+export const updateSitecoreContext = ({ page, api, componentMap }: SitecoreContextProps) => {
   SitecoreContext.setKey('page', page);
   SitecoreContext.setKey('api', api);
   SitecoreContext.setKey('componentMap', componentMap);
 };
 
-export const updateSitecoreDictionary = ({
-  dictionary,
-}: SitecoreDictionarytProps) => {
+/**
+ * Writes dictionary phrases into {@link SitecoreContext} for {@link useDictionary}.
+ * @param {SitecoreDictionarytProps} props
+ * @param {DictionaryPhrases} props.dictionary
+ * @internal
+ */
+export const updateSitecoreDictionary = ({ dictionary }: SitecoreDictionarytProps) => {
   SitecoreContext.setKey('dictionary', dictionary);
 };
 
+/**
+ * Returns the current page and API config from {@link SitecoreContext}.
+ * @public
+ */
 export const useSitecore = (): SitecoreContextProps => {
   return {
     page: SitecoreContext.get()['page'],
@@ -51,10 +74,18 @@ export const useSitecore = (): SitecoreContextProps => {
   };
 };
 
+/**
+ * Returns the component map from {@link SitecoreContext} for resolving rendering components.
+ * @public
+ */
 export const useComponentMap = (): ComponentMap => {
   return SitecoreContext.get()['componentMap'];
 };
 
+/**
+ * Returns a translator function `t(key)` that resolves keys against the dictionary on {@link SitecoreContext}, or returns the key if no dictionary is set.
+ * @public
+ */
 export const useDictionary = () => {
   const t = (key: string): string => {
     const dictionary = SitecoreContext.get()['dictionary'];

package/src/debug.ts

@@ -0,0 +1,13 @@
+import { debug as coreDebug } from '@sitecore-content-sdk/core';
+import { debug as contentDebug } from '@sitecore-content-sdk/content';
+
+/**
+ * Unified debug object containing all debug namespaces from referenced content-sdk packages.
+ * @public
+ */
+const debug: Record<string, debug.Debugger> = {
+  ...coreDebug,
+  ...contentDebug,
+};
+
+export default debug;

package/src/editing/editing-config-middleware.test.ts

@@ -1,9 +1,9 @@
 /* eslint-disable no-unused-expressions */
 import { expect } from 'chai';
 import { EditingConfigMiddleware } from './editing-config-middleware';
-import { QUERY_PARAM_EDITING_SECRET } from '@sitecore-content-sdk/core/editing';
+import { QUERY_PARAM_EDITING_SECRET } from '@sitecore-content-sdk/content/editing';
 import { AstroContentSdkComponent } from '../sharedTypes/component-props';
-import { mockRequest as MockRequest, Query } from '../test-data/helpers';
+import { mockRequest as MockRequest, Query } from '../tests/helpers';
 
 const allowedOrigin = 'https://allowed.com';
 
@@ -116,17 +116,15 @@ describe('EditingConfigMiddleware', () => {
     const res = await handler(req);
 
     expect(res.headers.has('Access-Control-Allow-Origin')).to.be.true;
-    expect(res.headers.get('Access-Control-Allow-Origin')).to.equal(
-      allowedOrigin
-    );
+    expect(res.headers.get('Access-Control-Allow-Origin')).to.include(allowedOrigin);
 
     expect(res.headers.has('Access-Control-Allow-Methods')).to.be.true;
-    expect(res.headers.get('Access-Control-Allow-Methods')).to.equal(
+    expect(res.headers.get('Access-Control-Allow-Methods')).to.include(
       'GET, POST, OPTIONS, DELETE, PUT, PATCH'
     );
 
     expect(res.headers.has('Access-Control-Allow-Headers')).to.be.true;
-    expect(res.headers.get('Access-Control-Allow-Headers')).to.equal(
+    expect(res.headers.get('Access-Control-Allow-Headers')).to.include(
       'Content-Type, Authorization'
     );
 

package/src/editing/editing-config-middleware.ts

@@ -1,14 +1,18 @@
 import {
   EDITING_ALLOWED_ORIGINS,
   QUERY_PARAM_EDITING_SECRET,
-} from '@sitecore-content-sdk/core/editing';
-import { debug } from '@sitecore-content-sdk/core';
-import { Metadata } from '@sitecore-content-sdk/core/editing';
-import { getEnforcedCorsHeaders } from '@sitecore-content-sdk/core/utils';
-import { EditMode } from '@sitecore-content-sdk/core/layout';
+} from '@sitecore-content-sdk/content/editing';
+import debug from '../debug';
+import { Metadata } from '@sitecore-content-sdk/core/node-tools';
+import { getEnforcedCorsHeaders } from '@sitecore-content-sdk/core/tools';
+import { EditMode } from '@sitecore-content-sdk/content/layout';
 import { getEditingSecret } from '../utils';
 import { AstroContentSdkComponent, ComponentMap } from '../sharedTypes/component-props';
 
+/**
+ * The interface for the EditingConfigMiddleware configuration.
+ * @public
+ */
 export type EditingConfigMiddlewareConfig = {
   /**
    * Components available in the application
@@ -23,6 +27,7 @@ export type EditingConfigMiddlewareConfig = {
 /**
  * Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
  * provides configuration information to determine feature compatibility on Pages side.
+ * @public
  */
 export class EditingConfigMiddleware {
   /**
@@ -39,7 +44,7 @@ export class EditingConfigMiddleware {
   }
 
   private handler = async (_req: Request): Promise<Response> => {
-    const url = new URL(_req.url.toLowerCase());
+    const url = new URL(_req.url);
     const secret = url.searchParams.get(QUERY_PARAM_EDITING_SECRET);
 
     const _res = new Response();
@@ -88,7 +93,6 @@ export class EditingConfigMiddleware {
     if (_req.method === 'OPTIONS') {
       debug.editing('preflight request');
 
-      // CORS headers are set by enforceCors
       return new Response(null, {
         status: 204,
         headers: _res.headers,