@strapi/plugin-documentation 5.0.0-beta.0 → 5.0.0-beta.1

package/dist/server/src/services/__mocks__/mock-strapi-data.d.ts

@@ -0,0 +1,592 @@
+import contentTypes from './mock-content-types';
+declare const components: {
+    'basic.simple': {
+        collectionName: string;
+        info: {
+            displayName: string;
+            icon: string;
+            description: string;
+        };
+        options: {};
+        attributes: {
+            name: {
+                type: string;
+                required: boolean;
+            };
+            test: {
+                type: string;
+            };
+        };
+        uid: string;
+        category: string;
+        modelType: string;
+        modelName: string;
+        globalId: string;
+    };
+    'blog.test-como': {
+        collectionName: string;
+        info: {
+            displayName: string;
+            icon: string;
+            description: string;
+        };
+        options: {};
+        attributes: {
+            name: {
+                type: string;
+                default: string;
+            };
+        };
+        uid: string;
+        category: string;
+        modelType: string;
+        modelName: string;
+        globalId: string;
+    };
+    'basic.relation': {
+        collectionName: string;
+        info: {
+            displayName: string;
+        };
+        options: {};
+        attributes: {
+            categories: {
+                type: string;
+                relation: string;
+                target: string;
+            };
+        };
+        uid: string;
+        category: string;
+        modelType: string;
+        modelName: string;
+        globalId: string;
+    };
+};
+declare const plugins: {
+    upload: {
+        contentTypes: {
+            file: {
+                collectionName: string;
+                info: {
+                    singularName: string;
+                    pluralName: string;
+                    displayName: string;
+                    description: string;
+                };
+                options: {};
+                pluginOptions: {
+                    'content-manager': {
+                        visible: boolean;
+                    };
+                    'content-type-builder': {
+                        visible: boolean;
+                    };
+                };
+                attributes: {
+                    name: {
+                        type: string;
+                        configurable: boolean;
+                        required: boolean;
+                    };
+                    alternativeText: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    caption: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    width: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    height: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    formats: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    hash: {
+                        type: string;
+                        configurable: boolean;
+                        required: boolean;
+                    };
+                    ext: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    mime: {
+                        type: string;
+                        configurable: boolean;
+                        required: boolean;
+                    };
+                    size: {
+                        type: string;
+                        configurable: boolean;
+                        required: boolean;
+                    };
+                    url: {
+                        type: string;
+                        configurable: boolean;
+                        required: boolean;
+                    };
+                    previewUrl: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    provider: {
+                        type: string;
+                        configurable: boolean;
+                        required: boolean;
+                    };
+                    provider_metadata: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    related: {
+                        type: string;
+                        relation: string;
+                        configurable: boolean;
+                    };
+                    folder: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        inversedBy: string;
+                        private: boolean;
+                    };
+                    folderPath: {
+                        type: string;
+                        min: number;
+                        required: boolean;
+                        private: boolean;
+                    };
+                    createdAt: {
+                        type: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                    };
+                    createdBy: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        configurable: boolean;
+                        writable: boolean;
+                        visible: boolean;
+                        useJoinTable: boolean;
+                        private: boolean;
+                    };
+                    updatedBy: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        configurable: boolean;
+                        writable: boolean;
+                        visible: boolean;
+                        useJoinTable: boolean;
+                        private: boolean;
+                    };
+                };
+                indexes: {
+                    name: string;
+                    columns: string[];
+                    type: null;
+                }[];
+                kind: string;
+                modelType: string;
+                modelName: string;
+                uid: string;
+                plugin: string;
+                globalId: string;
+            };
+            folder: {
+                collectionName: string;
+                info: {
+                    singularName: string;
+                    pluralName: string;
+                    displayName: string;
+                };
+                options: {};
+                pluginOptions: {
+                    'content-manager': {
+                        visible: boolean;
+                    };
+                    'content-type-builder': {
+                        visible: boolean;
+                    };
+                };
+                attributes: {
+                    name: {
+                        type: string;
+                        min: number;
+                        required: boolean;
+                    };
+                    pathId: {
+                        type: string;
+                        unique: boolean;
+                        required: boolean;
+                    };
+                    parent: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        inversedBy: string;
+                    };
+                    children: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        mappedBy: string;
+                    };
+                    files: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        mappedBy: string;
+                    };
+                    path: {
+                        type: string;
+                        min: number;
+                        required: boolean;
+                    };
+                    createdAt: {
+                        type: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                    };
+                    createdBy: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        configurable: boolean;
+                        writable: boolean;
+                        visible: boolean;
+                        useJoinTable: boolean;
+                        private: boolean;
+                    };
+                    updatedBy: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        configurable: boolean;
+                        writable: boolean;
+                        visible: boolean;
+                        useJoinTable: boolean;
+                        private: boolean;
+                    };
+                };
+                indexes: {
+                    name: string;
+                    columns: string[];
+                    type: string;
+                }[];
+                kind: string;
+                modelType: string;
+                modelName: string;
+                uid: string;
+                plugin: string;
+                globalId: string;
+            };
+        };
+        routes: {
+            'content-api': {
+                type: string;
+                routes: {
+                    method: string;
+                    path: string;
+                    handler: string;
+                    config: {
+                        auth: {
+                            scope: string[];
+                        };
+                    };
+                    info: {
+                        pluginName: string;
+                        type: string;
+                    };
+                }[];
+                prefix: string;
+            };
+        };
+    };
+    email: {
+        contentTypes: {};
+    };
+    'users-permissions': {
+        contentTypes: {};
+    };
+};
+declare const api: {
+    homepage: {
+        contentTypes: {
+            homepage: {
+                kind: string;
+                collectionName: string;
+                info: {
+                    displayName: string;
+                    singularName: string;
+                    pluralName: string;
+                };
+                pluginOptions: {
+                    i18n: {
+                        localized: boolean;
+                    };
+                };
+                attributes: {
+                    title: {
+                        type: string;
+                        required: boolean;
+                        pluginOptions: {
+                            i18n: {
+                                localized: boolean;
+                            };
+                        };
+                    };
+                    slug: {
+                        type: string;
+                        targetField: string;
+                        required: boolean;
+                        pluginOptions: {
+                            i18n: {
+                                localized: boolean;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        routes: {
+            homepage: {
+                type: string;
+                routes: {
+                    method: string;
+                    path: string;
+                    handler: string;
+                    config: {
+                        auth: {
+                            scope: string[];
+                        };
+                    };
+                    info: {
+                        apiName: string;
+                        type: string;
+                    };
+                }[];
+            };
+        };
+    };
+    kitchensink: {
+        contentTypes: {
+            kitchensink: {
+                kind: string;
+                collectionName: string;
+                info: {
+                    displayName: string;
+                    singularName: string;
+                    pluralName: string;
+                    description: string;
+                    name: string;
+                };
+                pluginOptions: {};
+                attributes: {
+                    short_text: {
+                        type: string;
+                    };
+                    long_text: {
+                        type: string;
+                    };
+                    rich_text: {
+                        type: string;
+                    };
+                    integer: {
+                        type: string;
+                    };
+                    biginteger: {
+                        type: string;
+                    };
+                    decimal: {
+                        type: string;
+                    };
+                    float: {
+                        type: string;
+                    };
+                    date: {
+                        type: string;
+                    };
+                    datetime: {
+                        type: string;
+                    };
+                    time: {
+                        type: string;
+                    };
+                    timestamp: {
+                        type: string;
+                    };
+                    boolean: {
+                        type: string;
+                    };
+                    email: {
+                        type: string;
+                    };
+                    password: {
+                        type: string;
+                    };
+                    enumeration: {
+                        type: string;
+                        enum: string[];
+                    };
+                    single_media: {
+                        type: string;
+                        multiple: boolean;
+                        required: boolean;
+                        allowedTypes: string[];
+                    };
+                    multiple_media: {
+                        type: string;
+                        multiple: boolean;
+                        required: boolean;
+                        allowedTypes: string[];
+                    };
+                    json: {
+                        type: string;
+                    };
+                    single_compo: {
+                        type: string;
+                        repeatable: boolean;
+                        component: string;
+                    };
+                    repeatable_compo: {
+                        type: string;
+                        repeatable: boolean;
+                        component: string;
+                    };
+                    dynamiczone: {
+                        type: string;
+                        components: string[];
+                    };
+                    one_way_tag: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                    };
+                    one_to_one_tag: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        private: boolean;
+                        inversedBy: string;
+                    };
+                    one_to_many_tags: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        mappedBy: string;
+                    };
+                    many_to_one_tag: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        inversedBy: string;
+                    };
+                    many_to_many_tags: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        inversedBy: string;
+                    };
+                    many_way_tags: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                    };
+                    morph_to_one: {
+                        type: string;
+                        relation: string;
+                    };
+                    morph_to_many: {
+                        type: string;
+                        relation: string;
+                    };
+                    custom_field: {
+                        type: string;
+                        customField: string;
+                    };
+                    custom_field_with_default_options: {
+                        type: string;
+                        regex: string;
+                        customField: string;
+                    };
+                    cats: {
+                        type: string;
+                        components: string[];
+                    };
+                    createdAt: {
+                        type: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                    };
+                    publishedAt: {
+                        type: string;
+                        configurable: boolean;
+                        writable: boolean;
+                        visible: boolean;
+                    };
+                    createdBy: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        configurable: boolean;
+                        writable: boolean;
+                        visible: boolean;
+                        useJoinTable: boolean;
+                        private: boolean;
+                    };
+                    updatedBy: {
+                        type: string;
+                        relation: string;
+                        target: string;
+                        configurable: boolean;
+                        writable: boolean;
+                        visible: boolean;
+                        useJoinTable: boolean;
+                        private: boolean;
+                    };
+                };
+                modelType: string;
+                modelName: string;
+                uid: string;
+                apiName: string;
+                globalId: string;
+                actions: {};
+                lifecycles: {};
+            };
+        };
+        routes: {
+            kitchensink: {
+                routes: {
+                    method: string;
+                    path: string;
+                    handler: string;
+                    config: {
+                        auth: {
+                            scope: string[];
+                        };
+                    };
+                    info: {
+                        apiName: string;
+                        type: string;
+                    };
+                }[];
+                type: string;
+            };
+        };
+    };
+};
+export { components, plugins, api, contentTypes };
+//# sourceMappingURL=mock-strapi-data.d.ts.map

