@exdst-sitecore-content-sdk/astro 0.0.23 → 0.0.25

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@exdst-sitecore-content-sdk/astro",
-  "version": "0.0.23",
+  "version": "0.0.25",
+  "description": "Astro Content SDK for Sitecore AI (XM Cloud)",
   "type": "module",
   "sideEffects": false,
   "publishConfig": {
@@ -9,13 +10,13 @@
   },
   "scripts": {
     "typecheck": "tsc -p tsconfig.json",
+    "build:types": "tsc -p tsconfig.build.json",
     "lint": "eslint \"./src/**/*.ts\"",
-    "test": "npm run test:unit & npm run test:components",
+    "test": "npm run test:unit && npm run test:components",
     "test:unit": "mocha \"./src/**/*.test.ts\" --ignore \"src/**/*.astro.test.ts\"",
     "test:components": "vitest run --config ./vitest.config.ts",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/core --entryPoints src/index.ts --entryPoints src/config/index.ts --entryPoints src/client/index.ts --entryPoints src/i18n/index.ts --entryPoints src/layout/index.ts --entryPoints src/media/index.ts --entryPoints src/personalize/index.ts --entryPoints src/site/index.ts --entryPoints src/tracking/index.ts --entryPoints src/utils/index.ts --entryPoints src/editing/index.ts --entryPoints src/tools/index.ts --githubPages false",
-    "api-extractor": "npm run build && api-extractor run --local --verbose",
+    "api-extractor": "api-extractor run --local --verbose",
     "api-extractor:verify": "api-extractor run"
   },
   "engines": {
@@ -49,7 +50,7 @@
     "@types/sinon-chai": "^4.0.0",
     "@typescript-eslint/eslint-plugin": "8.39.0",
     "@typescript-eslint/parser": "8.39.0",
-    "astro": "^6.1.2",
+    "astro": "^6.1.3",
     "chai": "^4.4.1",
     "chai-spies": "^1.1.0",
     "chai-string": "^1.6.0",
@@ -58,7 +59,6 @@
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-jsdoc": "52.0.3",
     "eslint-plugin-prettier": "^4.0.0",
-    "glob": "^11.0.2",
     "happy-dom": "^16.7.3",
     "mocha": "^11.2.2",
     "nyc": "^17.1.0",
@@ -72,7 +72,8 @@
   },
   "peerDependencies": {
     "@sitecore-content-sdk/analytics-core": "^2.0.1",
-    "@sitecore-content-sdk/events": "^2.0.1"
+    "@sitecore-content-sdk/events": "^2.0.1",
+    "astro": "^6.0.0"
   },
   "dependencies": {
     "@sitecore-content-sdk/content": "^2.0.1",
@@ -96,11 +97,5 @@
     "./tools": "./src/tools/index.ts",
     "./utils": "./src/utils/index.ts",
     "./components/Placeholder": "./src/components/Placeholder/index.ts"
-  },
-  "description": "",
-  "files": [
-    "src",
-    "index.ts",
-    "readme.md"
-  ]
+  }
 }

package/src/client/sitecore-astro-client.ts

@@ -7,7 +7,6 @@ import {
   SitecoreClientInit,
 } from '@sitecore-content-sdk/content/client';
 import { PreviewData } from '../sharedTypes/component-props';
