@strapi/generators 4.10.1 → 4.10.2

package/dist/plops/utils/validate-file-name-input.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (input) => {
+    const regex = /^[A-Za-z-_0-9]+$/g;
+    if (!input) {
+        return 'You must provide an input';
+    }
+    return regex.test(input) || "Please use only letters and number, '-' or '_' and no spaces";
+};
+//# sourceMappingURL=validate-file-name-input.js.map

package/dist/plops/utils/validate-file-name-input.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-file-name-input.js","sourceRoot":"","sources":["../../../src/plops/utils/validate-file-name-input.ts"],"names":[],"mappings":";;AAAA,kBAAe,CAAC,KAAa,EAAE,EAAE;IAC/B,MAAM,KAAK,GAAG,mBAAmB,CAAC;IAElC,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,2BAA2B,CAAC;KACpC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,8DAA8D,CAAC;AAC7F,CAAC,CAAC"}

package/dist/plops/utils/validate-input.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (input: string) => true | "You must provide an input" | "Please use only letters, '-' and no spaces";
+export default _default;

package/dist/plops/utils/validate-input.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (input) => {
+    const regex = /^[A-Za-z-]+$/g;
+    if (!input) {
+        return 'You must provide an input';
+    }
+    return regex.test(input) || "Please use only letters, '-' and no spaces";
+};
+//# sourceMappingURL=validate-input.js.map

package/dist/plops/utils/validate-input.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-input.js","sourceRoot":"","sources":["../../../src/plops/utils/validate-input.ts"],"names":[],"mappings":";;AAAA,kBAAe,CAAC,KAAa,EAAE,EAAE;IAC/B,MAAM,KAAK,GAAG,eAAe,CAAC;IAE9B,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,2BAA2B,CAAC;KACpC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,4CAA4C,CAAC;AAC3E,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/generators",
-  "version": "4.10.1",
+  "version": "4.10.2",
   "description": "Interactive API generator.",
   "keywords": [
     "strapi",
@@ -27,23 +27,40 @@
       "url": "https://strapi.io"
     }
   ],
-  "main": "lib/index.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist"
+  ],
   "scripts": {
+    "build": "run -T tsc && run copy-files",
+    "build:ts": "run build",
+    "watch": "run -T tsc -w --preserveWatchOutput",
+    "clean": "run -T rimraf ./dist",
+    "copy-files": "copyfiles -u 1 -a 'src/templates/**/*' 'src/files/**/*' dist",
+    "prepublishOnly": "yarn clean && yarn build",
+    "test:unit": "run -T jest",
+    "test:unit:watch": "run -T jest --watch",
     "lint": "run -T eslint ."
   },
   "dependencies": {
     "@sindresorhus/slugify": "1.1.0",
-    "@strapi/typescript-utils": "4.10.1",
-    "@strapi/utils": "4.10.1",
+    "@strapi/typescript-utils": "4.10.2",
+    "@strapi/utils": "4.10.2",
     "chalk": "4.1.2",
+    "copyfiles": "2.4.1",
     "fs-extra": "10.0.0",
     "node-plop": "0.26.3",
     "plop": "2.7.6",
     "pluralize": "8.0.0"
   },
+  "devDependencies": {
+    "eslint-config-custom": "4.10.2",
+    "tsconfig": "4.10.2"
+  },
   "engines": {
     "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "23b531cef55c1583ea7d526b2baf2340a3129dad"
+  "gitHead": "a02b19866a3bcc1f30c2395698afae6e9c3e0515"
 }

package/.eslintignore

@@ -1,3 +0,0 @@
-node_modules/
-.eslintrc.js
-lib/files/

package/.eslintrc.js

@@ -1,4 +0,0 @@
-module.exports = {
-  root: true,
-  extends: ['custom/back'],
-};

package/lib/index.js

