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

package/src/middleware/robots-middleware.test.ts

@@ -1,129 +0,0 @@
-import * as chai from 'chai';
-import { expect } from 'chai';
-import sinon from 'sinon';
-import sinonChai from 'sinon-chai';
-import { RobotsMiddleware } from './robots-middleware';
-import { SitecoreClient } from '@sitecore-content-sdk/content/client';
-import { SiteInfo } from '@sitecore-content-sdk/content/site';
-import { mockRequest } from '../tests/helpers';
-import { constants } from '@sitecore-content-sdk/core';
-
-const { ERROR_MESSAGES } = constants;
-
-chai.use(sinonChai);
-
-describe('RobotsMiddleware', () => {
-  const sandbox = sinon.createSandbox();
-  let sitecoreClientStub: sinon.SinonStubbedInstance<SitecoreClient>;
-  let middleware: RobotsMiddleware;
-  let req: Partial<Request>;
-  let siteResolverStub = {
-    getByHost: sandbox.stub(),
-    getByName: sandbox.stub(),
-  };
-
-  const mockSiteInfo: SiteInfo = {
-    name: 'test-site',
-    hostName: 'example.com',
-    language: 'en',
-  };
-
-  const sites = [mockSiteInfo, { name: 'test-site-two', hostName: 'localhost', language: 'da' }];
-
-  beforeEach(() => {
-    sitecoreClientStub = sandbox.createStubInstance(SitecoreClient);
-    siteResolverStub = {
-      getByHost: sandbox.stub(),
-      getByName: sandbox.stub(),
-    };
-
-    req = mockRequest({
-      headers: {
-        host: 'example.com',
-      },
-    });
-
-    middleware = new RobotsMiddleware(sitecoreClientStub as unknown as SitecoreClient, sites);
-    (middleware as any).siteResolver = siteResolverStub;
-    siteResolverStub.getByHost.callsFake((hostName) =>
-      sites.find((site) => site.hostName === hostName)
-    );
-  });
-
-  afterEach(() => {
-    sandbox.restore();
-  });
-
-  it('should set the content type header to text/plain', async () => {
-    sitecoreClientStub.getRobots.resolves('User-agent: *\nDisallow: /');
-
-    const res = await middleware.getHandler()(req as Request);
-
-    expect(res.headers.get('Content-Type')).to.equal('text/plain');
-  });
-
-  it('should call getRobots with the correct siteName', async () => {
-    sitecoreClientStub.getRobots.resolves('User-agent: *\nDisallow: /');
-
-    await middleware.getHandler()(req as Request);
-
-    expect(sitecoreClientStub.getRobots).to.have.been.calledWith('test-site');
-  });
-
-  it('should return 200 with robots content', async () => {
-    sitecoreClientStub.getRobots.resolves('User-agent: *\nDisallow: /');
-
-    const res = await middleware.getHandler()(req as Request);
-
-    const body = await res.text();
-    expect(res.status).to.equal(200);
-    expect(body).to.deep.equal('User-agent: *\nDisallow: /');
-  });
-
-  it('should return 404 if getRobots returns null', async () => {
-    sitecoreClientStub.getRobots.resolves(undefined);
-
-    const res = await middleware.getHandler()(req as Request);
-
-    const body = await res.text();
-    expect(res.status).to.equal(404);
-    expect(body).to.deep.equal('User-agent: *\nDisallow: /');
-  });
-
-  it('should return 500 if getRobots throws an error', async () => {
-    sitecoreClientStub.getRobots.rejects(new Error('Unexpected failure'));
-
-    const res = await middleware.getHandler()(req as Request);
-
-    const body = await res.text();
-    expect(res.status).to.equal(500);
-    expect(body).to.deep.equal(`Internal Server Error. ${ERROR_MESSAGES.CONTACT_SUPPORT}`);
-  });
-
-  it('should use "localhost" as fallback when host header is missing', async () => {
-    req = new Request('https://test.com'); // no host header
-
-    sitecoreClientStub.getRobots.resolves('User-agent: *\nDisallow: /');
-
-    const res = await middleware.getHandler()(req as Request);
-
-    expect(sitecoreClientStub.getRobots).to.have.been.calledWith('test-site-two');
-
-    const body = await res.text();
-    expect(res.status).to.equal(200);
-    expect(body).to.deep.equal('User-agent: *\nDisallow: /');
-  });
-
-  it('should use x-forwarded-host header when present', async () => {
-    req = mockRequest({
-      headers: {
-        'x-forwarded-host': 'proxy.forwarded.com',
-        host: 'localhost:3000',
-      },
-    });
-
-    await middleware.getHandler()(req as Request);
-
-    expect(siteResolverStub.getByHost).to.have.been.calledWith('proxy.forwarded.com');
-  });
-});

