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

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@exdst-sitecore-content-sdk/astro",
-  "version": "0.0.24",
+  "version": "0.0.25",
+  "description": "Astro Content SDK for Sitecore AI (XM Cloud)",
   "type": "module",
   "sideEffects": false,
   "publishConfig": {
@@ -9,12 +10,12 @@
   },
   "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": "api-extractor run --local --verbose",
     "api-extractor:verify": "api-extractor run"
   },
@@ -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/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.

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

@@ -1,267 +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',
-    multisite: {
-      enabled: true,
-      useCookieResolution: () => true,
-    },
-    layout: { formatLayoutQuery: sandbox.stub() },
-    dictionary: { caching: { enabled: true, timeout: 60000 } },
-    disableCodeGeneration: false,
-    rewriteMediaUrls: 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);
-      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);
-      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('getPreview', () => {
-    it('should call base getPreview with preview data and fetch options', async () => {
-      const previewData = {
-        variantId: 'variant-a',
-        route: '/test/path',
-        language: 'en',
-      } as any;
-      const fetchOptions = {
-        retries: 2,
-      } as any;
-
-      const basePrototype = Object.getPrototypeOf(SitecoreAstroClient.prototype);
-      const superGetPreviewStub = sandbox.stub(basePrototype, 'getPreview').resolves(null);
-
-      try {
-        await sitecoreClient.getPreview(previewData, fetchOptions);
-
-        expect(superGetPreviewStub).to.have.been.calledOnceWithExactly(previewData, fetchOptions);
-      } finally {
-        superGetPreviewStub.restore();
-      }
-    });
-  });
-});