@strapi/core 5.58.0 → 5.60.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/dist/Strapi.d.ts.map +1 -1
  2. package/dist/Strapi.js +1 -0
  3. package/dist/Strapi.js.map +1 -1
  4. package/dist/Strapi.mjs +1 -0
  5. package/dist/Strapi.mjs.map +1 -1
  6. package/dist/core-api/routes/index.js +10 -45
  7. package/dist/core-api/routes/index.js.map +1 -1
  8. package/dist/core-api/routes/index.mjs +10 -25
  9. package/dist/core-api/routes/index.mjs.map +1 -1
  10. package/dist/core-api/routes/response.d.ts +28 -0
  11. package/dist/core-api/routes/response.d.ts.map +1 -0
  12. package/dist/core-api/routes/response.js +63 -0
  13. package/dist/core-api/routes/response.js.map +1 -0
  14. package/dist/core-api/routes/response.mjs +40 -0
  15. package/dist/core-api/routes/response.mjs.map +1 -0
  16. package/dist/ee/entitlements.d.ts.map +1 -1
  17. package/dist/ee/entitlements.js.map +1 -1
  18. package/dist/ee/entitlements.mjs.map +1 -1
  19. package/dist/index.d.ts.map +1 -1
  20. package/dist/index.js +1 -1
  21. package/dist/index.js.map +1 -1
  22. package/dist/index.mjs +1 -1
  23. package/dist/index.mjs.map +1 -1
  24. package/dist/loaders/apis.d.ts.map +1 -1
  25. package/dist/loaders/apis.js.map +1 -1
  26. package/dist/loaders/apis.mjs.map +1 -1
  27. package/dist/loaders/plugins/get-enabled-plugins.js +2 -2
  28. package/dist/loaders/plugins/get-enabled-plugins.js.map +1 -1
  29. package/dist/loaders/plugins/get-enabled-plugins.mjs +2 -2
  30. package/dist/loaders/plugins/get-enabled-plugins.mjs.map +1 -1
  31. package/dist/middlewares/cors.d.ts.map +1 -1
  32. package/dist/middlewares/cors.js.map +1 -1
  33. package/dist/middlewares/cors.mjs.map +1 -1
  34. package/dist/migrations/database/5.0.0-discard-drafts.js +1 -1
  35. package/dist/migrations/database/5.0.0-discard-drafts.js.map +1 -1
  36. package/dist/migrations/database/5.0.0-discard-drafts.mjs +1 -1
  37. package/dist/migrations/database/5.0.0-discard-drafts.mjs.map +1 -1
  38. package/dist/migrations/first-published-at.js +1 -1
  39. package/dist/migrations/first-published-at.js.map +1 -1
  40. package/dist/migrations/first-published-at.mjs +1 -1
  41. package/dist/migrations/first-published-at.mjs.map +1 -1
  42. package/dist/package.json.js +15 -14
  43. package/dist/package.json.js.map +1 -1
  44. package/dist/package.json.mjs +15 -14
  45. package/dist/package.json.mjs.map +1 -1
  46. package/dist/providers/admin.d.ts.map +1 -1
  47. package/dist/providers/admin.js +8 -0
  48. package/dist/providers/admin.js.map +1 -1
  49. package/dist/providers/admin.mjs +8 -0
  50. package/dist/providers/admin.mjs.map +1 -1
  51. package/dist/registries/controllers.d.ts.map +1 -1
  52. package/dist/registries/controllers.js.map +1 -1
  53. package/dist/registries/controllers.mjs.map +1 -1
  54. package/dist/services/config.js +1 -1
  55. package/dist/services/config.js.map +1 -1
  56. package/dist/services/config.mjs +2 -2
  57. package/dist/services/config.mjs.map +1 -1
  58. package/dist/services/content-source-maps.js +6 -6
  59. package/dist/services/content-source-maps.js.map +1 -1
  60. package/dist/services/content-source-maps.mjs +6 -6
  61. package/dist/services/content-source-maps.mjs.map +1 -1
  62. package/dist/services/document-service/components.d.ts +27 -12
  63. package/dist/services/document-service/components.d.ts.map +1 -1
  64. package/dist/services/document-service/components.js +530 -86
  65. package/dist/services/document-service/components.js.map +1 -1
  66. package/dist/services/document-service/components.mjs +532 -89
  67. package/dist/services/document-service/components.mjs.map +1 -1
  68. package/dist/services/document-service/events.d.ts.map +1 -1
  69. package/dist/services/document-service/events.js +11 -2
  70. package/dist/services/document-service/events.js.map +1 -1
  71. package/dist/services/document-service/events.mjs +11 -2
  72. package/dist/services/document-service/events.mjs.map +1 -1
  73. package/dist/services/document-service/middlewares/middleware-manager.d.ts +1 -1
  74. package/dist/services/document-service/middlewares/middleware-manager.d.ts.map +1 -1
  75. package/dist/services/document-service/middlewares/middleware-manager.js +6 -1
  76. package/dist/services/document-service/middlewares/middleware-manager.js.map +1 -1
  77. package/dist/services/document-service/middlewares/middleware-manager.mjs +6 -1
  78. package/dist/services/document-service/middlewares/middleware-manager.mjs.map +1 -1
  79. package/dist/services/document-service/repository.d.ts.map +1 -1
  80. package/dist/services/document-service/repository.js +26 -7
  81. package/dist/services/document-service/repository.js.map +1 -1
  82. package/dist/services/document-service/repository.mjs +27 -8
  83. package/dist/services/document-service/repository.mjs.map +1 -1
  84. package/dist/services/document-service/transform/data.d.ts.map +1 -1
  85. package/dist/services/document-service/transform/data.js.map +1 -1
  86. package/dist/services/document-service/transform/data.mjs.map +1 -1
  87. package/dist/services/document-service/transform/relations/transform/default-locale.d.ts +4 -1
  88. package/dist/services/document-service/transform/relations/transform/default-locale.d.ts.map +1 -1
  89. package/dist/services/document-service/transform/relations/transform/default-locale.js +12 -9
  90. package/dist/services/document-service/transform/relations/transform/default-locale.js.map +1 -1
  91. package/dist/services/document-service/transform/relations/transform/default-locale.mjs +12 -10
  92. package/dist/services/document-service/transform/relations/transform/default-locale.mjs.map +1 -1
  93. package/dist/services/document-service/utils/clone-relations.d.ts +21 -4
  94. package/dist/services/document-service/utils/clone-relations.d.ts.map +1 -1
  95. package/dist/services/document-service/utils/clone-relations.js +619 -34
  96. package/dist/services/document-service/utils/clone-relations.js.map +1 -1
  97. package/dist/services/document-service/utils/clone-relations.mjs +619 -36
  98. package/dist/services/document-service/utils/clone-relations.mjs.map +1 -1
  99. package/dist/services/document-service/utils/unidirectional-relations.d.ts +4 -2
  100. package/dist/services/document-service/utils/unidirectional-relations.d.ts.map +1 -1
  101. package/dist/services/document-service/utils/unidirectional-relations.js +1 -10
  102. package/dist/services/document-service/utils/unidirectional-relations.js.map +1 -1
  103. package/dist/services/document-service/utils/unidirectional-relations.mjs +1 -10
  104. package/dist/services/document-service/utils/unidirectional-relations.mjs.map +1 -1
  105. package/dist/services/entity-validator/index.d.ts.map +1 -1
  106. package/dist/services/entity-validator/index.js +6 -2
  107. package/dist/services/entity-validator/index.js.map +1 -1
  108. package/dist/services/entity-validator/index.mjs +7 -3
  109. package/dist/services/entity-validator/index.mjs.map +1 -1
  110. package/dist/services/event-hub.d.ts +1 -0
  111. package/dist/services/event-hub.d.ts.map +1 -1
  112. package/dist/services/event-hub.js +30 -5
  113. package/dist/services/event-hub.js.map +1 -1
  114. package/dist/services/event-hub.mjs +30 -5
  115. package/dist/services/event-hub.mjs.map +1 -1
  116. package/dist/services/mcp/handlers/handlePost.d.ts.map +1 -1
  117. package/dist/services/mcp/handlers/handlePost.js +4 -2
  118. package/dist/services/mcp/handlers/handlePost.js.map +1 -1
  119. package/dist/services/mcp/handlers/handlePost.mjs +4 -2
  120. package/dist/services/mcp/handlers/handlePost.mjs.map +1 -1
  121. package/dist/services/mcp/internal/McpServerFactory.d.ts +4 -1
  122. package/dist/services/mcp/internal/McpServerFactory.d.ts.map +1 -1
  123. package/dist/services/mcp/internal/McpServerFactory.js +8 -2
  124. package/dist/services/mcp/internal/McpServerFactory.js.map +1 -1
  125. package/dist/services/mcp/internal/McpServerFactory.mjs +9 -3
  126. package/dist/services/mcp/internal/McpServerFactory.mjs.map +1 -1
  127. package/dist/services/mcp/internal/resolveToolSchemaScope.d.ts +16 -0
  128. package/dist/services/mcp/internal/resolveToolSchemaScope.d.ts.map +1 -0
  129. package/dist/services/mcp/internal/resolveToolSchemaScope.js +40 -0
  130. package/dist/services/mcp/internal/resolveToolSchemaScope.js.map +1 -0
  131. package/dist/services/mcp/internal/resolveToolSchemaScope.mjs +38 -0
  132. package/dist/services/mcp/internal/resolveToolSchemaScope.mjs.map +1 -0
  133. package/dist/services/mcp/tool-registry.d.ts +5 -0
  134. package/dist/services/mcp/tool-registry.d.ts.map +1 -1
  135. package/dist/services/mcp/tool-registry.js +30 -1
  136. package/dist/services/mcp/tool-registry.js.map +1 -1
  137. package/dist/services/mcp/tool-registry.mjs +30 -1
  138. package/dist/services/mcp/tool-registry.mjs.map +1 -1
  139. package/dist/services/webhook-runner.d.ts.map +1 -1
  140. package/dist/services/webhook-runner.js +23 -3
  141. package/dist/services/webhook-runner.js.map +1 -1
  142. package/dist/services/webhook-runner.mjs +23 -3
  143. package/dist/services/webhook-runner.mjs.map +1 -1
  144. package/dist/services/webhook-store.d.ts.map +1 -1
  145. package/dist/services/webhook-store.js +23 -4
  146. package/dist/services/webhook-store.js.map +1 -1
  147. package/dist/services/webhook-store.mjs +23 -4
  148. package/dist/services/webhook-store.mjs.map +1 -1
  149. package/dist/utils/fetch.d.ts.map +1 -1
  150. package/dist/utils/fetch.js +44 -8
  151. package/dist/utils/fetch.js.map +1 -1
  152. package/dist/utils/fetch.mjs +37 -8
  153. package/dist/utils/fetch.mjs.map +1 -1
  154. package/dist/utils/transform-content-types-to-models.js +5 -5
  155. package/dist/utils/transform-content-types-to-models.js.map +1 -1
  156. package/dist/utils/transform-content-types-to-models.mjs +5 -5
  157. package/dist/utils/transform-content-types-to-models.mjs.map +1 -1
  158. package/package.json +15 -14
