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

package/README.md

@@ -1,3 +1,3 @@
-# Sitecore Content SDK for Astro
-
-This module contains Astro components and integration for Sitecore Content SDK.
+# Sitecore Content SDK for Astro
+
+This module contains Astro components and integration for Sitecore Content SDK.

package/package.json

@@ -1,24 +1,7 @@
 {
   "name": "@exdst-sitecore-content-sdk/astro",
-  "version": "0.0.16",
+  "version": "0.0.19",
   "type": "module",
-  "exports": {
-    ".": "./src/index.ts",
-    "./*": "./src/*",
-    "./context": "./src/context.ts",
-    "./editing": "./src/editing/index.ts",
-    "./utils": "./src/utils/index.ts",
-    "./client": "./src/client/index.ts",
-    "./config": "./src/config/index.ts",
-    "./components/Placeholder": "./src/components/Placeholder/index.ts"
-
-    
-  },
-  "files": [
-    "src",
-    "index.ts",
-    "readme.md"
-  ],
   "sideEffects": false,
   "publishConfig": {
     "access": "public",
@@ -26,14 +9,17 @@
   },
   "scripts": {
     "typecheck": "tsc -p tsconfig.json",
-    "copy:astro": "ts-node ./src/scripts/copy-astro-components.ts",
     "lint": "eslint \"./src/**/*.ts\"",
-    "test": "mocha \"./src/**/*.test.ts\"",
+    "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"
+    "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:verify": "api-extractor run"
   },
   "engines": {
-    "node": ">=22"
+    "node": ">=24"
   },
   "author": {
     "name": "EXDST",
@@ -48,23 +34,22 @@
     "url": "https://github.com/exdst/jss-astro-public/issues"
   },
   "devDependencies": {
-    "@sitecore-cloudsdk/events": "^0.5.1",
+    "@happy-dom/global-registrator": "^20.8.7",
+    "@sitecore-content-sdk/events": "^2.0.1",
     "@stylistic/eslint-plugin": "^5.2.2",
+    "@testing-library/jest-dom": "^6.6.3",
     "@types/chai": "^5.2.2",
     "@types/chai-spies": "^1.0.6",
     "@types/chai-string": "^1.4.5",
     "@types/debug": "^4.1.12",
-    "@types/jsdom": "^21.1.7",
-    "@types/memory-cache": "^0.2.6",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.15.14",
+    "@types/node": "^24.10.4",
     "@types/proxyquire": "^1.3.31",
     "@types/sinon": "^17.0.4",
     "@types/sinon-chai": "^4.0.0",
-    "@types/url-parse": "1.4.11",
     "@typescript-eslint/eslint-plugin": "8.39.0",
     "@typescript-eslint/parser": "8.39.0",
-    "astro": "^5.16.6",
+    "astro": "^5.18.1",
     "chai": "^4.4.1",
     "chai-spies": "^1.1.0",
     "chai-string": "^1.6.0",
@@ -73,35 +58,49 @@
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-jsdoc": "52.0.3",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-react": "7.37.5",
-    "eslint-plugin-react-hooks": "5.2.0",
     "glob": "^11.0.2",
-    "jsdom": "^26.1.0",
+    "happy-dom": "^16.7.3",
     "mocha": "^11.2.2",
-    "nock": "14.0.0-beta.7",
     "nyc": "^17.1.0",
     "prettier": "^2.8.0",
     "proxyquire": "^2.1.3",
     "sinon": "^20.0.0",
     "sinon-chai": "3.7.0",
-    "tslib": "^2.8.1",
     "tsx": "^4.19.4",
-    "typescript": "~5.8.3"
+    "typescript": "~5.8.3",
+    "vitest": "^3.0.4"
   },
   "peerDependencies": {
-    "@sitecore-cloudsdk/events": "^0.5.1"
+    "@sitecore-content-sdk/analytics-core": "^2.0.1",
+    "@sitecore-content-sdk/events": "^2.0.1"
   },
   "dependencies": {
-    "@sitecore-content-sdk/core": "^1.5.1",
+    "@sitecore-content-sdk/content": "^2.0.1",
+    "@sitecore-content-sdk/core": "^2.0.1",
     "chalk": "^4.1.2",
     "cookie": "^1.0.2",
     "debug": "^4.4.0",
     "glob": "^11.0.2",
-    "graphql": "^16.11.0",
-    "graphql-request": "^6.1.0",
-    "memory-cache": "^0.2.0",
-    "nanostores": "^0.10.3",
-    "url-parse": "^1.5.10"
+    "nanostores": "^0.10.3"
   },
-  "description": ""
+  "exports": {
+    ".": "./src/index.ts",
+    "./*": "./src/*",
+    "./client": "./src/client/index.ts",
+    "./config": "./src/config/index.ts",
+    "./config-cli": "./src/config-cli/index.ts",
+    "./context": "./src/context.ts",
+    "./editing": "./src/editing/index.ts",
+    "./middleware": "./src/middleware/index.ts",
+    "./site": "./src/site/index.ts",
+    "./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/index.ts

@@ -8,5 +8,5 @@
   getEdgeProxyContentUrl,
   createGraphQLClientFactory,
   SitecoreClientInit,
-} from '@sitecore-content-sdk/core/client';
+} from '@sitecore-content-sdk/content/client';
 export { SitecoreAstroClient as SitecoreClient } from './sitecore-astro-client';

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