@@ -1,37 +0,0 @@
-'use strict';
-
-const { join } = require('path');
-const { Plop, run } = require('plop');
-const nodePlop = require('node-plop');
-
-/**
- * Starts the Plop CLI programmatically
- */
-const runCLI = () => {
-  Plop.launch({ configPath: join(__dirname, 'plopfile.js') }, (env) =>
-    run({ ...env, dest: join(process.cwd(), 'src') }, undefined, true)
-  );
-};
-
-/**
- * Runs a generator programmatically without prompts
- * @param {string} generatorName
- * @param {Object} options generator options replacing the prompts answers
- * @param {Object} plopOptions
- * @param {string} plopOptions.dir base path for plop to generate the files from
- */
-const generate = async (generatorName, options, { dir = process.cwd() } = {}) => {
-  const plop = nodePlop(join(__dirname, 'plopfile.js'), { destBasePath: join(dir, 'src') });
-
-  const generator = plop.getGenerator(generatorName);
-  await generator.runActions(options, {
-    onSuccess() {},
-    onFailure() {},
-    onComment() {},
-  });
-};
-
-module.exports = {
-  generate,
-  runCLI,
-};

package/lib/plopfile.js

@@ -1,28 +0,0 @@
-'use strict';
-
-const pluralize = require('pluralize');
-
-const generateApi = require('./plops/api');
-const generateController = require('./plops/controller');
-const generateContentType = require('./plops/content-type');
-const generatePlugin = require('./plops/plugin');
-const generatePolicy = require('./plops/policy');
-const generateMiddleware = require('./plops/middleware');
-const generateMigration = require('./plops/migration');
-const generateService = require('./plops/service');
-
-module.exports = (plop) => {
-  // Plop config
-  plop.setWelcomeMessage('Strapi Generators');
-  plop.addHelper('pluralize', (text) => pluralize(text));
-
-  // Generators
-  generateApi(plop);
-  generateController(plop);
-  generateContentType(plop);
-  generatePlugin(plop);
-  generatePolicy(plop);
-  generateMiddleware(plop);
-  generateMigration(plop);
-  generateService(plop);
-};

package/lib/plops/__tests__/content-type.test.js

@@ -1,179 +0,0 @@
-'use strict';
-
-const path = require('path');
-const { readFile, remove, stat } = require('fs-extra');
-const strapiGenerators = require('../../index');
-
-describe('Content Type Generator', () => {
-  const outputDirectory = path.join(__dirname, 'output');
-
-  afterEach(async () => {
-    await remove(outputDirectory);
-  });
-
-  test('it generates the schema', async () => {
-    await strapiGenerators.generate(
-      'content-type',
-      {
-        displayName: 'testContentType',
-        singularName: 'testContentType',
-        pluralName: 'testContentTypes',
-        kind: 'singleType',
-        id: 'testContentType',
-        useDraftAndPublish: false,
-        destination: 'new',
-        bootstrapApi: false,
-        attributes: [],
-      },
-      { dir: outputDirectory }
-    );
-
-    const generatedSchemaPath = path.join(
-      outputDirectory,
-      'src/api/testContentType',
-      'content-types/testContentType/schema.json'
-    );
-
-    expect((await stat(generatedSchemaPath)).isFile()).toBeTruthy();
-
-    const fileContent = await readFile(generatedSchemaPath, 'utf-8');
-
-    expect(fileContent).not.toBeNull();
-
-    const schema = JSON.parse(fileContent.toString());
-
-    expect(schema).toStrictEqual({
-      kind: 'singleType',
-      collectionName: 'test_content_types',
-      info: {
-        singularName: 'testContentType',
-        pluralName: 'testContentTypes',
-        displayName: 'testContentType',
-      },
-      options: {
-        draftAndPublish: false,
-        comment: '',
-      },
-      attributes: {},
-    });
-  });
-
-  test('it scaffolds a new API', async () => {
-    await strapiGenerators.generate(
-      'content-type',
-      {
-        displayName: 'testContentType',
-        singularName: 'testContentType',
-        pluralName: 'testContentTypes',
-        kind: 'singleType',
-        id: 'testContentType',
-        useDraftAndPublish: false,
-        destination: 'new',
-        bootstrapApi: true,
-        attributes: [],
-      },
-      { dir: outputDirectory }
-    );
-    const generatedApiPath = path.join(outputDirectory, 'src/api/testContentType');
-
-    expect((await stat(generatedApiPath)).isDirectory()).toBeTruthy();
-    expect(
-      (await stat(path.join(generatedApiPath, 'controllers/testContentType.js'))).isFile()
-    ).toBeTruthy();
-    expect(
-      (await stat(path.join(generatedApiPath, 'services/testContentType.js'))).isFile()
-    ).toBeTruthy();
-    expect(
-      (await stat(path.join(generatedApiPath, 'routes/testContentType.js'))).isFile()
-    ).toBeTruthy();
-
-    const controller = await readFile(
-      path.join(generatedApiPath, 'controllers/testContentType.js')
-    );
-    const router = await readFile(path.join(generatedApiPath, 'routes/testContentType.js'));
-    const service = await readFile(path.join(generatedApiPath, 'services/testContentType.js'));
-
-    expect(controller.toString()).toMatchInlineSnapshot(`
-      "'use strict';
-
-      /**
-       *  testContentType controller
-       */
-
-      const { createCoreController } = require('@strapi/strapi').factories;
-
-      module.exports = createCoreController('api::testContentType.testContentType');
-      "
-    `);
-    expect(router.toString()).toMatchInlineSnapshot(`
-      "'use strict';
-
-      /**
-       * testContentType router.
-       */
-
-      const { createCoreRouter } = require('@strapi/strapi').factories;
-
-      module.exports = createCoreRouter('api::testContentType.testContentType');
-      "
-    `);
-    expect(service.toString()).toMatchInlineSnapshot(`
-      "'use strict';
-
-      /**
-       * testContentType service.
-       */
-
-      const { createCoreService } = require('@strapi/strapi').factories;
-
-      module.exports = createCoreService('api::testContentType.testContentType');
-      "
-    `);
-  });
-
-  test('it generates the schema, then adds the attributes', async () => {
-    await strapiGenerators.generate(
-      'content-type',
-      {
-        displayName: 'testContentType',
-        singularName: 'testContentType',
-        pluralName: 'testContentTypes',
-        kind: 'singleType',
-        id: 'testContentType',
-        useDraftAndPublish: false,
-        destination: 'new',
-        bootstrapApi: false,
-        attributes: [
-          {
-            attributeName: 'name',
-            attributeType: 'string',
-          },
-          {
-            attributeName: 'email',
-            attributeType: 'string',
-          },
-        ],
-      },
-      { dir: outputDirectory }
-    );
-
-    const generatedSchemaPath = path.join(
-      outputDirectory,
-      'src/api/testContentType',
-      'content-types/testContentType/schema.json'
-    );
-
-    expect((await stat(generatedSchemaPath)).isFile()).toBeTruthy();
-
-    const fileContent = await readFile(generatedSchemaPath, 'utf-8');
-
-    expect(fileContent).not.toBeNull();
-
-    const schema = JSON.parse(fileContent.toString());
-
-    expect(schema.attributes).toStrictEqual({
-      email: { type: 'string' },
-      name: { type: 'string' },
-    });
-  });
-});

