@oak-digital/types-4-strapi-2 0.5.4 → 1.0.0-beta.1

package/tests/strapi-project/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "strapi-project",
+  "private": true,
+  "version": "0.1.0",
+  "description": "A Strapi application",
+  "scripts": {
+    "develop": "strapi develop",
+    "start": "strapi start",
+    "build": "strapi build",
+    "strapi": "strapi"
+  },
+  "devDependencies": {},
+  "dependencies": {
+    "@strapi/strapi": "4.10.5",
+    "@strapi/plugin-users-permissions": "4.10.5",
+    "@strapi/plugin-i18n": "4.10.5",
+    "better-sqlite3": "8.0.1"
+  },
+  "author": {
+    "name": "A Strapi developer"
+  },
+  "strapi": {
+    "uuid": "06c55e27-9078-4e51-a92e-0f4c5b1fdea4"
+  },
+  "engines": {
+    "node": ">=14.19.1 <=18.x.x",
+    "npm": ">=6.0.0"
+  },
+  "license": "MIT"
+}

package/tests/strapi-project/public/robots.txt

@@ -0,0 +1,3 @@
+# To prevent search engines from seeing the site altogether, uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

package/tests/strapi-project/src/admin/app.example.tsx

@@ -0,0 +1,35 @@
+export default {
+  config: {
+    locales: [
+      // 'ar',
+      // 'fr',
+      // 'cs',
+      // 'de',
+      // 'dk',
+      // 'es',
+      // 'he',
+      // 'id',
+      // 'it',
+      // 'ja',
+      // 'ko',
+      // 'ms',
+      // 'nl',
+      // 'no',
+      // 'pl',
+      // 'pt-BR',
+      // 'pt',
+      // 'ru',
+      // 'sk',
+      // 'sv',
+      // 'th',
+      // 'tr',
+      // 'uk',
+      // 'vi',
+      // 'zh-Hans',
+      // 'zh',
+    ],
+  },
+  bootstrap(app) {
+    console.log(app);
+  },
+};

package/tests/strapi-project/src/admin/webpack.config.example.js

@@ -0,0 +1,9 @@
+'use strict';
+
+/* eslint-disable no-unused-vars */
+module.exports = (config, webpack) => {
+  // Note: we provide webpack above so you should not `require` it
+  // Perform customizations to webpack config
+  // Important: return the modified config
+  return config;
+};

package/tests/strapi-project/src/api/collection-1/content-types/collection-1/schema.json

@@ -0,0 +1,18 @@
+{
+  "kind": "collectionType",
+  "collectionName": "collection_1s",
+  "info": {
+    "singularName": "collection-1",
+    "pluralName": "collection-1s",
+    "displayName": "Collection 1"
+  },
+  "options": {
+    "draftAndPublish": true
+  },
+  "pluginOptions": {},
+  "attributes": {
+    "text": {
+      "type": "string"
+    }
+  }
+}

package/tests/strapi-project/src/api/collection-1/content-types/generated-type/schema.json

@@ -0,0 +1,18 @@
+{
+  "kind": "collectionType",
+  "collectionName": "generated_types",
+  "info": {
+    "singularName": "generated-type",
+    "pluralName": "generated-types",
+    "displayName": "Generated type"
+  },
+  "options": {
+    "draftAndPublish": false,
+    "comment": ""
+  },
+  "attributes": {
+    "text": {
+      "type": "string"
+    }
+  }
+}

package/tests/strapi-project/src/api/collection-1/controllers/collection-1.ts

@@ -0,0 +1,7 @@
+/**
+ * collection-1 controller
+ */
+
+import { factories } from '@strapi/strapi'
+
+export default factories.createCoreController('api::collection-1.collection-1');

package/tests/strapi-project/src/api/collection-1/controllers/generated-type.ts

@@ -0,0 +1,7 @@
+/**
+ *  controller
+ */
+
+import { factories } from '@strapi/strapi'
+
+export default factories.createCoreController('api::collection-1.generated-type');

package/tests/strapi-project/src/api/collection-1/routes/collection-1.ts

