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

package/lib/program/InterfaceManager.d.ts

@@ -1,41 +1,391 @@
+import { caseType } from '../utils/casing/';
+import { SupportedPluginNamesType } from '../plugins/types';
 import { File } from '../file/File';
+import { ContentTypeReader } from '../readers/types/content-type-reader';
+import { InterfaceWriter } from '../writers/types/writer';
+declare type InterfaceManagerOptions = {
+    /**
+     * @default 'I'
+     * @type {string}
+     * @description The prefix to use for all interfaces
+     */
+    prefix?: string;
+    /**
+     * @default true
+     * @type {boolean}
+     * @description Whether to use the category prefix for component interfaces
+     */
+    useCategoryPrefix?: boolean;
+    /**
+     * @default ''
+     * @type {string}
+     * @description The prefix to use for component interfaces
+     */
+    componentPrefix?: string;
+    /**
+     * @default false
+     * @type {boolean}
+     * @description Whether to use only the component prefix for component interfaces
+     */
+    componentPrefixOverridesPrefix?: boolean;
+    /**
+     * @default ''
+     * @type {string}
+     * @description The prefix to use for builtin interfaces
+     */
+    /**
+     * @default false
+     * @type {boolean}
+     * @description Whether to use only the builtin prefix for builtin interfaces
+     */
+    /**
+     * @default null
+     * @type {string}
+     * @description The path to the prettier config file
+     */
+    fileCaseType?: caseType;
+    /**
+     * @default 'kebab'
+     * @type {caseType}
+     * @description The case type to use for folder names
+     */
+    folderCaseType?: caseType;
+    /**
+     * @default []
+     * @type {SupportedPluginNamesType[]}
+     * @description The plugins to use
+     */
+    enabledPlugins?: SupportedPluginNamesType[];
+};
 export default class InterfaceManager {
     private Files;
-    private OutRoot;
-    private StrapiSrcRoot;
     private Options;
-    private PrettierOptions;
     private PluginManager;
     private dependenciesInjected;
-    static BaseOptions: {
-        prefix: string;
-        useCategoryPrefix: boolean;
-        componentPrefix: string;
-        componentPrefixOverridesPrefix: boolean;
-        builtinsPrefix: string;
-        builtinsPrefixOverridesPrefix: boolean;
-        deleteOld: boolean;
-        prettierFile: any;
-        fileCaseType: "camel" | "capital" | "dot" | "snake" | "pascal" | "constant" | "kebab";
-        folderCaseType: "camel" | "capital" | "dot" | "snake" | "pascal" | "constant" | "kebab";
-        enabledPlugins: ("url-alias" | "i18n")[];
-    };
-    constructor(outRoot: string, strapiSrcRoot: string, options?: Partial<typeof InterfaceManager['BaseOptions']>);
+    private contentTypeReader;
+    private interfaceWriter;
+    constructor(reader: ContentTypeReader, writer: InterfaceWriter, { prefix, useCategoryPrefix, componentPrefix, componentPrefixOverridesPrefix, fileCaseType, folderCaseType, enabledPlugins, }?: Partial<InterfaceManagerOptions>);
     registerBuiltinPlugins(): void;
     registerPlugin(): void;
     validateOptions(): void;
-    loadPrettierConfig(): Promise<void>;
     readSchemas(): Promise<{
-        apiSchemas: any[];
-        componentSchemas: any[];
+        apiSchemas: Record<`api::${string}` | `plugin::${string}` | `admin::${string}` | `builtins::${string}`, {
+            name: string;
+            contentType: {
+                attributes?: Record<string, {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "text" | "string";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "email";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "uid";
+                    targetField?: string;
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "richtext";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "json";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "password";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "integer";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "float";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "biginteger";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "decimal";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "enumeration";
+                    enum?: string[];
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "date";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "datetime";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "time";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "media";
+                    multiple?: boolean;
+                    allowedTypes?: ("images" | "videos" | "audios" | "files")[];
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "boolean";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "relation";
+                    target?: string;
+                    relation?: "oneToOne";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "relation";
+                    target?: string;
+                    relation?: "oneToOne";
+                    inversedBy?: string;
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "relation";
+                    target?: string;
+                    mappedBy?: string;
+                    relation?: "oneToMany";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "relation";
+                    target?: string;
+                    relation?: "manyToOne";
+                    inversedBy?: string;
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "relation";
+                    target?: string;
+                    relation?: "manyToMany";
+                    inversedBy?: string;
+                    mappedBy?: string;
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "relation";
+                    target?: string;
+                    relation?: "oneToMany";
+                } | {
+                    type?: "relation";
+                    relation?: "morphToMany";
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "component";
+                    repeatable?: boolean;
+                    component?: string;
+                } | {
+                    __t4s_required?: boolean;
+                    pluginOptions?: any;
+                    required?: boolean;
+                    type?: "dynamiczone";
+                    components?: string[];
+                }>;
+                collectionName?: string;
+                options?: {
+                    draftAndPublish?: boolean;
+                };
+                pluginOptions?: Record<string, any>;
+                uid?: string;
+            };
+        } & ({
+            namespace: "api" | "plugin";
+            collection: string;
+        } | {
+            namespace: "admin";
+            collection?: null;
+        })>;
+        componentSchemas: Record<`${string}.${string}`, {
+            collectionName?: string;
+            attributes?: Record<string, {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "text" | "string";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "email";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "uid";
+                targetField?: string;
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "richtext";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "json";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "password";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "integer";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "float";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "biginteger";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "decimal";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "enumeration";
+                enum?: string[];
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "date";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "datetime";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "time";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "media";
+                multiple?: boolean;
+                allowedTypes?: ("images" | "videos" | "audios" | "files")[];
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "boolean";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "relation";
+                target?: string;
+                relation?: "oneToOne";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "relation";
+                target?: string;
+                relation?: "oneToOne";
+                inversedBy?: string;
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "relation";
+                target?: string;
+                mappedBy?: string;
+                relation?: "oneToMany";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "relation";
+                target?: string;
+                relation?: "manyToOne";
+                inversedBy?: string;
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "relation";
+                target?: string;
+                relation?: "manyToMany";
+                inversedBy?: string;
+                mappedBy?: string;
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "relation";
+                target?: string;
+                relation?: "oneToMany";
+            } | {
+                type?: "relation";
+                relation?: "morphToMany";
+            } | {
+                __t4s_required?: boolean;
+                pluginOptions?: any;
+                required?: boolean;
+                type?: "component";
+                repeatable?: boolean;
+                component?: string;
+            }>;
+            options?: {};
+            uid?: string;
+        }>;
     }>;
     addType(name: string, file: File, force?: boolean): boolean;
     createInterfaces(): Promise<void>;
     createBuiltinInterfaces(): void;
     injectDependencies(): void;
-    deleteOldFolders(): Promise<void>;
-    makeFolders(): Promise<void>;
-    writeInterfaces(): Promise<void>;
-    writeIndexFile(): Promise<void>;
     run(): Promise<void>;
 }
+export {};