@strapi/plugin-documentation 0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282 → 0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc

package/dist/server/services/override.js

@@ -6,8 +6,17 @@ const createService = ({ strapi })=>{
     const registeredOverrides = [];
     const excludedFromGeneration = [];
     return {
-        registeredOverrides,
-        excludedFromGeneration,
+        /**
+     * The registered overrides, merged by `generateFullDoc` in registration order.
+     *
+     * @internal
+     */ registeredOverrides,
+        /**
+     * The APIs and plugins left out of the generated paths. Names are kept as given, duplicates
+     * included.
+     *
+     * @internal
+     */ excludedFromGeneration,
         /**
      *
      * @param {(string | string[])} api - The name of the api or and array of apis to exclude from generation
@@ -18,7 +27,11 @@ const createService = ({ strapi })=>{
             }
             excludedFromGeneration.push(api);
         },
-        isEnabled (name) {
+        /**
+     * Whether `name` is excluded from generation. Despite its name, `true` means excluded.
+     *
+     * @internal
+     */ isEnabled (name) {
             return excludedFromGeneration.includes(name);
         },
         registerOverride (override, opts) {
@@ -36,6 +49,9 @@ const createService = ({ strapi })=>{
                 overrideToRegister = require('yaml').parse(overrideToRegister);
             }
             // receive an object we can register it directly
+            // TODO @Nico text that parses to a scalar, an array or `null` is registered as is, so
+            // `registeredOverrides` can hold more than OpenAPI parts; the exclusions above are also
+            // applied before a parse error is thrown.
             registeredOverrides.push(overrideToRegister);
         }
     };

package/dist/server/services/override.js.map

@@ -1 +1 @@
-{"version":3,"file":"override.js","sources":["../../../server/src/services/override.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\n\nimport { getPluginsThatNeedDocumentation } from './utils/get-plugins-that-need-documentation';\nimport type { PluginConfig } from '../types';\n\nexport type OverrideService = ReturnType<typeof createService>;\n\nconst createService = ({ strapi }: { strapi: Core.Strapi }) => {\n  const registeredOverrides: Partial<PluginConfig>[] = [];\n  const excludedFromGeneration: string[] = [];\n\n  return {\n    registeredOverrides,\n    excludedFromGeneration,\n    /**\n     *\n     * @param {(string | string[])} api - The name of the api or and array of apis to exclude from generation\n     */\n    excludeFromGeneration(api: string | string[]) {\n      if (Array.isArray(api)) {\n        excludedFromGeneration.push(...api);\n\n        return;\n      }\n\n      excludedFromGeneration.push(api);\n    },\n\n    isEnabled(name: string) {\n      return excludedFromGeneration.includes(name);\n    },\n\n    registerOverride(\n      override: Partial<PluginConfig>,\n      opts?: { pluginOrigin: string; excludeFromGeneration?: string[] }\n    ) {\n      const { pluginOrigin, excludeFromGeneration = [] } = opts ?? {};\n\n      const pluginsThatNeedDocumentation = getPluginsThatNeedDocumentation(\n        strapi.config.get('plugin::documentation')\n      );\n      // Don't apply the override if the plugin is not in the list of plugins that need documentation\n      if (pluginOrigin && !pluginsThatNeedDocumentation.includes(pluginOrigin)) return;\n\n      if (excludeFromGeneration.length) {\n        this.excludeFromGeneration(excludeFromGeneration);\n      }\n\n      let overrideToRegister = override;\n      // Parse yaml if we receive a string\n      if (typeof override === 'string') {\n        // eslint-disable-next-line @typescript-eslint/no-var-requires\n        overrideToRegister = require('yaml').parse(overrideToRegister);\n      }\n      // receive an object we can register it directly\n      registeredOverrides.push(overrideToRegister);\n    },\n  };\n};\n\nexport default createService;\n"],"names":["createService","strapi","registeredOverrides","excludedFromGeneration","excludeFromGeneration","api","Array","isArray","push","isEnabled","name","includes","registerOverride","override","opts","pluginOrigin","pluginsThatNeedDocumentation","getPluginsThatNeedDocumentation","config","get","length","overrideToRegister","require","parse"],"mappings":";;;;AAOA,MAAMA,aAAAA,GAAgB,CAAC,EAAEC,MAAM,EAA2B,GAAA;AACxD,IAAA,MAAMC,sBAA+C,EAAE;AACvD,IAAA,MAAMC,yBAAmC,EAAE;IAE3C,OAAO;AACLD,QAAAA,mBAAAA;AACAC,QAAAA,sBAAAA;AACA;;;AAGC,QACDC,uBAAsBC,GAAsB,EAAA;YAC1C,IAAIC,KAAAA,CAAMC,OAAO,CAACF,GAAAA,CAAAA,EAAM;AACtBF,gBAAAA,sBAAAA,CAAuBK,IAAI,CAAA,GAAIH,GAAAA,CAAAA;AAE/B,gBAAA;AACF,YAAA;AAEAF,YAAAA,sBAAAA,CAAuBK,IAAI,CAACH,GAAAA,CAAAA;AAC9B,QAAA,CAAA;AAEAI,QAAAA,SAAAA,CAAAA,CAAUC,IAAY,EAAA;YACpB,OAAOP,sBAAAA,CAAuBQ,QAAQ,CAACD,IAAAA,CAAAA;AACzC,QAAA,CAAA;QAEAE,gBAAAA,CAAAA,CACEC,QAA+B,EAC/BC,IAAiE,EAAA;YAEjE,MAAM,EAAEC,YAAY,EAAEX,qBAAAA,GAAwB,EAAE,EAAE,GAAGU,QAAQ,EAAC;AAE9D,YAAA,MAAME,+BAA+BC,+DAAAA,CACnChB,MAAAA,CAAOiB,MAAM,CAACC,GAAG,CAAC,uBAAA,CAAA,CAAA;;AAGpB,YAAA,IAAIJ,YAAAA,IAAgB,CAACC,4BAAAA,CAA6BL,QAAQ,CAACI,YAAAA,CAAAA,EAAe;YAE1E,IAAIX,qBAAAA,CAAsBgB,MAAM,EAAE;gBAChC,IAAI,CAAChB,qBAAqB,CAACA,qBAAAA,CAAAA;AAC7B,YAAA;AAEA,YAAA,IAAIiB,kBAAAA,GAAqBR,QAAAA;;YAEzB,IAAI,OAAOA,aAAa,QAAA,EAAU;;gBAEhCQ,kBAAAA,GAAqBC,OAAAA,CAAQ,MAAA,CAAA,CAAQC,KAAK,CAACF,kBAAAA,CAAAA;AAC7C,YAAA;;AAEAnB,YAAAA,mBAAAA,CAAoBM,IAAI,CAACa,kBAAAA,CAAAA;AAC3B,QAAA;AACF,KAAA;AACF;;;;"}
+{"version":3,"file":"override.js","sources":["../../../server/src/services/override.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\n\nimport { getPluginsThatNeedDocumentation } from './utils/get-plugins-that-need-documentation';\nimport type { PluginConfig } from '../types';\n\nexport type OverrideService = ReturnType<typeof createService>;\n\nconst createService = ({ strapi }: { strapi: Core.Strapi }) => {\n  const registeredOverrides: Partial<PluginConfig>[] = [];\n  const excludedFromGeneration: string[] = [];\n\n  return {\n    /**\n     * The registered overrides, merged by `generateFullDoc` in registration order.\n     *\n     * @internal\n     */\n    registeredOverrides,\n    /**\n     * The APIs and plugins left out of the generated paths. Names are kept as given, duplicates\n     * included.\n     *\n     * @internal\n     */\n    excludedFromGeneration,\n    /**\n     *\n     * @param {(string | string[])} api - The name of the api or and array of apis to exclude from generation\n     */\n    excludeFromGeneration(api: string | string[]) {\n      if (Array.isArray(api)) {\n        excludedFromGeneration.push(...api);\n\n        return;\n      }\n\n      excludedFromGeneration.push(api);\n    },\n\n    /**\n     * Whether `name` is excluded from generation. Despite its name, `true` means excluded.\n     *\n     * @internal\n     */\n    isEnabled(name: string) {\n      return excludedFromGeneration.includes(name);\n    },\n\n    registerOverride(\n      override: Partial<PluginConfig>,\n      opts?: { pluginOrigin: string; excludeFromGeneration?: string[] }\n    ) {\n      const { pluginOrigin, excludeFromGeneration = [] } = opts ?? {};\n\n      const pluginsThatNeedDocumentation = getPluginsThatNeedDocumentation(\n        strapi.config.get('plugin::documentation')\n      );\n      // Don't apply the override if the plugin is not in the list of plugins that need documentation\n      if (pluginOrigin && !pluginsThatNeedDocumentation.includes(pluginOrigin)) return;\n\n      if (excludeFromGeneration.length) {\n        this.excludeFromGeneration(excludeFromGeneration);\n      }\n\n      let overrideToRegister = override;\n      // Parse yaml if we receive a string\n      if (typeof override === 'string') {\n        // eslint-disable-next-line @typescript-eslint/no-var-requires\n        overrideToRegister = require('yaml').parse(overrideToRegister);\n      }\n      // receive an object we can register it directly\n      // TODO @Nico text that parses to a scalar, an array or `null` is registered as is, so\n      // `registeredOverrides` can hold more than OpenAPI parts; the exclusions above are also\n      // applied before a parse error is thrown.\n      registeredOverrides.push(overrideToRegister);\n    },\n  };\n};\n\nexport default createService;\n"],"names":["createService","strapi","registeredOverrides","excludedFromGeneration","excludeFromGeneration","api","Array","isArray","push","isEnabled","name","includes","registerOverride","override","opts","pluginOrigin","pluginsThatNeedDocumentation","getPluginsThatNeedDocumentation","config","get","length","overrideToRegister","require","parse"],"mappings":";;;;AAOA,MAAMA,aAAAA,GAAgB,CAAC,EAAEC,MAAM,EAA2B,GAAA;AACxD,IAAA,MAAMC,sBAA+C,EAAE;AACvD,IAAA,MAAMC,yBAAmC,EAAE;IAE3C,OAAO;AACL;;;;QAKAD,mBAAAA;AACA;;;;;QAMAC,sBAAAA;AACA;;;AAGC,QACDC,uBAAsBC,GAAsB,EAAA;YAC1C,IAAIC,KAAAA,CAAMC,OAAO,CAACF,GAAAA,CAAAA,EAAM;AACtBF,gBAAAA,sBAAAA,CAAuBK,IAAI,CAAA,GAAIH,GAAAA,CAAAA;AAE/B,gBAAA;AACF,YAAA;AAEAF,YAAAA,sBAAAA,CAAuBK,IAAI,CAACH,GAAAA,CAAAA;AAC9B,QAAA,CAAA;AAEA;;;;AAIC,QACDI,WAAUC,IAAY,EAAA;YACpB,OAAOP,sBAAAA,CAAuBQ,QAAQ,CAACD,IAAAA,CAAAA;AACzC,QAAA,CAAA;QAEAE,gBAAAA,CAAAA,CACEC,QAA+B,EAC/BC,IAAiE,EAAA;YAEjE,MAAM,EAAEC,YAAY,EAAEX,qBAAAA,GAAwB,EAAE,EAAE,GAAGU,QAAQ,EAAC;AAE9D,YAAA,MAAME,+BAA+BC,+DAAAA,CACnChB,MAAAA,CAAOiB,MAAM,CAACC,GAAG,CAAC,uBAAA,CAAA,CAAA;;AAGpB,YAAA,IAAIJ,YAAAA,IAAgB,CAACC,4BAAAA,CAA6BL,QAAQ,CAACI,YAAAA,CAAAA,EAAe;YAE1E,IAAIX,qBAAAA,CAAsBgB,MAAM,EAAE;gBAChC,IAAI,CAAChB,qBAAqB,CAACA,qBAAAA,CAAAA;AAC7B,YAAA;AAEA,YAAA,IAAIiB,kBAAAA,GAAqBR,QAAAA;;YAEzB,IAAI,OAAOA,aAAa,QAAA,EAAU;;gBAEhCQ,kBAAAA,GAAqBC,OAAAA,CAAQ,MAAA,CAAA,CAAQC,KAAK,CAACF,kBAAAA,CAAAA;AAC7C,YAAA;;;;;AAKAnB,YAAAA,mBAAAA,CAAoBM,IAAI,CAACa,kBAAAA,CAAAA;AAC3B,QAAA;AACF,KAAA;AACF;;;;"}

package/dist/server/services/override.mjs

@@ -4,8 +4,17 @@ const createService = ({ strapi })=>{
     const registeredOverrides = [];
     const excludedFromGeneration = [];
     return {
-        registeredOverrides,
-        excludedFromGeneration,
+        /**
+     * The registered overrides, merged by `generateFullDoc` in registration order.
+     *
+     * @internal
+     */ registeredOverrides,
+        /**
+     * The APIs and plugins left out of the generated paths. Names are kept as given, duplicates
+     * included.
+     *
+     * @internal
+     */ excludedFromGeneration,
         /**
      *
      * @param {(string | string[])} api - The name of the api or and array of apis to exclude from generation
@@ -16,7 +25,11 @@ const createService = ({ strapi })=>{
             }
             excludedFromGeneration.push(api);
         },
-        isEnabled (name) {
+        /**
+     * Whether `name` is excluded from generation. Despite its name, `true` means excluded.
+     *
+     * @internal
+     */ isEnabled (name) {
             return excludedFromGeneration.includes(name);
         },
         registerOverride (override, opts) {
@@ -34,6 +47,9 @@ const createService = ({ strapi })=>{
                 overrideToRegister = require('yaml').parse(overrideToRegister);
             }
             // receive an object we can register it directly
+            // TODO @Nico text that parses to a scalar, an array or `null` is registered as is, so
+            // `registeredOverrides` can hold more than OpenAPI parts; the exclusions above are also
+            // applied before a parse error is thrown.
             registeredOverrides.push(overrideToRegister);
         }
     };

package/dist/server/services/override.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"override.mjs","sources":["../../../server/src/services/override.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\n\nimport { getPluginsThatNeedDocumentation } from './utils/get-plugins-that-need-documentation';\nimport type { PluginConfig } from '../types';\n\nexport type OverrideService = ReturnType<typeof createService>;\n\nconst createService = ({ strapi }: { strapi: Core.Strapi }) => {\n  const registeredOverrides: Partial<PluginConfig>[] = [];\n  const excludedFromGeneration: string[] = [];\n\n  return {\n    registeredOverrides,\n    excludedFromGeneration,\n    /**\n     *\n     * @param {(string | string[])} api - The name of the api or and array of apis to exclude from generation\n     */\n    excludeFromGeneration(api: string | string[]) {\n      if (Array.isArray(api)) {\n        excludedFromGeneration.push(...api);\n\n        return;\n      }\n\n      excludedFromGeneration.push(api);\n    },\n\n    isEnabled(name: string) {\n      return excludedFromGeneration.includes(name);\n    },\n\n    registerOverride(\n      override: Partial<PluginConfig>,\n      opts?: { pluginOrigin: string; excludeFromGeneration?: string[] }\n    ) {\n      const { pluginOrigin, excludeFromGeneration = [] } = opts ?? {};\n\n      const pluginsThatNeedDocumentation = getPluginsThatNeedDocumentation(\n        strapi.config.get('plugin::documentation')\n      );\n      // Don't apply the override if the plugin is not in the list of plugins that need documentation\n      if (pluginOrigin && !pluginsThatNeedDocumentation.includes(pluginOrigin)) return;\n\n      if (excludeFromGeneration.length) {\n        this.excludeFromGeneration(excludeFromGeneration);\n      }\n\n      let overrideToRegister = override;\n      // Parse yaml if we receive a string\n      if (typeof override === 'string') {\n        // eslint-disable-next-line @typescript-eslint/no-var-requires\n        overrideToRegister = require('yaml').parse(overrideToRegister);\n      }\n      // receive an object we can register it directly\n      registeredOverrides.push(overrideToRegister);\n    },\n  };\n};\n\nexport default createService;\n"],"names":["createService","strapi","registeredOverrides","excludedFromGeneration","excludeFromGeneration","api","Array","isArray","push","isEnabled","name","includes","registerOverride","override","opts","pluginOrigin","pluginsThatNeedDocumentation","getPluginsThatNeedDocumentation","config","get","length","overrideToRegister","require","parse"],"mappings":";;AAOA,MAAMA,aAAAA,GAAgB,CAAC,EAAEC,MAAM,EAA2B,GAAA;AACxD,IAAA,MAAMC,sBAA+C,EAAE;AACvD,IAAA,MAAMC,yBAAmC,EAAE;IAE3C,OAAO;AACLD,QAAAA,mBAAAA;AACAC,QAAAA,sBAAAA;AACA;;;AAGC,QACDC,uBAAsBC,GAAsB,EAAA;YAC1C,IAAIC,KAAAA,CAAMC,OAAO,CAACF,GAAAA,CAAAA,EAAM;AACtBF,gBAAAA,sBAAAA,CAAuBK,IAAI,CAAA,GAAIH,GAAAA,CAAAA;AAE/B,gBAAA;AACF,YAAA;AAEAF,YAAAA,sBAAAA,CAAuBK,IAAI,CAACH,GAAAA,CAAAA;AAC9B,QAAA,CAAA;AAEAI,QAAAA,SAAAA,CAAAA,CAAUC,IAAY,EAAA;YACpB,OAAOP,sBAAAA,CAAuBQ,QAAQ,CAACD,IAAAA,CAAAA;AACzC,QAAA,CAAA;QAEAE,gBAAAA,CAAAA,CACEC,QAA+B,EAC/BC,IAAiE,EAAA;YAEjE,MAAM,EAAEC,YAAY,EAAEX,qBAAAA,GAAwB,EAAE,EAAE,GAAGU,QAAQ,EAAC;AAE9D,YAAA,MAAME,+BAA+BC,+BAAAA,CACnChB,MAAAA,CAAOiB,MAAM,CAACC,GAAG,CAAC,uBAAA,CAAA,CAAA;;AAGpB,YAAA,IAAIJ,YAAAA,IAAgB,CAACC,4BAAAA,CAA6BL,QAAQ,CAACI,YAAAA,CAAAA,EAAe;YAE1E,IAAIX,qBAAAA,CAAsBgB,MAAM,EAAE;gBAChC,IAAI,CAAChB,qBAAqB,CAACA,qBAAAA,CAAAA;AAC7B,YAAA;AAEA,YAAA,IAAIiB,kBAAAA,GAAqBR,QAAAA;;YAEzB,IAAI,OAAOA,aAAa,QAAA,EAAU;;gBAEhCQ,kBAAAA,GAAqBC,OAAAA,CAAQ,MAAA,CAAA,CAAQC,KAAK,CAACF,kBAAAA,CAAAA;AAC7C,YAAA;;AAEAnB,YAAAA,mBAAAA,CAAoBM,IAAI,CAACa,kBAAAA,CAAAA;AAC3B,QAAA;AACF,KAAA;AACF;;;;"}
+{"version":3,"file":"override.mjs","sources":["../../../server/src/services/override.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\n\nimport { getPluginsThatNeedDocumentation } from './utils/get-plugins-that-need-documentation';\nimport type { PluginConfig } from '../types';\n\nexport type OverrideService = ReturnType<typeof createService>;\n\nconst createService = ({ strapi }: { strapi: Core.Strapi }) => {\n  const registeredOverrides: Partial<PluginConfig>[] = [];\n  const excludedFromGeneration: string[] = [];\n\n  return {\n    /**\n     * The registered overrides, merged by `generateFullDoc` in registration order.\n     *\n     * @internal\n     */\n    registeredOverrides,\n    /**\n     * The APIs and plugins left out of the generated paths. Names are kept as given, duplicates\n     * included.\n     *\n     * @internal\n     */\n    excludedFromGeneration,\n    /**\n     *\n     * @param {(string | string[])} api - The name of the api or and array of apis to exclude from generation\n     */\n    excludeFromGeneration(api: string | string[]) {\n      if (Array.isArray(api)) {\n        excludedFromGeneration.push(...api);\n\n        return;\n      }\n\n      excludedFromGeneration.push(api);\n    },\n\n    /**\n     * Whether `name` is excluded from generation. Despite its name, `true` means excluded.\n     *\n     * @internal\n     */\n    isEnabled(name: string) {\n      return excludedFromGeneration.includes(name);\n    },\n\n    registerOverride(\n      override: Partial<PluginConfig>,\n      opts?: { pluginOrigin: string; excludeFromGeneration?: string[] }\n    ) {\n      const { pluginOrigin, excludeFromGeneration = [] } = opts ?? {};\n\n      const pluginsThatNeedDocumentation = getPluginsThatNeedDocumentation(\n        strapi.config.get('plugin::documentation')\n      );\n      // Don't apply the override if the plugin is not in the list of plugins that need documentation\n      if (pluginOrigin && !pluginsThatNeedDocumentation.includes(pluginOrigin)) return;\n\n      if (excludeFromGeneration.length) {\n        this.excludeFromGeneration(excludeFromGeneration);\n      }\n\n      let overrideToRegister = override;\n      // Parse yaml if we receive a string\n      if (typeof override === 'string') {\n        // eslint-disable-next-line @typescript-eslint/no-var-requires\n        overrideToRegister = require('yaml').parse(overrideToRegister);\n      }\n      // receive an object we can register it directly\n      // TODO @Nico text that parses to a scalar, an array or `null` is registered as is, so\n      // `registeredOverrides` can hold more than OpenAPI parts; the exclusions above are also\n      // applied before a parse error is thrown.\n      registeredOverrides.push(overrideToRegister);\n    },\n  };\n};\n\nexport default createService;\n"],"names":["createService","strapi","registeredOverrides","excludedFromGeneration","excludeFromGeneration","api","Array","isArray","push","isEnabled","name","includes","registerOverride","override","opts","pluginOrigin","pluginsThatNeedDocumentation","getPluginsThatNeedDocumentation","config","get","length","overrideToRegister","require","parse"],"mappings":";;AAOA,MAAMA,aAAAA,GAAgB,CAAC,EAAEC,MAAM,EAA2B,GAAA;AACxD,IAAA,MAAMC,sBAA+C,EAAE;AACvD,IAAA,MAAMC,yBAAmC,EAAE;IAE3C,OAAO;AACL;;;;QAKAD,mBAAAA;AACA;;;;;QAMAC,sBAAAA;AACA;;;AAGC,QACDC,uBAAsBC,GAAsB,EAAA;YAC1C,IAAIC,KAAAA,CAAMC,OAAO,CAACF,GAAAA,CAAAA,EAAM;AACtBF,gBAAAA,sBAAAA,CAAuBK,IAAI,CAAA,GAAIH,GAAAA,CAAAA;AAE/B,gBAAA;AACF,YAAA;AAEAF,YAAAA,sBAAAA,CAAuBK,IAAI,CAACH,GAAAA,CAAAA;AAC9B,QAAA,CAAA;AAEA;;;;AAIC,QACDI,WAAUC,IAAY,EAAA;YACpB,OAAOP,sBAAAA,CAAuBQ,QAAQ,CAACD,IAAAA,CAAAA;AACzC,QAAA,CAAA;QAEAE,gBAAAA,CAAAA,CACEC,QAA+B,EAC/BC,IAAiE,EAAA;YAEjE,MAAM,EAAEC,YAAY,EAAEX,qBAAAA,GAAwB,EAAE,EAAE,GAAGU,QAAQ,EAAC;AAE9D,YAAA,MAAME,+BAA+BC,+BAAAA,CACnChB,MAAAA,CAAOiB,MAAM,CAACC,GAAG,CAAC,uBAAA,CAAA,CAAA;;AAGpB,YAAA,IAAIJ,YAAAA,IAAgB,CAACC,4BAAAA,CAA6BL,QAAQ,CAACI,YAAAA,CAAAA,EAAe;YAE1E,IAAIX,qBAAAA,CAAsBgB,MAAM,EAAE;gBAChC,IAAI,CAAChB,qBAAqB,CAACA,qBAAAA,CAAAA;AAC7B,YAAA;AAEA,YAAA,IAAIiB,kBAAAA,GAAqBR,QAAAA;;YAEzB,IAAI,OAAOA,aAAa,QAAA,EAAU;;gBAEhCQ,kBAAAA,GAAqBC,OAAAA,CAAQ,MAAA,CAAA,CAAQC,KAAK,CAACF,kBAAAA,CAAAA;AAC7C,YAAA;;;;;AAKAnB,YAAAA,mBAAAA,CAAoBM,IAAI,CAACa,kBAAAA,CAAAA;AAC3B,QAAA;AACF,KAAA;AACF;;;;"}

package/dist/server/src/config/index.d.ts

@@ -1,4 +1,4 @@
 export declare const config: {
-    default: import("../types").PluginConfig;
+    default: import("..").PluginConfig;
 };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"documentation.d.ts","sourceRoot":"","sources":["../../../../server/src/controllers/documentation.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;;kBAwBL,GAAG,CAAC,OAAO;eAkBd,GAAG,CAAC,OAAO,QAAQ,GAAG,CAAC,IAAI;mBA4DvB,GAAG,CAAC,OAAO,QAAQ,GAAG,CAAC,IAAI;eA4C/B,GAAG,CAAC,OAAO;uBAwBH,GAAG,CAAC,OAAO;mBAwBf,GAAG,CAAC,OAAO;wBAwBN,GAAG,CAAC,OAAO;;AAnMvC,wBAoNE"}
+{"version":3,"file":"documentation.d.ts","sourceRoot":"","sources":["../../../../server/src/controllers/documentation.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;;kBA2BL,GAAG,CAAC,OAAO;eAkBd,GAAG,CAAC,OAAO,QAAQ,GAAG,CAAC,IAAI;mBA4DvB,GAAG,CAAC,OAAO,QAAQ,GAAG,CAAC,IAAI;eA4C/B,GAAG,CAAC,OAAO;uBA0BH,GAAG,CAAC,OAAO;mBAwBf,GAAG,CAAC,OAAO;wBAwBN,GAAG,CAAC,OAAO;;AArMvC,wBAsNE"}

package/dist/server/src/controllers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../server/src/controllers/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,wBAEE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../server/src/controllers/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,wBAEwB"}

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

@@ -1,5 +1,8 @@
 import { bootstrap } from './bootstrap';
 import { register } from './register';
+export type * from './types';
+export type * from './types/services';
+export type * from './types/controllers';
 declare const _default: {
     bootstrap: typeof bootstrap;
     config: {
@@ -52,7 +55,7 @@ declare const _default: {
     register: typeof register;
     services: {
         documentation: ({ strapi }: {
-            strapi: import("@strapi/types/dist/core").Strapi;
+            strapi: import("@strapi/types/dist/core/strapi.js").Strapi;
         }) => {
             getDocumentationVersion(): string;
             getFullDocumentationPath(): string;
@@ -73,7 +76,7 @@ declare const _default: {
             generateFullDoc(versionOpt?: string): Promise<void>;
         };
         override: ({ strapi }: {
-            strapi: import("@strapi/types/dist/core").Strapi;
+            strapi: import("@strapi/types/dist/core/strapi.js").Strapi;
         }) => {
             registeredOverrides: Partial<import("./types").PluginConfig>[];
             excludedFromGeneration: string[];

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../server/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCAcuqB,CAAC;;;;;AAR9sB,wBAOE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../server/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAMtC,mBAAmB,SAAS,CAAC;AAC7B,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,qBAAqB,CAAC;;;;;;;;;;;;;oBAU0B,CAAC;;;;;;;;uBAA6J,CAAC;oBAA6B,CAAC;;;;;;;;;;;;;gBAAoM,CAAC;uBAAgC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCAAihB,CAAC;;;;;AARx/B,wBAOE"}

package/dist/server/src/routes/index.d.ts

@@ -1,10 +1,11 @@
-declare const _default: ({
+import type Koa from 'koa';
+declare const routes: ({
     method: string;
     path: string;
     handler: string;
     config: {
         auth: boolean;
-        middlewares: ((ctx: import("koa").Context, next: import("koa").Next) => Promise<any>)[];
+        middlewares: ((ctx: Koa.Context, next: Koa.Next) => Promise<any>)[];
         policies?: undefined;
     };
 } | {
@@ -31,5 +32,5 @@ declare const _default: ({
         middlewares?: undefined;
     };
 })[];
-export default _default;
+export default routes;
 //# sourceMappingURL=index.d.ts.map

package/dist/server/src/routes/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../server/src/routes/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,wBA+EE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../server/src/routes/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAM3B,QAAA,MAAM,MAAM,EAAE,CACV;IACE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE;QACN,IAAI,EAAE,OAAO,CAAC;QACd,WAAW,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QACpE,QAAQ,CAAC,EAAE,SAAS,CAAC;KACtB,CAAC;CACH,GACD;IACE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE;QACN,IAAI,EAAE,OAAO,CAAC;QACd,WAAW,CAAC,EAAE,SAAS,CAAC;QACxB,QAAQ,CAAC,EAAE,SAAS,CAAC;KACtB,CAAC;CACH,GACD;IACE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE;QACN,QAAQ,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE;gBAAE,OAAO,EAAE,MAAM,EAAE,CAAA;aAAE,CAAA;SAAE,EAAE,CAAC;QAC5D,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,WAAW,CAAC,EAAE,SAAS,CAAC;KACzB,CAAC;CACH,CACJ,EA+EqE,CAAC;AAEvE,eAAe,MAAM,CAAC"}

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

@@ -8,20 +8,53 @@ export type DocumentationService = ReturnType<typeof createService>;
 declare const createService: ({ strapi }: {
     strapi: Core.Strapi;
 }) => {
+    /**
+     * The documentation version of the plugin config (`info.version`).
+     *
+     * @internal
+     */
     getDocumentationVersion(): string;
+    /**
+     * The folder that holds one folder per generated version, each with its
+     * `full_documentation.json`.
+     *
+     * @internal
+     */
     getFullDocumentationPath(): string;
+    /**
+     * The generated versions. A version whose file cannot be read is left out.
+     *
+     * @internal
+     */
     getDocumentationVersions(): Version[];
     /**
      * Returns settings stored in core-store
+     *
+     * @internal
      */
     getDocumentationAccess(): Promise<{
         restrictedAccess: boolean;
     }>;
+    /**
+     * The documentation folder of an API (`getter: 'api'`) or of a plugin (`getter: 'plugin'`).
+     *
+     * @internal
+     */
     getApiDocumentationPath(api: {
         name: string;
         getter: string;
     }): string;
+    /**
+     * Removes the files of a version. A version that was never generated resolves without error.
+     *
+     * @internal
+     */
     deleteDocumentation(version: string): Promise<void>;
+    /**
+     * The APIs, then the documented plugins, with the names of their content types.
+     *
+     * @internal
+     */
     getPluginAndApiInfo(): {
         name: string;
         getter: string;
@@ -29,6 +62,8 @@ declare const createService: ({ strapi }: {
     }[];
     /**
      * @description - Creates the Swagger json files
+     *
+     * @internal
      */
     generateFullDoc(versionOpt?: string): Promise<void>;
 };

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

@@ -1 +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,GAAI,YAAY;IAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;CAAE;;;gCAqB1B,OAAO,EAAE;IAuBrC;;OAEG;;;;iCAY0B;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;iCAc1B,MAAM;;;;;;IA6BzC;;OAEG;iCACgC,MAAM;CA6G5C,CAAC;AAEF,eAAe,aAAa,CAAC"}
+{"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,GAAI,YAAY;IAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;CAAE;IAMtD;;;;OAIG;;IAKH;;;;;OAKG;;IAYH;;;;OAIG;gCACyB,OAAO,EAAE;IAuBrC;;;;OAIG;;;;IAYH;;;;OAIG;iCAC0B;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;IAc7D;;;;OAIG;iCACgC,MAAM;IASzC;;;;OAIG;;;;;;IAqBH;;;;OAIG;iCACgC,MAAM;CAmH5C,CAAC;AAEF,eAAe,aAAa,CAAC"}

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

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

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

@@ -1 +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,GAAI,KAAK,GAAG,OAKrC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}
+{"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;AAwJhD,QAAA,MAAM,4BAA4B,GAAI,KAAK,GAAG,wBAS7C,CAAC;AAEF,QAAA,MAAM,oBAAoB,GACxB,KAAK,GAAG,EACR,+CAA6D,OAQ9D,CAAC;AAEF,eAAe,oBAAoB,CAAC;AACpC,OAAO,EAAE,4BAA4B,EAAE,CAAC"}

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

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

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

@@ -1 +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"}
+{"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,EAAE,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAC;AAE9F,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,4BAA4B,EAAE,CAAC"}

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

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

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

@@ -1 +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;AAgBD;;;;GAIG;AACH,QAAA,MAAM,qBAAqB,GACzB,YAAY,MAAM,CAAC,gBAAgB,EACnC,yDAA6E,OAAO,KACnF,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,eAAe,CA+NnE,CAAC;AAEF,eAAe,qBAAqB,CAAC"}
+{"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,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,yBAAyB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChD,+BAA+B,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;CAC5E;AAgBD;;;;GAIG;AACH,QAAA,MAAM,qBAAqB,GACzB,YAAY,MAAM,CAAC,gBAAgB,EACnC,2EAAmF,OAAO,KACzF,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,eAAe,CAmOnE,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/server/src/services/helpers/utils/loop-content-type-names.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loop-content-type-names.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/loop-content-type-names.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,QAAA,MAAM,oBAAoB,GAAI,KAAK,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,KAAK,GAAG,OA2CvE,CAAC;AAEF,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"loop-content-type-names.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/loop-content-type-names.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,QAAA,MAAM,oBAAoB,GAAI,KAAK,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,KAAK,GAAG,OA4CvE,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/server/src/services/helpers/utils/query-params.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/query-params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,QAAA,MAAM,MAAM,EAAE,SAAS,CAAC,eAAe,EAuGtC,CAAC;AAEF,eAAe,MAAM,CAAC"}
+{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/query-params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,QAAA,MAAM,MAAM,EAAE,SAAS,CAAC,eAAe,EA+GtC,CAAC;AAEF,eAAe,MAAM,CAAC"}

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

@@ -1,8 +1,9 @@
+import type { Core } from '@strapi/types';
 import { type DocumentationService } from './documentation';
 import { type OverrideService } from './override';
 declare const _default: {
     documentation: ({ strapi }: {
-        strapi: import("@strapi/types/dist/core").Strapi;
+        strapi: Core.Strapi;
     }) => {
         getDocumentationVersion(): string;
         getFullDocumentationPath(): string;
@@ -23,13 +24,13 @@ declare const _default: {
         generateFullDoc(versionOpt?: string): Promise<void>;
     };
     override: ({ strapi }: {
-        strapi: import("@strapi/types/dist/core").Strapi;
+        strapi: Core.Strapi;
     }) => {
-        registeredOverrides: Partial<import("../types").PluginConfig>[];
+        registeredOverrides: Partial<import("..").PluginConfig>[];
         excludedFromGeneration: string[];
         excludeFromGeneration(api: string | string[]): void;
         isEnabled(name: string): boolean;
-        registerOverride(override: Partial<import("../types").PluginConfig>, opts?: {
+        registerOverride(override: Partial<import("..").PluginConfig>, opts?: {
             pluginOrigin: string;
             excludeFromGeneration?: string[];
         }): void;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../server/src/services/index.ts"],"names":[],"mappings":"AAEA,OAAsB,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAW+nB,CAAC;;;;AAT5rB,wBAGE;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,aAAa,EAAE,oBAAoB,CAAC;IACpC,QAAQ,EAAE,eAAe,CAAC;CAC3B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../server/src/services/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAK1C,OAAsB,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAiBuvB,CAAC;;;;AATpzB,wBAG6C;AAE7C,MAAM,MAAM,QAAQ,GAAG;IACrB,aAAa,EAAE,oBAAoB,CAAC;IACpC,QAAQ,EAAE,eAAe,CAAC;CAC3B,CAAC"}

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

@@ -4,13 +4,29 @@ export type OverrideService = ReturnType<typeof createService>;
 declare const createService: ({ strapi }: {
     strapi: Core.Strapi;
 }) => {
+    /**
+     * The registered overrides, merged by `generateFullDoc` in registration order.
+     *
+     * @internal
+     */
     registeredOverrides: Partial<PluginConfig>[];
+    /**
+     * The APIs and plugins left out of the generated paths. Names are kept as given, duplicates
+     * included.
+     *
+     * @internal
+     */
     excludedFromGeneration: string[];
     /**
      *
      * @param {(string | string[])} api - The name of the api or and array of apis to exclude from generation
      */
     excludeFromGeneration(api: string | string[]): void;
+    /**
+     * Whether `name` is excluded from generation. Despite its name, `true` means excluded.
+     *
+     * @internal
+     */
     isEnabled(name: string): boolean;
     registerOverride(override: Partial<PluginConfig>, opts?: {
         pluginOrigin: string;

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

@@ -1 +1 @@
-{"version":3,"file":"override.d.ts","sourceRoot":"","sources":["../../../../server/src/services/override.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAG1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAE/D,QAAA,MAAM,aAAa,GAAI,YAAY;IAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;CAAE;;;IAOtD;;;OAGG;+BACwB,MAAM,GAAG,MAAM,EAAE;oBAU5B,MAAM;+BAKV,OAAO,CAAC,YAAY,CAAC,SACxB;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE;CAwBtE,CAAC;AAEF,eAAe,aAAa,CAAC"}
+{"version":3,"file":"override.d.ts","sourceRoot":"","sources":["../../../../server/src/services/override.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAG1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAE/D,QAAA,MAAM,aAAa,GAAI,YAAY;IAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;CAAE;IAKtD;;;;OAIG;;IAEH;;;;;OAKG;;IAEH;;;OAGG;+BACwB,MAAM,GAAG,MAAM,EAAE;IAU5C;;;;OAIG;oBACa,MAAM;+BAKV,OAAO,CAAC,YAAY,CAAC,SACxB;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE;CA2BtE,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/server/src/types/controllers.d.ts

@@ -0,0 +1,26 @@
+import type { Core } from '@strapi/types';
+/** Actions serving the documentation page and its login, and admin actions on the documentation. */
+export type DocumentationController = {
+    getInfos: Core.ControllerHandler;
+    index: Core.ControllerHandler;
+    loginView: Core.ControllerHandler;
+    login: Core.ControllerHandler;
+    regenerateDoc: Core.ControllerHandler;
+    deleteDoc: Core.ControllerHandler;
+    updateSettings: Core.ControllerHandler;
+};
+/** The controller contracts by name, as in the plugin's controllers map. Used to check the routes. */
+export type Controllers = {
+    documentation: DocumentationController;
+};
+/** Default controller contracts loaded with the Documentation server types. */
+declare global {
+    namespace Strapi {
+        namespace Registries {
+            interface PackageControllers {
+                'plugin::documentation.documentation': Controllers['documentation'];
+            }
+        }
+    }
+}
+//# sourceMappingURL=controllers.d.ts.map

package/dist/server/src/types/controllers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controllers.d.ts","sourceRoot":"","sources":["../../../../server/src/types/controllers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,oGAAoG;AACpG,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC;IACjC,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC;IAC9B,SAAS,EAAE,IAAI,CAAC,iBAAiB,CAAC;IAClC,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC;IAC9B,aAAa,EAAE,IAAI,CAAC,iBAAiB,CAAC;IACtC,SAAS,EAAE,IAAI,CAAC,iBAAiB,CAAC;IAClC,cAAc,EAAE,IAAI,CAAC,iBAAiB,CAAC;CACxC,CAAC;AAEF,sGAAsG;AACtG,MAAM,MAAM,WAAW,GAAG;IACxB,aAAa,EAAE,uBAAuB,CAAC;CACxC,CAAC;AAEF,+EAA+E;AAC/E,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,MAAM,CAAC;QAEf,UAAU,UAAU,CAAC;YACnB,UAAU,kBAAkB;gBAC1B,qCAAqC,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;aACrE;SACF;KACF;CACF"}

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

@@ -0,0 +1,47 @@
+import type { Services } from '../services';
+import type { Config, PluginConfig } from '../types';
+export type { Services } from '../services';
+/**
+ * The registered `override` service: lets plugins and applications add their own OpenAPI parts to
+ * the generated documentation.
+ */
+export type OverrideService = Omit<Services['override'], 'registerOverride'> & {
+    /**
+     * Registers an OpenAPI part merged into every generated documentation version, or only into the
+     * version its `info.version` names.
+     *
+     * @param override - The OpenAPI part, or its YAML or JSON text. Text is parsed when it is
+     * registered, and a parse error is thrown to the caller.
+     * @param opts.pluginOrigin - The plugin the override documents. The override is skipped when that
+     * plugin is not in the documented plugins.
+     * @param opts.excludeFromGeneration - APIs and plugins left out of the generated paths, as
+     * `excludeFromGeneration` does.
+     */
+    registerOverride(override: Partial<PluginConfig> | string, opts?: {
+        pluginOrigin?: string;
+        excludeFromGeneration?: string[];
+    }): void;
+};
+/** Default contracts loaded with the Documentation server types. */
+declare global {
+    namespace Strapi {
+        namespace Registries {
+            /** The plugin config merged with its defaults. */
+            interface PackageConfigs {
+                'plugin::documentation': PluginConfig;
+            }
+            /**
+             * The access settings of the documentation page, written with `restrictedAccess: false` at the
+             * first start. `password` is the bcrypt hash of the access password, missing until one is set.
+             */
+            interface Stores {
+                plugin_documentation_config: Config;
+            }
+            interface PackageServices {
+                'plugin::documentation.documentation': Services['documentation'];
+                'plugin::documentation.override': OverrideService;
+            }
+        }
+    }
+}
+//# sourceMappingURL=services.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../../../server/src/types/services.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAErD,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC,GAAG;IAC7E;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,MAAM,EACxC,IAAI,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACjE,IAAI,CAAC;CACT,CAAC;AAEF,oEAAoE;AACpE,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,MAAM,CAAC;QAEf,UAAU,UAAU,CAAC;YACnB,kDAAkD;YAClD,UAAU,cAAc;gBACtB,uBAAuB,EAAE,YAAY,CAAC;aACvC;YAED;;;eAGG;YACH,UAAU,MAAM;gBACd,2BAA2B,EAAE,MAAM,CAAC;aACrC;YAED,UAAU,eAAe;gBACvB,qCAAqC,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;gBACjE,gCAAgC,EAAE,eAAe,CAAC;aACnD;SACF;KACF;CACF"}

package/dist/server/src/types.d.ts

@@ -14,6 +14,7 @@ export type PluginConfig = OpenAPIV3.Document & {
     };
 };
 export interface ApiInfo {
+    uid: string;
     routeInfo: Core.Router;
     attributes: Struct.SchemaAttributes;
     uniqueName: string;

package/dist/server/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../server/src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,MAAM,WAAW,MAAM;IACrB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,GAAG;IAC9C,IAAI,EAAE,SAAS,CAAC,UAAU,GAAG;QAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,iBAAiB,EAAE;QACjB,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACzB,mBAAmB,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,QAAQ,KAAK,SAAS,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;KAClF,CAAC;CACH,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC,gBAAgB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,GAAG,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,GAAG;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../server/src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,MAAM,WAAW,MAAM;IACrB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,GAAG;IAC9C,IAAI,EAAE,SAAS,CAAC,UAAU,GAAG;QAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,iBAAiB,EAAE;QACjB,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACzB,mBAAmB,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,QAAQ,KAAK,SAAS,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;KAClF,CAAC;CACH,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC,gBAAgB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,GAAG,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,GAAG;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
+  "version": "0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc",
   "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
   "homepage": "https://strapi.io",
   "bugs": {
@@ -52,24 +52,25 @@
     "build:types:server": "run -T tsc -p server/tsconfig.build.json --emitDeclarationOnly",
     "build:types:admin": "run -T tsc -p admin/tsconfig.build.json --emitDeclarationOnly",
     "clean": "run -T rimraf ./dist",
-    "lint": "run -T eslint .",
+    "lint": "run -T eslint . --max-warnings=0",
     "test:front": "run -T cross-env IS_EE=true jest --config ./jest.config.front.js",
     "test:front:watch": "run -T cross-env IS_EE=true jest --config ./jest.config.front.js --watchAll",
     "test:ts:front": "run -T tsc -p admin/tsconfig.json",
-    "test:ts:back": "run -T tsc --noEmit -p server/tsconfig.json",
+    "test:ts:back": "run -T tsc -p server/tsconfig.json",
     "test:unit": "run -T jest --verbose",
     "test:unit:watch": "run -T jest --watch",
     "watch": "run -T rollup -c -w"
   },
   "dependencies": {
     "@reduxjs/toolkit": "1.9.7",
-    "@strapi/admin": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
-    "@strapi/design-system": "2.2.1",
-    "@strapi/icons": "2.2.1",
-    "@strapi/utils": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
+    "@strapi/admin": "0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc",
+    "@strapi/design-system": "2.2.4",
+    "@strapi/icons": "2.2.4",
+    "@strapi/types": "0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc",
+    "@strapi/utils": "0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.2.0",
-    "formik": "2.4.5",
+    "formik": "2.4.9",
     "fs-extra": "11.3.4",
     "immer": "9.0.21",
     "koa-static": "^5.0.0",
@@ -82,14 +83,18 @@
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@strapi/admin-test-utils": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
-    "@strapi/strapi": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
-    "@strapi/types": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
+    "@strapi/admin-test-utils": "0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc",
+    "@strapi/strapi": "0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc",
+    "@testing-library/dom": "10.4.1",
+    "@testing-library/jest-dom": "6.9.1",
     "@testing-library/react": "16.3.2",
     "@testing-library/user-event": "14.6.1",
     "@types/fs-extra": "11.0.4",
+    "@types/jest": "29.5.2",
     "@types/koa": "2.15.2",
+    "@types/node": "20.19.41",
     "@types/swagger-ui-dist": "3.30.4",
+    "jest": "29.6.0",
     "koa": "2.16.4",
     "koa-body": "6.0.1",
     "koa-session": "7.0.2",
@@ -97,18 +102,18 @@
     "openapi-types": "12.1.3",
     "react": "18.3.1",
     "react-dom": "18.3.1",
-    "react-router-dom": "6.30.3",
+    "react-router-dom": "6.30.6",
     "styled-components": "6.4.1"
   },
   "peerDependencies": {
-    "@strapi/strapi": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
-    "react": "^17.0.0 || ^18.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0",
+    "@strapi/strapi": "0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
     "react-router-dom": "^6.30.3",
     "styled-components": "^6.0.0"
   },
   "engines": {
-    "node": ">=20.19.0 <=26.x.x",
+    "node": ">=20.0.0 <=26.x.x",
     "npm": ">=6.0.0"
   },
   "strapi": {
@@ -116,5 +121,12 @@
     "name": "documentation",
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
+  },
+  "typesVersions": {
+    "*": {
+      "strapi-server": [
+        "dist/server/src/index.d.ts"
+      ]
+    }
   }
 }