package/lib/plops/api.js

@@ -1,82 +0,0 @@
-'use strict';
-
-const { join } = require('path');
-const fs = require('fs-extra');
-const tsUtils = require('@strapi/typescript-utils');
-
-const validateInput = require('./utils/validate-input');
-
-module.exports = (plop) => {
-  // API generator
-  plop.setGenerator('api', {
-    description: 'Generate a basic API',
-    prompts: [
-      {
-        type: 'input',
-        name: 'id',
-        message: 'API name',
-        validate: (input) => validateInput(input),
-      },
-      {
-        type: 'confirm',
-        name: 'isPluginApi',
-        message: 'Is this API for a plugin?',
-      },
-      {
-        when: (answers) => answers.isPluginApi,
-        type: 'list',
-        name: 'plugin',
-        message: 'Plugin name',
-        async choices() {
-          const pluginsPath = join(plop.getDestBasePath(), 'plugins');
-          const exists = await fs.pathExists(pluginsPath);
-
-          if (!exists) {
-            throw Error('Couldn\'t find a "plugins" directory');
-          }
-
-          const pluginsDir = await fs.readdir(pluginsPath, { withFileTypes: true });
-          const pluginsDirContent = pluginsDir.filter((fd) => fd.isDirectory());
-
-          if (pluginsDirContent.length === 0) {
-            throw Error('The "plugins" directory is empty');
-          }
-
-          return pluginsDirContent;
-        },
-      },
-    ],
-    actions(answers) {
-      const filePath =
-        answers.isPluginApi && answers.plugin ? 'plugins/{{ plugin }}' : 'api/{{ id }}';
-      const currentDir = process.cwd();
-      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
-
-      const baseActions = [
-        {
-          type: 'add',
-          path: `${filePath}/controllers/{{ id }}.${language}`,
-          templateFile: `templates/${language}/controller.${language}.hbs`,
-        },
-        {
-          type: 'add',
-          path: `${filePath}/services/{{ id }}.${language}`,
-          templateFile: `templates/${language}/service.${language}.hbs`,
-        },
-      ];
-
-      if (answers.isPluginApi) {
-        return baseActions;
-      }
-
-      return [
-        {
-          type: 'add',
-          path: `${filePath}/routes/{{ id }}.${language}`,
-          templateFile: `templates/${language}/single-route.${language}.hbs`,
-        },
-        ...baseActions,
-      ];
-    },
-  });
-};

