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

package/src/tools/generate-map.test.ts

@@ -1,201 +0,0 @@
-/* eslint-disable quotes */
-/* eslint-disable no-unused-expressions, @typescript-eslint/no-unused-expressions */
-
-import path from 'path';
-import * as chai from 'chai';
-import sinonChai from 'sinon-chai';
-import { expect } from 'chai';
-import sinon from 'sinon';
-
-chai.use(sinonChai);
-import { generateMap } from './generate-map';
-import fs from 'fs';
-import { ComponentImport } from '@sitecore-content-sdk/content/tools';
-
-describe('generateMap', () => {
-  const sandbox = sinon.createSandbox();
-
-  describe('generateMap', () => {
-    const fakePackages: ComponentImport[] = [
-      {
-        importName: 'MyLib',
-        importInfo: {
-          importFrom: '@my/lib',
-        },
-      },
-      {
-        importName: 'OtherLib',
-        importInfo: {
-          importFrom: '@other/lib',
-        },
-      },
-    ];
-
-    beforeEach(() => {
-      sandbox.stub(fs, 'writeFileSync');
-    });
-
-    afterEach(() => {
-      sandbox.restore();
-    });
-
-    it('should write componentMap.ts file with components from "paths" parameter', () => {
-      const paths = ['src/tests/test-components/generate-map'];
-      generateMap({ paths });
-
-      expect(fs.writeFileSync).to.have.been.calledOnce;
-      const [dest, content] = (fs.writeFileSync as sinon.SinonStub).getCall(0).args;
-      expect(dest).to.equal(path.join(process.cwd(), '.sitecore', 'component-map.ts'));
-
-      expect(content).to.include(
-        "import type { AstroContentSdkComponent } from '@exdst-sitecore-content-sdk/astro';"
-      );
-
-      expect(content).to.include(
-        "import Button from 'src/tests/test-components/generate-map/Button.astro';"
-      );
-      expect(content).to.include(
-        "import Link from 'src/tests/test-components/generate-map/Link.astro';"
-      );
-
-      expect(content).to.include('new Map');
-      expect(content).to.include("['Button', Button]");
-      expect(content).to.include("['Link', Link]");
-      expect(content).to.include('export default componentMap;');
-    });
-
-    it('should use template from custom componentMap function, when provided', () => {
-      const paths = ['src/tests/test-components/generate-map'];
-      const customTemplate = sinon.stub().returns('// custom template output');
-      const fakePackages = [
-        {
-          importName: 'CustomLib',
-          importInfo: {
-            importFrom: '@custom/lib',
-          },
-        },
-      ];
-      generateMap({ paths, componentImports: fakePackages, mapTemplate: customTemplate });
-
-      expect(customTemplate).to.have.been.calledOnce;
-      const [componentsArg, packagesArg] = customTemplate.getCall(0).args;
-      expect(packagesArg).to.deep.equal(fakePackages);
-      expect(componentsArg.map((c: any) => c.componentName)).to.include.members(['Button', 'Link']);
-
-      expect(fs.writeFileSync).to.have.been.calledOnce;
-      const [, content] = (fs.writeFileSync as sinon.SinonStub).getCall(0).args;
-      expect(content).to.equal('// custom template output');
-    });
-
-    it('should generate an empty component map if no components are found', () => {
-      const paths = ['src/tests/test-components/generate-map-empty'];
-      generateMap({ paths });
-
-      expect(fs.writeFileSync).to.have.been.calledOnce;
-      const [, content] = (fs.writeFileSync as sinon.SinonStub).getCall(0).args;
-      expect(content).to.include(
-        'export const componentMap = new Map<string, AstroContentSdkComponent>(['
-      );
-      expect(content).to.not.match(/\['Button'[\s\S]*Button/);
-      expect(content).to.not.match(/\['Link'[\s\S]*Link/);
-      expect(content).to.include('export default componentMap;');
-    });
-
-    it('should handle multiple paths and merge their components', () => {
-      const paths = [
-        'src/tests/test-components/generate-map',
-        'src/tests/test-components/map-components',
-      ];
-
-      generateMap({ paths });
-
-      expect(fs.writeFileSync).to.have.been.calledOnce;
-      const [mainDest, content] = (fs.writeFileSync as sinon.SinonStub).getCall(0).args;
-      expect(mainDest).to.equal(path.join(process.cwd(), '.sitecore', 'component-map.ts'));
-
-      expect(content).to.include('new Map');
-
-      expect(content).to.include(
-        "import Button from 'src/tests/test-components/generate-map/Button.astro';"
-      );
-      expect(content).to.include(
-        "import Link from 'src/tests/test-components/generate-map/Link.astro';"
-      );
-      expect(content).to.include(
-        "import Bar from 'src/tests/test-components/map-components/Bar.astro';"
-      );
-
-      expect(content).to.include("['Button', Button]");
-      expect(content).to.include("['Link', Link]");
-      expect(content).to.include("['Bar', Bar]");
-      expect(content).to.include('export default componentMap;');
-    });
-
-    it('should not fail if packages is undefined', () => {
-      const paths = ['src/components'];
-      expect(() => generateMap({ paths, componentImports: undefined })).to.not.throw();
-      expect(fs.writeFileSync).to.have.been.calledOnce;
-    });
-
-    it('should write componentMap.ts file with components from "paths" and "packages" parameters, when provided', () => {
-      const paths = ['src/components'];
-      generateMap({ paths, componentImports: fakePackages });
-
-      expect(fs.writeFileSync).to.have.been.calledOnce;
-      const [, content] = (fs.writeFileSync as sinon.SinonStub).getCall(0).args;
-      expect(content).to.include("import MyLib from '@my/lib';");
-      expect(content).to.include("import OtherLib from '@other/lib';");
-
-      expect(content).to.include(
-        'export const componentMap = new Map<string, AstroContentSdkComponent>(['
-      );
-      expect(content).to.include("['MyLib', MyLib],");
-      expect(content).to.include("['OtherLib', OtherLib],");
-    });
-
-    it('should use custom destination when provided', () => {
-      const paths = ['src/components'];
-      const customDir = path.join(process.cwd(), 'custom/path');
-      const mainDest = path.join(customDir, 'component-map.ts');
-
-      generateMap({ paths, destination: 'custom/path', includeVariants: false });
-
-      expect(fs.writeFileSync).to.have.been.calledOnce;
-
-      const encodingArg = sinon.match.string.or(sinon.match.has('encoding'));
-
-      expect(fs.writeFileSync).to.have.been.calledWithMatch(
-        mainDest,
-        sinon.match.string,
-        encodingArg
-      );
-    });
-
-    it('should pass exclude param into component collection call', () => {
-      const paths = ['src/tests/test-components/generate-map'];
-      const exclude = ['src/tests/test-components/generate-map/Button.*'];
-      generateMap({ paths, exclude });
-
-      expect(fs.writeFileSync).to.have.been.calledOnce;
-      const [, content] = (fs.writeFileSync as sinon.SinonStub).getCall(0).args;
-
-      expect(content).to.include(
-        "import Link from 'src/tests/test-components/generate-map/Link.astro';"
-      );
-      expect(content).to.not.include('Button');
-    });
-
-    it('should throw error when destination cannot be written to', async () => {
-      (fs.writeFileSync as sinon.SinonStub).throws(new Error('Disk full'));
-      const paths = ['src/components'];
-      let errorCaught = null;
-      try {
-        generateMap({ paths });
-      } catch (err) {
-        errorCaught = err;
-      }
-      expect(errorCaught).to.be.an('error');
-      expect((errorCaught as Error).message).to.equal('Disk full');
-    });
-  });
-});

package/src/tools/templating/components.test.ts

@@ -1,318 +0,0 @@
-/* eslint-disable no-unused-expressions */
-import { expect } from 'chai';
-import sinon from 'sinon';
-import { getComponentList } from './components';
-import { ComponentFile } from '@sitecore-content-sdk/content/tools';
-import path from 'path';
-
-describe('components', () => {
-  const sandbox = sinon.createSandbox();
-  beforeEach(() => {
-    sandbox.restore();
-  });
-
-  describe('getComponentList', () => {
-    afterEach(() => {
-      sandbox.restore();
-    });
-
-    it('should return results when one of "paths" is a glob pattern', () => {
-      const items = [
-        {
-          importPath: 'src/tests/test-components/map-components/Qux',
-          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
-          componentName: 'Qux',
-          moduleName: 'Qux',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Foo',
-          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
-          componentName: 'Foo',
-          moduleName: 'Foo',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Baz',
-          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
-          componentName: 'Baz',
-          moduleName: 'Baz',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Bar',
-          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
-          componentName: 'Bar',
-          moduleName: 'Bar',
-        },
-      ] as ComponentFile[];
-
-      const result = getComponentList(
-        ['src/tests/test-components/map-components/*.astro'],
-        ['**/*.test.*'],
-        false
-      );
-      expect(result).to.deep.equal(items);
-    });
-
-    it('should return results with all folded paths when path is a non-glob path', () => {
-      const items = [
-        {
-          importPath: 'src/tests/test-components/map-components/Qux',
-          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
-          componentName: 'Qux',
-          moduleName: 'Qux',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Foo',
-          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
-          componentName: 'Foo',
-          moduleName: 'Foo',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Baz',
-          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
-          componentName: 'Baz',
-          moduleName: 'Baz',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Bar',
-          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
-          componentName: 'Bar',
-          moduleName: 'Bar',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/folded/Folded',
-          filePath: path.normalize('src/tests/test-components/map-components/folded/Folded.astro'),
-          componentName: 'Folded',
-          moduleName: 'Folded',
-        },
-      ] as ComponentFile[];
-
-      const result = getComponentList(
-        ['src/tests/test-components/map-components'],
-        ['**/*.test.*'],
-        false
-      );
-      expect(result).to.deep.equal(items);
-    });
-
-    it('should filter out results that are not components', () => {
-      const items = [
-        {
-          importPath: 'src/tests/test-components/map-components/Qux',
-          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
-          componentName: 'Qux',
-          moduleName: 'Qux',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Foo',
-          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
-          componentName: 'Foo',
-          moduleName: 'Foo',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Baz',
-          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
-          componentName: 'Baz',
-          moduleName: 'Baz',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Bar',
-          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
-          componentName: 'Bar',
-          moduleName: 'Bar',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/folded/Folded',
-          filePath: path.normalize('src/tests/test-components/map-components/folded/Folded.astro'),
-          componentName: 'Folded',
-          moduleName: 'Folded',
-        },
-      ] as ComponentFile[];
-
-      const result = getComponentList(['src/tests/test-components/map-components/**/*']);
-      expect(result).to.deep.equal(items);
-    });
-
-    it('should return result when "paths" contain exact paths to Astro components', () => {
-      const items = [
-        {
-          importPath: 'src/tests/test-components/map-components/Foo',
-          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
-          componentName: 'Foo',
-          moduleName: 'Foo',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Bar',
-          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
-          componentName: 'Bar',
-          moduleName: 'Bar',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Baz',
-          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
-          componentName: 'Baz',
-          moduleName: 'Baz',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Qux',
-          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
-          componentName: 'Qux',
-          moduleName: 'Qux',
-        },
-      ];
-
-      const result = getComponentList([
-        'src/tests/test-components/map-components/Foo.astro',
-        'src/tests/test-components/map-components/Bar.astro',
-        'src/tests/test-components/map-components/Baz.astro',
-        'src/tests/test-components/map-components/Qux.astro',
-      ]);
-      expect(result).to.deep.equal(items);
-    });
-
-    it('should return filtered results when "exclude" contains a glob pattern', () => {
-      const exclude = ['**/test-components/map-components/**'];
-      expect(getComponentList(['src/tests/test-components/map-components/*.astro'], exclude)).to.be
-        .empty;
-    });
-
-    it('should return variants in results when includeVariants is true', () => {
-      sandbox.stub(console, 'debug');
-
-      const items = [
-        {
-          importPath: 'src/tests/test-components/map-components/Qux',
-          filePath: path.normalize('src/tests/test-components/map-components/Qux.astro'),
-          componentName: 'Qux',
-          moduleName: 'Qux',
-        },
-        // variant component
-        {
-          importPath: 'src/tests/test-components/map-components/Hero.variant',
-          filePath: path.normalize('src/tests/test-components/map-components/Hero.variant.astro'),
-          componentName: 'Hero.variant',
-          moduleName: 'Herovariant',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Foo',
-          filePath: path.normalize('src/tests/test-components/map-components/Foo.astro'),
-          componentName: 'Foo',
-          moduleName: 'Foo',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Baz',
-          filePath: path.normalize('src/tests/test-components/map-components/Baz.astro'),
-          componentName: 'Baz',
-          moduleName: 'Baz',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Bar',
-          filePath: path.normalize('src/tests/test-components/map-components/Bar.astro'),
-          componentName: 'Bar',
-          moduleName: 'Bar',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/folded/Folded',
-          filePath: path.normalize('src/tests/test-components/map-components/folded/Folded.astro'),
-          componentName: 'Folded',
-          moduleName: 'Folded',
-        },
-      ] as ComponentFile[];
-
-      const result = getComponentList(
-        ['src/tests/test-components/map-components'],
-        ['**/*.test.*'],
-        true
-      );
-      expect(result).to.deep.equal(items);
-    });
-
-    it('should return filtered results when "exclude" contains an exact path', () => {
-      const exclude = ['src/tests/test-components/map-components/Foo.astro'];
-      getComponentList(['src/tests/test-components/map-components/*.astro'], exclude);
-    });
-
-    it('should return correct result in unix file systems', () => {
-      const stubbedPaths = [
-        'src/tests/test-components/map-components/Foo.astro',
-        'src/tests/test-components/map-components/Bar.astro',
-        'src/tests/test-components/map-components/Baz.astro',
-        'src/tests/test-components/map-components/Qux.astro',
-      ];
-      const expected = [
-        {
-          importPath: 'src/tests/test-components/map-components/Foo',
-          filePath: 'src/tests/test-components/map-components/Foo.astro',
-          componentName: 'Foo',
-          moduleName: 'Foo',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Bar',
-          filePath: 'src/tests/test-components/map-components/Bar.astro',
-          componentName: 'Bar',
-          moduleName: 'Bar',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Baz',
-          filePath: 'src/tests/test-components/map-components/Baz.astro',
-          componentName: 'Baz',
-          moduleName: 'Baz',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Qux',
-          filePath: 'src/tests/test-components/map-components/Qux.astro',
-          componentName: 'Qux',
-          moduleName: 'Qux',
-        },
-      ];
-
-      const globSyncStub = sandbox.stub(require('glob'), 'sync').returns(stubbedPaths);
-
-      const result = getComponentList(['src/tests/test-components/map-components/*.astro']);
-      expect(result).to.deep.equal(expected);
-
-      globSyncStub.restore();
-    });
-
-    it('should return correct result in windows file systems', () => {
-      const stubbedPaths = [
-        'src\\tests\\test-components\\map-components\\Foo.astro',
-        'src\\tests\\test-components\\map-components\\Bar.astro',
-        'src\\tests\\test-components\\map-components\\Baz.astro',
-        'src\\tests\\test-components\\map-components\\Qux.astro',
-      ];
-      const expected = [
-        {
-          importPath: 'src/tests/test-components/map-components/Foo',
-          filePath: 'src\\tests\\test-components\\map-components\\Foo.astro',
-          componentName: 'Foo',
-          moduleName: 'Foo',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Bar',
-          filePath: 'src\\tests\\test-components\\map-components\\Bar.astro',
-          componentName: 'Bar',
-          moduleName: 'Bar',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Baz',
-          filePath: 'src\\tests\\test-components\\map-components\\Baz.astro',
-          componentName: 'Baz',
-          moduleName: 'Baz',
-        },
-        {
-          importPath: 'src/tests/test-components/map-components/Qux',
-          filePath: 'src\\tests\\test-components\\map-components\\Qux.astro',
-          componentName: 'Qux',
-          moduleName: 'Qux',
-        },
-      ];
-
-      const globSyncStub = sandbox.stub(require('glob'), 'sync').returns(stubbedPaths);
-
-      const result = getComponentList(['src/tests/test-components/map-components/*.astro']);
-      expect(result).to.deep.equal(expected);
-
-      globSyncStub.restore();
-    });
-  });
-});

package/src/tools/templating/default-component.test.ts

@@ -1,31 +0,0 @@
-/* eslint-disable no-unused-expressions, @typescript-eslint/no-unused-expressions */
-import { expect } from 'chai';
-import { defaultTemplate } from './default-component';
-import chalk from 'chalk';
-
-describe('default-component', () => {
-  describe('generateTemplate', () => {
-    it('should generate a template with the given component name', () => {
-      const componentName = 'TestComponent';
-      const template = defaultTemplate.generateTemplate(componentName);
-      expect(template).to.include(`export type ${componentName}Props`);
-      expect(template).to.include(`<p>${componentName} Component</p>`);
-    });
-  });
-
-  describe('getNextSteps', () => {
-    it('should return an empty array if no componentOutputPath is provided', () => {
-      const nextSteps = defaultTemplate.getNextSteps && defaultTemplate.getNextSteps('');
-      expect(nextSteps).to.be.an('array').that.is.empty;
-    });
-
-    it('should return an array with next steps if componentOutputPath is provided', () => {
-      const componentOutputPath = 'src/components/TestComponent.astro';
-      const nextSteps =
-        defaultTemplate.getNextSteps && defaultTemplate.getNextSteps(componentOutputPath);
-      expect(nextSteps)
-        .to.be.an('array')
-        .that.includes(`* Implement the Astro component in ${chalk.green(componentOutputPath)}`);
-    });
-  });
-});

package/src/utils/utils.test.ts

@@ -1,111 +0,0 @@
-/* eslint-disable no-unused-expressions */
-import { expect, use } from 'chai';
-import spies from 'chai-spies';
-import { addClassName, extractPath, getEditingSecret, removeLanguageFromPath } from './utils';
-
-use(spies);
-
-describe('utils', () => {
-  describe('getEditingSecret', () => {
-    afterEach(() => {
-      delete process.env.SITECORE_EDITING_SECRET;
-    });
-
-    it('should throw if env variable missing', () => {
-      expect(() => getEditingSecret()).to.throw();
-    });
-
-    it('should return env variable', () => {
-      const secret = '1234abcd';
-      process.env.SITECORE_EDITING_SECRET = secret;
-      const result = getEditingSecret();
-      expect(result).to.equal(secret);
-    });
-  });
-});
-
-describe('addClassName', () => {
-  it('should add class attribute value to className', () => {
-    const modifiableAttrs = {
-      className: 'first-class',
-      class: 'second-class',
-    };
-    addClassName(modifiableAttrs);
-    expect(modifiableAttrs).to.deep.equal({
-      className: 'first-class second-class',
-    });
-  });
-
-  it('should convert class attribute value to className when className is absent', () => {
-    const modifiableAttrs = {
-      class: 'second-class',
-    };
-    addClassName(modifiableAttrs);
-    expect(modifiableAttrs).to.deep.equal({
-      className: 'second-class',
-    });
-  });
-
-  it('should keep attributes unchanged when class is absent', () => {
-    const modifiableAttrs = {
-      className: 'first-class',
-      id: 'image',
-    };
-    addClassName(modifiableAttrs);
-    expect(modifiableAttrs).to.deep.equal({
-      className: 'first-class',
-      id: 'image',
-    });
-  });
-});
-
-describe('extractPath', () => {
-  it('should return root slash when params are undefined', () => {
-    const result = extractPath(undefined as unknown as Record<string, string | undefined>);
-    expect(result).to.equal('/');
-  });
-
-  it('should join path segments when path is an array', () => {
-    const result = extractPath({ path: ['about', 'team'] as unknown as string });
-    expect(result).to.equal('about/team');
-  });
-
-  it('should return path when path is a string', () => {
-    const result = extractPath({ path: 'about' });
-    expect(result).to.equal('about');
-  });
-
-  it('should return root slash when path is missing', () => {
-    const result = extractPath({});
-    expect(result).to.equal('/');
-  });
-});
-
-describe('removeLanguageFromPath', () => {
-  const languages = ['en', 'fr', 'de-DE'];
-
-  it('should remove a leading language segment', () => {
-    const result = removeLanguageFromPath('en/About', languages);
-    expect(result).to.equal('About');
-  });
-
-  it('should remove a language segment following a _site_ segment', () => {
-    const result = removeLanguageFromPath('_site_Basic/en/About', languages);
-    expect(result).to.equal('_site_Basic/About');
-  });
-
-  it('should match languages case-insensitively', () => {
-    const result = removeLanguageFromPath('_site_Basic/FR/About', languages);
-    expect(result).to.equal('_site_Basic/About');
-  });
-
-  it('should return root slash when path only contains a language segment', () => {
-    const result = removeLanguageFromPath('en', languages);
-    expect(result).to.equal('/');
-  });
-
-  it('should leave path unchanged when no supported language is found', () => {
-    const result = removeLanguageFromPath('es/About', languages);
-    expect(result).to.equal('es/About');
-  });
-});