@akemona-org/strapi-generate-api 3.7.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015-present Strapi Solutions SAS
+
+Portions of the Strapi software are licensed as follows:
+
+* All software that resides under an "ee/" directory (the “EE Software”), if that directory exists, is licensed under the license defined in "ee/LICENSE".
+
+* All software outside of the above-mentioned directories or restrictions above is available under the "MIT Expat" license as set forth below.
+
+MIT Expat License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# strapi-generate-api
+
+[![npm version](https://img.shields.io/npm/v/strapi-generate-api.svg)](https://www.npmjs.org/package/strapi-generate-api)
+[![npm downloads](https://img.shields.io/npm/dm/strapi-generate-api.svg)](https://www.npmjs.org/package/strapi-generate-api)
+[![npm dependencies](https://david-dm.org/strapi/strapi-generate-api.svg)](https://david-dm.org/strapi/strapi-generate-api)
+[![Build status](https://travis-ci.org/strapi/strapi-generate-api.svg?branch=master)](https://travis-ci.org/strapi/strapi-generate-api)
+[![Slack status](https://slack.strapi.io/badge.svg)](https://slack.strapi.io)
+
+This Strapi generator contains all the default files for a new API.
+
+This generator can be called with:
+
+```bash
+$ strapi generate:api apiName
+```
+
+## Resources
+
+- [License](LICENSE)
+
+## Links
+
+- [Strapi website](https://strapi.akemona.com/)
+- [Strapi community on Slack](https://slack.strapi.io)
+- [Strapi news on Twitter](https://twitter.com/strapijs)

package/json/routes.json.js

@@ -0,0 +1,116 @@
+'use strict';
+
+/**
+ * Module dependencies
+ */
+
+// Node.js core.
+const fs = require('fs');
+
+// Public node modules.
+const _ = require('lodash');
+
+function generateSingleTypeRoutes({ route, name }) {
+  return [
+    {
+      method: 'GET',
+      path: '/' + route,
+      handler: name + '.find',
+      config: {
+        policies: [],
+      },
+    },
+    {
+      method: 'PUT',
+      path: '/' + route,
+      handler: name + '.update',
+      config: {
+        policies: [],
+      },
+    },
+    {
+      method: 'DELETE',
+      path: '/' + route,
+      handler: name + '.delete',
+      config: {
+        policies: [],
+      },
+    },
+  ];
+}
+
+function generateCollectionTypeRoutes({ route, name }) {
+  return [
+    {
+      method: 'GET',
+      path: '/' + route,
+      handler: name + '.find',
+      config: {
+        policies: [],
+      },
+    },
+    {
+      method: 'GET',
+      path: '/' + route + '/count',
+      handler: name + '.count',
+      config: {
+        policies: [],
+      },
+    },
+    {
+      method: 'GET',
+      path: '/' + route + '/:id',
+      handler: name + '.findOne',
+      config: {
+        policies: [],
+      },
+    },
+    {
+      method: 'POST',
+      path: '/' + route,
+      handler: name + '.create',
+      config: {
+        policies: [],
+      },
+    },
+    {
+      method: 'PUT',
+      path: '/' + route + '/:id',
+      handler: name + '.update',
+      config: {
+        policies: [],
+      },
+    },
+    {
+      method: 'DELETE',
+      path: '/' + route + '/:id',
+      handler: name + '.delete',
+      config: {
+        policies: [],
+      },
+    },
+  ];
+}
+
+/**
+ * Expose main routes of the generated API
+ */
+
+module.exports = scope => {
+  let routes = [];
+  if (!scope.args.plugin) {
+    routes =
+      scope.contentTypeKind === 'singleType'
+        ? generateSingleTypeRoutes({ route: scope.route, name: scope.name })
+        : generateCollectionTypeRoutes({ route: scope.route, name: scope.name });
+  }
+
+  // if routes.json already exists, then merge
+  if (fs.existsSync(scope.rootPath)) {
+    let current = require(scope.rootPath);
+    fs.unlinkSync(scope.rootPath);
+    routes = _.concat(routes, _.differenceWith(current.routes, routes, _.isEqual));
+  }
+
+  return { routes };
+};

package/lib/before.js

@@ -0,0 +1,144 @@
+'use strict';
+
+/**
+ * Module dependencies
+ */
+
+// Public node modules.
+const _ = require('lodash');
+const pluralize = require('pluralize');
+const { nameToSlug } = require('@akemona-org/strapi-utils');
+
+/**
+ * This `before` function is run before generating targets.
+ * Validate, configure defaults, get extra dependencies, etc.
+ *
+ * @param {Object} scope
+ * @param {Function} cb
+ */
+
+module.exports = (scope, cb) => {
+  if (!scope.rootPath || !scope.id) {
+    return cb.invalid('Usage: `$ strapi generate:api apiName`');
+  }
+
+  // Format `id`.
+  const name = scope.name || nameToSlug(scope.id);
+
+  scope.contentTypeKind = scope.args.kind || 'collectionType';
+
+  // `scope.args` are the raw command line arguments.
+  _.defaults(scope, {
+    name,
+    route:
+      scope.contentTypeKind === 'singleType'
+        ? _.kebabCase(scope.id)
+        : _.kebabCase(pluralize(scope.id)),
+  });
+
+  let filePath;
+  if (scope.args.api) {
+    filePath = `./api/${scope.args.api}`;
+  } else if (scope.args.plugin) {
+    filePath = `./plugins/${scope.args.plugin}`;
+  } else if (scope.args.extend) {
+    filePath = `./extensions/${scope.args.extend}`;
+  } else {
+    filePath = `./api/${name}`;
+  }
+
+  // Take another pass to take advantage of the defaults absorbed in previous passes.
+  _.defaults(scope, {
+    filename: `${name}.js`,
+    filenameSettings: `${name}.settings.json`,
+    filePath,
+  });
+
+  // Validate optional attribute arguments.
+  const invalidAttributes = [];
+
+  if (_.isPlainObject(scope.args.attributes)) {
+    scope.attributes = scope.args.attributes;
+  } else {
+    // Map attributes and split them for CLI.
+    scope.attributes = scope.args.attributes.map((attribute) => {
+      if (_.isString(attribute)) {
+        const parts = attribute.split(':');
+
+        parts[1] = parts[1] || 'string';
+
+        // Handle invalid attributes.
+        if (!parts[1] || !parts[0]) {
+          invalidAttributes.push('Error: Invalid attribute notation `' + attribute + '`.');
+          return;
+        }
+
+        return {
+          name: _.trim(_.deburr(parts[0].toLowerCase())),
+          params: {
+            type: _.trim(_.deburr(parts[1].toLowerCase())),
+          },
+        };
+      } else {
+        return _.has(attribute, 'params.type') ? attribute : undefined;
+      }
+    });
+
+    scope.attributes = _.compact(scope.attributes);
+
+    // Handle invalid action arguments.
+    // Send back invalidActions.
+    if (invalidAttributes.length) {
+      return cb.invalid(invalidAttributes);
+    }
+
+    // Make sure there aren't duplicates.
+    if (
+      _(scope.attributes.map((attribute) => attribute.name))
+        .uniq()
+        .valueOf().length !== scope.attributes.length
+    ) {
+      return cb.invalid('Duplicate attributes not allowed!');
+    }
+
+    // Render some stringified code from the action template
+    // and make it available in our scope for use later on.
+    scope.attributes = scope.attributes.reduce((acc, attribute) => {
+      acc[attribute.name] = attribute.params;
+      return acc;
+    }, {});
+  }
+  // Set collectionName
+  scope.collectionName = _.has(scope.args, 'collectionName')
+    ? scope.args.collectionName
+    : _.snakeCase(pluralize(name));
+
+  // Set description
+  scope.description = _.has(scope.args, 'description') ? scope.args.description : '';
+
+  // Set connection
+  scope.connection = _.get(scope.args, 'connection', undefined);
+
+  scope.schema = JSON.stringify(
+    {
+      connection: scope.connection,
+      collectionName: scope.collectionName,
+      info: {
+        name: scope.args.displayName || scope.id,
+        description: scope.description,
+      },
+      options: {
+        draftAndPublish: scope.args.draftAndPublish === 'true',
+        increments: true,
+        timestamps: true,
+        comment: '',
+      },
+      attributes: scope.attributes,
+    },
+    null,
+    2
+  );
+
+  // Trigger callback with no error to proceed.
+  return cb.success();
+};

package/lib/index.js

@@ -0,0 +1,48 @@
+'use strict';
+
+/**
+ * Module dependencies
+ */
+
+// Node.js core.
+const path = require('path');
+
+// Local dependencies.
+const routesJSON = require('../json/routes.json.js');
+
+/**
+ * Generate a core API
+ */
+
+module.exports = {
+  templatesDirectory: path.resolve(__dirname, '..', 'templates'),
+  before: require('./before'),
+  targets: {
+    // Use the default `controller` file as a template for
+    // every generated controller.
+    ':filePath/controllers/:filename': {
+      template: 'controller.template',
+    },
+
+    // every generated controller.
+    ':filePath/services/:filename': {
+      template: 'service.template',
+    },
+
+    // Copy an empty JavaScript model where every functions will be.
+    ':filePath/models/:filename': {
+      template: 'model.template',
+    },
+
+    // Copy the generated JSON model for the connection,
+    // schema and attributes.
+    ':filePath/models/:filenameSettings': {
+      template: 'model.settings.template',
+    },
+
+    // Generate routes.
+    ':filePath/config/routes.json': {
+      jsonfile: routesJSON,
+    },
+  },
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@akemona-org/strapi-generate-api",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "3.7.0",
+  "description": "Generate an API for a Strapi application.",
+  "homepage": "https://strapi.akemona.com",
+  "keywords": [
+    "generate",
+    "generator",
+    "strapi"
+  ],
+  "main": "./lib/index.js",
+  "directories": {
+    "lib": "./lib"
+  },
+  "dependencies": {
+    "@akemona-org/strapi-utils": "3.7.0",
+    "lodash": "4.17.21",
+    "pluralize": "^8.0.0"
+  },
+  "scripts": {
+    "test": "echo \"no tests yet\""
+  },
+  "author": {
+    "email": "strapi@akemona.com",
+    "name": "Akemona team",
+    "url": "https://strapi.akemona.com"
+  },
+  "maintainers": [
+    {
+      "name": "Akemona team",
+      "email": "strapi@akemona.com",
+      "url": "https://strapi.akemona.com"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/akemona/strapi.git"
+  },
+  "bugs": {
+    "url": "https://github.com/akemona/strapi/issues"
+  },
+  "engines": {
+    "node": ">=10.16.0 <=14.x.x",
+    "npm": ">=6.0.0"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "gitHead": "129a8d6191b55810fd66448dcc47fee829df986c"
+}

package/templates/controller.template

@@ -0,0 +1,8 @@
+'use strict';
+
+/**
+ * Read the documentation (https://strapi.akemona.com/documentation/developer-docs/latest/development/backend-customization.html#core-controllers)
+ * to customize this controller
+ */
+
+module.exports = {};

package/templates/model.settings.template

@@ -0,0 +1 @@
+<%= schema %>

package/templates/model.template

@@ -0,0 +1,8 @@
+'use strict';
+
+/**
+ * Read the documentation (https://strapi.akemona.com/documentation/developer-docs/latest/development/backend-customization.html#lifecycle-hooks)
+ * to customize this model
+ */
+
+module.exports = {};

package/templates/service.template

@@ -0,0 +1,8 @@
+'use strict';
+
+/**
+ * Read the documentation (https://strapi.akemona.com/documentation/developer-docs/latest/development/backend-customization.html#core-services)
+ * to customize this service
+ */
+
+module.exports = {};