@oak-digital/types-4-strapi-2 0.1.2 → 0.2.2

package/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true

package/.eslintrc.json

@@ -0,0 +1,52 @@
+{
+    "env": {
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides": [
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "off",
+        "no-case-declarations": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "default-case-last": ["error"],
+        "eqeqeq": ["error", "always"],
+        "no-lonely-if": ["error"],
+        "no-magic-numbers": ["warn", {
+            "ignoreArrayIndexes": true,
+            "ignore": [-1, 0, 1]
+        }],
+        "no-return-assign": ["error", "always"],
+        "no-return-await": ["error"],
+        "no-var": ["error"],
+        "no-cond-assign": ["error", "always"],
+        "indent": [
+            "error",
+            4
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "always"
+        ]
+    }
+}

package/.prettierrc.json

@@ -0,0 +1,7 @@
+{
+    "parser": "typescript",
+    "semi": true,
+    "singleQuote": true,
+    "bracketSameLine": false,
+    "trailingComma": "es5"
+}

package/README.md

@@ -0,0 +1,67 @@
+# types-4-strapi-2
+
+types-4-strapi-2 is a typescript program that will generate typescript types for your strapi projects.
+This can be useful if you have a frontend written with typescript to make sure you are using the correct types and can help report errors at compile time.
+
+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.
+
+## Getting started
+
+Install the script for your project:
+
+```bash
+npm install --save-dev @oak-digital/types-4-strapi-2
+```
+
+Then set up a script in your `package.json`
+
+```jsonc
+// package.json
+{
+    "scripts": {
+        "types": "t4s"
+    }
+}
+```
+
+In some cases it is desirable to change the output directory which is `./types` by default.
+This can be done with the `--out` flag like in the following example.
+
+```jsonc
+// package.json
+{
+    "scripts": {
+        "types": "t4s --out ../frontend/src/lib/types"
+    }
+}
+```
+
+## Features
+
+* Generate typescript interfaces for all your api content-types and components
+* Generate typescript interfaces for builtin types such as `Media` and `MediaFormat`
+* Select input and output directory
+* Prettier formatting and ability to use your own `.prettierrc`.
+
+### Planned features
+
+* Support if you are using other plugins, such as `url-alias`, which should add extra fields for some interfaces.
+
+## Help
+
+use `t4s --help` to display which options are available for you
+
+## Building
+
+To build this project, use the following command
+
+```bash
+npm run build
+```
+
+## Publihsing
+
+```bash
+npm run build
+npm publish
+```

package/lib/.prettierrc.json

@@ -0,0 +1,7 @@
+{
+    "parser": "typescript",
+    "semi": true,
+    "singleQuote": true,
+    "bracketSameLine": false,
+    "trailingComma": "es5"
+}

package/lib/index.js

@@ -6,14 +6,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var commander_1 = require("commander");
 var InterfaceManager_1 = __importDefault(require("./interface/InterfaceManager"));
 commander_1.program
-    .name("t4s");
+    .name('t4s');
 commander_1.program
     .option('-i, --in <dir>', 'The src directory for strapi', './src')
-    .option('-o, --out <dir>', 'The output directory to output the types to', './types');
+    .option('-o, --out <dir>', 'The output directory to output the types to', './types')
+    .option('--component-prefix <prefix>', 'A prefix for components', '')
+    .option('--prettier <file>', 'The prettier config file to use for formatting typescript interfaces');
 commander_1.program.parse();
 var options = commander_1.program.opts();
-var input = options.in, out = options.out;
-var manager = new InterfaceManager_1.default(out, input);
+var input = options.in, out = options.out, componentPrefix = options.componentPrefix, prettierFile = options.prettier;
+var manager = new InterfaceManager_1.default(out, input, {
+    componentPrefix: componentPrefix,
+    prettierFile: prettierFile,
+});
 manager.run().catch(function (err) {
     console.error(err);
 });

package/lib/interface/Attributes.d.ts

