@oak-digital/types-4-strapi-2 0.3.0 → 0.3.2

package/README.md

@@ -5,6 +5,10 @@ This can be useful if you have a frontend written with TypeScript to make sure y
 
 types-4-strapi-2 is a rewrite of [francescolorenzetti/types-4-strapi](https://github.com/francescolorenzetti/types-4-strapi) written in TypeScript, with the goal of being much easier to extend and maintain.
 
+## Requirements
+
+* Node `>=v16`
+
 ## Getting started
 
 Install the script for your project:
@@ -57,11 +61,54 @@ This can be done with the `--out` flag like in the following example.
 |-----------------------------|--------------------------------------------------------------------------------------|-------------|
 | -i, --in <dir>              | The src directory for strapi                                                         | `./src`     |
 | -o, --out <dir>             | The output directory to output the types to                                          | `./types`   |
-| -prefix                     | A prefix for all generated interfaces                                                | `I`         |
+| --prefix <prefix>           | A prefix for all generated interfaces                                                | `I`         |
 | --component-prefix <prefix> | A prefix for components                                                              | none        |
 | -D, --delete-old            | CAUTION: This option is equivalent to running `rm -rf` on the output directory first | `false`     |
 | --prettier <file>           | The prettier config file to use for formatting TypeScript interfaces                 | none        |
 
+## Tips and tricks
+
+### Generate interfaces as soon as you create/modify/delete new components or content types
+
+You can make an extension for your strapi project to generate the new typescript interfaces as soon as they are created with strapi.
+If you followed the step of adding a script to your `package.json`, you can easily make an extension that just calls `npm run types`.
+An example of how this can be done is shown in the following snippet.
+
+```typescript
+// src/extensions/content-type-builder/strapi-server.ts
+import { exec } from "child_process";
+
+export default (plugin: any) => {
+  const componentRunAfter = [
+    "createComponent",
+    "deleteComponent",
+    "updateComponent",
+  ];
+  const contentTypesRunAfter = [
+    "createContentType",
+    "updateContentType",
+    "deleteContentType",
+  ];
+  componentRunAfter.forEach((name) => {
+    const oldFunc = plugin.controllers.components[name];
+    plugin.controllers.components[name] = async (ctx: any) => {
+      await oldFunc(ctx);
+      exec("npm run types");
+      return ctx
+    }
+  })
+  contentTypesRunAfter.forEach((name) => {
+    const oldFunc = plugin.controllers['content-types'][name];
+    plugin.controllers["content-types"][name] = async (ctx: any) => {
+      await oldFunc(ctx);
+      exec("npm run types");
+      return ctx
+    }
+  })
+  return plugin;
+}
+```
+
 ## Building
 
 To build this project, use the following command

package/lib/interface/Attributes.js

@@ -61,6 +61,8 @@ var Attributes = /** @class */ (function () {
         var _this = this;
         var _a, _b, _c, _d;
         var optionalString = this.isAttributeOptional(attr) ? '?' : '';
+        var orNull = ' | null';
+        var requiredString = attr.required !== true ? orNull : '';
         var str = "    ".concat(attrName).concat(optionalString, ": ");
         var isArray = false;
         switch (attr.type) {
@@ -76,7 +78,7 @@ var Attributes = /** @class */ (function () {
                 var apiName = attr.target;
                 // console.log(this.RelationNames, apiName)
                 var dependencyName = (_c = (_b = this.RelationNames[apiName]) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : 'any';
-                var relationMultipleString = attr.relation.endsWith('ToMany') ? '[]' : ' | null';
+                var relationMultipleString = attr.relation.endsWith('ToMany') ? '[]' : orNull;
                 str += "{ data: ".concat(dependencyName).concat(relationMultipleString, "; }");
                 break;
             case 'component':
@@ -87,8 +89,7 @@ var Attributes = /** @class */ (function () {
                 str += dependencyComponentName;
                 break;
             case 'media':
-                var mediaOptional = attr.required !== true ? ' | null' : '';
-                var mediaMultipleString = attr.multiple ? '[]' : mediaOptional;
+                var mediaMultipleString = attr.multiple ? '[]' : requiredString;
                 str += "{ data: ".concat(this.RelationNames['builtins::Media'].name).concat(mediaMultipleString, "; }");
                 break;
             case 'password':
@@ -115,20 +116,24 @@ var Attributes = /** @class */ (function () {
             case 'email':
             case 'uid':
                 str += 'string';
+                str += requiredString;
                 break;
             case 'integer':
             case 'biginteger':
             case 'decimal':
             case 'float':
                 str += 'number';
+                str += requiredString;
                 break;
             case 'date':
             case 'datetime':
             case 'time':
                 str += 'Date';
+                str += requiredString;
                 break;
             case 'boolean':
                 str += attr.type;
+                str += requiredString;
                 break;
             case 'json':
             default:

package/lib/interface/Interface.js

@@ -10,7 +10,7 @@ var Attributes_1 = __importDefault(require("./Attributes"));
 var change_case_1 = require("change-case");
 var Interface = /** @class */ (function () {
     function Interface(baseName, attributes, relativeDirectoryPath, fileCaseType, prefix) {
-        if (fileCaseType === void 0) { fileCaseType = "pascal"; }
+        if (fileCaseType === void 0) { fileCaseType = 'pascal'; }
         if (prefix === void 0) { prefix = ''; }
         this.Relations = []; // Components and relations
         this.RelationNames = {};

package/lib/interface/builtinInterfaces.js

@@ -7,7 +7,7 @@ exports.createMediaFormatInterface = exports.createMediaInterface = void 0;
 var BuiltinComponentInterface_1 = __importDefault(require("./BuiltinComponentInterface"));
 var BuiltinInterface_1 = __importDefault(require("./BuiltinInterface"));
 function createMediaInterface(directory, caseTypeName, prefix) {
-    var stringFields = [
+    var stringRequiredFields = [
         'name',
         'alternativeText',
         'caption',
@@ -15,14 +15,13 @@ function createMediaInterface(directory, caseTypeName, prefix) {
         'ext',
         'mime',
         'url',
-        'previewUrl',
         'provider',
     ];
-    var numberFields = [
-        'width',
-        'height',
-        'size',
+    var stringFields = [
+        'previewUrl',
+        'provider_metadata',
     ];
+    var numberFields = ['width', 'height', 'size'];
     var mediaFormat = {
         type: 'component',
         repeatable: false,
@@ -41,11 +40,14 @@ function createMediaInterface(directory, caseTypeName, prefix) {
             },
         },
     };
+    stringRequiredFields.forEach(function (s) {
+        mediaAttrs[s] = { type: 'string', required: true };
+    });
     stringFields.forEach(function (s) {
         mediaAttrs[s] = { type: 'string' };
     });
     numberFields.forEach(function (s) {
-        mediaAttrs[s] = { type: 'integer' };
+        mediaAttrs[s] = { type: 'integer', required: true };
     });
     // const dataAttrs = {
     //     data: {
@@ -58,19 +60,8 @@ function createMediaInterface(directory, caseTypeName, prefix) {
 }
 exports.createMediaInterface = createMediaInterface;
 function createMediaFormatInterface(directory, caseTypeName, prefix) {
-    var stringFields = [
-        'name',
-        'hash',
-        'ext',
-        'mime',
-        'path',
-        'url',
-    ];
-    var numberFields = [
-        'width',
-        'height',
-        'size',
-    ];
+    var stringFields = ['name', 'hash', 'ext', 'mime', 'path', 'url'];
+    var numberFields = ['width', 'height', 'size'];
     var mediaAttrs = {};
     stringFields.forEach(function (s) {
         mediaAttrs[s] = { type: 'string' };

package/lib/interface/schemaReader.js

@@ -37,6 +37,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getApiSchemas = exports.getComponentSchemas = exports.getComponentCategoryFolders = exports.getApiFolders = exports.readSchema = void 0;
+var node_fs_1 = require("node:fs");
 var promises_1 = require("node:fs/promises");
 var posix_1 = require("node:path/posix");
 var utils_1 = require("../utils");
@@ -83,6 +84,10 @@ function getComponentCategoryFolders(strapiSrcRoot) {
             switch (_a.label) {
                 case 0:
                     path = (0, posix_1.join)(strapiSrcRoot, 'components');
+                    // If there exists no components, just fallback to an empty array.
+                    if (!(0, node_fs_1.existsSync)(path)) {
+                        return [2 /*return*/, []];
+                    }
                     return [4 /*yield*/, (0, utils_1.readDirFiltered)(path)];
                 case 1:
                     folders = _a.sent();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oak-digital/types-4-strapi-2",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Typescript interface generator for Strapi 4 models",
   "bin": {
     "t4s": "./bin/index.js"