package/lib/plops/content-type.js

@@ -1,148 +0,0 @@
-'use strict';
-
-const { join } = require('path');
-const slugify = require('@sindresorhus/slugify');
-const fs = require('fs-extra');
-const { isKebabCase } = require('@strapi/utils');
-const tsUtils = require('@strapi/typescript-utils');
-
-const getDestinationPrompts = require('./prompts/get-destination-prompts');
-const getFilePath = require('./utils/get-file-path');
-const ctNamesPrompts = require('./prompts/ct-names-prompts');
-const kindPrompts = require('./prompts/kind-prompts');
-const draftAndPublishPrompts = require('./prompts/draft-and-publish-prompts');
-const getAttributesPrompts = require('./prompts/get-attributes-prompts');
-const bootstrapApiPrompts = require('./prompts/bootstrap-api-prompts');
-
-module.exports = (plop) => {
-  // Model generator
-  plop.setGenerator('content-type', {
-    description: 'Generate a content type for an API',
-    async prompts(inquirer) {
-      const config = await inquirer.prompt([
-        ...ctNamesPrompts,
-        ...kindPrompts,
-        ...draftAndPublishPrompts,
-      ]);
-      const attributes = await getAttributesPrompts(inquirer);
-
-      const api = await inquirer.prompt([
-        ...getDestinationPrompts('model', plop.getDestBasePath()),
-        {
-          when: (answers) => answers.destination === 'new',
-          type: 'input',
-          name: 'id',
-          default: config.singularName,
-          message: 'Name of the new API?',
-          async validate(input) {
-            if (!isKebabCase(input)) {
-              return 'Value must be in kebab-case';
-            }
-
-            const apiPath = join(plop.getDestBasePath(), 'api');
-            const exists = await fs.pathExists(apiPath);
-
-            if (!exists) {
-              return true;
-            }
-
-            const apiDir = await fs.readdir(apiPath, { withFileTypes: true });
-            const apiDirContent = apiDir.filter((fd) => fd.isDirectory());
-
-            if (apiDirContent.findIndex((api) => api.name === input) !== -1) {
-              throw new Error('This name is already taken.');
-            }
-
-            return true;
-          },
-        },
-        ...bootstrapApiPrompts,
-      ]);
-
-      return {
-        ...config,
-        ...api,
-        attributes,
-      };
-    },
-    actions(answers) {
-      const attributes = answers.attributes.reduce((object, answer) => {
-        const val = { type: answer.attributeType };
-
-        if (answer.attributeType === 'enumeration') {
-          val.enum = answer.enum.split(',').map((item) => item.trim());
-        }
-
-        if (answer.attributeType === 'media') {
-          val.allowedTypes = ['images', 'files', 'videos', 'audios'];
-          val.multiple = answer.multiple;
-        }
-
-        return Object.assign(object, { [answer.attributeName]: val }, {});
-      }, {});
-
-      const filePath = getFilePath(answers.destination);
-      const currentDir = process.cwd();
-      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
-
-      const baseActions = [
-        {
-          type: 'add',
-          path: `${filePath}/content-types/{{ singularName }}/schema.json`,
-          templateFile: `templates/${language}/content-type.schema.json.hbs`,
-          data: {
-            collectionName: slugify(answers.pluralName, { separator: '_' }),
-          },
-        },
-      ];
-
-      if (Object.entries(attributes).length > 0) {
-        baseActions.push({
-          type: 'modify',
-          path: `${filePath}/content-types/{{ singularName }}/schema.json`,
-          transform(template) {
-            const parsedTemplate = JSON.parse(template);
-            parsedTemplate.attributes = attributes;
-            return JSON.stringify(parsedTemplate, null, 2);
-          },
-        });
-      }
-
-      if (answers.bootstrapApi) {
-        const { singularName } = answers;
-
-        let uid;
-        if (answers.destination === 'new') {
-          uid = `api::${answers.id}.${singularName}`;
-        } else if (answers.api) {
-          uid = `api::${answers.api}.${singularName}`;
-        } else if (answers.plugin) {
-          uid = `plugin::${answers.plugin}.${singularName}`;
-        }
-
-        baseActions.push(
-          {
-            type: 'add',
-            path: `${filePath}/controllers/{{ singularName }}.${language}`,
-            templateFile: `templates/${language}/core-controller.${language}.hbs`,
-            data: { uid },
-          },
-          {
-            type: 'add',
-            path: `${filePath}/services/{{ singularName }}.${language}`,
-            templateFile: `templates/${language}/core-service.${language}.hbs`,
-            data: { uid },
-          },
-          {
-            type: 'add',
-            path: `${filePath}/routes/{{ singularName }}.${language}`,
-            templateFile: `templates/${language}/core-router.${language}.hbs`,
-            data: { uid },
-          }
-        );
-      }
-
-      return baseActions;
-    },
-  });
-};

