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

package/src/components/Placeholder/PlaceholderMetadata.astro.test.ts

@@ -1,228 +0,0 @@
-import { describe, test, expect } from 'vitest';
-import { renderAstroComponent } from '../../tests/astro-helpers';
-import PlaceholderMetadata from './PlaceholderMetadata.astro';
-
-describe('PlaceholderMetadata', () => {
-  test('renders rendering code blocks for metadataType rendering', async () => {
-    const children = '<div class="richtext-class"></div>';
-
-    const wrapper = await renderAstroComponent(PlaceholderMetadata, {
-      props: { rendering: { uid: '123', componentName: 'RichText' } },
-      slots: {
-        default: children,
-      },
-    });
-
-    expect(wrapper.innerHTML).to.equal(
-      [
-        '<code type="text/sitecore" chrometype="rendering" class="scpm" kind="open" id="123"></code>',
-        '<div class="richtext-class"></div>',
-        '<code type="text/sitecore" chrometype="rendering" class="scpm" kind="close"></code>',
-      ].join('')
-    );
-  });
-
-  test('renders placeholder code blocks when metadataType is placeholder', async () => {
-    const children = '<div class="richtext-mock"></div>';
-
-    const wrapper = await renderAstroComponent(PlaceholderMetadata, {
-      props: {
-        rendering: {
-          uid: '123',
-          componentName: 'RichText',
-          placeholders: { main: [] },
-        },
-        placeholderName: 'main',
-      },
-      slots: {
-        default: children,
-      },
-    });
-
-    expect(wrapper.innerHTML).to.equal(
-      [
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="open" id="main_123"></code>',
-        '<div class="richtext-mock"></div>',
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="close"></code>',
-      ].join('')
-    );
-  });
-
-  test('renders placeholder code blocks with DEFAULT_PLACEHOLDER_UID value when metadataType is a placeholder(root) and uid is not present', async () => {
-    const children = '<div class="richtext-mock"></div>';
-
-    const wrapper = await renderAstroComponent(PlaceholderMetadata, {
-      props: {
-        rendering: {
-          componentName: 'RichText',
-          placeholders: { main: [] },
-        },
-        placeholderName: 'main',
-      },
-      slots: {
-        default: children,
-      },
-    });
-
-    expect(wrapper.innerHTML).to.equal(
-      [
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="open" id="main_00000000-0000-0000-0000-000000000000"></code>',
-        '<div class="richtext-mock"></div>',
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="close"></code>',
-      ].join('')
-    );
-  });
-
-  test('renders placeholder blocks with rendering uid when metadataType is dynamic placeholder', async () => {
-    const children = '<div class="richtext-mock"></div>';
-
-    const wrapper = await renderAstroComponent(PlaceholderMetadata, {
-      props: {
-        rendering: {
-          uid: 'renderinguid',
-          componentName: 'RichText',
-          placeholders: { 'main-{*}': [] },
-        },
-        placeholderName: 'main-1',
-      },
-      slots: {
-        default: children,
-      },
-    });
-
-    expect(wrapper.innerHTML).to.equal(
-      [
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="open" id="main-{*}_renderinguid"></code>',
-        '<div class="richtext-mock"></div>',
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="close"></code>',
-      ].join('')
-    );
-  });
-
-  test('renders placeholder blocks with DEFAULT_PLACEHOLDER_UID value when metadataType is dynamic placeholder and uid is not present', async () => {
-    const children = '<div class="richtext-mock"></div>';
-
-    const wrapper = await renderAstroComponent(PlaceholderMetadata, {
-      props: {
-        rendering: {
-          componentName: 'RichText',
-          placeholders: { 'main-{*}': [] },
-        },
-        placeholderName: 'main-1',
-      },
-      slots: {
-        default: children,
-      },
-    });
-
-    expect(wrapper.innerHTML).to.equal(
-      [
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="open" id="main-{*}_00000000-0000-0000-0000-000000000000"></code>',
-        '<div class="richtext-mock"></div>',
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="close"></code>',
-      ].join('')
-    );
-  });
-
-  test('renders placeholder code blocks when metadataType is double digit dynamic placeholder', async () => {
-    const children = '<div class="richtext-mock"></div>';
-
-    const wrapper = await renderAstroComponent(PlaceholderMetadata, {
-      props: {
-        rendering: {
-          uid: 'renderinguid',
-          componentName: 'RichText',
-          placeholders: { 'main-1-{*}': [] },
-        },
-        placeholderName: 'main-1-1',
-      },
-      slots: {
-        default: children,
-      },
-    });
-
-    expect(wrapper.innerHTML).to.equal(
-      [
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="open" id="main-1-{*}_renderinguid"></code>',
-        '<div class="richtext-mock"></div>',
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="close"></code>',
-      ].join('')
-    );
-  });
-
-  test('adds data-csdk-component-runtime attribute to rendering chrome', async () => {
-    const children = '<div class="richtext-class"></div>';
-
-    const wrapper = await renderAstroComponent(PlaceholderMetadata, {
-      props: {
-        rendering: {
-          uid: '123',
-          componentName: 'RichText',
-        },
-        componentRuntime: 'server',
-      },
-      slots: {
-        default: children,
-      },
-    });
-
-    expect(wrapper.innerHTML).to.equal(
-      [
-        '<code type="text/sitecore" chrometype="rendering" class="scpm" kind="open" id="123" data-csdk-component-runtime="server"></code>',
-        '<div class="richtext-class"></div>',
-        '<code type="text/sitecore" chrometype="rendering" class="scpm" kind="close"></code>',
-      ].join('')
-    );
-  });
-
-  test('does not add data-csdk-component-runtime attribute to placeholder chrome even when componentRuntime is provided', async () => {
-    const children = '<div class="richtext-mock"></div>';
-
-    const wrapper = await renderAstroComponent(PlaceholderMetadata, {
-      props: {
-        rendering: {
-          uid: '123',
-          componentName: 'RichText',
-          placeholders: { main: [] },
-        },
-        componentRuntime: 'server',
-        placeholderName: 'main',
-      },
-      slots: {
-        default: children,
-      },
-    });
-
-    expect(wrapper.innerHTML).to.equal(
-      [
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="open" id="main_123"></code>',
-        '<div class="richtext-mock"></div>',
-        '<code type="text/sitecore" chrometype="placeholder" class="scpm" kind="close"></code>',
-      ].join('')
-    );
-  });
-
-  test('does not add data-csdk-component-runtime attribute when componentRuntime is not provided', async () => {
-    const children = '<div class="richtext-class"></div>';
-
-    const wrapper = await renderAstroComponent(PlaceholderMetadata, {
-      props: {
-        rendering: {
-          uid: '123',
-          componentName: 'RichText',
-        },
-      },
-      slots: {
-        default: children,
-      },
-    });
-
-    expect(wrapper.innerHTML).to.equal(
-      [
-        '<code type="text/sitecore" chrometype="rendering" class="scpm" kind="open" id="123"></code>',
-        '<div class="richtext-class"></div>',
-        '<code type="text/sitecore" chrometype="rendering" class="scpm" kind="close"></code>',
-      ].join('')
-    );
-  });
-});

