@exdst-sitecore-content-sdk/astro 0.0.1

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

@@ -0,0 +1,63 @@
+import chalk from 'chalk';
+import {
+  ScaffoldTemplate,
+  ComponentTemplateType,
+} from '@sitecore-content-sdk/core/config';
+import { COMPONENT_FILE_EXTENSION } from './constants';
+
+/**
+ * Astro component boilerplate
+ * @param {string} componentName - the component name
+ * @returns component generated template
+ */
+const generateTemplate = (componentName: string): string => {
+  return `
+  ---
+  import { Field } from "@astro-sitecore-jss/astro-content-sdk";
+  
+  interface Fields {
+    Title: Field<string>;
+  }
+
+  export type ${componentName}Props = {
+    params: { [key: string]: string };
+    fields: Fields;
+  };
+
+  const props: ${componentName}Props = Astro.props.route;
+
+  const id = props.params.RenderingIdentifier;
+---
+
+  <div class={\`component \${props.params.styles}\`} id={id ? id : undefined}>
+    <div class="component-content">
+      <p>${componentName} Component</p>
+      <Text field={props.fields.Title} />
+    </div>
+  </div>
+`;
+};
+
+/**
+ * Generates a list of next steps when scaffolding a component.
+ * @param {string} componentOutputPath - The file path where the component file is generated.
+ * @returns {string[]} An array of strings, each representing a next step.
+ */
+const getNextSteps = (componentOutputPath: string): string[] => {
+  const nextSteps = [];
+
+  if (componentOutputPath) {
+    nextSteps.push(
+      `* Implement the Astro component in ${chalk.green(componentOutputPath)}`
+    );
+  }
+
+  return nextSteps;
+};
+
+export const defaultTemplate: ScaffoldTemplate = {
+  name: ComponentTemplateType.DEFAULT,
+  fileExtension: COMPONENT_FILE_EXTENSION,
+  generateTemplate,
+  getNextSteps,
+};

package/src/tools/templating/index.ts

@@ -0,0 +1,2 @@
+export { getComponentList } from './components';
+

package/src/utils/index.ts

@@ -0,0 +1 @@
+export { getEditingSecret, extractPath, removeLanguageFromPath, addClassName } from './utils';

package/src/utils/utils.test.ts

@@ -0,0 +1,48 @@
+/* eslint-disable no-unused-expressions */
+import { expect, use } from 'chai';
+import spies from 'chai-spies';
+import { addClassName, getEditingSecret } 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',
+      });
+    });
+  });
+});

package/src/utils/utils.ts

@@ -0,0 +1,52 @@
+export const getEditingSecret = (): string => {
+  const secret = process.env.SITECORE_EDITING_SECRET;
+
+  if (!secret || secret.length === 0) {
+    throw new Error('The SITECORE_EDITING_SECRET environment variable is missing or invalid.');
+  }
+  return secret.toLowerCase();
+};
+
+export const extractPath = (params: Record<string, string | undefined>) => {
+  return params === undefined
+    ? '/'
+    : Array.isArray(params.path)
+    ? params.path.join('/')
+    : params.path ?? '/';
+};
+
+export const removeLanguageFromPath = (path: string, languages: string[]): string => {
+  const segments = path.split('/');
+
+  const langs = languages.map((lang) => lang.toLowerCase());
+
+  if (segments.length > 0 && langs.includes(segments[0].toLowerCase())) {
+    // E.g. /en/About
+    segments.splice(0, 1);
+  } else if (segments.length > 1 && langs.includes(segments[1].toLowerCase())) {
+    // if path contains _site_ segment before language
+    // E.g. /_site_Basic/en/About
+    segments.splice(1, 1);
+  }
+
+  return segments.join('/') || '/';
+};
+
+/**
+ * "class" property will be transformed into or appended to "className" instead.
+ * @param {string} otherAttrs all other props included on the image component
+ * @returns {void}
+ */
+export const addClassName = (otherAttrs: { [key: string]: unknown }): void => {
+  if (otherAttrs.class) {
+    // if any classes are defined properly already
+    if (otherAttrs.className) {
+      let className: string = otherAttrs.className as string;
+      className += ` ${otherAttrs.class}`;
+      otherAttrs.className = className;
+    } else {
+      otherAttrs.className = otherAttrs.class;
+    }
+    delete otherAttrs.class;
+  }
+};