package/dist/server/src/services/__mocks__/mock-strapi-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-strapi-data.d.ts","sourceRoot":"","sources":["../../../../../server/src/services/__mocks__/mock-strapi-data.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,sBAAsB,CAAC;AAEhD,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCf,CAAC;AAEF,QAAA,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiDZ,CAAC;AAEF,QAAA,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwFR,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC"}

package/dist/server/src/services/documentation.d.ts

@@ -0,0 +1,36 @@
+import type { Core } from '@strapi/types';
+export type Version = {
+    version: string;
+    generatedDate: string;
+    url: string;
+};
+export type DocumentationService = ReturnType<typeof createService>;
+declare const createService: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    getDocumentationVersion(): string;
+    getFullDocumentationPath(): string;
+    getDocumentationVersions(): Version[];
+    /**
+     * Returns settings stored in core-store
+     */
+    getDocumentationAccess(): Promise<{
+        restrictedAccess: boolean;
+    }>;
+    getApiDocumentationPath(api: {
+        name: string;
+        getter: string;
+    }): string;
+    deleteDocumentation(version: string): Promise<void>;
+    getPluginAndApiInfo(): {
+        name: string;
+        getter: string;
+        ctNames: string[];
+    }[];
+    /**
+     * @description - Creates the Swagger json files
+     */
+    generateFullDoc(versionOpt?: string): Promise<void>;
+};
+export default createService;
+//# sourceMappingURL=documentation.d.ts.map