@@ -0,0 +1,7 @@
+/**
+ * collection-1 router
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreRouter('api::collection-1.collection-1');

package/tests/strapi-project/src/api/collection-1/routes/generated-type.ts

@@ -0,0 +1,7 @@
+/**
+ *  router
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreRouter('api::collection-1.generated-type');

package/tests/strapi-project/src/api/collection-1/services/collection-1.ts

@@ -0,0 +1,7 @@
+/**
+ * collection-1 service
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreService('api::collection-1.collection-1');

package/tests/strapi-project/src/api/collection-1/services/generated-type.ts

@@ -0,0 +1,7 @@
+/**
+ *  service
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreService('api::collection-1.generated-type');

package/tests/strapi-project/src/api/standalone-controller/controllers/standalone-controller.ts

@@ -0,0 +1,13 @@
+/**
+ * A set of functions called "actions" for `standalone-controller`
+ */
+
+export default {
+  // exampleAction: async (ctx, next) => {
+  //   try {
+  //     ctx.body = 'ok';
+  //   } catch (err) {
+  //     ctx.body = err;
+  //   }
+  // }
+};

package/tests/strapi-project/src/components/my-category/all-types.json

@@ -0,0 +1,88 @@
+{
+  "collectionName": "components_my_category_all_types",
+  "info": {
+    "displayName": "All types",
+    "description": ""
+  },
+  "options": {},
+  "attributes": {
+    "text": {
+      "type": "string"
+    },
+    "email": {
+      "type": "email"
+    },
+    "rich": {
+      "type": "richtext"
+    },
+    "pswd": {
+      "type": "password"
+    },
+    "int": {
+      "type": "integer"
+    },
+    "bigint": {
+      "type": "biginteger"
+    },
+    "decimal": {
+      "type": "decimal"
+    },
+    "float": {
+      "type": "float"
+    },
+    "enum": {
+      "type": "enumeration",
+      "enum": [
+        "a",
+        "b",
+        "c"
+      ]
+    },
+    "date": {
+      "type": "date"
+    },
+    "datetime": {
+      "type": "datetime"
+    },
+    "time": {
+      "type": "time"
+    },
+    "multipleMedia": {
+      "type": "media",
+      "multiple": true,
+      "required": false,
+      "allowedTypes": [
+        "images",
+        "files",
+        "videos",
+        "audios"
+      ]
+    },
+    "singleImage": {
+      "type": "media",
+      "multiple": false,
+      "required": false,
+      "allowedTypes": [
+        "images"
+      ]
+    },
+    "bool": {
+      "type": "boolean",
+      "required": true
+    },
+    "json": {
+      "type": "json"
+    },
+    "repeatable": {
+      "displayName": "subComponent",
+      "type": "component",
+      "repeatable": true,
+      "component": "other-category.sub-component"
+    },
+    "component": {
+      "type": "component",
+      "repeatable": false,
+      "component": "other-category.sub-component"
+    }
+  }
+}

package/tests/strapi-project/src/components/other-category/sub-component.json

@@ -0,0 +1,12 @@
+{
+  "collectionName": "components_other_category_sub_components",
+  "info": {
+    "displayName": "subComponent"
+  },
+  "options": {},
+  "attributes": {
+    "text": {
+      "type": "string"
+    }
+  }
+}

package/tests/strapi-project/src/index.ts

@@ -0,0 +1,18 @@
+export default {
+  /**
+   * An asynchronous register function that runs before
+   * your application is initialized.
+   *
+   * This gives you an opportunity to extend code.
+   */
+  register(/*{ strapi }*/) {},
+
+  /**
+   * An asynchronous bootstrap function that runs before
+   * your application gets started.
+   *
+   * This gives you an opportunity to set up your data model,
+   * run jobs, or perform some special logic.
+   */
+  bootstrap(/*{ strapi }*/) {},
+};

package/lib/.prettierrc.json

@@ -1,7 +0,0 @@
-{
-    "parser": "typescript",
-    "semi": true,
-    "singleQuote": true,
-    "bracketSameLine": false,
-    "trailingComma": "es5"
-}

