@oak-digital/types-4-strapi-2 0.4.0 → 0.5.1

package/lib/attributes/Attributes.js

@@ -13,6 +13,7 @@ var Attributes = /** @class */ (function () {
             case 'nested':
                 // we need to check equality since it could be undefined
                 return attr.nullable === true;
+            case 'media': // media is also always populatable
             case 'component':
             case 'dynamiczone':
             case 'relation':
@@ -82,12 +83,14 @@ var Attributes = /** @class */ (function () {
     };
     Attributes.prototype.attributeToString = function (attrName, attr) {
         var _this = this;
-        var _a, _b, _c, _d;
+        var _a, _b, _c;
         var isPopulatable = this.isAttributePopulatable(attr);
         var isOptional = isPopulatable;
         var optionalString = isOptional ? '?' : '';
         var orNull = ' | null';
-        var requiredString = attr.required !== true ? orNull : '';
+        // TODO: only add this in non paranoid mode
+        /* const requiredString = attr.required !== true ? orNull : ''; */
+        var requiredString = (attr === null || attr === void 0 ? void 0 : attr[constants_1.CERTAINLY_REQUIRED_KEY]) === true ? '' : orNull;
         var str = "    ".concat(attrName).concat(optionalString, ": ");
         var isArray = false;
         switch (attr.type) {
@@ -123,8 +126,13 @@ var Attributes = /** @class */ (function () {
                 var relationNameObj = this.RelationNames[componentName];
                 /* console.log(this.RelationNames); */
                 var dependencyComponentName = relationNameObj.name;
-                isArray = (_d = attr.repeatable) !== null && _d !== void 0 ? _d : false;
+                /* isArray = attr.repeatable ?? false; */
+                isArray = false; // we already handle this here.
                 str += dependencyComponentName;
+                if (attr.repeatable) {
+                    str += '[]';
+                }
+                str += requiredString; // resolves #20. components can be null.
                 break;
             case 'media':
                 var mediaMultipleString = attr.multiple

package/lib/constants.d.ts

@@ -1 +1,2 @@
 export declare const POPULATE_GENERIC_NAME = "Populate";
+export declare const CERTAINLY_REQUIRED_KEY = "__t4s_required";

package/lib/constants.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.POPULATE_GENERIC_NAME = void 0;
+exports.CERTAINLY_REQUIRED_KEY = exports.POPULATE_GENERIC_NAME = void 0;
 exports.POPULATE_GENERIC_NAME = 'Populate';
+exports.CERTAINLY_REQUIRED_KEY = '__t4s_required';

package/lib/interface/builtinInterfaces.js

@@ -4,21 +4,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createMediaFormatInterface = exports.createMediaInterface = void 0;
+var constants_1 = require("../constants");
 var BuiltinComponentInterface_1 = __importDefault(require("./BuiltinComponentInterface"));
 var BuiltinInterface_1 = __importDefault(require("./BuiltinInterface"));
 function createMediaInterface(directory, caseTypeName, prefix) {
     var stringRequiredFields = [
         'name',
-        'alternativeText',
-        'caption',
         'hash',
         'ext',
         'mime',
         'url',
         'provider',
     ];
-    var stringFields = ['previewUrl', 'provider_metadata'];
-    var numberFields = ['width', 'height', 'size'];
+    var stringFields = [
+        'previewUrl',
+        'provider_metadata',
+        'alternativeText',
+        'caption', // nullable in plain text
+    ];
+    var numberRequiredFields = ['size'];
+    // Nullable if you have a plain text file
+    var numberFields = ['width', 'height'];
     var mediaFormat = {
         type: 'component',
         repeatable: false,
@@ -38,13 +44,28 @@ function createMediaInterface(directory, caseTypeName, prefix) {
         },
     };
     stringRequiredFields.forEach(function (s) {
-        mediaAttrs[s] = { type: 'string', required: true };
+        var _a;
+        mediaAttrs[s] = (_a = {
+                type: 'string',
+                required: true
+            },
+            _a[constants_1.CERTAINLY_REQUIRED_KEY] = true,
+            _a);
     });
     stringFields.forEach(function (s) {
         mediaAttrs[s] = { type: 'string' };
     });
     numberFields.forEach(function (s) {
-        mediaAttrs[s] = { type: 'integer', required: true };
+        mediaAttrs[s] = { type: 'integer' };
+    });
+    numberRequiredFields.forEach(function (s) {
+        var _a;
+        mediaAttrs[s] = (_a = {
+                type: 'integer',
+                required: true
+            },
+            _a[constants_1.CERTAINLY_REQUIRED_KEY] = true,
+            _a);
     });
     // const dataAttrs = {
     //     data: {

package/package.json

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