package/dist/server/src/services/documentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentation.d.ts","sourceRoot":"","sources":["../../../../server/src/services/documentation.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAQ1C,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAEpE,QAAA,MAAM,aAAa;YAA0B,KAAK,MAAM;;;;gCAcxB,OAAO,EAAE;IAuBrC;;OAEG;;;;iCAY0B;QAAE,MAAM,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;iCAQ1B,MAAM;;;;;;IA6BzC;;OAEG;iCACgC,MAAM;CA6G5C,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/server/src/services/helpers/build-api-endpoint-path.d.ts

@@ -0,0 +1,7 @@
+import type { Api } from '../../types';
+/**
+ * @description - Builds the Swagger paths object for each api
+ */
+declare const buildApiEndpointPath: (api: Api) => {};
+export default buildApiEndpointPath;
+//# sourceMappingURL=build-api-endpoint-path.d.ts.map

package/dist/server/src/services/helpers/build-api-endpoint-path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-api-endpoint-path.d.ts","sourceRoot":"","sources":["../../../../../server/src/services/helpers/build-api-endpoint-path.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,GAAG,EAAW,MAAM,aAAa,CAAC;AAmIhD;;GAEG;AACH,QAAA,MAAM,oBAAoB,QAAS,GAAG,OAKrC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/server/src/services/helpers/build-component-schema.d.ts

