@squiz/component-cli-lib 1.69.1 → 1.70.0

package/src/component-init.spec.ts

@@ -1,258 +0,0 @@
-import componentInit from './component-init';
-import fs from 'fs-extra';
-import * as logger from '@squiz/dx-logger-lib';
-import path from 'path';
-
-jest.mock('fs-extra');
-jest.mock('path', () => {
-  return {
-    ...jest.requireActual('path'),
-  };
-});
-
-const fsMocked = jest.mocked(fs);
-
-beforeEach(() => {
-  jest.restoreAllMocks();
-  fsMocked.readJSON.mockResolvedValue({});
-
-  // Reset our process.env.NODE_ENV variable
-  process.env.NODE_ENV = 'test';
-});
-
-describe('componentInit', () => {
-  it('should setup a new logger instance with the correct options', async () => {
-    const loggerSpy = jest.spyOn(logger, 'getLogger');
-
-    // Mock the process.env.NODE_ENV variable to be "development"
-    process.env.NODE_ENV = 'development';
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '',
-    });
-
-    expect(loggerSpy).toHaveBeenCalledWith({
-      name: 'component-dev',
-      format: 'human',
-      silent: false,
-    });
-  });
-
-  it('path.resolve should be called with __dirname to get the current script directory', async () => {
-    const pathResolveSpy = jest.spyOn(path, 'resolve');
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '',
-    });
-
-    expect(pathResolveSpy).toHaveBeenCalledWith(__dirname);
-  });
-
-  it('path.join should be called with the current script directory and the component type to get the source folder', async () => {
-    const pathJoinSpy = jest.spyOn(path, 'join');
-
-    jest
-      .spyOn(path, 'resolve')
-      .mockReturnValue('/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src');
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '',
-    });
-
-    expect(pathJoinSpy).toHaveBeenCalledWith(
-      '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src',
-      'templates',
-      'basic',
-    );
-  });
-
-  it('path.resolve should be called with the destination folder to get the destination folder', async () => {
-    const pathResolveSpy = jest.spyOn(path, 'resolve');
-
-    jest.spyOn(path, 'resolve').mockReturnValue('/Users/username/Projects/squiz/new-component');
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '/Users/username/Projects/squiz/new-component',
-    });
-
-    expect(pathResolveSpy).toHaveBeenCalledWith('/Users/username/Projects/squiz/new-component');
-  });
-
-  it('should fail if the destination folder already exists and there are files in it', async () => {
-    // Mock the current script directory
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src';
-    });
-
-    // Mock the destination folder
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/new-component';
-    });
-
-    // Mock the fs.pathExists function to return true
-    jest.spyOn(fs, 'pathExists').mockImplementationOnce(() => {
-      return Promise.resolve(true);
-    });
-
-    // Mock the fs.readdirSync function to return an array of files
-    jest.spyOn(fs, 'readdir').mockImplementationOnce(() => {
-      return Promise.resolve(['file1.txt', 'file2.txt']);
-    });
-
-    await expect(
-      componentInit({
-        componentType: 'basic',
-        destination: '/Users/username/Projects/squiz/new-component',
-      }),
-    ).rejects.toThrowError('The destination folder already exists and is not empty.');
-  });
-
-  it('should create the destination folder if it does not exist', async () => {
-    // Mock the current script directory
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src';
-    });
-
-    // Mock the destination folder
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/new-component';
-    });
-
-    // Mock the fs.pathExists function to return false
-    jest.spyOn(fs, 'pathExists').mockImplementationOnce(() => {
-      return Promise.resolve(false);
-    });
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '/Users/username/Projects/squiz/new-component',
-    });
-
-    expect(fs.mkdirp).toHaveBeenCalledWith('/Users/username/Projects/squiz/new-component');
-  });
-
-  it('should not fail if the destination folder already exists and there are no files in it', async () => {
-    // Mock the current script directory
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src';
-    });
-
-    // Mock the destination folder
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/new-component';
-    });
-
-    // Mock the fs.pathExists function to return true
-    jest.spyOn(fs, 'pathExists').mockImplementationOnce(() => {
-      return Promise.resolve(true);
-    });
-
-    // Mock the fs.readdir function to return an empty array
-    jest.spyOn(fs, 'readdir').mockImplementationOnce(() => {
-      return Promise.resolve([]);
-    });
-
-    await expect(
-      componentInit({
-        componentType: 'basic',
-        destination: '/Users/username/Projects/squiz/new-component',
-      }),
-    ).resolves.toBeUndefined();
-  });
-
-  it('fs.copy should be called with the source folder and the destination folder', async () => {
-    // Mock the fs.copy function
-    const fsCopySpy = jest.spyOn(fs, 'copy');
-
-    // Mock the current script directory
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/src';
-    });
-
-    // Mock the source folder
-    jest.spyOn(path, 'join').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/templates/basic';
-    });
-
-    // Mock the destination folder
-    jest.spyOn(path, 'resolve').mockImplementationOnce(() => {
-      return '/Users/username/Projects/squiz/new-component';
-    });
-
-    // Mock the fs.pathExists function to return true
-    jest.spyOn(fs, 'pathExists').mockImplementationOnce(() => {
-      return Promise.resolve(true);
-    });
-
-    // Mock the fs.readdir function to return an empty array
-    jest.spyOn(fs, 'readdir').mockImplementationOnce(() => {
-      return Promise.resolve([]);
-    });
-
-    await componentInit({
-      componentType: 'basic',
-      destination: '/Users/username/Projects/squiz/new-component',
-    });
-
-    expect(fsCopySpy).toHaveBeenCalledWith(
-      '/Users/username/Projects/squiz/component-cli-lib/packages/component-cli-lib/templates/basic',
-      '/Users/username/Projects/squiz/new-component',
-    );
-  });
-
-  describe('prompts', () => {
-    it('should default when no prompts provided', async () => {
-      await componentInit({ componentType: 'basic', destination: '' });
-
-      expect(fsMocked.writeJSON).toHaveBeenCalledWith(
-        expect.any(String),
-        expect.objectContaining({
-          name: 'default',
-          namespace: 'default-namespace',
-          displayName: 'Default',
-        }),
-        expect.objectContaining({ spaces: 2 }),
-      );
-    });
-
-    it('should overwrite default values with provided values', async () => {
-      await componentInit({
-        componentType: 'basic',
-        destination: '',
-        prompts: {
-          name: 'my-component',
-          namespace: 'my-namespace',
-          displayName: 'My Component',
-        },
-      });
-
-      expect(fsMocked.writeJSON).toHaveBeenCalledWith(
-        expect.any(String),
-        expect.objectContaining({
-          name: 'my-component',
-          namespace: 'my-namespace',
-          displayName: 'My Component',
-        }),
-        expect.objectContaining({ spaces: 2 }),
-      );
-    });
-
-    it('should read and write the destination manifest file', async () => {
-      await componentInit({
-        componentType: 'basic',
-        destination: '/Users/username/Projects/squiz/new-component',
-      });
-
-      expect(fsMocked.readJSON).toHaveBeenCalledWith('/Users/username/Projects/squiz/new-component/manifest.json');
-      expect(fsMocked.writeJSON).toHaveBeenCalledWith(
-        '/Users/username/Projects/squiz/new-component/manifest.json',
-        expect.any(Object),
-        expect.objectContaining({ spaces: 2 }),
-      );
-    });
-  });
-});