package/src/components/Placeholder/PlaceholderUtils.astro.test.ts

@@ -1,149 +0,0 @@
-/* eslint-disable no-unused-expressions */
-import { describe, test, expect, beforeEach, afterEach } from 'vitest';
-import { ComponentRendering } from '@sitecore-content-sdk/content/layout';
-import { ComponentMap } from '../../sharedTypes/component-props';
-import { createSandbox } from 'sinon';
-import { getComponentForRendering } from './PlaceholderUtils.astro';
-import MissingComponent from '../MissingComponent.astro';
-import HiddenRendering from '../HiddenRendering.astro';
-import TestComponent from '../../tests/test-components/TestComponent.astro';
-import CustomMissingComponent from '../../tests/test-components/CustomMissingComponent.astro';
-import CustomHiddenRendering from '../../tests/test-components/CustomHiddenRendering.astro';
-import { HIDDEN_RENDERING_NAME } from '@sitecore-content-sdk/content';
-
-describe('placeholder-utils', () => {
-  const sandbox = createSandbox();
-  let consoleWarnStub: ReturnType<typeof sandbox.stub>;
-
-  beforeEach(() => {
-    consoleWarnStub = sandbox.stub(console, 'warn');
-    sandbox.stub(console, 'error');
-  });
-
-  afterEach(() => {
-    sandbox.restore();
-  });
-
-  describe('getComponentForRendering', () => {
-    let componentMap: ComponentMap;
-
-    beforeEach(() => {
-      componentMap = new Map();
-    });
-
-    test('should return null when componentMap is empty', () => {
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-      };
-
-      const result = getComponentForRendering(rendering, 'test-placeholder');
-
-      expect(result?.component).to.equal(MissingComponent);
-      expect(result?.isEmpty).to.be.true;
-      expect(consoleWarnStub.calledOnce).to.be.true;
-    });
-
-    test('should return null when componentMap is not provided', () => {
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-      };
-
-      const result = getComponentForRendering(rendering, 'test-placeholder', undefined);
-
-      expect(result?.component).to.equal(MissingComponent);
-      expect(result?.isEmpty).to.be.true;
-      expect(consoleWarnStub.calledOnce).to.be.true;
-    });
-
-    test('should return component directly when it is not a module', () => {
-      componentMap.set('TestComponent', TestComponent);
-
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-      };
-
-      const result = getComponentForRendering(rendering, 'test-placeholder', componentMap);
-
-      expect(result?.component).to.equal(TestComponent);
-    });
-
-    test('should return default missing component when component not found in component map', () => {
-      // Add a dummy entry so componentMap is not empty
-      componentMap.set('DummyComponent', TestComponent);
-
-      const rendering: ComponentRendering = {
-        componentName: 'NonExistentComponent',
-        uid: 'test-uid',
-      };
-
-      const result = getComponentForRendering(rendering, 'test-placeholder', componentMap);
-
-      expect(result?.component).to.equal(MissingComponent);
-      expect(result?.isEmpty).to.be.true;
-    });
-
-    test('should return custom missing component when specified and component not found in component map', () => {
-      // Add a dummy entry so componentMap is not empty
-      componentMap.set('DummyComponent', TestComponent);
-
-      const rendering: ComponentRendering = {
-        componentName: 'NonExistentComponent',
-        uid: 'test-uid',
-      };
-
-      const result = getComponentForRendering(
-        rendering,
-        'test-placeholder',
-        componentMap,
-        undefined,
-        CustomMissingComponent
-      );
-
-      expect(result?.component).to.equal(CustomMissingComponent);
-      expect(result?.isEmpty).to.be.true;
-    });
-
-    test('should return hiddenRenderingComponent when component is hidden', () => {
-      const rendering: ComponentRendering = {
-        componentName: HIDDEN_RENDERING_NAME,
-        uid: 'test-uid',
-      };
-
-      const result = getComponentForRendering(
-        rendering,
-        'test-placeholder',
-        componentMap,
-        CustomHiddenRendering
-      );
-
-      expect(result?.component).to.equal(CustomHiddenRendering);
-      expect(result?.isEmpty).to.be.true;
-    });
-
-    test('should return default HiddenRendering when component is hidden and no custom hidden component provided', () => {
-      const rendering: ComponentRendering = {
-        componentName: HIDDEN_RENDERING_NAME,
-        uid: 'test-uid',
-      };
-
-      const result = getComponentForRendering(rendering, 'test-placeholder', componentMap);
-
-      expect(result?.component).to.equal(HiddenRendering);
-      expect(result?.isEmpty).to.be.true;
-    });
-
-    test('should handle rendering without componentName', () => {
-      const rendering: ComponentRendering = {
-        componentName: '',
-        uid: 'test-uid',
-      };
-
-      const result = getComponentForRendering(rendering, 'test-placeholder', componentMap);
-
-      expect(result?.isEmpty).to.be.true;
-    });
-  });
-});

