@oak-digital/types-4-strapi-2 0.2.5 → 0.2.8

package/README.md

@@ -1,16 +1,19 @@
 # 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 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.
+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
 npm install --save-dev @oak-digital/types-4-strapi-2
+# YARN
+yarn add -D @oak-digital/types-4-strapi-2
 ```
 
 Then set up a script in your `package.json`
@@ -38,8 +41,8 @@ This can be done with the `--out` flag like in the following example.
 
 ## Features
 
-* Generate typescript interfaces for all your api content-types and components
-* Generate typescript interfaces for builtin types such as `Media` and `MediaFormat`
+* 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`.
 
@@ -48,9 +51,16 @@ This can be done with the `--out` flag like in the following example.
 * Support for localization
 * Support if you are using other plugins, such as `url-alias`, which should add extra fields for some interfaces.
 
-## Help
+## Flags
 
-use `t4s --help` to display which options are available for you
+| **Flag**                    | **Description**                                                                      | **Default** |
+|-----------------------------|--------------------------------------------------------------------------------------|-------------|
+| -i, --in <dir>              | The src directory for strapi                                                         | `./src`     |
+| -o, --out <dir>             | The output directory to output the types to                                          | `./types`   |
+| -prefix                     | A prefix for all generated interfaces                                                | `I`         |
+| --component-prefix <prefix> | A prefix for components                                                              | none        |
+| -D, --delete-old            | CAUTION: This option is equivalent to running `rm -rf` on the output directory first | `false`     |
+| --prettier <file>           | The prettier config file to use for formatting TypeScript interfaces                 | none        |
 
 ## Building
 
@@ -60,7 +70,7 @@ To build this project, use the following command
 npm run build
 ```
 
-## Publihsing
+## Publishing
 
 ```bash
 npm run build

package/lib/case/index.d.ts

@@ -0,0 +1,4 @@
+export declare const caseTypesArray: string[];
+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/case/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/lib/index.js

@@ -10,14 +10,22 @@ commander_1.program
 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('--prefix <prefix>', 'A prefix for all generated interfaces', 'I')
     .option('--component-prefix <prefix>', 'A prefix for components', '')