package/src/middleware/sitemap-middleware.test.ts

@@ -1,184 +0,0 @@
-/* eslint-disable no-unused-expressions, @typescript-eslint/no-unused-expressions */
-import * as chai from 'chai';
-import { expect } from 'chai';
-import sinon from 'sinon';
-import sinonChai from 'sinon-chai';
-import { SitemapMiddleware } from './sitemap-middleware';
-import { SitecoreClient } from '@sitecore-content-sdk/content/client';
-import { constants } from '@sitecore-content-sdk/core';
-import { mockRequest } from '../tests/helpers';
-
-const { ERROR_MESSAGES } = constants;
-
-chai.use(sinonChai);
-
-describe('SitemapMiddleware', () => {
-  const sandbox = sinon.createSandbox();
-  let sitecoreClientStub: sinon.SinonStubbedInstance<SitecoreClient>;
-  let middleware: SitemapMiddleware;
-  let req: Partial<Request>;
-  let siteResolverStub = {
-    getByHost: sandbox.stub(),
-    getByName: sandbox.stub(),
-  };
-
-  const sites = [
-    { name: 'test-site', hostName: 'example.com', language: 'en' },
-    { name: 'test-site-two', hostName: '*', language: 'da' },
-  ];
-
-  beforeEach(() => {
-    sitecoreClientStub = sandbox.createStubInstance(SitecoreClient);
-
-    req = mockRequest({
-      headers: {
-        host: 'example.com',
-        'x-forwarded-proto': 'https',
-      },
-    });
-
-    siteResolverStub = {
-      getByHost: sandbox.stub(),
-      getByName: sandbox.stub(),
-    };
-
-    middleware = new SitemapMiddleware(sitecoreClientStub as unknown as SitecoreClient, sites);
-    (middleware as any).siteResolver = siteResolverStub;
-    siteResolverStub.getByHost.callsFake((hostName) =>
-      sites.find((site) => site.hostName === hostName)
-    );
-  });
-
-  afterEach(() => {
-    sandbox.restore();
-  });
-
-  describe('getHandler', () => {
-    it('should return a handler function', () => {
-      const handler = middleware.getHandler();
-      expect(handler).to.be.a('function');
-    });
-  });
-
-  describe('handler', () => {
-    it('should process sitemap request without id parameter', async () => {
-      const siteName = sites[0].name;
-      const xmlContent = '<sitemapindex>...</sitemapindex>';
-
-      sitecoreClientStub.getSiteMap.resolves(xmlContent);
-
-      const res = await middleware.getHandler()(req as Request);
-
-      expect(sitecoreClientStub.getSiteMap.calledOnce).to.be.true;
-      expect(sitecoreClientStub.getSiteMap.firstCall.args[0]).to.deep.include({
-        reqHost: 'example.com',
-        reqProtocol: 'https',
-        id: '',
-        siteName: siteName,
-      });
-
-      expect(res.headers.get('Content-Type')).to.equal('text/xml;charset=utf-8');
-
-      const body = await res.text();
-      expect(body).to.deep.equal(xmlContent);
-    });
-
-    it('should handle sitemap request with specific id parameter', async () => {
-      const sitemapId = '1';
-      req = mockRequest({
-        url: `https://test.com/sitemap-${sitemapId}.xml`,
-        headers: {
-          host: 'example.com',
-          'x-forwarded-proto': 'https',
-        },
-      });
-      const siteName = sites[0].name;
-      const xmlContent = '<urlset>...</urlset>';
-
-      sitecoreClientStub.getSiteMap.resolves(xmlContent);
-
-      const res = await middleware.getHandler()(req as Request);
-
-      expect(sitecoreClientStub.getSiteMap.firstCall.args[0]).to.deep.include({
-        reqHost: 'example.com',
-        reqProtocol: 'https',
-        id: sitemapId,
-        siteName: siteName,
-      });
-
-      const body = await res.text();
-      expect(body).to.deep.equal(xmlContent);
-    });
-
-    it('should default to https protocol when x-forwarded-proto header is missing', async () => {
-      req.headers?.delete('x-forwarded-proto');
-      const siteName = sites[0].name;
-      const xmlContent = '<sitemapindex>...</sitemapindex>';
-
-      sitecoreClientStub.getSiteMap.resolves(xmlContent);
-
-      await middleware.getHandler()(req as Request);
-
-      expect(sitecoreClientStub.getSiteMap.firstCall.args[0]).to.deep.include({
-        reqHost: 'example.com',
-        reqProtocol: 'https',
-        siteName: siteName,
-      });
-    });
-
-    it('should use x-forwarded-host header when present', async () => {
-      req = mockRequest({
-        headers: {
-          'x-forwarded-host': 'example.com',
-          host: 'localhost:3000',
-        },
-      });
-
-      await middleware.getHandler()(req as Request);
-
-      expect(siteResolverStub.getByHost).to.have.been.calledWith('example.com');
-    });
-
-    it('should use empty string when both x-forwarded-host and host headers are missing', async () => {
-      req.headers?.delete('host');
-      const xmlContent = '<sitemapindex>...</sitemapindex>';
-
-      siteResolverStub.getByHost.withArgs('').returns(sites[1]);
-
-      sitecoreClientStub.getSiteMap.resolves(xmlContent);
-
-      await middleware.getHandler()(req as Request);
-
-      expect(sitecoreClientStub.getSiteMap.firstCall.args[0]).to.deep.include({
-        reqHost: '',
-        reqProtocol: 'https',
-      });
-    });
-
-    it('should redirect to 404 when REDIRECT_404 error is thrown', async () => {
-      const error = new Error('REDIRECT_404');
-
-      sitecoreClientStub.getSiteMap.rejects(error);
-
-      const res = await middleware.getHandler()(req as Request);
-
-      expect(res.status).to.equal(302);
-      expect(res.body).to.equal(null);
-
-      expect(res.headers.has('Location')).to.be.true;
-      expect(res.headers.get('Location')).to.equal('/404');
-    });
-
-    it('should return 500 error when any other error occurs', async () => {
-      const error = new Error('Unexpected error');
-
-      sitecoreClientStub.getSiteMap.rejects(error);
-
-      const res = await middleware.getHandler()(req as Request);
-
-      const body = await res.text();
-      expect(res.status).to.equal(500);
-      expect(body).to.equal(`Internal Server Error. ${ERROR_MESSAGES.CONTACT_SUPPORT}`);
-    });
-  });
-});