package/src/component-init.ts

@@ -1,81 +0,0 @@
-import fse from 'fs-extra';
-import path from 'path';
-import { getLogger, LoggerOptions } from '@squiz/dx-logger-lib';
-
-export interface InitPrompts {
-  name: string;
-  displayName: string;
-  description: string;
-  namespace: string;
-}
-
-const DEFAULT_PROMPTS: InitPrompts = {
-  name: 'default',
-  displayName: 'Default',
-  description: 'Default component',
-  namespace: 'default-namespace',
-};
-
-interface InitOptions {
-  componentType: 'basic' | 'advanced';
-  destination: string;
-  loggingFormat?: LoggerOptions['format'];
-  prompts?: Partial<InitPrompts>;
-}
-
-/**
- * componentInit initializes a new component
- * @param {object} options - The options object
- * @param {string} options.componentType - The type of component to initialize
- * @returns {void}
- */
-export default async function componentInit(options: InitOptions) {
-  const logger = getLogger({
-    name: 'component-dev',
-    format: options.loggingFormat || 'human',
-    silent: process.env.NODE_ENV === 'test',
-  });
-
-  logger.info('Initializing component...');
-
-  // Get our current script directory
-  const currentScriptDir = path.resolve(__dirname);
-
-  // Define the file source to move from
-  const sourceFolder = path.join(currentScriptDir, 'templates', options.componentType);
-
-  // Define the file destination to move to
-  const destination = path.resolve(options.destination);
-
-  // If the destination folder already exists, and it's not empty, throw an error
-  if (await fse.pathExists(destination)) {
-    const files = await fse.readdir(destination);
-    if (files.length > 0) {
-      throw new Error('The destination folder already exists and is not empty.');
-    }
-  } else {
-    // If the destination folder doesn't exist, create it
-    await fse.mkdirp(destination);
-  }
-
-  // Copy the contents of the source folder to the destination folder
-  await fse.copy(sourceFolder, destination);
-  await writeManifestVariables({ destination, prompts: Object.assign({}, DEFAULT_PROMPTS, options.prompts) });
-
-  logger.info('Component initialized!');
-}
-
-async function writeManifestVariables(options: { destination: string; prompts: InitPrompts }) {
-  const { destination, prompts } = options;
-
-  const manifestPath = path.resolve(destination, 'manifest.json');
-
-  const manifest = await fse.readJSON(manifestPath);
-
-  manifest.name = prompts.name;
-  manifest.displayName = prompts.displayName;
-  manifest.description = prompts.description;
-  manifest.namespace = prompts.namespace;
-
-  await fse.writeJSON(manifestPath, manifest, { spaces: 2 });
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-export { uploadComponentFolder } from './upload-component-folder';
-export { startDevelopmentRender } from './component-dev';
-export { startEdgeDevelopmentRender } from './component-edge-dev';
-export { default as componentInit, InitPrompts } from './component-init';
-export { uploadJobFolder } from './upload-job';

package/src/integration-tests/__components__/big-package/manifest.json

@@ -1,36 +0,0 @@
-{
-  "$schema": "http://localhost:3000/schemas/v1.json#",
-
-  "name": "big-package",
-  "version": "1.0.2",
-  "mainFunction": "render-json",
-  "namespace": "smoke-test-components",
-  "displayName": "some-displayName",
-  "description": "some-description",
-  "functions": [
-    {
-      "name": "render-json",
-      "entry": "render-json.js",
-      "input": {
-        "type": "object",
-        "properties": {
-          "something": {
-            "type": "string"
-          }
-        },
-        "required": ["something"]
-      },
-      "output": {
-        "responseType": "json",
-        "definition": {
-          "properties": {
-            "my-prop": {
-              "type": "string"
-            }
-          },
-          "required": ["my-prop"]
-        }
-      }
-    }
-  ]
-}

package/src/integration-tests/__components__/big-package/render-json.js

@@ -1,5 +0,0 @@
-module.exports = async function () {
-  return {
-    'my-prop': 'test value for my-prop',
-  };
-};

package/src/integration-tests/__components__/cmp-format-string/main.js

@@ -1,7 +0,0 @@
-/**
- * @param {object} input
- * @param {ComponentInfo} info
- */
-module.exports = async function (input, info) {
-  return `<div>Input: ${input.text}</div>`;
-};

package/src/integration-tests/__components__/cmp-format-string/manifest.json

@@ -1,41 +0,0 @@
-{
-  "$schema": "http://localhost:3000/schemas/v1.json#",
-
-  "name": "cmp-format-string",
-  "version": "1.0.0",
-  "mainFunction": "main",
-  "displayName": "some-display-name",
-  "namespace": "smoke-test-components",
-  "description": "some-description",
-  "functions": [
-    {
-      "name": "main",
-      "entry": "main.js",
-      "input": {
-        "type": "object",
-        "properties": {
-          "text": {
-            "type": "string",
-            "format": "multi-line"
-          }
-        },
-        "required": ["text"]
-      },
-      "output": { "responseType": "html" }
-    }
-  ],
-  "previews": {
-    "test-preview": {
-      "functionData": {
-        "main": {
-          "inputData": {
-            "type": "inline",
-            "value": {
-              "text": "this is a test"
-            }
-          }
-        }
-      }
-    }
-  }
-}

package/src/integration-tests/__components__/cmp-no-api-key/main.js

@@ -1,25 +0,0 @@
-/**
- * @param {object} input
- * @param {ComponentInfo} info
- */
-module.exports = async function (input, info) {
-  function hasDxpApiKey(obj) {
-    if (typeof obj === 'object' && obj !== null) {
-      if (obj.hasOwnProperty('dxpApiKey')) {
-        return true;
-      }
-      for (const prop in obj) {
-        if (hasDxpApiKey(obj[prop])) {
-          return true;
-        }
-      }
-    }
-    return false;
-  }
-
-  if (hasDxpApiKey(input) || hasDxpApiKey(info)) {
-    return 'true';
-  }
-
-  return 'false';
-};

package/src/integration-tests/__components__/cmp-no-api-key/manifest.json

@@ -1,41 +0,0 @@
-{
-  "$schema": "http://localhost:3000/schemas/v1.json#",
-
-  "name": "cmp-no-api-key",
-  "version": "1.0.0",
-  "mainFunction": "main",
-  "displayName": "some-display-name",
-  "namespace": "smoke-test-components",
-  "description": "some-description",
-  "functions": [
-    {
-      "name": "main",
-      "entry": "main.js",
-      "input": {
-        "type": "object",
-        "properties": {
-          "text": {
-            "type": "string",
-            "format": "multi-line"
-          }
-        },
-        "required": []
-      },
-      "output": { "responseType": "html" }
-    }
-  ],
-  "previews": {
-    "test-preview": {
-      "functionData": {
-        "main": {
-          "inputData": {
-            "type": "inline",
-            "value": {
-              "text": "this is a test"
-            }
-          }
-        }
-      }
-    }
-  }
-}

package/src/integration-tests/__components__/cmp-property-order/main.js

@@ -1,6 +0,0 @@
-/**
- * @param {object} input
- */
-module.exports = async function (input) {
-  return `<div>Input: ${JSON.stringify(input)}</div>`;
-};

package/src/integration-tests/__components__/cmp-property-order/manifest.json

@@ -1,60 +0,0 @@
-{
-  "$schema": "http://localhost:3000/schemas/v1.json#",
-
-  "name": "cmp-property-order",
-  "version": "1.0.0",
-  "mainFunction": "main",
-  "displayName": "some-display-name",
-  "namespace": "smoke-test-components",
-  "description": "some-description",
-  "functions": [
-    {
-      "name": "main",
-      "entry": "main.js",
-      "input": {
-        "type": "object",
-        "properties": {
-          "input1": {
-            "type": "string"
-          },
-          "333": {
-            "type": "string"
-          },
-          "input333": {
-            "type": "string"
-          },
-          "\"": {
-            "type": "string"
-          },
-          "~": {
-            "type": "string"
-          },
-          "": {
-            "type": "string"
-          },
-          "$": {
-            "type": "string"
-          },
-          "111": {
-            "type": "string"
-          },
-          "input22": {
-            "type": "string"
-          },
-          "222": {
-            "type": "string"
-          },
-          "*": {
-            "type": "string"
-          },
-          "null": {
-            "type": "null",
-            "default": null
-          }
-        },
-        "required": []
-      },
-      "output": { "responseType": "html" }
-    }
-  ]
-}

package/src/integration-tests/__components__/cmp-static-file-test/main.js

@@ -1,6 +0,0 @@
-module.exports = async function (input, info) {
-  return (
-    `<div>Input: ${input.something}</div>` +
-    `<div>${info.componentName} ${info.version} ${info.ctx.getStaticResourceUrl('birthday-cake.png')}</div>`
-  );
-};

package/src/integration-tests/__components__/cmp-static-file-test/manifest.json

@@ -1,42 +0,0 @@
-{
-  "$schema": "http://localhost:3000/schemas/v1.json#",
-
-  "name": "cmp-static-file-test",
-  "version": "1.0.0",
-  "mainFunction": "main",
-  "namespace": "smoke-test-components",
-  "displayName": "some-displayName",
-  "description": "some-description",
-  "functions": [
-    {
-      "entry": "main.js",
-      "name": "main",
-      "input": {
-        "type": "object",
-        "properties": {
-          "something": {
-            "type": "string"
-          }
-        },
-        "required": []
-      },
-      "output": {
-        "responseType": "html",
-
-        "staticFiles": [
-          {
-            "location": "header",
-            "file": {
-              "filepath": "static-library-file.js",
-              "type": "js"
-            }
-          }
-        ]
-      }
-    }
-  ],
-
-  "staticFiles": {
-    "locationRoot": "public"
-  }
-}

package/src/integration-tests/__components__/cmp-static-file-test/public/static-library-file.js

@@ -1 +0,0 @@
-const name = 'foo';

package/src/integration-tests/__components__/invalid-manifest/main.js

@@ -1,3 +0,0 @@
-module.exports = async function (input, info) {
-  return '<div>test</div>';
-};

package/src/integration-tests/__components__/invalid-manifest/manifest.json

@@ -1,29 +0,0 @@
-{
-  "$schema": "http://localhost:3000/schemas/v1.json#",
-
-  "name": "invalid-manifes@t",
-  "version": "1.0.0",
-  "mainFunction": "main",
-  "namespace": "smoke-test-components",
-  "displayName": "some-displayName",
-  "description": "some-description",
-
-  "functions": [
-    {
-      "entry": "main.js",
-      "name": "main",
-      "input": {
-        "type": "object",
-        "properties": {
-          "something": {
-            "type": "string"
-          }
-        },
-        "required": ["something"]
-      },
-      "output": {
-        "responseType": "html"
-      }
-    }
-  ]
-}

package/src/integration-tests/__components__/invalid-upload/main.js

@@ -1,3 +0,0 @@
-module.exports = async function (input, info) {
-  return '<div>test</div>';
-};

package/src/integration-tests/__components__/matrix-asset-uri/main.js

@@ -1,7 +0,0 @@
-/**
- * @param {object} input
- * @param {ComponentInfo} info
- */
-module.exports = async function (input, info) {
-  return `<div>Input: ${input.text}</div>`;
-};