@@ -1 +1 @@
1
- {"version":3,"file":"tool-registry.js","sources":["../../../src/services/mcp/tool-registry.ts"],"sourcesContent":["import type { McpServer, RegisteredTool, ServerContext } from '@modelcontextprotocol/server';\nimport type { Core, Modules } from '@strapi/types';\nimport { McpCapabilityDefinitionRegistry } from './internal/McpCapabilityDefinitionRegistry';\nimport {\n type McpCapabilityRegistry,\n McpCapabilityRegistryBase,\n} from './internal/McpCapabilityRegistry';\nimport { wrapCapabilityHandlerForMetrics } from './metrics/wrapCapabilityHandlerForMetrics';\nimport { createSafeCapabilityRegistration } from './utils/createSafeCapabilityRegistration';\nimport { createMcpCapabilityHandlerContext } from './utils/createMcpCapabilityHandlerContext';\nimport { toSdkToolResult } from './utils/toSdkMcpCapabilityResult';\nimport type { McpAdminTokenAbility } from './authentication';\n\n/**\n * Defines a Strapi MCP tool with full type inference, ready to pass to\n * `strapi.ai.mcp.registerTool()`. Exposed publicly as `ai.mcp.defineTool`.\n *\n * The returned value is the definition unchanged — this builder only exists to\n * infer the `name`, input/output schemas and handler types, and to narrow the\n * access variant (`devModeOnly` vs `auth`) so the result is directly assignable\n * to `registerTool`.\n *\n * @param tool - The tool definition. Provide either `devModeOnly: true` (dev-only,\n * no auth) or an `auth` policy set — never both.\n * @returns The same definition, with its access variant narrowed.\n *\n * @example\n * ```ts\n * import { ai } from '@strapi/strapi';\n * import { z } from '@strapi/utils';\n *\n * const greet = ai.mcp.defineTool({\n * name: 'greet',\n * title: 'Greet',\n * description: 'Greets a user by name',\n * devModeOnly: true,\n * resolveInputSchema: () => z.object({ name: z.string() }),\n * resolveOutputSchema: () => z.object({ message: z.string() }),\n * createHandler: (strapi) => async ({ args }) => {\n * const message = `Hello, ${args.name}!`;\n * return { content: [{ type: 'text', text: message }], structuredContent: { message } };\n * },\n * });\n *\n * // later, in register() or bootstrap():\n * strapi.ai.mcp.registerTool(greet);\n * ```\n */\nexport const makeMcpToolDefinition = ((definition: Modules.MCP.McpToolDefinition) =>\n definition) as unknown as Modules.MCP.McpToolBuilder;\n\nexport class McpToolRegistry\n extends McpCapabilityRegistryBase<'tool', Modules.MCP.McpToolDefinition, RegisteredTool>\n implements McpCapabilityRegistry\n{\n #strapi: Core.Strapi;\n\n #ability: McpAdminTokenAbility;\n\n #user: Modules.MCP.McpHandlerContext['user'];\n\n constructor(ctx: {\n strapi: Core.Strapi;\n definitions: McpCapabilityDefinitionRegistry<'tool', Modules.MCP.McpToolDefinition>;\n ability: McpAdminTokenAbility;\n user: Modules.MCP.McpHandlerContext['user'];\n }) {\n super(ctx.definitions);\n this.#strapi = ctx.strapi;\n this.#ability = ctx.ability;\n this.#user = ctx.user;\n }\n\n bind(mcpServer: McpServer) {\n const strapi = this.#strapi;\n\n super.register((definition) => {\n const { name, title, description, resolveInputSchema, resolveOutputSchema, createHandler } =\n definition;\n\n // Bind the session ability and token owner into the handler context so handlers can enforce\n // field-level and entity-level permission checks and set creator fields.\n const context: Modules.MCP.McpHandlerContext = {\n userAbility: this.#ability,\n user: this.#user,\n };\n const createHandlerWithContext = (strapi: Core.Strapi) => createHandler(strapi, context);\n\n return createSafeCapabilityRegistration({\n strapi,\n capabilityType: 'Tool',\n name,\n createHandler: createHandlerWithContext,\n createFallbackHandler(errorMessage) {\n return async () => ({\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" failed to initialize: ${errorMessage}`,\n },\n ],\n isError: true,\n });\n },\n createErrorResult(error) {\n return {\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" execution failed: ${error.message}`,\n },\n ],\n isError: true,\n };\n },\n registerWithSdk(safeHandler) {\n const inputSchema =\n resolveInputSchema !== undefined ? resolveInputSchema(context) : undefined;\n const outputSchema = resolveOutputSchema(context);\n\n if (inputSchema !== undefined) {\n // Adapt from Strapi's object parameter to the SDK's positional callback.\n const sdkHandler = wrapCapabilityHandlerForMetrics(\n strapi,\n 'tool',\n name,\n definition.telemetry,\n async (args: unknown, context: ServerContext) =>\n toSdkToolResult(\n await safeHandler({\n args,\n extra: createMcpCapabilityHandlerContext(context),\n } as Parameters<typeof safeHandler>[0])\n )\n );\n\n return mcpServer.registerTool(\n name,\n { title, description, inputSchema, outputSchema },\n sdkHandler\n );\n }\n\n const sdkHandler = wrapCapabilityHandlerForMetrics(\n strapi,\n 'tool',\n name,\n definition.telemetry,\n async (context: ServerContext) =>\n toSdkToolResult(\n await safeHandler({\n extra: createMcpCapabilityHandlerContext(context),\n } as Parameters<typeof safeHandler>[0])\n )\n );\n\n return mcpServer.registerTool(name, { title, description, outputSchema }, sdkHandler);\n },\n });\n });\n }\n}\n"],"names":["makeMcpToolDefinition","definition","McpToolRegistry","McpCapabilityRegistryBase","bind","mcpServer","strapi","register","name","title","description","resolveInputSchema","resolveOutputSchema","createHandler","context","userAbility","user","createHandlerWithContext","createSafeCapabilityRegistration","capabilityType","createFallbackHandler","errorMessage","content","type","text","isError","createErrorResult","error","message","registerWithSdk","safeHandler","inputSchema","undefined","outputSchema","sdkHandler","wrapCapabilityHandlerForMetrics","telemetry","args","toSdkToolResult","extra","createMcpCapabilityHandlerContext","registerTool","ctx","definitions","ability"],"mappings":";;;;;;;;;;;;;;;;;;AAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCC,IACM,MAAMA,qBAAAA,GAAyB,CAACC,aACrCA;AAMA,IAAA,OAAA,iBAAA,8BAAA,CAAA,SAAA,CAAA,EAEA,QAAA,iBAAA,8BAAA,CAAA,UAAA,CAAA,EAEA,KAAA,iBAAA,8BAAA,CAAA,OAAA,CAAA;AARK,MAAMC,eAAAA,SACHC,+CAAAA,CAAAA;AAqBRC,IAAAA,IAAAA,CAAKC,SAAoB,EAAE;AACzB,QAAA,MAAMC,MAAAA,GAAS,+BAAA,CAAA,IAAI,EAAC,OAAA,CAAA,CAAA,OAAA,CAAA;QAEpB,KAAK,CAACC,SAAS,CAACN,UAAAA,GAAAA;AACd,YAAA,MAAM,EAAEO,IAAI,EAAEC,KAAK,EAAEC,WAAW,EAAEC,kBAAkB,EAAEC,mBAAmB,EAAEC,aAAa,EAAE,GACxFZ,UAAAA;;;AAIF,YAAA,MAAMa,OAAAA,GAAyC;AAC7CC,gBAAAA,WAAW,EAAE,+BAAA,CAAA,IAAI,EAAC,QAAA,CAAA,CAAA,QAAA,CAAA;AAClBC,gBAAAA,IAAI,EAAE,+BAAA,CAAA,IAAI,EAAC,KAAA,CAAA,CAAA,KAAA;AACb,aAAA;AACA,YAAA,MAAMC,wBAAAA,GAA2B,CAACX,MAAAA,GAAwBO,aAAAA,CAAcP,MAAAA,EAAQQ,OAAAA,CAAAA;AAEhF,YAAA,OAAOI,iEAAAA,CAAiC;AACtCZ,gBAAAA,MAAAA;gBACAa,cAAAA,EAAgB,MAAA;AAChBX,gBAAAA,IAAAA;gBACAK,aAAAA,EAAeI,wBAAAA;AACfG,gBAAAA,qBAAAA,CAAAA,CAAsBC,YAAY,EAAA;AAChC,oBAAA,OAAO,WAAa;4BAClBC,OAAAA,EAAS;AACP,gCAAA;oCACEC,IAAAA,EAAM,MAAA;AACNC,oCAAAA,IAAAA,EAAM,CAAC,MAAM,EAAEhB,IAAAA,CAAK,wBAAwB,EAAEa,YAAAA,CAAAA;AAChD;AACD,6BAAA;4BACDI,OAAAA,EAAS;yBACX,CAAA;AACF,gBAAA,CAAA;AACAC,gBAAAA,iBAAAA,CAAAA,CAAkBC,KAAK,EAAA;oBACrB,OAAO;wBACLL,OAAAA,EAAS;AACP,4BAAA;gCACEC,IAAAA,EAAM,MAAA;gCACNC,IAAAA,EAAM,CAAC,MAAM,EAAEhB,IAAAA,CAAK,oBAAoB,EAAEmB,KAAAA,CAAMC,OAAO,CAAA;AACzD;AACD,yBAAA;wBACDH,OAAAA,EAAS;AACX,qBAAA;AACF,gBAAA,CAAA;AACAI,gBAAAA,eAAAA,CAAAA,CAAgBC,WAAW,EAAA;AACzB,oBAAA,MAAMC,WAAAA,GACJpB,kBAAAA,KAAuBqB,SAAAA,GAAYrB,kBAAAA,CAAmBG,OAAAA,CAAAA,GAAWkB,SAAAA;AACnE,oBAAA,MAAMC,eAAerB,mBAAAA,CAAoBE,OAAAA,CAAAA;AAEzC,oBAAA,IAAIiB,gBAAgBC,SAAAA,EAAW;;AAE7B,wBAAA,MAAME,UAAAA,GAAaC,+DAAAA,CACjB7B,MAAAA,EACA,MAAA,EACAE,IAAAA,EACAP,UAAAA,CAAWmC,SAAS,EACpB,OAAOC,IAAAA,EAAevB,OAAAA,GACpBwB,wCAAAA,CACE,MAAMR,WAAAA,CAAY;AAChBO,gCAAAA,IAAAA;AACAE,gCAAAA,KAAAA,EAAOC,mEAAAA,CAAkC1B,OAAAA;AAC3C,6BAAA,CAAA,CAAA,CAAA;wBAIN,OAAOT,SAAAA,CAAUoC,YAAY,CAC3BjC,IAAAA,EACA;AAAEC,4BAAAA,KAAAA;AAAOC,4BAAAA,WAAAA;AAAaqB,4BAAAA,WAAAA;AAAaE,4BAAAA;yBAAa,EAChDC,UAAAA,CAAAA;AAEJ,oBAAA;AAEA,oBAAA,MAAMA,UAAAA,GAAaC,+DAAAA,CACjB7B,MAAAA,EACA,MAAA,EACAE,IAAAA,EACAP,UAAAA,CAAWmC,SAAS,EACpB,OAAOtB,OAAAA,GACLwB,wCAAAA,CACE,MAAMR,WAAAA,CAAY;AAChBS,4BAAAA,KAAAA,EAAOC,mEAAAA,CAAkC1B,OAAAA;AAC3C,yBAAA,CAAA,CAAA,CAAA;oBAIN,OAAOT,SAAAA,CAAUoC,YAAY,CAACjC,IAAAA,EAAM;AAAEC,wBAAAA,KAAAA;AAAOC,wBAAAA,WAAAA;AAAauB,wBAAAA;qBAAa,EAAGC,UAAAA,CAAAA;AAC5E,gBAAA;AACF,aAAA,CAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;AAnGA,IAAA,WAAA,CAAYQ,GAKX,CAAE;AACD,QAAA,KAAK,CAACA,GAAAA,CAAIC,WAAW,CAAA,EAZvB,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,OAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,QAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,KAAA,EAAA;;mBAAA;;AASE,QAAA,+BAAA,CAAA,IAAI,EAAC,OAAA,CAAA,CAAA,OAAA,CAAA,GAAUD,IAAIpC,MAAM;AACzB,QAAA,+BAAA,CAAA,IAAI,EAAC,QAAA,CAAA,CAAA,QAAA,CAAA,GAAWoC,IAAIE,OAAO;AAC3B,QAAA,+BAAA,CAAA,IAAI,EAAC,KAAA,CAAA,CAAA,KAAA,CAAA,GAAQF,IAAI1B,IAAI;AACvB,IAAA;AA0FF;;;;;"}
1
+ {"version":3,"file":"tool-registry.js","sources":["../../../src/services/mcp/tool-registry.ts"],"sourcesContent":["import type { McpServer, RegisteredTool, ServerContext } from '@modelcontextprotocol/server';\nimport type { Core, Modules } from '@strapi/types';\nimport { McpCapabilityDefinitionRegistry } from './internal/McpCapabilityDefinitionRegistry';\nimport {\n type McpCapabilityRegistry,\n McpCapabilityRegistryBase,\n} from './internal/McpCapabilityRegistry';\nimport { wrapCapabilityHandlerForMetrics } from './metrics/wrapCapabilityHandlerForMetrics';\nimport { createSafeCapabilityRegistration } from './utils/createSafeCapabilityRegistration';\nimport { createMcpCapabilityHandlerContext } from './utils/createMcpCapabilityHandlerContext';\nimport { toSdkToolResult } from './utils/toSdkMcpCapabilityResult';\nimport type { McpAdminTokenAbility } from './authentication';\n\n/**\n * Defines a Strapi MCP tool with full type inference, ready to pass to\n * `strapi.ai.mcp.registerTool()`. Exposed publicly as `ai.mcp.defineTool`.\n *\n * The returned value is the definition unchanged — this builder only exists to\n * infer the `name`, input/output schemas and handler types, and to narrow the\n * access variant (`devModeOnly` vs `auth`) so the result is directly assignable\n * to `registerTool`.\n *\n * @param tool - The tool definition. Provide either `devModeOnly: true` (dev-only,\n * no auth) or an `auth` policy set — never both.\n * @returns The same definition, with its access variant narrowed.\n *\n * @example\n * ```ts\n * import { ai } from '@strapi/strapi';\n * import { z } from '@strapi/utils';\n *\n * const greet = ai.mcp.defineTool({\n * name: 'greet',\n * title: 'Greet',\n * description: 'Greets a user by name',\n * devModeOnly: true,\n * resolveInputSchema: () => z.object({ name: z.string() }),\n * resolveOutputSchema: () => z.object({ message: z.string() }),\n * createHandler: (strapi) => async ({ args }) => {\n * const message = `Hello, ${args.name}!`;\n * return { content: [{ type: 'text', text: message }], structuredContent: { message } };\n * },\n * });\n *\n * // later, in register() or bootstrap():\n * strapi.ai.mcp.registerTool(greet);\n * ```\n */\nexport const makeMcpToolDefinition = ((definition: Modules.MCP.McpToolDefinition) =>\n definition) as unknown as Modules.MCP.McpToolBuilder;\n\nexport class McpToolRegistry\n extends McpCapabilityRegistryBase<'tool', Modules.MCP.McpToolDefinition, RegisteredTool>\n implements McpCapabilityRegistry\n{\n #strapi: Core.Strapi;\n\n #ability: McpAdminTokenAbility;\n\n #user: Modules.MCP.McpHandlerContext['user'];\n\n #shouldResolveSchemas: (definition: Modules.MCP.McpToolDefinition) => boolean;\n\n constructor(ctx: {\n strapi: Core.Strapi;\n definitions: McpCapabilityDefinitionRegistry<'tool', Modules.MCP.McpToolDefinition>;\n ability: McpAdminTokenAbility;\n user: Modules.MCP.McpHandlerContext['user'];\n /**\n * Whether the current request needs this tool's schemas. Resolving them is the dominant\n * per-request cost, so tools the request never lists nor calls skip it. Defaults to every tool.\n */\n shouldResolveSchemas?: (definition: Modules.MCP.McpToolDefinition) => boolean;\n }) {\n super(ctx.definitions);\n this.#strapi = ctx.strapi;\n this.#ability = ctx.ability;\n this.#user = ctx.user;\n this.#shouldResolveSchemas = ctx.shouldResolveSchemas ?? (() => true);\n }\n\n bind(mcpServer: McpServer) {\n const strapi = this.#strapi;\n\n super.register((definition) => {\n const { name, title, description, resolveInputSchema, resolveOutputSchema, createHandler } =\n definition;\n\n if (this.#shouldResolveSchemas(definition) === false) {\n // Keep the tool known to the SDK so a call answers `Tool <name> disabled` (no permission)\n // rather than `not found`. The request never lists nor runs it, so no schema is needed.\n const unavailableResult = {\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" is not available in this request`,\n },\n ],\n isError: true,\n };\n\n return createSafeCapabilityRegistration({\n strapi,\n capabilityType: 'Tool',\n name,\n createHandler: () => async () => unavailableResult,\n createFallbackHandler: () => async () => unavailableResult,\n createErrorResult: () => unavailableResult,\n registerWithSdk: (safeHandler) =>\n mcpServer.registerTool(name, { title, description }, safeHandler),\n });\n }\n\n // Bind the session ability and token owner into the handler context so handlers can enforce\n // field-level and entity-level permission checks and set creator fields.\n const context: Modules.MCP.McpHandlerContext = {\n userAbility: this.#ability,\n user: this.#user,\n };\n const createHandlerWithContext = (strapi: Core.Strapi) => createHandler(strapi, context);\n\n return createSafeCapabilityRegistration({\n strapi,\n capabilityType: 'Tool',\n name,\n createHandler: createHandlerWithContext,\n createFallbackHandler(errorMessage) {\n return async () => ({\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" failed to initialize: ${errorMessage}`,\n },\n ],\n isError: true,\n });\n },\n createErrorResult(error) {\n return {\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" execution failed: ${error.message}`,\n },\n ],\n isError: true,\n };\n },\n registerWithSdk(safeHandler) {\n const inputSchema =\n resolveInputSchema !== undefined ? resolveInputSchema(context) : undefined;\n const outputSchema = resolveOutputSchema(context);\n\n if (inputSchema !== undefined) {\n // Adapt from Strapi's object parameter to the SDK's positional callback.\n const sdkHandler = wrapCapabilityHandlerForMetrics(\n strapi,\n 'tool',\n name,\n definition.telemetry,\n async (args: unknown, context: ServerContext) =>\n toSdkToolResult(\n await safeHandler({\n args,\n extra: createMcpCapabilityHandlerContext(context),\n } as Parameters<typeof safeHandler>[0])\n )\n );\n\n return mcpServer.registerTool(\n name,\n { title, description, inputSchema, outputSchema },\n sdkHandler\n );\n }\n\n const sdkHandler = wrapCapabilityHandlerForMetrics(\n strapi,\n 'tool',\n name,\n definition.telemetry,\n async (context: ServerContext) =>\n toSdkToolResult(\n await safeHandler({\n extra: createMcpCapabilityHandlerContext(context),\n } as Parameters<typeof safeHandler>[0])\n )\n );\n\n return mcpServer.registerTool(name, { title, description, outputSchema }, sdkHandler);\n },\n });\n });\n }\n}\n"],"names":["makeMcpToolDefinition","definition","McpToolRegistry","McpCapabilityRegistryBase","bind","mcpServer","strapi","register","name","title","description","resolveInputSchema","resolveOutputSchema","createHandler","unavailableResult","content","type","text","isError","createSafeCapabilityRegistration","capabilityType","createFallbackHandler","createErrorResult","registerWithSdk","safeHandler","registerTool","context","userAbility","user","createHandlerWithContext","errorMessage","error","message","inputSchema","undefined","outputSchema","sdkHandler","wrapCapabilityHandlerForMetrics","telemetry","args","toSdkToolResult","extra","createMcpCapabilityHandlerContext","ctx","definitions","ability","shouldResolveSchemas"],"mappings":";;;;;;;;;;;;;;;;;;AAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCC,IACM,MAAMA,qBAAAA,GAAyB,CAACC,aACrCA;AAMA,IAAA,OAAA,iBAAA,8BAAA,CAAA,SAAA,CAAA,EAEA,qEAEA,KAAA,iBAAA,8BAAA,CAAA,OAAA,CAAA,EAEA,qBAAA,iBAAA,8BAAA,CAAA,uBAAA,CAAA;AAVK,MAAMC,eAAAA,SACHC,+CAAAA,CAAAA;AA6BRC,IAAAA,IAAAA,CAAKC,SAAoB,EAAE;AACzB,QAAA,MAAMC,MAAAA,GAAS,+BAAA,CAAA,IAAI,EAAC,OAAA,CAAA,CAAA,OAAA,CAAA;QAEpB,KAAK,CAACC,SAAS,CAACN,UAAAA,GAAAA;AACd,YAAA,MAAM,EAAEO,IAAI,EAAEC,KAAK,EAAEC,WAAW,EAAEC,kBAAkB,EAAEC,mBAAmB,EAAEC,aAAa,EAAE,GACxFZ,UAAAA;AAEF,YAAA,IAAI,gCAAA,IAAI,EAAC,qBAAA,CAAA,CAAA,qBAAA,CAAA,CAAsBA,gBAAgB,KAAA,EAAO;;;AAGpD,gBAAA,MAAMa,iBAAAA,GAAoB;oBACxBC,OAAAA,EAAS;AACP,wBAAA;4BACEC,IAAAA,EAAM,MAAA;AACNC,4BAAAA,IAAAA,EAAM,CAAC,MAAM,EAAET,IAAAA,CAAK,kCAAkC;AACxD;AACD,qBAAA;oBACDU,OAAAA,EAAS;AACX,iBAAA;AAEA,gBAAA,OAAOC,iEAAAA,CAAiC;AACtCb,oBAAAA,MAAAA;oBACAc,cAAAA,EAAgB,MAAA;AAChBZ,oBAAAA,IAAAA;AACAK,oBAAAA,aAAAA,EAAe,IAAM,UAAYC,iBAAAA;AACjCO,oBAAAA,qBAAAA,EAAuB,IAAM,UAAYP,iBAAAA;AACzCQ,oBAAAA,iBAAAA,EAAmB,IAAMR,iBAAAA;AACzBS,oBAAAA,eAAAA,EAAiB,CAACC,WAAAA,GAChBnB,SAAAA,CAAUoB,YAAY,CAACjB,IAAAA,EAAM;AAAEC,4BAAAA,KAAAA;AAAOC,4BAAAA;yBAAY,EAAGc,WAAAA;AACzD,iBAAA,CAAA;AACF,YAAA;;;AAIA,YAAA,MAAME,OAAAA,GAAyC;AAC7CC,gBAAAA,WAAW,EAAE,+BAAA,CAAA,IAAI,EAAC,QAAA,CAAA,CAAA,QAAA,CAAA;AAClBC,gBAAAA,IAAI,EAAE,+BAAA,CAAA,IAAI,EAAC,KAAA,CAAA,CAAA,KAAA;AACb,aAAA;AACA,YAAA,MAAMC,wBAAAA,GAA2B,CAACvB,MAAAA,GAAwBO,aAAAA,CAAcP,MAAAA,EAAQoB,OAAAA,CAAAA;AAEhF,YAAA,OAAOP,iEAAAA,CAAiC;AACtCb,gBAAAA,MAAAA;gBACAc,cAAAA,EAAgB,MAAA;AAChBZ,gBAAAA,IAAAA;gBACAK,aAAAA,EAAegB,wBAAAA;AACfR,gBAAAA,qBAAAA,CAAAA,CAAsBS,YAAY,EAAA;AAChC,oBAAA,OAAO,WAAa;4BAClBf,OAAAA,EAAS;AACP,gCAAA;oCACEC,IAAAA,EAAM,MAAA;AACNC,oCAAAA,IAAAA,EAAM,CAAC,MAAM,EAAET,IAAAA,CAAK,wBAAwB,EAAEsB,YAAAA,CAAAA;AAChD;AACD,6BAAA;4BACDZ,OAAAA,EAAS;yBACX,CAAA;AACF,gBAAA,CAAA;AACAI,gBAAAA,iBAAAA,CAAAA,CAAkBS,KAAK,EAAA;oBACrB,OAAO;wBACLhB,OAAAA,EAAS;AACP,4BAAA;gCACEC,IAAAA,EAAM,MAAA;gCACNC,IAAAA,EAAM,CAAC,MAAM,EAAET,IAAAA,CAAK,oBAAoB,EAAEuB,KAAAA,CAAMC,OAAO,CAAA;AACzD;AACD,yBAAA;wBACDd,OAAAA,EAAS;AACX,qBAAA;AACF,gBAAA,CAAA;AACAK,gBAAAA,eAAAA,CAAAA,CAAgBC,WAAW,EAAA;AACzB,oBAAA,MAAMS,WAAAA,GACJtB,kBAAAA,KAAuBuB,SAAAA,GAAYvB,kBAAAA,CAAmBe,OAAAA,CAAAA,GAAWQ,SAAAA;AACnE,oBAAA,MAAMC,eAAevB,mBAAAA,CAAoBc,OAAAA,CAAAA;AAEzC,oBAAA,IAAIO,gBAAgBC,SAAAA,EAAW;;AAE7B,wBAAA,MAAME,UAAAA,GAAaC,+DAAAA,CACjB/B,MAAAA,EACA,MAAA,EACAE,IAAAA,EACAP,UAAAA,CAAWqC,SAAS,EACpB,OAAOC,IAAAA,EAAeb,OAAAA,GACpBc,wCAAAA,CACE,MAAMhB,WAAAA,CAAY;AAChBe,gCAAAA,IAAAA;AACAE,gCAAAA,KAAAA,EAAOC,mEAAAA,CAAkChB,OAAAA;AAC3C,6BAAA,CAAA,CAAA,CAAA;wBAIN,OAAOrB,SAAAA,CAAUoB,YAAY,CAC3BjB,IAAAA,EACA;AAAEC,4BAAAA,KAAAA;AAAOC,4BAAAA,WAAAA;AAAauB,4BAAAA,WAAAA;AAAaE,4BAAAA;yBAAa,EAChDC,UAAAA,CAAAA;AAEJ,oBAAA;AAEA,oBAAA,MAAMA,UAAAA,GAAaC,+DAAAA,CACjB/B,MAAAA,EACA,MAAA,EACAE,IAAAA,EACAP,UAAAA,CAAWqC,SAAS,EACpB,OAAOZ,OAAAA,GACLc,wCAAAA,CACE,MAAMhB,WAAAA,CAAY;AAChBiB,4BAAAA,KAAAA,EAAOC,mEAAAA,CAAkChB,OAAAA;AAC3C,yBAAA,CAAA,CAAA,CAAA;oBAIN,OAAOrB,SAAAA,CAAUoB,YAAY,CAACjB,IAAAA,EAAM;AAAEC,wBAAAA,KAAAA;AAAOC,wBAAAA,WAAAA;AAAayB,wBAAAA;qBAAa,EAAGC,UAAAA,CAAAA;AAC5E,gBAAA;AACF,aAAA,CAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;AAlIA,IAAA,WAAA,CAAYO,GAUX,CAAE;AACD,QAAA,KAAK,CAACA,GAAAA,CAAIC,WAAW,CAAA,EAnBvB,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,OAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,QAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,KAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,qBAAA,EAAA;;mBAAA;;AAcE,QAAA,+BAAA,CAAA,IAAI,EAAC,OAAA,CAAA,CAAA,OAAA,CAAA,GAAUD,IAAIrC,MAAM;AACzB,QAAA,+BAAA,CAAA,IAAI,EAAC,QAAA,CAAA,CAAA,QAAA,CAAA,GAAWqC,IAAIE,OAAO;AAC3B,QAAA,+BAAA,CAAA,IAAI,EAAC,KAAA,CAAA,CAAA,KAAA,CAAA,GAAQF,IAAIf,IAAI;QACrB,+BAAA,CAAA,IAAI,EAAC,qBAAA,CAAA,CAAA,qBAAA,CAAA,GAAwBe,IAAIG,oBAAoB,KAAK,IAAM,IAAG,CAAA;AACrE,IAAA;AAmHF;;;;;"}
@@ -49,12 +49,37 @@ function _class_private_field_loose_key(name) {
49
49
  * strapi.ai.mcp.registerTool(greet);
50
50
  * ```
51
51
  */ const makeMcpToolDefinition = (definition)=>definition;
52
- var _strapi = /*#__PURE__*/ _class_private_field_loose_key("_strapi"), _ability = /*#__PURE__*/ _class_private_field_loose_key("_ability"), _user = /*#__PURE__*/ _class_private_field_loose_key("_user");
52
+ var _strapi = /*#__PURE__*/ _class_private_field_loose_key("_strapi"), _ability = /*#__PURE__*/ _class_private_field_loose_key("_ability"), _user = /*#__PURE__*/ _class_private_field_loose_key("_user"), _shouldResolveSchemas = /*#__PURE__*/ _class_private_field_loose_key("_shouldResolveSchemas");
53
53
  class McpToolRegistry extends McpCapabilityRegistryBase {
54
54
  bind(mcpServer) {
55
55
  const strapi = _class_private_field_loose_base(this, _strapi)[_strapi];
56
56
  super.register((definition)=>{
57
57
  const { name, title, description, resolveInputSchema, resolveOutputSchema, createHandler } = definition;
58
+ if (_class_private_field_loose_base(this, _shouldResolveSchemas)[_shouldResolveSchemas](definition) === false) {
59
+ // Keep the tool known to the SDK so a call answers `Tool <name> disabled` (no permission)
60
+ // rather than `not found`. The request never lists nor runs it, so no schema is needed.
61
+ const unavailableResult = {
62
+ content: [
63
+ {
64
+ type: 'text',
65
+ text: `Tool "${name}" is not available in this request`
66
+ }
67
+ ],
68
+ isError: true
69
+ };
70
+ return createSafeCapabilityRegistration({
71
+ strapi,
72
+ capabilityType: 'Tool',
73
+ name,
74
+ createHandler: ()=>async ()=>unavailableResult,
75
+ createFallbackHandler: ()=>async ()=>unavailableResult,
76
+ createErrorResult: ()=>unavailableResult,
77
+ registerWithSdk: (safeHandler)=>mcpServer.registerTool(name, {
78
+ title,
79
+ description
80
+ }, safeHandler)
81
+ });
82
+ }
58
83
  // Bind the session ability and token owner into the handler context so handlers can enforce
59
84
  // field-level and entity-level permission checks and set creator fields.
60
85
  const context = {
@@ -127,10 +152,14 @@ class McpToolRegistry extends McpCapabilityRegistryBase {
127
152
  }), Object.defineProperty(this, _user, {
128
153
  writable: true,
129
154
  value: void 0
155
+ }), Object.defineProperty(this, _shouldResolveSchemas, {
156
+ writable: true,
157
+ value: void 0
130
158
  });
131
159
  _class_private_field_loose_base(this, _strapi)[_strapi] = ctx.strapi;
132
160
  _class_private_field_loose_base(this, _ability)[_ability] = ctx.ability;
133
161
  _class_private_field_loose_base(this, _user)[_user] = ctx.user;
162
+ _class_private_field_loose_base(this, _shouldResolveSchemas)[_shouldResolveSchemas] = ctx.shouldResolveSchemas ?? (()=>true);
134
163
  }
135
164
  }
136
165
 
@@ -1 +1 @@
1
- {"version":3,"file":"tool-registry.mjs","sources":["../../../src/services/mcp/tool-registry.ts"],"sourcesContent":["import type { McpServer, RegisteredTool, ServerContext } from '@modelcontextprotocol/server';\nimport type { Core, Modules } from '@strapi/types';\nimport { McpCapabilityDefinitionRegistry } from './internal/McpCapabilityDefinitionRegistry';\nimport {\n type McpCapabilityRegistry,\n McpCapabilityRegistryBase,\n} from './internal/McpCapabilityRegistry';\nimport { wrapCapabilityHandlerForMetrics } from './metrics/wrapCapabilityHandlerForMetrics';\nimport { createSafeCapabilityRegistration } from './utils/createSafeCapabilityRegistration';\nimport { createMcpCapabilityHandlerContext } from './utils/createMcpCapabilityHandlerContext';\nimport { toSdkToolResult } from './utils/toSdkMcpCapabilityResult';\nimport type { McpAdminTokenAbility } from './authentication';\n\n/**\n * Defines a Strapi MCP tool with full type inference, ready to pass to\n * `strapi.ai.mcp.registerTool()`. Exposed publicly as `ai.mcp.defineTool`.\n *\n * The returned value is the definition unchanged — this builder only exists to\n * infer the `name`, input/output schemas and handler types, and to narrow the\n * access variant (`devModeOnly` vs `auth`) so the result is directly assignable\n * to `registerTool`.\n *\n * @param tool - The tool definition. Provide either `devModeOnly: true` (dev-only,\n * no auth) or an `auth` policy set — never both.\n * @returns The same definition, with its access variant narrowed.\n *\n * @example\n * ```ts\n * import { ai } from '@strapi/strapi';\n * import { z } from '@strapi/utils';\n *\n * const greet = ai.mcp.defineTool({\n * name: 'greet',\n * title: 'Greet',\n * description: 'Greets a user by name',\n * devModeOnly: true,\n * resolveInputSchema: () => z.object({ name: z.string() }),\n * resolveOutputSchema: () => z.object({ message: z.string() }),\n * createHandler: (strapi) => async ({ args }) => {\n * const message = `Hello, ${args.name}!`;\n * return { content: [{ type: 'text', text: message }], structuredContent: { message } };\n * },\n * });\n *\n * // later, in register() or bootstrap():\n * strapi.ai.mcp.registerTool(greet);\n * ```\n */\nexport const makeMcpToolDefinition = ((definition: Modules.MCP.McpToolDefinition) =>\n definition) as unknown as Modules.MCP.McpToolBuilder;\n\nexport class McpToolRegistry\n extends McpCapabilityRegistryBase<'tool', Modules.MCP.McpToolDefinition, RegisteredTool>\n implements McpCapabilityRegistry\n{\n #strapi: Core.Strapi;\n\n #ability: McpAdminTokenAbility;\n\n #user: Modules.MCP.McpHandlerContext['user'];\n\n constructor(ctx: {\n strapi: Core.Strapi;\n definitions: McpCapabilityDefinitionRegistry<'tool', Modules.MCP.McpToolDefinition>;\n ability: McpAdminTokenAbility;\n user: Modules.MCP.McpHandlerContext['user'];\n }) {\n super(ctx.definitions);\n this.#strapi = ctx.strapi;\n this.#ability = ctx.ability;\n this.#user = ctx.user;\n }\n\n bind(mcpServer: McpServer) {\n const strapi = this.#strapi;\n\n super.register((definition) => {\n const { name, title, description, resolveInputSchema, resolveOutputSchema, createHandler } =\n definition;\n\n // Bind the session ability and token owner into the handler context so handlers can enforce\n // field-level and entity-level permission checks and set creator fields.\n const context: Modules.MCP.McpHandlerContext = {\n userAbility: this.#ability,\n user: this.#user,\n };\n const createHandlerWithContext = (strapi: Core.Strapi) => createHandler(strapi, context);\n\n return createSafeCapabilityRegistration({\n strapi,\n capabilityType: 'Tool',\n name,\n createHandler: createHandlerWithContext,\n createFallbackHandler(errorMessage) {\n return async () => ({\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" failed to initialize: ${errorMessage}`,\n },\n ],\n isError: true,\n });\n },\n createErrorResult(error) {\n return {\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" execution failed: ${error.message}`,\n },\n ],\n isError: true,\n };\n },\n registerWithSdk(safeHandler) {\n const inputSchema =\n resolveInputSchema !== undefined ? resolveInputSchema(context) : undefined;\n const outputSchema = resolveOutputSchema(context);\n\n if (inputSchema !== undefined) {\n // Adapt from Strapi's object parameter to the SDK's positional callback.\n const sdkHandler = wrapCapabilityHandlerForMetrics(\n strapi,\n 'tool',\n name,\n definition.telemetry,\n async (args: unknown, context: ServerContext) =>\n toSdkToolResult(\n await safeHandler({\n args,\n extra: createMcpCapabilityHandlerContext(context),\n } as Parameters<typeof safeHandler>[0])\n )\n );\n\n return mcpServer.registerTool(\n name,\n { title, description, inputSchema, outputSchema },\n sdkHandler\n );\n }\n\n const sdkHandler = wrapCapabilityHandlerForMetrics(\n strapi,\n 'tool',\n name,\n definition.telemetry,\n async (context: ServerContext) =>\n toSdkToolResult(\n await safeHandler({\n extra: createMcpCapabilityHandlerContext(context),\n } as Parameters<typeof safeHandler>[0])\n )\n );\n\n return mcpServer.registerTool(name, { title, description, outputSchema }, sdkHandler);\n },\n });\n });\n }\n}\n"],"names":["makeMcpToolDefinition","definition","McpToolRegistry","McpCapabilityRegistryBase","bind","mcpServer","strapi","register","name","title","description","resolveInputSchema","resolveOutputSchema","createHandler","context","userAbility","user","createHandlerWithContext","createSafeCapabilityRegistration","capabilityType","createFallbackHandler","errorMessage","content","type","text","isError","createErrorResult","error","message","registerWithSdk","safeHandler","inputSchema","undefined","outputSchema","sdkHandler","wrapCapabilityHandlerForMetrics","telemetry","args","toSdkToolResult","extra","createMcpCapabilityHandlerContext","registerTool","ctx","definitions","ability"],"mappings":";;;;;;;;;;;;;;;;AAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCC,IACM,MAAMA,qBAAAA,GAAyB,CAACC,aACrCA;AAMA,IAAA,OAAA,iBAAA,8BAAA,CAAA,SAAA,CAAA,EAEA,QAAA,iBAAA,8BAAA,CAAA,UAAA,CAAA,EAEA,KAAA,iBAAA,8BAAA,CAAA,OAAA,CAAA;AARK,MAAMC,eAAAA,SACHC,yBAAAA,CAAAA;AAqBRC,IAAAA,IAAAA,CAAKC,SAAoB,EAAE;AACzB,QAAA,MAAMC,MAAAA,GAAS,+BAAA,CAAA,IAAI,EAAC,OAAA,CAAA,CAAA,OAAA,CAAA;QAEpB,KAAK,CAACC,SAAS,CAACN,UAAAA,GAAAA;AACd,YAAA,MAAM,EAAEO,IAAI,EAAEC,KAAK,EAAEC,WAAW,EAAEC,kBAAkB,EAAEC,mBAAmB,EAAEC,aAAa,EAAE,GACxFZ,UAAAA;;;AAIF,YAAA,MAAMa,OAAAA,GAAyC;AAC7CC,gBAAAA,WAAW,EAAE,+BAAA,CAAA,IAAI,EAAC,QAAA,CAAA,CAAA,QAAA,CAAA;AAClBC,gBAAAA,IAAI,EAAE,+BAAA,CAAA,IAAI,EAAC,KAAA,CAAA,CAAA,KAAA;AACb,aAAA;AACA,YAAA,MAAMC,wBAAAA,GAA2B,CAACX,MAAAA,GAAwBO,aAAAA,CAAcP,MAAAA,EAAQQ,OAAAA,CAAAA;AAEhF,YAAA,OAAOI,gCAAAA,CAAiC;AACtCZ,gBAAAA,MAAAA;gBACAa,cAAAA,EAAgB,MAAA;AAChBX,gBAAAA,IAAAA;gBACAK,aAAAA,EAAeI,wBAAAA;AACfG,gBAAAA,qBAAAA,CAAAA,CAAsBC,YAAY,EAAA;AAChC,oBAAA,OAAO,WAAa;4BAClBC,OAAAA,EAAS;AACP,gCAAA;oCACEC,IAAAA,EAAM,MAAA;AACNC,oCAAAA,IAAAA,EAAM,CAAC,MAAM,EAAEhB,IAAAA,CAAK,wBAAwB,EAAEa,YAAAA,CAAAA;AAChD;AACD,6BAAA;4BACDI,OAAAA,EAAS;yBACX,CAAA;AACF,gBAAA,CAAA;AACAC,gBAAAA,iBAAAA,CAAAA,CAAkBC,KAAK,EAAA;oBACrB,OAAO;wBACLL,OAAAA,EAAS;AACP,4BAAA;gCACEC,IAAAA,EAAM,MAAA;gCACNC,IAAAA,EAAM,CAAC,MAAM,EAAEhB,IAAAA,CAAK,oBAAoB,EAAEmB,KAAAA,CAAMC,OAAO,CAAA;AACzD;AACD,yBAAA;wBACDH,OAAAA,EAAS;AACX,qBAAA;AACF,gBAAA,CAAA;AACAI,gBAAAA,eAAAA,CAAAA,CAAgBC,WAAW,EAAA;AACzB,oBAAA,MAAMC,WAAAA,GACJpB,kBAAAA,KAAuBqB,SAAAA,GAAYrB,kBAAAA,CAAmBG,OAAAA,CAAAA,GAAWkB,SAAAA;AACnE,oBAAA,MAAMC,eAAerB,mBAAAA,CAAoBE,OAAAA,CAAAA;AAEzC,oBAAA,IAAIiB,gBAAgBC,SAAAA,EAAW;;AAE7B,wBAAA,MAAME,UAAAA,GAAaC,+BAAAA,CACjB7B,MAAAA,EACA,MAAA,EACAE,IAAAA,EACAP,UAAAA,CAAWmC,SAAS,EACpB,OAAOC,IAAAA,EAAevB,OAAAA,GACpBwB,eAAAA,CACE,MAAMR,WAAAA,CAAY;AAChBO,gCAAAA,IAAAA;AACAE,gCAAAA,KAAAA,EAAOC,iCAAAA,CAAkC1B,OAAAA;AAC3C,6BAAA,CAAA,CAAA,CAAA;wBAIN,OAAOT,SAAAA,CAAUoC,YAAY,CAC3BjC,IAAAA,EACA;AAAEC,4BAAAA,KAAAA;AAAOC,4BAAAA,WAAAA;AAAaqB,4BAAAA,WAAAA;AAAaE,4BAAAA;yBAAa,EAChDC,UAAAA,CAAAA;AAEJ,oBAAA;AAEA,oBAAA,MAAMA,UAAAA,GAAaC,+BAAAA,CACjB7B,MAAAA,EACA,MAAA,EACAE,IAAAA,EACAP,UAAAA,CAAWmC,SAAS,EACpB,OAAOtB,OAAAA,GACLwB,eAAAA,CACE,MAAMR,WAAAA,CAAY;AAChBS,4BAAAA,KAAAA,EAAOC,iCAAAA,CAAkC1B,OAAAA;AAC3C,yBAAA,CAAA,CAAA,CAAA;oBAIN,OAAOT,SAAAA,CAAUoC,YAAY,CAACjC,IAAAA,EAAM;AAAEC,wBAAAA,KAAAA;AAAOC,wBAAAA,WAAAA;AAAauB,wBAAAA;qBAAa,EAAGC,UAAAA,CAAAA;AAC5E,gBAAA;AACF,aAAA,CAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;AAnGA,IAAA,WAAA,CAAYQ,GAKX,CAAE;AACD,QAAA,KAAK,CAACA,GAAAA,CAAIC,WAAW,CAAA,EAZvB,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,OAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,QAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,KAAA,EAAA;;mBAAA;;AASE,QAAA,+BAAA,CAAA,IAAI,EAAC,OAAA,CAAA,CAAA,OAAA,CAAA,GAAUD,IAAIpC,MAAM;AACzB,QAAA,+BAAA,CAAA,IAAI,EAAC,QAAA,CAAA,CAAA,QAAA,CAAA,GAAWoC,IAAIE,OAAO;AAC3B,QAAA,+BAAA,CAAA,IAAI,EAAC,KAAA,CAAA,CAAA,KAAA,CAAA,GAAQF,IAAI1B,IAAI;AACvB,IAAA;AA0FF;;;;"}
1
+ {"version":3,"file":"tool-registry.mjs","sources":["../../../src/services/mcp/tool-registry.ts"],"sourcesContent":["import type { McpServer, RegisteredTool, ServerContext } from '@modelcontextprotocol/server';\nimport type { Core, Modules } from '@strapi/types';\nimport { McpCapabilityDefinitionRegistry } from './internal/McpCapabilityDefinitionRegistry';\nimport {\n type McpCapabilityRegistry,\n McpCapabilityRegistryBase,\n} from './internal/McpCapabilityRegistry';\nimport { wrapCapabilityHandlerForMetrics } from './metrics/wrapCapabilityHandlerForMetrics';\nimport { createSafeCapabilityRegistration } from './utils/createSafeCapabilityRegistration';\nimport { createMcpCapabilityHandlerContext } from './utils/createMcpCapabilityHandlerContext';\nimport { toSdkToolResult } from './utils/toSdkMcpCapabilityResult';\nimport type { McpAdminTokenAbility } from './authentication';\n\n/**\n * Defines a Strapi MCP tool with full type inference, ready to pass to\n * `strapi.ai.mcp.registerTool()`. Exposed publicly as `ai.mcp.defineTool`.\n *\n * The returned value is the definition unchanged — this builder only exists to\n * infer the `name`, input/output schemas and handler types, and to narrow the\n * access variant (`devModeOnly` vs `auth`) so the result is directly assignable\n * to `registerTool`.\n *\n * @param tool - The tool definition. Provide either `devModeOnly: true` (dev-only,\n * no auth) or an `auth` policy set — never both.\n * @returns The same definition, with its access variant narrowed.\n *\n * @example\n * ```ts\n * import { ai } from '@strapi/strapi';\n * import { z } from '@strapi/utils';\n *\n * const greet = ai.mcp.defineTool({\n * name: 'greet',\n * title: 'Greet',\n * description: 'Greets a user by name',\n * devModeOnly: true,\n * resolveInputSchema: () => z.object({ name: z.string() }),\n * resolveOutputSchema: () => z.object({ message: z.string() }),\n * createHandler: (strapi) => async ({ args }) => {\n * const message = `Hello, ${args.name}!`;\n * return { content: [{ type: 'text', text: message }], structuredContent: { message } };\n * },\n * });\n *\n * // later, in register() or bootstrap():\n * strapi.ai.mcp.registerTool(greet);\n * ```\n */\nexport const makeMcpToolDefinition = ((definition: Modules.MCP.McpToolDefinition) =>\n definition) as unknown as Modules.MCP.McpToolBuilder;\n\nexport class McpToolRegistry\n extends McpCapabilityRegistryBase<'tool', Modules.MCP.McpToolDefinition, RegisteredTool>\n implements McpCapabilityRegistry\n{\n #strapi: Core.Strapi;\n\n #ability: McpAdminTokenAbility;\n\n #user: Modules.MCP.McpHandlerContext['user'];\n\n #shouldResolveSchemas: (definition: Modules.MCP.McpToolDefinition) => boolean;\n\n constructor(ctx: {\n strapi: Core.Strapi;\n definitions: McpCapabilityDefinitionRegistry<'tool', Modules.MCP.McpToolDefinition>;\n ability: McpAdminTokenAbility;\n user: Modules.MCP.McpHandlerContext['user'];\n /**\n * Whether the current request needs this tool's schemas. Resolving them is the dominant\n * per-request cost, so tools the request never lists nor calls skip it. Defaults to every tool.\n */\n shouldResolveSchemas?: (definition: Modules.MCP.McpToolDefinition) => boolean;\n }) {\n super(ctx.definitions);\n this.#strapi = ctx.strapi;\n this.#ability = ctx.ability;\n this.#user = ctx.user;\n this.#shouldResolveSchemas = ctx.shouldResolveSchemas ?? (() => true);\n }\n\n bind(mcpServer: McpServer) {\n const strapi = this.#strapi;\n\n super.register((definition) => {\n const { name, title, description, resolveInputSchema, resolveOutputSchema, createHandler } =\n definition;\n\n if (this.#shouldResolveSchemas(definition) === false) {\n // Keep the tool known to the SDK so a call answers `Tool <name> disabled` (no permission)\n // rather than `not found`. The request never lists nor runs it, so no schema is needed.\n const unavailableResult = {\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" is not available in this request`,\n },\n ],\n isError: true,\n };\n\n return createSafeCapabilityRegistration({\n strapi,\n capabilityType: 'Tool',\n name,\n createHandler: () => async () => unavailableResult,\n createFallbackHandler: () => async () => unavailableResult,\n createErrorResult: () => unavailableResult,\n registerWithSdk: (safeHandler) =>\n mcpServer.registerTool(name, { title, description }, safeHandler),\n });\n }\n\n // Bind the session ability and token owner into the handler context so handlers can enforce\n // field-level and entity-level permission checks and set creator fields.\n const context: Modules.MCP.McpHandlerContext = {\n userAbility: this.#ability,\n user: this.#user,\n };\n const createHandlerWithContext = (strapi: Core.Strapi) => createHandler(strapi, context);\n\n return createSafeCapabilityRegistration({\n strapi,\n capabilityType: 'Tool',\n name,\n createHandler: createHandlerWithContext,\n createFallbackHandler(errorMessage) {\n return async () => ({\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" failed to initialize: ${errorMessage}`,\n },\n ],\n isError: true,\n });\n },\n createErrorResult(error) {\n return {\n content: [\n {\n type: 'text' as const,\n text: `Tool \"${name}\" execution failed: ${error.message}`,\n },\n ],\n isError: true,\n };\n },\n registerWithSdk(safeHandler) {\n const inputSchema =\n resolveInputSchema !== undefined ? resolveInputSchema(context) : undefined;\n const outputSchema = resolveOutputSchema(context);\n\n if (inputSchema !== undefined) {\n // Adapt from Strapi's object parameter to the SDK's positional callback.\n const sdkHandler = wrapCapabilityHandlerForMetrics(\n strapi,\n 'tool',\n name,\n definition.telemetry,\n async (args: unknown, context: ServerContext) =>\n toSdkToolResult(\n await safeHandler({\n args,\n extra: createMcpCapabilityHandlerContext(context),\n } as Parameters<typeof safeHandler>[0])\n )\n );\n\n return mcpServer.registerTool(\n name,\n { title, description, inputSchema, outputSchema },\n sdkHandler\n );\n }\n\n const sdkHandler = wrapCapabilityHandlerForMetrics(\n strapi,\n 'tool',\n name,\n definition.telemetry,\n async (context: ServerContext) =>\n toSdkToolResult(\n await safeHandler({\n extra: createMcpCapabilityHandlerContext(context),\n } as Parameters<typeof safeHandler>[0])\n )\n );\n\n return mcpServer.registerTool(name, { title, description, outputSchema }, sdkHandler);\n },\n });\n });\n }\n}\n"],"names":["makeMcpToolDefinition","definition","McpToolRegistry","McpCapabilityRegistryBase","bind","mcpServer","strapi","register","name","title","description","resolveInputSchema","resolveOutputSchema","createHandler","unavailableResult","content","type","text","isError","createSafeCapabilityRegistration","capabilityType","createFallbackHandler","createErrorResult","registerWithSdk","safeHandler","registerTool","context","userAbility","user","createHandlerWithContext","errorMessage","error","message","inputSchema","undefined","outputSchema","sdkHandler","wrapCapabilityHandlerForMetrics","telemetry","args","toSdkToolResult","extra","createMcpCapabilityHandlerContext","ctx","definitions","ability","shouldResolveSchemas"],"mappings":";;;;;;;;;;;;;;;;AAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCC,IACM,MAAMA,qBAAAA,GAAyB,CAACC,aACrCA;AAMA,IAAA,OAAA,iBAAA,8BAAA,CAAA,SAAA,CAAA,EAEA,qEAEA,KAAA,iBAAA,8BAAA,CAAA,OAAA,CAAA,EAEA,qBAAA,iBAAA,8BAAA,CAAA,uBAAA,CAAA;AAVK,MAAMC,eAAAA,SACHC,yBAAAA,CAAAA;AA6BRC,IAAAA,IAAAA,CAAKC,SAAoB,EAAE;AACzB,QAAA,MAAMC,MAAAA,GAAS,+BAAA,CAAA,IAAI,EAAC,OAAA,CAAA,CAAA,OAAA,CAAA;QAEpB,KAAK,CAACC,SAAS,CAACN,UAAAA,GAAAA;AACd,YAAA,MAAM,EAAEO,IAAI,EAAEC,KAAK,EAAEC,WAAW,EAAEC,kBAAkB,EAAEC,mBAAmB,EAAEC,aAAa,EAAE,GACxFZ,UAAAA;AAEF,YAAA,IAAI,gCAAA,IAAI,EAAC,qBAAA,CAAA,CAAA,qBAAA,CAAA,CAAsBA,gBAAgB,KAAA,EAAO;;;AAGpD,gBAAA,MAAMa,iBAAAA,GAAoB;oBACxBC,OAAAA,EAAS;AACP,wBAAA;4BACEC,IAAAA,EAAM,MAAA;AACNC,4BAAAA,IAAAA,EAAM,CAAC,MAAM,EAAET,IAAAA,CAAK,kCAAkC;AACxD;AACD,qBAAA;oBACDU,OAAAA,EAAS;AACX,iBAAA;AAEA,gBAAA,OAAOC,gCAAAA,CAAiC;AACtCb,oBAAAA,MAAAA;oBACAc,cAAAA,EAAgB,MAAA;AAChBZ,oBAAAA,IAAAA;AACAK,oBAAAA,aAAAA,EAAe,IAAM,UAAYC,iBAAAA;AACjCO,oBAAAA,qBAAAA,EAAuB,IAAM,UAAYP,iBAAAA;AACzCQ,oBAAAA,iBAAAA,EAAmB,IAAMR,iBAAAA;AACzBS,oBAAAA,eAAAA,EAAiB,CAACC,WAAAA,GAChBnB,SAAAA,CAAUoB,YAAY,CAACjB,IAAAA,EAAM;AAAEC,4BAAAA,KAAAA;AAAOC,4BAAAA;yBAAY,EAAGc,WAAAA;AACzD,iBAAA,CAAA;AACF,YAAA;;;AAIA,YAAA,MAAME,OAAAA,GAAyC;AAC7CC,gBAAAA,WAAW,EAAE,+BAAA,CAAA,IAAI,EAAC,QAAA,CAAA,CAAA,QAAA,CAAA;AAClBC,gBAAAA,IAAI,EAAE,+BAAA,CAAA,IAAI,EAAC,KAAA,CAAA,CAAA,KAAA;AACb,aAAA;AACA,YAAA,MAAMC,wBAAAA,GAA2B,CAACvB,MAAAA,GAAwBO,aAAAA,CAAcP,MAAAA,EAAQoB,OAAAA,CAAAA;AAEhF,YAAA,OAAOP,gCAAAA,CAAiC;AACtCb,gBAAAA,MAAAA;gBACAc,cAAAA,EAAgB,MAAA;AAChBZ,gBAAAA,IAAAA;gBACAK,aAAAA,EAAegB,wBAAAA;AACfR,gBAAAA,qBAAAA,CAAAA,CAAsBS,YAAY,EAAA;AAChC,oBAAA,OAAO,WAAa;4BAClBf,OAAAA,EAAS;AACP,gCAAA;oCACEC,IAAAA,EAAM,MAAA;AACNC,oCAAAA,IAAAA,EAAM,CAAC,MAAM,EAAET,IAAAA,CAAK,wBAAwB,EAAEsB,YAAAA,CAAAA;AAChD;AACD,6BAAA;4BACDZ,OAAAA,EAAS;yBACX,CAAA;AACF,gBAAA,CAAA;AACAI,gBAAAA,iBAAAA,CAAAA,CAAkBS,KAAK,EAAA;oBACrB,OAAO;wBACLhB,OAAAA,EAAS;AACP,4BAAA;gCACEC,IAAAA,EAAM,MAAA;gCACNC,IAAAA,EAAM,CAAC,MAAM,EAAET,IAAAA,CAAK,oBAAoB,EAAEuB,KAAAA,CAAMC,OAAO,CAAA;AACzD;AACD,yBAAA;wBACDd,OAAAA,EAAS;AACX,qBAAA;AACF,gBAAA,CAAA;AACAK,gBAAAA,eAAAA,CAAAA,CAAgBC,WAAW,EAAA;AACzB,oBAAA,MAAMS,WAAAA,GACJtB,kBAAAA,KAAuBuB,SAAAA,GAAYvB,kBAAAA,CAAmBe,OAAAA,CAAAA,GAAWQ,SAAAA;AACnE,oBAAA,MAAMC,eAAevB,mBAAAA,CAAoBc,OAAAA,CAAAA;AAEzC,oBAAA,IAAIO,gBAAgBC,SAAAA,EAAW;;AAE7B,wBAAA,MAAME,UAAAA,GAAaC,+BAAAA,CACjB/B,MAAAA,EACA,MAAA,EACAE,IAAAA,EACAP,UAAAA,CAAWqC,SAAS,EACpB,OAAOC,IAAAA,EAAeb,OAAAA,GACpBc,eAAAA,CACE,MAAMhB,WAAAA,CAAY;AAChBe,gCAAAA,IAAAA;AACAE,gCAAAA,KAAAA,EAAOC,iCAAAA,CAAkChB,OAAAA;AAC3C,6BAAA,CAAA,CAAA,CAAA;wBAIN,OAAOrB,SAAAA,CAAUoB,YAAY,CAC3BjB,IAAAA,EACA;AAAEC,4BAAAA,KAAAA;AAAOC,4BAAAA,WAAAA;AAAauB,4BAAAA,WAAAA;AAAaE,4BAAAA;yBAAa,EAChDC,UAAAA,CAAAA;AAEJ,oBAAA;AAEA,oBAAA,MAAMA,UAAAA,GAAaC,+BAAAA,CACjB/B,MAAAA,EACA,MAAA,EACAE,IAAAA,EACAP,UAAAA,CAAWqC,SAAS,EACpB,OAAOZ,OAAAA,GACLc,eAAAA,CACE,MAAMhB,WAAAA,CAAY;AAChBiB,4BAAAA,KAAAA,EAAOC,iCAAAA,CAAkChB,OAAAA;AAC3C,yBAAA,CAAA,CAAA,CAAA;oBAIN,OAAOrB,SAAAA,CAAUoB,YAAY,CAACjB,IAAAA,EAAM;AAAEC,wBAAAA,KAAAA;AAAOC,wBAAAA,WAAAA;AAAayB,wBAAAA;qBAAa,EAAGC,UAAAA,CAAAA;AAC5E,gBAAA;AACF,aAAA,CAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;AAlIA,IAAA,WAAA,CAAYO,GAUX,CAAE;AACD,QAAA,KAAK,CAACA,GAAAA,CAAIC,WAAW,CAAA,EAnBvB,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,OAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,QAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,KAAA,EAAA;;mBAAA;YAEA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,qBAAA,EAAA;;mBAAA;;AAcE,QAAA,+BAAA,CAAA,IAAI,EAAC,OAAA,CAAA,CAAA,OAAA,CAAA,GAAUD,IAAIrC,MAAM;AACzB,QAAA,+BAAA,CAAA,IAAI,EAAC,QAAA,CAAA,CAAA,QAAA,CAAA,GAAWqC,IAAIE,OAAO;AAC3B,QAAA,+BAAA,CAAA,IAAI,EAAC,KAAA,CAAA,CAAA,KAAA,CAAA,GAAQF,IAAIf,IAAI;QACrB,+BAAA,CAAA,IAAI,EAAC,qBAAA,CAAA,CAAA,qBAAA,CAAA,GAAwBe,IAAIG,oBAAoB,KAAK,IAAM,IAAG,CAAA;AACrE,IAAA;AAmHF;;;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"webhook-runner.d.ts","sourceRoot":"","sources":["../../src/services/webhook-runner.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,KAAK,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC;AAM5C,UAAU,qBAAqB;IAC7B,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC;CACd;AAED,UAAU,KAAK;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAUD,cAAM,aAAa;IACjB,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,WAAW,CAAqC;IAExD,OAAO,CAAC,SAAS,CAAoC;IAErD,OAAO,CAAC,KAAK,CAA2B;IAExC,OAAO,CAAC,KAAK,CAAQ;gBAET,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAkB,EAAE,KAAK,EAAE,EAAE,qBAAqB;IAmBlF,cAAc,CAAC,KAAK,EAAE,MAAM;IAW5B,cAAc,CAAC,KAAK,EAAE,MAAM;IAgBtB,eAAe,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK;IAa5C,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,KAAK;;;;;;;;;;IAsC9C,GAAG,CAAC,OAAO,EAAE,OAAO;IAcpB,MAAM,CAAC,OAAO,EAAE,OAAO;IAMvB,MAAM,CAAC,OAAO,EAAE,OAAO;CAexB;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,IAAI,EAAE,qBAAqB,GAAG,aAAa,CAEtF;AAED,YAAY,EAAE,aAAa,EAAE,CAAC"}
1
+ {"version":3,"file":"webhook-runner.d.ts","sourceRoot":"","sources":["../../src/services/webhook-runner.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,KAAK,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC;AAM5C,UAAU,qBAAqB;IAC7B,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC;CACd;AAED,UAAU,KAAK;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAoCD,cAAM,aAAa;IACjB,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,WAAW,CAAqC;IAExD,OAAO,CAAC,SAAS,CAAoC;IAErD,OAAO,CAAC,KAAK,CAA2B;IAExC,OAAO,CAAC,KAAK,CAAQ;gBAET,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAkB,EAAE,KAAK,EAAE,EAAE,qBAAqB;IAmBlF,cAAc,CAAC,KAAK,EAAE,MAAM;IAW5B,cAAc,CAAC,KAAK,EAAE,MAAM;IAgBtB,eAAe,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK;IAe5C,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,KAAK;;;;;;;;;;IAsC9C,GAAG,CAAC,OAAO,EAAE,OAAO;IAYpB,MAAM,CAAC,OAAO,EAAE,OAAO;IAMvB,MAAM,CAAC,OAAO,EAAE,OAAO;CAexB;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,IAAI,EAAE,qBAAqB,GAAG,aAAa,CAEtF;AAED,YAAY,EAAE,aAAa,EAAE,CAAC"}
@@ -13,6 +13,27 @@ const debug = createDebug__default.default('strapi:webhook');
13
13
  const defaultConfiguration = {
14
14
  defaultHeaders: {}
15
15
  };
16
+ /**
17
+ * Every event the webhook has to listen to, including the ones it only sends for some content types.
18
+ */ const getEvents = ({ events, contentTypeEvents = {} })=>{
19
+ return [
20
+ ...new Set([
21
+ ...events,
22
+ ...Object.values(contentTypeEvents).flat()
23
+ ])
24
+ ];
25
+ };
26
+ /**
27
+ * A webhook is triggered by the events it listens to for every content type,
28
+ * and by the events it listens to for the content type the event is about.
29
+ */ const isTriggeredBy = (webhook, event, info)=>{
30
+ const { events, contentTypeEvents = {} } = webhook;
31
+ const uid = info?.uid;
32
+ if (events.includes(event)) {
33
+ return true;
34
+ }
35
+ return typeof uid === 'string' && Object.hasOwn(contentTypeEvents, uid) && contentTypeEvents[uid].includes(event);
36
+ };
16
37
  class WebhookRunner {
17
38
  deleteListener(event) {
18
39
  debug(`Deleting listener for event '${event}'`);
@@ -39,7 +60,7 @@ class WebhookRunner {
39
60
  async executeListener({ event, info }) {
40
61
  debug(`Executing webhook for event '${event}'`);
41
62
  const webhooks = this.webhooksMap.get(event) || [];
42
- const activeWebhooks = webhooks.filter((webhook)=>webhook.isEnabled === true);
63
+ const activeWebhooks = webhooks.filter((webhook)=>webhook.isEnabled === true && isTriggeredBy(webhook, event, info));
43
64
  for (const webhook of activeWebhooks){
44
65
  await this.run(webhook, event, info).catch((error)=>{
45
66
  this.logger.error('Error running webhook');
@@ -82,8 +103,7 @@ class WebhookRunner {
82
103
  }
83
104
  add(webhook) {
84
105
  debug(`Registering webhook '${webhook.id}'`);
85
- const { events } = webhook;
86
- events.forEach((event)=>{
106
+ getEvents(webhook).forEach((event)=>{
87
107
  if (this.webhooksMap.has(event)) {
88
108
  this.webhooksMap.get(event)?.push(webhook);
89
109
  } else {
@@ -1 +1 @@
1
- {"version":3,"file":"webhook-runner.js","sources":["../../src/services/webhook-runner.ts"],"sourcesContent":["/**\n * The event hub is Strapi's event control center.\n */\n\nimport createdDebugger from 'debug';\nimport _ from 'lodash';\nimport type { Logger } from '@strapi/logger';\n\nimport type { Modules } from '@strapi/types';\nimport WorkerQueue from './worker-queue';\nimport type { EventHub } from './event-hub';\nimport type { Fetch } from '../utils/fetch';\n\ntype Webhook = Modules.WebhookStore.Webhook;\n\ninterface Config {\n defaultHeaders: Record<string, string>;\n}\n\ninterface ConstructorParameters {\n eventHub: EventHub;\n logger: Logger;\n configuration?: Record<string, unknown>;\n fetch: Fetch;\n}\n\ninterface Event {\n event: string;\n info: Record<string, unknown>;\n}\n\ntype Listener = (info: Record<string, unknown>) => Promise<void>;\n\nconst debug = createdDebugger('strapi:webhook');\n\nconst defaultConfiguration: Config = {\n defaultHeaders: {},\n};\n\nclass WebhookRunner {\n private eventHub: EventHub;\n\n private logger: Logger;\n\n private config: Config;\n\n private webhooksMap: Map<string, Webhook[]> = new Map();\n\n private listeners: Map<string, Listener> = new Map();\n\n private queue: WorkerQueue<Event, void>;\n\n private fetch: Fetch;\n\n constructor({ eventHub, logger, configuration = {}, fetch }: ConstructorParameters) {\n debug('Initialized webhook runner');\n this.eventHub = eventHub;\n this.logger = logger;\n this.fetch = fetch;\n\n if (typeof configuration !== 'object') {\n throw new Error(\n 'Invalid configuration provided to the webhookRunner.\\nCheck your server.json -> webhooks configuration'\n );\n }\n\n this.config = _.merge(defaultConfiguration, configuration);\n\n this.queue = new WorkerQueue({ logger, concurrency: 5 });\n\n this.queue.subscribe(this.executeListener.bind(this));\n }\n\n deleteListener(event: string) {\n debug(`Deleting listener for event '${event}'`);\n\n const fn = this.listeners.get(event);\n\n if (fn !== undefined) {\n this.eventHub.off(event, fn);\n this.listeners.delete(event);\n }\n }\n\n createListener(event: string) {\n debug(`Creating listener for event '${event}'`);\n if (this.listeners.has(event)) {\n this.logger.error(\n `The webhook runner is already listening for the event '${event}'. Did you mean to call .register() ?`\n );\n }\n\n const listen = async (info: Event['info']) => {\n this.queue.enqueue({ event, info });\n };\n\n this.listeners.set(event, listen);\n this.eventHub.on(event, listen);\n }\n\n async executeListener({ event, info }: Event) {\n debug(`Executing webhook for event '${event}'`);\n const webhooks = this.webhooksMap.get(event) || [];\n const activeWebhooks = webhooks.filter((webhook) => webhook.isEnabled === true);\n\n for (const webhook of activeWebhooks) {\n await this.run(webhook, event, info).catch((error: unknown) => {\n this.logger.error('Error running webhook');\n this.logger.error(error);\n });\n }\n }\n\n run(webhook: Webhook, event: string, info = {}) {\n const { url, headers } = webhook;\n\n return this.fetch(url, {\n method: 'post',\n body: JSON.stringify({\n event,\n createdAt: new Date(),\n ...info,\n }),\n headers: {\n ...this.config.defaultHeaders,\n ...headers,\n 'X-Strapi-Event': event,\n 'Content-Type': 'application/json',\n },\n signal: AbortSignal.timeout(10000),\n })\n .then(async (res) => {\n if (res.ok) {\n return {\n statusCode: res.status,\n };\n }\n\n return {\n statusCode: res.status,\n message: await res.text(),\n };\n })\n .catch((err) => {\n return {\n statusCode: 500,\n message: err.message,\n };\n });\n }\n\n add(webhook: Webhook) {\n debug(`Registering webhook '${webhook.id}'`);\n const { events } = webhook;\n\n events.forEach((event) => {\n if (this.webhooksMap.has(event)) {\n this.webhooksMap.get(event)?.push(webhook);\n } else {\n this.webhooksMap.set(event, [webhook]);\n this.createListener(event);\n }\n });\n }\n\n update(webhook: Webhook) {\n debug(`Refreshing webhook '${webhook.id}'`);\n this.remove(webhook);\n this.add(webhook);\n }\n\n remove(webhook: Webhook) {\n debug(`Unregistering webhook '${webhook.id}'`);\n\n this.webhooksMap.forEach((webhooks, event) => {\n const filteredWebhooks = webhooks.filter((value) => value.id !== webhook.id);\n\n // Cleanup hanging listeners\n if (filteredWebhooks.length === 0) {\n this.webhooksMap.delete(event);\n this.deleteListener(event);\n } else {\n this.webhooksMap.set(event, filteredWebhooks);\n }\n });\n }\n}\n\n/**\n * Expose a factory function instead of the class\n */\nexport default function createWebhookRunner(opts: ConstructorParameters): WebhookRunner {\n return new WebhookRunner(opts);\n}\n\nexport type { WebhookRunner };\n"],"names":["debug","createdDebugger","defaultConfiguration","defaultHeaders","WebhookRunner","deleteListener","event","fn","listeners","get","undefined","eventHub","off","delete","createListener","has","logger","error","listen","info","queue","enqueue","set","on","executeListener","webhooks","webhooksMap","activeWebhooks","filter","webhook","isEnabled","run","catch","url","headers","fetch","method","body","JSON","stringify","createdAt","Date","config","signal","AbortSignal","timeout","then","res","ok","statusCode","status","message","text","err","add","id","events","forEach","push","update","remove","filteredWebhooks","value","length","configuration","Map","Error","_","merge","WorkerQueue","concurrency","subscribe","bind","createWebhookRunner","opts"],"mappings":";;;;;;;;;;;AAiCA,MAAMA,QAAQC,4BAAAA,CAAgB,gBAAA,CAAA;AAE9B,MAAMC,oBAAAA,GAA+B;AACnCC,IAAAA,cAAAA,EAAgB;AAClB,CAAA;AAEA,MAAMC,aAAAA,CAAAA;AAkCJC,IAAAA,cAAAA,CAAeC,KAAa,EAAE;AAC5BN,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEM,KAAAA,CAAM,CAAC,CAAC,CAAA;AAE9C,QAAA,MAAMC,KAAK,IAAI,CAACC,SAAS,CAACC,GAAG,CAACH,KAAAA,CAAAA;AAE9B,QAAA,IAAIC,OAAOG,SAAAA,EAAW;AACpB,YAAA,IAAI,CAACC,QAAQ,CAACC,GAAG,CAACN,KAAAA,EAAOC,EAAAA,CAAAA;AACzB,YAAA,IAAI,CAACC,SAAS,CAACK,MAAM,CAACP,KAAAA,CAAAA;AACxB,QAAA;AACF,IAAA;AAEAQ,IAAAA,cAAAA,CAAeR,KAAa,EAAE;AAC5BN,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEM,KAAAA,CAAM,CAAC,CAAC,CAAA;AAC9C,QAAA,IAAI,IAAI,CAACE,SAAS,CAACO,GAAG,CAACT,KAAAA,CAAAA,EAAQ;YAC7B,IAAI,CAACU,MAAM,CAACC,KAAK,CACf,CAAC,uDAAuD,EAAEX,KAAAA,CAAM,qCAAqC,CAAC,CAAA;AAE1G,QAAA;AAEA,QAAA,MAAMY,SAAS,OAAOC,IAAAA,GAAAA;AACpB,YAAA,IAAI,CAACC,KAAK,CAACC,OAAO,CAAC;AAAEf,gBAAAA,KAAAA;AAAOa,gBAAAA;AAAK,aAAA,CAAA;AACnC,QAAA,CAAA;AAEA,QAAA,IAAI,CAACX,SAAS,CAACc,GAAG,CAAChB,KAAAA,EAAOY,MAAAA,CAAAA;AAC1B,QAAA,IAAI,CAACP,QAAQ,CAACY,EAAE,CAACjB,KAAAA,EAAOY,MAAAA,CAAAA;AAC1B,IAAA;AAEA,IAAA,MAAMM,gBAAgB,EAAElB,KAAK,EAAEa,IAAI,EAAS,EAAE;AAC5CnB,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEM,KAAAA,CAAM,CAAC,CAAC,CAAA;QAC9C,MAAMmB,QAAAA,GAAW,IAAI,CAACC,WAAW,CAACjB,GAAG,CAACH,UAAU,EAAE;QAClD,MAAMqB,cAAAA,GAAiBF,SAASG,MAAM,CAAC,CAACC,OAAAA,GAAYA,OAAAA,CAAQC,SAAS,KAAK,IAAA,CAAA;QAE1E,KAAK,MAAMD,WAAWF,cAAAA,CAAgB;YACpC,MAAM,IAAI,CAACI,GAAG,CAACF,SAASvB,KAAAA,EAAOa,IAAAA,CAAAA,CAAMa,KAAK,CAAC,CAACf,KAAAA,GAAAA;AAC1C,gBAAA,IAAI,CAACD,MAAM,CAACC,KAAK,CAAC,uBAAA,CAAA;AAClB,gBAAA,IAAI,CAACD,MAAM,CAACC,KAAK,CAACA,KAAAA,CAAAA;AACpB,YAAA,CAAA,CAAA;AACF,QAAA;AACF,IAAA;AAEAc,IAAAA,GAAAA,CAAIF,OAAgB,EAAEvB,KAAa,EAAEa,IAAAA,GAAO,EAAE,EAAE;AAC9C,QAAA,MAAM,EAAEc,GAAG,EAAEC,OAAO,EAAE,GAAGL,OAAAA;AAEzB,QAAA,OAAO,IAAI,CAACM,KAAK,CAACF,GAAAA,EAAK;YACrBG,MAAAA,EAAQ,MAAA;YACRC,IAAAA,EAAMC,IAAAA,CAAKC,SAAS,CAAC;AACnBjC,gBAAAA,KAAAA;AACAkC,gBAAAA,SAAAA,EAAW,IAAIC,IAAAA,EAAAA;AACf,gBAAA,GAAGtB;AACL,aAAA,CAAA;YACAe,OAAAA,EAAS;AACP,gBAAA,GAAG,IAAI,CAACQ,MAAM,CAACvC,cAAc;AAC7B,gBAAA,GAAG+B,OAAO;gBACV,gBAAA,EAAkB5B,KAAAA;gBAClB,cAAA,EAAgB;AAClB,aAAA;YACAqC,MAAAA,EAAQC,WAAAA,CAAYC,OAAO,CAAC,KAAA;SAC9B,CAAA,CACGC,IAAI,CAAC,OAAOC,GAAAA,GAAAA;YACX,IAAIA,GAAAA,CAAIC,EAAE,EAAE;gBACV,OAAO;AACLC,oBAAAA,UAAAA,EAAYF,IAAIG;AAClB,iBAAA;AACF,YAAA;YAEA,OAAO;AACLD,gBAAAA,UAAAA,EAAYF,IAAIG,MAAM;gBACtBC,OAAAA,EAAS,MAAMJ,IAAIK,IAAI;AACzB,aAAA;QACF,CAAA,CAAA,CACCpB,KAAK,CAAC,CAACqB,GAAAA,GAAAA;YACN,OAAO;gBACLJ,UAAAA,EAAY,GAAA;AACZE,gBAAAA,OAAAA,EAASE,IAAIF;AACf,aAAA;AACF,QAAA,CAAA,CAAA;AACJ,IAAA;AAEAG,IAAAA,GAAAA,CAAIzB,OAAgB,EAAE;AACpB7B,QAAAA,KAAAA,CAAM,CAAC,qBAAqB,EAAE6B,QAAQ0B,EAAE,CAAC,CAAC,CAAC,CAAA;QAC3C,MAAM,EAAEC,MAAM,EAAE,GAAG3B,OAAAA;QAEnB2B,MAAAA,CAAOC,OAAO,CAAC,CAACnD,KAAAA,GAAAA;AACd,YAAA,IAAI,IAAI,CAACoB,WAAW,CAACX,GAAG,CAACT,KAAAA,CAAAA,EAAQ;AAC/B,gBAAA,IAAI,CAACoB,WAAW,CAACjB,GAAG,CAACH,QAAQoD,IAAAA,CAAK7B,OAAAA,CAAAA;YACpC,CAAA,MAAO;AACL,gBAAA,IAAI,CAACH,WAAW,CAACJ,GAAG,CAAChB,KAAAA,EAAO;AAACuB,oBAAAA;AAAQ,iBAAA,CAAA;gBACrC,IAAI,CAACf,cAAc,CAACR,KAAAA,CAAAA;AACtB,YAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;AAEAqD,IAAAA,MAAAA,CAAO9B,OAAgB,EAAE;AACvB7B,QAAAA,KAAAA,CAAM,CAAC,oBAAoB,EAAE6B,QAAQ0B,EAAE,CAAC,CAAC,CAAC,CAAA;QAC1C,IAAI,CAACK,MAAM,CAAC/B,OAAAA,CAAAA;QACZ,IAAI,CAACyB,GAAG,CAACzB,OAAAA,CAAAA;AACX,IAAA;AAEA+B,IAAAA,MAAAA,CAAO/B,OAAgB,EAAE;AACvB7B,QAAAA,KAAAA,CAAM,CAAC,uBAAuB,EAAE6B,QAAQ0B,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7C,QAAA,IAAI,CAAC7B,WAAW,CAAC+B,OAAO,CAAC,CAAChC,QAAAA,EAAUnB,KAAAA,GAAAA;YAClC,MAAMuD,gBAAAA,GAAmBpC,QAAAA,CAASG,MAAM,CAAC,CAACkC,QAAUA,KAAAA,CAAMP,EAAE,KAAK1B,OAAAA,CAAQ0B,EAAE,CAAA;;YAG3E,IAAIM,gBAAAA,CAAiBE,MAAM,KAAK,CAAA,EAAG;AACjC,gBAAA,IAAI,CAACrC,WAAW,CAACb,MAAM,CAACP,KAAAA,CAAAA;gBACxB,IAAI,CAACD,cAAc,CAACC,KAAAA,CAAAA;YACtB,CAAA,MAAO;AACL,gBAAA,IAAI,CAACoB,WAAW,CAACJ,GAAG,CAAChB,KAAAA,EAAOuD,gBAAAA,CAAAA;AAC9B,YAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;IAnIA,WAAA,CAAY,EAAElD,QAAQ,EAAEK,MAAM,EAAEgD,aAAAA,GAAgB,EAAE,EAAE7B,KAAK,EAAyB,CAAE;AAR5ET,QAAAA,IAAAA,CAAAA,WAAAA,GAAsC,IAAIuC,GAAAA,EAAAA;AAE1CzD,QAAAA,IAAAA,CAAAA,SAAAA,GAAmC,IAAIyD,GAAAA,EAAAA;QAO7CjE,KAAAA,CAAM,4BAAA,CAAA;QACN,IAAI,CAACW,QAAQ,GAAGA,QAAAA;QAChB,IAAI,CAACK,MAAM,GAAGA,MAAAA;QACd,IAAI,CAACmB,KAAK,GAAGA,KAAAA;QAEb,IAAI,OAAO6B,kBAAkB,QAAA,EAAU;AACrC,YAAA,MAAM,IAAIE,KAAAA,CACR,wGAAA,CAAA;AAEJ,QAAA;AAEA,QAAA,IAAI,CAACxB,MAAM,GAAGyB,kBAAAA,CAAEC,KAAK,CAAClE,oBAAAA,EAAsB8D,aAAAA,CAAAA;AAE5C,QAAA,IAAI,CAAC5C,KAAK,GAAG,IAAIiD,WAAAA,CAAY;AAAErD,YAAAA,MAAAA;YAAQsD,WAAAA,EAAa;AAAE,SAAA,CAAA;QAEtD,IAAI,CAAClD,KAAK,CAACmD,SAAS,CAAC,IAAI,CAAC/C,eAAe,CAACgD,IAAI,CAAC,IAAI,CAAA,CAAA;AACrD,IAAA;AAmHF;AAEA;;IAGe,SAASC,mBAAAA,CAAoBC,IAA2B,EAAA;AACrE,IAAA,OAAO,IAAItE,aAAAA,CAAcsE,IAAAA,CAAAA;AAC3B;;;;"}
1
+ {"version":3,"file":"webhook-runner.js","sources":["../../src/services/webhook-runner.ts"],"sourcesContent":["/**\n * The event hub is Strapi's event control center.\n */\n\nimport createdDebugger from 'debug';\nimport _ from 'lodash';\nimport type { Logger } from '@strapi/logger';\n\nimport type { Modules } from '@strapi/types';\nimport WorkerQueue from './worker-queue';\nimport type { EventHub } from './event-hub';\nimport type { Fetch } from '../utils/fetch';\n\ntype Webhook = Modules.WebhookStore.Webhook;\n\ninterface Config {\n defaultHeaders: Record<string, string>;\n}\n\ninterface ConstructorParameters {\n eventHub: EventHub;\n logger: Logger;\n configuration?: Record<string, unknown>;\n fetch: Fetch;\n}\n\ninterface Event {\n event: string;\n info: Record<string, unknown>;\n}\n\ntype Listener = (info: Record<string, unknown>) => Promise<void>;\n\nconst debug = createdDebugger('strapi:webhook');\n\nconst defaultConfiguration: Config = {\n defaultHeaders: {},\n};\n\n/**\n * Every event the webhook has to listen to, including the ones it only sends for some content types.\n */\nconst getEvents = ({ events, contentTypeEvents = {} }: Webhook) => {\n return [...new Set([...events, ...Object.values(contentTypeEvents).flat()])];\n};\n\n/**\n * A webhook is triggered by the events it listens to for every content type,\n * and by the events it listens to for the content type the event is about.\n */\nconst isTriggeredBy = (webhook: Webhook, event: string, info?: Event['info']) => {\n const { events, contentTypeEvents = {} } = webhook;\n const uid = info?.uid;\n\n if (events.includes(event)) {\n return true;\n }\n\n return (\n typeof uid === 'string' &&\n Object.hasOwn(contentTypeEvents, uid) &&\n contentTypeEvents[uid].includes(event)\n );\n};\n\nclass WebhookRunner {\n private eventHub: EventHub;\n\n private logger: Logger;\n\n private config: Config;\n\n private webhooksMap: Map<string, Webhook[]> = new Map();\n\n private listeners: Map<string, Listener> = new Map();\n\n private queue: WorkerQueue<Event, void>;\n\n private fetch: Fetch;\n\n constructor({ eventHub, logger, configuration = {}, fetch }: ConstructorParameters) {\n debug('Initialized webhook runner');\n this.eventHub = eventHub;\n this.logger = logger;\n this.fetch = fetch;\n\n if (typeof configuration !== 'object') {\n throw new Error(\n 'Invalid configuration provided to the webhookRunner.\\nCheck your server.json -> webhooks configuration'\n );\n }\n\n this.config = _.merge(defaultConfiguration, configuration);\n\n this.queue = new WorkerQueue({ logger, concurrency: 5 });\n\n this.queue.subscribe(this.executeListener.bind(this));\n }\n\n deleteListener(event: string) {\n debug(`Deleting listener for event '${event}'`);\n\n const fn = this.listeners.get(event);\n\n if (fn !== undefined) {\n this.eventHub.off(event, fn);\n this.listeners.delete(event);\n }\n }\n\n createListener(event: string) {\n debug(`Creating listener for event '${event}'`);\n if (this.listeners.has(event)) {\n this.logger.error(\n `The webhook runner is already listening for the event '${event}'. Did you mean to call .register() ?`\n );\n }\n\n const listen = async (info: Event['info']) => {\n this.queue.enqueue({ event, info });\n };\n\n this.listeners.set(event, listen);\n this.eventHub.on(event, listen);\n }\n\n async executeListener({ event, info }: Event) {\n debug(`Executing webhook for event '${event}'`);\n const webhooks = this.webhooksMap.get(event) || [];\n const activeWebhooks = webhooks.filter(\n (webhook) => webhook.isEnabled === true && isTriggeredBy(webhook, event, info)\n );\n\n for (const webhook of activeWebhooks) {\n await this.run(webhook, event, info).catch((error: unknown) => {\n this.logger.error('Error running webhook');\n this.logger.error(error);\n });\n }\n }\n\n run(webhook: Webhook, event: string, info = {}) {\n const { url, headers } = webhook;\n\n return this.fetch(url, {\n method: 'post',\n body: JSON.stringify({\n event,\n createdAt: new Date(),\n ...info,\n }),\n headers: {\n ...this.config.defaultHeaders,\n ...headers,\n 'X-Strapi-Event': event,\n 'Content-Type': 'application/json',\n },\n signal: AbortSignal.timeout(10000),\n })\n .then(async (res) => {\n if (res.ok) {\n return {\n statusCode: res.status,\n };\n }\n\n return {\n statusCode: res.status,\n message: await res.text(),\n };\n })\n .catch((err) => {\n return {\n statusCode: 500,\n message: err.message,\n };\n });\n }\n\n add(webhook: Webhook) {\n debug(`Registering webhook '${webhook.id}'`);\n getEvents(webhook).forEach((event) => {\n if (this.webhooksMap.has(event)) {\n this.webhooksMap.get(event)?.push(webhook);\n } else {\n this.webhooksMap.set(event, [webhook]);\n this.createListener(event);\n }\n });\n }\n\n update(webhook: Webhook) {\n debug(`Refreshing webhook '${webhook.id}'`);\n this.remove(webhook);\n this.add(webhook);\n }\n\n remove(webhook: Webhook) {\n debug(`Unregistering webhook '${webhook.id}'`);\n\n this.webhooksMap.forEach((webhooks, event) => {\n const filteredWebhooks = webhooks.filter((value) => value.id !== webhook.id);\n\n // Cleanup hanging listeners\n if (filteredWebhooks.length === 0) {\n this.webhooksMap.delete(event);\n this.deleteListener(event);\n } else {\n this.webhooksMap.set(event, filteredWebhooks);\n }\n });\n }\n}\n\n/**\n * Expose a factory function instead of the class\n */\nexport default function createWebhookRunner(opts: ConstructorParameters): WebhookRunner {\n return new WebhookRunner(opts);\n}\n\nexport type { WebhookRunner };\n"],"names":["debug","createdDebugger","defaultConfiguration","defaultHeaders","getEvents","events","contentTypeEvents","Set","Object","values","flat","isTriggeredBy","webhook","event","info","uid","includes","hasOwn","WebhookRunner","deleteListener","fn","listeners","get","undefined","eventHub","off","delete","createListener","has","logger","error","listen","queue","enqueue","set","on","executeListener","webhooks","webhooksMap","activeWebhooks","filter","isEnabled","run","catch","url","headers","fetch","method","body","JSON","stringify","createdAt","Date","config","signal","AbortSignal","timeout","then","res","ok","statusCode","status","message","text","err","add","id","forEach","push","update","remove","filteredWebhooks","value","length","configuration","Map","Error","_","merge","WorkerQueue","concurrency","subscribe","bind","createWebhookRunner","opts"],"mappings":";;;;;;;;;;;AAiCA,MAAMA,QAAQC,4BAAAA,CAAgB,gBAAA,CAAA;AAE9B,MAAMC,oBAAAA,GAA+B;AACnCC,IAAAA,cAAAA,EAAgB;AAClB,CAAA;AAEA;;IAGA,MAAMC,YAAY,CAAC,EAAEC,MAAM,EAAEC,iBAAAA,GAAoB,EAAE,EAAW,GAAA;IAC5D,OAAO;AAAI,QAAA,GAAA,IAAIC,GAAAA,CAAI;AAAIF,YAAAA,GAAAA,MAAAA;eAAWG,MAAAA,CAAOC,MAAM,CAACH,iBAAAA,CAAAA,CAAmBI,IAAI;AAAG,SAAA;AAAE,KAAA;AAC9E,CAAA;AAEA;;;AAGC,IACD,MAAMC,aAAAA,GAAgB,CAACC,OAAAA,EAAkBC,KAAAA,EAAeC,IAAAA,GAAAA;AACtD,IAAA,MAAM,EAAET,MAAM,EAAEC,oBAAoB,EAAE,EAAE,GAAGM,OAAAA;AAC3C,IAAA,MAAMG,MAAMD,IAAAA,EAAMC,GAAAA;IAElB,IAAIV,MAAAA,CAAOW,QAAQ,CAACH,KAAAA,CAAAA,EAAQ;QAC1B,OAAO,IAAA;AACT,IAAA;AAEA,IAAA,OACE,OAAOE,GAAAA,KAAQ,QAAA,IACfP,MAAAA,CAAOS,MAAM,CAACX,iBAAAA,EAAmBS,GAAAA,CAAAA,IACjCT,iBAAiB,CAACS,GAAAA,CAAI,CAACC,QAAQ,CAACH,KAAAA,CAAAA;AAEpC,CAAA;AAEA,MAAMK,aAAAA,CAAAA;AAkCJC,IAAAA,cAAAA,CAAeN,KAAa,EAAE;AAC5Bb,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEa,KAAAA,CAAM,CAAC,CAAC,CAAA;AAE9C,QAAA,MAAMO,KAAK,IAAI,CAACC,SAAS,CAACC,GAAG,CAACT,KAAAA,CAAAA;AAE9B,QAAA,IAAIO,OAAOG,SAAAA,EAAW;AACpB,YAAA,IAAI,CAACC,QAAQ,CAACC,GAAG,CAACZ,KAAAA,EAAOO,EAAAA,CAAAA;AACzB,YAAA,IAAI,CAACC,SAAS,CAACK,MAAM,CAACb,KAAAA,CAAAA;AACxB,QAAA;AACF,IAAA;AAEAc,IAAAA,cAAAA,CAAed,KAAa,EAAE;AAC5Bb,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEa,KAAAA,CAAM,CAAC,CAAC,CAAA;AAC9C,QAAA,IAAI,IAAI,CAACQ,SAAS,CAACO,GAAG,CAACf,KAAAA,CAAAA,EAAQ;YAC7B,IAAI,CAACgB,MAAM,CAACC,KAAK,CACf,CAAC,uDAAuD,EAAEjB,KAAAA,CAAM,qCAAqC,CAAC,CAAA;AAE1G,QAAA;AAEA,QAAA,MAAMkB,SAAS,OAAOjB,IAAAA,GAAAA;AACpB,YAAA,IAAI,CAACkB,KAAK,CAACC,OAAO,CAAC;AAAEpB,gBAAAA,KAAAA;AAAOC,gBAAAA;AAAK,aAAA,CAAA;AACnC,QAAA,CAAA;AAEA,QAAA,IAAI,CAACO,SAAS,CAACa,GAAG,CAACrB,KAAAA,EAAOkB,MAAAA,CAAAA;AAC1B,QAAA,IAAI,CAACP,QAAQ,CAACW,EAAE,CAACtB,KAAAA,EAAOkB,MAAAA,CAAAA;AAC1B,IAAA;AAEA,IAAA,MAAMK,gBAAgB,EAAEvB,KAAK,EAAEC,IAAI,EAAS,EAAE;AAC5Cd,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEa,KAAAA,CAAM,CAAC,CAAC,CAAA;QAC9C,MAAMwB,QAAAA,GAAW,IAAI,CAACC,WAAW,CAAChB,GAAG,CAACT,UAAU,EAAE;AAClD,QAAA,MAAM0B,cAAAA,GAAiBF,QAAAA,CAASG,MAAM,CACpC,CAAC5B,OAAAA,GAAYA,OAAAA,CAAQ6B,SAAS,KAAK,IAAA,IAAQ9B,aAAAA,CAAcC,OAAAA,EAASC,KAAAA,EAAOC,IAAAA,CAAAA,CAAAA;QAG3E,KAAK,MAAMF,WAAW2B,cAAAA,CAAgB;YACpC,MAAM,IAAI,CAACG,GAAG,CAAC9B,SAASC,KAAAA,EAAOC,IAAAA,CAAAA,CAAM6B,KAAK,CAAC,CAACb,KAAAA,GAAAA;AAC1C,gBAAA,IAAI,CAACD,MAAM,CAACC,KAAK,CAAC,uBAAA,CAAA;AAClB,gBAAA,IAAI,CAACD,MAAM,CAACC,KAAK,CAACA,KAAAA,CAAAA;AACpB,YAAA,CAAA,CAAA;AACF,QAAA;AACF,IAAA;AAEAY,IAAAA,GAAAA,CAAI9B,OAAgB,EAAEC,KAAa,EAAEC,IAAAA,GAAO,EAAE,EAAE;AAC9C,QAAA,MAAM,EAAE8B,GAAG,EAAEC,OAAO,EAAE,GAAGjC,OAAAA;AAEzB,QAAA,OAAO,IAAI,CAACkC,KAAK,CAACF,GAAAA,EAAK;YACrBG,MAAAA,EAAQ,MAAA;YACRC,IAAAA,EAAMC,IAAAA,CAAKC,SAAS,CAAC;AACnBrC,gBAAAA,KAAAA;AACAsC,gBAAAA,SAAAA,EAAW,IAAIC,IAAAA,EAAAA;AACf,gBAAA,GAAGtC;AACL,aAAA,CAAA;YACA+B,OAAAA,EAAS;AACP,gBAAA,GAAG,IAAI,CAACQ,MAAM,CAAClD,cAAc;AAC7B,gBAAA,GAAG0C,OAAO;gBACV,gBAAA,EAAkBhC,KAAAA;gBAClB,cAAA,EAAgB;AAClB,aAAA;YACAyC,MAAAA,EAAQC,WAAAA,CAAYC,OAAO,CAAC,KAAA;SAC9B,CAAA,CACGC,IAAI,CAAC,OAAOC,GAAAA,GAAAA;YACX,IAAIA,GAAAA,CAAIC,EAAE,EAAE;gBACV,OAAO;AACLC,oBAAAA,UAAAA,EAAYF,IAAIG;AAClB,iBAAA;AACF,YAAA;YAEA,OAAO;AACLD,gBAAAA,UAAAA,EAAYF,IAAIG,MAAM;gBACtBC,OAAAA,EAAS,MAAMJ,IAAIK,IAAI;AACzB,aAAA;QACF,CAAA,CAAA,CACCpB,KAAK,CAAC,CAACqB,GAAAA,GAAAA;YACN,OAAO;gBACLJ,UAAAA,EAAY,GAAA;AACZE,gBAAAA,OAAAA,EAASE,IAAIF;AACf,aAAA;AACF,QAAA,CAAA,CAAA;AACJ,IAAA;AAEAG,IAAAA,GAAAA,CAAIrD,OAAgB,EAAE;AACpBZ,QAAAA,KAAAA,CAAM,CAAC,qBAAqB,EAAEY,QAAQsD,EAAE,CAAC,CAAC,CAAC,CAAA;QAC3C9D,SAAAA,CAAUQ,OAAAA,CAAAA,CAASuD,OAAO,CAAC,CAACtD,KAAAA,GAAAA;AAC1B,YAAA,IAAI,IAAI,CAACyB,WAAW,CAACV,GAAG,CAACf,KAAAA,CAAAA,EAAQ;AAC/B,gBAAA,IAAI,CAACyB,WAAW,CAAChB,GAAG,CAACT,QAAQuD,IAAAA,CAAKxD,OAAAA,CAAAA;YACpC,CAAA,MAAO;AACL,gBAAA,IAAI,CAAC0B,WAAW,CAACJ,GAAG,CAACrB,KAAAA,EAAO;AAACD,oBAAAA;AAAQ,iBAAA,CAAA;gBACrC,IAAI,CAACe,cAAc,CAACd,KAAAA,CAAAA;AACtB,YAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;AAEAwD,IAAAA,MAAAA,CAAOzD,OAAgB,EAAE;AACvBZ,QAAAA,KAAAA,CAAM,CAAC,oBAAoB,EAAEY,QAAQsD,EAAE,CAAC,CAAC,CAAC,CAAA;QAC1C,IAAI,CAACI,MAAM,CAAC1D,OAAAA,CAAAA;QACZ,IAAI,CAACqD,GAAG,CAACrD,OAAAA,CAAAA;AACX,IAAA;AAEA0D,IAAAA,MAAAA,CAAO1D,OAAgB,EAAE;AACvBZ,QAAAA,KAAAA,CAAM,CAAC,uBAAuB,EAAEY,QAAQsD,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7C,QAAA,IAAI,CAAC5B,WAAW,CAAC6B,OAAO,CAAC,CAAC9B,QAAAA,EAAUxB,KAAAA,GAAAA;YAClC,MAAM0D,gBAAAA,GAAmBlC,QAAAA,CAASG,MAAM,CAAC,CAACgC,QAAUA,KAAAA,CAAMN,EAAE,KAAKtD,OAAAA,CAAQsD,EAAE,CAAA;;YAG3E,IAAIK,gBAAAA,CAAiBE,MAAM,KAAK,CAAA,EAAG;AACjC,gBAAA,IAAI,CAACnC,WAAW,CAACZ,MAAM,CAACb,KAAAA,CAAAA;gBACxB,IAAI,CAACM,cAAc,CAACN,KAAAA,CAAAA;YACtB,CAAA,MAAO;AACL,gBAAA,IAAI,CAACyB,WAAW,CAACJ,GAAG,CAACrB,KAAAA,EAAO0D,gBAAAA,CAAAA;AAC9B,YAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;IAnIA,WAAA,CAAY,EAAE/C,QAAQ,EAAEK,MAAM,EAAE6C,aAAAA,GAAgB,EAAE,EAAE5B,KAAK,EAAyB,CAAE;AAR5ER,QAAAA,IAAAA,CAAAA,WAAAA,GAAsC,IAAIqC,GAAAA,EAAAA;AAE1CtD,QAAAA,IAAAA,CAAAA,SAAAA,GAAmC,IAAIsD,GAAAA,EAAAA;QAO7C3E,KAAAA,CAAM,4BAAA,CAAA;QACN,IAAI,CAACwB,QAAQ,GAAGA,QAAAA;QAChB,IAAI,CAACK,MAAM,GAAGA,MAAAA;QACd,IAAI,CAACiB,KAAK,GAAGA,KAAAA;QAEb,IAAI,OAAO4B,kBAAkB,QAAA,EAAU;AACrC,YAAA,MAAM,IAAIE,KAAAA,CACR,wGAAA,CAAA;AAEJ,QAAA;AAEA,QAAA,IAAI,CAACvB,MAAM,GAAGwB,kBAAAA,CAAEC,KAAK,CAAC5E,oBAAAA,EAAsBwE,aAAAA,CAAAA;AAE5C,QAAA,IAAI,CAAC1C,KAAK,GAAG,IAAI+C,WAAAA,CAAY;AAAElD,YAAAA,MAAAA;YAAQmD,WAAAA,EAAa;AAAE,SAAA,CAAA;QAEtD,IAAI,CAAChD,KAAK,CAACiD,SAAS,CAAC,IAAI,CAAC7C,eAAe,CAAC8C,IAAI,CAAC,IAAI,CAAA,CAAA;AACrD,IAAA;AAmHF;AAEA;;IAGe,SAASC,mBAAAA,CAAoBC,IAA2B,EAAA;AACrE,IAAA,OAAO,IAAIlE,aAAAA,CAAckE,IAAAA,CAAAA;AAC3B;;;;"}
@@ -6,6 +6,27 @@ const debug = createDebug('strapi:webhook');
6
6
  const defaultConfiguration = {
7
7
  defaultHeaders: {}
8
8
  };
9
+ /**
10
+ * Every event the webhook has to listen to, including the ones it only sends for some content types.
11
+ */ const getEvents = ({ events, contentTypeEvents = {} })=>{
12
+ return [
13
+ ...new Set([
14
+ ...events,
15
+ ...Object.values(contentTypeEvents).flat()
16
+ ])
17
+ ];
18
+ };
19
+ /**
20
+ * A webhook is triggered by the events it listens to for every content type,
21
+ * and by the events it listens to for the content type the event is about.
22
+ */ const isTriggeredBy = (webhook, event, info)=>{
23
+ const { events, contentTypeEvents = {} } = webhook;
24
+ const uid = info?.uid;
25
+ if (events.includes(event)) {
26
+ return true;
27
+ }
28
+ return typeof uid === 'string' && Object.hasOwn(contentTypeEvents, uid) && contentTypeEvents[uid].includes(event);
29
+ };
9
30
  class WebhookRunner {
10
31
  deleteListener(event) {
11
32
  debug(`Deleting listener for event '${event}'`);
@@ -32,7 +53,7 @@ class WebhookRunner {
32
53
  async executeListener({ event, info }) {
33
54
  debug(`Executing webhook for event '${event}'`);
34
55
  const webhooks = this.webhooksMap.get(event) || [];
35
- const activeWebhooks = webhooks.filter((webhook)=>webhook.isEnabled === true);
56
+ const activeWebhooks = webhooks.filter((webhook)=>webhook.isEnabled === true && isTriggeredBy(webhook, event, info));
36
57
  for (const webhook of activeWebhooks){
37
58
  await this.run(webhook, event, info).catch((error)=>{
38
59
  this.logger.error('Error running webhook');
@@ -75,8 +96,7 @@ class WebhookRunner {
75
96
  }
76
97
  add(webhook) {
77
98
  debug(`Registering webhook '${webhook.id}'`);
78
- const { events } = webhook;
79
- events.forEach((event)=>{
99
+ getEvents(webhook).forEach((event)=>{
80
100
  if (this.webhooksMap.has(event)) {
81
101
  this.webhooksMap.get(event)?.push(webhook);
82
102
  } else {
@@ -1 +1 @@
1
- {"version":3,"file":"webhook-runner.mjs","sources":["../../src/services/webhook-runner.ts"],"sourcesContent":["/**\n * The event hub is Strapi's event control center.\n */\n\nimport createdDebugger from 'debug';\nimport _ from 'lodash';\nimport type { Logger } from '@strapi/logger';\n\nimport type { Modules } from '@strapi/types';\nimport WorkerQueue from './worker-queue';\nimport type { EventHub } from './event-hub';\nimport type { Fetch } from '../utils/fetch';\n\ntype Webhook = Modules.WebhookStore.Webhook;\n\ninterface Config {\n defaultHeaders: Record<string, string>;\n}\n\ninterface ConstructorParameters {\n eventHub: EventHub;\n logger: Logger;\n configuration?: Record<string, unknown>;\n fetch: Fetch;\n}\n\ninterface Event {\n event: string;\n info: Record<string, unknown>;\n}\n\ntype Listener = (info: Record<string, unknown>) => Promise<void>;\n\nconst debug = createdDebugger('strapi:webhook');\n\nconst defaultConfiguration: Config = {\n defaultHeaders: {},\n};\n\nclass WebhookRunner {\n private eventHub: EventHub;\n\n private logger: Logger;\n\n private config: Config;\n\n private webhooksMap: Map<string, Webhook[]> = new Map();\n\n private listeners: Map<string, Listener> = new Map();\n\n private queue: WorkerQueue<Event, void>;\n\n private fetch: Fetch;\n\n constructor({ eventHub, logger, configuration = {}, fetch }: ConstructorParameters) {\n debug('Initialized webhook runner');\n this.eventHub = eventHub;\n this.logger = logger;\n this.fetch = fetch;\n\n if (typeof configuration !== 'object') {\n throw new Error(\n 'Invalid configuration provided to the webhookRunner.\\nCheck your server.json -> webhooks configuration'\n );\n }\n\n this.config = _.merge(defaultConfiguration, configuration);\n\n this.queue = new WorkerQueue({ logger, concurrency: 5 });\n\n this.queue.subscribe(this.executeListener.bind(this));\n }\n\n deleteListener(event: string) {\n debug(`Deleting listener for event '${event}'`);\n\n const fn = this.listeners.get(event);\n\n if (fn !== undefined) {\n this.eventHub.off(event, fn);\n this.listeners.delete(event);\n }\n }\n\n createListener(event: string) {\n debug(`Creating listener for event '${event}'`);\n if (this.listeners.has(event)) {\n this.logger.error(\n `The webhook runner is already listening for the event '${event}'. Did you mean to call .register() ?`\n );\n }\n\n const listen = async (info: Event['info']) => {\n this.queue.enqueue({ event, info });\n };\n\n this.listeners.set(event, listen);\n this.eventHub.on(event, listen);\n }\n\n async executeListener({ event, info }: Event) {\n debug(`Executing webhook for event '${event}'`);\n const webhooks = this.webhooksMap.get(event) || [];\n const activeWebhooks = webhooks.filter((webhook) => webhook.isEnabled === true);\n\n for (const webhook of activeWebhooks) {\n await this.run(webhook, event, info).catch((error: unknown) => {\n this.logger.error('Error running webhook');\n this.logger.error(error);\n });\n }\n }\n\n run(webhook: Webhook, event: string, info = {}) {\n const { url, headers } = webhook;\n\n return this.fetch(url, {\n method: 'post',\n body: JSON.stringify({\n event,\n createdAt: new Date(),\n ...info,\n }),\n headers: {\n ...this.config.defaultHeaders,\n ...headers,\n 'X-Strapi-Event': event,\n 'Content-Type': 'application/json',\n },\n signal: AbortSignal.timeout(10000),\n })\n .then(async (res) => {\n if (res.ok) {\n return {\n statusCode: res.status,\n };\n }\n\n return {\n statusCode: res.status,\n message: await res.text(),\n };\n })\n .catch((err) => {\n return {\n statusCode: 500,\n message: err.message,\n };\n });\n }\n\n add(webhook: Webhook) {\n debug(`Registering webhook '${webhook.id}'`);\n const { events } = webhook;\n\n events.forEach((event) => {\n if (this.webhooksMap.has(event)) {\n this.webhooksMap.get(event)?.push(webhook);\n } else {\n this.webhooksMap.set(event, [webhook]);\n this.createListener(event);\n }\n });\n }\n\n update(webhook: Webhook) {\n debug(`Refreshing webhook '${webhook.id}'`);\n this.remove(webhook);\n this.add(webhook);\n }\n\n remove(webhook: Webhook) {\n debug(`Unregistering webhook '${webhook.id}'`);\n\n this.webhooksMap.forEach((webhooks, event) => {\n const filteredWebhooks = webhooks.filter((value) => value.id !== webhook.id);\n\n // Cleanup hanging listeners\n if (filteredWebhooks.length === 0) {\n this.webhooksMap.delete(event);\n this.deleteListener(event);\n } else {\n this.webhooksMap.set(event, filteredWebhooks);\n }\n });\n }\n}\n\n/**\n * Expose a factory function instead of the class\n */\nexport default function createWebhookRunner(opts: ConstructorParameters): WebhookRunner {\n return new WebhookRunner(opts);\n}\n\nexport type { WebhookRunner };\n"],"names":["debug","createdDebugger","defaultConfiguration","defaultHeaders","WebhookRunner","deleteListener","event","fn","listeners","get","undefined","eventHub","off","delete","createListener","has","logger","error","listen","info","queue","enqueue","set","on","executeListener","webhooks","webhooksMap","activeWebhooks","filter","webhook","isEnabled","run","catch","url","headers","fetch","method","body","JSON","stringify","createdAt","Date","config","signal","AbortSignal","timeout","then","res","ok","statusCode","status","message","text","err","add","id","events","forEach","push","update","remove","filteredWebhooks","value","length","configuration","Map","Error","_","merge","WorkerQueue","concurrency","subscribe","bind","createWebhookRunner","opts"],"mappings":";;;;AAiCA,MAAMA,QAAQC,WAAAA,CAAgB,gBAAA,CAAA;AAE9B,MAAMC,oBAAAA,GAA+B;AACnCC,IAAAA,cAAAA,EAAgB;AAClB,CAAA;AAEA,MAAMC,aAAAA,CAAAA;AAkCJC,IAAAA,cAAAA,CAAeC,KAAa,EAAE;AAC5BN,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEM,KAAAA,CAAM,CAAC,CAAC,CAAA;AAE9C,QAAA,MAAMC,KAAK,IAAI,CAACC,SAAS,CAACC,GAAG,CAACH,KAAAA,CAAAA;AAE9B,QAAA,IAAIC,OAAOG,SAAAA,EAAW;AACpB,YAAA,IAAI,CAACC,QAAQ,CAACC,GAAG,CAACN,KAAAA,EAAOC,EAAAA,CAAAA;AACzB,YAAA,IAAI,CAACC,SAAS,CAACK,MAAM,CAACP,KAAAA,CAAAA;AACxB,QAAA;AACF,IAAA;AAEAQ,IAAAA,cAAAA,CAAeR,KAAa,EAAE;AAC5BN,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEM,KAAAA,CAAM,CAAC,CAAC,CAAA;AAC9C,QAAA,IAAI,IAAI,CAACE,SAAS,CAACO,GAAG,CAACT,KAAAA,CAAAA,EAAQ;YAC7B,IAAI,CAACU,MAAM,CAACC,KAAK,CACf,CAAC,uDAAuD,EAAEX,KAAAA,CAAM,qCAAqC,CAAC,CAAA;AAE1G,QAAA;AAEA,QAAA,MAAMY,SAAS,OAAOC,IAAAA,GAAAA;AACpB,YAAA,IAAI,CAACC,KAAK,CAACC,OAAO,CAAC;AAAEf,gBAAAA,KAAAA;AAAOa,gBAAAA;AAAK,aAAA,CAAA;AACnC,QAAA,CAAA;AAEA,QAAA,IAAI,CAACX,SAAS,CAACc,GAAG,CAAChB,KAAAA,EAAOY,MAAAA,CAAAA;AAC1B,QAAA,IAAI,CAACP,QAAQ,CAACY,EAAE,CAACjB,KAAAA,EAAOY,MAAAA,CAAAA;AAC1B,IAAA;AAEA,IAAA,MAAMM,gBAAgB,EAAElB,KAAK,EAAEa,IAAI,EAAS,EAAE;AAC5CnB,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEM,KAAAA,CAAM,CAAC,CAAC,CAAA;QAC9C,MAAMmB,QAAAA,GAAW,IAAI,CAACC,WAAW,CAACjB,GAAG,CAACH,UAAU,EAAE;QAClD,MAAMqB,cAAAA,GAAiBF,SAASG,MAAM,CAAC,CAACC,OAAAA,GAAYA,OAAAA,CAAQC,SAAS,KAAK,IAAA,CAAA;QAE1E,KAAK,MAAMD,WAAWF,cAAAA,CAAgB;YACpC,MAAM,IAAI,CAACI,GAAG,CAACF,SAASvB,KAAAA,EAAOa,IAAAA,CAAAA,CAAMa,KAAK,CAAC,CAACf,KAAAA,GAAAA;AAC1C,gBAAA,IAAI,CAACD,MAAM,CAACC,KAAK,CAAC,uBAAA,CAAA;AAClB,gBAAA,IAAI,CAACD,MAAM,CAACC,KAAK,CAACA,KAAAA,CAAAA;AACpB,YAAA,CAAA,CAAA;AACF,QAAA;AACF,IAAA;AAEAc,IAAAA,GAAAA,CAAIF,OAAgB,EAAEvB,KAAa,EAAEa,IAAAA,GAAO,EAAE,EAAE;AAC9C,QAAA,MAAM,EAAEc,GAAG,EAAEC,OAAO,EAAE,GAAGL,OAAAA;AAEzB,QAAA,OAAO,IAAI,CAACM,KAAK,CAACF,GAAAA,EAAK;YACrBG,MAAAA,EAAQ,MAAA;YACRC,IAAAA,EAAMC,IAAAA,CAAKC,SAAS,CAAC;AACnBjC,gBAAAA,KAAAA;AACAkC,gBAAAA,SAAAA,EAAW,IAAIC,IAAAA,EAAAA;AACf,gBAAA,GAAGtB;AACL,aAAA,CAAA;YACAe,OAAAA,EAAS;AACP,gBAAA,GAAG,IAAI,CAACQ,MAAM,CAACvC,cAAc;AAC7B,gBAAA,GAAG+B,OAAO;gBACV,gBAAA,EAAkB5B,KAAAA;gBAClB,cAAA,EAAgB;AAClB,aAAA;YACAqC,MAAAA,EAAQC,WAAAA,CAAYC,OAAO,CAAC,KAAA;SAC9B,CAAA,CACGC,IAAI,CAAC,OAAOC,GAAAA,GAAAA;YACX,IAAIA,GAAAA,CAAIC,EAAE,EAAE;gBACV,OAAO;AACLC,oBAAAA,UAAAA,EAAYF,IAAIG;AAClB,iBAAA;AACF,YAAA;YAEA,OAAO;AACLD,gBAAAA,UAAAA,EAAYF,IAAIG,MAAM;gBACtBC,OAAAA,EAAS,MAAMJ,IAAIK,IAAI;AACzB,aAAA;QACF,CAAA,CAAA,CACCpB,KAAK,CAAC,CAACqB,GAAAA,GAAAA;YACN,OAAO;gBACLJ,UAAAA,EAAY,GAAA;AACZE,gBAAAA,OAAAA,EAASE,IAAIF;AACf,aAAA;AACF,QAAA,CAAA,CAAA;AACJ,IAAA;AAEAG,IAAAA,GAAAA,CAAIzB,OAAgB,EAAE;AACpB7B,QAAAA,KAAAA,CAAM,CAAC,qBAAqB,EAAE6B,QAAQ0B,EAAE,CAAC,CAAC,CAAC,CAAA;QAC3C,MAAM,EAAEC,MAAM,EAAE,GAAG3B,OAAAA;QAEnB2B,MAAAA,CAAOC,OAAO,CAAC,CAACnD,KAAAA,GAAAA;AACd,YAAA,IAAI,IAAI,CAACoB,WAAW,CAACX,GAAG,CAACT,KAAAA,CAAAA,EAAQ;AAC/B,gBAAA,IAAI,CAACoB,WAAW,CAACjB,GAAG,CAACH,QAAQoD,IAAAA,CAAK7B,OAAAA,CAAAA;YACpC,CAAA,MAAO;AACL,gBAAA,IAAI,CAACH,WAAW,CAACJ,GAAG,CAAChB,KAAAA,EAAO;AAACuB,oBAAAA;AAAQ,iBAAA,CAAA;gBACrC,IAAI,CAACf,cAAc,CAACR,KAAAA,CAAAA;AACtB,YAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;AAEAqD,IAAAA,MAAAA,CAAO9B,OAAgB,EAAE;AACvB7B,QAAAA,KAAAA,CAAM,CAAC,oBAAoB,EAAE6B,QAAQ0B,EAAE,CAAC,CAAC,CAAC,CAAA;QAC1C,IAAI,CAACK,MAAM,CAAC/B,OAAAA,CAAAA;QACZ,IAAI,CAACyB,GAAG,CAACzB,OAAAA,CAAAA;AACX,IAAA;AAEA+B,IAAAA,MAAAA,CAAO/B,OAAgB,EAAE;AACvB7B,QAAAA,KAAAA,CAAM,CAAC,uBAAuB,EAAE6B,QAAQ0B,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7C,QAAA,IAAI,CAAC7B,WAAW,CAAC+B,OAAO,CAAC,CAAChC,QAAAA,EAAUnB,KAAAA,GAAAA;YAClC,MAAMuD,gBAAAA,GAAmBpC,QAAAA,CAASG,MAAM,CAAC,CAACkC,QAAUA,KAAAA,CAAMP,EAAE,KAAK1B,OAAAA,CAAQ0B,EAAE,CAAA;;YAG3E,IAAIM,gBAAAA,CAAiBE,MAAM,KAAK,CAAA,EAAG;AACjC,gBAAA,IAAI,CAACrC,WAAW,CAACb,MAAM,CAACP,KAAAA,CAAAA;gBACxB,IAAI,CAACD,cAAc,CAACC,KAAAA,CAAAA;YACtB,CAAA,MAAO;AACL,gBAAA,IAAI,CAACoB,WAAW,CAACJ,GAAG,CAAChB,KAAAA,EAAOuD,gBAAAA,CAAAA;AAC9B,YAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;IAnIA,WAAA,CAAY,EAAElD,QAAQ,EAAEK,MAAM,EAAEgD,aAAAA,GAAgB,EAAE,EAAE7B,KAAK,EAAyB,CAAE;AAR5ET,QAAAA,IAAAA,CAAAA,WAAAA,GAAsC,IAAIuC,GAAAA,EAAAA;AAE1CzD,QAAAA,IAAAA,CAAAA,SAAAA,GAAmC,IAAIyD,GAAAA,EAAAA;QAO7CjE,KAAAA,CAAM,4BAAA,CAAA;QACN,IAAI,CAACW,QAAQ,GAAGA,QAAAA;QAChB,IAAI,CAACK,MAAM,GAAGA,MAAAA;QACd,IAAI,CAACmB,KAAK,GAAGA,KAAAA;QAEb,IAAI,OAAO6B,kBAAkB,QAAA,EAAU;AACrC,YAAA,MAAM,IAAIE,KAAAA,CACR,wGAAA,CAAA;AAEJ,QAAA;AAEA,QAAA,IAAI,CAACxB,MAAM,GAAGyB,CAAAA,CAAEC,KAAK,CAAClE,oBAAAA,EAAsB8D,aAAAA,CAAAA;AAE5C,QAAA,IAAI,CAAC5C,KAAK,GAAG,IAAIiD,WAAAA,CAAY;AAAErD,YAAAA,MAAAA;YAAQsD,WAAAA,EAAa;AAAE,SAAA,CAAA;QAEtD,IAAI,CAAClD,KAAK,CAACmD,SAAS,CAAC,IAAI,CAAC/C,eAAe,CAACgD,IAAI,CAAC,IAAI,CAAA,CAAA;AACrD,IAAA;AAmHF;AAEA;;IAGe,SAASC,mBAAAA,CAAoBC,IAA2B,EAAA;AACrE,IAAA,OAAO,IAAItE,aAAAA,CAAcsE,IAAAA,CAAAA;AAC3B;;;;"}
1
+ {"version":3,"file":"webhook-runner.mjs","sources":["../../src/services/webhook-runner.ts"],"sourcesContent":["/**\n * The event hub is Strapi's event control center.\n */\n\nimport createdDebugger from 'debug';\nimport _ from 'lodash';\nimport type { Logger } from '@strapi/logger';\n\nimport type { Modules } from '@strapi/types';\nimport WorkerQueue from './worker-queue';\nimport type { EventHub } from './event-hub';\nimport type { Fetch } from '../utils/fetch';\n\ntype Webhook = Modules.WebhookStore.Webhook;\n\ninterface Config {\n defaultHeaders: Record<string, string>;\n}\n\ninterface ConstructorParameters {\n eventHub: EventHub;\n logger: Logger;\n configuration?: Record<string, unknown>;\n fetch: Fetch;\n}\n\ninterface Event {\n event: string;\n info: Record<string, unknown>;\n}\n\ntype Listener = (info: Record<string, unknown>) => Promise<void>;\n\nconst debug = createdDebugger('strapi:webhook');\n\nconst defaultConfiguration: Config = {\n defaultHeaders: {},\n};\n\n/**\n * Every event the webhook has to listen to, including the ones it only sends for some content types.\n */\nconst getEvents = ({ events, contentTypeEvents = {} }: Webhook) => {\n return [...new Set([...events, ...Object.values(contentTypeEvents).flat()])];\n};\n\n/**\n * A webhook is triggered by the events it listens to for every content type,\n * and by the events it listens to for the content type the event is about.\n */\nconst isTriggeredBy = (webhook: Webhook, event: string, info?: Event['info']) => {\n const { events, contentTypeEvents = {} } = webhook;\n const uid = info?.uid;\n\n if (events.includes(event)) {\n return true;\n }\n\n return (\n typeof uid === 'string' &&\n Object.hasOwn(contentTypeEvents, uid) &&\n contentTypeEvents[uid].includes(event)\n );\n};\n\nclass WebhookRunner {\n private eventHub: EventHub;\n\n private logger: Logger;\n\n private config: Config;\n\n private webhooksMap: Map<string, Webhook[]> = new Map();\n\n private listeners: Map<string, Listener> = new Map();\n\n private queue: WorkerQueue<Event, void>;\n\n private fetch: Fetch;\n\n constructor({ eventHub, logger, configuration = {}, fetch }: ConstructorParameters) {\n debug('Initialized webhook runner');\n this.eventHub = eventHub;\n this.logger = logger;\n this.fetch = fetch;\n\n if (typeof configuration !== 'object') {\n throw new Error(\n 'Invalid configuration provided to the webhookRunner.\\nCheck your server.json -> webhooks configuration'\n );\n }\n\n this.config = _.merge(defaultConfiguration, configuration);\n\n this.queue = new WorkerQueue({ logger, concurrency: 5 });\n\n this.queue.subscribe(this.executeListener.bind(this));\n }\n\n deleteListener(event: string) {\n debug(`Deleting listener for event '${event}'`);\n\n const fn = this.listeners.get(event);\n\n if (fn !== undefined) {\n this.eventHub.off(event, fn);\n this.listeners.delete(event);\n }\n }\n\n createListener(event: string) {\n debug(`Creating listener for event '${event}'`);\n if (this.listeners.has(event)) {\n this.logger.error(\n `The webhook runner is already listening for the event '${event}'. Did you mean to call .register() ?`\n );\n }\n\n const listen = async (info: Event['info']) => {\n this.queue.enqueue({ event, info });\n };\n\n this.listeners.set(event, listen);\n this.eventHub.on(event, listen);\n }\n\n async executeListener({ event, info }: Event) {\n debug(`Executing webhook for event '${event}'`);\n const webhooks = this.webhooksMap.get(event) || [];\n const activeWebhooks = webhooks.filter(\n (webhook) => webhook.isEnabled === true && isTriggeredBy(webhook, event, info)\n );\n\n for (const webhook of activeWebhooks) {\n await this.run(webhook, event, info).catch((error: unknown) => {\n this.logger.error('Error running webhook');\n this.logger.error(error);\n });\n }\n }\n\n run(webhook: Webhook, event: string, info = {}) {\n const { url, headers } = webhook;\n\n return this.fetch(url, {\n method: 'post',\n body: JSON.stringify({\n event,\n createdAt: new Date(),\n ...info,\n }),\n headers: {\n ...this.config.defaultHeaders,\n ...headers,\n 'X-Strapi-Event': event,\n 'Content-Type': 'application/json',\n },\n signal: AbortSignal.timeout(10000),\n })\n .then(async (res) => {\n if (res.ok) {\n return {\n statusCode: res.status,\n };\n }\n\n return {\n statusCode: res.status,\n message: await res.text(),\n };\n })\n .catch((err) => {\n return {\n statusCode: 500,\n message: err.message,\n };\n });\n }\n\n add(webhook: Webhook) {\n debug(`Registering webhook '${webhook.id}'`);\n getEvents(webhook).forEach((event) => {\n if (this.webhooksMap.has(event)) {\n this.webhooksMap.get(event)?.push(webhook);\n } else {\n this.webhooksMap.set(event, [webhook]);\n this.createListener(event);\n }\n });\n }\n\n update(webhook: Webhook) {\n debug(`Refreshing webhook '${webhook.id}'`);\n this.remove(webhook);\n this.add(webhook);\n }\n\n remove(webhook: Webhook) {\n debug(`Unregistering webhook '${webhook.id}'`);\n\n this.webhooksMap.forEach((webhooks, event) => {\n const filteredWebhooks = webhooks.filter((value) => value.id !== webhook.id);\n\n // Cleanup hanging listeners\n if (filteredWebhooks.length === 0) {\n this.webhooksMap.delete(event);\n this.deleteListener(event);\n } else {\n this.webhooksMap.set(event, filteredWebhooks);\n }\n });\n }\n}\n\n/**\n * Expose a factory function instead of the class\n */\nexport default function createWebhookRunner(opts: ConstructorParameters): WebhookRunner {\n return new WebhookRunner(opts);\n}\n\nexport type { WebhookRunner };\n"],"names":["debug","createdDebugger","defaultConfiguration","defaultHeaders","getEvents","events","contentTypeEvents","Set","Object","values","flat","isTriggeredBy","webhook","event","info","uid","includes","hasOwn","WebhookRunner","deleteListener","fn","listeners","get","undefined","eventHub","off","delete","createListener","has","logger","error","listen","queue","enqueue","set","on","executeListener","webhooks","webhooksMap","activeWebhooks","filter","isEnabled","run","catch","url","headers","fetch","method","body","JSON","stringify","createdAt","Date","config","signal","AbortSignal","timeout","then","res","ok","statusCode","status","message","text","err","add","id","forEach","push","update","remove","filteredWebhooks","value","length","configuration","Map","Error","_","merge","WorkerQueue","concurrency","subscribe","bind","createWebhookRunner","opts"],"mappings":";;;;AAiCA,MAAMA,QAAQC,WAAAA,CAAgB,gBAAA,CAAA;AAE9B,MAAMC,oBAAAA,GAA+B;AACnCC,IAAAA,cAAAA,EAAgB;AAClB,CAAA;AAEA;;IAGA,MAAMC,YAAY,CAAC,EAAEC,MAAM,EAAEC,iBAAAA,GAAoB,EAAE,EAAW,GAAA;IAC5D,OAAO;AAAI,QAAA,GAAA,IAAIC,GAAAA,CAAI;AAAIF,YAAAA,GAAAA,MAAAA;eAAWG,MAAAA,CAAOC,MAAM,CAACH,iBAAAA,CAAAA,CAAmBI,IAAI;AAAG,SAAA;AAAE,KAAA;AAC9E,CAAA;AAEA;;;AAGC,IACD,MAAMC,aAAAA,GAAgB,CAACC,OAAAA,EAAkBC,KAAAA,EAAeC,IAAAA,GAAAA;AACtD,IAAA,MAAM,EAAET,MAAM,EAAEC,oBAAoB,EAAE,EAAE,GAAGM,OAAAA;AAC3C,IAAA,MAAMG,MAAMD,IAAAA,EAAMC,GAAAA;IAElB,IAAIV,MAAAA,CAAOW,QAAQ,CAACH,KAAAA,CAAAA,EAAQ;QAC1B,OAAO,IAAA;AACT,IAAA;AAEA,IAAA,OACE,OAAOE,GAAAA,KAAQ,QAAA,IACfP,MAAAA,CAAOS,MAAM,CAACX,iBAAAA,EAAmBS,GAAAA,CAAAA,IACjCT,iBAAiB,CAACS,GAAAA,CAAI,CAACC,QAAQ,CAACH,KAAAA,CAAAA;AAEpC,CAAA;AAEA,MAAMK,aAAAA,CAAAA;AAkCJC,IAAAA,cAAAA,CAAeN,KAAa,EAAE;AAC5Bb,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEa,KAAAA,CAAM,CAAC,CAAC,CAAA;AAE9C,QAAA,MAAMO,KAAK,IAAI,CAACC,SAAS,CAACC,GAAG,CAACT,KAAAA,CAAAA;AAE9B,QAAA,IAAIO,OAAOG,SAAAA,EAAW;AACpB,YAAA,IAAI,CAACC,QAAQ,CAACC,GAAG,CAACZ,KAAAA,EAAOO,EAAAA,CAAAA;AACzB,YAAA,IAAI,CAACC,SAAS,CAACK,MAAM,CAACb,KAAAA,CAAAA;AACxB,QAAA;AACF,IAAA;AAEAc,IAAAA,cAAAA,CAAed,KAAa,EAAE;AAC5Bb,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEa,KAAAA,CAAM,CAAC,CAAC,CAAA;AAC9C,QAAA,IAAI,IAAI,CAACQ,SAAS,CAACO,GAAG,CAACf,KAAAA,CAAAA,EAAQ;YAC7B,IAAI,CAACgB,MAAM,CAACC,KAAK,CACf,CAAC,uDAAuD,EAAEjB,KAAAA,CAAM,qCAAqC,CAAC,CAAA;AAE1G,QAAA;AAEA,QAAA,MAAMkB,SAAS,OAAOjB,IAAAA,GAAAA;AACpB,YAAA,IAAI,CAACkB,KAAK,CAACC,OAAO,CAAC;AAAEpB,gBAAAA,KAAAA;AAAOC,gBAAAA;AAAK,aAAA,CAAA;AACnC,QAAA,CAAA;AAEA,QAAA,IAAI,CAACO,SAAS,CAACa,GAAG,CAACrB,KAAAA,EAAOkB,MAAAA,CAAAA;AAC1B,QAAA,IAAI,CAACP,QAAQ,CAACW,EAAE,CAACtB,KAAAA,EAAOkB,MAAAA,CAAAA;AAC1B,IAAA;AAEA,IAAA,MAAMK,gBAAgB,EAAEvB,KAAK,EAAEC,IAAI,EAAS,EAAE;AAC5Cd,QAAAA,KAAAA,CAAM,CAAC,6BAA6B,EAAEa,KAAAA,CAAM,CAAC,CAAC,CAAA;QAC9C,MAAMwB,QAAAA,GAAW,IAAI,CAACC,WAAW,CAAChB,GAAG,CAACT,UAAU,EAAE;AAClD,QAAA,MAAM0B,cAAAA,GAAiBF,QAAAA,CAASG,MAAM,CACpC,CAAC5B,OAAAA,GAAYA,OAAAA,CAAQ6B,SAAS,KAAK,IAAA,IAAQ9B,aAAAA,CAAcC,OAAAA,EAASC,KAAAA,EAAOC,IAAAA,CAAAA,CAAAA;QAG3E,KAAK,MAAMF,WAAW2B,cAAAA,CAAgB;YACpC,MAAM,IAAI,CAACG,GAAG,CAAC9B,SAASC,KAAAA,EAAOC,IAAAA,CAAAA,CAAM6B,KAAK,CAAC,CAACb,KAAAA,GAAAA;AAC1C,gBAAA,IAAI,CAACD,MAAM,CAACC,KAAK,CAAC,uBAAA,CAAA;AAClB,gBAAA,IAAI,CAACD,MAAM,CAACC,KAAK,CAACA,KAAAA,CAAAA;AACpB,YAAA,CAAA,CAAA;AACF,QAAA;AACF,IAAA;AAEAY,IAAAA,GAAAA,CAAI9B,OAAgB,EAAEC,KAAa,EAAEC,IAAAA,GAAO,EAAE,EAAE;AAC9C,QAAA,MAAM,EAAE8B,GAAG,EAAEC,OAAO,EAAE,GAAGjC,OAAAA;AAEzB,QAAA,OAAO,IAAI,CAACkC,KAAK,CAACF,GAAAA,EAAK;YACrBG,MAAAA,EAAQ,MAAA;YACRC,IAAAA,EAAMC,IAAAA,CAAKC,SAAS,CAAC;AACnBrC,gBAAAA,KAAAA;AACAsC,gBAAAA,SAAAA,EAAW,IAAIC,IAAAA,EAAAA;AACf,gBAAA,GAAGtC;AACL,aAAA,CAAA;YACA+B,OAAAA,EAAS;AACP,gBAAA,GAAG,IAAI,CAACQ,MAAM,CAAClD,cAAc;AAC7B,gBAAA,GAAG0C,OAAO;gBACV,gBAAA,EAAkBhC,KAAAA;gBAClB,cAAA,EAAgB;AAClB,aAAA;YACAyC,MAAAA,EAAQC,WAAAA,CAAYC,OAAO,CAAC,KAAA;SAC9B,CAAA,CACGC,IAAI,CAAC,OAAOC,GAAAA,GAAAA;YACX,IAAIA,GAAAA,CAAIC,EAAE,EAAE;gBACV,OAAO;AACLC,oBAAAA,UAAAA,EAAYF,IAAIG;AAClB,iBAAA;AACF,YAAA;YAEA,OAAO;AACLD,gBAAAA,UAAAA,EAAYF,IAAIG,MAAM;gBACtBC,OAAAA,EAAS,MAAMJ,IAAIK,IAAI;AACzB,aAAA;QACF,CAAA,CAAA,CACCpB,KAAK,CAAC,CAACqB,GAAAA,GAAAA;YACN,OAAO;gBACLJ,UAAAA,EAAY,GAAA;AACZE,gBAAAA,OAAAA,EAASE,IAAIF;AACf,aAAA;AACF,QAAA,CAAA,CAAA;AACJ,IAAA;AAEAG,IAAAA,GAAAA,CAAIrD,OAAgB,EAAE;AACpBZ,QAAAA,KAAAA,CAAM,CAAC,qBAAqB,EAAEY,QAAQsD,EAAE,CAAC,CAAC,CAAC,CAAA;QAC3C9D,SAAAA,CAAUQ,OAAAA,CAAAA,CAASuD,OAAO,CAAC,CAACtD,KAAAA,GAAAA;AAC1B,YAAA,IAAI,IAAI,CAACyB,WAAW,CAACV,GAAG,CAACf,KAAAA,CAAAA,EAAQ;AAC/B,gBAAA,IAAI,CAACyB,WAAW,CAAChB,GAAG,CAACT,QAAQuD,IAAAA,CAAKxD,OAAAA,CAAAA;YACpC,CAAA,MAAO;AACL,gBAAA,IAAI,CAAC0B,WAAW,CAACJ,GAAG,CAACrB,KAAAA,EAAO;AAACD,oBAAAA;AAAQ,iBAAA,CAAA;gBACrC,IAAI,CAACe,cAAc,CAACd,KAAAA,CAAAA;AACtB,YAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;AAEAwD,IAAAA,MAAAA,CAAOzD,OAAgB,EAAE;AACvBZ,QAAAA,KAAAA,CAAM,CAAC,oBAAoB,EAAEY,QAAQsD,EAAE,CAAC,CAAC,CAAC,CAAA;QAC1C,IAAI,CAACI,MAAM,CAAC1D,OAAAA,CAAAA;QACZ,IAAI,CAACqD,GAAG,CAACrD,OAAAA,CAAAA;AACX,IAAA;AAEA0D,IAAAA,MAAAA,CAAO1D,OAAgB,EAAE;AACvBZ,QAAAA,KAAAA,CAAM,CAAC,uBAAuB,EAAEY,QAAQsD,EAAE,CAAC,CAAC,CAAC,CAAA;AAE7C,QAAA,IAAI,CAAC5B,WAAW,CAAC6B,OAAO,CAAC,CAAC9B,QAAAA,EAAUxB,KAAAA,GAAAA;YAClC,MAAM0D,gBAAAA,GAAmBlC,QAAAA,CAASG,MAAM,CAAC,CAACgC,QAAUA,KAAAA,CAAMN,EAAE,KAAKtD,OAAAA,CAAQsD,EAAE,CAAA;;YAG3E,IAAIK,gBAAAA,CAAiBE,MAAM,KAAK,CAAA,EAAG;AACjC,gBAAA,IAAI,CAACnC,WAAW,CAACZ,MAAM,CAACb,KAAAA,CAAAA;gBACxB,IAAI,CAACM,cAAc,CAACN,KAAAA,CAAAA;YACtB,CAAA,MAAO;AACL,gBAAA,IAAI,CAACyB,WAAW,CAACJ,GAAG,CAACrB,KAAAA,EAAO0D,gBAAAA,CAAAA;AAC9B,YAAA;AACF,QAAA,CAAA,CAAA;AACF,IAAA;IAnIA,WAAA,CAAY,EAAE/C,QAAQ,EAAEK,MAAM,EAAE6C,aAAAA,GAAgB,EAAE,EAAE5B,KAAK,EAAyB,CAAE;AAR5ER,QAAAA,IAAAA,CAAAA,WAAAA,GAAsC,IAAIqC,GAAAA,EAAAA;AAE1CtD,QAAAA,IAAAA,CAAAA,SAAAA,GAAmC,IAAIsD,GAAAA,EAAAA;QAO7C3E,KAAAA,CAAM,4BAAA,CAAA;QACN,IAAI,CAACwB,QAAQ,GAAGA,QAAAA;QAChB,IAAI,CAACK,MAAM,GAAGA,MAAAA;QACd,IAAI,CAACiB,KAAK,GAAGA,KAAAA;QAEb,IAAI,OAAO4B,kBAAkB,QAAA,EAAU;AACrC,YAAA,MAAM,IAAIE,KAAAA,CACR,wGAAA,CAAA;AAEJ,QAAA;AAEA,QAAA,IAAI,CAACvB,MAAM,GAAGwB,CAAAA,CAAEC,KAAK,CAAC5E,oBAAAA,EAAsBwE,aAAAA,CAAAA;AAE5C,QAAA,IAAI,CAAC1C,KAAK,GAAG,IAAI+C,WAAAA,CAAY;AAAElD,YAAAA,MAAAA;YAAQmD,WAAAA,EAAa;AAAE,SAAA,CAAA;QAEtD,IAAI,CAAChD,KAAK,CAACiD,SAAS,CAAC,IAAI,CAAC7C,eAAe,CAAC8C,IAAI,CAAC,IAAI,CAAA,CAAA;AACrD,IAAA;AAmHF;AAEA;;IAGe,SAASC,mBAAAA,CAAoBC,IAA2B,EAAA;AACrE,IAAA,OAAO,IAAIlE,aAAAA,CAAckE,IAAAA,CAAAA;AAC3B;;;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"webhook-store.d.ts","sourceRoot":"","sources":["../../src/services/webhook-store.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAI7C,QAAA,MAAM,YAAY,EAAE,KAwBnB,CAAC;AAEF,KAAK,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC;AAqC5C,MAAM,WAAW,YAAY;IAC3B,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,iBAAiB,IAAI,MAAM,EAAE,CAAC;IAC9B,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACjD,YAAY,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACnC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACjD,aAAa,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/C,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAClE,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;CACpD;AAED,QAAA,MAAM,kBAAkB,GAAI,QAAQ;IAAE,EAAE,EAAE,QAAQ,CAAA;CAAE,KAAG,YAwDtD,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,CAAC"}
1
+ {"version":3,"file":"webhook-store.d.ts","sourceRoot":"","sources":["../../src/services/webhook-store.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAI7C,QAAA,MAAM,YAAY,EAAE,KA2BnB,CAAC;AAEF,KAAK,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC;AA2D5C,MAAM,WAAW,YAAY;IAC3B,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,iBAAiB,IAAI,MAAM,EAAE,CAAC;IAC9B,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACjD,YAAY,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACnC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACjD,aAAa,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/C,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAClE,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;CACpD;AAED,QAAA,MAAM,kBAAkB,GAAI,QAAQ;IAAE,EAAE,EAAE,QAAQ,CAAA;CAAE,KAAG,YAwDtD,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,CAAC"}
@@ -23,17 +23,35 @@ const webhookModel = {
23
23
  events: {
24
24
  type: 'json'
25
25
  },
26
+ contentTypeEvents: {
27
+ type: 'json'
28
+ },
26
29
  enabled: {
27
30
  type: 'boolean'
28
31
  }
29
32
  }
30
33
  };
34
+ /**
35
+ * Events triggered for every content type don't need to be saved per content type as well.
36
+ */ const toContentTypeEvents = ({ events, contentTypeEvents = {} })=>{
37
+ return Object.fromEntries(Object.entries(contentTypeEvents).map(([uid, uidEvents])=>[
38
+ uid,
39
+ uidEvents.filter((event)=>!events.includes(event))
40
+ ]).filter(([, uidEvents])=>uidEvents.length > 0));
41
+ };
42
+ const getEvents = ({ events, contentTypeEvents = {} })=>{
43
+ return [
44
+ ...events,
45
+ ...Object.values(contentTypeEvents).flat()
46
+ ];
47
+ };
31
48
  const toDBObject = (data)=>{
32
49
  return {
33
50
  name: data.name,
34
51
  url: data.url,
35
52
  headers: data.headers,
36
53
  events: data.events,
54
+ contentTypeEvents: toContentTypeEvents(data),
37
55
  enabled: data.isEnabled
38
56
  };
39
57
  };
@@ -44,13 +62,14 @@ const fromDBObject = (row)=>{
44
62
  url: row.url,
45
63
  headers: row.headers,
46
64
  events: row.events,
65
+ contentTypeEvents: row.contentTypeEvents ?? {},
47
66
  isEnabled: row.enabled
48
67
  };
49
68
  };
50
69
  const webhookEventValidator = async (allowedEvents, events)=>{
51
- const allowedValues = Array.from(allowedEvents.values());
70
+ const allowedValues = new Set(Array.from(allowedEvents.values()));
52
71
  events.forEach((event)=>{
53
- if (allowedValues.includes(event)) {
72
+ if (allowedValues.has(event)) {
54
73
  return;
55
74
  }
56
75
  throw new ValidationError(`Webhook event ${event} is not supported`);
@@ -109,7 +128,7 @@ const createWebhookStore = ({ db })=>{
109
128
  return result ? fromDBObject(result) : null;
110
129
  },
111
130
  async createWebhook (data) {
112
- await webhookEventValidator(this.allowedEvents, data.events);
131
+ await webhookEventValidator(this.allowedEvents, getEvents(data));
113
132
  return db.query('strapi::webhook').create({
114
133
  data: toDBObject({
115
134
  ...data,
@@ -118,7 +137,7 @@ const createWebhookStore = ({ db })=>{
118
137
  }).then(fromDBObject);
119
138
  },
120
139
  async updateWebhook (id, data) {
121
- await webhookEventValidator(this.allowedEvents, data.events);
140
+ await webhookEventValidator(this.allowedEvents, getEvents(data));
122
141
  const webhook = await db.query('strapi::webhook').update({
123
142
  where: {
124
143
  id
@@ -1 +1 @@
1
- {"version":3,"file":"webhook-store.js","sources":["../../src/services/webhook-store.ts"],"sourcesContent":["/**\n * Webhook store is the implementation of webhook storage over the core_store\n */\n\nimport { errors } from '@strapi/utils';\nimport type { Model, Database } from '@strapi/database';\nimport type { Modules } from '@strapi/types';\n\nconst { ValidationError } = errors;\n\nconst webhookModel: Model = {\n uid: 'strapi::webhook',\n singularName: 'strapi_webhooks',\n tableName: 'strapi_webhooks',\n attributes: {\n id: {\n type: 'increments',\n },\n name: {\n type: 'string',\n },\n url: {\n type: 'text',\n },\n headers: {\n type: 'json',\n },\n events: {\n type: 'json',\n },\n enabled: {\n type: 'boolean',\n },\n },\n};\n\ntype Webhook = Modules.WebhookStore.Webhook;\ntype DBOutput = Omit<Webhook, 'id' | 'isEnabled'> & { id: string | number; enabled: boolean };\ntype DBInput = Omit<DBOutput, 'id'>;\n\nconst toDBObject = (data: Webhook): DBInput => {\n return {\n name: data.name,\n url: data.url,\n headers: data.headers,\n events: data.events,\n enabled: data.isEnabled,\n };\n};\n\nconst fromDBObject = (row: DBOutput): Webhook => {\n return {\n id: typeof row.id === 'number' ? row.id.toString() : row.id,\n name: row.name,\n url: row.url,\n headers: row.headers,\n events: row.events,\n isEnabled: row.enabled,\n };\n};\n\nconst webhookEventValidator = async (allowedEvents: Map<string, string>, events: string[]) => {\n const allowedValues = Array.from(allowedEvents.values());\n\n events.forEach((event) => {\n if (allowedValues.includes(event)) {\n return;\n }\n\n throw new ValidationError(`Webhook event ${event} is not supported`);\n });\n};\n\nexport interface WebhookStore {\n allowedEvents: Map<string, string>;\n addAllowedEvent(key: string, value: string): void;\n removeAllowedEvent(key: string): void;\n listAllowedEvents(): string[];\n getAllowedEvent(key: string): string | undefined;\n findWebhooks(): Promise<Webhook[]>;\n findWebhook(id: string): Promise<Webhook | null>;\n createWebhook(data: Webhook): Promise<Webhook>;\n updateWebhook(id: string, data: Webhook): Promise<Webhook | null>;\n deleteWebhook(id: string): Promise<Webhook | null>;\n}\n\nconst createWebhookStore = ({ db }: { db: Database }): WebhookStore => {\n return {\n allowedEvents: new Map([\n ['ENTRY_CREATE', 'entry.create'],\n ['ENTRY_UPDATE', 'entry.update'],\n ['ENTRY_DELETE', 'entry.delete'],\n ['ENTRY_PUBLISH', 'entry.publish'],\n ['ENTRY_UNPUBLISH', 'entry.unpublish'],\n ['ENTRY_DRAFT_DISCARD', 'entry.draft-discard'],\n ]),\n addAllowedEvent(key, value) {\n this.allowedEvents.set(key, value);\n },\n removeAllowedEvent(key) {\n this.allowedEvents.delete(key);\n },\n listAllowedEvents() {\n return Array.from(this.allowedEvents.keys());\n },\n getAllowedEvent(key) {\n return this.allowedEvents.get(key);\n },\n async findWebhooks() {\n const results = await db.query('strapi::webhook').findMany();\n\n return results.map(fromDBObject);\n },\n async findWebhook(id) {\n const result = await db.query('strapi::webhook').findOne({ where: { id } });\n return result ? fromDBObject(result) : null;\n },\n async createWebhook(data) {\n await webhookEventValidator(this.allowedEvents, data.events);\n\n return db\n .query('strapi::webhook')\n .create({\n data: toDBObject({ ...data, isEnabled: true }),\n })\n .then(fromDBObject);\n },\n async updateWebhook(id, data) {\n await webhookEventValidator(this.allowedEvents, data.events);\n\n const webhook = await db.query('strapi::webhook').update({\n where: { id },\n data: toDBObject(data),\n });\n\n return webhook ? fromDBObject(webhook) : null;\n },\n async deleteWebhook(id) {\n const webhook = await db.query('strapi::webhook').delete({ where: { id } });\n return webhook ? fromDBObject(webhook) : null;\n },\n };\n};\n\nexport { webhookModel, createWebhookStore };\n"],"names":["ValidationError","errors","webhookModel","uid","singularName","tableName","attributes","id","type","name","url","headers","events","enabled","toDBObject","data","isEnabled","fromDBObject","row","toString","webhookEventValidator","allowedEvents","allowedValues","Array","from","values","forEach","event","includes","createWebhookStore","db","Map","addAllowedEvent","key","value","set","removeAllowedEvent","delete","listAllowedEvents","keys","getAllowedEvent","get","findWebhooks","results","query","findMany","map","findWebhook","result","findOne","where","createWebhook","create","then","updateWebhook","webhook","update","deleteWebhook"],"mappings":";;;;AAQA,MAAM,EAAEA,eAAe,EAAE,GAAGC,kBAAAA;AAE5B,MAAMC,YAAAA,GAAsB;IAC1BC,GAAAA,EAAK,iBAAA;IACLC,YAAAA,EAAc,iBAAA;IACdC,SAAAA,EAAW,iBAAA;IACXC,UAAAA,EAAY;QACVC,EAAAA,EAAI;YACFC,IAAAA,EAAM;AACR,SAAA;QACAC,IAAAA,EAAM;YACJD,IAAAA,EAAM;AACR,SAAA;QACAE,GAAAA,EAAK;YACHF,IAAAA,EAAM;AACR,SAAA;QACAG,OAAAA,EAAS;YACPH,IAAAA,EAAM;AACR,SAAA;QACAI,MAAAA,EAAQ;YACNJ,IAAAA,EAAM;AACR,SAAA;QACAK,OAAAA,EAAS;YACPL,IAAAA,EAAM;AACR;AACF;AACF;AAMA,MAAMM,aAAa,CAACC,IAAAA,GAAAA;IAClB,OAAO;AACLN,QAAAA,IAAAA,EAAMM,KAAKN,IAAI;AACfC,QAAAA,GAAAA,EAAKK,KAAKL,GAAG;AACbC,QAAAA,OAAAA,EAASI,KAAKJ,OAAO;AACrBC,QAAAA,MAAAA,EAAQG,KAAKH,MAAM;AACnBC,QAAAA,OAAAA,EAASE,KAAKC;AAChB,KAAA;AACF,CAAA;AAEA,MAAMC,eAAe,CAACC,GAAAA,GAAAA;IACpB,OAAO;QACLX,EAAAA,EAAI,OAAOW,GAAAA,CAAIX,EAAE,KAAK,QAAA,GAAWW,GAAAA,CAAIX,EAAE,CAACY,QAAQ,EAAA,GAAKD,GAAAA,CAAIX,EAAE;AAC3DE,QAAAA,IAAAA,EAAMS,IAAIT,IAAI;AACdC,QAAAA,GAAAA,EAAKQ,IAAIR,GAAG;AACZC,QAAAA,OAAAA,EAASO,IAAIP,OAAO;AACpBC,QAAAA,MAAAA,EAAQM,IAAIN,MAAM;AAClBI,QAAAA,SAAAA,EAAWE,IAAIL;AACjB,KAAA;AACF,CAAA;AAEA,MAAMO,qBAAAA,GAAwB,OAAOC,aAAAA,EAAoCT,MAAAA,GAAAA;AACvE,IAAA,MAAMU,aAAAA,GAAgBC,KAAAA,CAAMC,IAAI,CAACH,cAAcI,MAAM,EAAA,CAAA;IAErDb,MAAAA,CAAOc,OAAO,CAAC,CAACC,KAAAA,GAAAA;QACd,IAAIL,aAAAA,CAAcM,QAAQ,CAACD,KAAAA,CAAAA,EAAQ;AACjC,YAAA;AACF,QAAA;AAEA,QAAA,MAAM,IAAI3B,eAAAA,CAAgB,CAAC,cAAc,EAAE2B,KAAAA,CAAM,iBAAiB,CAAC,CAAA;AACrE,IAAA,CAAA,CAAA;AACF,CAAA;AAeA,MAAME,kBAAAA,GAAqB,CAAC,EAAEC,EAAE,EAAoB,GAAA;IAClD,OAAO;AACLT,QAAAA,aAAAA,EAAe,IAAIU,GAAAA,CAAI;AACrB,YAAA;AAAC,gBAAA,cAAA;AAAgB,gBAAA;AAAe,aAAA;AAChC,YAAA;AAAC,gBAAA,cAAA;AAAgB,gBAAA;AAAe,aAAA;AAChC,YAAA;AAAC,gBAAA,cAAA;AAAgB,gBAAA;AAAe,aAAA;AAChC,YAAA;AAAC,gBAAA,eAAA;AAAiB,gBAAA;AAAgB,aAAA;AAClC,YAAA;AAAC,gBAAA,iBAAA;AAAmB,gBAAA;AAAkB,aAAA;AACtC,YAAA;AAAC,gBAAA,qBAAA;AAAuB,gBAAA;AAAsB;AAC/C,SAAA,CAAA;QACDC,eAAAA,CAAAA,CAAgBC,GAAG,EAAEC,KAAK,EAAA;AACxB,YAAA,IAAI,CAACb,aAAa,CAACc,GAAG,CAACF,GAAAA,EAAKC,KAAAA,CAAAA;AAC9B,QAAA,CAAA;AACAE,QAAAA,kBAAAA,CAAAA,CAAmBH,GAAG,EAAA;AACpB,YAAA,IAAI,CAACZ,aAAa,CAACgB,MAAM,CAACJ,GAAAA,CAAAA;AAC5B,QAAA,CAAA;AACAK,QAAAA,iBAAAA,CAAAA,GAAAA;AACE,YAAA,OAAOf,MAAMC,IAAI,CAAC,IAAI,CAACH,aAAa,CAACkB,IAAI,EAAA,CAAA;AAC3C,QAAA,CAAA;AACAC,QAAAA,eAAAA,CAAAA,CAAgBP,GAAG,EAAA;AACjB,YAAA,OAAO,IAAI,CAACZ,aAAa,CAACoB,GAAG,CAACR,GAAAA,CAAAA;AAChC,QAAA,CAAA;QACA,MAAMS,YAAAA,CAAAA,GAAAA;AACJ,YAAA,MAAMC,UAAU,MAAMb,EAAAA,CAAGc,KAAK,CAAC,mBAAmBC,QAAQ,EAAA;YAE1D,OAAOF,OAAAA,CAAQG,GAAG,CAAC7B,YAAAA,CAAAA;AACrB,QAAA,CAAA;AACA,QAAA,MAAM8B,aAAYxC,EAAE,EAAA;AAClB,YAAA,MAAMyC,SAAS,MAAMlB,EAAAA,CAAGc,KAAK,CAAC,iBAAA,CAAA,CAAmBK,OAAO,CAAC;gBAAEC,KAAAA,EAAO;AAAE3C,oBAAAA;AAAG;AAAE,aAAA,CAAA;YACzE,OAAOyC,MAAAA,GAAS/B,aAAa+B,MAAAA,CAAAA,GAAU,IAAA;AACzC,QAAA,CAAA;AACA,QAAA,MAAMG,eAAcpC,IAAI,EAAA;AACtB,YAAA,MAAMK,sBAAsB,IAAI,CAACC,aAAa,EAAEN,KAAKH,MAAM,CAAA;AAE3D,YAAA,OAAOkB,EAAAA,CACJc,KAAK,CAAC,iBAAA,CAAA,CACNQ,MAAM,CAAC;AACNrC,gBAAAA,IAAAA,EAAMD,UAAAA,CAAW;AAAE,oBAAA,GAAGC,IAAI;oBAAEC,SAAAA,EAAW;AAAK,iBAAA;AAC9C,aAAA,CAAA,CACCqC,IAAI,CAACpC,YAAAA,CAAAA;AACV,QAAA,CAAA;QACA,MAAMqC,aAAAA,CAAAA,CAAc/C,EAAE,EAAEQ,IAAI,EAAA;AAC1B,YAAA,MAAMK,sBAAsB,IAAI,CAACC,aAAa,EAAEN,KAAKH,MAAM,CAAA;AAE3D,YAAA,MAAM2C,UAAU,MAAMzB,EAAAA,CAAGc,KAAK,CAAC,iBAAA,CAAA,CAAmBY,MAAM,CAAC;gBACvDN,KAAAA,EAAO;AAAE3C,oBAAAA;AAAG,iBAAA;AACZQ,gBAAAA,IAAAA,EAAMD,UAAAA,CAAWC,IAAAA;AACnB,aAAA,CAAA;YAEA,OAAOwC,OAAAA,GAAUtC,aAAasC,OAAAA,CAAAA,GAAW,IAAA;AAC3C,QAAA,CAAA;AACA,QAAA,MAAME,eAAclD,EAAE,EAAA;AACpB,YAAA,MAAMgD,UAAU,MAAMzB,EAAAA,CAAGc,KAAK,CAAC,iBAAA,CAAA,CAAmBP,MAAM,CAAC;gBAAEa,KAAAA,EAAO;AAAE3C,oBAAAA;AAAG;AAAE,aAAA,CAAA;YACzE,OAAOgD,OAAAA,GAAUtC,aAAasC,OAAAA,CAAAA,GAAW,IAAA;AAC3C,QAAA;AACF,KAAA;AACF;;;;;"}
1
+ {"version":3,"file":"webhook-store.js","sources":["../../src/services/webhook-store.ts"],"sourcesContent":["/**\n * Webhook store is the implementation of webhook storage over the core_store\n */\n\nimport { errors } from '@strapi/utils';\nimport type { Model, Database } from '@strapi/database';\nimport type { Modules } from '@strapi/types';\n\nconst { ValidationError } = errors;\n\nconst webhookModel: Model = {\n uid: 'strapi::webhook',\n singularName: 'strapi_webhooks',\n tableName: 'strapi_webhooks',\n attributes: {\n id: {\n type: 'increments',\n },\n name: {\n type: 'string',\n },\n url: {\n type: 'text',\n },\n headers: {\n type: 'json',\n },\n events: {\n type: 'json',\n },\n contentTypeEvents: {\n type: 'json',\n },\n enabled: {\n type: 'boolean',\n },\n },\n};\n\ntype Webhook = Modules.WebhookStore.Webhook;\ntype DBOutput = Omit<Webhook, 'id' | 'isEnabled' | 'contentTypeEvents'> & {\n id: string | number;\n enabled: boolean;\n // null for webhooks saved before events could be selected per content type\n contentTypeEvents?: Webhook['contentTypeEvents'] | null;\n};\ntype DBInput = Omit<DBOutput, 'id'>;\n\n/**\n * Events triggered for every content type don't need to be saved per content type as well.\n */\nconst toContentTypeEvents = ({ events, contentTypeEvents = {} }: Webhook) => {\n return Object.fromEntries(\n Object.entries(contentTypeEvents)\n .map(([uid, uidEvents]) => [uid, uidEvents.filter((event) => !events.includes(event))])\n .filter(([, uidEvents]) => uidEvents.length > 0)\n );\n};\n\nconst getEvents = ({ events, contentTypeEvents = {} }: Webhook) => {\n return [...events, ...Object.values(contentTypeEvents).flat()];\n};\n\nconst toDBObject = (data: Webhook): DBInput => {\n return {\n name: data.name,\n url: data.url,\n headers: data.headers,\n events: data.events,\n contentTypeEvents: toContentTypeEvents(data),\n enabled: data.isEnabled,\n };\n};\n\nconst fromDBObject = (row: DBOutput): Webhook => {\n return {\n id: typeof row.id === 'number' ? row.id.toString() : row.id,\n name: row.name,\n url: row.url,\n headers: row.headers,\n events: row.events,\n contentTypeEvents: row.contentTypeEvents ?? {},\n isEnabled: row.enabled,\n };\n};\n\nconst webhookEventValidator = async (allowedEvents: Map<string, string>, events: string[]) => {\n const allowedValues = new Set(Array.from(allowedEvents.values()));\n\n events.forEach((event) => {\n if (allowedValues.has(event)) {\n return;\n }\n\n throw new ValidationError(`Webhook event ${event} is not supported`);\n });\n};\n\nexport interface WebhookStore {\n allowedEvents: Map<string, string>;\n addAllowedEvent(key: string, value: string): void;\n removeAllowedEvent(key: string): void;\n listAllowedEvents(): string[];\n getAllowedEvent(key: string): string | undefined;\n findWebhooks(): Promise<Webhook[]>;\n findWebhook(id: string): Promise<Webhook | null>;\n createWebhook(data: Webhook): Promise<Webhook>;\n updateWebhook(id: string, data: Webhook): Promise<Webhook | null>;\n deleteWebhook(id: string): Promise<Webhook | null>;\n}\n\nconst createWebhookStore = ({ db }: { db: Database }): WebhookStore => {\n return {\n allowedEvents: new Map([\n ['ENTRY_CREATE', 'entry.create'],\n ['ENTRY_UPDATE', 'entry.update'],\n ['ENTRY_DELETE', 'entry.delete'],\n ['ENTRY_PUBLISH', 'entry.publish'],\n ['ENTRY_UNPUBLISH', 'entry.unpublish'],\n ['ENTRY_DRAFT_DISCARD', 'entry.draft-discard'],\n ]),\n addAllowedEvent(key, value) {\n this.allowedEvents.set(key, value);\n },\n removeAllowedEvent(key) {\n this.allowedEvents.delete(key);\n },\n listAllowedEvents() {\n return Array.from(this.allowedEvents.keys());\n },\n getAllowedEvent(key) {\n return this.allowedEvents.get(key);\n },\n async findWebhooks() {\n const results = await db.query('strapi::webhook').findMany();\n\n return results.map(fromDBObject);\n },\n async findWebhook(id) {\n const result = await db.query('strapi::webhook').findOne({ where: { id } });\n return result ? fromDBObject(result) : null;\n },\n async createWebhook(data) {\n await webhookEventValidator(this.allowedEvents, getEvents(data));\n\n return db\n .query('strapi::webhook')\n .create({\n data: toDBObject({ ...data, isEnabled: true }),\n })\n .then(fromDBObject);\n },\n async updateWebhook(id, data) {\n await webhookEventValidator(this.allowedEvents, getEvents(data));\n\n const webhook = await db.query('strapi::webhook').update({\n where: { id },\n data: toDBObject(data),\n });\n\n return webhook ? fromDBObject(webhook) : null;\n },\n async deleteWebhook(id) {\n const webhook = await db.query('strapi::webhook').delete({ where: { id } });\n return webhook ? fromDBObject(webhook) : null;\n },\n };\n};\n\nexport { webhookModel, createWebhookStore };\n"],"names":["ValidationError","errors","webhookModel","uid","singularName","tableName","attributes","id","type","name","url","headers","events","contentTypeEvents","enabled","toContentTypeEvents","Object","fromEntries","entries","map","uidEvents","filter","event","includes","length","getEvents","values","flat","toDBObject","data","isEnabled","fromDBObject","row","toString","webhookEventValidator","allowedEvents","allowedValues","Set","Array","from","forEach","has","createWebhookStore","db","Map","addAllowedEvent","key","value","set","removeAllowedEvent","delete","listAllowedEvents","keys","getAllowedEvent","get","findWebhooks","results","query","findMany","findWebhook","result","findOne","where","createWebhook","create","then","updateWebhook","webhook","update","deleteWebhook"],"mappings":";;;;AAQA,MAAM,EAAEA,eAAe,EAAE,GAAGC,kBAAAA;AAE5B,MAAMC,YAAAA,GAAsB;IAC1BC,GAAAA,EAAK,iBAAA;IACLC,YAAAA,EAAc,iBAAA;IACdC,SAAAA,EAAW,iBAAA;IACXC,UAAAA,EAAY;QACVC,EAAAA,EAAI;YACFC,IAAAA,EAAM;AACR,SAAA;QACAC,IAAAA,EAAM;YACJD,IAAAA,EAAM;AACR,SAAA;QACAE,GAAAA,EAAK;YACHF,IAAAA,EAAM;AACR,SAAA;QACAG,OAAAA,EAAS;YACPH,IAAAA,EAAM;AACR,SAAA;QACAI,MAAAA,EAAQ;YACNJ,IAAAA,EAAM;AACR,SAAA;QACAK,iBAAAA,EAAmB;YACjBL,IAAAA,EAAM;AACR,SAAA;QACAM,OAAAA,EAAS;YACPN,IAAAA,EAAM;AACR;AACF;AACF;AAWA;;IAGA,MAAMO,sBAAsB,CAAC,EAAEH,MAAM,EAAEC,iBAAAA,GAAoB,EAAE,EAAW,GAAA;AACtE,IAAA,OAAOG,MAAAA,CAAOC,WAAW,CACvBD,MAAAA,CAAOE,OAAO,CAACL,iBAAAA,CAAAA,CACZM,GAAG,CAAC,CAAC,CAAChB,GAAAA,EAAKiB,UAAU,GAAK;AAACjB,YAAAA,GAAAA;AAAKiB,YAAAA,SAAAA,CAAUC,MAAM,CAAC,CAACC,QAAU,CAACV,MAAAA,CAAOW,QAAQ,CAACD,KAAAA,CAAAA;SAAQ,CAAA,CACrFD,MAAM,CAAC,CAAC,GAAGD,UAAU,GAAKA,SAAAA,CAAUI,MAAM,GAAG,CAAA,CAAA,CAAA;AAEpD,CAAA;AAEA,MAAMC,SAAAA,GAAY,CAAC,EAAEb,MAAM,EAAEC,iBAAAA,GAAoB,EAAE,EAAW,GAAA;IAC5D,OAAO;AAAID,QAAAA,GAAAA,MAAAA;WAAWI,MAAAA,CAAOU,MAAM,CAACb,iBAAAA,CAAAA,CAAmBc,IAAI;AAAG,KAAA;AAChE,CAAA;AAEA,MAAMC,aAAa,CAACC,IAAAA,GAAAA;IAClB,OAAO;AACLpB,QAAAA,IAAAA,EAAMoB,KAAKpB,IAAI;AACfC,QAAAA,GAAAA,EAAKmB,KAAKnB,GAAG;AACbC,QAAAA,OAAAA,EAASkB,KAAKlB,OAAO;AACrBC,QAAAA,MAAAA,EAAQiB,KAAKjB,MAAM;AACnBC,QAAAA,iBAAAA,EAAmBE,mBAAAA,CAAoBc,IAAAA,CAAAA;AACvCf,QAAAA,OAAAA,EAASe,KAAKC;AAChB,KAAA;AACF,CAAA;AAEA,MAAMC,eAAe,CAACC,GAAAA,GAAAA;IACpB,OAAO;QACLzB,EAAAA,EAAI,OAAOyB,GAAAA,CAAIzB,EAAE,KAAK,QAAA,GAAWyB,GAAAA,CAAIzB,EAAE,CAAC0B,QAAQ,EAAA,GAAKD,GAAAA,CAAIzB,EAAE;AAC3DE,QAAAA,IAAAA,EAAMuB,IAAIvB,IAAI;AACdC,QAAAA,GAAAA,EAAKsB,IAAItB,GAAG;AACZC,QAAAA,OAAAA,EAASqB,IAAIrB,OAAO;AACpBC,QAAAA,MAAAA,EAAQoB,IAAIpB,MAAM;QAClBC,iBAAAA,EAAmBmB,GAAAA,CAAInB,iBAAiB,IAAI,EAAC;AAC7CiB,QAAAA,SAAAA,EAAWE,IAAIlB;AACjB,KAAA;AACF,CAAA;AAEA,MAAMoB,qBAAAA,GAAwB,OAAOC,aAAAA,EAAoCvB,MAAAA,GAAAA;AACvE,IAAA,MAAMwB,gBAAgB,IAAIC,GAAAA,CAAIC,MAAMC,IAAI,CAACJ,cAAcT,MAAM,EAAA,CAAA,CAAA;IAE7Dd,MAAAA,CAAO4B,OAAO,CAAC,CAAClB,KAAAA,GAAAA;QACd,IAAIc,aAAAA,CAAcK,GAAG,CAACnB,KAAAA,CAAAA,EAAQ;AAC5B,YAAA;AACF,QAAA;AAEA,QAAA,MAAM,IAAItB,eAAAA,CAAgB,CAAC,cAAc,EAAEsB,KAAAA,CAAM,iBAAiB,CAAC,CAAA;AACrE,IAAA,CAAA,CAAA;AACF,CAAA;AAeA,MAAMoB,kBAAAA,GAAqB,CAAC,EAAEC,EAAE,EAAoB,GAAA;IAClD,OAAO;AACLR,QAAAA,aAAAA,EAAe,IAAIS,GAAAA,CAAI;AACrB,YAAA;AAAC,gBAAA,cAAA;AAAgB,gBAAA;AAAe,aAAA;AAChC,YAAA;AAAC,gBAAA,cAAA;AAAgB,gBAAA;AAAe,aAAA;AAChC,YAAA;AAAC,gBAAA,cAAA;AAAgB,gBAAA;AAAe,aAAA;AAChC,YAAA;AAAC,gBAAA,eAAA;AAAiB,gBAAA;AAAgB,aAAA;AAClC,YAAA;AAAC,gBAAA,iBAAA;AAAmB,gBAAA;AAAkB,aAAA;AACtC,YAAA;AAAC,gBAAA,qBAAA;AAAuB,gBAAA;AAAsB;AAC/C,SAAA,CAAA;QACDC,eAAAA,CAAAA,CAAgBC,GAAG,EAAEC,KAAK,EAAA;AACxB,YAAA,IAAI,CAACZ,aAAa,CAACa,GAAG,CAACF,GAAAA,EAAKC,KAAAA,CAAAA;AAC9B,QAAA,CAAA;AACAE,QAAAA,kBAAAA,CAAAA,CAAmBH,GAAG,EAAA;AACpB,YAAA,IAAI,CAACX,aAAa,CAACe,MAAM,CAACJ,GAAAA,CAAAA;AAC5B,QAAA,CAAA;AACAK,QAAAA,iBAAAA,CAAAA,GAAAA;AACE,YAAA,OAAOb,MAAMC,IAAI,CAAC,IAAI,CAACJ,aAAa,CAACiB,IAAI,EAAA,CAAA;AAC3C,QAAA,CAAA;AACAC,QAAAA,eAAAA,CAAAA,CAAgBP,GAAG,EAAA;AACjB,YAAA,OAAO,IAAI,CAACX,aAAa,CAACmB,GAAG,CAACR,GAAAA,CAAAA;AAChC,QAAA,CAAA;QACA,MAAMS,YAAAA,CAAAA,GAAAA;AACJ,YAAA,MAAMC,UAAU,MAAMb,EAAAA,CAAGc,KAAK,CAAC,mBAAmBC,QAAQ,EAAA;YAE1D,OAAOF,OAAAA,CAAQrC,GAAG,CAACY,YAAAA,CAAAA;AACrB,QAAA,CAAA;AACA,QAAA,MAAM4B,aAAYpD,EAAE,EAAA;AAClB,YAAA,MAAMqD,SAAS,MAAMjB,EAAAA,CAAGc,KAAK,CAAC,iBAAA,CAAA,CAAmBI,OAAO,CAAC;gBAAEC,KAAAA,EAAO;AAAEvD,oBAAAA;AAAG;AAAE,aAAA,CAAA;YACzE,OAAOqD,MAAAA,GAAS7B,aAAa6B,MAAAA,CAAAA,GAAU,IAAA;AACzC,QAAA,CAAA;AACA,QAAA,MAAMG,eAAclC,IAAI,EAAA;AACtB,YAAA,MAAMK,qBAAAA,CAAsB,IAAI,CAACC,aAAa,EAAEV,SAAAA,CAAUI,IAAAA,CAAAA,CAAAA;AAE1D,YAAA,OAAOc,EAAAA,CACJc,KAAK,CAAC,iBAAA,CAAA,CACNO,MAAM,CAAC;AACNnC,gBAAAA,IAAAA,EAAMD,UAAAA,CAAW;AAAE,oBAAA,GAAGC,IAAI;oBAAEC,SAAAA,EAAW;AAAK,iBAAA;AAC9C,aAAA,CAAA,CACCmC,IAAI,CAAClC,YAAAA,CAAAA;AACV,QAAA,CAAA;QACA,MAAMmC,aAAAA,CAAAA,CAAc3D,EAAE,EAAEsB,IAAI,EAAA;AAC1B,YAAA,MAAMK,qBAAAA,CAAsB,IAAI,CAACC,aAAa,EAAEV,SAAAA,CAAUI,IAAAA,CAAAA,CAAAA;AAE1D,YAAA,MAAMsC,UAAU,MAAMxB,EAAAA,CAAGc,KAAK,CAAC,iBAAA,CAAA,CAAmBW,MAAM,CAAC;gBACvDN,KAAAA,EAAO;AAAEvD,oBAAAA;AAAG,iBAAA;AACZsB,gBAAAA,IAAAA,EAAMD,UAAAA,CAAWC,IAAAA;AACnB,aAAA,CAAA;YAEA,OAAOsC,OAAAA,GAAUpC,aAAaoC,OAAAA,CAAAA,GAAW,IAAA;AAC3C,QAAA,CAAA;AACA,QAAA,MAAME,eAAc9D,EAAE,EAAA;AACpB,YAAA,MAAM4D,UAAU,MAAMxB,EAAAA,CAAGc,KAAK,CAAC,iBAAA,CAAA,CAAmBP,MAAM,CAAC;gBAAEY,KAAAA,EAAO;AAAEvD,oBAAAA;AAAG;AAAE,aAAA,CAAA;YACzE,OAAO4D,OAAAA,GAAUpC,aAAaoC,OAAAA,CAAAA,GAAW,IAAA;AAC3C,QAAA;AACF,KAAA;AACF;;;;;"}
@@ -21,17 +21,35 @@ const webhookModel = {
21
21
  events: {
22
22
  type: 'json'
23
23
  },
24
+ contentTypeEvents: {
25
+ type: 'json'
26
+ },
24
27
  enabled: {
25
28
  type: 'boolean'
26
29
  }
27
30
  }
28
31
  };
32
+ /**
33
+ * Events triggered for every content type don't need to be saved per content type as well.
34
+ */ const toContentTypeEvents = ({ events, contentTypeEvents = {} })=>{
35
+ return Object.fromEntries(Object.entries(contentTypeEvents).map(([uid, uidEvents])=>[
36
+ uid,
37
+ uidEvents.filter((event)=>!events.includes(event))
38
+ ]).filter(([, uidEvents])=>uidEvents.length > 0));
39
+ };
40
+ const getEvents = ({ events, contentTypeEvents = {} })=>{
41
+ return [
42
+ ...events,
43
+ ...Object.values(contentTypeEvents).flat()
44
+ ];
45
+ };
29
46
  const toDBObject = (data)=>{
30
47
  return {
31
48
  name: data.name,
32
49
  url: data.url,
33
50
  headers: data.headers,
34
51
  events: data.events,
52
+ contentTypeEvents: toContentTypeEvents(data),
35
53
  enabled: data.isEnabled
36
54
  };
37
55
  };
@@ -42,13 +60,14 @@ const fromDBObject = (row)=>{
42
60
  url: row.url,
43
61
  headers: row.headers,
44
62
  events: row.events,
63
+ contentTypeEvents: row.contentTypeEvents ?? {},
45
64
  isEnabled: row.enabled
46
65
  };
47
66
  };
48
67
  const webhookEventValidator = async (allowedEvents, events)=>{
49
- const allowedValues = Array.from(allowedEvents.values());
68
+ const allowedValues = new Set(Array.from(allowedEvents.values()));
50
69
  events.forEach((event)=>{
51
- if (allowedValues.includes(event)) {
70
+ if (allowedValues.has(event)) {
52
71
  return;
53
72
  }
54
73
  throw new ValidationError(`Webhook event ${event} is not supported`);
@@ -107,7 +126,7 @@ const createWebhookStore = ({ db })=>{
107
126
  return result ? fromDBObject(result) : null;
108
127
  },
109
128
  async createWebhook (data) {
110
- await webhookEventValidator(this.allowedEvents, data.events);
129
+ await webhookEventValidator(this.allowedEvents, getEvents(data));
111
130
  return db.query('strapi::webhook').create({
112
131
  data: toDBObject({
113
132
  ...data,
@@ -116,7 +135,7 @@ const createWebhookStore = ({ db })=>{
116
135
  }).then(fromDBObject);
117
136
  },
118
137
  async updateWebhook (id, data) {
119
- await webhookEventValidator(this.allowedEvents, data.events);
138
+ await webhookEventValidator(this.allowedEvents, getEvents(data));
120
139
  const webhook = await db.query('strapi::webhook').update({
121
140
  where: {
122
141
  id