@oak-digital/types-4-strapi-2 0.2.3 → 0.2.6

package/README.md

@@ -45,11 +45,18 @@ This can be done with the `--out` flag like in the following example.
 
 ### Planned features
 
+* 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**                                                                    |
+|-----------------------------|------------------------------------------------------------------------------------|
+| -i, --in <dir>              | The src directory for strapi                                                       |
+| -o, --out <dir>             | The output directory to output the types to                                        |
+| --component-prefix <prefix> | A prefix for components                                                            |
+| -D, --delete-old            | CAUTION: This option is equivalent to running rm -rf on the output directory first |
+| --prettier <file>           | The prettier config file to use for formatting typescript interfaces               |
 
 ## Building
 

package/lib/index.js

@@ -11,13 +11,15 @@ 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('--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('--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, prettierFile = options.prettier, deleteOld = options.deleteOld;
 var manager = new InterfaceManager_1.default(out, input, {
     componentPrefix: componentPrefix,
     prettierFile: prettierFile,
+    deleteOld: deleteOld,
 });
 manager.run().catch(function (err) {
     console.error(err);

package/lib/interface/Attributes.d.ts

@@ -1,4 +1,4 @@
-import { RelationNames } from "./Interface";
+import { RelationNames } from './Interface';
 export default class Attributes {
     Attrs: Record<string, Record<string, any>>;
     private RelationNames;

package/lib/interface/Attributes.js

@@ -9,11 +9,11 @@ var Attributes = /** @class */ (function () {
     Attributes.prototype.isAttributeOptional = function (attr) {
         // If it is a component / relation / dynamiczone it is always optional due to population
         switch (attr.type) {
-            case "nested":
+            case 'nested':
                 return attr.nullable === true;
-            case "component":
-            case "dynamiczone":
-            case "relation":
+            case 'component':
+            case 'dynamiczone':
+            case 'relation':
                 return true;
             default:
                 break;
@@ -26,18 +26,18 @@ var Attributes = /** @class */ (function () {
             var attr = this.Attrs[attrName];
             var dependencyNames = [];
             switch (attr.type) {
-                case "nested":
+                case 'nested':
                     var attrs = new Attributes(attr.fields, this.RelationNames);
                     dependencyNames.push.apply(dependencyNames, attrs.getDependencies());
                     break;
-                case "relation":
+                case 'relation':
                     dependencyNames.push(attr.target);
                     break;
-                case "component":
+                case 'component':
                     dependencyNames.push(attr.component);
                     break;
-                case "media":
-                    dependencyNames.push("builtins::Media");
+                case 'media':
+                    dependencyNames.push('builtins::Media');
                     break;
                 default:
                     continue;
@@ -55,70 +55,70 @@ var Attributes = /** @class */ (function () {
         return dependencies;
     };
     Attributes.prototype.attributeToString = function (attrName, attr) {
-        var _a, _b;
+        var _a;
         var optionalString = this.isAttributeOptional(attr) ? '?' : '';
         var str = "    ".concat(attrName).concat(optionalString, ": ");
         var isArray = false;
         switch (attr.type) {
             // types-4-strapi-2 specific, used for builtin types
-            case "nested":
+            case 'nested':
                 // Be careful with recursion
                 // console.log(attr);
                 var newAttrs = new Attributes(attr.fields, this.RelationNames);
                 str += newAttrs.toString();
                 break;
-            case "relation":
+            case 'relation':
                 var apiName = attr.target;
                 // console.log(this.RelationNames, apiName)
                 var dependencyName = this.RelationNames[apiName].name;
-                isArray = attr.relation.endsWith("ToMany");
-                str += dependencyName;
+                var relationMultipleString = attr.relation.endsWith('ToMany') ? '[]' : ' | null';
+                str += "{ data: ".concat(dependencyName).concat(relationMultipleString, "; }");
                 break;
-            case "component":
+            case 'component':
                 var componentName = attr.component;
                 var relationNameObj = this.RelationNames[componentName];
                 var dependencyComponentName = relationNameObj.name;
                 isArray = (_a = attr.repeatable) !== null && _a !== void 0 ? _a : false;
                 str += dependencyComponentName;
                 break;
-            case "media":
-                var mediaOptional = attr.required !== true ? "?" : "";
-                str += "{ data".concat(mediaOptional, ": ").concat(this.RelationNames["builtins::Media"].name, "; }");
-                isArray = (_b = attr.multiple) !== null && _b !== void 0 ? _b : false;
+            case 'media':
+                var mediaOptional = attr.required !== true ? ' | null' : '';
+                var mediaMultipleString = attr.multiple ? '[]' : mediaOptional;
+                str += "{ data: ".concat(this.RelationNames['builtins::Media'].name).concat(mediaMultipleString, "; }");
                 break;
-            case "password":
+            case 'password':
                 return null;
-            case "enumeration":
-                var hasDefault = "default" in attr;
+            case 'enumeration':
+                var hasDefault = 'default' in attr;
                 var enums = attr.enum.map(function (en) { return "\"".concat(en, "\""); });
-                enums.push("null");
-                var typeString = enums.join(" | ");
+                enums.push('null');
+                var typeString = enums.join(' | ');
                 str += typeString;
                 break;
-            case "string":
-            case "text":
-            case "richtext":
-            case "email":
-            case "uid":
-                str += "string";
+            case 'string':
+            case 'text':
+            case 'richtext':
+            case 'email':
+            case 'uid':
+                str += 'string';
                 break;
-            case "integer":
-            case "biginteger":
-            case "decimal":
-            case "float":
-                str += "number";
+            case 'integer':
+            case 'biginteger':
+            case 'decimal':
+            case 'float':
+                str += 'number';
                 break;
-            case "date":
-            case "datetime":
-            case "time":
-                str += "Date";
+            case 'date':
+            case 'datetime':
+            case 'time':
+                str += 'Date';
                 break;
-            case "boolean":
+            case 'boolean':
                 str += attr.type;
                 break;
-            case "json":
+            case 'json':
             default:
-                str += "any";
+                str += 'any';
                 break;
         }
         var isArrayString = isArray ? '[]' : '';
@@ -135,13 +135,13 @@ var Attributes = /** @class */ (function () {
             }
             strings.push(attrString);
         }
-        return strings.map(function (s) { return "".concat(s, "\n"); }).join("");
+        return strings.map(function (s) { return "".concat(s, "\n"); }).join('');
     };
     Attributes.prototype.toString = function () {
-        var strings = ["{"];
+        var strings = ['{'];
         strings.push(this.toFieldsString());
-        strings.push("}");
-        return strings.join("\n");
+        strings.push('}');
+        return strings.join('\n');
     };
     return Attributes;
 }());

package/lib/interface/InterfaceManager.d.ts

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

package/lib/interface/InterfaceManager.js

@@ -140,23 +140,44 @@ var InterfaceManager = /** @class */ (function () {
             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 _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;
@@ -180,7 +201,7 @@ var InterfaceManager = /** @class */ (function () {
                             promises.push((0, promises_1.mkdir)((0, posix_1.join)(this.OutRoot, 'builtins')));
                         }
                         return [4 /*yield*/, Promise.all(promises)];
-                    case 4:
+                    case 6:
                         _a.sent();
                         return [2 /*return*/];
                 }
@@ -279,6 +300,7 @@ var InterfaceManager = /** @class */ (function () {
         componentPrefixOverridesPrefix: false,
         builtinsPrefix: '',
         builtinsPrefixOverridesPrefix: false,
+        deleteOld: false,
         prettierFile: null,
     };
     return InterfaceManager;

package/package.json

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