package/lib/case/index.d.ts

@@ -1,4 +0,0 @@
-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/case/index.js

@@ -1,47 +0,0 @@
-"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/interface/Attributes.d.ts

@@ -1,11 +0,0 @@
-import { RelationNames } from './Interface';
-export default class Attributes {
-    Attrs: Record<string, Record<string, any>>;
-    private RelationNames;
-    constructor(attr: Record<string, Record<string, any>>, relationNames: RelationNames);
-    isAttributeOptional(attr: any): boolean;
-    getDependencies(): any[];
-    attributeToString(attrName: string, attr: any): string;
-    toFieldsString(): string;
-    toString(): string;
-}

package/lib/interface/Attributes.js

@@ -1,167 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var Attributes = /** @class */ (function () {
-    function Attributes(attr, relationNames) {
-        this.RelationNames = {};
-        this.Attrs = attr;
-        this.RelationNames = relationNames;
-    }
-    Attributes.prototype.isAttributeOptional = function (attr) {
-        // If it is a component / relation / dynamiczone it is always optional due to population
-        switch (attr.type) {
-            case 'nested':
-                return attr.nullable === true;
-            case 'component':
-            case 'dynamiczone':
-            case 'relation':
-                return true;
-            default:
-                break;
-        }
-        return false;
-    };
-    Attributes.prototype.getDependencies = function () {
-        var dependencies = [];
-        for (var attrName in this.Attrs) {
-            var attr = this.Attrs[attrName];
-            var dependencyNames = [];
-            switch (attr.type) {
-                case 'nested':
-                    var attrs = new Attributes(attr.fields, this.RelationNames);
-                    dependencyNames.push.apply(dependencyNames, attrs.getDependencies());
-                    break;
-                case 'relation':
-                    dependencyNames.push(attr.target);
-                    break;
-                case 'component':
-                    dependencyNames.push(attr.component);
-                    break;
-                case 'media':
-                    dependencyNames.push('builtins::Media');
-                    break;
-                case 'dynamiczone':
-                    dependencyNames.push.apply(dependencyNames, attr.components);
-                    break;
-                default:
-                    continue;
-            }
-            // // If the current dependency is the interface itself, do not report it as a dependency
-            // if (dependencyName === strapiName) {
-            //     continue;
-            // }
-            dependencyNames.forEach(function (dependencyName) {
-                if (!dependencies.includes(dependencyName)) {
-                    dependencies.push(dependencyName);
-                }
-            });
-        }
-        return dependencies;
-    };
-    Attributes.prototype.attributeToString = function (attrName, attr) {
-        var _this = this;
-        var _a, _b, _c, _d;
-        var optionalString = this.isAttributeOptional(attr) ? '?' : '';
-        var orNull = ' | null';
-        var requiredString = attr.required !== true ? orNull : '';
-        var str = "    ".concat(attrName).concat(optionalString, ": ");
-        var isArray = false;
-        switch (attr.type) {
-            // types-4-strapi-2 specific, used for builtin types
-            case 'nested':
-                // Be careful with recursion
-                // console.log(attr);
-                var nullableString = ((_a = attr === null || attr === void 0 ? void 0 : attr.nullable) !== null && _a !== void 0 ? _a : false) ? ' | null' : '';
-                var newAttrs = new Attributes(attr.fields, this.RelationNames);
-                str += newAttrs.toString() + nullableString;
-                break;
-            case 'relation':
-                var apiName = attr.target;
-                // console.log(this.RelationNames, apiName)
-                var dependencyName = (_c = (_b = this.RelationNames[apiName]) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : 'any';
-                var relationMultipleString = attr.relation.endsWith('ToMany') ? '[]' : orNull;
-                str += "{ data: ".concat(dependencyName).concat(relationMultipleString, "; }");
-                break;
-            case 'component':
-                var componentName = attr.component;
-                var relationNameObj = this.RelationNames[componentName];
-                var dependencyComponentName = relationNameObj.name;
-                isArray = (_d = attr.repeatable) !== null && _d !== void 0 ? _d : false;
-                str += dependencyComponentName;
-                break;
-            case 'media':
-                var mediaMultipleString = attr.multiple ? '[]' : requiredString;
-                str += "{ data: ".concat(this.RelationNames['builtins::Media'].name).concat(mediaMultipleString, "; }");
-                break;
-            case 'password':
-                return null;
-            case 'enumeration':
-                var hasDefault = 'default' in attr;
-                var enums = attr.enum.map(function (en) { return "\"".concat(en, "\""); });
-                enums.push('null');
-                var typeString = enums.join(' | ');
-                str += typeString;
-                break;
-            case 'dynamiczone':
-                // console.log(attr.components);
-                var relations = attr.components
-                    .map(function (componentName) { return _this.RelationNames[componentName].name; });
-                // console.log(relations);
-                var relationsString = relations.join(' | ');
-                // console.log(relationsString);
-                str += "Array<".concat(relationsString, ">");
-                break;
-            case 'string':
-            case 'text':
-            case 'richtext':
-            case 'email':
-            case 'uid':
-                str += 'string';
-                str += requiredString;
-                break;
-            case 'integer':
-            case 'biginteger':
-            case 'decimal':
-            case 'float':
-                str += 'number';
-                str += requiredString;
-                break;
-            case 'date':
-            case 'datetime':
-            case 'time':
-                str += 'string';
-                str += requiredString;
-                break;
-            case 'boolean':
-                str += attr.type;
-                str += requiredString;
-                break;
-            case 'json':
-            default:
-                str += 'any';
-                break;
-        }
-        var isArrayString = isArray ? '[]' : '';
-        str += "".concat(isArrayString, ";");
-        return str;
-    };
-    Attributes.prototype.toFieldsString = function () {
-        var strings = [];
-        for (var attrName in this.Attrs) {
-            var attr = this.Attrs[attrName];
-            var attrString = this.attributeToString(attrName, attr);
-            if (attrString === null) {
-                continue;
-            }
-            strings.push(attrString);
-        }
-        return strings.map(function (s) { return "".concat(s, "\n"); }).join('');
-    };
-    Attributes.prototype.toString = function () {
-        var strings = ['{'];
-        strings.push(this.toFieldsString());
-        strings.push('}');
-        return strings.join('\n');
-    };
-    return Attributes;
-}());
-exports.default = Attributes;

package/lib/interface/InterfaceManager.d.ts

@@ -1,39 +0,0 @@
-/// <reference types="node" />
-import EventEmitter from 'events';
-export default class InterfaceManager {
-    private Interfaces;
-    private OutRoot;
-    private StrapiSrcRoot;
-    private Options;
-    private PrettierOptions;
-    eventEmitter: EventEmitter;
-    static BaseOptions: {
-        prefix: string;
-        useCategoryPrefix: boolean;
-        componentPrefix: string;
-        componentPrefixOverridesPrefix: boolean;
-        builtinsPrefix: string;
-        builtinsPrefixOverridesPrefix: boolean;
-        deleteOld: boolean;
-        prettierFile: any;
-        fileCaseType: "pascal" | "camel" | "capital" | "dot" | "snake" | "constant" | "kebab";
-        folderCaseType: "pascal" | "camel" | "capital" | "dot" | "snake" | "constant" | "kebab";
-        enabledPlugins: "url-alias"[];
-    };
-    constructor(outRoot: string, strapiSrcRoot: string, options?: Partial<typeof InterfaceManager['BaseOptions']>);
-    registerPlugins(): void;
-    validateOptions(): void;
-    loadPrettierConfig(): Promise<void>;
-    readSchemas(): Promise<{
-        apiSchemas: any[];
-        componentSchemas: any[];
-    }>;
-    createInterfaces(): Promise<void>;
-    createBuiltinInterfaces(): void;
-    injectDependencies(): void;
-    deleteOldFolders(): Promise<void>;
-    makeFolders(): Promise<void>;
-    writeInterfaces(): Promise<void>;
-    writeIndexFile(): Promise<void>;
-    run(): Promise<void>;
-}