@oak-digital/types-4-strapi-2 0.3.3 → 0.3.4

package/lib/events/index.d.ts

@@ -0,0 +1,12 @@
+export declare enum Events {
+    BeforeReadSchema = "BeforeReadSchema",
+    AfterReadSchema = "AfterReadSchema"
+}
+export declare type SchemasType = {
+    apiSchemas: Record<string, any>[];
+    componentSchemas: Record<string, any>[];
+};
+export declare type EventTypes = {
+    BeforeReadSchema: SchemasType;
+    AfterReadSchema: SchemasType;
+};

package/lib/events/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Events = void 0;
+var Events;
+(function (Events) {
+    Events["BeforeReadSchema"] = "BeforeReadSchema";
+    Events["AfterReadSchema"] = "AfterReadSchema";
+})(Events = exports.Events || (exports.Events = {}));

package/lib/index.js

@@ -15,10 +15,11 @@ commander_1.program
     .option('-D, --delete-old', 'CAUTION: This option is equivalent to running rm -rf on the output directory first')
     .option('--file-case <case>', 'Which case to use for generated files', 'pascal')
     .option('--folder-case <case>', 'Which case to use for generated folders', 'kebab')
+    .option('--plugins <plugins...>', 'A list of enabled plugins in the target strapi project that modify content-types')
     .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, componentPrefix = options.componentPrefix, prefix = options.prefix, prettierFile = options.prettier, deleteOld = options.deleteOld, fileCaseType = options.fileCase, folderCaseType = options.folderCase;