package/src/tests/astro-helpers.ts

@@ -1,61 +0,0 @@
-import type { ComponentProps } from 'astro/types';
-import {
-  experimental_AstroContainer as AstroContainer,
-  type ContainerRenderOptions,
-} from 'astro/container';
-import { Page } from '@sitecore-content-sdk/content/client';
-import { ComponentMap } from '../sharedTypes/component-props';
-import { vi } from 'vitest';
-import { SitecoreContext } from '../context';
-
-type AstroComponentFactory = Parameters<AstroContainer['renderToString']>[0];
-
-type ComponentContainerRenderOptions<T extends AstroComponentFactory> = Omit<
-  ContainerRenderOptions,
-  'props'
-> & {
-  // @ts-expect-error
-  props?: ComponentProps<T>;
-};
-
-/**
- * Renders an Astro component to a DOM element for tests.
- * @param {AstroComponentFactory} Component - The Astro component to render.
- * @param {ComponentContainerRenderOptions<T>} options - Container render options, including component props.
- * @returns A `div` whose `innerHTML` is the rendered markup (Astro attributes stripped).
- */
-export async function renderAstroComponent<T extends AstroComponentFactory>(
-  Component: T,
-  options: ComponentContainerRenderOptions<T> = {}
-) {
-  const container = await AstroContainer.create();
-  const result = await container.renderToString(Component, options);
-
-  const html = removeAstroAttributes(result);
-
-  const div = document.createElement('div');
-  div.innerHTML = html;
-
-  return div;
-}
-
-export const mockSitecoreContext = (page?: Page, map?: ComponentMap, api?: any) => {
-  const getMock = vi.fn();
-
-  getMock.mockReturnValue({
-    page: page,
-    componentMap: map,
-    api: api,
-  });
-
-  SitecoreContext.get = getMock;
-};
-
-/**
- * Removes Astro-specific data attributes (data-astro-*)
- * and whitespaces between HTML tags from a given HTML string.
- * @param {string} html - Raw HTML string from Astro rendering.
- */
-const removeAstroAttributes = (html: string) => {
-  return html.replace(/\s*data-astro-[a-zA-Z0-9-]+=(\"|\').*?\1\s*/g, '').replace(/>\s+</g, '><');
-};

package/src/tests/helpers.ts

@@ -1,46 +0,0 @@
-export type Query = {
-  [key: string]: string | string[];
-};
-
-const baseUrl = 'https://test.com';
-
-export const mockRequest = ({
-  url,
-  method,
-  query,
-  headers,
-}: {
-  url?: string;
-  method?: string;
-  query?: Query;
-  headers?: { [key: string]: string };
-}) => {
-  const requestUrl = addQueryToUrl(url || baseUrl, query);
-  return new Request(requestUrl, {
-    method,
-    headers: headers,
-  });
-};
-
-export const addQueryToUrl = (baseUrl: string, query?: Query): string => {
-  const url = new URL(baseUrl);
-  const params = new URLSearchParams();
-
-  if (query) {
-    Object.entries(query).forEach(([key, value]) => {
-      if (Array.isArray(value)) {
-        value.forEach((item) => {
-          params.append(key, item);
-        });
-      } else {
-        params.append(key, value);
-      }
-    });
-
-    params.forEach((value, key) => {
-      url.searchParams.append(key, value);
-    });
-  }
-
-  return url.toString();
-};

package/src/tests/personalizeData.ts

@@ -1,63 +0,0 @@
-export const mountain_bike_audience = {
-  uid: '0b6d23d8-c50e-4e79-9eca-317ec43e82b0',
-  componentName: 'ContentBlock',
-  dataSource: '20679cd4-356b-4452-b507-453beeb0be39',
-  fields: {
-    content: {
-      value:
-        '<p><img src="https://edge-beta.sitecorecloud.io/ser-edge-personalization/media/CsdkNextWeb/Mountain-Bike.jpg?h=675&amp;w=1200" style="width:1200px;height:675px;" /></p>',
-    },
-    heading: { value: 'Mountain Bike' },
-  },
-};
-
-export const city_bike_audience = {
-  uid: '0b6d23d8-c50e-4e79-9eca-317ec43e82b0',
-  componentName: 'ContentBlock',
-  dataSource: '36e02581-2056-4c55-a4d5-f4b700ba1ae2',
-  fields: {
-    content: {
-      value:
-        '<p><img src="https://edge-beta.sitecorecloud.io/ser-edge-personalization/media/CsdkNextWeb/Mountain-Bike.jpg?h=675&amp;w=1200" style="width:1200px;height:675px;" /></p>',
-    },
-    heading: { value: 'Mountain Bike' },
-  },
-};
-
-export const layoutData = {
-  sitecore: {
-    context: {
-      pageEditing: false,
-      site: { name: 'CsdkNextWeb' },
-      visitorIdentificationTimestamp: 1038543,
-      language: 'en',
-      variantId: undefined,
-    },
-    route: {
-      name: 'landingpage',
-      placeholders: {
-        'content-sdk-main': [
-          {
-            uid: '0b6d23d8-c50e-4e79-9eca-317ec43e82b0',
-            componentName: 'ContentBlock',
-            dataSource: 'e020fb58-1be8-4537-aab8-67916452ecf2',
-            fields: { content: { value: '' }, heading: { value: 'Default Content' } },
-            experiences: {
-              mountain_bike_audience: mountain_bike_audience,
-              city_bike_audience: city_bike_audience,
-            },
-          },
-        ],
-      },
-    },
-  },
-};
-
-export const componentWithExperiences = {
-  uid: '0b6d23d8-c50e-4e79-9eca-317ec43e82b0',
-  componentName: 'ContentBlock',
-  dataSource: '20679cd4-356b-4452-b507-453beeb0be39',
-  fields: mountain_bike_audience.fields,
-};
-
-export const componentsWithExperiencesArray = [componentWithExperiences];

package/src/tests/test-components/CustomErrorComponent.astro

@@ -1,3 +0,0 @@
----
----
-<div class="custom-error">This is a custom error component!</div>

package/src/tests/test-components/CustomHiddenRendering.astro

@@ -1,10 +0,0 @@
----
-import HiddenRendering from '../../components/HiddenRendering.astro';
-
-const props = Astro.props;
----
-
-<div class="hidden-rendering">
-  <HiddenRendering />
-  <p>{props.rendering.componentName}</p>
-</div>

package/src/tests/test-components/CustomMissingComponent.astro

@@ -1,9 +0,0 @@
----
-import MissingComponent from '../../components/MissingComponent.astro';
-
-const props = Astro.props;
----
-
-<div class="missing-component">
-  <MissingComponent {...props} />
-</div>

package/src/tests/test-components/DownloadCallout.astro

@@ -1,12 +0,0 @@
----
-const props = Astro.props as {
-  [prop: string]: unknown;
-  fields?: { message?: { value?: string } };
-  extraDiv?: boolean;
-};
----
-
-<div class="download-callout-mock">
-  {props.fields?.message ? props.fields.message.value : ''}
-  {props.extraDiv ? <div class="extra">extra!</div> : null}
-</div>

package/src/tests/test-components/EmptyFieldEditingComponent.astro

@@ -1,5 +0,0 @@
----
-
----
-
-<span class="empty-field-value-placeholder">Custom Empty field value</span>

package/src/tests/test-components/ErrorBoundaryWithError.astro

@@ -1,10 +0,0 @@
----
-import ErrorBoundary from '../../components/ErrorBoundary.astro';
-import TestComponentWithError from './TestComponentWithError.astro';
-
-const props = Astro.props;
-
----
-<ErrorBoundary {...props}>
-  <TestComponentWithError />
-</ErrorBoundary>

package/src/tests/test-components/Home.astro

@@ -1,12 +0,0 @@
----
-import Placeholder from '../../components/Placeholder/Placeholder.astro';
-
-const { rendering, render, renderEach, renderEmpty, ...otherProps } =
-  Astro.props;
----
-
-<div class="home-mock">
-  <Placeholder name="main" rendering={rendering} />
-  <Placeholder name="page-header" rendering={rendering} />
-  <Placeholder name="page-content" rendering={rendering} {...otherProps} />
-</div>

package/src/tests/test-components/SxaRichText.astro

@@ -1,23 +0,0 @@
----
-import { Field } from '@sitecore-content-sdk/content/layout';
-import SxaRichTextDefault from './SxaRichTextDefault.astro';
-import SxaRichTextWithTitle from './SxaRichTextWithTitle.astro';
-
-interface Fields {
-  Text: Field<string>;
-  Title: Field<string>;
-}
-
-type RichTextProps = {
-  params: { [key: string]: string };
-  fields: Fields;
-};
-
-const props = Astro.props as RichTextProps;
-const variantName = props.params.FieldNames ?? 'Default';
----
-
-<>
-  {variantName === 'Default' && <SxaRichTextDefault {...props} />}
-  {variantName === 'WithTitle' && <SxaRichTextWithTitle {...props} />}
-</>

package/src/tests/test-components/SxaRichTextDefault.astro

@@ -1,7 +0,0 @@
----
-const props = Astro.props;
----
-
-<div class={`rendering-variant ${props.params.styles}`}>
-  <span class="default">Rich text</span>
-</div>

package/src/tests/test-components/SxaRichTextWithTitle.astro

@@ -1,8 +0,0 @@
----
-const props = Astro.props;
----
-
-<div class={`rendering-variant ${props.params.styles}`}>
-  <div class="title">{props.fields.Title.value}</div>
-  <span class="text">{props.fields.Text.value}</span>
-</div>

package/src/tests/test-components/TestComponent.astro

@@ -1,9 +0,0 @@
----
-
----
-
-<div>
-  <h1>hi</h1>
-  <h2>foo</h2>
-  <p>bar</p>
-</div>

package/src/tests/test-components/TestComponentWithError.astro

@@ -1,4 +0,0 @@
----
-throw Error("an error occured");
----
-<></>

package/src/tests/test-components/TestComponentWithField.astro

@@ -1,17 +0,0 @@
----
-type TestComponentProps = {
-  field?: {
-    value?: string;
-    metadata?: { [key: string]: unknown };
-  };
-  editable?: boolean;
-};
-
-const props = Astro.props as TestComponentProps;
----
-
-<div>
-  <h1>{props.field?.value}</h1>
-  <h2>foo</h2>
-  <p>bar</p>
-</div>

package/src/tests/test-components/TestHeader.astro

@@ -1,8 +0,0 @@
----
-import Placeholder from '../../components/Placeholder/Placeholder.astro';
-const { rendering } = Astro.props;
-
----
-<div class="header-wrapper">
-      <Placeholder name="logo" rendering={rendering} />
-</div>

package/src/tests/test-components/TestLogo.astro

@@ -1,5 +0,0 @@
----
-
----
-
-<div class="Logo-mock"></div>

package/src/tests/test-components/TestParentWrapperComponent.astro

@@ -1,5 +0,0 @@
----
----
-<div class="parent-wrapper">
-  <slot />
-</div>

package/src/tests/test-components/TestWrapperComponent.astro

@@ -1,5 +0,0 @@
----
----
-<div class="wrapper">
-  <slot />
-</div>

package/src/tests/test-components/generate-map/Button.astro

@@ -1,4 +0,0 @@
----
----
-
-<button type="button">Test Button</button>

package/src/tests/test-components/generate-map/Link.astro

@@ -1,4 +0,0 @@
----
----
-
-<a href="#">Test Link</a>