@oak-digital/types-4-strapi-2 0.5.3 → 0.5.5

package/lib/src/interface/Interface.js

@@ -1,112 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var path_1 = require("path");
-var utils_1 = require("../utils");
-var Attributes_1 = __importDefault(require("./Attributes"));
-var Interface = /** @class */ (function () {
-    function Interface(baseName, attributes, relativeDirectoryPath, prefix) {
-        if (prefix === void 0) { prefix = ''; }
-        this.Relations = []; // Components and relations
-        this.RelationNames = {};
-        this.RelationNamesCounter = {};
-        this.NamePrefix = '';
-        this.BaseName = baseName;
-        this.updateStrapiName();
-        this.NamePrefix = prefix;
-        this.Attributes = attributes;
-        this.RelativeDirectoryPath = relativeDirectoryPath;
-    }
-    Interface.prototype.updateStrapiName = function () {
-        this.StrapiName = "api::".concat(this.BaseName, ".").concat(this.BaseName);
-    };
-    Interface.prototype.getBaseName = function () {
-        return this.BaseName;
-    };
-    Interface.prototype.getStrapiName = function () {
-        return this.StrapiName;
-    };
-    Interface.prototype.getDependencies = function () {
-        var attrs = new Attributes_1.default(this.Attributes, this.RelationNames);
-        return attrs.getDependencies();
-    };
-    Interface.prototype.getFullInterfaceName = function () {
-        var pascalName = (0, utils_1.pascalCase)(this.BaseName);
-        return "".concat(this.NamePrefix).concat(pascalName);
-    };
-    // For typescript import from index file
-    Interface.prototype.getRelativeRootPath = function () {
-        var path = (0, path_1.join)(this.RelativeDirectoryPath, this.getBaseName());
-        return (0, utils_1.prefixDotSlash)(path);
-    };
-    Interface.prototype.getRelativeRootDir = function () {
-        var path = (0, path_1.dirname)(this.getRelativeRootPathFile());
-        return path;
-    };
-    Interface.prototype.getRelativeRootPathFile = function () {
-        return "".concat(this.getRelativeRootPath(), ".ts");
-    };
-    Interface.prototype.setRelations = function (relations) {
-        var _this = this;
-        this.Relations = relations;
-        this.RelationNames = {};
-        this.Relations.forEach(function (inter) {
-            var name = inter.getFullInterfaceName();
-            // FIXME: clean up this mess...
-            if (inter.getStrapiName() !== _this.getStrapiName()) {
-                // Avoid duplicate names
-                if (name in _this.RelationNamesCounter) {
-                    name += ++_this.RelationNamesCounter[name];
-                }
-                else {
-                    _this.RelationNamesCounter[name] = 0;
-                }
-            }
-            _this.RelationNames[inter.getStrapiName()] = { name: name, inter: inter };
-        });
-    };
-    Interface.prototype.getTsImports = function () {
-        var _this = this;
-        return Object.keys(this.RelationNames).map(function (strapiName) {
-            if (strapiName === _this.getStrapiName()) {
-                return '';
-            }
-            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);
-            return "import { ".concat(importNameString, " } from '").concat(importPath, "';");
-        }).filter(function (s) { return s; }).join('\n');
-    };
-    Interface.prototype.getAttributes = function () {
-        return new Attributes_1.default(this.Attributes, this.RelationNames);
-    };
-    Interface.prototype.attributesToString = function () {
-        var attrs = this.getAttributes();
-        return attrs.toString();
-    };
-    Interface.prototype.getInerfaceString = function () {
-        var str = "export interface ".concat(this.getFullInterfaceName(), " {\n");
-        str += this.getInterfaceFieldsString();
-        str += '}';
-        return str;
-    };
-    Interface.prototype.getInterfaceFieldsString = function () {
-        var str = '';
-        str += 'id: number;\n';
-        str += "attributes: ".concat(this.attributesToString(), "\n");
-        return str;
-    };
-    Interface.prototype.toString = function () {
-        var strings = [
-            this.getTsImports(),
-            this.getInerfaceString()
-        ];
-        return strings.join('\n');
-    };
-    return Interface;
-}());
-exports.default = Interface;