@@ -0,0 +1,4 @@
+import type { Api } from '../../types';
+declare const buildComponentSchema: (api: Api) => {};
+export default buildComponentSchema;
+//# sourceMappingURL=build-component-schema.d.ts.map

package/dist/server/src/services/helpers/build-component-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-component-schema.d.ts","sourceRoot":"","sources":["../../../../../server/src/services/helpers/build-component-schema.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,GAAG,EAAW,MAAM,aAAa,CAAC;AAgJhD,QAAA,MAAM,oBAAoB,QAAS,GAAG,OAKrC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/server/src/services/helpers/index.d.ts

@@ -0,0 +1,4 @@
+import builApiEndpointPath from './build-api-endpoint-path';
+import buildComponentSchema from './build-component-schema';
+export { builApiEndpointPath, buildComponentSchema };
+//# sourceMappingURL=index.d.ts.map

package/dist/server/src/services/helpers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../server/src/services/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAC5D,OAAO,oBAAoB,MAAM,0BAA0B,CAAC;AAE5D,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/server/src/services/helpers/utils/clean-schema-attributes.d.ts

@@ -0,0 +1,15 @@
+import type { Struct } from '@strapi/types';
+import type { OpenAPIV3 } from 'openapi-types';
+interface Options {
+    typeMap?: Map<string, boolean>;
+    isRequest?: boolean;
+    didAddStrapiComponentsToSchemas: (name: string, schema: object) => boolean;
+}
+/**
+ * @description - Converts types found on attributes to OpenAPI acceptable data types
+ *
+ * @returns Attributes using OpenAPI acceptable data types
+ */
+declare const cleanSchemaAttributes: (attributes: Struct.SchemaAttributes, { typeMap, isRequest, didAddStrapiComponentsToSchemas }: Options) => Record<string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject>;
+export default cleanSchemaAttributes;
+//# sourceMappingURL=clean-schema-attributes.d.ts.map

package/dist/server/src/services/helpers/utils/clean-schema-attributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-schema-attributes.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/clean-schema-attributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAK/C,UAAU,OAAO;IACf,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,+BAA+B,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;CAC5E;AAED;;;;GAIG;AACH,QAAA,MAAM,qBAAqB,eACb,OAAO,gBAAgB,2DAC0C,OAAO,uEAgNrF,CAAC;AAEF,eAAe,qBAAqB,CAAC"}