package/lib/plops/controller.js

@@ -1,36 +0,0 @@
-'use strict';
-
-const tsUtils = require('@strapi/typescript-utils');
-
-const getDestinationPrompts = require('./prompts/get-destination-prompts');
-const getFilePath = require('./utils/get-file-path');
-const validateInput = require('./utils/validate-input');
-
-module.exports = (plop) => {
-  // Controller generator
-  plop.setGenerator('controller', {
-    description: 'Generate a controller for an API',
-    prompts: [
-      {
-        type: 'input',
-        name: 'id',
-        message: 'Controller name',
-        validate: (input) => validateInput(input),
-      },
-      ...getDestinationPrompts('controller', plop.getDestBasePath()),
-    ],
-    actions(answers) {
-      const filePath = getFilePath(answers.destination);
-      const currentDir = process.cwd();
-      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
-
-      return [
-        {
-          type: 'add',
-          path: `${filePath}/controllers/{{ id }}.${language}`,
-          templateFile: `templates/${language}/controller.${language}.hbs`,
-        },
-      ];
-    },
-  });
-};

package/lib/plops/middleware.js

@@ -1,36 +0,0 @@
-'use strict';
-
-const tsUtils = require('@strapi/typescript-utils');
-
-const getDestinationPrompts = require('./prompts/get-destination-prompts');
-const validateInput = require('./utils/validate-input');
-const getFilePath = require('./utils/get-file-path');
-
-module.exports = (plop) => {
-  // middleware generator
-  plop.setGenerator('middleware', {
-    description: 'Generate a middleware for an API',
-    prompts: [
-      {
-        type: 'input',
-        name: 'name',
-        message: 'Middleware name',
-        validate: (input) => validateInput(input),
-      },
-      ...getDestinationPrompts('middleware', plop.getDestBasePath(), { rootFolder: true }),
-    ],
-    actions(answers) {
-      const filePath = getFilePath(answers.destination);
-      const currentDir = process.cwd();
-      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
-
-      return [
-        {
-          type: 'add',
-          path: `${filePath}/middlewares/{{ name }}.${language}`,
-          templateFile: `templates/${language}/middleware.${language}.hbs`,
-        },
-      ];
-    },
-  });
-};

package/lib/plops/migration.js

@@ -1,33 +0,0 @@
-'use strict';
-
-const tsUtils = require('@strapi/typescript-utils');
-const validateFileNameInput = require('./utils/validate-file-name-input');
-const getFormattedDate = require('./utils/get-formatted-date');
-
-module.exports = (plop) => {
-  // Migration generator
-  plop.setGenerator('migration', {
-    description: 'Generate a migration',
-    prompts: [
-      {
-        type: 'input',
-        name: 'name',
-        message: 'Migration name',
-        validate: (input) => validateFileNameInput(input),
-      },
-    ],
-    actions() {
-      const currentDir = process.cwd();
-      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
-      const timestamp = getFormattedDate();
-
-      return [
-        {
-          type: 'add',
-          path: `${currentDir}/database/migrations/${timestamp}.{{ name }}.${language}`,
-          templateFile: `templates/${language}/migration.${language}.hbs`,
-        },
-      ];
-    },
-  });
-};