@@ -6,12 +6,9 @@ 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/core/site';
-import {
-  layoutData,
-  componentsWithExperiencesArray,
-} from '../test-data/personalizeData';
-import { VARIANT_PREFIX } from '@sitecore-content-sdk/core/personalize';
+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);
 
@@ -60,6 +57,9 @@ describe('SitecoreClient', () => {
   let restComponentServiceStub = {
     fetchComponentData: sandbox.stub(),
   };
+  let sitePathServiceStub = {
+    fetchSiteRoutes: sandbox.stub(),
+  };
 
   beforeEach(() => {
     layoutServiceStub = {
@@ -78,6 +78,9 @@ describe('SitecoreClient', () => {
     restComponentServiceStub = {
       fetchComponentData: sandbox.stub(),
     };
+    sitePathServiceStub = {
+      fetchSiteRoutes: sandbox.stub(),
+    };
 
     sitecoreClient = new SitecoreAstroClient(defaultInitOptions);
 
@@ -86,6 +89,7 @@ describe('SitecoreClient', () => {
     (sitecoreClient as any).errorPagesService = errorPagesServiceStub;
     (sitecoreClient as any).editingService = editingServiceStub;
     (sitecoreClient as any).componentService = restComponentServiceStub;
+    (sitecoreClient as any).sitePathService = sitePathServiceStub;
   });
 
   describe('getPage', () => {
@@ -147,13 +151,10 @@ describe('SitecoreClient', () => {
         locale,
       });
 
-      expect(layoutServiceStub.fetchLayoutData).to.be.calledWithMatch(
-        '/test/path',
-        {
-          locale,
-          site: 'mysite',
-        }
-      );
+      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 () => {
@@ -170,13 +171,10 @@ describe('SitecoreClient', () => {
         site: 'other-site',
       });
 
-      expect(layoutServiceStub.fetchLayoutData).to.be.calledWithMatch(
-        '/test/path',
-        {
-          locale,
-          site: 'other-site',
-        }
-      );
+      expect(layoutServiceStub.fetchLayoutData).to.be.calledWithMatch('/test/path', {
+        locale,
+        site: 'other-site',
+      });
     });
   });
 
@@ -227,6 +225,29 @@ describe('SitecoreClient', () => {
       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 () => {

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

@@ -1,32 +1,34 @@
+import { StaticPath } from '@sitecore-content-sdk/content';
 import {
   FetchOptions,
   Page,
   PageOptions,
   SitecoreClient,
   SitecoreClientInit,
-} from '@sitecore-content-sdk/core/client';
-import {
-  AstroContentSdkComponent,
-  ComponentMap,
-  ComponentPropsCollection,
-  ComponentPropsError,
-  PreviewData,
-} from '../sharedTypes/component-props';
-import { LayoutServiceData } from '@sitecore-content-sdk/core/layout';
+} 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/core/editing';
-import {
-  getSiteRewriteData,
-  normalizeSiteRewrite,
-} from '@sitecore-content-sdk/core/site';
+import { EditingPreviewData } from '@sitecore-content-sdk/content/editing';
+import { getSiteRewriteData, normalizeSiteRewrite } from '@sitecore-content-sdk/content/site';
 import {
   getPersonalizedRewriteData,
   normalizePersonalizedRewrite,
-} from '@sitecore-content-sdk/core/personalize';
+} from '@sitecore-content-sdk/content/personalize';
+import { SitecoreConfig } from '../config';
 
+/**
+ * Init options for Sitecore Client that allows you to override services too
+ * @public
+ */
+export type SitecoreAstroClientInit = SitecoreClientInit & Pick<SitecoreConfig, 'multisite'>;
+
+/**
+ * The SitecoreAstroClient class extends the SitecoreClient class to provide additional functionality for Astro.
+ * @public
+ */
 export class SitecoreAstroClient extends SitecoreClient {
   protected componentPropsService: ComponentPropsService;
-  constructor(protected initOptions: SitecoreClientInit) {
+  constructor(protected initOptions: SitecoreAstroClientInit) {
     super(initOptions);
     this.componentPropsService = this.getComponentPropsService();
   }
@@ -38,11 +40,8 @@ export class SitecoreAstroClient extends SitecoreClient {
    */
   getSiteNameFromPath(path: string | string[]) {
     const resolvedPath = super.parsePath(path);
-    // Get site name (from path rewritten in middleware)
-    const siteData = getSiteRewriteData(
-      resolvedPath,
-      this.initOptions.defaultSite
-    );
+    // Get site name (from path rewritten in proxy)
+    const siteData = getSiteRewriteData(resolvedPath, this.initOptions.defaultSite);
 
     return siteData.siteName;
   }
@@ -65,8 +64,7 @@ export class SitecoreAstroClient extends SitecoreClient {
     const resolvedPath = this.parsePath(path);
     // Get variant(s) for personalization (from path), must ensure path is of type string
     const personalizeData =
-      pageOptions.personalize ||
-      getPersonalizedRewriteData(super.parsePath(path));
+      pageOptions.personalize || getPersonalizedRewriteData(super.parsePath(path));
     const site = pageOptions.site || this.getSiteNameFromPath(path);
     const page = await super.getPage(
       resolvedPath,
@@ -86,50 +84,69 @@ export class SitecoreAstroClient extends SitecoreClient {
    * @param {PreviewData} previewData - The editing preview data for metadata mode.
    * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
    */
-  async getPreview(
-    previewData: PreviewData,
-    fetchOptions?: FetchOptions
-  ): Promise<Page | null> {
+  async getPreview(previewData: PreviewData, fetchOptions?: FetchOptions): Promise<Page | null> {
     return super.getPreview(previewData as EditingPreviewData, fetchOptions);
   }
 
   /**
-   * Parses components from nextjs 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
+   * Retrieves the static paths for pages based on the given languages.
+   * @param {string[]} sites - An array of site names to fetch routes for.
+   * @param {string[]} [languages] - An optional array of language codes to generate paths for.
+   * @param {FetchOptions} [fetchOptions] - Additional fetch options.
+   * @returns {Promise<StaticPath[]>} A promise that resolves to an array of static paths.
    */
-  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,
+  async getPagePaths(
+    sites: string[],
+    languages?: string[],
+    fetchOptions?: FetchOptions
+  ): Promise<StaticPath[]> {
+    const staticPaths = await super.getPagePaths(sites, languages, fetchOptions);
+
+    // remove _site_ segments (Astro doesn't support multisite in SSG yet)
+    staticPaths.map((path) => {
+      path.params.path = normalizeSiteRewrite(path.params.path.join('/')).split('/');
     });
 
-    const errors = Object.keys(componentProps)
-      .map((id) => {
-        const component = componentProps[id] as ComponentPropsError;
+    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,
+  //   });
 
-        return component.error
-          ? `\nUnable to get component props for ${component.componentName} (${id}): ${component.error}`
-          : '';
-      })
-      .join('');
+  //   const errors = Object.keys(componentProps)
+  //     .map((id) => {
+  //       const component = componentProps[id] as ComponentPropsError;
 
-    if (errors.length) {
-      throw new Error(errors);
-    }
+  //       return component.error
+  //         ? `\nUnable to get component props for ${component.componentName} (${id}): ${component.error}`
+  //         : '';
+  //     })
+  //     .join('');
 
-    return componentProps;
-  }
+  //   if (errors.length) {
+  //     throw new Error(errors);
+  //   }
+
+  //   return componentProps;
+  // }
 
   protected getComponentPropsService(): ComponentPropsService {
     return new ComponentPropsService();

package/src/components/AstroImage.astro

@@ -8,9 +8,9 @@ import type {
 } from './Image.astro';
 import Image from './Image.astro';
 import { EditableFieldProps } from './sharedTypes';
-import { isFieldValueEmpty } from '@sitecore-content-sdk/core/layout';
+import { isFieldValueEmpty } from '@sitecore-content-sdk/content/layout';
 import { addClassName } from '../utils';
-import { mediaApi } from '@sitecore-content-sdk/core/media';
+import { mediaApi } from '@sitecore-content-sdk/content/media';
 
 const { page } = useSitecore();
 let fallback = false,