@strapi/typescript-utils 0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282 → 0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc

package/dist/generators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/generators/index.ts"],"sourcesContent":["import path from 'node:path';\nimport fs from 'node:fs/promises';\nimport chalk from 'chalk';\n\nimport { TYPES_ROOT_DIR, GENERATED_OUT_DIR } from './constants';\nimport { saveDefinitionToFileSystem, createLogger, timer, pathExists } from './utils';\nimport { generateContentTypesDefinitions } from './content-types';\nimport { generateComponentsDefinitions } from './components';\nimport { generatePluginDefinitions } from './plugins';\nimport { generateServicesDefinitions } from './services';\nimport { generateControllersDefinitions } from './controllers';\nimport { generatePoliciesDefinitions } from './policies';\nimport { generateMiddlewaresDefinitions } from './middlewares';\nimport { generateStrictDefinitions } from './strict';\n\nconst GENERATORS = {\n  contentTypes: generateContentTypesDefinitions,\n  components: generateComponentsDefinitions,\n  plugins: generatePluginDefinitions,\n  services: generateServicesDefinitions,\n  controllers: generateControllersDefinitions,\n  policies: generatePoliciesDefinitions,\n  middlewares: generateMiddlewaresDefinitions,\n  strict: generateStrictDefinitions,\n};\n\n/**\n * Artifacts written as `.ts` rather than `.d.ts`: they import the application's sources, and a\n * reference that no longer resolves (a moved source, a renamed contract) is reported by `tsc` even\n * with `skipLibCheck`, rather than silently typing the lookup as `any`. The other artifacts only\n * hold declarations generated from the schemas, and stay `.d.ts`.\n */\nconst SOURCE_ARTIFACTS = new Set(['services', 'controllers', 'policies', 'middlewares']);\n\n/**\n * The application's linters would check the `.ts` artifacts, whose helpers use `any`.\n */\nconst LINT_DISABLE_HEADER = '/* eslint-disable */\\n/* oxlint-disable */\\n';\n\nconst isSourceArtifact = (artifact: string) => SOURCE_ARTIFACTS.has(artifact);\n\nconst filenameOf = (artifact: string) =>\n  isSourceArtifact(artifact) === true ? `${artifact}.ts` : `${artifact}.d.ts`;\n\n/**\n * File name an earlier generation wrote the artifact to, removed with the artifact's own file\n */\nconst previousFilenameOf = (artifact: string) =>\n  isSourceArtifact(artifact) === true ? `${artifact}.d.ts` : undefined;\n\nexport interface GenerateConfig {\n  strapi: any;\n  pwd: string;\n  rootDir?: string;\n  /**\n   * Artifacts to generate. `true` generates the artifact, `false` removes the file a previous\n   * run may have generated for it, unset leaves it untouched.\n   * `services`, `controllers`, `policies`, `middlewares` and `strict` are the strict types artifacts\n   * (`typescript.strictTypes`).\n   */\n  artifacts?: {\n    contentTypes?: boolean;\n    components?: boolean;\n    plugins?: boolean;\n    services?: boolean;\n    strict?: boolean;\n    controllers?: boolean;\n    policies?: boolean;\n    middlewares?: boolean;\n  };\n  logger?: {\n    silent?: boolean;\n    debug?: boolean;\n    verbose?: boolean;\n  };\n}\n\n/**\n * Generate types definitions based on the given configuration\n */\nexport const generate = async (config: GenerateConfig = {} as GenerateConfig) => {\n  const { pwd, rootDir = TYPES_ROOT_DIR, strapi, artifacts = {}, logger: loggerConfig } = config;\n  const reports: Record<string, any> = {};\n  const logger = createLogger(loggerConfig);\n  const psTimer = timer().start();\n\n  const registryPwd = path.join(pwd, rootDir, GENERATED_OUT_DIR);\n  // Strict mode reads only the global schema registries, so schemas use that form with the opt-in.\n  const strict = artifacts.strict === true;\n  const generatorConfig = { strapi, pwd: registryPwd, appDir: pwd, logger, strict };\n\n  const returnWithMessage = () => {\n    const nbWarnings = chalk.yellow(`${logger.warnings} warning(s)`);\n    const nbErrors = chalk.red(`${logger.errors} error(s)`);\n\n    const status = logger.errors > 0 ? chalk.red('errored') : chalk.green('completed successfully');\n\n    psTimer.end();\n\n    logger.info(`The task ${status} with ${nbWarnings} and ${nbErrors} in ${psTimer.duration}s.`);\n\n    return reports;\n  };\n\n  const enabledArtifacts = Object.keys(artifacts).filter(\n    (p) => (artifacts as Record<string, boolean>)[p] === true\n  );\n  const disabledArtifacts = Object.keys(artifacts).filter(\n    (p) => (artifacts as Record<string, boolean>)[p] === false && p in GENERATORS\n  );\n\n  logger.info('Starting the type generation process');\n  logger.debug(`Enabled artifacts: ${enabledArtifacts.join(', ')}`);\n\n  for (const artifact of enabledArtifacts) {\n    const boldArtifact = chalk.bold(artifact); // used for log messages\n\n    logger.info(`Generating types for ${boldArtifact}`);\n\n    if (artifact in GENERATORS) {\n      const generator = (GENERATORS as any)[artifact];\n\n      try {\n        const artifactGenTimer = timer().start();\n\n        reports[artifact] = await generator(generatorConfig);\n\n        artifactGenTimer.end();\n\n        logger.debug(`Generated ${boldArtifact} in ${artifactGenTimer.duration}s`);\n      } catch (e) {\n        logger.error(\n          `Failed to generate types for ${boldArtifact}: ${(e as any).message ?? (e as any).toString()}. Exiting`\n        );\n        return returnWithMessage();\n      }\n    } else {\n      logger.warn(`The types generator for ${boldArtifact} is not implemented, skipping`);\n    }\n  }\n\n  for (const artifact of Object.keys(reports)) {\n    const boldArtifact = chalk.bold(artifact); // used for log messages\n\n    const artifactFsTimer = timer().start();\n\n    const report = reports[artifact];\n    const filename = filenameOf(artifact);\n    const previousFilename = previousFilenameOf(artifact);\n    const content =\n      isSourceArtifact(artifact) === true\n        ? `${LINT_DISABLE_HEADER}${report.output}`\n        : report.output;\n\n    try {\n      const outPath = await saveDefinitionToFileSystem(registryPwd, filename, content);\n\n      // A stale `.d.ts` would declare the registry entries a second time\n      if (previousFilename !== undefined) {\n        await fs.rm(path.join(registryPwd, previousFilename), { force: true });\n      }\n\n      const relativeOutPath = path.relative(process.cwd(), outPath);\n\n      artifactFsTimer.end();\n\n      logger.info(`Saved ${boldArtifact} types in ${chalk.bold(relativeOutPath)}`);\n      logger.debug(`Saved ${boldArtifact} in ${artifactFsTimer.duration}s`);\n    } catch (e) {\n      logger.error(\n        `An error occurred while saving ${boldArtifact} types to the filesystem: ${\n          (e as any).message ?? (e as any).toString()\n        }. Exiting`\n      );\n      return returnWithMessage();\n    }\n  }\n\n  // Disabled artifacts are removed so that a stale generated file does not keep applying\n  for (const artifact of disabledArtifacts) {\n    const boldArtifact = chalk.bold(artifact); // used for log messages\n    const previousFilename = previousFilenameOf(artifact);\n    const outPaths = [\n      filenameOf(artifact),\n      ...(previousFilename === undefined ? [] : [previousFilename]),\n    ].map((filename) => path.join(registryPwd, filename));\n\n    try {\n      for (const outPath of outPaths) {\n        if ((await pathExists(outPath)) === false) {\n          continue;\n        }\n\n        await fs.rm(outPath);\n\n        logger.info(\n          `Removed ${boldArtifact} types from ${chalk.bold(path.relative(process.cwd(), outPath))} (artifact disabled)`\n        );\n      }\n    } catch (e) {\n      logger.error(\n        `An error occurred while removing ${boldArtifact} types from the filesystem: ${\n          (e as any).message ?? (e as any).toString()\n        }. Exiting`\n      );\n      return returnWithMessage();\n    }\n  }\n\n  return returnWithMessage();\n};\n"],"names":["GENERATORS","contentTypes","generateContentTypesDefinitions","components","generateComponentsDefinitions","plugins","generatePluginDefinitions","services","generateServicesDefinitions","controllers","generateControllersDefinitions","policies","generatePoliciesDefinitions","middlewares","generateMiddlewaresDefinitions","strict","generateStrictDefinitions","SOURCE_ARTIFACTS","Set","LINT_DISABLE_HEADER","isSourceArtifact","artifact","has","filenameOf","previousFilenameOf","undefined","generate","config","pwd","rootDir","TYPES_ROOT_DIR","strapi","artifacts","logger","loggerConfig","reports","createLogger","psTimer","timer","start","registryPwd","path","join","GENERATED_OUT_DIR","generatorConfig","appDir","returnWithMessage","nbWarnings","chalk","yellow","warnings","nbErrors","red","errors","status","green","end","info","duration","enabledArtifacts","Object","keys","filter","p","disabledArtifacts","debug","boldArtifact","bold","generator","artifactGenTimer","e","error","message","toString","warn","artifactFsTimer","report","filename","previousFilename","content","output","outPath","saveDefinitionToFileSystem","fs","rm","force","relativeOutPath","relative","process","cwd","outPaths","map","pathExists"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAeA,MAAMA,UAAAA,GAAa;IACjBC,YAAAA,EAAcC,uCAAAA;IACdC,UAAAA,EAAYC,qCAAAA;IACZC,OAAAA,EAASC,iCAAAA;IACTC,QAAAA,EAAUC,mCAAAA;IACVC,WAAAA,EAAaC,sCAAAA;IACbC,QAAAA,EAAUC,mCAAAA;IACVC,WAAAA,EAAaC,sCAAAA;IACbC,MAAAA,EAAQC;AACV,CAAA;AAEA;;;;;IAMA,MAAMC,gBAAAA,GAAmB,IAAIC,GAAAA,CAAI;AAAC,IAAA,UAAA;AAAY,IAAA,aAAA;AAAe,IAAA,UAAA;AAAY,IAAA;AAAc,CAAA,CAAA;AAEvF;;AAEC,IACD,MAAMC,mBAAAA,GAAsB,8CAAA;AAE5B,MAAMC,gBAAAA,GAAmB,CAACC,QAAAA,GAAqBJ,gBAAAA,CAAiBK,GAAG,CAACD,QAAAA,CAAAA;AAEpE,MAAME,UAAAA,GAAa,CAACF,QAAAA,GAClBD,gBAAAA,CAAiBC,cAAc,IAAA,GAAO,CAAA,EAAGA,QAAAA,CAAS,GAAG,CAAC,GAAG,CAAA,EAAGA,QAAAA,CAAS,KAAK,CAAC;AAE7E;;IAGA,MAAMG,kBAAAA,GAAqB,CAACH,QAAAA,GAC1BD,gBAAAA,CAAiBC,QAAAA,CAAAA,KAAc,IAAA,GAAO,CAAA,EAAGA,QAAAA,CAAS,KAAK,CAAC,GAAGI,SAAAA;AA6B7D;;AAEC,IACM,MAAMC,QAAAA,GAAW,OAAOC,MAAAA,GAAyB,EAAoB,GAAA;AAC1E,IAAA,MAAM,EAAEC,GAAG,EAAEC,OAAAA,GAAUC,wBAAc,EAAEC,MAAM,EAAEC,SAAAA,GAAY,EAAE,EAAEC,MAAAA,EAAQC,YAAY,EAAE,GAAGP,MAAAA;AACxF,IAAA,MAAMQ,UAA+B,EAAC;AACtC,IAAA,MAAMF,SAASG,kBAAAA,CAAaF,YAAAA,CAAAA;IAC5B,MAAMG,OAAAA,GAAUC,cAAQC,KAAK,EAAA;AAE7B,IAAA,MAAMC,WAAAA,GAAcC,qBAAAA,CAAKC,IAAI,CAACd,KAAKC,OAAAA,EAASc,2BAAAA,CAAAA;;IAE5C,MAAM5B,MAAAA,GAASiB,SAAAA,CAAUjB,MAAM,KAAK,IAAA;AACpC,IAAA,MAAM6B,eAAAA,GAAkB;AAAEb,QAAAA,MAAAA;QAAQH,GAAAA,EAAKY,WAAAA;QAAaK,MAAAA,EAAQjB,GAAAA;AAAKK,QAAAA,MAAAA;AAAQlB,QAAAA;AAAO,KAAA;AAEhF,IAAA,MAAM+B,iBAAAA,GAAoB,IAAA;QACxB,MAAMC,UAAAA,GAAaC,uBAAMC,MAAM,CAAC,GAAGhB,MAAAA,CAAOiB,QAAQ,CAAC,WAAW,CAAC,CAAA;QAC/D,MAAMC,QAAAA,GAAWH,uBAAMI,GAAG,CAAC,GAAGnB,MAAAA,CAAOoB,MAAM,CAAC,SAAS,CAAC,CAAA;QAEtD,MAAMC,MAAAA,GAASrB,MAAAA,CAAOoB,MAAM,GAAG,CAAA,GAAIL,sBAAAA,CAAMI,GAAG,CAAC,SAAA,CAAA,GAAaJ,sBAAAA,CAAMO,KAAK,CAAC,wBAAA,CAAA;AAEtElB,QAAAA,OAAAA,CAAQmB,GAAG,EAAA;AAEXvB,QAAAA,MAAAA,CAAOwB,IAAI,CAAC,CAAC,SAAS,EAAEH,MAAAA,CAAO,MAAM,EAAEP,UAAAA,CAAW,KAAK,EAAEI,SAAS,IAAI,EAAEd,QAAQqB,QAAQ,CAAC,EAAE,CAAC,CAAA;QAE5F,OAAOvB,OAAAA;AACT,IAAA,CAAA;AAEA,IAAA,MAAMwB,gBAAAA,GAAmBC,MAAAA,CAAOC,IAAI,CAAC7B,SAAAA,CAAAA,CAAW8B,MAAM,CACpD,CAACC,CAAAA,GAAO/B,SAAqC,CAAC+B,EAAE,KAAK,IAAA,CAAA;AAEvD,IAAA,MAAMC,iBAAAA,GAAoBJ,MAAAA,CAAOC,IAAI,CAAC7B,WAAW8B,MAAM,CACrD,CAACC,CAAAA,GAAM,SAAsC,CAACA,CAAAA,CAAE,KAAK,SAASA,CAAAA,IAAK/D,UAAAA,CAAAA;AAGrEiC,IAAAA,MAAAA,CAAOwB,IAAI,CAAC,sCAAA,CAAA;IACZxB,MAAAA,CAAOgC,KAAK,CAAC,CAAC,mBAAmB,EAAEN,gBAAAA,CAAiBjB,IAAI,CAAC,IAAA,CAAA,CAAA,CAAO,CAAA;IAEhE,KAAK,MAAMrB,YAAYsC,gBAAAA,CAAkB;AACvC,QAAA,MAAMO,YAAAA,GAAelB,sBAAAA,CAAMmB,IAAI,CAAC9C;AAEhCY,QAAAA,MAAAA,CAAOwB,IAAI,CAAC,CAAC,qBAAqB,EAAES,YAAAA,CAAAA,CAAc,CAAA;AAElD,QAAA,IAAI7C,YAAYrB,UAAAA,EAAY;AAC1B,YAAA,MAAMoE,SAAAA,GAAapE,UAAkB,CAACqB,QAAAA,CAAS;YAE/C,IAAI;gBACF,MAAMgD,gBAAAA,GAAmB/B,cAAQC,KAAK,EAAA;AAEtCJ,gBAAAA,OAAO,CAACd,QAAAA,CAAS,GAAG,MAAM+C,SAAAA,CAAUxB,eAAAA,CAAAA;AAEpCyB,gBAAAA,gBAAAA,CAAiBb,GAAG,EAAA;AAEpBvB,gBAAAA,MAAAA,CAAOgC,KAAK,CAAC,CAAC,UAAU,EAAEC,YAAAA,CAAa,IAAI,EAAEG,gBAAAA,CAAiBX,QAAQ,CAAC,CAAC,CAAC,CAAA;AAC3E,YAAA,CAAA,CAAE,OAAOY,CAAAA,EAAG;AACVrC,gBAAAA,MAAAA,CAAOsC,KAAK,CACV,CAAC,6BAA6B,EAAEL,aAAa,EAAE,EAAE,CAACI,CAAUE,OAAO,IAAKF,EAAUG,QAAQ,EAAA,CAAG,SAAS,CAAC,CAAA;gBAEzG,OAAO3B,iBAAAA,EAAAA;AACT,YAAA;QACF,CAAA,MAAO;AACLb,YAAAA,MAAAA,CAAOyC,IAAI,CAAC,CAAC,wBAAwB,EAAER,YAAAA,CAAa,6BAA6B,CAAC,CAAA;AACpF,QAAA;AACF,IAAA;AAEA,IAAA,KAAK,MAAM7C,QAAAA,IAAYuC,MAAAA,CAAOC,IAAI,CAAC1B,OAAAA,CAAAA,CAAU;AAC3C,QAAA,MAAM+B,YAAAA,GAAelB,sBAAAA,CAAMmB,IAAI,CAAC9C;QAEhC,MAAMsD,eAAAA,GAAkBrC,cAAQC,KAAK,EAAA;QAErC,MAAMqC,MAAAA,GAASzC,OAAO,CAACd,QAAAA,CAAS;AAChC,QAAA,MAAMwD,WAAWtD,UAAAA,CAAWF,QAAAA,CAAAA;AAC5B,QAAA,MAAMyD,mBAAmBtD,kBAAAA,CAAmBH,QAAAA,CAAAA;QAC5C,MAAM0D,OAAAA,GACJ3D,gBAAAA,CAAiBC,QAAAA,CAAAA,KAAc,IAAA,GAC3B,CAAA,EAAGF,mBAAAA,CAAAA,EAAsByD,MAAAA,CAAOI,MAAM,CAAA,CAAE,GACxCJ,MAAAA,CAAOI,MAAM;QAEnB,IAAI;AACF,YAAA,MAAMC,OAAAA,GAAU,MAAMC,gCAAAA,CAA2B1C,WAAAA,EAAaqC,QAAAA,EAAUE,OAAAA,CAAAA;;AAGxE,YAAA,IAAID,qBAAqBrD,SAAAA,EAAW;AAClC,gBAAA,MAAM0D,oBAAGC,EAAE,CAAC3C,sBAAKC,IAAI,CAACF,aAAasC,gBAAAA,CAAAA,EAAmB;oBAAEO,KAAAA,EAAO;AAAK,iBAAA,CAAA;AACtE,YAAA;AAEA,YAAA,MAAMC,kBAAkB7C,qBAAAA,CAAK8C,QAAQ,CAACC,OAAAA,CAAQC,GAAG,EAAA,EAAIR,OAAAA,CAAAA;AAErDN,YAAAA,eAAAA,CAAgBnB,GAAG,EAAA;YAEnBvB,MAAAA,CAAOwB,IAAI,CAAC,CAAC,MAAM,EAAES,YAAAA,CAAa,UAAU,EAAElB,sBAAAA,CAAMmB,IAAI,CAACmB,eAAAA,CAAAA,CAAAA,CAAkB,CAAA;AAC3ErD,YAAAA,MAAAA,CAAOgC,KAAK,CAAC,CAAC,MAAM,EAAEC,YAAAA,CAAa,IAAI,EAAES,eAAAA,CAAgBjB,QAAQ,CAAC,CAAC,CAAC,CAAA;AACtE,QAAA,CAAA,CAAE,OAAOY,CAAAA,EAAG;AACVrC,YAAAA,MAAAA,CAAOsC,KAAK,CACV,CAAC,+BAA+B,EAAEL,aAAa,0BAA0B,EACvE,CAACI,CAAUE,OAAO,IAAKF,EAAUG,QAAQ,EAAA,CAC1C,SAAS,CAAC,CAAA;YAEb,OAAO3B,iBAAAA,EAAAA;AACT,QAAA;AACF,IAAA;;IAGA,KAAK,MAAMzB,YAAY2C,iBAAAA,CAAmB;AACxC,QAAA,MAAME,YAAAA,GAAelB,sBAAAA,CAAMmB,IAAI,CAAC9C;AAChC,QAAA,MAAMyD,mBAAmBtD,kBAAAA,CAAmBH,QAAAA,CAAAA;AAC5C,QAAA,MAAMqE,QAAAA,GAAW;YACfnE,UAAAA,CAAWF,QAAAA,CAAAA;eACPyD,gBAAAA,KAAqBrD,SAAAA,GAAY,EAAE,GAAG;AAACqD,gBAAAA;AAAiB;AAC7D,SAAA,CAACa,GAAG,CAAC,CAACd,WAAapC,qBAAAA,CAAKC,IAAI,CAACF,WAAAA,EAAaqC,QAAAA,CAAAA,CAAAA;QAE3C,IAAI;YACF,KAAK,MAAMI,WAAWS,QAAAA,CAAU;AAC9B,gBAAA,IAAI,MAAOE,gBAAAA,CAAWX,OAAAA,CAAAA,KAAc,KAAA,EAAO;AACzC,oBAAA;AACF,gBAAA;gBAEA,MAAME,mBAAAA,CAAGC,EAAE,CAACH,OAAAA,CAAAA;AAEZhD,gBAAAA,MAAAA,CAAOwB,IAAI,CACT,CAAC,QAAQ,EAAES,YAAAA,CAAa,YAAY,EAAElB,sBAAAA,CAAMmB,IAAI,CAAC1B,qBAAAA,CAAK8C,QAAQ,CAACC,OAAAA,CAAQC,GAAG,EAAA,EAAIR,OAAAA,CAAAA,CAAAA,CAAU,oBAAoB,CAAC,CAAA;AAEjH,YAAA;AACF,QAAA,CAAA,CAAE,OAAOX,CAAAA,EAAG;AACVrC,YAAAA,MAAAA,CAAOsC,KAAK,CACV,CAAC,iCAAiC,EAAEL,aAAa,4BAA4B,EAC3E,CAACI,CAAUE,OAAO,IAAKF,EAAUG,QAAQ,EAAA,CAC1C,SAAS,CAAC,CAAA;YAEb,OAAO3B,iBAAAA,EAAAA;AACT,QAAA;AACF,IAAA;IAEA,OAAOA,iBAAAA,EAAAA;AACT;;;;"}

package/dist/generators/index.mjs

@@ -0,0 +1,142 @@
+import path from 'node:path';
+import fs from 'node:fs/promises';
+import chalk from 'chalk';
+import { TYPES_ROOT_DIR, GENERATED_OUT_DIR } from './constants.mjs';
+import { createLogger, timer, saveDefinitionToFileSystem, pathExists } from './utils.mjs';
+import { generateContentTypesDefinitions } from './content-types/index.mjs';
+import { generateComponentsDefinitions } from './components/index.mjs';
+import { generatePluginDefinitions } from './plugins/index.mjs';
+import { generateServicesDefinitions } from './services/index.mjs';
+import { generateControllersDefinitions } from './controllers/index.mjs';
+import { generatePoliciesDefinitions } from './policies/index.mjs';
+import { generateMiddlewaresDefinitions } from './middlewares/index.mjs';
+import { generateStrictDefinitions } from './strict/index.mjs';
+
+const GENERATORS = {
+    contentTypes: generateContentTypesDefinitions,
+    components: generateComponentsDefinitions,
+    plugins: generatePluginDefinitions,
+    services: generateServicesDefinitions,
+    controllers: generateControllersDefinitions,
+    policies: generatePoliciesDefinitions,
+    middlewares: generateMiddlewaresDefinitions,
+    strict: generateStrictDefinitions
+};
+/**
+ * Artifacts written as `.ts` rather than `.d.ts`: they import the application's sources, and a
+ * reference that no longer resolves (a moved source, a renamed contract) is reported by `tsc` even
+ * with `skipLibCheck`, rather than silently typing the lookup as `any`. The other artifacts only
+ * hold declarations generated from the schemas, and stay `.d.ts`.
+ */ const SOURCE_ARTIFACTS = new Set([
+    'services',
+    'controllers',
+    'policies',
+    'middlewares'
+]);
+/**
+ * The application's linters would check the `.ts` artifacts, whose helpers use `any`.
+ */ const LINT_DISABLE_HEADER = '/* eslint-disable */\n/* oxlint-disable */\n';
+const isSourceArtifact = (artifact)=>SOURCE_ARTIFACTS.has(artifact);
+const filenameOf = (artifact)=>isSourceArtifact(artifact) === true ? `${artifact}.ts` : `${artifact}.d.ts`;
+/**
+ * File name an earlier generation wrote the artifact to, removed with the artifact's own file
+ */ const previousFilenameOf = (artifact)=>isSourceArtifact(artifact) === true ? `${artifact}.d.ts` : undefined;
+/**
+ * Generate types definitions based on the given configuration
+ */ const generate = async (config = {})=>{
+    const { pwd, rootDir = TYPES_ROOT_DIR, strapi, artifacts = {}, logger: loggerConfig } = config;
+    const reports = {};
+    const logger = createLogger(loggerConfig);
+    const psTimer = timer().start();
+    const registryPwd = path.join(pwd, rootDir, GENERATED_OUT_DIR);
+    // Strict mode reads only the global schema registries, so schemas use that form with the opt-in.
+    const strict = artifacts.strict === true;
+    const generatorConfig = {
+        strapi,
+        pwd: registryPwd,
+        appDir: pwd,
+        logger,
+        strict
+    };
+    const returnWithMessage = ()=>{
+        const nbWarnings = chalk.yellow(`${logger.warnings} warning(s)`);
+        const nbErrors = chalk.red(`${logger.errors} error(s)`);
+        const status = logger.errors > 0 ? chalk.red('errored') : chalk.green('completed successfully');
+        psTimer.end();
+        logger.info(`The task ${status} with ${nbWarnings} and ${nbErrors} in ${psTimer.duration}s.`);
+        return reports;
+    };
+    const enabledArtifacts = Object.keys(artifacts).filter((p)=>artifacts[p] === true);
+    const disabledArtifacts = Object.keys(artifacts).filter((p)=>artifacts[p] === false && p in GENERATORS);
+    logger.info('Starting the type generation process');
+    logger.debug(`Enabled artifacts: ${enabledArtifacts.join(', ')}`);
+    for (const artifact of enabledArtifacts){
+        const boldArtifact = chalk.bold(artifact); // used for log messages
+        logger.info(`Generating types for ${boldArtifact}`);
+        if (artifact in GENERATORS) {
+            const generator = GENERATORS[artifact];
+            try {
+                const artifactGenTimer = timer().start();
+                reports[artifact] = await generator(generatorConfig);
+                artifactGenTimer.end();
+                logger.debug(`Generated ${boldArtifact} in ${artifactGenTimer.duration}s`);
+            } catch (e) {
+                logger.error(`Failed to generate types for ${boldArtifact}: ${e.message ?? e.toString()}. Exiting`);
+                return returnWithMessage();
+            }
+        } else {
+            logger.warn(`The types generator for ${boldArtifact} is not implemented, skipping`);
+        }
+    }
+    for (const artifact of Object.keys(reports)){
+        const boldArtifact = chalk.bold(artifact); // used for log messages
+        const artifactFsTimer = timer().start();
+        const report = reports[artifact];
+        const filename = filenameOf(artifact);
+        const previousFilename = previousFilenameOf(artifact);
+        const content = isSourceArtifact(artifact) === true ? `${LINT_DISABLE_HEADER}${report.output}` : report.output;
+        try {
+            const outPath = await saveDefinitionToFileSystem(registryPwd, filename, content);
+            // A stale `.d.ts` would declare the registry entries a second time
+            if (previousFilename !== undefined) {
+                await fs.rm(path.join(registryPwd, previousFilename), {
+                    force: true
+                });
+            }
+            const relativeOutPath = path.relative(process.cwd(), outPath);
+            artifactFsTimer.end();
+            logger.info(`Saved ${boldArtifact} types in ${chalk.bold(relativeOutPath)}`);
+            logger.debug(`Saved ${boldArtifact} in ${artifactFsTimer.duration}s`);
+        } catch (e) {
+            logger.error(`An error occurred while saving ${boldArtifact} types to the filesystem: ${e.message ?? e.toString()}. Exiting`);
+            return returnWithMessage();
+        }
+    }
+    // Disabled artifacts are removed so that a stale generated file does not keep applying
+    for (const artifact of disabledArtifacts){
+        const boldArtifact = chalk.bold(artifact); // used for log messages
+        const previousFilename = previousFilenameOf(artifact);
+        const outPaths = [
+            filenameOf(artifact),
+            ...previousFilename === undefined ? [] : [
+                previousFilename
+            ]
+        ].map((filename)=>path.join(registryPwd, filename));
+        try {
+            for (const outPath of outPaths){
+                if (await pathExists(outPath) === false) {
+                    continue;
+                }
+                await fs.rm(outPath);
+                logger.info(`Removed ${boldArtifact} types from ${chalk.bold(path.relative(process.cwd(), outPath))} (artifact disabled)`);
+            }
+        } catch (e) {
+            logger.error(`An error occurred while removing ${boldArtifact} types from the filesystem: ${e.message ?? e.toString()}. Exiting`);
+            return returnWithMessage();
+        }
+    }
+    return returnWithMessage();
+};
+
+export { generate };
+//# sourceMappingURL=index.mjs.map

package/dist/generators/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../src/generators/index.ts"],"sourcesContent":["import path from 'node:path';\nimport fs from 'node:fs/promises';\nimport chalk from 'chalk';\n\nimport { TYPES_ROOT_DIR, GENERATED_OUT_DIR } from './constants';\nimport { saveDefinitionToFileSystem, createLogger, timer, pathExists } from './utils';\nimport { generateContentTypesDefinitions } from './content-types';\nimport { generateComponentsDefinitions } from './components';\nimport { generatePluginDefinitions } from './plugins';\nimport { generateServicesDefinitions } from './services';\nimport { generateControllersDefinitions } from './controllers';\nimport { generatePoliciesDefinitions } from './policies';\nimport { generateMiddlewaresDefinitions } from './middlewares';\nimport { generateStrictDefinitions } from './strict';\n\nconst GENERATORS = {\n  contentTypes: generateContentTypesDefinitions,\n  components: generateComponentsDefinitions,\n  plugins: generatePluginDefinitions,\n  services: generateServicesDefinitions,\n  controllers: generateControllersDefinitions,\n  policies: generatePoliciesDefinitions,\n  middlewares: generateMiddlewaresDefinitions,\n  strict: generateStrictDefinitions,\n};\n\n/**\n * Artifacts written as `.ts` rather than `.d.ts`: they import the application's sources, and a\n * reference that no longer resolves (a moved source, a renamed contract) is reported by `tsc` even\n * with `skipLibCheck`, rather than silently typing the lookup as `any`. The other artifacts only\n * hold declarations generated from the schemas, and stay `.d.ts`.\n */\nconst SOURCE_ARTIFACTS = new Set(['services', 'controllers', 'policies', 'middlewares']);\n\n/**\n * The application's linters would check the `.ts` artifacts, whose helpers use `any`.\n */\nconst LINT_DISABLE_HEADER = '/* eslint-disable */\\n/* oxlint-disable */\\n';\n\nconst isSourceArtifact = (artifact: string) => SOURCE_ARTIFACTS.has(artifact);\n\nconst filenameOf = (artifact: string) =>\n  isSourceArtifact(artifact) === true ? `${artifact}.ts` : `${artifact}.d.ts`;\n\n/**\n * File name an earlier generation wrote the artifact to, removed with the artifact's own file\n */\nconst previousFilenameOf = (artifact: string) =>\n  isSourceArtifact(artifact) === true ? `${artifact}.d.ts` : undefined;\n\nexport interface GenerateConfig {\n  strapi: any;\n  pwd: string;\n  rootDir?: string;\n  /**\n   * Artifacts to generate. `true` generates the artifact, `false` removes the file a previous\n   * run may have generated for it, unset leaves it untouched.\n   * `services`, `controllers`, `policies`, `middlewares` and `strict` are the strict types artifacts\n   * (`typescript.strictTypes`).\n   */\n  artifacts?: {\n    contentTypes?: boolean;\n    components?: boolean;\n    plugins?: boolean;\n    services?: boolean;\n    strict?: boolean;\n    controllers?: boolean;\n    policies?: boolean;\n    middlewares?: boolean;\n  };\n  logger?: {\n    silent?: boolean;\n    debug?: boolean;\n    verbose?: boolean;\n  };\n}\n\n/**\n * Generate types definitions based on the given configuration\n */\nexport const generate = async (config: GenerateConfig = {} as GenerateConfig) => {\n  const { pwd, rootDir = TYPES_ROOT_DIR, strapi, artifacts = {}, logger: loggerConfig } = config;\n  const reports: Record<string, any> = {};\n  const logger = createLogger(loggerConfig);\n  const psTimer = timer().start();\n\n  const registryPwd = path.join(pwd, rootDir, GENERATED_OUT_DIR);\n  // Strict mode reads only the global schema registries, so schemas use that form with the opt-in.\n  const strict = artifacts.strict === true;\n  const generatorConfig = { strapi, pwd: registryPwd, appDir: pwd, logger, strict };\n\n  const returnWithMessage = () => {\n    const nbWarnings = chalk.yellow(`${logger.warnings} warning(s)`);\n    const nbErrors = chalk.red(`${logger.errors} error(s)`);\n\n    const status = logger.errors > 0 ? chalk.red('errored') : chalk.green('completed successfully');\n\n    psTimer.end();\n\n    logger.info(`The task ${status} with ${nbWarnings} and ${nbErrors} in ${psTimer.duration}s.`);\n\n    return reports;\n  };\n\n  const enabledArtifacts = Object.keys(artifacts).filter(\n    (p) => (artifacts as Record<string, boolean>)[p] === true\n  );\n  const disabledArtifacts = Object.keys(artifacts).filter(\n    (p) => (artifacts as Record<string, boolean>)[p] === false && p in GENERATORS\n  );\n\n  logger.info('Starting the type generation process');\n  logger.debug(`Enabled artifacts: ${enabledArtifacts.join(', ')}`);\n\n  for (const artifact of enabledArtifacts) {\n    const boldArtifact = chalk.bold(artifact); // used for log messages\n\n    logger.info(`Generating types for ${boldArtifact}`);\n\n    if (artifact in GENERATORS) {\n      const generator = (GENERATORS as any)[artifact];\n\n      try {\n        const artifactGenTimer = timer().start();\n\n        reports[artifact] = await generator(generatorConfig);\n\n        artifactGenTimer.end();\n\n        logger.debug(`Generated ${boldArtifact} in ${artifactGenTimer.duration}s`);\n      } catch (e) {\n        logger.error(\n          `Failed to generate types for ${boldArtifact}: ${(e as any).message ?? (e as any).toString()}. Exiting`\n        );\n        return returnWithMessage();\n      }\n    } else {\n      logger.warn(`The types generator for ${boldArtifact} is not implemented, skipping`);\n    }\n  }\n\n  for (const artifact of Object.keys(reports)) {\n    const boldArtifact = chalk.bold(artifact); // used for log messages\n\n    const artifactFsTimer = timer().start();\n\n    const report = reports[artifact];\n    const filename = filenameOf(artifact);\n    const previousFilename = previousFilenameOf(artifact);\n    const content =\n      isSourceArtifact(artifact) === true\n        ? `${LINT_DISABLE_HEADER}${report.output}`\n        : report.output;\n\n    try {\n      const outPath = await saveDefinitionToFileSystem(registryPwd, filename, content);\n\n      // A stale `.d.ts` would declare the registry entries a second time\n      if (previousFilename !== undefined) {\n        await fs.rm(path.join(registryPwd, previousFilename), { force: true });\n      }\n\n      const relativeOutPath = path.relative(process.cwd(), outPath);\n\n      artifactFsTimer.end();\n\n      logger.info(`Saved ${boldArtifact} types in ${chalk.bold(relativeOutPath)}`);\n      logger.debug(`Saved ${boldArtifact} in ${artifactFsTimer.duration}s`);\n    } catch (e) {\n      logger.error(\n        `An error occurred while saving ${boldArtifact} types to the filesystem: ${\n          (e as any).message ?? (e as any).toString()\n        }. Exiting`\n      );\n      return returnWithMessage();\n    }\n  }\n\n  // Disabled artifacts are removed so that a stale generated file does not keep applying\n  for (const artifact of disabledArtifacts) {\n    const boldArtifact = chalk.bold(artifact); // used for log messages\n    const previousFilename = previousFilenameOf(artifact);\n    const outPaths = [\n      filenameOf(artifact),\n      ...(previousFilename === undefined ? [] : [previousFilename]),\n    ].map((filename) => path.join(registryPwd, filename));\n\n    try {\n      for (const outPath of outPaths) {\n        if ((await pathExists(outPath)) === false) {\n          continue;\n        }\n\n        await fs.rm(outPath);\n\n        logger.info(\n          `Removed ${boldArtifact} types from ${chalk.bold(path.relative(process.cwd(), outPath))} (artifact disabled)`\n        );\n      }\n    } catch (e) {\n      logger.error(\n        `An error occurred while removing ${boldArtifact} types from the filesystem: ${\n          (e as any).message ?? (e as any).toString()\n        }. Exiting`\n      );\n      return returnWithMessage();\n    }\n  }\n\n  return returnWithMessage();\n};\n"],"names":["GENERATORS","contentTypes","generateContentTypesDefinitions","components","generateComponentsDefinitions","plugins","generatePluginDefinitions","services","generateServicesDefinitions","controllers","generateControllersDefinitions","policies","generatePoliciesDefinitions","middlewares","generateMiddlewaresDefinitions","strict","generateStrictDefinitions","SOURCE_ARTIFACTS","Set","LINT_DISABLE_HEADER","isSourceArtifact","artifact","has","filenameOf","previousFilenameOf","undefined","generate","config","pwd","rootDir","TYPES_ROOT_DIR","strapi","artifacts","logger","loggerConfig","reports","createLogger","psTimer","timer","start","registryPwd","path","join","GENERATED_OUT_DIR","generatorConfig","appDir","returnWithMessage","nbWarnings","chalk","yellow","warnings","nbErrors","red","errors","status","green","end","info","duration","enabledArtifacts","Object","keys","filter","p","disabledArtifacts","debug","boldArtifact","bold","generator","artifactGenTimer","e","error","message","toString","warn","artifactFsTimer","report","filename","previousFilename","content","output","outPath","saveDefinitionToFileSystem","fs","rm","force","relativeOutPath","relative","process","cwd","outPaths","map","pathExists"],"mappings":";;;;;;;;;;;;;;AAeA,MAAMA,UAAAA,GAAa;IACjBC,YAAAA,EAAcC,+BAAAA;IACdC,UAAAA,EAAYC,6BAAAA;IACZC,OAAAA,EAASC,yBAAAA;IACTC,QAAAA,EAAUC,2BAAAA;IACVC,WAAAA,EAAaC,8BAAAA;IACbC,QAAAA,EAAUC,2BAAAA;IACVC,WAAAA,EAAaC,8BAAAA;IACbC,MAAAA,EAAQC;AACV,CAAA;AAEA;;;;;IAMA,MAAMC,gBAAAA,GAAmB,IAAIC,GAAAA,CAAI;AAAC,IAAA,UAAA;AAAY,IAAA,aAAA;AAAe,IAAA,UAAA;AAAY,IAAA;AAAc,CAAA,CAAA;AAEvF;;AAEC,IACD,MAAMC,mBAAAA,GAAsB,8CAAA;AAE5B,MAAMC,gBAAAA,GAAmB,CAACC,QAAAA,GAAqBJ,gBAAAA,CAAiBK,GAAG,CAACD,QAAAA,CAAAA;AAEpE,MAAME,UAAAA,GAAa,CAACF,QAAAA,GAClBD,gBAAAA,CAAiBC,cAAc,IAAA,GAAO,CAAA,EAAGA,QAAAA,CAAS,GAAG,CAAC,GAAG,CAAA,EAAGA,QAAAA,CAAS,KAAK,CAAC;AAE7E;;IAGA,MAAMG,kBAAAA,GAAqB,CAACH,QAAAA,GAC1BD,gBAAAA,CAAiBC,QAAAA,CAAAA,KAAc,IAAA,GAAO,CAAA,EAAGA,QAAAA,CAAS,KAAK,CAAC,GAAGI,SAAAA;AA6B7D;;AAEC,IACM,MAAMC,QAAAA,GAAW,OAAOC,MAAAA,GAAyB,EAAoB,GAAA;AAC1E,IAAA,MAAM,EAAEC,GAAG,EAAEC,OAAAA,GAAUC,cAAc,EAAEC,MAAM,EAAEC,SAAAA,GAAY,EAAE,EAAEC,MAAAA,EAAQC,YAAY,EAAE,GAAGP,MAAAA;AACxF,IAAA,MAAMQ,UAA+B,EAAC;AACtC,IAAA,MAAMF,SAASG,YAAAA,CAAaF,YAAAA,CAAAA;IAC5B,MAAMG,OAAAA,GAAUC,QAAQC,KAAK,EAAA;AAE7B,IAAA,MAAMC,WAAAA,GAAcC,IAAAA,CAAKC,IAAI,CAACd,KAAKC,OAAAA,EAASc,iBAAAA,CAAAA;;IAE5C,MAAM5B,MAAAA,GAASiB,SAAAA,CAAUjB,MAAM,KAAK,IAAA;AACpC,IAAA,MAAM6B,eAAAA,GAAkB;AAAEb,QAAAA,MAAAA;QAAQH,GAAAA,EAAKY,WAAAA;QAAaK,MAAAA,EAAQjB,GAAAA;AAAKK,QAAAA,MAAAA;AAAQlB,QAAAA;AAAO,KAAA;AAEhF,IAAA,MAAM+B,iBAAAA,GAAoB,IAAA;QACxB,MAAMC,UAAAA,GAAaC,MAAMC,MAAM,CAAC,GAAGhB,MAAAA,CAAOiB,QAAQ,CAAC,WAAW,CAAC,CAAA;QAC/D,MAAMC,QAAAA,GAAWH,MAAMI,GAAG,CAAC,GAAGnB,MAAAA,CAAOoB,MAAM,CAAC,SAAS,CAAC,CAAA;QAEtD,MAAMC,MAAAA,GAASrB,MAAAA,CAAOoB,MAAM,GAAG,CAAA,GAAIL,KAAAA,CAAMI,GAAG,CAAC,SAAA,CAAA,GAAaJ,KAAAA,CAAMO,KAAK,CAAC,wBAAA,CAAA;AAEtElB,QAAAA,OAAAA,CAAQmB,GAAG,EAAA;AAEXvB,QAAAA,MAAAA,CAAOwB,IAAI,CAAC,CAAC,SAAS,EAAEH,MAAAA,CAAO,MAAM,EAAEP,UAAAA,CAAW,KAAK,EAAEI,SAAS,IAAI,EAAEd,QAAQqB,QAAQ,CAAC,EAAE,CAAC,CAAA;QAE5F,OAAOvB,OAAAA;AACT,IAAA,CAAA;AAEA,IAAA,MAAMwB,gBAAAA,GAAmBC,MAAAA,CAAOC,IAAI,CAAC7B,SAAAA,CAAAA,CAAW8B,MAAM,CACpD,CAACC,CAAAA,GAAO/B,SAAqC,CAAC+B,EAAE,KAAK,IAAA,CAAA;AAEvD,IAAA,MAAMC,iBAAAA,GAAoBJ,MAAAA,CAAOC,IAAI,CAAC7B,WAAW8B,MAAM,CACrD,CAACC,CAAAA,GAAM,SAAsC,CAACA,CAAAA,CAAE,KAAK,SAASA,CAAAA,IAAK/D,UAAAA,CAAAA;AAGrEiC,IAAAA,MAAAA,CAAOwB,IAAI,CAAC,sCAAA,CAAA;IACZxB,MAAAA,CAAOgC,KAAK,CAAC,CAAC,mBAAmB,EAAEN,gBAAAA,CAAiBjB,IAAI,CAAC,IAAA,CAAA,CAAA,CAAO,CAAA;IAEhE,KAAK,MAAMrB,YAAYsC,gBAAAA,CAAkB;AACvC,QAAA,MAAMO,YAAAA,GAAelB,KAAAA,CAAMmB,IAAI,CAAC9C;AAEhCY,QAAAA,MAAAA,CAAOwB,IAAI,CAAC,CAAC,qBAAqB,EAAES,YAAAA,CAAAA,CAAc,CAAA;AAElD,QAAA,IAAI7C,YAAYrB,UAAAA,EAAY;AAC1B,YAAA,MAAMoE,SAAAA,GAAapE,UAAkB,CAACqB,QAAAA,CAAS;YAE/C,IAAI;gBACF,MAAMgD,gBAAAA,GAAmB/B,QAAQC,KAAK,EAAA;AAEtCJ,gBAAAA,OAAO,CAACd,QAAAA,CAAS,GAAG,MAAM+C,SAAAA,CAAUxB,eAAAA,CAAAA;AAEpCyB,gBAAAA,gBAAAA,CAAiBb,GAAG,EAAA;AAEpBvB,gBAAAA,MAAAA,CAAOgC,KAAK,CAAC,CAAC,UAAU,EAAEC,YAAAA,CAAa,IAAI,EAAEG,gBAAAA,CAAiBX,QAAQ,CAAC,CAAC,CAAC,CAAA;AAC3E,YAAA,CAAA,CAAE,OAAOY,CAAAA,EAAG;AACVrC,gBAAAA,MAAAA,CAAOsC,KAAK,CACV,CAAC,6BAA6B,EAAEL,aAAa,EAAE,EAAE,CAACI,CAAUE,OAAO,IAAKF,EAAUG,QAAQ,EAAA,CAAG,SAAS,CAAC,CAAA;gBAEzG,OAAO3B,iBAAAA,EAAAA;AACT,YAAA;QACF,CAAA,MAAO;AACLb,YAAAA,MAAAA,CAAOyC,IAAI,CAAC,CAAC,wBAAwB,EAAER,YAAAA,CAAa,6BAA6B,CAAC,CAAA;AACpF,QAAA;AACF,IAAA;AAEA,IAAA,KAAK,MAAM7C,QAAAA,IAAYuC,MAAAA,CAAOC,IAAI,CAAC1B,OAAAA,CAAAA,CAAU;AAC3C,QAAA,MAAM+B,YAAAA,GAAelB,KAAAA,CAAMmB,IAAI,CAAC9C;QAEhC,MAAMsD,eAAAA,GAAkBrC,QAAQC,KAAK,EAAA;QAErC,MAAMqC,MAAAA,GAASzC,OAAO,CAACd,QAAAA,CAAS;AAChC,QAAA,MAAMwD,WAAWtD,UAAAA,CAAWF,QAAAA,CAAAA;AAC5B,QAAA,MAAMyD,mBAAmBtD,kBAAAA,CAAmBH,QAAAA,CAAAA;QAC5C,MAAM0D,OAAAA,GACJ3D,gBAAAA,CAAiBC,QAAAA,CAAAA,KAAc,IAAA,GAC3B,CAAA,EAAGF,mBAAAA,CAAAA,EAAsByD,MAAAA,CAAOI,MAAM,CAAA,CAAE,GACxCJ,MAAAA,CAAOI,MAAM;QAEnB,IAAI;AACF,YAAA,MAAMC,OAAAA,GAAU,MAAMC,0BAAAA,CAA2B1C,WAAAA,EAAaqC,QAAAA,EAAUE,OAAAA,CAAAA;;AAGxE,YAAA,IAAID,qBAAqBrD,SAAAA,EAAW;AAClC,gBAAA,MAAM0D,GAAGC,EAAE,CAAC3C,KAAKC,IAAI,CAACF,aAAasC,gBAAAA,CAAAA,EAAmB;oBAAEO,KAAAA,EAAO;AAAK,iBAAA,CAAA;AACtE,YAAA;AAEA,YAAA,MAAMC,kBAAkB7C,IAAAA,CAAK8C,QAAQ,CAACC,OAAAA,CAAQC,GAAG,EAAA,EAAIR,OAAAA,CAAAA;AAErDN,YAAAA,eAAAA,CAAgBnB,GAAG,EAAA;YAEnBvB,MAAAA,CAAOwB,IAAI,CAAC,CAAC,MAAM,EAAES,YAAAA,CAAa,UAAU,EAAElB,KAAAA,CAAMmB,IAAI,CAACmB,eAAAA,CAAAA,CAAAA,CAAkB,CAAA;AAC3ErD,YAAAA,MAAAA,CAAOgC,KAAK,CAAC,CAAC,MAAM,EAAEC,YAAAA,CAAa,IAAI,EAAES,eAAAA,CAAgBjB,QAAQ,CAAC,CAAC,CAAC,CAAA;AACtE,QAAA,CAAA,CAAE,OAAOY,CAAAA,EAAG;AACVrC,YAAAA,MAAAA,CAAOsC,KAAK,CACV,CAAC,+BAA+B,EAAEL,aAAa,0BAA0B,EACvE,CAACI,CAAUE,OAAO,IAAKF,EAAUG,QAAQ,EAAA,CAC1C,SAAS,CAAC,CAAA;YAEb,OAAO3B,iBAAAA,EAAAA;AACT,QAAA;AACF,IAAA;;IAGA,KAAK,MAAMzB,YAAY2C,iBAAAA,CAAmB;AACxC,QAAA,MAAME,YAAAA,GAAelB,KAAAA,CAAMmB,IAAI,CAAC9C;AAChC,QAAA,MAAMyD,mBAAmBtD,kBAAAA,CAAmBH,QAAAA,CAAAA;AAC5C,QAAA,MAAMqE,QAAAA,GAAW;YACfnE,UAAAA,CAAWF,QAAAA,CAAAA;eACPyD,gBAAAA,KAAqBrD,SAAAA,GAAY,EAAE,GAAG;AAACqD,gBAAAA;AAAiB;AAC7D,SAAA,CAACa,GAAG,CAAC,CAACd,WAAapC,IAAAA,CAAKC,IAAI,CAACF,WAAAA,EAAaqC,QAAAA,CAAAA,CAAAA;QAE3C,IAAI;YACF,KAAK,MAAMI,WAAWS,QAAAA,CAAU;AAC9B,gBAAA,IAAI,MAAOE,UAAAA,CAAWX,OAAAA,CAAAA,KAAc,KAAA,EAAO;AACzC,oBAAA;AACF,gBAAA;gBAEA,MAAME,EAAAA,CAAGC,EAAE,CAACH,OAAAA,CAAAA;AAEZhD,gBAAAA,MAAAA,CAAOwB,IAAI,CACT,CAAC,QAAQ,EAAES,YAAAA,CAAa,YAAY,EAAElB,KAAAA,CAAMmB,IAAI,CAAC1B,IAAAA,CAAK8C,QAAQ,CAACC,OAAAA,CAAQC,GAAG,EAAA,EAAIR,OAAAA,CAAAA,CAAAA,CAAU,oBAAoB,CAAC,CAAA;AAEjH,YAAA;AACF,QAAA,CAAA,CAAE,OAAOX,CAAAA,EAAG;AACVrC,YAAAA,MAAAA,CAAOsC,KAAK,CACV,CAAC,iCAAiC,EAAEL,aAAa,4BAA4B,EAC3E,CAACI,CAAUE,OAAO,IAAKF,EAAUG,QAAQ,EAAA,CAC1C,SAAS,CAAC,CAAA;YAEb,OAAO3B,iBAAAA,EAAAA;AACT,QAAA;AACF,IAAA;IAEA,OAAOA,iBAAAA,EAAAA;AACT;;;;"}

package/dist/generators/middlewares/index.d.ts

@@ -0,0 +1,30 @@
+import type { GeneratorOptions } from '../utils';
+/**
+ * Generate type definitions for the application's middlewares (global::* and api::*)
+ *
+ * Middlewares are typed from their source file, so only the ones with a source in src/middlewares or
+ * src/api are emitted. Bundled middlewares (strapi::*, admin::*, plugin::*) are left to the packages
+ * themselves (Strapi.Registries.PackageMiddlewares), so registering application middlewares keeps
+ * them accepted.
+ *
+ * declare global {
+ *   namespace Strapi {
+ *     namespace Registries {
+ *       interface AppMiddlewares {
+ *         'global::<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;
+ *         'api::<api>.<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;
+ *         'global::<js middleware>': unknown;
+ *       }
+ *     }
+ *   }
+ * }
+ *
+ * Like JS policies (see the policies generator), JS middlewares are registered as `unknown` without
+ * an import.
+ * TODO @Nico with `allowJs`, a JSDoc-typed JS middleware could register its config like a TS one
+ */
+export declare const generateMiddlewaresDefinitions: (options?: GeneratorOptions) => Promise<{
+    output: string;
+    stats: {};
+}>;
+//# sourceMappingURL=index.d.ts.map

package/dist/generators/middlewares/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generators/middlewares/index.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AA4KjD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,8BAA8B,GACzC,UAAS,gBAAyC;;;EAoCnD,CAAC"}

package/dist/generators/middlewares/index.js

@@ -0,0 +1,163 @@
+'use strict';
+
+var ts = require('typescript');
+var sources = require('../common/sources.js');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var ts__namespace = /*#__PURE__*/_interopNamespace(ts);
+
+const { factory } = ts__namespace;
+const REGISTRY = 'AppMiddlewares';
+const CONFIG_HELPER = 'MiddlewareConfig';
+const FACTORY_CONFIG_HELPER = 'MiddlewareFactoryConfig';
+const NO_MIDDLEWARE_PLACEHOLDER_COMMENT = `/*
+ * The app doesn't have any middlewares yet.
+ */
+
+export {};
+`;
+/**
+ * type MiddlewareFactoryConfig<TFactory> = TFactory extends (...args: infer TArgs) => unknown
+ *   ? TFactory extends (config: never, ctx: { strapi: never }) => unknown
+ *     ? TArgs['length'] extends 0
+ *       ? undefined
+ *       : 0 extends 1 & TArgs[0]
+ *         ? unknown
+ *         : TArgs[0] extends { request: unknown; response: unknown; app: unknown }
+ *           ? never
+ *           : TArgs[0]
+ *     : never
+ *   : unknown;
+ *
+ * type MiddlewareConfig<TModule> = TModule extends { default: infer TExport }
+ *   ? MiddlewareFactoryConfig<TExport>
+ *   : unknown;
+ *
+ * Emitted in the file so that middlewares.ts stands alone, and only when a TypeScript middleware
+ * reads them, like the policies helpers.
+ *
+ * Resolves the config a middleware accepts from the type of its module: the first parameter of the
+ * factory it exports. A factory without parameters takes no config: `undefined`, as in
+ * PackageMiddlewares. An optional parameter keeps `undefined` in the config, so typed routes accept
+ * the name alone. An untyped (`any`) config and a module without a default export resolve to
+ * `unknown`, as for policies.
+ * A plain Koa handler `(ctx, next)` is not a factory: runtime calls it with the config and
+ * `{ strapi }`, which breaks. A function whose second parameter cannot take `{ strapi }`
+ * (Core.MiddlewareFactory) registers `never`, so typed routes reject its name. `never` stands for
+ * the Strapi instance, so that the file needs no import and any context type a factory declares
+ * accepts it.
+ * A handler with one parameter `(ctx)`, or an untyped `next`, takes `{ strapi }`: a first parameter
+ * with the required members of a Koa context (`request`, `response`, `app`) registers `never` too.
+ * TODO @Nico a handler whose context is `any` still registers as a factory with an untyped config
+ * (`unknown`); an opt-in `defineMiddleware` brand (new factory helpers, D15) would tell them apart
+ * TODO @Nico a module without a default export registers `undefined` at runtime (a reference to it
+ * throws "Middleware <uid> not found"); `unknown` accepts any reference to it, like an untyped one
+ */ const generateConfigHelpersDefinition = ()=>{
+    const args = factory.createTypeReferenceNode('TArgs');
+    const configArg = factory.createIndexedAccessTypeNode(args, factory.createLiteralTypeNode(factory.createNumericLiteral(0)));
+    const never = ()=>factory.createKeywordTypeNode(ts__namespace.SyntaxKind.NeverKeyword);
+    // (config: never, ctx: { strapi: never }) => unknown, what runtime calls a middleware with
+    const factorySignature = factory.createFunctionTypeNode(undefined, [
+        factory.createParameterDeclaration(undefined, undefined, 'config', undefined, never()),
+        factory.createParameterDeclaration(undefined, undefined, 'ctx', undefined, factory.createTypeLiteralNode([
+            factory.createPropertySignature(undefined, 'strapi', undefined, never())
+        ]))
+    ], factory.createKeywordTypeNode(ts__namespace.SyntaxKind.UnknownKeyword));
+    // { request: unknown; response: unknown; app: unknown }, required members of a Koa context
+    const koaContextShape = factory.createTypeLiteralNode([
+        'request',
+        'response',
+        'app'
+    ].map((member)=>factory.createPropertySignature(undefined, member, undefined, factory.createKeywordTypeNode(ts__namespace.SyntaxKind.UnknownKeyword))));
+    const factoryConfig = factory.createConditionalTypeNode(factory.createTypeReferenceNode('TFactory'), factory.createFunctionTypeNode(undefined, [
+        factory.createParameterDeclaration(undefined, factory.createToken(ts__namespace.SyntaxKind.DotDotDotToken), 'args', undefined, factory.createInferTypeNode(factory.createTypeParameterDeclaration(undefined, 'TArgs')))
+    ], factory.createKeywordTypeNode(ts__namespace.SyntaxKind.UnknownKeyword)), factory.createConditionalTypeNode(factory.createTypeReferenceNode('TFactory'), factorySignature, factory.createConditionalTypeNode(factory.createIndexedAccessTypeNode(args, factory.createLiteralTypeNode(factory.createStringLiteral('length', true))), factory.createLiteralTypeNode(factory.createNumericLiteral(0)), factory.createKeywordTypeNode(ts__namespace.SyntaxKind.UndefinedKeyword), // 0 extends 1 & TArgs[0], true only when the config is `any`
+    factory.createConditionalTypeNode(factory.createLiteralTypeNode(factory.createNumericLiteral(0)), factory.createIntersectionTypeNode([
+        factory.createLiteralTypeNode(factory.createNumericLiteral(1)),
+        configArg
+    ]), factory.createKeywordTypeNode(ts__namespace.SyntaxKind.UnknownKeyword), // A Koa handler (ctx) or (ctx, next: any): its first parameter is a context
+    factory.createConditionalTypeNode(configArg, koaContextShape, never(), configArg))), // A Koa handler (ctx, next): its `next` cannot take `{ strapi }`
+    never()), factory.createKeywordTypeNode(ts__namespace.SyntaxKind.UnknownKeyword));
+    const moduleConfig = factory.createConditionalTypeNode(factory.createTypeReferenceNode('TModule'), factory.createTypeLiteralNode([
+        factory.createPropertySignature(undefined, 'default', undefined, factory.createInferTypeNode(factory.createTypeParameterDeclaration(undefined, 'TExport')))
+    ]), factory.createTypeReferenceNode(FACTORY_CONFIG_HELPER, [
+        factory.createTypeReferenceNode('TExport')
+    ]), factory.createKeywordTypeNode(ts__namespace.SyntaxKind.UnknownKeyword));
+    return [
+        sources.withDocComment(factory.createTypeAliasDeclaration(undefined, factory.createIdentifier(FACTORY_CONFIG_HELPER), [
+            factory.createTypeParameterDeclaration(undefined, 'TFactory')
+        ], factoryConfig), '*\n * Config a middleware factory accepts: its first parameter, `undefined` when it has none,\n * `unknown` when it is untyped, `never` when the function is not a factory (a Koa handler).\n '),
+        sources.withDocComment(factory.createTypeAliasDeclaration(undefined, factory.createIdentifier(CONFIG_HELPER), [
+            factory.createTypeParameterDeclaration(undefined, 'TModule')
+        ], moduleConfig), '*\n * Config accepted by the factory a middleware module exports.\n ')
+    ];
+};
+/**
+ * Generate type definitions for the application's middlewares (global::* and api::*)
+ *
+ * Middlewares are typed from their source file, so only the ones with a source in src/middlewares or
+ * src/api are emitted. Bundled middlewares (strapi::*, admin::*, plugin::*) are left to the packages
+ * themselves (Strapi.Registries.PackageMiddlewares), so registering application middlewares keeps
+ * them accepted.
+ *
+ * declare global {
+ *   namespace Strapi {
+ *     namespace Registries {
+ *       interface AppMiddlewares {
+ *         'global::<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;
+ *         'api::<api>.<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;
+ *         'global::<js middleware>': unknown;
+ *       }
+ *     }
+ *   }
+ * }
+ *
+ * Like JS policies (see the policies generator), JS middlewares are registered as `unknown` without
+ * an import.
+ * TODO @Nico with `allowJs`, a JSDoc-typed JS middleware could register its config like a TS one
+ */ const generateMiddlewaresDefinitions = async (options = {})=>{
+    const { strapi, logger, pwd: outDir } = options;
+    if (!outDir) {
+        throw new Error('The middlewares generator needs the output directory to resolve source imports');
+    }
+    const sources$1 = await sources.collectAppSources('middlewares', {
+        global: strapi.dirs.app.middlewares,
+        api: strapi.dirs.app.api
+    }, outDir, logger);
+    const middlewaresDefinitions = sources.filterRegisteredSources(sources$1, strapi.middlewares, logger);
+    logger.debug(`Found ${middlewaresDefinitions.length} middlewares.`);
+    if (middlewaresDefinitions.length === 0) {
+        return {
+            output: NO_MIDDLEWARE_PLACEHOLDER_COMMENT,
+            stats: {}
+        };
+    }
+    // The helpers are only emitted when an entry reads them: `noUnusedLocals` reports unused ones
+    const output = await sources.emitRegistryDefinitions(REGISTRY, middlewaresDefinitions.some(sources.isTypedSource) === true ? generateConfigHelpersDefinition() : [], middlewaresDefinitions, (source)=>sources.isTypedSource(source) ? factory.createTypeReferenceNode(CONFIG_HELPER, [
+            sources.typeofImport(source)
+        ]) : factory.createKeywordTypeNode(ts__namespace.SyntaxKind.UnknownKeyword));
+    return {
+        output,
+        stats: {}
+    };
+};
+
+exports.generateMiddlewaresDefinitions = generateMiddlewaresDefinitions;
+//# sourceMappingURL=index.js.map

package/dist/generators/middlewares/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../src/generators/middlewares/index.ts"],"sourcesContent":["import * as ts from 'typescript';\n\nimport {\n  collectAppSources,\n  emitRegistryDefinitions,\n  filterRegisteredSources,\n  isTypedSource,\n  typeofImport,\n  withDocComment,\n} from '../common/sources';\nimport type { GeneratorOptions } from '../utils';\n\nconst { factory } = ts;\n\nconst REGISTRY = 'AppMiddlewares';\nconst CONFIG_HELPER = 'MiddlewareConfig';\nconst FACTORY_CONFIG_HELPER = 'MiddlewareFactoryConfig';\n\nconst NO_MIDDLEWARE_PLACEHOLDER_COMMENT = `/*\n * The app doesn't have any middlewares yet.\n */\n\nexport {};\n`;\n\n/**\n * type MiddlewareFactoryConfig<TFactory> = TFactory extends (...args: infer TArgs) => unknown\n *   ? TFactory extends (config: never, ctx: { strapi: never }) => unknown\n *     ? TArgs['length'] extends 0\n *       ? undefined\n *       : 0 extends 1 & TArgs[0]\n *         ? unknown\n *         : TArgs[0] extends { request: unknown; response: unknown; app: unknown }\n *           ? never\n *           : TArgs[0]\n *     : never\n *   : unknown;\n *\n * type MiddlewareConfig<TModule> = TModule extends { default: infer TExport }\n *   ? MiddlewareFactoryConfig<TExport>\n *   : unknown;\n *\n * Emitted in the file so that middlewares.ts stands alone, and only when a TypeScript middleware\n * reads them, like the policies helpers.\n *\n * Resolves the config a middleware accepts from the type of its module: the first parameter of the\n * factory it exports. A factory without parameters takes no config: `undefined`, as in\n * PackageMiddlewares. An optional parameter keeps `undefined` in the config, so typed routes accept\n * the name alone. An untyped (`any`) config and a module without a default export resolve to\n * `unknown`, as for policies.\n * A plain Koa handler `(ctx, next)` is not a factory: runtime calls it with the config and\n * `{ strapi }`, which breaks. A function whose second parameter cannot take `{ strapi }`\n * (Core.MiddlewareFactory) registers `never`, so typed routes reject its name. `never` stands for\n * the Strapi instance, so that the file needs no import and any context type a factory declares\n * accepts it.\n * A handler with one parameter `(ctx)`, or an untyped `next`, takes `{ strapi }`: a first parameter\n * with the required members of a Koa context (`request`, `response`, `app`) registers `never` too.\n * TODO @Nico a handler whose context is `any` still registers as a factory with an untyped config\n * (`unknown`); an opt-in `defineMiddleware` brand (new factory helpers, D15) would tell them apart\n * TODO @Nico a module without a default export registers `undefined` at runtime (a reference to it\n * throws \"Middleware <uid> not found\"); `unknown` accepts any reference to it, like an untyped one\n */\nconst generateConfigHelpersDefinition = () => {\n  const args = factory.createTypeReferenceNode('TArgs');\n  const configArg = factory.createIndexedAccessTypeNode(\n    args,\n    factory.createLiteralTypeNode(factory.createNumericLiteral(0))\n  );\n\n  const never = () => factory.createKeywordTypeNode(ts.SyntaxKind.NeverKeyword);\n\n  // (config: never, ctx: { strapi: never }) => unknown, what runtime calls a middleware with\n  const factorySignature = factory.createFunctionTypeNode(\n    undefined,\n    [\n      factory.createParameterDeclaration(undefined, undefined, 'config', undefined, never()),\n      factory.createParameterDeclaration(\n        undefined,\n        undefined,\n        'ctx',\n        undefined,\n        factory.createTypeLiteralNode([\n          factory.createPropertySignature(undefined, 'strapi', undefined, never()),\n        ])\n      ),\n    ],\n    factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n  );\n\n  // { request: unknown; response: unknown; app: unknown }, required members of a Koa context\n  const koaContextShape = factory.createTypeLiteralNode(\n    ['request', 'response', 'app'].map((member) =>\n      factory.createPropertySignature(\n        undefined,\n        member,\n        undefined,\n        factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n      )\n    )\n  );\n\n  const factoryConfig = factory.createConditionalTypeNode(\n    factory.createTypeReferenceNode('TFactory'),\n    factory.createFunctionTypeNode(\n      undefined,\n      [\n        factory.createParameterDeclaration(\n          undefined,\n          factory.createToken(ts.SyntaxKind.DotDotDotToken),\n          'args',\n          undefined,\n          factory.createInferTypeNode(factory.createTypeParameterDeclaration(undefined, 'TArgs'))\n        ),\n      ],\n      factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n    ),\n    factory.createConditionalTypeNode(\n      factory.createTypeReferenceNode('TFactory'),\n      factorySignature,\n      factory.createConditionalTypeNode(\n        factory.createIndexedAccessTypeNode(\n          args,\n          factory.createLiteralTypeNode(factory.createStringLiteral('length', true))\n        ),\n        factory.createLiteralTypeNode(factory.createNumericLiteral(0)),\n        factory.createKeywordTypeNode(ts.SyntaxKind.UndefinedKeyword),\n        // 0 extends 1 & TArgs[0], true only when the config is `any`\n        factory.createConditionalTypeNode(\n          factory.createLiteralTypeNode(factory.createNumericLiteral(0)),\n          factory.createIntersectionTypeNode([\n            factory.createLiteralTypeNode(factory.createNumericLiteral(1)),\n            configArg,\n          ]),\n          factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword),\n          // A Koa handler (ctx) or (ctx, next: any): its first parameter is a context\n          factory.createConditionalTypeNode(configArg, koaContextShape, never(), configArg)\n        )\n      ),\n      // A Koa handler (ctx, next): its `next` cannot take `{ strapi }`\n      never()\n    ),\n    factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n  );\n\n  const moduleConfig = factory.createConditionalTypeNode(\n    factory.createTypeReferenceNode('TModule'),\n    factory.createTypeLiteralNode([\n      factory.createPropertySignature(\n        undefined,\n        'default',\n        undefined,\n        factory.createInferTypeNode(factory.createTypeParameterDeclaration(undefined, 'TExport'))\n      ),\n    ]),\n    factory.createTypeReferenceNode(FACTORY_CONFIG_HELPER, [\n      factory.createTypeReferenceNode('TExport'),\n    ]),\n    factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n  );\n\n  return [\n    withDocComment(\n      factory.createTypeAliasDeclaration(\n        undefined,\n        factory.createIdentifier(FACTORY_CONFIG_HELPER),\n        [factory.createTypeParameterDeclaration(undefined, 'TFactory')],\n        factoryConfig\n      ),\n      '*\\n * Config a middleware factory accepts: its first parameter, `undefined` when it has none,\\n * `unknown` when it is untyped, `never` when the function is not a factory (a Koa handler).\\n '\n    ),\n    withDocComment(\n      factory.createTypeAliasDeclaration(\n        undefined,\n        factory.createIdentifier(CONFIG_HELPER),\n        [factory.createTypeParameterDeclaration(undefined, 'TModule')],\n        moduleConfig\n      ),\n      '*\\n * Config accepted by the factory a middleware module exports.\\n '\n    ),\n  ];\n};\n\n/**\n * Generate type definitions for the application's middlewares (global::* and api::*)\n *\n * Middlewares are typed from their source file, so only the ones with a source in src/middlewares or\n * src/api are emitted. Bundled middlewares (strapi::*, admin::*, plugin::*) are left to the packages\n * themselves (Strapi.Registries.PackageMiddlewares), so registering application middlewares keeps\n * them accepted.\n *\n * declare global {\n *   namespace Strapi {\n *     namespace Registries {\n *       interface AppMiddlewares {\n *         'global::<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;\n *         'api::<api>.<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;\n *         'global::<js middleware>': unknown;\n *       }\n *     }\n *   }\n * }\n *\n * Like JS policies (see the policies generator), JS middlewares are registered as `unknown` without\n * an import.\n * TODO @Nico with `allowJs`, a JSDoc-typed JS middleware could register its config like a TS one\n */\nexport const generateMiddlewaresDefinitions = async (\n  options: GeneratorOptions = {} as GeneratorOptions\n) => {\n  const { strapi, logger, pwd: outDir } = options;\n\n  if (!outDir) {\n    throw new Error(\n      'The middlewares generator needs the output directory to resolve source imports'\n    );\n  }\n\n  const sources = await collectAppSources(\n    'middlewares',\n    { global: strapi.dirs.app.middlewares, api: strapi.dirs.app.api },\n    outDir,\n    logger\n  );\n  const middlewaresDefinitions = filterRegisteredSources(sources, strapi.middlewares, logger);\n\n  logger.debug(`Found ${middlewaresDefinitions.length} middlewares.`);\n\n  if (middlewaresDefinitions.length === 0) {\n    return { output: NO_MIDDLEWARE_PLACEHOLDER_COMMENT, stats: {} };\n  }\n\n  // The helpers are only emitted when an entry reads them: `noUnusedLocals` reports unused ones\n  const output = await emitRegistryDefinitions(\n    REGISTRY,\n    middlewaresDefinitions.some(isTypedSource) === true ? generateConfigHelpersDefinition() : [],\n    middlewaresDefinitions,\n    (source) =>\n      isTypedSource(source)\n        ? factory.createTypeReferenceNode(CONFIG_HELPER, [typeofImport(source)])\n        : factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n  );\n\n  return { output, stats: {} };\n};\n"],"names":["factory","ts","REGISTRY","CONFIG_HELPER","FACTORY_CONFIG_HELPER","NO_MIDDLEWARE_PLACEHOLDER_COMMENT","generateConfigHelpersDefinition","args","createTypeReferenceNode","configArg","createIndexedAccessTypeNode","createLiteralTypeNode","createNumericLiteral","never","createKeywordTypeNode","SyntaxKind","NeverKeyword","factorySignature","createFunctionTypeNode","undefined","createParameterDeclaration","createTypeLiteralNode","createPropertySignature","UnknownKeyword","koaContextShape","map","member","factoryConfig","createConditionalTypeNode","createToken","DotDotDotToken","createInferTypeNode","createTypeParameterDeclaration","createStringLiteral","UndefinedKeyword","createIntersectionTypeNode","moduleConfig","withDocComment","createTypeAliasDeclaration","createIdentifier","generateMiddlewaresDefinitions","options","strapi","logger","pwd","outDir","Error","sources","collectAppSources","global","dirs","app","middlewares","api","middlewaresDefinitions","filterRegisteredSources","debug","length","output","stats","emitRegistryDefinitions","some","isTypedSource","source","typeofImport"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAYA,MAAM,EAAEA,OAAO,EAAE,GAAGC,aAAAA;AAEpB,MAAMC,QAAAA,GAAW,gBAAA;AACjB,MAAMC,aAAAA,GAAgB,kBAAA;AACtB,MAAMC,qBAAAA,GAAwB,yBAAA;AAE9B,MAAMC,oCAAoC,CAAC;;;;;AAK3C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCC,IACD,MAAMC,+BAAAA,GAAkC,IAAA;IACtC,MAAMC,IAAAA,GAAOP,OAAAA,CAAQQ,uBAAuB,CAAC,OAAA,CAAA;IAC7C,MAAMC,SAAAA,GAAYT,OAAAA,CAAQU,2BAA2B,CACnDH,IAAAA,EACAP,QAAQW,qBAAqB,CAACX,OAAAA,CAAQY,oBAAoB,CAAC,CAAA,CAAA,CAAA,CAAA;IAG7D,MAAMC,KAAAA,GAAQ,IAAMb,OAAAA,CAAQc,qBAAqB,CAACb,aAAAA,CAAGc,UAAU,CAACC,YAAY,CAAA;;AAG5E,IAAA,MAAMC,gBAAAA,GAAmBjB,OAAAA,CAAQkB,sBAAsB,CACrDC,SAAAA,EACA;AACEnB,QAAAA,OAAAA,CAAQoB,0BAA0B,CAACD,SAAAA,EAAWA,SAAAA,EAAW,UAAUA,SAAAA,EAAWN,KAAAA,EAAAA,CAAAA;QAC9Eb,OAAAA,CAAQoB,0BAA0B,CAChCD,SAAAA,EACAA,SAAAA,EACA,OACAA,SAAAA,EACAnB,OAAAA,CAAQqB,qBAAqB,CAAC;AAC5BrB,YAAAA,OAAAA,CAAQsB,uBAAuB,CAACH,SAAAA,EAAW,QAAA,EAAUA,SAAAA,EAAWN,KAAAA,EAAAA;AACjE,SAAA,CAAA;AAEJ,KAAA,EACDb,QAAQc,qBAAqB,CAACb,aAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA;;IAI5D,MAAMC,eAAAA,GAAkBxB,OAAAA,CAAQqB,qBAAqB,CACnD;AAAC,QAAA,SAAA;AAAW,QAAA,UAAA;AAAY,QAAA;AAAM,KAAA,CAACI,GAAG,CAAC,CAACC,MAAAA,GAClC1B,OAAAA,CAAQsB,uBAAuB,CAC7BH,SAAAA,EACAO,MAAAA,EACAP,SAAAA,EACAnB,QAAQc,qBAAqB,CAACb,aAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA,CAAA,CAAA;IAKhE,MAAMI,aAAAA,GAAgB3B,OAAAA,CAAQ4B,yBAAyB,CACrD5B,OAAAA,CAAQQ,uBAAuB,CAAC,UAAA,CAAA,EAChCR,OAAAA,CAAQkB,sBAAsB,CAC5BC,SAAAA,EACA;AACEnB,QAAAA,OAAAA,CAAQoB,0BAA0B,CAChCD,SAAAA,EACAnB,QAAQ6B,WAAW,CAAC5B,cAAGc,UAAU,CAACe,cAAc,CAAA,EAChD,MAAA,EACAX,WACAnB,OAAAA,CAAQ+B,mBAAmB,CAAC/B,OAAAA,CAAQgC,8BAA8B,CAACb,SAAAA,EAAW,OAAA,CAAA,CAAA;KAEjF,EACDnB,OAAAA,CAAQc,qBAAqB,CAACb,aAAAA,CAAGc,UAAU,CAACQ,cAAc,IAE5DvB,OAAAA,CAAQ4B,yBAAyB,CAC/B5B,OAAAA,CAAQQ,uBAAuB,CAAC,UAAA,CAAA,EAChCS,gBAAAA,EACAjB,QAAQ4B,yBAAyB,CAC/B5B,OAAAA,CAAQU,2BAA2B,CACjCH,IAAAA,EACAP,QAAQW,qBAAqB,CAACX,QAAQiC,mBAAmB,CAAC,UAAU,IAAA,CAAA,CAAA,CAAA,EAEtEjC,OAAAA,CAAQW,qBAAqB,CAACX,OAAAA,CAAQY,oBAAoB,CAAC,CAAA,CAAA,CAAA,EAC3DZ,QAAQc,qBAAqB,CAACb,cAAGc,UAAU,CAACmB,gBAAgB,CAAA;IAE5DlC,OAAAA,CAAQ4B,yBAAyB,CAC/B5B,OAAAA,CAAQW,qBAAqB,CAACX,OAAAA,CAAQY,oBAAoB,CAAC,CAAA,CAAA,CAAA,EAC3DZ,OAAAA,CAAQmC,0BAA0B,CAAC;AACjCnC,QAAAA,OAAAA,CAAQW,qBAAqB,CAACX,OAAAA,CAAQY,oBAAoB,CAAC,CAAA,CAAA,CAAA;AAC3DH,QAAAA;KACD,CAAA,EACDT,OAAAA,CAAQc,qBAAqB,CAACb,aAAAA,CAAGc,UAAU,CAACQ,cAAc;AAE1DvB,IAAAA,OAAAA,CAAQ4B,yBAAyB,CAACnB,SAAAA,EAAWe,eAAAA,EAAiBX,KAAAA,EAAAA,EAASJ;AAI3EI,IAAAA,KAAAA,EAAAA,CAAAA,EAEFb,QAAQc,qBAAqB,CAACb,aAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA;IAG5D,MAAMa,YAAAA,GAAepC,OAAAA,CAAQ4B,yBAAyB,CACpD5B,OAAAA,CAAQQ,uBAAuB,CAAC,SAAA,CAAA,EAChCR,OAAAA,CAAQqB,qBAAqB,CAAC;QAC5BrB,OAAAA,CAAQsB,uBAAuB,CAC7BH,SAAAA,EACA,SAAA,EACAA,SAAAA,EACAnB,OAAAA,CAAQ+B,mBAAmB,CAAC/B,OAAAA,CAAQgC,8BAA8B,CAACb,SAAAA,EAAW,SAAA,CAAA,CAAA;KAEjF,CAAA,EACDnB,OAAAA,CAAQQ,uBAAuB,CAACJ,qBAAAA,EAAuB;AACrDJ,QAAAA,OAAAA,CAAQQ,uBAAuB,CAAC,SAAA;AACjC,KAAA,CAAA,EACDR,QAAQc,qBAAqB,CAACb,aAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA;IAG5D,OAAO;AACLc,QAAAA,sBAAAA,CACErC,QAAQsC,0BAA0B,CAChCnB,WACAnB,OAAAA,CAAQuC,gBAAgB,CAACnC,qBAAAA,CAAAA,EACzB;YAACJ,OAAAA,CAAQgC,8BAA8B,CAACb,SAAAA,EAAW,UAAA;AAAY,SAAA,EAC/DQ,aAAAA,CAAAA,EAEF,gMAAA,CAAA;AAEFU,QAAAA,sBAAAA,CACErC,QAAQsC,0BAA0B,CAChCnB,WACAnB,OAAAA,CAAQuC,gBAAgB,CAACpC,aAAAA,CAAAA,EACzB;YAACH,OAAAA,CAAQgC,8BAA8B,CAACb,SAAAA,EAAW,SAAA;AAAW,SAAA,EAC9DiB,YAAAA,CAAAA,EAEF,sEAAA;AAEH,KAAA;AACH,CAAA;AAEA;;;;;;;;;;;;;;;;;;;;;;;AAuBC,IACM,MAAMI,8BAAAA,GAAiC,OAC5CC,OAAAA,GAA4B,EAAsB,GAAA;IAElD,MAAM,EAAEC,MAAM,EAAEC,MAAM,EAAEC,GAAAA,EAAKC,MAAM,EAAE,GAAGJ,OAAAA;AAExC,IAAA,IAAI,CAACI,MAAAA,EAAQ;AACX,QAAA,MAAM,IAAIC,KAAAA,CACR,gFAAA,CAAA;AAEJ,IAAA;IAEA,MAAMC,SAAAA,GAAU,MAAMC,yBAAAA,CACpB,aAAA,EACA;AAAEC,QAAAA,MAAAA,EAAQP,MAAAA,CAAOQ,IAAI,CAACC,GAAG,CAACC,WAAW;AAAEC,QAAAA,GAAAA,EAAKX,MAAAA,CAAOQ,IAAI,CAACC,GAAG,CAACE;AAAI,KAAA,EAChER,MAAAA,EACAF,MAAAA,CAAAA;AAEF,IAAA,MAAMW,sBAAAA,GAAyBC,+BAAAA,CAAwBR,SAAAA,EAASL,MAAAA,CAAOU,WAAW,EAAET,MAAAA,CAAAA;IAEpFA,MAAAA,CAAOa,KAAK,CAAC,CAAC,MAAM,EAAEF,sBAAAA,CAAuBG,MAAM,CAAC,aAAa,CAAC,CAAA;IAElE,IAAIH,sBAAAA,CAAuBG,MAAM,KAAK,CAAA,EAAG;QACvC,OAAO;YAAEC,MAAAA,EAAQrD,iCAAAA;AAAmCsD,YAAAA,KAAAA,EAAO;AAAG,SAAA;AAChE,IAAA;;IAGA,MAAMD,MAAAA,GAAS,MAAME,+BAAAA,CACnB1D,QAAAA,EACAoD,uBAAuBO,IAAI,CAACC,2BAAmB,IAAA,GAAOxD,+BAAAA,EAAAA,GAAoC,EAAE,EAC5FgD,sBAAAA,EACA,CAACS,MAAAA,GACCD,qBAAAA,CAAcC,UACV/D,OAAAA,CAAQQ,uBAAuB,CAACL,aAAAA,EAAe;YAAC6D,oBAAAA,CAAaD,MAAAA;AAAQ,SAAA,CAAA,GACrE/D,QAAQc,qBAAqB,CAACb,aAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA;IAGlE,OAAO;AAAEmC,QAAAA,MAAAA;AAAQC,QAAAA,KAAAA,EAAO;AAAG,KAAA;AAC7B;;;;"}

package/dist/generators/middlewares/index.mjs

@@ -0,0 +1,141 @@
+import * as ts from 'typescript';
+import { collectAppSources, filterRegisteredSources, emitRegistryDefinitions, isTypedSource, withDocComment, typeofImport } from '../common/sources.mjs';
+
+const { factory } = ts;
+const REGISTRY = 'AppMiddlewares';
+const CONFIG_HELPER = 'MiddlewareConfig';
+const FACTORY_CONFIG_HELPER = 'MiddlewareFactoryConfig';
+const NO_MIDDLEWARE_PLACEHOLDER_COMMENT = `/*
+ * The app doesn't have any middlewares yet.
+ */
+
+export {};
+`;
+/**
+ * type MiddlewareFactoryConfig<TFactory> = TFactory extends (...args: infer TArgs) => unknown
+ *   ? TFactory extends (config: never, ctx: { strapi: never }) => unknown
+ *     ? TArgs['length'] extends 0
+ *       ? undefined
+ *       : 0 extends 1 & TArgs[0]
+ *         ? unknown
+ *         : TArgs[0] extends { request: unknown; response: unknown; app: unknown }
+ *           ? never
+ *           : TArgs[0]
+ *     : never
+ *   : unknown;
+ *
+ * type MiddlewareConfig<TModule> = TModule extends { default: infer TExport }
+ *   ? MiddlewareFactoryConfig<TExport>
+ *   : unknown;
+ *
+ * Emitted in the file so that middlewares.ts stands alone, and only when a TypeScript middleware
+ * reads them, like the policies helpers.
+ *
+ * Resolves the config a middleware accepts from the type of its module: the first parameter of the
+ * factory it exports. A factory without parameters takes no config: `undefined`, as in
+ * PackageMiddlewares. An optional parameter keeps `undefined` in the config, so typed routes accept
+ * the name alone. An untyped (`any`) config and a module without a default export resolve to
+ * `unknown`, as for policies.
+ * A plain Koa handler `(ctx, next)` is not a factory: runtime calls it with the config and
+ * `{ strapi }`, which breaks. A function whose second parameter cannot take `{ strapi }`
+ * (Core.MiddlewareFactory) registers `never`, so typed routes reject its name. `never` stands for
+ * the Strapi instance, so that the file needs no import and any context type a factory declares
+ * accepts it.
+ * A handler with one parameter `(ctx)`, or an untyped `next`, takes `{ strapi }`: a first parameter
+ * with the required members of a Koa context (`request`, `response`, `app`) registers `never` too.
+ * TODO @Nico a handler whose context is `any` still registers as a factory with an untyped config
+ * (`unknown`); an opt-in `defineMiddleware` brand (new factory helpers, D15) would tell them apart
+ * TODO @Nico a module without a default export registers `undefined` at runtime (a reference to it
+ * throws "Middleware <uid> not found"); `unknown` accepts any reference to it, like an untyped one
+ */ const generateConfigHelpersDefinition = ()=>{
+    const args = factory.createTypeReferenceNode('TArgs');
+    const configArg = factory.createIndexedAccessTypeNode(args, factory.createLiteralTypeNode(factory.createNumericLiteral(0)));
+    const never = ()=>factory.createKeywordTypeNode(ts.SyntaxKind.NeverKeyword);
+    // (config: never, ctx: { strapi: never }) => unknown, what runtime calls a middleware with
+    const factorySignature = factory.createFunctionTypeNode(undefined, [
+        factory.createParameterDeclaration(undefined, undefined, 'config', undefined, never()),
+        factory.createParameterDeclaration(undefined, undefined, 'ctx', undefined, factory.createTypeLiteralNode([
+            factory.createPropertySignature(undefined, 'strapi', undefined, never())
+        ]))
+    ], factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword));
+    // { request: unknown; response: unknown; app: unknown }, required members of a Koa context
+    const koaContextShape = factory.createTypeLiteralNode([
+        'request',
+        'response',
+        'app'
+    ].map((member)=>factory.createPropertySignature(undefined, member, undefined, factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword))));
+    const factoryConfig = factory.createConditionalTypeNode(factory.createTypeReferenceNode('TFactory'), factory.createFunctionTypeNode(undefined, [
+        factory.createParameterDeclaration(undefined, factory.createToken(ts.SyntaxKind.DotDotDotToken), 'args', undefined, factory.createInferTypeNode(factory.createTypeParameterDeclaration(undefined, 'TArgs')))
+    ], factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)), factory.createConditionalTypeNode(factory.createTypeReferenceNode('TFactory'), factorySignature, factory.createConditionalTypeNode(factory.createIndexedAccessTypeNode(args, factory.createLiteralTypeNode(factory.createStringLiteral('length', true))), factory.createLiteralTypeNode(factory.createNumericLiteral(0)), factory.createKeywordTypeNode(ts.SyntaxKind.UndefinedKeyword), // 0 extends 1 & TArgs[0], true only when the config is `any`
+    factory.createConditionalTypeNode(factory.createLiteralTypeNode(factory.createNumericLiteral(0)), factory.createIntersectionTypeNode([
+        factory.createLiteralTypeNode(factory.createNumericLiteral(1)),
+        configArg
+    ]), factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword), // A Koa handler (ctx) or (ctx, next: any): its first parameter is a context
+    factory.createConditionalTypeNode(configArg, koaContextShape, never(), configArg))), // A Koa handler (ctx, next): its `next` cannot take `{ strapi }`
+    never()), factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword));
+    const moduleConfig = factory.createConditionalTypeNode(factory.createTypeReferenceNode('TModule'), factory.createTypeLiteralNode([
+        factory.createPropertySignature(undefined, 'default', undefined, factory.createInferTypeNode(factory.createTypeParameterDeclaration(undefined, 'TExport')))
+    ]), factory.createTypeReferenceNode(FACTORY_CONFIG_HELPER, [
+        factory.createTypeReferenceNode('TExport')
+    ]), factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword));
+    return [
+        withDocComment(factory.createTypeAliasDeclaration(undefined, factory.createIdentifier(FACTORY_CONFIG_HELPER), [
+            factory.createTypeParameterDeclaration(undefined, 'TFactory')
+        ], factoryConfig), '*\n * Config a middleware factory accepts: its first parameter, `undefined` when it has none,\n * `unknown` when it is untyped, `never` when the function is not a factory (a Koa handler).\n '),
+        withDocComment(factory.createTypeAliasDeclaration(undefined, factory.createIdentifier(CONFIG_HELPER), [
+            factory.createTypeParameterDeclaration(undefined, 'TModule')
+        ], moduleConfig), '*\n * Config accepted by the factory a middleware module exports.\n ')
+    ];
+};
+/**
+ * Generate type definitions for the application's middlewares (global::* and api::*)
+ *
+ * Middlewares are typed from their source file, so only the ones with a source in src/middlewares or
+ * src/api are emitted. Bundled middlewares (strapi::*, admin::*, plugin::*) are left to the packages
+ * themselves (Strapi.Registries.PackageMiddlewares), so registering application middlewares keeps
+ * them accepted.
+ *
+ * declare global {
+ *   namespace Strapi {
+ *     namespace Registries {
+ *       interface AppMiddlewares {
+ *         'global::<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;
+ *         'api::<api>.<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;
+ *         'global::<js middleware>': unknown;
+ *       }
+ *     }
+ *   }
+ * }
+ *
+ * Like JS policies (see the policies generator), JS middlewares are registered as `unknown` without
+ * an import.
+ * TODO @Nico with `allowJs`, a JSDoc-typed JS middleware could register its config like a TS one
+ */ const generateMiddlewaresDefinitions = async (options = {})=>{
+    const { strapi, logger, pwd: outDir } = options;
+    if (!outDir) {
+        throw new Error('The middlewares generator needs the output directory to resolve source imports');
+    }
+    const sources = await collectAppSources('middlewares', {
+        global: strapi.dirs.app.middlewares,
+        api: strapi.dirs.app.api
+    }, outDir, logger);
+    const middlewaresDefinitions = filterRegisteredSources(sources, strapi.middlewares, logger);
+    logger.debug(`Found ${middlewaresDefinitions.length} middlewares.`);
+    if (middlewaresDefinitions.length === 0) {
+        return {
+            output: NO_MIDDLEWARE_PLACEHOLDER_COMMENT,
+            stats: {}
+        };
+    }
+    // The helpers are only emitted when an entry reads them: `noUnusedLocals` reports unused ones
+    const output = await emitRegistryDefinitions(REGISTRY, middlewaresDefinitions.some(isTypedSource) === true ? generateConfigHelpersDefinition() : [], middlewaresDefinitions, (source)=>isTypedSource(source) ? factory.createTypeReferenceNode(CONFIG_HELPER, [
+            typeofImport(source)
+        ]) : factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword));
+    return {
+        output,
+        stats: {}
+    };
+};
+
+export { generateMiddlewaresDefinitions };
+//# sourceMappingURL=index.mjs.map