package/src/components/Placeholder/placeholder-utils.test.ts

@@ -1,309 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/* eslint-disable no-unused-expressions */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { expect } from 'chai';
-import { createSandbox } from 'sinon';
-import {
-  getChildComponentProps,
-  getPlaceholderRenderings,
-  getSXAParams,
-} from './placeholder-utils';
-import { ComponentRendering } from '@sitecore-content-sdk/content/layout';
-import { PlaceholderProps } from './models';
-
-describe('placeholder-utils', () => {
-  const sandbox = createSandbox();
-  let consoleWarnStub: any;
-
-  beforeEach(() => {
-    consoleWarnStub = sandbox.stub(console, 'warn');
-  });
-
-  afterEach(() => {
-    sandbox.restore();
-  });
-
-  describe('getPlaceholderRenderings', () => {
-    it('should return null if rendering does not have placeholders', () => {
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-      };
-
-      const result = getPlaceholderRenderings(rendering, 'test-placeholder', false);
-
-      expect(result).to.deep.equal([]);
-      expect(consoleWarnStub.calledOnce).to.be.true;
-      expect(consoleWarnStub.firstCall.args[0]).to.include('test-placeholder');
-    });
-
-    it('should return renderings from placeholder by name', () => {
-      const expectedRenderings = [
-        {
-          componentName: 'Component1',
-          uid: 'comp1-uid',
-        },
-        {
-          componentName: 'Component2',
-          uid: 'comp2-uid',
-        },
-      ];
-
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-        placeholders: {
-          'test-placeholder': expectedRenderings,
-          'other-placeholder': [{ componentName: 'OtherComponent', uid: 'other-uid' }],
-        },
-      };
-
-      const result = getPlaceholderRenderings(rendering, 'test-placeholder', false);
-
-      expect(result).to.deep.equal(expectedRenderings);
-      expect(consoleWarnStub.called).to.be.false;
-    });
-
-    it('should parse dynamic SXA placeholder names correctly', () => {
-      const expectedRenderings = [
-        {
-          componentName: 'DynamicComponent',
-          uid: 'dynamic-uid',
-        },
-      ];
-
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-        placeholders: {
-          'container-{*}': expectedRenderings,
-          'other-placeholder': [{ componentName: 'OtherComponent', uid: 'other-uid' }],
-        },
-      };
-
-      // Test non-editing mode - should replace dynamic placeholder
-      const result = getPlaceholderRenderings(rendering, 'container-1', false);
-      expect(result).to.deep.equal(expectedRenderings);
-      expect(rendering.placeholders?.['container-1']).to.deep.equal(expectedRenderings);
-      expect(rendering.placeholders?.['container-{*}']).to.be.undefined;
-
-      // Reset rendering for editing mode test
-      rendering.placeholders = {
-        'container-{*}': expectedRenderings,
-        'other-placeholder': [{ componentName: 'OtherComponent', uid: 'other-uid' }],
-      };
-
-      // Test editing mode - should keep original placeholder name
-      const editResult = getPlaceholderRenderings(rendering, 'container-1', true);
-      expect(editResult).to.deep.equal(expectedRenderings);
-      expect(rendering.placeholders['container-{*}']).to.deep.equal(expectedRenderings);
-    });
-  });
-
-  describe('getSXAParams', () => {
-    it('should return GridParameters and Styles when present', () => {
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-        params: {
-          GridParameters: 'col-lg-6',
-          Styles: 'custom-class',
-          OtherParam: 'other-value',
-        },
-      };
-
-      const result = getSXAParams(rendering);
-
-      expect(result).to.deep.equal({
-        styles: 'col-lg-6 custom-class',
-      });
-    });
-
-    it('should return only GridParameters when Styles not present', () => {
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-        params: {
-          GridParameters: 'col-lg-8',
-          OtherParam: 'other-value',
-        },
-      };
-
-      const result = getSXAParams(rendering);
-
-      expect(result).to.deep.equal({
-        styles: 'col-lg-8 ',
-      });
-    });
-
-    it('should return only Styles when GridParameters not present', () => {
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-        params: {
-          Styles: 'custom-styles',
-          OtherParam: 'other-value',
-        },
-      };
-
-      const result = getSXAParams(rendering);
-
-      expect(result).to.deep.equal({
-        styles: ' custom-styles',
-      });
-    });
-
-    it('should return empty styles string when no params', () => {
-      const rendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-      };
-
-      const result = getSXAParams(rendering);
-
-      expect(result).to.deep.equal({ styles: '' });
-    });
-  });
-
-  describe('getChildComponentProps', () => {
-    it('should merge placeholder and rendering fields', () => {
-      const placeholderProps: PlaceholderProps = {
-        name: 'test-placeholder',
-        rendering: { componentName: 'Test', uid: 'test-uid' },
-        page: {
-          layout: {},
-          locale: 'en',
-          mode: {
-            name: 'normal',
-            isNormal: true,
-            isPreview: false,
-            isEditing: false,
-            isDesignLibrary: false,
-            designLibrary: { isVariantGeneration: false },
-          },
-        },
-        fields: {
-          placeholderField: { value: 'placeholder-value' },
-          sharedField: { value: 'placeholder-shared-value' },
-        },
-      };
-
-      const componentRendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-        fields: {
-          renderingField: { value: 'rendering-value' },
-          sharedField: { value: 'rendering-shared-value' },
-        },
-      };
-
-      const result = getChildComponentProps(placeholderProps, componentRendering);
-
-      expect(result.fields).to.deep.equal({
-        placeholderField: { value: 'placeholder-value' },
-        renderingField: { value: 'rendering-value' },
-        sharedField: { value: 'rendering-shared-value' }, // rendering should override placeholder
-      });
-      expect(result.rendering).to.equal(componentRendering);
-    });
-
-    it('should merge placeholder and rendering params', () => {
-      const placeholderProps: PlaceholderProps = {
-        name: 'test-placeholder',
-        rendering: { componentName: 'Test', uid: 'test-uid' },
-        page: {
-          layout: {},
-          locale: 'en',
-          mode: {
-            name: 'normal',
-            isNormal: true,
-            isPreview: false,
-            isEditing: false,
-            isDesignLibrary: false,
-            designLibrary: { isVariantGeneration: false },
-          },
-        },
-        params: {
-          placeholderParam: 'placeholder-param-value',
-          sharedParam: 'placeholder-shared-param',
-        },
-      };
-
-      const componentRendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-        params: {
-          renderingParam: 'rendering-param-value',
-          sharedParam: 'rendering-shared-param',
-          GridParameters: 'col-lg-6',
-          Styles: 'custom-class',
-        },
-      };
-
-      const result = getChildComponentProps(placeholderProps, componentRendering);
-
-      expect(result.params).to.deep.equal({
-        placeholderParam: 'placeholder-param-value',
-        renderingParam: 'rendering-param-value',
-        sharedParam: 'rendering-shared-param', // rendering should override placeholder
-        GridParameters: 'col-lg-6',
-        Styles: 'custom-class',
-        styles: 'col-lg-6 custom-class', // SXA styles should be added
-      });
-      expect(result.rendering).to.equal(componentRendering);
-    });
-
-    it('should return minimal child component props object', () => {
-      const placeholderProps: PlaceholderProps = {
-        name: 'test-placeholder',
-        rendering: { componentName: 'Test', uid: 'test-uid' },
-        page: {
-          layout: {},
-          locale: 'en',
-          mode: {
-            name: 'normal',
-            isNormal: true,
-            isPreview: false,
-            isEditing: false,
-            isDesignLibrary: false,
-            designLibrary: { isVariantGeneration: false },
-          },
-        },
-        componentMap: new Map(),
-        customProp: 'custom-value',
-        // missingComponentComponent: MissingComponent,
-        // hiddenRenderingComponent: HiddenRendering,
-      };
-
-      const componentRendering: ComponentRendering = {
-        componentName: 'TestComponent',
-        uid: 'test-uid',
-        fields: {
-          testField: { value: 'test-value' },
-        },
-        params: {
-          testParam: 'test-param',
-        },
-      };
-
-      const result = getChildComponentProps(placeholderProps, componentRendering);
-
-      // getChildComponentProps returns only fields, params, and rendering
-      expect(result.rendering).to.equal(componentRendering);
-      expect(result.fields).to.deep.equal({
-        testField: { value: 'test-value' },
-      });
-      expect(result.params).to.deep.equal({
-        testParam: 'test-param',
-      });
-
-      // getChildComponentProps does not include these props
-      expect((result as any).key).to.be.undefined;
-      expect((result as any).customProp).to.be.undefined;
-      expect((result as any).componentMap).to.be.undefined;
-      expect((result as any).missingComponentComponent).to.be.undefined;
-      expect((result as any).hiddenRenderingComponent).to.be.undefined;
-      expect((result as any).name).to.be.undefined;
-    });
-  });
-});