+var input = options.in, out = options.out, componentPrefix = options.componentPrefix, prefix = options.prefix, prettierFile = options.prettier, deleteOld = options.deleteOld, fileCaseType = options.fileCase, folderCaseType = options.folderCase, plugins = options.plugins;
 var manager = new InterfaceManager_1.default(out, input, {
     componentPrefix: componentPrefix,
     prefix: prefix,
@@ -26,6 +27,7 @@ var manager = new InterfaceManager_1.default(out, input, {
     deleteOld: deleteOld,
     fileCaseType: fileCaseType,
     folderCaseType: folderCaseType,
+    enabledPlugins: plugins,
 });
 manager.run().catch(function (err) {
     console.error(err);

package/lib/interface/InterfaceManager.d.ts

@@ -1,9 +1,12 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
 export default class InterfaceManager {
     private Interfaces;
     private OutRoot;
     private StrapiSrcRoot;
     private Options;
     private PrettierOptions;
+    eventEmitter: EventEmitter;
     static BaseOptions: {
         prefix: string;
         useCategoryPrefix: boolean;
@@ -13,12 +16,18 @@ export default class InterfaceManager {
         builtinsPrefixOverridesPrefix: boolean;
         deleteOld: boolean;
         prettierFile: any;
-        fileCaseType: "camel" | "capital" | "dot" | "snake" | "pascal" | "constant" | "kebab";
-        folderCaseType: "camel" | "capital" | "dot" | "snake" | "pascal" | "constant" | "kebab";
+        fileCaseType: "pascal" | "camel" | "capital" | "dot" | "snake" | "constant" | "kebab";
+        folderCaseType: "pascal" | "camel" | "capital" | "dot" | "snake" | "constant" | "kebab";
+        enabledPlugins: any[];
     };
     constructor(outRoot: string, strapiSrcRoot: string, options?: any);
+    registerPlugins(): void;
     validateOptions(): void;
     loadPrettierConfig(): Promise<void>;
+    readSchemas(): Promise<{
+        apiSchemas: any[];
+        componentSchemas: any[];
+    }>;
     createInterfaces(): Promise<void>;
     createBuiltinInterfaces(): void;
     injectDependencies(): void;

package/lib/interface/InterfaceManager.js

@@ -35,6 +35,15 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -49,15 +58,25 @@ var schemaReader_1 = require("./schemaReader");
 var prettier_1 = __importDefault(require("prettier"));
 var pascal_case_1 = require("pascal-case");
 var case_1 = require("../case");
+var events_1 = __importDefault(require("events"));
+var events_2 = require("../events");
+var plugins_1 = require("../plugins");
+var types_1 = require("../plugins/types");
 var InterfaceManager = /** @class */ (function () {
     function InterfaceManager(outRoot, strapiSrcRoot, options) {
         if (options === void 0) { options = {}; }
         this.Interfaces = {}; // string = strapi name
+        this.eventEmitter = new events_1.default();
         this.OutRoot = outRoot;
         this.StrapiSrcRoot = strapiSrcRoot;
         this.Options = Object.assign({}, InterfaceManager.BaseOptions, options);
         this.validateOptions();
+        this.registerPlugins();
     }
+    InterfaceManager.prototype.registerPlugins = function () {
+        var pluginNames = new Set(this.Options.enabledPlugins);
+        (0, plugins_1.registerPlugins)(pluginNames, this.eventEmitter);
+    };
     InterfaceManager.prototype.validateOptions = function () {
         if (!(0, case_1.checkCaseType)(this.Options.fileCaseType)) {
             throw new Error("".concat(this.Options.fileCaseType, " is not a supported type, please use one of the following ").concat(case_1.caseTypesArray.join(', ')));
@@ -65,6 +84,11 @@ var InterfaceManager = /** @class */ (function () {
         if (!(0, case_1.checkCaseType)(this.Options.folderCaseType)) {
             throw new Error("".concat(this.Options.folderCaseType, " is not a supported type, please use one of the following ").concat(case_1.caseTypesArray.join(', ')));
         }
+        this.Options.enabledPlugins.forEach(function (enabledPlugin) {
+            if (!types_1.supportedPluginNames.includes(enabledPlugin)) {
+                throw new Error("".concat(enabledPlugin, " is not a supported plugin, please open an issue on https://github.com/Oak-Digital/types-4-strapi-2 or only use the following plugins [").concat(types_1.supportedPluginNames.join(', '), "]"));
+            }
+        });
     };
     InterfaceManager.prototype.loadPrettierConfig = function () {
         return __awaiter(this, void 0, void 0, function () {
@@ -90,27 +114,48 @@ var InterfaceManager = /** @class */ (function () {
             });
         });
     };
-    InterfaceManager.prototype.createInterfaces = function () {
+    InterfaceManager.prototype.readSchemas = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var apiSchemasPromise, componentSchemasPromise, apiSchemas, componentSchemas;
-            var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var apiSchemasPre, componentSchemasPre, apiSchemasPromise, componentSchemasPromise, _a, apiSchemas, componentSchemas, newObject;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
+                        apiSchemasPre = [];
+                        componentSchemasPre = [];
                         apiSchemasPromise = (0, schemaReader_1.getApiSchemas)(this.StrapiSrcRoot);
                         componentSchemasPromise = (0, schemaReader_1.getComponentSchemas)(this.StrapiSrcRoot);
-                        return [4 /*yield*/, apiSchemasPromise];
+                        this.eventEmitter.emit(events_2.Events.BeforeReadSchema, {
+                            apiSchemas: apiSchemasPre,
+                            componentSchemas: componentSchemasPre,
+                        });
+                        return [4 /*yield*/, Promise.all([apiSchemasPromise, componentSchemasPromise])];
                     case 1:
-                        apiSchemas = _a.sent();
+                        _a = _b.sent(), apiSchemas = _a[0], componentSchemas = _a[1];
+                        newObject = {
+                            apiSchemas: __spreadArray(__spreadArray([], apiSchemasPre, true), apiSchemas, true),
+                            componentSchemas: __spreadArray(__spreadArray([], componentSchemasPre, true), componentSchemas, true),
+                        };
+                        this.eventEmitter.emit(events_2.Events.AfterReadSchema, newObject);
+                        return [2 /*return*/, newObject];
+                }
+            });
+        });
+    };
+    InterfaceManager.prototype.createInterfaces = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, apiSchemas, componentSchemas;
+            var _this = this;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.readSchemas()];
+                    case 1:
+                        _a = _b.sent(), apiSchemas = _a.apiSchemas, componentSchemas = _a.componentSchemas;
                         apiSchemas.forEach(function (schema) {
                             var name = schema.name, attributes = schema.attributes;
                             var strapiName = "api::".concat(name, ".").concat(name);
                             var inter = new Interface_1.default(name, attributes, './', _this.Options.fileCaseType, _this.Options.prefix);
                             _this.Interfaces[strapiName] = inter;
                         });
-                        return [4 /*yield*/, componentSchemasPromise];
-                    case 2:
-                        componentSchemas = _a.sent();
                         componentSchemas.forEach(function (category) {
                             var categoryName = category.category;
                             category.schemas.forEach(function (schema) {
@@ -326,6 +371,7 @@ var InterfaceManager = /** @class */ (function () {
         prettierFile: null,
         fileCaseType: 'pascal',
         folderCaseType: 'kebab',
+        enabledPlugins: [],
     };
     return InterfaceManager;
 }());

package/lib/plugins/index.d.ts

@@ -1,2 +1,3 @@
+import EventEmitter from "events";
 import { SupportedPluginNamesType } from "./types";
-export declare const registerPlugins: (pluginNames: Set<SupportedPluginNamesType>) => void;
+export declare const registerPlugins: (pluginNames: Set<SupportedPluginNamesType>, eventEmitter: EventEmitter) => void;

package/lib/plugins/index.js

@@ -1,8 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerPlugins = void 0;
-var registerPlugins = function (pluginNames) {
+var url_alias_1 = __importDefault(require("./url-alias"));
+var registerPlugins = function (pluginNames, eventEmitter) {
     if (pluginNames.has('url-alias')) {
+        (0, url_alias_1.default)(eventEmitter);
     }
 };
 exports.registerPlugins = registerPlugins;

package/lib/plugins/url-alias/index.d.ts

@@ -0,0 +1,3 @@
+import EventEmitter from "events";
+declare const register: (eventEmitter: EventEmitter) => void;
+export default register;

package/lib/plugins/url-alias/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var events_1 = require("../../events");
+var addUrlAliasToAllContentTypes = function (_a) {
+    var apiSchemas = _a.apiSchemas;
+    apiSchemas.forEach(function (schema) {
+        var attributes = schema.attributes;
+        attributes.url_path = {
+            type: 'string',
+            required: true,
+        };
+        // console.log('updated schema', schema)
+        // TODO: add this with possibly undefined instead of null
+        // attributes.url_path_id = {
+        //     type: 'string',
+        // };
+    });
+};
+var register = function (eventEmitter) {
+    eventEmitter.on(events_1.Events.AfterReadSchema, addUrlAliasToAllContentTypes);
+};
+exports.default = register;

package/package.json

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