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

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

@@ -18,17 +18,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 +44,45 @@ 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":
+                str += 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

@@ -8,9 +8,12 @@ export default class InterfaceManager {
         useCategoryPrefix: boolean;
         componentPrefix: string;
         componentPrefixOverridesPrefix: boolean;
+        builtinsPrefix: string;
+        builtinsPrefixOverridesPrefix: boolean;
     };
     constructor(outRoot: string, strapiSrcRoot: string, options?: any);
     createInterfaces(): Promise<void>;
+    createBuiltinInterfaces(): void;
     injectDependencies(): void;
     makeFolders(): Promise<void>;
     writeInterfaces(): Promise<void>;

package/lib/interface/InterfaceManager.js

@@ -43,6 +43,7 @@ var fs_1 = require("fs");
 var promises_1 = require("fs/promises");
 var path_1 = require("path");
 var utils_1 = require("../utils");
+var builtinInterfaces_1 = require("./builtinInterfaces");
 var ComponentInterface_1 = __importDefault(require("./ComponentInterface"));
 var Interface_1 = __importDefault(require("./Interface"));
 var schemaReader_1 = require("./schemaReader");
@@ -92,6 +93,16 @@ var InterfaceManager = /** @class */ (function () {
             });
         });
     };
+    InterfaceManager.prototype.createBuiltinInterfaces = function () {
+        var _this = this;
+        var outDir = "./builtins";
+        var builtinInterfaces = [];
+        builtinInterfaces.push((0, builtinInterfaces_1.createMediaInterface)(outDir, this.Options.prefix));
+        builtinInterfaces.push((0, builtinInterfaces_1.createMediaFormatInterface)(outDir, this.Options.prefix));
+        builtinInterfaces.forEach(function (inter) {
+            _this.Interfaces[inter.getStrapiName()] = inter;
+        });
+    };
     // Inject dependencies into all interfaces
     InterfaceManager.prototype.injectDependencies = function () {
         var _this = this;
@@ -108,7 +119,7 @@ var InterfaceManager = /** @class */ (function () {
     };
     InterfaceManager.prototype.makeFolders = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var componentCategories;
+            var componentCategories, promises, componentCategoriesPromises, builtinsPath;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
@@ -122,7 +133,9 @@ var InterfaceManager = /** @class */ (function () {
                     case 2:
                         _a.sent();
                         _a.label = 3;
-                    case 3: return [4 /*yield*/, Promise.all(componentCategories.map(function (category) { return __awaiter(_this, void 0, void 0, function () {
+                    case 3:
+                        promises = [];
+                        componentCategoriesPromises = componentCategories.map(function (category) { return __awaiter(_this, void 0, void 0, function () {
                             var path;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
@@ -137,7 +150,13 @@ var InterfaceManager = /** @class */ (function () {
                                         return [2 /*return*/];
                                 }
                             });
-                        }); }))];
+                        }); });
+                        promises.push.apply(promises, componentCategoriesPromises);
+                        builtinsPath = (0, path_1.join)(this.OutRoot, "builtins");
+                        if (!(0, fs_1.existsSync)(builtinsPath)) {
+                            promises.push((0, promises_1.mkdir)((0, path_1.join)(this.OutRoot, "builtins")));
+                        }
+                        return [4 /*yield*/, Promise.all(promises)];
                     case 4:
                         _a.sent();
                         return [2 /*return*/];
@@ -205,9 +224,11 @@ var InterfaceManager = /** @class */ (function () {
                         _a.trys.push([0, 4, , 5]);
                         createInterfacesPromise = this.createInterfaces();
                         makeFoldersPromise = this.makeFolders();
+                        this.createBuiltinInterfaces();
                         return [4 /*yield*/, createInterfacesPromise];
                     case 1:
                         _a.sent();
+                        // Create all interfaces before injecting
                         this.injectDependencies();
                         return [4 /*yield*/, makeFoldersPromise];
                     case 2:
@@ -230,6 +251,8 @@ var InterfaceManager = /** @class */ (function () {
         useCategoryPrefix: true,
         componentPrefix: "",
         componentPrefixOverridesPrefix: false,
+        builtinsPrefix: "",
+        builtinsPrefixOverridesPrefix: false // TODO: make this work
     };
     return InterfaceManager;
 }());

package/lib/interface/builtinInterfaces.d.ts

@@ -0,0 +1,4 @@
+import BuiltinComponentInterface from "./BuiltinComponentInterface";
+import BuiltinInterface from "./BuiltinInterface";
+export declare function createMediaInterface(directory: string, prefix: string): BuiltinInterface;
+export declare function createMediaFormatInterface(directory: string, prefix: string): BuiltinComponentInterface;

package/lib/interface/builtinInterfaces.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMediaFormatInterface = exports.createMediaInterface = void 0;
+var BuiltinComponentInterface_1 = __importDefault(require("./BuiltinComponentInterface"));
+var BuiltinInterface_1 = __importDefault(require("./BuiltinInterface"));
+function createMediaInterface(directory, prefix) {
+    var stringFields = [
+        "name",
+        "alternativeText",
+        "caption",
+        "hash",
+        "ext",
+        "mime",
+        "url",
+        "previewUrl",
+        "provider",
+    ];
+    var numberFields = [
+        "width",
+        "height",
+        "size",
+    ];
+    var mediaFormat = {
+        type: "component",
+        repeatable: false,
+        component: "builtins::MediaFormat",
+    };
+    var mediaAttrs = {
+        formats: {
+            // types-4-strapi-2 specific
+            type: "nested",
+            fields: {
+                thumbnail: mediaFormat,
+                medium: mediaFormat,
+                small: mediaFormat,
+            },
+        },
+    };
+    stringFields.forEach(function (s) { return mediaAttrs[s] = { type: "string" }; });
+    numberFields.forEach(function (s) { return mediaAttrs[s] = { type: "integer" }; });
+    return new BuiltinInterface_1.default("Media", mediaAttrs, directory, prefix);
+}
+exports.createMediaInterface = createMediaInterface;
+function createMediaFormatInterface(directory, prefix) {
+    var stringFields = [
+        "name",
+        "hash",
+        "ext",
+        "mime",
+        "path",
+        "url",
+    ];
+    var numberFields = [
+        "width",
+        "height",
+        "size",
+    ];
+    var mediaAttrs = {};
+    stringFields.forEach(function (s) { return mediaAttrs[s] = { type: "string" }; });
+    numberFields.forEach(function (s) { return mediaAttrs[s] = { type: "integer" }; });
+    return new BuiltinComponentInterface_1.default("MediaFormat", mediaAttrs, directory, prefix);
+}
+exports.createMediaFormatInterface = createMediaFormatInterface;

package/package.json

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