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

package/src/tools/generate-map.ts

@@ -2,14 +2,15 @@ import {
   GenerateMapArgs,
   GenerateMapFunction,
   ComponentMapTemplate,
-} from '@sitecore-content-sdk/core/tools';
+} from '@sitecore-content-sdk/content/tools';
 import path from 'path';
 import fs from 'fs';
 import { getComponentList } from './templating/components';
 
 /**
  * Generate and write componentMap.ts file based on provided params.
- * @param {GenerateMapArgs} param0 params for generateMap
+ * @param {GenerateMapArgs} param - the parameters for the generateMap function.
+ * @public
  */
 export const generateMap: GenerateMapFunction = ({
   paths,
@@ -64,7 +65,7 @@ const buildAstroMapContent: ComponentMapTemplate = (components, componentImports
   });
 
   return `//@ts-nocheck
-import { AstroContentSdkComponent } from '@astro-sitecore-jss/astro-content-sdk';
+import type { AstroContentSdkComponent } from '@exdst-sitecore-content-sdk/astro';
 
 // Components imported from the app itself
 ${wildcardImports.join('\n')}

package/src/tools/index.ts

@@ -1,7 +1,5 @@
-export {
-  generateSites,
-  generateMetadata,
-} from '@sitecore-content-sdk/core/tools';
+export { generateMetadata } from '@sitecore-content-sdk/core/node-tools';
+export { generateSites } from '@sitecore-content-sdk/content/node-tools';
 
 export { generateMap } from './generate-map';
 

package/src/tools/templating/components.test.ts

@@ -2,7 +2,7 @@
 import { expect } from 'chai';
 import sinon from 'sinon';
 import { getComponentList } from './components';
-import { ComponentFile } from '@sitecore-content-sdk/core/tools';
+import { ComponentFile } from '@sitecore-content-sdk/content/tools';
 import path from 'path';
 
 describe('components', () => {
@@ -19,151 +19,160 @@ describe('components', () => {
     it('should return results when one of "paths" is a glob pattern', () => {
       const items = [
         {
-          importPath: 'src/test-data/components/Qux',
-          filePath: path.normalize('src/test-data/components/Qux.astro'),
+          importPath: 'src/tests/test-components/map-components/Qux',
+          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
           componentName: 'Qux',
           moduleName: 'Qux',
         },
         {
-          importPath: 'src/test-data/components/Foo',
-          filePath: path.normalize('src/test-data/components/Foo.astro'),
+          importPath: 'src/tests/test-components/map-components/Foo',
+          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
           componentName: 'Foo',
           moduleName: 'Foo',
         },
         {
-          importPath: 'src/test-data/components/Baz',
-          filePath: path.normalize('src/test-data/components/Baz.astro'),
+          importPath: 'src/tests/test-components/map-components/Baz',
+          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
           componentName: 'Baz',
           moduleName: 'Baz',
         },
         {
-          importPath: 'src/test-data/components/Bar',
-          filePath: path.normalize('src/test-data/components/Bar.astro'),
+          importPath: 'src/tests/test-components/map-components/Bar',
+          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
           componentName: 'Bar',
           moduleName: 'Bar',
         },
       ] as ComponentFile[];
 
-      const result = getComponentList(['src/test-data/components/*.astro'], ['**/*.test.*'], false);
+      const result = getComponentList(
+        ['src/tests/test-components/map-components/*.astro'],
+        ['**/*.test.*'],
+        false
+      );
       expect(result).to.deep.equal(items);
     });
 
     it('should return results with all folded paths when path is a non-glob path', () => {
       const items = [
         {
-          importPath: 'src/test-data/components/Qux',
-          filePath: path.normalize('src/test-data/components/Qux.astro'),
+          importPath: 'src/tests/test-components/map-components/Qux',
+          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
           componentName: 'Qux',
           moduleName: 'Qux',
         },
         {
-          importPath: 'src/test-data/components/Foo',
-          filePath: path.normalize('src/test-data/components/Foo.astro'),
+          importPath: 'src/tests/test-components/map-components/Foo',
+          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
           componentName: 'Foo',
           moduleName: 'Foo',
         },
         {
-          importPath: 'src/test-data/components/Baz',
-          filePath: path.normalize('src/test-data/components/Baz.astro'),
+          importPath: 'src/tests/test-components/map-components/Baz',
+          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
           componentName: 'Baz',
           moduleName: 'Baz',
         },
         {
-          importPath: 'src/test-data/components/Bar',
-          filePath: path.normalize('src/test-data/components/Bar.astro'),
+          importPath: 'src/tests/test-components/map-components/Bar',
+          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
           componentName: 'Bar',
           moduleName: 'Bar',
         },
         {
-          importPath: 'src/test-data/components/folded/Folded',
-          filePath: path.normalize('src/test-data/components/folded/Folded.astro'),
+          importPath: 'src/tests/test-components/map-components/folded/Folded',
+          filePath: path.normalize('src/tests/test-components/map-components/folded/Folded.astro'),
           componentName: 'Folded',
           moduleName: 'Folded',
         },
       ] as ComponentFile[];
 
-      const result = getComponentList(['src/test-data/components'], ['**/*.test.*'], false);
+      const result = getComponentList(
+        ['src/tests/test-components/map-components'],
+        ['**/*.test.*'],
+        false
+      );
       expect(result).to.deep.equal(items);
     });
 
     it('should filter out results that are not components', () => {
       const items = [
         {
-          importPath: 'src/test-data/components/Qux',
-          filePath: path.normalize('src/test-data/components/Qux.astro'),
+          importPath: 'src/tests/test-components/map-components/Qux',
+          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
           componentName: 'Qux',
           moduleName: 'Qux',
         },
         {
-          importPath: 'src/test-data/components/Foo',
-          filePath: path.normalize('src/test-data/components/Foo.astro'),
+          importPath: 'src/tests/test-components/map-components/Foo',
+          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
           componentName: 'Foo',
           moduleName: 'Foo',
         },
         {
-          importPath: 'src/test-data/components/Baz',
-          filePath: path.normalize('src/test-data/components/Baz.astro'),
+          importPath: 'src/tests/test-components/map-components/Baz',
+          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
           componentName: 'Baz',
           moduleName: 'Baz',
         },
         {
-          importPath: 'src/test-data/components/Bar',
-          filePath: path.normalize('src/test-data/components/Bar.astro'),
+          importPath: 'src/tests/test-components/map-components/Bar',
+          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
           componentName: 'Bar',
           moduleName: 'Bar',
         },
         {
-          importPath: 'src/test-data/components/folded/Folded',
-          filePath: path.normalize('src/test-data/components/folded/Folded.astro'),
+          importPath: 'src/tests/test-components/map-components/folded/Folded',
+          filePath: path.normalize('src/tests/test-components/map-components/folded/Folded.astro'),
           componentName: 'Folded',
           moduleName: 'Folded',
         },
       ] as ComponentFile[];
 
-      const result = getComponentList(['src/test-data/components/**/*']);
+      const result = getComponentList(['src/tests/test-components/map-components/**/*']);
       expect(result).to.deep.equal(items);
     });
 
     it('should return result when "paths" contain exact paths to Astro components', () => {
       const items = [
         {
-          importPath: 'src/test-data/components/Foo',
-          filePath: path.normalize('src/test-data/components/Foo.astro'),
+          importPath: 'src/tests/test-components/map-components/Foo',
+          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
           componentName: 'Foo',
           moduleName: 'Foo',
         },
         {
-          importPath: 'src/test-data/components/Bar',
-          filePath: path.normalize('src/test-data/components/Bar.astro'),
+          importPath: 'src/tests/test-components/map-components/Bar',
+          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
           componentName: 'Bar',
           moduleName: 'Bar',
         },
         {
-          importPath: 'src/test-data/components/Baz',
-          filePath: path.normalize('src/test-data/components/Baz.astro'),
+          importPath: 'src/tests/test-components/map-components/Baz',
+          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
           componentName: 'Baz',
           moduleName: 'Baz',
         },
         {
-          importPath: 'src/test-data/components/Qux',
-          filePath: path.normalize('src/test-data/components/Qux.astro'),
+          importPath: 'src/tests/test-components/map-components/Qux',
+          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
           componentName: 'Qux',
           moduleName: 'Qux',
         },
       ];
 
       const result = getComponentList([
-        'src/test-data/components/Foo.astro',
-        'src/test-data/components/Bar.astro',
-        'src/test-data/components/Baz.astro',
-        'src/test-data/components/Qux.astro',
+        'src/tests/test-components/map-components/Foo.astro',
+        'src/tests/test-components/map-components/Bar.astro',
+        'src/tests/test-components/map-components/Baz.astro',
+        'src/tests/test-components/map-components/Qux.astro',
       ]);
       expect(result).to.deep.equal(items);
     });
 
     it('should return filtered results when "exclude" contains a glob pattern', () => {
-      const exclude = ['**/components/**'];
-      expect(getComponentList(['src/test-data/components/*.astro'], exclude)).to.be.empty;
+      const exclude = ['**/test-components/map-components/**'];
+      expect(getComponentList(['src/tests/test-components/map-components/*.astro'], exclude)).to.be
+        .empty;
     });
 
     it('should return variants in results when includeVariants is true', () => {
@@ -171,82 +180,86 @@ describe('components', () => {
 
       const items = [
         {
-          importPath: 'src/test-data/components/Qux',
-          filePath: path.normalize('src/test-data/components/Qux.astro'),
+          importPath: 'src/tests/test-components/map-components/Qux',
+          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
           componentName: 'Qux',
           moduleName: 'Qux',
         },
         // variant component
         {
-          importPath: 'src/test-data/components/Hero.variant',
-          filePath: path.normalize('src/test-data/components/Hero.variant.astro'),
+          importPath: 'src/tests/test-components/map-components/Hero.variant',
+          filePath: path.normalize('src/tests/test-components/map-components/Hero.variant.astro'),
           componentName: 'Hero.variant',
           moduleName: 'Herovariant',
         },
         {
-          importPath: 'src/test-data/components/Foo',
-          filePath: path.normalize('src/test-data/components/Foo.astro'),
+          importPath: 'src/tests/test-components/map-components/Foo',
+          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
           componentName: 'Foo',
           moduleName: 'Foo',
         },
         {
-          importPath: 'src/test-data/components/Baz',
-          filePath: path.normalize('src/test-data/components/Baz.astro'),
+          importPath: 'src/tests/test-components/map-components/Baz',
+          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
           componentName: 'Baz',
           moduleName: 'Baz',
         },
         {
-          importPath: 'src/test-data/components/Bar',
-          filePath: path.normalize('src/test-data/components/Bar.astro'),
+          importPath: 'src/tests/test-components/map-components/Bar',
+          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
           componentName: 'Bar',
           moduleName: 'Bar',
         },
         {
-          importPath: 'src/test-data/components/folded/Folded',
-          filePath: path.normalize('src/test-data/components/folded/Folded.astro'),
+          importPath: 'src/tests/test-components/map-components/folded/Folded',
+          filePath: path.normalize('src/tests/test-components/map-components/folded/Folded.astro'),
           componentName: 'Folded',
           moduleName: 'Folded',
         },
       ] as ComponentFile[];
 
-      const result = getComponentList(['src/test-data/components'], ['**/*.test.*'], true);
+      const result = getComponentList(
+        ['src/tests/test-components/map-components'],
+        ['**/*.test.*'],
+        true
+      );
       expect(result).to.deep.equal(items);
     });
 
     it('should return filtered results when "exclude" contains an exact path', () => {
-      const exclude = ['src/test-data/components/Foo.astro'];
-      getComponentList(['src/test-data/components/*.astro'], exclude);
+      const exclude = ['src/tests/test-components/map-components/Foo.astro'];
+      getComponentList(['src/tests/test-components/map-components/*.astro'], exclude);
     });
 
     it('should return correct result in unix file systems', () => {
       const stubbedPaths = [
-        'src/test-data/components/Foo.astro',
-        'src/test-data/components/Bar.astro',
-        'src/test-data/components/Baz.astro',
-        'src/test-data/components/Qux.astro',
+        'src/tests/test-components/map-components/Foo.astro',
+        'src/tests/test-components/map-components/Bar.astro',
+        'src/tests/test-components/map-components/Baz.astro',
+        'src/tests/test-components/map-components/Qux.astro',
       ];
       const expected = [
         {
-          importPath: 'src/test-data/components/Foo',
-          filePath: 'src/test-data/components/Foo.astro',
+          importPath: 'src/tests/test-components/map-components/Foo',
+          filePath: 'src/tests/test-components/map-components/Foo.astro',
           componentName: 'Foo',
           moduleName: 'Foo',
         },
         {
-          importPath: 'src/test-data/components/Bar',
-          filePath: 'src/test-data/components/Bar.astro',
+          importPath: 'src/tests/test-components/map-components/Bar',
+          filePath: 'src/tests/test-components/map-components/Bar.astro',
           componentName: 'Bar',
           moduleName: 'Bar',
         },
         {
-          importPath: 'src/test-data/components/Baz',
-          filePath: 'src/test-data/components/Baz.astro',
+          importPath: 'src/tests/test-components/map-components/Baz',
+          filePath: 'src/tests/test-components/map-components/Baz.astro',
           componentName: 'Baz',
           moduleName: 'Baz',
         },
         {
-          importPath: 'src/test-data/components/Qux',
-          filePath: 'src/test-data/components/Qux.astro',
+          importPath: 'src/tests/test-components/map-components/Qux',
+          filePath: 'src/tests/test-components/map-components/Qux.astro',
           componentName: 'Qux',
           moduleName: 'Qux',
         },
@@ -254,7 +267,7 @@ describe('components', () => {
 
       const globSyncStub = sandbox.stub(require('glob'), 'sync').returns(stubbedPaths);
 
-      const result = getComponentList(['src/test-data/components/*.astro']);
+      const result = getComponentList(['src/tests/test-components/map-components/*.astro']);
       expect(result).to.deep.equal(expected);
 
       globSyncStub.restore();
@@ -262,33 +275,33 @@ describe('components', () => {
 
     it('should return correct result in windows file systems', () => {
       const stubbedPaths = [
-        'src\\test-data\\components\\Foo.astro',
-        'src\\test-data\\components\\Bar.astro',
-        'src\\test-data\\components\\Baz.astro',
-        'src\\test-data\\components\\Qux.astro',
+        'src\\tests\\test-components\\map-components\\Foo.astro',
+        'src\\tests\\test-components\\map-components\\Bar.astro',
+        'src\\tests\\test-components\\map-components\\Baz.astro',
+        'src\\tests\\test-components\\map-components\\Qux.astro',
       ];
       const expected = [
         {
-          importPath: 'src/test-data/components/Foo',
-          filePath: 'src\\test-data\\components\\Foo.astro',
+          importPath: 'src/tests/test-components/map-components/Foo',
+          filePath: 'src\\tests\\test-components\\map-components\\Foo.astro',
           componentName: 'Foo',
           moduleName: 'Foo',
         },
         {
-          importPath: 'src/test-data/components/Bar',
-          filePath: 'src\\test-data\\components\\Bar.astro',
+          importPath: 'src/tests/test-components/map-components/Bar',
+          filePath: 'src\\tests\\test-components\\map-components\\Bar.astro',
           componentName: 'Bar',
           moduleName: 'Bar',
         },
         {
-          importPath: 'src/test-data/components/Baz',
-          filePath: 'src\\test-data\\components\\Baz.astro',
+          importPath: 'src/tests/test-components/map-components/Baz',
+          filePath: 'src\\tests\\test-components\\map-components\\Baz.astro',
           componentName: 'Baz',
           moduleName: 'Baz',
         },
         {
-          importPath: 'src/test-data/components/Qux',
-          filePath: 'src\\test-data\\components\\Qux.astro',
+          importPath: 'src/tests/test-components/map-components/Qux',
+          filePath: 'src\\tests\\test-components\\map-components\\Qux.astro',
           componentName: 'Qux',
           moduleName: 'Qux',
         },
@@ -296,7 +309,7 @@ describe('components', () => {
 
       const globSyncStub = sandbox.stub(require('glob'), 'sync').returns(stubbedPaths);
 
-      const result = getComponentList(['src/test-data/components/*.astro']);
+      const result = getComponentList(['src/tests/test-components/map-components/*.astro']);
       expect(result).to.deep.equal(expected);
 
       globSyncStub.restore();

package/src/tools/templating/components.ts

@@ -1,5 +1,5 @@
 import * as glob from 'glob';
-import { ComponentFile } from '@sitecore-content-sdk/core/tools';
+import { ComponentFile } from '@sitecore-content-sdk/content/tools';
 
 const componentNamePattern = /^[\/]*(.+[\/\\])*(.+)\.astro?$/;
 
@@ -16,6 +16,7 @@ const componentPathPattern = /^([\/]*.+[\/\\].+)\..+$/;
  * @param {string[]} paths paths to search
  * @param {string[]} [exclude] paths and glob patterns to exclude from final result
  * @param {boolean} [includeVariants] whether to include variant components
+ * @internal
  */
 export function getComponentList(
   paths: string[],

package/src/tools/templating/default-component.ts

@@ -1,8 +1,5 @@
 import chalk from 'chalk';
-import {
-  ScaffoldTemplate,
-  ComponentTemplateType,
-} from '@sitecore-content-sdk/core/config';
+import { ScaffoldTemplate, ComponentTemplateType } from '@sitecore-content-sdk/content/config';
 import { COMPONENT_FILE_EXTENSION } from './constants';
 
 /**
@@ -13,7 +10,7 @@ import { COMPONENT_FILE_EXTENSION } from './constants';
 const generateTemplate = (componentName: string): string => {
   return `
   ---
-  import { Field } from "@astro-sitecore-jss/astro-content-sdk";
+  import { Field } from "@exdst-sitecore-content-sdk/astro";
   
   interface Fields {
     Title: Field<string>;
@@ -47,9 +44,7 @@ const getNextSteps = (componentOutputPath: string): string[] => {
   const nextSteps = [];
 
   if (componentOutputPath) {
-    nextSteps.push(
-      `* Implement the Astro component in ${chalk.green(componentOutputPath)}`
-    );
+    nextSteps.push(`* Implement the Astro component in ${chalk.green(componentOutputPath)}`);
   }
 
   return nextSteps;

package/src/utils/utils.ts

@@ -1,12 +1,21 @@
+/**
+ * @internal
+ */
 export const getEditingSecret = (): string => {
-  const secret = import.meta.env?.SITECORE_EDITING_SECRET || process.env.SITECORE_EDITING_SECRET;
+  const secret = process.env.SITECORE_EDITING_SECRET;
 
   if (!secret || secret.length === 0) {
     throw new Error('The SITECORE_EDITING_SECRET environment variable is missing or invalid.');
   }
-  return secret.toLowerCase();
+  return secret;
 };
 
+/**
+ * Extracts the path from the Astro context parameters.
+ * @param {Record<string, string | undefined>} params - The Astro context parameters.
+ * @returns The extracted path.
+ * @public
+ */
 export const extractPath = (params: Record<string, string | undefined>) => {
   return params === undefined
     ? '/'
@@ -15,6 +24,14 @@ export const extractPath = (params: Record<string, string | undefined>) => {
     : params.path ?? '/';
 };
 
+/**
+ * Removes a leading language segment from a given path.
+ * Handles paths with or without a preceding `_site_` segment (e.g. `/en/About`, `/_site_Basic/en/About`).
+ * @param {string} path - The path that may contain a language segment.
+ * @param {string[]} languages - The list of supported language codes to strip from the path.
+ * @returns The path without the leading language segment, defaulting to `'/'` when empty.
+ * @public
+ */
 export const removeLanguageFromPath = (path: string, languages: string[]): string => {
   const segments = path.split('/');
 
@@ -36,6 +53,7 @@ export const removeLanguageFromPath = (path: string, languages: string[]): strin
  * "class" property will be transformed into or appended to "className" instead.
  * @param {string} otherAttrs all other props included on the image component
  * @returns {void}
+ * @public
  */
 export const addClassName = (otherAttrs: { [key: string]: unknown }): void => {
   if (otherAttrs.class) {