@@ -1,10 +1,10 @@
-import Interface from "./Interface";
+import { RelationNames } from "./Interface";
 export default class Attributes {
     Attrs: Record<string, Record<string, any>>;
     private RelationNames;
-    constructor(attr: Record<string, Record<string, any>>, relationNames: Record<string, [string, Interface]>);
+    constructor(attr: Record<string, Record<string, any>>, relationNames: RelationNames);
     isAttributeOptional(attr: any): boolean;
-    getDependencies(strapiName: string): any[];
+    getDependencies(): any[];
     attributeToString(attrName: string, attr: any): string;
     toFieldsString(): string;
     toString(): string;

package/lib/interface/Attributes.js

@@ -9,6 +9,8 @@ var Attributes = /** @class */ (function () {
     Attributes.prototype.isAttributeOptional = function (attr) {
         // If it is a component / relation / dynamiczone it is always optional due to population
         switch (attr.type) {
+            case "nested":
+                return attr.nullable === true;
             case "component":
             case "dynamiczone":
             case "relation":
@@ -18,17 +20,24 @@ var Attributes = /** @class */ (function () {
         }
         return false;
     };
-    Attributes.prototype.getDependencies = function (strapiName) {
+    Attributes.prototype.getDependencies = function () {
         var dependencies = [];
         for (var attrName in this.Attrs) {
             var attr = this.Attrs[attrName];
-            var dependencyName = void 0;
+            var dependencyNames = [];
             switch (attr.type) {
+                case "nested":
+                    var attrs = new Attributes(attr.fields, this.RelationNames);
+                    dependencyNames.push.apply(dependencyNames, attrs.getDependencies());
+                    break;
                 case "relation":
-                    dependencyName = attr.target;
+                    dependencyNames.push(attr.target);
                     break;
                 case "component":
-                    dependencyName = attr.component;
+                    dependencyNames.push(attr.component);
+                    break;
+                case "media":
+                    dependencyNames.push("builtins::Media");
                     break;
                 default:
                     continue;
@@ -37,30 +46,46 @@ var Attributes = /** @class */ (function () {
             // if (dependencyName === strapiName) {
             //     continue;
             // }
-            dependencies.push(dependencyName);
+            dependencyNames.forEach(function (dependencyName) {
+                if (!dependencies.includes(dependencyName)) {
+                    dependencies.push(dependencyName);
+                }
+            });
         }
         return dependencies;
     };
     Attributes.prototype.attributeToString = function (attrName, attr) {
-        var _a;
+        var _a, _b;
         var optionalString = this.isAttributeOptional(attr) ? '?' : '';
         var str = "    ".concat(attrName).concat(optionalString, ": ");
         var isArray = false;
         switch (attr.type) {
+            // types-4-strapi-2 specific, used for builtin types
+            case "nested":
+                // Be careful with recursion
+                // console.log(attr);
+                var newAttrs = new Attributes(attr.fields, this.RelationNames);
+                str += newAttrs.toString();
+                break;
             case "relation":
                 var apiName = attr.target;
-                // console.log(attrName)
                 // console.log(this.RelationNames, apiName)
-                var dependencyName = this.RelationNames[apiName][0];
+                var dependencyName = this.RelationNames[apiName].name;
                 isArray = attr.relation.endsWith("ToMany");
                 str += dependencyName;
                 break;
             case "component":
                 var componentName = attr.component;
-                var dependencyComponentName = this.RelationNames[componentName][0];
+                var relationNameObj = this.RelationNames[componentName];
+                var dependencyComponentName = relationNameObj.name;
                 isArray = (_a = attr.repeatable) !== null && _a !== void 0 ? _a : false;
                 str += dependencyComponentName;
                 break;
+            case "media":
+                var mediaOptional = attr.required !== true ? "?" : "";
+                str += "{ data".concat(mediaOptional, ": ").concat(this.RelationNames["builtins::Media"].name, "; }");
+                isArray = (_b = attr.multiple) !== null && _b !== void 0 ? _b : false;
+                break;
             case "password":
                 return null;
             case "enumeration":

package/lib/interface/BuiltinComponentInterface.d.ts

@@ -0,0 +1,5 @@
+import ComponentInterface from "./ComponentInterface";
+export default class BuiltinComponentInterface extends ComponentInterface {
+    constructor(baseName: string, attributes: any, relativeDirectoryPath: string, prefix?: string);
+    updateStrapiName(): void;
+}

package/lib/interface/BuiltinComponentInterface.js

@@ -0,0 +1,36 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var ComponentInterface_1 = __importDefault(require("./ComponentInterface"));
+var BuiltinComponentInterface = /** @class */ (function (_super) {
+    __extends(BuiltinComponentInterface, _super);
+    function BuiltinComponentInterface(baseName, attributes, relativeDirectoryPath, prefix) {
+        if (prefix === void 0) { prefix = ""; }
+        return _super.call(this, baseName, attributes, relativeDirectoryPath, "builtins", prefix, {
+            hasId: false,
+            hasComponent: false,
+        }) || this;
+    }
+    BuiltinComponentInterface.prototype.updateStrapiName = function () {
+        this.StrapiName = "builtins::".concat(this.BaseName);
+    };
+    return BuiltinComponentInterface;
+}(ComponentInterface_1.default));
+exports.default = BuiltinComponentInterface;

package/lib/interface/BuiltinInterface.d.ts

@@ -0,0 +1,5 @@
+import Interface from "./Interface";
+export default class BuiltinInterface extends Interface {
+    constructor(baseName: string, attributes: any, relativeDirectoryPath: string, prefix?: string);
+    updateStrapiName(): void;
+}

package/lib/interface/BuiltinInterface.js

@@ -0,0 +1,33 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Interface_1 = __importDefault(require("./Interface"));
+var BuiltinInterface = /** @class */ (function (_super) {
+    __extends(BuiltinInterface, _super);
+    function BuiltinInterface(baseName, attributes, relativeDirectoryPath, prefix) {
+        if (prefix === void 0) { prefix = ""; }
+        return _super.call(this, baseName, attributes, relativeDirectoryPath, prefix) || this;
+    }
+    BuiltinInterface.prototype.updateStrapiName = function () {
+        this.StrapiName = "builtins::".concat(this.BaseName);
+    };
+    return BuiltinInterface;
+}(Interface_1.default));
+exports.default = BuiltinInterface;

package/lib/interface/ComponentInterface.d.ts

@@ -1,7 +1,8 @@
 import Interface from "./Interface";
 export default class ComponentInterface extends Interface {
     protected Category: string;
-    constructor(baseName: string, attributes: any, relativeDirectoryPath: string, category: string, prefix?: string);
+    protected Options: Record<string, any>;
+    constructor(baseName: string, attributes: any, relativeDirectoryPath: string, category: string, prefix?: string, options?: Record<string, any>);
     updateStrapiName(): void;
     getInterfaceFieldsString(): string;
 }

package/lib/interface/ComponentInterface.js

@@ -21,15 +21,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var Interface_1 = __importDefault(require("./Interface"));
 var ComponentInterface = /** @class */ (function (_super) {
     __extends(ComponentInterface, _super);
-    function ComponentInterface(baseName, attributes, relativeDirectoryPath, category, prefix) {
+    function ComponentInterface(baseName, attributes, relativeDirectoryPath, category, prefix, options) {
         if (prefix === void 0) { prefix = ""; }
+        if (options === void 0) { options = {}; }
         var _this = _super.call(this, baseName, attributes, relativeDirectoryPath, prefix) || this;
+        _this.Options = {
+            hasId: true,
+            hasComponent: true,
+        };
         _this.Category = category;
         // this.Attributes.id = {
         //     type: "number", // Components have a id field with a number
         //     required: true,
         // };
         _this.updateStrapiName();
+        Object.assign(_this.Options, options);
         return _this;
     }
     ComponentInterface.prototype.updateStrapiName = function () {
@@ -38,8 +44,13 @@ var ComponentInterface = /** @class */ (function (_super) {
     ComponentInterface.prototype.getInterfaceFieldsString = function () {
         var attrs = this.getAttributes();
         var str = '';
-        str += "  id: number;\n";
-        str += "  __component: \"".concat(this.getStrapiName(), "\";\n");
+        var _a = this.Options, hasId = _a.hasId, hasComponent = _a.hasComponent;
+        if (hasId) {
+            str += "  id: number;\n";
+        }
+        if (hasComponent) {
+            str += "  __component: \"".concat(this.getStrapiName(), "\";\n");
+        }
         return str + attrs.toFieldsString();
     };
     return ComponentInterface;

package/lib/interface/Interface.d.ts

@@ -1,4 +1,8 @@
 import Attributes from "./Attributes";
+export declare type RelationNames = Record<string, {
+    name: string;
+    inter: Interface;
+}>;
 export default class Interface {
     protected BaseName: string;
     private Relations;

package/lib/interface/Interface.js

@@ -30,7 +30,7 @@ var Interface = /** @class */ (function () {
     };
     Interface.prototype.getDependencies = function () {
         var attrs = new Attributes_1.default(this.Attributes, this.RelationNames);
-        return attrs.getDependencies(this.getStrapiName());
+        return attrs.getDependencies();
     };
     Interface.prototype.getFullInterfaceName = function () {
         var pascalName = (0, utils_1.pascalCase)(this.BaseName);
@@ -66,7 +66,7 @@ var Interface = /** @class */ (function () {
                     _this.RelationNamesCounter[name] = 0;
                 }
             }
-            _this.RelationNames[inter.getStrapiName()] = [name, inter];
+            _this.RelationNames[inter.getStrapiName()] = { name: name, inter: inter };
         });
     };
     Interface.prototype.getTsImports = function () {
@@ -75,8 +75,8 @@ var Interface = /** @class */ (function () {
             if (strapiName === _this.getStrapiName()) {
                 return "";
             }
-            var relationName = _this.RelationNames[strapiName][0];
-            var inter = _this.RelationNames[strapiName][1];
+            var relationName = _this.RelationNames[strapiName].name;
+            var inter = _this.RelationNames[strapiName].inter;
             var importPath = (0, utils_1.prefixDotSlash)((0, path_1.relative)(_this.getRelativeRootDir(), inter.getRelativeRootPath()));
             var fullName = inter.getFullInterfaceName();
             var importNameString = fullName === relationName ? fullName : "".concat(fullName, " as ").concat(relationName);

package/lib/interface/InterfaceManager.d.ts

@@ -3,14 +3,20 @@ export default class InterfaceManager {
     private OutRoot;
     private StrapiSrcRoot;
     private Options;
+    private PrettierOptions;
     static BaseOptions: {
         prefix: string;
         useCategoryPrefix: boolean;
         componentPrefix: string;
         componentPrefixOverridesPrefix: boolean;
+        builtinsPrefix: string;
+        builtinsPrefixOverridesPrefix: boolean;
+        prettierFile: any;
     };
     constructor(outRoot: string, strapiSrcRoot: string, options?: any);
+    loadPrettierConfig(): Promise<void>;
     createInterfaces(): Promise<void>;
+    createBuiltinInterfaces(): void;
     injectDependencies(): void;
     makeFolders(): Promise<void>;
     writeInterfaces(): Promise<void>;