@oak-digital/types-4-strapi-2 0.3.6 → 0.5.0

package/lib/program/InterfaceManager.js

@@ -0,0 +1,417 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        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 };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var fs_1 = require("fs");
+var promises_1 = require("fs/promises");
+var posix_1 = require("path/posix");
+var builtinInterfaces_1 = require("../interface/builtinInterfaces");
+var ComponentInterface_1 = __importDefault(require("../interface/ComponentInterface"));
+var Interface_1 = __importDefault(require("../interface/Interface"));
+var reader_1 = require("../content-types/reader");
+var prettier_1 = __importDefault(require("prettier"));
+var pascal_case_1 = require("pascal-case");
+var casing_1 = require("../utils/casing/");
+var events_1 = require("../events");
+var plugins_1 = require("../plugins");
+var types_1 = require("../plugins/types");
+var PluginManager_1 = require("../plugins/PluginManager");
+var createExtraTypes_1 = require("../extra-types/createExtraTypes");
+var InterfaceManager = /** @class */ (function () {
+    function InterfaceManager(outRoot, strapiSrcRoot, options) {
+        if (options === void 0) { options = {}; }
+        var _this = this;
+        // TODO: remove Interfaces
+        this.Interfaces = {}; // string = strapi name
+        this.Files = {}; // string = strapi name
+        this.OutRoot = outRoot;
+        this.StrapiSrcRoot = strapiSrcRoot;
+        this.Options = __assign(__assign({}, InterfaceManager.BaseOptions), options);
+        // Make sure all options are set
+        Object.keys(this.Options).map(function (name) {
+            if (_this.Options[name] === undefined) {
+                _this.Options[name] = InterfaceManager.BaseOptions[name];
+            }
+        });
+        this.PluginManager = new PluginManager_1.PluginManager();
+        this.validateOptions();
+        this.registerBuiltinPlugins();
+    }
+    InterfaceManager.prototype.registerBuiltinPlugins = function () {
+        var pluginNames = new Set(this.Options.enabledPlugins);
+        (0, plugins_1.registerBuiltinPlugins)(this.PluginManager, pluginNames);
+        this.PluginManager.sortHooks();
+    };
+    // TODO: this function let's the user register their own plugins
+    InterfaceManager.prototype.registerPlugin = function () {
+        throw new Error('Not implemented');
+    };
+    InterfaceManager.prototype.validateOptions = function () {
+        if (!(0, casing_1.checkCaseType)(this.Options.fileCaseType)) {
+            throw new Error("".concat(this.Options.fileCaseType, " is not a supported type, please use one of the following ").concat(casing_1.caseTypesArray.join(', ')));
+        }
+        if (!(0, casing_1.checkCaseType)(this.Options.folderCaseType)) {
+            throw new Error("".concat(this.Options.folderCaseType, " is not a supported type, please use one of the following ").concat(casing_1.caseTypesArray.join(', ')));
+        }
+        this.Options.enabledPlugins.forEach(function (enabledPlugin) {
+            if (!types_1.supportedPluginNames.includes(enabledPlugin)) {
+                throw new Error("plugin: `".concat(enabledPlugin, "` is not a supported plugin, please open an issue on https://github.com/Oak-Digital/types-4-strapi-2 if you want this included or only use the following plugins [").concat(types_1.supportedPluginNames.join(', '), "]"));
+            }
+        });
+    };
+    InterfaceManager.prototype.loadPrettierConfig = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var defaultOptions, resolved;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        defaultOptions = {
+                            parser: 'typescript',
+                        };
+                        if (!this.Options.prettierFile) {
+                            this.PrettierOptions = defaultOptions;
+                            return [2 /*return*/];
+                        }
+                        return [4 /*yield*/, prettier_1.default.resolveConfig(this.Options.prettierFile, {
+                                editorconfig: true,
+                            })];
+                    case 1:
+                        resolved = _a.sent();
+                        this.PrettierOptions = Object.assign({}, defaultOptions, resolved);
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    InterfaceManager.prototype.readSchemas = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiSchemasPre, componentSchemasPre, apiSchemasPromise, componentSchemasPromise, _a, apiSchemas, componentSchemas, newObject;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        apiSchemasPre = [];
+                        componentSchemasPre = [];
+                        apiSchemasPromise = (0, reader_1.getApiSchemas)(this.StrapiSrcRoot);
+                        componentSchemasPromise = (0, reader_1.getComponentSchemas)(this.StrapiSrcRoot);
+                        this.PluginManager.invoke(events_1.Events.BeforeReadSchema, this, {
+                            apiSchemas: apiSchemasPre,
+                            componentSchemas: componentSchemasPre,
+                        });
+                        return [4 /*yield*/, Promise.all([
+                                apiSchemasPromise,
+                                componentSchemasPromise,
+                            ])];
+                    case 1:
+                        _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.PluginManager.invoke(events_1.Events.AfterReadSchema, this, 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;
+                            _this.Files[strapiName] = inter;
+                        });
+                        componentSchemas.forEach(function (category) {
+                            var categoryName = category.category;
+                            category.schemas.forEach(function (schema) {
+                                var componentName = schema.name;
+                                var strapiName = "".concat(categoryName, ".").concat(schema.name);
+                                var componentPrefix = "".concat(_this.Options.componentPrefix).concat(_this.Options.useCategoryPrefix
+                                    ? (0, pascal_case_1.pascalCase)(categoryName)
+                                    : '');
+                                var prefix = _this.Options.componentPrefixOverridesPrefix
+                                    ? componentPrefix
+                                    : _this.Options.prefix + componentPrefix;
+                                var categoryFolderName = (0, casing_1.changeCase)(categoryName, _this.Options.folderCaseType);
+                                // make component interface
+                                var inter = new ComponentInterface_1.default(componentName, schema.attributes, "./".concat(categoryFolderName), categoryName, _this.Options.fileCaseType, prefix);
+                                _this.Interfaces[strapiName] = inter;
+                                _this.Files[strapiName] = inter;
+                            });
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    InterfaceManager.prototype.createBuiltinInterfaces = function () {
+        var _this = this;
+        // Interfaces
+        var outDirName = (0, casing_1.changeCase)('builtins', this.Options.folderCaseType);
+        var outDir = "./".concat(outDirName);
+        var builtinInterfaces = [];
+        builtinInterfaces.push((0, builtinInterfaces_1.createMediaInterface)(outDir, this.Options.fileCaseType, this.Options.prefix));
+        builtinInterfaces.push((0, builtinInterfaces_1.createMediaFormatInterface)(outDir, this.Options.fileCaseType, this.Options.prefix));
+        builtinInterfaces.forEach(function (inter) {
+            _this.Interfaces[inter.getStrapiName()] = inter;
+            _this.Files[inter.getStrapiName()] = inter;
+        });
+        // Types
+        var types = [];
+        types.push.apply(types, (0, createExtraTypes_1.createExtraTypes)());
+        types.forEach(function (t) {
+            _this.Files[t.getStrapiName()] = t;
+        });
+    };
+    // Inject dependencies into all interfaces
+    InterfaceManager.prototype.injectDependencies = function () {
+        var _this = this;
+        // console.log("Injecting dependencies")
+        Object.keys(this.Files).forEach(function (strapiName) {
+            var file = _this.Files[strapiName];
+            var dependencies = file.getDependencies();
+            // console.log(`Interfaces for ${inter.getStrapiName()} are`)
+            var interfacesToInject = dependencies
+                .map(function (dependencyStrapiName) {
+                return _this.Files[dependencyStrapiName];
+            })
+                .filter(function (inter) { return inter; });
+            file.setRelations(interfacesToInject);
+        });
+    };
+    InterfaceManager.prototype.deleteOldFolders = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, promises_1.rm)(this.OutRoot, {
+                            force: true,
+                            recursive: true,
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    InterfaceManager.prototype.makeFolders = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var componentCategories, promises, componentCategoriesPromises, builintsFolderName, builtinsPath;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.Options.deleteOld) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.deleteOldFolders()];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, (0, reader_1.getComponentCategoryFolders)(this.StrapiSrcRoot)];
+                    case 3:
+                        componentCategories = _a.sent();
+                        if (!!(0, fs_1.existsSync)(this.OutRoot)) return [3 /*break*/, 5];
+                        return [4 /*yield*/, (0, promises_1.mkdir)(this.OutRoot, {
+                                recursive: true,
+                            })];
+                    case 4:
+                        _a.sent();
+                        _a.label = 5;
+                    case 5:
+                        promises = [];
+                        componentCategoriesPromises = componentCategories.map(function (category) { return __awaiter(_this, void 0, void 0, function () {
+                            var folderName, path;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0:
+                                        folderName = (0, casing_1.changeCase)(category, this.Options.folderCaseType);
+                                        path = (0, posix_1.join)(this.OutRoot, folderName);
+                                        if ((0, fs_1.existsSync)(path)) {
+                                            return [2 /*return*/];
+                                        }
+                                        return [4 /*yield*/, (0, promises_1.mkdir)(path)];
+                                    case 1:
+                                        _a.sent();
+                                        return [2 /*return*/];
+                                }
+                            });
+                        }); });
+                        promises.push.apply(promises, componentCategoriesPromises);
+                        builintsFolderName = (0, casing_1.changeCase)('builtins', this.Options.folderCaseType);
+                        builtinsPath = (0, posix_1.join)(this.OutRoot, builintsFolderName);
+                        if (!(0, fs_1.existsSync)(builtinsPath)) {
+                            promises.push((0, promises_1.mkdir)(builtinsPath));
+                        }
+                        return [4 /*yield*/, Promise.all(promises)];
+                    case 6:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    InterfaceManager.prototype.writeInterfaces = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var writePromises;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        writePromises = Object.keys(this.Files).map(function (strapiName) { return __awaiter(_this, void 0, void 0, function () {
+                            var file, fileData, formattedFileData, filePath;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0:
+                                        file = this.Files[strapiName];
+                                        fileData = file.toString();
+                                        formattedFileData = prettier_1.default.format(fileData, this.PrettierOptions);
+                                        filePath = (0, posix_1.join)(this.OutRoot, file.getRelativeRootPathFile());
+                                        return [4 /*yield*/, (0, promises_1.writeFile)(filePath, formattedFileData)];
+                                    case 1:
+                                        _a.sent();
+                                        return [2 /*return*/];
+                                }
+                            });
+                        }); });
+                        return [4 /*yield*/, Promise.all(writePromises)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    InterfaceManager.prototype.writeIndexFile = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var strings, fileData, formattedFileData, filePath;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        strings = Object.keys(this.Files).map(function (strapiName) {
+                            var inter = _this.Files[strapiName];
+                            return "export * from '".concat(inter.getRelativeRootPath(), "'");
+                        });
+                        fileData = strings.join('\n');
+                        formattedFileData = prettier_1.default.format(fileData, this.PrettierOptions);
+                        filePath = (0, posix_1.join)(this.OutRoot, 'index.ts');
+                        return [4 /*yield*/, (0, promises_1.writeFile)(filePath, formattedFileData)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    InterfaceManager.prototype.run = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var createInterfacesPromise, makeFoldersPromise, loadPrettierPromise, err_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 4, , 5]);
+                        createInterfacesPromise = this.createInterfaces();
+                        makeFoldersPromise = this.makeFolders();
+                        loadPrettierPromise = this.loadPrettierConfig();
+                        this.createBuiltinInterfaces();
+                        return [4 /*yield*/, createInterfacesPromise];
+                    case 1:
+                        _a.sent();
+                        // Create all interfaces before injecting
+                        this.injectDependencies();
+                        return [4 /*yield*/, Promise.all([makeFoldersPromise, loadPrettierPromise])];
+                    case 2:
+                        _a.sent();
+                        return [4 /*yield*/, Promise.all([this.writeInterfaces(), this.writeIndexFile()])];
+                    case 3:
+                        _a.sent();
+                        return [3 /*break*/, 5];
+                    case 4:
+                        err_1 = _a.sent();
+                        console.error(err_1);
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    InterfaceManager.BaseOptions = {
+        prefix: 'I',
+        useCategoryPrefix: true,
+        componentPrefix: '',
+        componentPrefixOverridesPrefix: false,
+        builtinsPrefix: '',
+        builtinsPrefixOverridesPrefix: false,
+        deleteOld: false,
+        prettierFile: null,
+        fileCaseType: 'pascal',
+        folderCaseType: 'kebab',
+        enabledPlugins: [],
+    };
+    return InterfaceManager;
+}());
+exports.default = InterfaceManager;