package/lib/src/interface/InterfaceManager.d.ts

@@ -1,25 +0,0 @@
-export default class InterfaceManager {
-    private Interfaces;
-    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>;
-    writeIndexFile(): Promise<void>;
-    run(): Promise<void>;
-}

package/lib/src/interface/InterfaceManager.js

@@ -1,288 +0,0 @@
-"use strict";
-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 __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 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");
-var prettier_1 = __importDefault(require("prettier"));
-var _prettierrc_json_1 = __importDefault(require("../../.prettierrc.json"));
-var InterfaceManager = /** @class */ (function () {
-    function InterfaceManager(outRoot, strapiSrcRoot, options) {
-        if (options === void 0) { options = {}; }
-        this.Interfaces = {}; // string = strapi name
-        this.OutRoot = outRoot;
-        this.StrapiSrcRoot = strapiSrcRoot;
-        this.Options = Object.assign({}, InterfaceManager.BaseOptions, options);
-    }
-    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 = _prettierrc_json_1.default;
-                        if (!this.Options.prettierFile) {
-                            this.PrettierOptions = defaultOptions;
-                            return [2 /*return*/];
-                        }
-                        return [4 /*yield*/, prettier_1.default.resolveConfig(this.Options.prettierFile)];
-                    case 1:
-                        resolved = _a.sent();
-                        this.PrettierOptions = Object.assign({}, defaultOptions, resolved);
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    InterfaceManager.prototype.createInterfaces = 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) {
-                    case 0:
-                        apiSchemasPromise = (0, schemaReader_1.getApiSchemas)(this.StrapiSrcRoot);
-                        componentSchemasPromise = (0, schemaReader_1.getComponentSchemas)(this.StrapiSrcRoot);
-                        return [4 /*yield*/, apiSchemasPromise];
-                    case 1:
-                        apiSchemas = _a.sent();
-                        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.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) {
-                                var componentName = schema.name;
-                                var strapiName = "".concat(categoryName, ".").concat(schema.name);
-                                var componentPrefix = "".concat(_this.Options.componentPrefix).concat(_this.Options.useCategoryPrefix ? (0, utils_1.pascalCase)(categoryName) : '');
-                                var prefix = _this.Options.componentPrefixOverridesPrefix ? componentPrefix : _this.Options.prefix + componentPrefix;
-                                // TODO: make component interface
-                                var inter = new ComponentInterface_1.default(componentName, schema.attributes, "./".concat(categoryName), categoryName, prefix);
-                                _this.Interfaces[strapiName] = inter;
-                            });
-                        });
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    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;
-        // console.log("Injecting dependencies")
-        Object.keys(this.Interfaces).forEach(function (strapiName) {
-            var inter = _this.Interfaces[strapiName];
-            var dependencies = inter.getDependencies();
-            // console.log(`Interfaces for ${inter.getStrapiName()} are`)
-            var interfacesToInject = dependencies.map(function (dependencyStrapiName) {
-                return _this.Interfaces[dependencyStrapiName];
-            }).filter(function (inter) { return inter; });
-            inter.setRelations(interfacesToInject);
-        });
-    };
-    InterfaceManager.prototype.makeFolders = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var componentCategories, promises, componentCategoriesPromises, builtinsPath;
-            var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, schemaReader_1.getComponentCategoryFolders)(this.StrapiSrcRoot)];
-                    case 1:
-                        componentCategories = _a.sent();
-                        if (!!(0, fs_1.existsSync)(this.OutRoot)) return [3 /*break*/, 3];
-                        return [4 /*yield*/, (0, promises_1.mkdir)(this.OutRoot, {
-                                recursive: true,
-                            })];
-                    case 2:
-                        _a.sent();
-                        _a.label = 3;
-                    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) {
-                                    case 0:
-                                        path = (0, path_1.join)(this.OutRoot, category);
-                                        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);
-                        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*/];
-                }
-            });
-        });
-    };
-    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.Interfaces).map(function (strapiName) { return __awaiter(_this, void 0, void 0, function () {
-                            var inter, fileData, formattedFileData, filePath;
-                            return __generator(this, function (_a) {
-                                switch (_a.label) {
-                                    case 0:
-                                        inter = this.Interfaces[strapiName];
-                                        fileData = inter.toString();
-                                        formattedFileData = prettier_1.default.format(fileData, this.PrettierOptions);
-                                        filePath = (0, path_1.join)(this.OutRoot, inter.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.Interfaces).map(function (strapiName) {
-                            var inter = _this.Interfaces[strapiName];
-                            return "export * from '".concat(inter.getRelativeRootPath(), "'");
-                        });
-                        fileData = strings.join('\n');
-                        formattedFileData = prettier_1.default.format(fileData, this.PrettierOptions);
-                        filePath = (0, path_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, 5, , 6]);
-                        createInterfacesPromise = this.createInterfaces();
-                        makeFoldersPromise = this.makeFolders();
-                        loadPrettierPromise = this.loadPrettierConfig();
-                        return [4 /*yield*/, loadPrettierPromise];
-                    case 1:
-                        _a.sent();
-                        this.createBuiltinInterfaces();
-                        return [4 /*yield*/, createInterfacesPromise];
-                    case 2:
-                        _a.sent();
-                        // Create all interfaces before injecting
-                        this.injectDependencies();
-                        return [4 /*yield*/, Promise.all([makeFoldersPromise,])];
-                    case 3:
-                        _a.sent();
-                        return [4 /*yield*/, Promise.all([this.writeInterfaces(), this.writeIndexFile()])];
-                    case 4:
-                        _a.sent();
-                        return [3 /*break*/, 6];
-                    case 5:
-                        err_1 = _a.sent();
-                        console.error(err_1);
-                        return [3 /*break*/, 6];
-                    case 6: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    InterfaceManager.BaseOptions = {
-        prefix: 'I',
-        useCategoryPrefix: true,
-        componentPrefix: '',
-        componentPrefixOverridesPrefix: false,
-        builtinsPrefix: '',
-        builtinsPrefixOverridesPrefix: false,
-        prettierFile: null,
-    };
-    return InterfaceManager;
-}());
-exports.default = InterfaceManager;

package/lib/src/interface/builtinInterfaces.d.ts

@@ -1,4 +0,0 @@
-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/src/interface/builtinInterfaces.js

@@ -1,81 +0,0 @@
-"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) {
-        mediaAttrs[s] = { type: 'string' };
-    });
-    numberFields.forEach(function (s) {
-        mediaAttrs[s] = { type: 'integer' };
-    });
-    // const dataAttrs = {
-    //     data: {
-    //         type: "nested",
-    //         fields: mediaAttrs,
-    //         nullable: true,
-    //     },
-    // };
-    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) {
-        mediaAttrs[s] = { type: 'string' };
-    });
-    numberFields.forEach(function (s) {
-        mediaAttrs[s] = { type: 'integer' };
-    });
-    return new BuiltinComponentInterface_1.default('MediaFormat', mediaAttrs, directory, prefix);
-}
-exports.createMediaFormatInterface = createMediaFormatInterface;

package/lib/src/interface/schemaReader.d.ts

@@ -1,14 +0,0 @@
-export declare function readSchema(schemaPath: string): Promise<any>;
-export declare function getApiFolders(strapiSrcRoot: string): Promise<string[]>;
-export declare function getComponentCategoryFolders(strapiSrcRoot: string): Promise<string[]>;
-export declare function getComponentSchemas(strapiSrcRoot: string): Promise<{
-    category: string;
-    schemas: {
-        name: string;
-        attributes: any;
-    }[];
-}[]>;
-export declare function getApiSchemas(strapiSrcRoot: string): Promise<{
-    name: string;
-    attributes: any;
-}[]>;