package/dist/generators/middlewares/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../../src/generators/middlewares/index.ts"],"sourcesContent":["import * as ts from 'typescript';\n\nimport {\n  collectAppSources,\n  emitRegistryDefinitions,\n  filterRegisteredSources,\n  isTypedSource,\n  typeofImport,\n  withDocComment,\n} from '../common/sources';\nimport type { GeneratorOptions } from '../utils';\n\nconst { factory } = ts;\n\nconst REGISTRY = 'AppMiddlewares';\nconst CONFIG_HELPER = 'MiddlewareConfig';\nconst FACTORY_CONFIG_HELPER = 'MiddlewareFactoryConfig';\n\nconst NO_MIDDLEWARE_PLACEHOLDER_COMMENT = `/*\n * The app doesn't have any middlewares yet.\n */\n\nexport {};\n`;\n\n/**\n * type MiddlewareFactoryConfig<TFactory> = TFactory extends (...args: infer TArgs) => unknown\n *   ? TFactory extends (config: never, ctx: { strapi: never }) => unknown\n *     ? TArgs['length'] extends 0\n *       ? undefined\n *       : 0 extends 1 & TArgs[0]\n *         ? unknown\n *         : TArgs[0] extends { request: unknown; response: unknown; app: unknown }\n *           ? never\n *           : TArgs[0]\n *     : never\n *   : unknown;\n *\n * type MiddlewareConfig<TModule> = TModule extends { default: infer TExport }\n *   ? MiddlewareFactoryConfig<TExport>\n *   : unknown;\n *\n * Emitted in the file so that middlewares.ts stands alone, and only when a TypeScript middleware\n * reads them, like the policies helpers.\n *\n * Resolves the config a middleware accepts from the type of its module: the first parameter of the\n * factory it exports. A factory without parameters takes no config: `undefined`, as in\n * PackageMiddlewares. An optional parameter keeps `undefined` in the config, so typed routes accept\n * the name alone. An untyped (`any`) config and a module without a default export resolve to\n * `unknown`, as for policies.\n * A plain Koa handler `(ctx, next)` is not a factory: runtime calls it with the config and\n * `{ strapi }`, which breaks. A function whose second parameter cannot take `{ strapi }`\n * (Core.MiddlewareFactory) registers `never`, so typed routes reject its name. `never` stands for\n * the Strapi instance, so that the file needs no import and any context type a factory declares\n * accepts it.\n * A handler with one parameter `(ctx)`, or an untyped `next`, takes `{ strapi }`: a first parameter\n * with the required members of a Koa context (`request`, `response`, `app`) registers `never` too.\n * TODO @Nico a handler whose context is `any` still registers as a factory with an untyped config\n * (`unknown`); an opt-in `defineMiddleware` brand (new factory helpers, D15) would tell them apart\n * TODO @Nico a module without a default export registers `undefined` at runtime (a reference to it\n * throws \"Middleware <uid> not found\"); `unknown` accepts any reference to it, like an untyped one\n */\nconst generateConfigHelpersDefinition = () => {\n  const args = factory.createTypeReferenceNode('TArgs');\n  const configArg = factory.createIndexedAccessTypeNode(\n    args,\n    factory.createLiteralTypeNode(factory.createNumericLiteral(0))\n  );\n\n  const never = () => factory.createKeywordTypeNode(ts.SyntaxKind.NeverKeyword);\n\n  // (config: never, ctx: { strapi: never }) => unknown, what runtime calls a middleware with\n  const factorySignature = factory.createFunctionTypeNode(\n    undefined,\n    [\n      factory.createParameterDeclaration(undefined, undefined, 'config', undefined, never()),\n      factory.createParameterDeclaration(\n        undefined,\n        undefined,\n        'ctx',\n        undefined,\n        factory.createTypeLiteralNode([\n          factory.createPropertySignature(undefined, 'strapi', undefined, never()),\n        ])\n      ),\n    ],\n    factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n  );\n\n  // { request: unknown; response: unknown; app: unknown }, required members of a Koa context\n  const koaContextShape = factory.createTypeLiteralNode(\n    ['request', 'response', 'app'].map((member) =>\n      factory.createPropertySignature(\n        undefined,\n        member,\n        undefined,\n        factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n      )\n    )\n  );\n\n  const factoryConfig = factory.createConditionalTypeNode(\n    factory.createTypeReferenceNode('TFactory'),\n    factory.createFunctionTypeNode(\n      undefined,\n      [\n        factory.createParameterDeclaration(\n          undefined,\n          factory.createToken(ts.SyntaxKind.DotDotDotToken),\n          'args',\n          undefined,\n          factory.createInferTypeNode(factory.createTypeParameterDeclaration(undefined, 'TArgs'))\n        ),\n      ],\n      factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n    ),\n    factory.createConditionalTypeNode(\n      factory.createTypeReferenceNode('TFactory'),\n      factorySignature,\n      factory.createConditionalTypeNode(\n        factory.createIndexedAccessTypeNode(\n          args,\n          factory.createLiteralTypeNode(factory.createStringLiteral('length', true))\n        ),\n        factory.createLiteralTypeNode(factory.createNumericLiteral(0)),\n        factory.createKeywordTypeNode(ts.SyntaxKind.UndefinedKeyword),\n        // 0 extends 1 & TArgs[0], true only when the config is `any`\n        factory.createConditionalTypeNode(\n          factory.createLiteralTypeNode(factory.createNumericLiteral(0)),\n          factory.createIntersectionTypeNode([\n            factory.createLiteralTypeNode(factory.createNumericLiteral(1)),\n            configArg,\n          ]),\n          factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword),\n          // A Koa handler (ctx) or (ctx, next: any): its first parameter is a context\n          factory.createConditionalTypeNode(configArg, koaContextShape, never(), configArg)\n        )\n      ),\n      // A Koa handler (ctx, next): its `next` cannot take `{ strapi }`\n      never()\n    ),\n    factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n  );\n\n  const moduleConfig = factory.createConditionalTypeNode(\n    factory.createTypeReferenceNode('TModule'),\n    factory.createTypeLiteralNode([\n      factory.createPropertySignature(\n        undefined,\n        'default',\n        undefined,\n        factory.createInferTypeNode(factory.createTypeParameterDeclaration(undefined, 'TExport'))\n      ),\n    ]),\n    factory.createTypeReferenceNode(FACTORY_CONFIG_HELPER, [\n      factory.createTypeReferenceNode('TExport'),\n    ]),\n    factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n  );\n\n  return [\n    withDocComment(\n      factory.createTypeAliasDeclaration(\n        undefined,\n        factory.createIdentifier(FACTORY_CONFIG_HELPER),\n        [factory.createTypeParameterDeclaration(undefined, 'TFactory')],\n        factoryConfig\n      ),\n      '*\\n * Config a middleware factory accepts: its first parameter, `undefined` when it has none,\\n * `unknown` when it is untyped, `never` when the function is not a factory (a Koa handler).\\n '\n    ),\n    withDocComment(\n      factory.createTypeAliasDeclaration(\n        undefined,\n        factory.createIdentifier(CONFIG_HELPER),\n        [factory.createTypeParameterDeclaration(undefined, 'TModule')],\n        moduleConfig\n      ),\n      '*\\n * Config accepted by the factory a middleware module exports.\\n '\n    ),\n  ];\n};\n\n/**\n * Generate type definitions for the application's middlewares (global::* and api::*)\n *\n * Middlewares are typed from their source file, so only the ones with a source in src/middlewares or\n * src/api are emitted. Bundled middlewares (strapi::*, admin::*, plugin::*) are left to the packages\n * themselves (Strapi.Registries.PackageMiddlewares), so registering application middlewares keeps\n * them accepted.\n *\n * declare global {\n *   namespace Strapi {\n *     namespace Registries {\n *       interface AppMiddlewares {\n *         'global::<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;\n *         'api::<api>.<middleware>': MiddlewareConfig<typeof import('<relative path to the source>')>;\n *         'global::<js middleware>': unknown;\n *       }\n *     }\n *   }\n * }\n *\n * Like JS policies (see the policies generator), JS middlewares are registered as `unknown` without\n * an import.\n * TODO @Nico with `allowJs`, a JSDoc-typed JS middleware could register its config like a TS one\n */\nexport const generateMiddlewaresDefinitions = async (\n  options: GeneratorOptions = {} as GeneratorOptions\n) => {\n  const { strapi, logger, pwd: outDir } = options;\n\n  if (!outDir) {\n    throw new Error(\n      'The middlewares generator needs the output directory to resolve source imports'\n    );\n  }\n\n  const sources = await collectAppSources(\n    'middlewares',\n    { global: strapi.dirs.app.middlewares, api: strapi.dirs.app.api },\n    outDir,\n    logger\n  );\n  const middlewaresDefinitions = filterRegisteredSources(sources, strapi.middlewares, logger);\n\n  logger.debug(`Found ${middlewaresDefinitions.length} middlewares.`);\n\n  if (middlewaresDefinitions.length === 0) {\n    return { output: NO_MIDDLEWARE_PLACEHOLDER_COMMENT, stats: {} };\n  }\n\n  // The helpers are only emitted when an entry reads them: `noUnusedLocals` reports unused ones\n  const output = await emitRegistryDefinitions(\n    REGISTRY,\n    middlewaresDefinitions.some(isTypedSource) === true ? generateConfigHelpersDefinition() : [],\n    middlewaresDefinitions,\n    (source) =>\n      isTypedSource(source)\n        ? factory.createTypeReferenceNode(CONFIG_HELPER, [typeofImport(source)])\n        : factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)\n  );\n\n  return { output, stats: {} };\n};\n"],"names":["factory","ts","REGISTRY","CONFIG_HELPER","FACTORY_CONFIG_HELPER","NO_MIDDLEWARE_PLACEHOLDER_COMMENT","generateConfigHelpersDefinition","args","createTypeReferenceNode","configArg","createIndexedAccessTypeNode","createLiteralTypeNode","createNumericLiteral","never","createKeywordTypeNode","SyntaxKind","NeverKeyword","factorySignature","createFunctionTypeNode","undefined","createParameterDeclaration","createTypeLiteralNode","createPropertySignature","UnknownKeyword","koaContextShape","map","member","factoryConfig","createConditionalTypeNode","createToken","DotDotDotToken","createInferTypeNode","createTypeParameterDeclaration","createStringLiteral","UndefinedKeyword","createIntersectionTypeNode","moduleConfig","withDocComment","createTypeAliasDeclaration","createIdentifier","generateMiddlewaresDefinitions","options","strapi","logger","pwd","outDir","Error","sources","collectAppSources","global","dirs","app","middlewares","api","middlewaresDefinitions","filterRegisteredSources","debug","length","output","stats","emitRegistryDefinitions","some","isTypedSource","source","typeofImport"],"mappings":";;;AAYA,MAAM,EAAEA,OAAO,EAAE,GAAGC,EAAAA;AAEpB,MAAMC,QAAAA,GAAW,gBAAA;AACjB,MAAMC,aAAAA,GAAgB,kBAAA;AACtB,MAAMC,qBAAAA,GAAwB,yBAAA;AAE9B,MAAMC,oCAAoC,CAAC;;;;;AAK3C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCC,IACD,MAAMC,+BAAAA,GAAkC,IAAA;IACtC,MAAMC,IAAAA,GAAOP,OAAAA,CAAQQ,uBAAuB,CAAC,OAAA,CAAA;IAC7C,MAAMC,SAAAA,GAAYT,OAAAA,CAAQU,2BAA2B,CACnDH,IAAAA,EACAP,QAAQW,qBAAqB,CAACX,OAAAA,CAAQY,oBAAoB,CAAC,CAAA,CAAA,CAAA,CAAA;IAG7D,MAAMC,KAAAA,GAAQ,IAAMb,OAAAA,CAAQc,qBAAqB,CAACb,EAAAA,CAAGc,UAAU,CAACC,YAAY,CAAA;;AAG5E,IAAA,MAAMC,gBAAAA,GAAmBjB,OAAAA,CAAQkB,sBAAsB,CACrDC,SAAAA,EACA;AACEnB,QAAAA,OAAAA,CAAQoB,0BAA0B,CAACD,SAAAA,EAAWA,SAAAA,EAAW,UAAUA,SAAAA,EAAWN,KAAAA,EAAAA,CAAAA;QAC9Eb,OAAAA,CAAQoB,0BAA0B,CAChCD,SAAAA,EACAA,SAAAA,EACA,OACAA,SAAAA,EACAnB,OAAAA,CAAQqB,qBAAqB,CAAC;AAC5BrB,YAAAA,OAAAA,CAAQsB,uBAAuB,CAACH,SAAAA,EAAW,QAAA,EAAUA,SAAAA,EAAWN,KAAAA,EAAAA;AACjE,SAAA,CAAA;AAEJ,KAAA,EACDb,QAAQc,qBAAqB,CAACb,EAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA;;IAI5D,MAAMC,eAAAA,GAAkBxB,OAAAA,CAAQqB,qBAAqB,CACnD;AAAC,QAAA,SAAA;AAAW,QAAA,UAAA;AAAY,QAAA;AAAM,KAAA,CAACI,GAAG,CAAC,CAACC,MAAAA,GAClC1B,OAAAA,CAAQsB,uBAAuB,CAC7BH,SAAAA,EACAO,MAAAA,EACAP,SAAAA,EACAnB,QAAQc,qBAAqB,CAACb,EAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA,CAAA,CAAA;IAKhE,MAAMI,aAAAA,GAAgB3B,OAAAA,CAAQ4B,yBAAyB,CACrD5B,OAAAA,CAAQQ,uBAAuB,CAAC,UAAA,CAAA,EAChCR,OAAAA,CAAQkB,sBAAsB,CAC5BC,SAAAA,EACA;AACEnB,QAAAA,OAAAA,CAAQoB,0BAA0B,CAChCD,SAAAA,EACAnB,QAAQ6B,WAAW,CAAC5B,GAAGc,UAAU,CAACe,cAAc,CAAA,EAChD,MAAA,EACAX,WACAnB,OAAAA,CAAQ+B,mBAAmB,CAAC/B,OAAAA,CAAQgC,8BAA8B,CAACb,SAAAA,EAAW,OAAA,CAAA,CAAA;KAEjF,EACDnB,OAAAA,CAAQc,qBAAqB,CAACb,EAAAA,CAAGc,UAAU,CAACQ,cAAc,IAE5DvB,OAAAA,CAAQ4B,yBAAyB,CAC/B5B,OAAAA,CAAQQ,uBAAuB,CAAC,UAAA,CAAA,EAChCS,gBAAAA,EACAjB,QAAQ4B,yBAAyB,CAC/B5B,OAAAA,CAAQU,2BAA2B,CACjCH,IAAAA,EACAP,QAAQW,qBAAqB,CAACX,QAAQiC,mBAAmB,CAAC,UAAU,IAAA,CAAA,CAAA,CAAA,EAEtEjC,OAAAA,CAAQW,qBAAqB,CAACX,OAAAA,CAAQY,oBAAoB,CAAC,CAAA,CAAA,CAAA,EAC3DZ,QAAQc,qBAAqB,CAACb,GAAGc,UAAU,CAACmB,gBAAgB,CAAA;IAE5DlC,OAAAA,CAAQ4B,yBAAyB,CAC/B5B,OAAAA,CAAQW,qBAAqB,CAACX,OAAAA,CAAQY,oBAAoB,CAAC,CAAA,CAAA,CAAA,EAC3DZ,OAAAA,CAAQmC,0BAA0B,CAAC;AACjCnC,QAAAA,OAAAA,CAAQW,qBAAqB,CAACX,OAAAA,CAAQY,oBAAoB,CAAC,CAAA,CAAA,CAAA;AAC3DH,QAAAA;KACD,CAAA,EACDT,OAAAA,CAAQc,qBAAqB,CAACb,EAAAA,CAAGc,UAAU,CAACQ,cAAc;AAE1DvB,IAAAA,OAAAA,CAAQ4B,yBAAyB,CAACnB,SAAAA,EAAWe,eAAAA,EAAiBX,KAAAA,EAAAA,EAASJ;AAI3EI,IAAAA,KAAAA,EAAAA,CAAAA,EAEFb,QAAQc,qBAAqB,CAACb,EAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA;IAG5D,MAAMa,YAAAA,GAAepC,OAAAA,CAAQ4B,yBAAyB,CACpD5B,OAAAA,CAAQQ,uBAAuB,CAAC,SAAA,CAAA,EAChCR,OAAAA,CAAQqB,qBAAqB,CAAC;QAC5BrB,OAAAA,CAAQsB,uBAAuB,CAC7BH,SAAAA,EACA,SAAA,EACAA,SAAAA,EACAnB,OAAAA,CAAQ+B,mBAAmB,CAAC/B,OAAAA,CAAQgC,8BAA8B,CAACb,SAAAA,EAAW,SAAA,CAAA,CAAA;KAEjF,CAAA,EACDnB,OAAAA,CAAQQ,uBAAuB,CAACJ,qBAAAA,EAAuB;AACrDJ,QAAAA,OAAAA,CAAQQ,uBAAuB,CAAC,SAAA;AACjC,KAAA,CAAA,EACDR,QAAQc,qBAAqB,CAACb,EAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA;IAG5D,OAAO;AACLc,QAAAA,cAAAA,CACErC,QAAQsC,0BAA0B,CAChCnB,WACAnB,OAAAA,CAAQuC,gBAAgB,CAACnC,qBAAAA,CAAAA,EACzB;YAACJ,OAAAA,CAAQgC,8BAA8B,CAACb,SAAAA,EAAW,UAAA;AAAY,SAAA,EAC/DQ,aAAAA,CAAAA,EAEF,gMAAA,CAAA;AAEFU,QAAAA,cAAAA,CACErC,QAAQsC,0BAA0B,CAChCnB,WACAnB,OAAAA,CAAQuC,gBAAgB,CAACpC,aAAAA,CAAAA,EACzB;YAACH,OAAAA,CAAQgC,8BAA8B,CAACb,SAAAA,EAAW,SAAA;AAAW,SAAA,EAC9DiB,YAAAA,CAAAA,EAEF,sEAAA;AAEH,KAAA;AACH,CAAA;AAEA;;;;;;;;;;;;;;;;;;;;;;;AAuBC,IACM,MAAMI,8BAAAA,GAAiC,OAC5CC,OAAAA,GAA4B,EAAsB,GAAA;IAElD,MAAM,EAAEC,MAAM,EAAEC,MAAM,EAAEC,GAAAA,EAAKC,MAAM,EAAE,GAAGJ,OAAAA;AAExC,IAAA,IAAI,CAACI,MAAAA,EAAQ;AACX,QAAA,MAAM,IAAIC,KAAAA,CACR,gFAAA,CAAA;AAEJ,IAAA;IAEA,MAAMC,OAAAA,GAAU,MAAMC,iBAAAA,CACpB,aAAA,EACA;AAAEC,QAAAA,MAAAA,EAAQP,MAAAA,CAAOQ,IAAI,CAACC,GAAG,CAACC,WAAW;AAAEC,QAAAA,GAAAA,EAAKX,MAAAA,CAAOQ,IAAI,CAACC,GAAG,CAACE;AAAI,KAAA,EAChER,MAAAA,EACAF,MAAAA,CAAAA;AAEF,IAAA,MAAMW,sBAAAA,GAAyBC,uBAAAA,CAAwBR,OAAAA,EAASL,MAAAA,CAAOU,WAAW,EAAET,MAAAA,CAAAA;IAEpFA,MAAAA,CAAOa,KAAK,CAAC,CAAC,MAAM,EAAEF,sBAAAA,CAAuBG,MAAM,CAAC,aAAa,CAAC,CAAA;IAElE,IAAIH,sBAAAA,CAAuBG,MAAM,KAAK,CAAA,EAAG;QACvC,OAAO;YAAEC,MAAAA,EAAQrD,iCAAAA;AAAmCsD,YAAAA,KAAAA,EAAO;AAAG,SAAA;AAChE,IAAA;;IAGA,MAAMD,MAAAA,GAAS,MAAME,uBAAAA,CACnB1D,QAAAA,EACAoD,uBAAuBO,IAAI,CAACC,mBAAmB,IAAA,GAAOxD,+BAAAA,EAAAA,GAAoC,EAAE,EAC5FgD,sBAAAA,EACA,CAACS,MAAAA,GACCD,aAAAA,CAAcC,UACV/D,OAAAA,CAAQQ,uBAAuB,CAACL,aAAAA,EAAe;YAAC6D,YAAAA,CAAaD,MAAAA;AAAQ,SAAA,CAAA,GACrE/D,QAAQc,qBAAqB,CAACb,EAAAA,CAAGc,UAAU,CAACQ,cAAc,CAAA,CAAA;IAGlE,OAAO;AAAEmC,QAAAA,MAAAA;AAAQC,QAAAA,KAAAA,EAAO;AAAG,KAAA;AAC7B;;;;"}