package/lib/utils/casing/index.d.ts

@@ -0,0 +1,4 @@
+export declare const caseTypesArray: readonly ["camel", "capital", "dot", "snake", "pascal", "constant", "kebab"];
+export declare type caseType = typeof caseTypesArray[number];
+export declare function checkCaseType(caseName: caseType): caseName is caseType;
+export declare function changeCase(text: string, caseName: caseType): string;

package/lib/utils/casing/index.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.changeCase = exports.checkCaseType = exports.caseTypesArray = void 0;
+var change_case_1 = require("change-case");
+exports.caseTypesArray = [
+    'camel',
+    'capital',
+    'dot',
+    'snake',
+    'pascal',
+    'constant',
+    'kebab',
+];
+function checkCaseType(caseName) {
+    return exports.caseTypesArray.includes(caseName);
+}
+exports.checkCaseType = checkCaseType;
+function changeCase(text, caseName) {
+    var name = text;
+    switch (caseName) {
+        case 'dot':
+            name = (0, change_case_1.dotCase)(name);
+            break;
+        case 'camel':
+            name = (0, change_case_1.camelCase)(name);
+            break;
+        case 'snake':
+            name = (0, change_case_1.snakeCase)(name);
+            break;
+        case 'capital':
+            name = (0, change_case_1.capitalCase)(name);
+            break;
+        case 'constant':
+            name = (0, change_case_1.constantCase)(name);
+            break;
+        case 'kebab':
+            // paramcase is the same as kebab
+            name = (0, change_case_1.paramCase)(name);
+            break;
+        case 'pascal':
+        default:
+            name = (0, change_case_1.pascalCase)(name);
+            break;
+    }
+    return name;
+}
+exports.changeCase = changeCase;

package/package.json

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