@oak-digital/types-4-strapi-2 0.3.1 → 0.3.3

package/README.md

@@ -5,6 +5,10 @@ This can be useful if you have a frontend written with TypeScript to make sure y
 
 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.
 
+## Requirements
+
+* Node `>=v16`
+
 ## Getting started
 
 Install the script for your project:

package/lib/case/index.d.ts

@@ -1,4 +1,4 @@
-export declare const caseTypesArray: string[];
+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/interface/InterfaceManager.d.ts

@@ -13,8 +13,8 @@ export default class InterfaceManager {
         builtinsPrefixOverridesPrefix: boolean;
         deleteOld: boolean;
         prettierFile: any;
-        fileCaseType: string;
-        folderCaseType: string;
+        fileCaseType: "camel" | "capital" | "dot" | "snake" | "pascal" | "constant" | "kebab";
+        folderCaseType: "camel" | "capital" | "dot" | "snake" | "pascal" | "constant" | "kebab";
     };
     constructor(outRoot: string, strapiSrcRoot: string, options?: any);
     validateOptions(): void;

package/lib/interface/builtinInterfaces.js

@@ -7,7 +7,7 @@ exports.createMediaFormatInterface = exports.createMediaInterface = void 0;
 var BuiltinComponentInterface_1 = __importDefault(require("./BuiltinComponentInterface"));
 var BuiltinInterface_1 = __importDefault(require("./BuiltinInterface"));
 function createMediaInterface(directory, caseTypeName, prefix) {
-    var stringFields = [
+    var stringRequiredFields = [
         'name',
         'alternativeText',
         'caption',
@@ -15,14 +15,10 @@ function createMediaInterface(directory, caseTypeName, prefix) {
         'ext',
         'mime',
         'url',
-        'previewUrl',
         'provider',
     ];
-    var numberFields = [
-        'width',
-        'height',
-        'size',
-    ];
+    var stringFields = ['previewUrl', 'provider_metadata'];
+    var numberFields = ['width', 'height', 'size'];
     var mediaFormat = {
         type: 'component',
         repeatable: false,
@@ -41,11 +37,14 @@ function createMediaInterface(directory, caseTypeName, prefix) {
             },
         },
     };
+    stringRequiredFields.forEach(function (s) {
+        mediaAttrs[s] = { type: 'string', required: true };
+    });
     stringFields.forEach(function (s) {
         mediaAttrs[s] = { type: 'string' };
     });
     numberFields.forEach(function (s) {
-        mediaAttrs[s] = { type: 'integer' };
+        mediaAttrs[s] = { type: 'integer', required: true };
     });
     // const dataAttrs = {
     //     data: {
@@ -58,25 +57,18 @@ function createMediaInterface(directory, caseTypeName, prefix) {
 }
 exports.createMediaInterface = createMediaInterface;
 function createMediaFormatInterface(directory, caseTypeName, prefix) {
-    var stringFields = [
-        'name',
-        'hash',
-        'ext',
-        'mime',
-        'path',
-        'url',
-    ];
-    var numberFields = [
-        'width',
-        'height',
-        'size',
-    ];
+    var stringRequiredFields = ['name', 'hash', 'ext', 'mime', 'url'];
+    var stringFields = ['path'];
+    var numberFields = ['width', 'height', 'size'];
     var mediaAttrs = {};
+    stringRequiredFields.forEach(function (s) {
+        mediaAttrs[s] = { type: 'string', required: true };
+    });
     stringFields.forEach(function (s) {
         mediaAttrs[s] = { type: 'string' };
     });
     numberFields.forEach(function (s) {
-        mediaAttrs[s] = { type: 'integer' };
+        mediaAttrs[s] = { type: 'integer', required: true };
     });
     return new BuiltinComponentInterface_1.default('MediaFormat', mediaAttrs, directory, caseTypeName, prefix);
 }

package/lib/plugins/index.d.ts

@@ -0,0 +1,2 @@
+import { SupportedPluginNamesType } from "./types";
+export declare const registerPlugins: (pluginNames: Set<SupportedPluginNamesType>) => void;

package/lib/plugins/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerPlugins = void 0;
+var registerPlugins = function (pluginNames) {
+    if (pluginNames.has('url-alias')) {
+    }
+};
+exports.registerPlugins = registerPlugins;

package/lib/plugins/types.d.ts

@@ -0,0 +1,2 @@
+export declare const supportedPluginNames: readonly ["url-alias"];
+export declare type SupportedPluginNamesType = typeof supportedPluginNames[number];

package/lib/plugins/types.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.supportedPluginNames = void 0;
+exports.supportedPluginNames = [
+    'url-alias',
+];

package/package.json

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