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

package/lib/interface/builtinInterfaces.js

@@ -3,12 +3,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": 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 = [
+exports.createMediaFormatInterface = exports.createMediaInterface = exports.attributeWithNested = exports.nestedAttribute = void 0;
+const zod_1 = require("zod");
+const constants_1 = require("../constants");
+const attributes_1 = require("../readers/types/attributes");
+const BuiltinComponentInterface_1 = __importDefault(require("./BuiltinComponentInterface"));
+const BuiltinInterface_1 = __importDefault(require("./BuiltinInterface"));
+exports.nestedAttribute = zod_1.z.object({
+    type: zod_1.z.literal('nested'),
+    nullable: zod_1.z.boolean().optional(),
+    fields: zod_1.z.record(attributes_1.contentTypeAttribute),
+});
+exports.attributeWithNested = zod_1.z.union([attributes_1.contentTypeAttribute, exports.nestedAttribute]);
+function createMediaInterface(caseTypeName, prefix) {
+    const stringRequiredFields = [
         'name',
         'hash',
         'ext',
@@ -16,21 +24,21 @@ function createMediaInterface(directory, caseTypeName, prefix) {
         'url',
         'provider',
     ];
-    var stringFields = [
+    const stringFields = [
         'previewUrl',
         'provider_metadata',
         'alternativeText',
         'caption', // nullable in plain text
     ];
-    var numberRequiredFields = ['size'];
+    const numberRequiredFields = ['size'];
     // Nullable if you have a plain text file
-    var numberFields = ['width', 'height'];
-    var mediaFormat = {
+    const numberFields = ['width', 'height'];
+    const mediaFormat = {
         type: 'component',
         repeatable: false,
         component: 'builtins::MediaFormat',
     };
-    var mediaAttrs = {
+    const mediaAttrs = {
         formats: {
             // types-4-strapi-2 specific
             type: 'nested',
@@ -43,29 +51,25 @@ function createMediaInterface(directory, caseTypeName, prefix) {
             },
         },
     };
-    stringRequiredFields.forEach(function (s) {
-        var _a;
-        mediaAttrs[s] = (_a = {
-                type: 'string',
-                required: true
-            },
-            _a[constants_1.CERTAINLY_REQUIRED_KEY] = true,
-            _a);
+    stringRequiredFields.forEach((s) => {
+        mediaAttrs[s] = {
+            type: 'text',
+            required: true,
+            [constants_1.CERTAINLY_REQUIRED_KEY]: true,
+        };
     });
-    stringFields.forEach(function (s) {
-        mediaAttrs[s] = { type: 'string' };
+    stringFields.forEach((s) => {
+        mediaAttrs[s] = { type: 'text' };
     });
-    numberFields.forEach(function (s) {
+    numberFields.forEach((s) => {
         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);
+    numberRequiredFields.forEach((s) => {
+        mediaAttrs[s] = {
+            type: 'integer',
+            required: true,
+            [constants_1.CERTAINLY_REQUIRED_KEY]: true,
+        };
     });
     // const dataAttrs = {
     //     data: {
@@ -74,29 +78,35 @@ function createMediaInterface(directory, caseTypeName, prefix) {
     //         nullable: true,
     //     },
     // };
-    return new BuiltinInterface_1.default('Media', mediaAttrs, directory, caseTypeName, prefix);
+    return new BuiltinInterface_1.default('Media', mediaAttrs, '', caseTypeName, prefix);
 }
 exports.createMediaInterface = createMediaInterface;
-function createMediaFormatInterface(directory, caseTypeName, prefix) {
-    var stringRequiredFields = ['name', 'hash', 'ext', 'mime', 'url'];
-    var stringFields = ['path'];
-    var numberRequiredFields = ['size', 'width', 'height']; // TODO: not sure if this is corrext
-    var numberFields = [];
-    var mediaAttrs = {};
-    stringRequiredFields.forEach(function (s) {
-        var _a;
-        mediaAttrs[s] = (_a = { type: 'string', required: true }, _a[constants_1.CERTAINLY_REQUIRED_KEY] = true, _a);
+function createMediaFormatInterface(caseTypeName, prefix) {
+    const stringRequiredFields = ['name', 'hash', 'ext', 'mime', 'url'];
+    const stringFields = ['path'];
+    const numberRequiredFields = ['size', 'width', 'height']; // TODO: not sure if this is corrext
+    const numberFields = [];
+    const mediaAttrs = {};
+    stringRequiredFields.forEach((s) => {
+        mediaAttrs[s] = {
+            type: 'string',
+            required: true,
+            [constants_1.CERTAINLY_REQUIRED_KEY]: true,
+        };
     });
-    stringFields.forEach(function (s) {
+    stringFields.forEach((s) => {
         mediaAttrs[s] = { type: 'string' };
     });
-    numberRequiredFields.forEach(function (s) {
-        var _a;
-        mediaAttrs[s] = (_a = { type: 'integer', required: true }, _a[constants_1.CERTAINLY_REQUIRED_KEY] = true, _a);
+    numberRequiredFields.forEach((s) => {
+        mediaAttrs[s] = {
+            type: 'integer',
+            required: true,
+            [constants_1.CERTAINLY_REQUIRED_KEY]: true,
+        };
     });
-    numberFields.forEach(function (s) {
+    numberFields.forEach((s) => {
         mediaAttrs[s] = { type: 'integer' };
     });
-    return new BuiltinComponentInterface_1.default('MediaFormat', mediaAttrs, directory, caseTypeName, prefix);
+    return new BuiltinComponentInterface_1.default('MediaFormat', mediaAttrs, '', caseTypeName, prefix);
 }
 exports.createMediaFormatInterface = createMediaFormatInterface;

package/lib/plugins/PluginManager.d.ts

@@ -1,8 +1,13 @@
 import { Events } from '../events';
 import InterfaceManager from '../program/InterfaceManager';
+import { ContentTypeReader } from '../readers/types/content-type-reader';
+declare type Schemas = {
+    apiSchemas: Awaited<ReturnType<ContentTypeReader['readContentTypes']>>;
+    componentSchemas: Awaited<ReturnType<ContentTypeReader['readComponents']>>;
+};
 export declare type HookTypes = {
-    [Events.BeforeReadSchema]: (state: InterfaceManager, schema: any) => void;
-    [Events.AfterReadSchema]: (state: InterfaceManager, schema: any) => void;
+    [Events.BeforeReadSchema]: (state: InterfaceManager, schema: Schemas) => void;
+    [Events.AfterReadSchema]: (state: InterfaceManager, schema: Schemas) => void;
     [Events.BeforeReadSchemas]: (state: InterfaceManager) => void;
     [Events.AfterReadSchemas]: (state: InterfaceManager) => void;
     [Events.ModifySchemas]: (state: InterfaceManager) => void;
@@ -22,3 +27,4 @@ export declare class PluginManager {
     sortHooks(): void;
     invoke<Hook extends keyof HookTypes>(hook: Hook, ...args: Parameters<HookTypes[Hook]>): void;
 }
+export {};

package/lib/plugins/PluginManager.js

@@ -1,46 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PluginManager = void 0;
-var events_1 = require("../events");
-var PluginManager = /** @class */ (function () {
-    function PluginManager() {
-        var _a;
-        this.hooks = (_a = {},
-            _a[events_1.Events.BeforeReadSchema] = [],
-            _a[events_1.Events.BeforeReadSchemas] = [],
-            _a[events_1.Events.AfterReadSchema] = [],
-            _a[events_1.Events.AfterReadSchemas] = [],
-            _a[events_1.Events.ModifySchemas] = [],
-            _a[events_1.Events.BeforeInjectDependencies] = [],
-            _a[events_1.Events.AfterInjectDependencies] = [],
-            _a);
+const events_1 = require("../events");
+class PluginManager {
+    constructor() {
+        this.hooks = {
+            [events_1.Events.BeforeReadSchema]: [],
+            [events_1.Events.BeforeReadSchemas]: [],
+            [events_1.Events.AfterReadSchema]: [],
+            [events_1.Events.AfterReadSchemas]: [],
+            [events_1.Events.ModifySchemas]: [],
+            [events_1.Events.BeforeInjectDependencies]: [],
+            [events_1.Events.AfterInjectDependencies]: [],
+        };
     }
-    PluginManager.prototype.registerPlugin = function (hooks) {
-        var _a;
-        for (var hook in hooks) {
+    registerPlugin(hooks) {
+        for (const hook in hooks) {
             if (hooks[hook]) {
-                (_a = this.hooks[hook]).push.apply(_a, hooks[hook]);
+                this.hooks[hook].push(...hooks[hook]);
             }
         }
-    };
-    PluginManager.prototype.registerHook = function (hook, fn, priority) {
-        this.hooks[hook].push({ fn: fn, priority: priority });
-    };
-    PluginManager.prototype.sortHooks = function () {
-        for (var hook in this.hooks) {
-            this.hooks[hook].sort(function (a, b) { return a.priority - b.priority; });
-        }
-    };
-    PluginManager.prototype.invoke = function (hook) {
-        var args = [];
-        for (var _i = 1; _i < arguments.length; _i++) {
-            args[_i - 1] = arguments[_i];
+    }
+    registerHook(hook, fn, priority) {
+        this.hooks[hook].push({ fn, priority });
+    }
+    sortHooks() {
+        for (const hook in this.hooks) {
+            this.hooks[hook].sort((a, b) => a.priority - b.priority);
         }
-        this.hooks[hook].forEach(function (hook) {
+    }
+    invoke(hook, ...args) {
+        this.hooks[hook].forEach((hook) => {
             // @ts-ignore we know that it is the correct type, sunce HooksType is built from HookTypes
-            hook.fn.apply(hook, args);
+            hook.fn(...args);
         });
-    };
-    return PluginManager;
-}());
+    }
+}
 exports.PluginManager = PluginManager;

package/lib/plugins/draft-and-publish/index.d.ts

@@ -1,3 +1,3 @@
-import { PluginRegister } from "../types";
+import { PluginRegister } from '../types';
 declare const register: PluginRegister;
 export default register;

package/lib/plugins/draft-and-publish/index.js

@@ -1,36 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var constants_1 = require("../../constants");
-var events_1 = require("../../events");
-var addFieldsToContentTypes = function (state, schema) {
-    var apiSchemas = schema.apiSchemas;
-    apiSchemas.forEach(function (_a) {
-        var name = _a.name, schema = _a.schema;
-        var attributes = schema.attributes, _b = schema.options, options = _b === void 0 ? {} : _b;
+const constants_1 = require("../../constants");
+const events_1 = require("../../events");
+const addFieldsToContentTypes = (state, schema) => {
+    const { apiSchemas } = schema;
+    Object.entries(apiSchemas).forEach(([strapiName, schema]) => {
+        const { attributes, options = {} } = schema.contentType;
         if ((options === null || options === void 0 ? void 0 : options.draftAndPublish) !== true) {
             return;
         }
-        var fieldNames = ['publishedAt', 'createdAt', 'updatedAt'];
-        fieldNames.forEach(function (fieldName) {
-            var _a;
-            attributes[fieldName] = (_a = {
-                    type: 'string',
-                    required: true
-                },
-                _a[constants_1.CERTAINLY_REQUIRED_KEY] = true,
-                _a);
+        const fieldNames = ['publishedAt', 'createdAt', 'updatedAt'];
+        fieldNames.forEach((fieldName) => {
+            attributes[fieldName] = {
+                type: 'string',
+                required: true,
+                [constants_1.CERTAINLY_REQUIRED_KEY]: true,
+            };
         });
     });
 };
-var register = function () {
-    var _a;
-    return _a = {},
-        _a[events_1.Events.AfterReadSchema] = [
+const register = () => {
+    return {
+        [events_1.Events.AfterReadSchema]: [
             {
                 fn: addFieldsToContentTypes,
                 priority: 10,
             },
         ],
-        _a;
+    };
 };
 exports.default = register;

package/lib/plugins/i18n/index.d.ts

@@ -1,3 +1,3 @@
-import { PluginRegister } from "../types";
+import { PluginRegister } from '../types';
 declare const register: PluginRegister;
 export default register;

package/lib/plugins/i18n/index.js

@@ -1,41 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var constants_1 = require("../../constants");
-var events_1 = require("../../events");
-var addLocaleToLocalizedContentTypes = function (state, _a) {
-    var apiSchemas = _a.apiSchemas;
-    apiSchemas.forEach(function (_a) {
-        var _b;
-        var _c, _d;
-        var name = _a.name, schema = _a.schema;
-        var attributes = schema.attributes;
-        if (((_d = (_c = schema === null || schema === void 0 ? void 0 : schema.pluginOptions) === null || _c === void 0 ? void 0 : _c.i18n) === null || _d === void 0 ? void 0 : _d.localized) !== true) {
+const constants_1 = require("../../constants");
+const events_1 = require("../../events");
+const addLocaleToLocalizedContentTypes = (state, { apiSchemas }) => {
+    Object.entries(apiSchemas).forEach(([strapiName, schema]) => {
+        var _a, _b, _c;
+        const { attributes } = schema.contentType;
+        if (((_c = (_b = (_a = schema.contentType) === null || _a === void 0 ? void 0 : _a.pluginOptions) === null || _b === void 0 ? void 0 : _b.i18n) === null || _c === void 0 ? void 0 : _c.localized) !== true) {
             return;
         }
         // Add locale to all localized content types
-        attributes.locale = (_b = {
-                type: 'string',
-                required: true
-            },
-            _b[constants_1.CERTAINLY_REQUIRED_KEY] = true,
-            _b);
+        attributes.locale = {
+            type: 'string',
+            required: true,
+            [constants_1.CERTAINLY_REQUIRED_KEY]: true,
+        };
         // Add populatable field for localizations
         attributes.localizations = {
             type: 'relation',
             relation: 'oneToMany',
-            target: "api::".concat(name, ".").concat(name), // TODO: make this more complete
+            target: strapiName
         };
     });
 };
-var register = function () {
-    var _a;
-    return _a = {},
-        _a[events_1.Events.AfterReadSchema] = [
+const register = () => {
+    return {
+        [events_1.Events.AfterReadSchema]: [
             {
                 fn: addLocaleToLocalizedContentTypes,
                 priority: 10,
             },
         ],
-        _a;
+    };
 };
 exports.default = register;

package/lib/plugins/index.js

@@ -4,10 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerBuiltinPlugins = void 0;
-var url_alias_1 = __importDefault(require("./url-alias"));
-var draft_and_publish_1 = __importDefault(require("./draft-and-publish"));
-var i18n_1 = __importDefault(require("./i18n"));
-var registerBuiltinPlugins = function (pluginManager, pluginNames) {
+const url_alias_1 = __importDefault(require("./url-alias"));
+const draft_and_publish_1 = __importDefault(require("./draft-and-publish"));
+const i18n_1 = __importDefault(require("./i18n"));
+const registerBuiltinPlugins = (pluginManager, pluginNames) => {
     // Draft and publish is always registered since it is built into Strapi
     pluginManager.registerPlugin((0, draft_and_publish_1.default)());
     if (pluginNames.has('url-alias')) {

package/lib/plugins/types.d.ts

@@ -1,4 +1,4 @@
-import { HooksType } from "./PluginManager";
+import { HooksType } from './PluginManager';
 export declare const supportedPluginNames: readonly ["url-alias", "i18n"];
 export declare type SupportedPluginNamesType = typeof supportedPluginNames[number];
 export declare type PluginRegister = () => Partial<HooksType>;

package/lib/plugins/types.js

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

package/lib/plugins/url-alias/index.js

@@ -1,12 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var events_1 = require("../../events");
-var type_1 = require("./type");
-var addUrlAliasToAllContentTypes = function (state, _a) {
-    var apiSchemas = _a.apiSchemas;
-    apiSchemas.forEach(function (_a) {
-        var name = _a.name, schema = _a.schema;
-        var attributes = schema.attributes;
+const events_1 = require("../../events");
+const type_1 = require("./type");
+const addUrlAliasToAllContentTypes = (state, { apiSchemas }) => {
+    Object.entries(apiSchemas).forEach(([strapiName, schema]) => {
+        const { attributes } = schema.contentType;
         // TODO: write comment here if it is intentional that it it can be null
         attributes.url_path = {
             type: 'string',
@@ -19,25 +17,24 @@ var addUrlAliasToAllContentTypes = function (state, _a) {
         // };
     });
 };
-var addUrlAliasGetType = function (state) {
-    var urlAliasGet = new type_1.UrlAliasGet();
+const addUrlAliasGetType = (state) => {
+    const urlAliasGet = new type_1.UrlAliasGet();
     state.addType(urlAliasGet.getStrapiName(), urlAliasGet);
 };
-var register = function () {
-    var _a;
-    return _a = {},
-        _a[events_1.Events.AfterReadSchema] = [
+const register = () => {
+    return {
+        [events_1.Events.AfterReadSchema]: [
             {
                 fn: addUrlAliasToAllContentTypes,
                 priority: 10,
             },
         ],
-        _a[events_1.Events.AfterReadSchemas] = [
+        [events_1.Events.AfterReadSchemas]: [
             {
                 fn: addUrlAliasGetType,
                 priority: 10,
             },
         ],
-        _a;
+    };
 };
 exports.default = register;

package/lib/plugins/url-alias/type.js

@@ -1,41 +1,30 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UrlAliasGet = void 0;
-var File_1 = require("../../file/File");
+const File_1 = require("../../file/File");
 /* import Interface from "../../interface/Interface"; */
-var UrlAliasGet = /** @class */ (function (_super) {
-    __extends(UrlAliasGet, _super);
-    function UrlAliasGet() {
-        var baseName = 'url-alias';
-        return _super.call(this, baseName, 'plugins/url-alias', 'pascal') || this;
+class UrlAliasGet extends File_1.File {
+    constructor() {
+        const baseName = 'url-alias';
+        super(baseName, 'plugins/url-alias', 'pascal'); // TODO: figure out how to change the casing
     }
-    UrlAliasGet.prototype.getStrapiName = function () {
+    getStrapiName() {
         return 'plugins::url-alias.get';
-    };
-    UrlAliasGet.prototype.getFullName = function () {
+    }
+    getFullName() {
         return 'UrlAliasGet';
-    };
-    UrlAliasGet.prototype.getDependencies = function () {
+    }
+    getDependencies() {
         return [];
-    };
-    UrlAliasGet.prototype.toString = function () {
-        return "\n            export type ".concat(this.getFullName(), "<ContentType extends { attributes: {} }> = ContentType & {\n                attributes: {\n                    contentType: string;\n                },\n            }\n        ");
-    };
-    return UrlAliasGet;
-}(File_1.File));
+    }
+    toString() {
+        return `
+            export type ${this.getFullName()}<ContentType extends { attributes: {} }> = ContentType & {
+                attributes: {
+                    contentType: string;
+                },
+            }
+        `;
+    }
+}
 exports.UrlAliasGet = UrlAliasGet;