+    .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('--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, prettierFile = options.prettier;
+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 manager = new InterfaceManager_1.default(out, input, {
     componentPrefix: componentPrefix,
+    prefix: prefix,
     prettierFile: prettierFile,
+    deleteOld: deleteOld,
+    fileCaseType: fileCaseType,
+    folderCaseType: folderCaseType,
 });
 manager.run().catch(function (err) {
     console.error(err);

package/lib/interface/BuiltinComponentInterface.d.ts

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

package/lib/interface/BuiltinComponentInterface.js

@@ -21,9 +21,9 @@ 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, {
+    function BuiltinComponentInterface(baseName, attributes, relativeDirectoryPath, fileCase, prefix) {
+        if (prefix === void 0) { prefix = ''; }
+        return _super.call(this, baseName, attributes, relativeDirectoryPath, 'builtins', fileCase, prefix, {
             hasId: false,
             hasComponent: false,
         }) || this;

package/lib/interface/BuiltinInterface.d.ts

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

package/lib/interface/BuiltinInterface.js

@@ -21,9 +21,9 @@ 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;
+    function BuiltinInterface(baseName, attributes, relativeDirectoryPath, fileCase, prefix) {
+        if (prefix === void 0) { prefix = ''; }
+        return _super.call(this, baseName, attributes, relativeDirectoryPath, fileCase, prefix) || this;
     }
     BuiltinInterface.prototype.updateStrapiName = function () {
         this.StrapiName = "builtins::".concat(this.BaseName);

package/lib/interface/ComponentInterface.d.ts

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

package/lib/interface/ComponentInterface.js

@@ -21,10 +21,10 @@ 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, options) {
-        if (prefix === void 0) { prefix = ""; }
+    function ComponentInterface(baseName, attributes, relativeDirectoryPath, category, fileCase, prefix, options) {
+        if (prefix === void 0) { prefix = ''; }
         if (options === void 0) { options = {}; }
-        var _this = _super.call(this, baseName, attributes, relativeDirectoryPath, prefix) || this;
+        var _this = _super.call(this, baseName, attributes, relativeDirectoryPath, fileCase, prefix) || this;
         _this.Options = {
             hasId: true,
             hasComponent: true,
@@ -46,7 +46,7 @@ var ComponentInterface = /** @class */ (function (_super) {
         var str = '';
         var _a = this.Options, hasId = _a.hasId, hasComponent = _a.hasComponent;
         if (hasId) {
-            str += "  id: number;\n";
+            str += '  id: number;\n';
         }
         if (hasComponent) {
             str += "  __component: \"".concat(this.getStrapiName(), "\";\n");

package/lib/interface/Interface.d.ts

@@ -1,3 +1,4 @@
+import { caseType } from '../case';
 import Attributes from './Attributes';
 export declare type RelationNames = Record<string, {
     name: string;
@@ -12,12 +13,14 @@ export default class Interface {
     protected Attributes: any;
     private RelativeDirectoryPath;
     protected StrapiName: string;
-    constructor(baseName: string, attributes: any, relativeDirectoryPath: string, prefix?: string);
+    protected FileCase: caseType;
+    constructor(baseName: string, attributes: any, relativeDirectoryPath: string, fileCaseType?: caseType, prefix?: string);
     protected updateStrapiName(): void;
     getBaseName(): string;
     getStrapiName(): string;
     getDependencies(): any[];
     getFullInterfaceName(): string;
+    getFileBaseName(): string;
     getRelativeRootPath(): any;
     getRelativeRootDir(): string;
     getRelativeRootPathFile(): string;

package/lib/interface/Interface.js

@@ -4,10 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var posix_1 = require("path/posix");
+var case_1 = require("../case");
 var utils_1 = require("../utils");
 var Attributes_1 = __importDefault(require("./Attributes"));
+var change_case_1 = require("change-case");
 var Interface = /** @class */ (function () {
-    function Interface(baseName, attributes, relativeDirectoryPath, prefix) {
+    function Interface(baseName, attributes, relativeDirectoryPath, fileCaseType, prefix) {
+        if (fileCaseType === void 0) { fileCaseType = "pascal"; }
         if (prefix === void 0) { prefix = ''; }
         this.Relations = []; // Components and relations
         this.RelationNames = {};
@@ -18,6 +21,7 @@ var Interface = /** @class */ (function () {
         this.NamePrefix = prefix;
         this.Attributes = attributes;
         this.RelativeDirectoryPath = relativeDirectoryPath;
+        this.FileCase = fileCaseType;
     }
     Interface.prototype.updateStrapiName = function () {
         this.StrapiName = "api::".concat(this.BaseName, ".").concat(this.BaseName);
@@ -33,12 +37,15 @@ var Interface = /** @class */ (function () {
         return attrs.getDependencies();
     };
     Interface.prototype.getFullInterfaceName = function () {
-        var pascalName = (0, utils_1.pascalCase)(this.BaseName);
+        var pascalName = (0, change_case_1.pascalCase)(this.BaseName);
         return "".concat(this.NamePrefix).concat(pascalName);
     };
+    Interface.prototype.getFileBaseName = function () {
+        return (0, case_1.changeCase)(this.getBaseName(), this.FileCase);
+    };
     // For typescript import from index file
     Interface.prototype.getRelativeRootPath = function () {
-        var path = (0, posix_1.join)(this.RelativeDirectoryPath, this.getBaseName());
+        var path = (0, posix_1.join)(this.RelativeDirectoryPath, this.getFileBaseName());
         return (0, utils_1.prefixDotSlash)(path);
     };
     Interface.prototype.getRelativeRootDir = function () {

package/lib/interface/InterfaceManager.d.ts

@@ -11,13 +11,18 @@ export default class InterfaceManager {
         componentPrefixOverridesPrefix: boolean;
         builtinsPrefix: string;
         builtinsPrefixOverridesPrefix: boolean;
+        deleteOld: boolean;
         prettierFile: any;
+        fileCaseType: string;
+        folderCaseType: string;
     };
     constructor(outRoot: string, strapiSrcRoot: string, options?: any);
+    validateOptions(): void;
     loadPrettierConfig(): Promise<void>;
     createInterfaces(): Promise<void>;
     createBuiltinInterfaces(): void;
     injectDependencies(): void;
+    deleteOldFolders(): Promise<void>;
     makeFolders(): Promise<void>;
     writeInterfaces(): Promise<void>;
     writeIndexFile(): Promise<void>;

package/lib/interface/InterfaceManager.js

@@ -42,12 +42,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var fs_1 = require("fs");
 var promises_1 = require("fs/promises");
 var posix_1 = require("path/posix");
-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 pascal_case_1 = require("pascal-case");
+var case_1 = require("../case");
 var InterfaceManager = /** @class */ (function () {
     function InterfaceManager(outRoot, strapiSrcRoot, options) {
         if (options === void 0) { options = {}; }
@@ -55,7 +56,16 @@ var InterfaceManager = /** @class */ (function () {
         this.OutRoot = outRoot;
         this.StrapiSrcRoot = strapiSrcRoot;
         this.Options = Object.assign({}, InterfaceManager.BaseOptions, options);
+        this.validateOptions();
     }
+    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(', ')));
+        }
+        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(', ')));
+        }
+    };
     InterfaceManager.prototype.loadPrettierConfig = function () {
         return __awaiter(this, void 0, void 0, function () {
             var defaultOptions, resolved;
@@ -93,7 +103,7 @@ var InterfaceManager = /** @class */ (function () {
                         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);
+                            var inter = new Interface_1.default(name, attributes, './', _this.Options.fileCaseType, _this.Options.prefix);
                             _this.Interfaces[strapiName] = inter;
                         });
                         return [4 /*yield*/, componentSchemasPromise];
@@ -104,10 +114,15 @@ var InterfaceManager = /** @class */ (function () {
                             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);
+                                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, case_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;
                             });
                         });
@@ -118,10 +133,11 @@ var InterfaceManager = /** @class */ (function () {
     };
     InterfaceManager.prototype.createBuiltinInterfaces = function () {
         var _this = this;
-        var outDir = './builtins';
+        var outDirName = (0, case_1.changeCase)('builtins', this.Options.folderCaseType);
+        var outDir = "./".concat(outDirName);
         var builtinInterfaces = [];
-        builtinInterfaces.push((0, builtinInterfaces_1.createMediaInterface)(outDir, this.Options.prefix));
-        builtinInterfaces.push((0, builtinInterfaces_1.createMediaFormatInterface)(outDir, this.Options.prefix));
+        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;
         });
@@ -134,36 +150,60 @@ var InterfaceManager = /** @class */ (function () {
             var inter = _this.Interfaces[strapiName];
             var dependencies = inter.getDependencies();
             // console.log(`Interfaces for ${inter.getStrapiName()} are`)
-            var interfacesToInject = dependencies.map(function (dependencyStrapiName) {
+            var interfacesToInject = dependencies
+                .map(function (dependencyStrapiName) {
                 return _this.Interfaces[dependencyStrapiName];
-            }).filter(function (inter) { return inter; });
+            })
+                .filter(function (inter) { return inter; });
             inter.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, builtinsPath;
+            var componentCategories, promises, componentCategoriesPromises, builintsFolderName, builtinsPath;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, schemaReader_1.getComponentCategoryFolders)(this.StrapiSrcRoot)];
+                    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, schemaReader_1.getComponentCategoryFolders)(this.StrapiSrcRoot)];
+                    case 3:
                         componentCategories = _a.sent();
-                        if (!!(0, fs_1.existsSync)(this.OutRoot)) return [3 /*break*/, 3];
+                        if (!!(0, fs_1.existsSync)(this.OutRoot)) return [3 /*break*/, 5];
                         return [4 /*yield*/, (0, promises_1.mkdir)(this.OutRoot, {
                                 recursive: true,
                             })];
-                    case 2:
+                    case 4:
                         _a.sent();
-                        _a.label = 3;
-                    case 3:
+                        _a.label = 5;
+                    case 5:
                         promises = [];
                         componentCategoriesPromises = componentCategories.map(function (category) { return __awaiter(_this, void 0, void 0, function () {
-                            var path;
+                            var folderName, path;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
                                     case 0:
-                                        path = (0, posix_1.join)(this.OutRoot, category);
+                                        folderName = (0, case_1.changeCase)(category, this.Options.folderCaseType);
+                                        path = (0, posix_1.join)(this.OutRoot, folderName);
                                         if ((0, fs_1.existsSync)(path)) {
                                             return [2 /*return*/];
                                         }
@@ -175,12 +215,13 @@ var InterfaceManager = /** @class */ (function () {
                             });
                         }); });
                         promises.push.apply(promises, componentCategoriesPromises);
-                        builtinsPath = (0, posix_1.join)(this.OutRoot, 'builtins');
+                        builintsFolderName = (0, case_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)((0, posix_1.join)(this.OutRoot, 'builtins')));
+                            promises.push((0, promises_1.mkdir)(builtinsPath));
                         }
                         return [4 /*yield*/, Promise.all(promises)];
-                    case 4:
+                    case 6:
                         _a.sent();
                         return [2 /*return*/];
                 }
@@ -279,7 +320,10 @@ var InterfaceManager = /** @class */ (function () {
         componentPrefixOverridesPrefix: false,
         builtinsPrefix: '',
         builtinsPrefixOverridesPrefix: false,
+        deleteOld: false,
         prettierFile: null,
+        fileCaseType: 'pascal',
+        folderCaseType: 'kebab',
     };
     return InterfaceManager;
 }());

package/lib/interface/builtinInterfaces.d.ts

@@ -1,4 +1,5 @@
-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;
+import { caseType } from '../case';
+import BuiltinComponentInterface from './BuiltinComponentInterface';
+import BuiltinInterface from './BuiltinInterface';
+export declare function createMediaInterface(directory: string, caseTypeName: caseType, prefix: string): BuiltinInterface;
+export declare function createMediaFormatInterface(directory: string, caseTypeName: caseType, prefix: string): BuiltinComponentInterface;

package/lib/interface/builtinInterfaces.js

@@ -6,32 +6,32 @@ 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) {
+function createMediaInterface(directory, caseTypeName, prefix) {
     var stringFields = [
-        "name",
-        "alternativeText",
-        "caption",
-        "hash",
-        "ext",
-        "mime",
-        "url",
-        "previewUrl",
-        "provider",
+        'name',
+        'alternativeText',
+        'caption',
+        'hash',
+        'ext',
+        'mime',
+        'url',
+        'previewUrl',
+        'provider',
     ];
     var numberFields = [
-        "width",
-        "height",
-        "size",
+        'width',
+        'height',
+        'size',
     ];
     var mediaFormat = {
-        type: "component",
+        type: 'component',
         repeatable: false,
-        component: "builtins::MediaFormat",
+        component: 'builtins::MediaFormat',
     };
     var mediaAttrs = {
         formats: {
             // types-4-strapi-2 specific
-            type: "nested",
+            type: 'nested',
             fields: {
                 thumbnail: mediaFormat,
                 medium: mediaFormat,
@@ -39,8 +39,12 @@ function createMediaInterface(directory, prefix) {
             },
         },
     };
-    stringFields.forEach(function (s) { return mediaAttrs[s] = { type: "string" }; });
-    numberFields.forEach(function (s) { return mediaAttrs[s] = { type: "integer" }; });
+    stringFields.forEach(function (s) {
+        mediaAttrs[s] = { type: 'string' };
+    });
+    numberFields.forEach(function (s) {
+        mediaAttrs[s] = { type: 'integer' };
+    });
     // const dataAttrs = {
     //     data: {
     //         type: "nested",
@@ -48,26 +52,30 @@ function createMediaInterface(directory, prefix) {
     //         nullable: true,
     //     },
     // };
-    return new BuiltinInterface_1.default("Media", mediaAttrs, directory, prefix);
+    return new BuiltinInterface_1.default('Media', mediaAttrs, directory, caseTypeName, prefix);
 }
 exports.createMediaInterface = createMediaInterface;
-function createMediaFormatInterface(directory, prefix) {
+function createMediaFormatInterface(directory, caseTypeName, prefix) {
     var stringFields = [
-        "name",
-        "hash",
-        "ext",
-        "mime",
-        "path",
-        "url",
+        'name',
+        'hash',
+        'ext',
+        'mime',
+        'path',
+        'url',
     ];
     var numberFields = [
-        "width",
-        "height",
-        "size",
+        '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);
+    stringFields.forEach(function (s) {
+        mediaAttrs[s] = { type: 'string' };
+    });
+    numberFields.forEach(function (s) {
+        mediaAttrs[s] = { type: 'integer' };
+    });
+    return new BuiltinComponentInterface_1.default('MediaFormat', mediaAttrs, directory, caseTypeName, prefix);
 }
 exports.createMediaFormatInterface = createMediaFormatInterface;

package/lib/utils/index.d.ts

@@ -1,3 +1,2 @@
-export declare function pascalCase(name: string): string;
 export declare function readDirFiltered(dir: string): Promise<string[]>;
 export declare function prefixDotSlash(path: any): any;

package/lib/utils/index.js

@@ -36,17 +36,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prefixDotSlash = exports.readDirFiltered = exports.pascalCase = void 0;
+exports.prefixDotSlash = exports.readDirFiltered = void 0;
 var promises_1 = require("fs/promises");
-function pascalCase(name) {
-    var words = name.match(/[a-z]+/gi);
-    var pascalName = words.map(function (word) {
-        return word.charAt(0).toUpperCase() + word.substring(1).toLowerCase();
-    }).join("");
-    // console.log(pascalName)
-    return pascalName;
-}
-exports.pascalCase = pascalCase;
 function readDirFiltered(dir) {
     return __awaiter(this, void 0, void 0, function () {
         var folders;
@@ -55,13 +46,13 @@ function readDirFiltered(dir) {
                 case 0: return [4 /*yield*/, (0, promises_1.readdir)(dir)];
                 case 1:
                     folders = _a.sent();
-                    return [2 /*return*/, folders.filter(function (folder) { return !folder.startsWith("."); })];
+                    return [2 /*return*/, folders.filter(function (folder) { return !folder.startsWith('.'); })];
             }
         });
     });
 }
 exports.readDirFiltered = readDirFiltered;
 function prefixDotSlash(path) {
-    return (/^\.?\.\//).test(path) ? path : "./" + path;
+    return (/^\.?\.\//).test(path) ? path : './' + path;
 }
 exports.prefixDotSlash = prefixDotSlash;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oak-digital/types-4-strapi-2",
-  "version": "0.2.5",
+  "version": "0.2.8",
   "description": "Typescript interface generator for Strapi 4 models",
   "bin": {
     "t4s": "./bin/index.js"
@@ -36,6 +36,7 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
+    "change-case": "^4.1.2",
     "commander": "^9.4.0",
     "prettier": "^2.7.1"
   }