-import { ComponentPropsService } from '../services/component-props-service';
 import { EditingPreviewData } from '@sitecore-content-sdk/content/editing';
 import { getSiteRewriteData, normalizeSiteRewrite } from '@sitecore-content-sdk/content/site';
 import {
@@ -27,10 +26,8 @@ export type SitecoreAstroClientInit = SitecoreClientInit & Pick<SitecoreConfig,
  * @public
  */
 export class SitecoreAstroClient extends SitecoreClient {
-  protected componentPropsService: ComponentPropsService;
   constructor(protected initOptions: SitecoreAstroClientInit) {
     super(initOptions);
-    this.componentPropsService = this.getComponentPropsService();
   }
 
   /**
@@ -109,46 +106,4 @@ export class SitecoreAstroClient extends SitecoreClient {
 
     return staticPaths;
   }
-
-  // /**
-  //  * Parses components from component map and layoutData, executes getServerProps/getStaticProps methods
-  //  * and returns resulting props from components
-  //  * @param {LayoutServiceData} layoutData layout data to parse compnents from
-  //  * @param {ComponentMap<AstroContentSdkComponent>} components component map to get props for
-  //  * @returns {ComponentPropsCollection} component props
-  //  */
-  // async getComponentData(
-  //   layoutData: LayoutServiceData,
-  //   // context: GetServerSidePropsContext | GetStaticPropsContext,
-  //   components: ComponentMap<AstroContentSdkComponent>
-  // ): Promise<ComponentPropsCollection> {
-  //   let componentProps: ComponentPropsCollection = {};
-  //   if (!layoutData.sitecore.route) return componentProps;
-  //   // Retrieve component props using side-effects defined on components level
-  //   componentProps = await this.componentPropsService.fetchComponentProps({
-  //     layoutData: layoutData,
-  //     // context,
-  //     components,
-  //   });
-
-  //   const errors = Object.keys(componentProps)
-  //     .map((id) => {
-  //       const component = componentProps[id] as ComponentPropsError;
-
-  //       return component.error
-  //         ? `\nUnable to get component props for ${component.componentName} (${id}): ${component.error}`
-  //         : '';
-  //     })
-  //     .join('');
-
-  //   if (errors.length) {
-  //     throw new Error(errors);
-  //   }
-
-  //   return componentProps;
-  // }
-
-  protected getComponentPropsService(): ComponentPropsService {
-    return new ComponentPropsService();
-  }
 }

package/src/context.ts

@@ -2,7 +2,7 @@ import { map } from 'nanostores';
 import { ComponentMap } from './sharedTypes/component-props';
 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';
+import { DictionaryPhrases } from '@sitecore-content-sdk/content/i18n';
 
 /**
  * Nanostore map holding Sitecore page, API config, component map, and dictionary for the current request or app scope.
@@ -12,7 +12,7 @@ export const SitecoreContext: any = map({});
 
 /**
  * Shape of values passed when updating {@link SitecoreContext} (page, API, and optional component map).
- * @internal
+ * @public
  */
 export interface SitecoreContextProps {
   /**
@@ -31,9 +31,9 @@ export interface SitecoreContextProps {
 
 /**
  * Shape of values passed when updating dictionary phrases on {@link SitecoreContext}.
- * @internal
+ * @public
  */
-export interface SitecoreDictionarytProps {
+export interface SitecoreDictionaryProps {
   /**
    * The dictionary data.
    */
@@ -42,10 +42,8 @@ export interface SitecoreDictionarytProps {
 
 /**
  * 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
+ * @param {SitecoreContextProps} props - Page, API, and optional component map.
+ * @public
  */
 export const updateSitecoreContext = ({ page, api, componentMap }: SitecoreContextProps) => {
   SitecoreContext.setKey('page', page);
@@ -55,11 +53,10 @@ export const updateSitecoreContext = ({ page, api, componentMap }: SitecoreConte
 
 /**
  * Writes dictionary phrases into {@link SitecoreContext} for {@link useDictionary}.
- * @param {SitecoreDictionarytProps} props
- * @param {DictionaryPhrases} props.dictionary
- * @internal
+ * @param {DictionaryPhrases} dictionary - The dictionary data.
+ * @public
  */
-export const updateSitecoreDictionary = ({ dictionary }: SitecoreDictionarytProps) => {
+export const updateSitecoreDictionary = ({ dictionary }: SitecoreDictionaryProps) => {
   SitecoreContext.setKey('dictionary', dictionary);
 };
 
@@ -68,9 +65,10 @@ export const updateSitecoreDictionary = ({ dictionary }: SitecoreDictionarytProp
  * @public
  */
 export const useSitecore = (): SitecoreContextProps => {
+  const context = SitecoreContext.get();
   return {
-    page: SitecoreContext.get()['page'],
-    api: SitecoreContext.get()['api'],
+    page: context.page,
+    api: context.api,
   };
 };
 
@@ -79,7 +77,7 @@ export const useSitecore = (): SitecoreContextProps => {
  * @public
  */
 export const useComponentMap = (): ComponentMap => {
-  return SitecoreContext.get()['componentMap'];
+  return SitecoreContext.get().componentMap;
 };
 
 /**
@@ -88,7 +86,7 @@ export const useComponentMap = (): ComponentMap => {
  */
 export const useDictionary = () => {
   const t = (key: string): string => {
-    const dictionary = SitecoreContext.get()['dictionary'];
+    const dictionary = SitecoreContext.get().dictionary;
     if (!dictionary) {
       return key;
     }

package/src/env.d.ts

@@ -1,5 +1,5 @@
 /* eslint-disable spaced-comment */
-/* eslint-disable @typescript-eslint/triple-slash-reference */
+/* eslint-disable no-unused-vars */
 /// <reference types="astro/client" />
 declare global {
   namespace App {

package/src/sharedTypes/component-props.ts

@@ -1,13 +1,3 @@
-export type ComponentPropsError = { error: string; componentName: string };
-
-/**
- * Shape of component props storage
- * @public
- */
-export type ComponentPropsCollection = {
-  [componentUid: string]: unknown | ComponentPropsError;
-};
-
 /**
  * Represents an Astro component import
  * @public

package/src/tools/generate-map.ts

@@ -36,40 +36,28 @@ export const generateMap: GenerateMapFunction = ({
 };
 
 const buildAstroMapContent: ComponentMapTemplate = (components, componentImports): string => {
-  const wildcardImports: string[] = [];
-  const namedImports: string[] = [];
-
+  const componentImportsList: string[] = [];
   const componentMapEntries: string[] = [];
 
   components.forEach((component) => {
-    wildcardImports.push(`import ${component.moduleName} from '${component.importPath}.astro';`);
+    componentImportsList.push(
+      `import ${component.moduleName} from '${component.importPath}.astro';`
+    );
     componentMapEntries.push(`['${component.moduleName}', ${component.moduleName}]`);
   });
 
   componentImports?.forEach((packageEntry) => {
-    if (packageEntry.importInfo.namedImports) {
-      namedImports.push(
-        `import { ${packageEntry.importInfo.namedImports.join(', ')} } from '${
-          packageEntry.importInfo.importFrom
-        }.astro';`
-      );
-      packageEntry.importInfo.namedImports.forEach((importName) => {
-        componentMapEntries.push(`['${importName}', ${importName}]`);
-      });
-    } else {
-      wildcardImports.push(
-        `import ${packageEntry.importName} from '${packageEntry.importInfo.importFrom}';`
-      );
-      componentMapEntries.push(`['${packageEntry.importName}', ${packageEntry.importName}]`);
-    }
+    componentImportsList.push(
+      `import ${packageEntry.importName} from '${packageEntry.importInfo.importFrom}';`
+    );
+    componentMapEntries.push(`['${packageEntry.importName}', ${packageEntry.importName}]`);
   });
 
   return `
 import type { AstroContentSdkComponent } from '@exdst-sitecore-content-sdk/astro';
 
 // Components imported from the app itself
-${wildcardImports.join('\n')}
-${namedImports.join('\n')}
+${componentImportsList.join('\n')}
 
 // Components must be registered within the map to match the string key with component name in Sitecore
 export const componentMap = new Map<string, AstroContentSdkComponent>([

package/src/client/sitecore-astro-client.test.ts

@@ -1,292 +0,0 @@
-/* eslint-disable no-unused-vars */
-/* eslint-disable no-unused-expressions, @typescript-eslint/no-unused-expressions */
-import { expect } from 'chai';
-import * as chai from 'chai';
-import sinon from 'sinon';
-import sinonChai from 'sinon-chai';
-import { SitecoreAstroClient } from './sitecore-astro-client';
-import { DefaultRetryStrategy } from '@sitecore-content-sdk/core';
-import { SITE_PREFIX } from '@sitecore-content-sdk/content/site';
-import { layoutData, componentsWithExperiencesArray } from '../tests/personalizeData';
-import { VARIANT_PREFIX } from '@sitecore-content-sdk/content/personalize';
-
-chai.use(sinonChai);
-
-describe('SitecoreClient', () => {
-  const sandbox = sinon.createSandbox();
-  const defaultInitOptions = {
-    api: {
-      edge: {
-        contextId: 'test-context-id',
-        clientContextId: 'client-context-id',
-        edgeUrl: 'https://edge.example.com',
-      },
-      local: {
-        apiHost: 'http://local.example.com',
-        apiKey: 'test-api-key',
-        path: '/api/graph/test',
-      },
-    },
-    editingSecret: '********-****',
-    retries: {
-      count: 3,
-      retryStrategy: sinon.createStubInstance(DefaultRetryStrategy),
-    },
-    defaultSite: 'default-site',
-    defaultLanguage: 'en',
-    layout: { formatLayoutQuery: sandbox.stub() },
-    dictionary: { caching: { enabled: true, timeout: 60000 } },
-    disableCodeGeneration: false,
-  };
-
-  let sitecoreClient = new SitecoreAstroClient(defaultInitOptions);
-
-  let layoutServiceStub = {
-    fetchLayoutData: sandbox.stub(),
-  };
-  let dictionaryServiceStub = {
-    fetchDictionaryData: sandbox.stub(),
-  };
-  let errorPagesServiceStub = {
-    fetchErrorPages: sandbox.stub(),
-  };
-  let editingServiceStub = {
-    fetchEditingData: sandbox.stub(),
-    fetchDictionaryData: sandbox.stub(),
-  };
-  let restComponentServiceStub = {
-    fetchComponentData: sandbox.stub(),
-  };
-  let sitePathServiceStub = {
-    fetchSiteRoutes: sandbox.stub(),
-  };
-
-  beforeEach(() => {
-    layoutServiceStub = {
-      fetchLayoutData: sandbox.stub(),
-    };
-    dictionaryServiceStub = {
-      fetchDictionaryData: sandbox.stub(),
-    };
-    errorPagesServiceStub = {
-      fetchErrorPages: sandbox.stub(),
-    };
-    editingServiceStub = {
-      fetchEditingData: sandbox.stub(),
-      fetchDictionaryData: sandbox.stub(),
-    };
-    restComponentServiceStub = {
-      fetchComponentData: sandbox.stub(),
-    };
-    sitePathServiceStub = {
-      fetchSiteRoutes: sandbox.stub(),
-    };
-
-    sitecoreClient = new SitecoreAstroClient(defaultInitOptions);
-
-    (sitecoreClient as any).layoutService = layoutServiceStub;
-    (sitecoreClient as any).dictionaryService = dictionaryServiceStub;
-    (sitecoreClient as any).errorPagesService = errorPagesServiceStub;
-    (sitecoreClient as any).editingService = editingServiceStub;
-    (sitecoreClient as any).componentService = restComponentServiceStub;
-    (sitecoreClient as any).sitePathService = sitePathServiceStub;
-  });
-
-  describe('getPage', () => {
-    it('should personalize page layout when variants present in path', async () => {
-      const path = `${VARIANT_PREFIX}variant1/${VARIANT_PREFIX}mountain_bike_audience/test/path`;
-      const locale = 'en-US';
-      const testLayoutData = structuredClone(layoutData);
-
-      const siteInfo = {
-        name: 'default-site',
-        hostName: 'example.com',
-        language: 'en',
-      };
-      layoutServiceStub.fetchLayoutData.returns(testLayoutData);
-      sandbox.stub(sitecoreClient, 'getHeadLinks').returns([]);
-
-      const result = await sitecoreClient.getPage(path, { locale });
-
-      expect(result?.layout.sitecore.route?.placeholders).to.deep.equal({
-        'content-sdk-main': [...componentsWithExperiencesArray],
-      });
-    });
-
-    it('should use personalize details passed in page options over variants present in path', async () => {
-      const path = `${VARIANT_PREFIX}variant1/${VARIANT_PREFIX}sand_bike_audience/test/path`;
-      const locale = 'en-US';
-      const testLayoutData = structuredClone(layoutData);
-
-      const siteInfo = {
-        name: 'default-site',
-        hostName: 'example.com',
-        language: 'en',
-      };
-      layoutServiceStub.fetchLayoutData.returns(testLayoutData);
-      sandbox.stub(sitecoreClient, 'getHeadLinks').returns([]);
-
-      const result = await sitecoreClient.getPage(path, {
-        locale,
-        personalize: {
-          variantId: 'variant2',
-          componentVariantIds: ['mountain_bike_audience'],
-        },
-      });
-
-      expect(result?.layout.sitecore.route?.placeholders).to.deep.equal({
-        'content-sdk-main': [...componentsWithExperiencesArray],
-      });
-    });
-
-    it('should pass site from path to base getPage method', async () => {
-      const path = `${SITE_PREFIX}mysite/test/path`;
-      const locale = 'en-US';
-      const testLayoutData = structuredClone(layoutData);
-
-      sandbox.stub(sitecoreClient, 'parsePath').returns('/test/path');
-      layoutServiceStub.fetchLayoutData.returns(testLayoutData);
-
-      await sitecoreClient.getPage(path, {
-        locale,
-      });
-
-      expect(layoutServiceStub.fetchLayoutData).to.be.calledWithMatch('/test/path', {
-        locale,
-        site: 'mysite',
-      });
-    });
-
-    it('should use site passed in page options over site parsed from path', async () => {
-      const path = `${SITE_PREFIX}mysite/test/path`;
-      const locale = 'en-US';
-      const testLayoutData = structuredClone(layoutData);
-
-      sandbox.stub(sitecoreClient, 'parsePath').returns('/test/path');
-
-      layoutServiceStub.fetchLayoutData.returns(testLayoutData);
-
-      await sitecoreClient.getPage(path, {
-        locale,
-        site: 'other-site',
-      });
-
-      expect(layoutServiceStub.fetchLayoutData).to.be.calledWithMatch('/test/path', {
-        locale,
-        site: 'other-site',
-      });
-    });
-  });
-
-  describe('getSiteNameFromPath', () => {
-    it('should get site name correctly with string path', () => {
-      const path = '/some/path';
-      const siteInfo = { name: 'default-site', hostName: '*', language: 'en' };
-
-      const result = sitecoreClient.getSiteNameFromPath(path);
-
-      expect(result).to.equal(siteInfo.name);
-    });
-
-    it('should get site name correctly with array path', () => {
-      const path = [`${SITE_PREFIX}other-site`, '/some', 'path'];
-      const siteInfo = { name: 'other-site', hostName: '*', language: 'en' };
-
-      const result = sitecoreClient.getSiteNameFromPath(path);
-
-      expect(result).to.equal(siteInfo.name);
-    });
-
-    it('should get default site name when site not found', () => {
-      const path = ['wrong-path-yet-anoother-site', '/some', 'path'];
-
-      const result = sitecoreClient.getSiteNameFromPath(path);
-
-      expect(result).to.equal('default-site');
-    });
-  });
-
-  describe('parsePath', () => {
-    it('should return string path when accepting string[] path', () => {
-      const path = ['/some', 'path'];
-      const expectedPath = '/some/path';
-
-      const result = sitecoreClient.parsePath(path);
-
-      expect(result).to.equal(expectedPath);
-    });
-
-    it('should strip site and variant prefixes from path', () => {
-      const path = `/${SITE_PREFIX}site1/${VARIANT_PREFIX}variant1/some/path`;
-      const expectedPath = '/some/path';
-
-      const result = sitecoreClient.parsePath(path);
-
-      expect(result).to.equal(expectedPath);
-    });
-  });
-
-  describe('getPagePaths', () => {
-    it('should return static paths without site prefixes', async () => {
-      const paths = [
-        { params: { path: ['_site_site-one', 'home'] }, locale: 'en' },
-        { params: { path: ['_site_site-one', 'about'] }, locale: 'en' },
-        { params: { path: ['_site_site-two', 'home'] }, locale: 'de-DE' },
-      ];
-
-      const expectedPaths = [
-        { params: { path: ['home'] }, locale: 'en' },
-        { params: { path: ['about'] }, locale: 'en' },
-        { params: { path: ['home'] }, locale: 'de-DE' },
-      ];
-
-      sitePathServiceStub.fetchSiteRoutes.resolves(structuredClone(paths));
-
-      const result = await sitecoreClient.getPagePaths(['site-one'], ['en'], undefined);
-
-      expect(result).to.deep.equal(expectedPaths);
-    });
-  });
-
-  /*
-  describe('getComponentData', () => {
-    it('should return componentData when component has getComponentsProps method', async () => {
-      const context = {
-        params: { path: ['test', 'path'] },
-        query: {},
-        req: {},
-        res: {},
-        resolvedUrl: '/test/path',
-      } as unknown as GetServerSidePropsContext;
-      const layoutData = {
-        sitecore: {
-          context,
-          route: {
-            name: 'test',
-            placeholders: {
-              main: [
-                {
-                  componentName: 'TestComponent',
-                  uid: 'test-uid',
-                },
-              ],
-            },
-          },
-        },
-      };
-
-      const mockComponent = {
-        getComponentServerProps: sandbox.stub().resolves({ props: { data: 'test-data' } }),
-      };
-
-      const componentMap = new Map([['TestComponent', mockComponent]]);
-
-      const result = await sitecoreClient.getComponentData(layoutData, context, componentMap);
-
-      expect(result).to.deep.equal({
-        'test-uid': { props: { data: 'test-data' } },
-      });
-      expect(mockComponent.getComponentServerProps.calledOnce).to.be.true;
-    });
-  });*/
-});