@xemahq/platform-common 0.1.3
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.
- package/LICENSE +201 -0
- package/README.md +64 -0
- package/dist/index.d.ts +35 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +74 -0
- package/dist/index.js.map +1 -0
- package/dist/lib/advisory-lock.d.ts +9 -0
- package/dist/lib/advisory-lock.d.ts.map +1 -0
- package/dist/lib/advisory-lock.js +25 -0
- package/dist/lib/advisory-lock.js.map +1 -0
- package/dist/lib/agent-session.types.d.ts +171 -0
- package/dist/lib/agent-session.types.d.ts.map +1 -0
- package/dist/lib/agent-session.types.js +156 -0
- package/dist/lib/agent-session.types.js.map +1 -0
- package/dist/lib/approval-mode.d.ts +9 -0
- package/dist/lib/approval-mode.d.ts.map +1 -0
- package/dist/lib/approval-mode.js +27 -0
- package/dist/lib/approval-mode.js.map +1 -0
- package/dist/lib/briefcase/index.d.ts +18 -0
- package/dist/lib/briefcase/index.d.ts.map +1 -0
- package/dist/lib/briefcase/index.js +72 -0
- package/dist/lib/briefcase/index.js.map +1 -0
- package/dist/lib/deliverable-output-contract.d.ts +87 -0
- package/dist/lib/deliverable-output-contract.d.ts.map +1 -0
- package/dist/lib/deliverable-output-contract.js +119 -0
- package/dist/lib/deliverable-output-contract.js.map +1 -0
- package/dist/lib/derive-required-workspace-slots.d.ts +12 -0
- package/dist/lib/derive-required-workspace-slots.d.ts.map +1 -0
- package/dist/lib/derive-required-workspace-slots.js +51 -0
- package/dist/lib/derive-required-workspace-slots.js.map +1 -0
- package/dist/lib/encryption.d.ts +5 -0
- package/dist/lib/encryption.d.ts.map +1 -0
- package/dist/lib/encryption.js +40 -0
- package/dist/lib/encryption.js.map +1 -0
- package/dist/lib/enums/artifact-versioning-mode.d.ts +6 -0
- package/dist/lib/enums/artifact-versioning-mode.d.ts.map +1 -0
- package/dist/lib/enums/artifact-versioning-mode.js +10 -0
- package/dist/lib/enums/artifact-versioning-mode.js.map +1 -0
- package/dist/lib/enums/index.d.ts +5 -0
- package/dist/lib/enums/index.d.ts.map +1 -0
- package/dist/lib/enums/index.js +21 -0
- package/dist/lib/enums/index.js.map +1 -0
- package/dist/lib/enums/llm-gateway.d.ts +19 -0
- package/dist/lib/enums/llm-gateway.d.ts.map +1 -0
- package/dist/lib/enums/llm-gateway.js +51 -0
- package/dist/lib/enums/llm-gateway.js.map +1 -0
- package/dist/lib/enums/scope-source.d.ts +24 -0
- package/dist/lib/enums/scope-source.d.ts.map +1 -0
- package/dist/lib/enums/scope-source.js +73 -0
- package/dist/lib/enums/scope-source.js.map +1 -0
- package/dist/lib/enums/webapp-studio.d.ts +20 -0
- package/dist/lib/enums/webapp-studio.d.ts.map +1 -0
- package/dist/lib/enums/webapp-studio.js +27 -0
- package/dist/lib/enums/webapp-studio.js.map +1 -0
- package/dist/lib/errors/pipeline-errors.d.ts +182 -0
- package/dist/lib/errors/pipeline-errors.d.ts.map +1 -0
- package/dist/lib/errors/pipeline-errors.js +323 -0
- package/dist/lib/errors/pipeline-errors.js.map +1 -0
- package/dist/lib/escape-for-prompt.d.ts +3 -0
- package/dist/lib/escape-for-prompt.d.ts.map +1 -0
- package/dist/lib/escape-for-prompt.js +28 -0
- package/dist/lib/escape-for-prompt.js.map +1 -0
- package/dist/lib/file-share-token.d.ts +25 -0
- package/dist/lib/file-share-token.d.ts.map +1 -0
- package/dist/lib/file-share-token.js +90 -0
- package/dist/lib/file-share-token.js.map +1 -0
- package/dist/lib/integration-webhooks/adapter-key.enum.d.ts +8 -0
- package/dist/lib/integration-webhooks/adapter-key.enum.d.ts.map +1 -0
- package/dist/lib/integration-webhooks/adapter-key.enum.js +12 -0
- package/dist/lib/integration-webhooks/adapter-key.enum.js.map +1 -0
- package/dist/lib/integration-webhooks/index.d.ts +5 -0
- package/dist/lib/integration-webhooks/index.d.ts.map +1 -0
- package/dist/lib/integration-webhooks/index.js +21 -0
- package/dist/lib/integration-webhooks/index.js.map +1 -0
- package/dist/lib/integration-webhooks/integration-provider.enum.d.ts +26 -0
- package/dist/lib/integration-webhooks/integration-provider.enum.d.ts.map +1 -0
- package/dist/lib/integration-webhooks/integration-provider.enum.js +30 -0
- package/dist/lib/integration-webhooks/integration-provider.enum.js.map +1 -0
- package/dist/lib/integration-webhooks/routes.d.ts +3 -0
- package/dist/lib/integration-webhooks/routes.d.ts.map +1 -0
- package/dist/lib/integration-webhooks/routes.js +6 -0
- package/dist/lib/integration-webhooks/routes.js.map +1 -0
- package/dist/lib/integration-webhooks/webhook-entity-kind.enum.d.ts +12 -0
- package/dist/lib/integration-webhooks/webhook-entity-kind.enum.d.ts.map +1 -0
- package/dist/lib/integration-webhooks/webhook-entity-kind.enum.js +16 -0
- package/dist/lib/integration-webhooks/webhook-entity-kind.enum.js.map +1 -0
- package/dist/lib/interaction-widgets/factories.d.ts +83 -0
- package/dist/lib/interaction-widgets/factories.d.ts.map +1 -0
- package/dist/lib/interaction-widgets/factories.js +173 -0
- package/dist/lib/interaction-widgets/factories.js.map +1 -0
- package/dist/lib/interaction-widgets/index.d.ts +4 -0
- package/dist/lib/interaction-widgets/index.d.ts.map +1 -0
- package/dist/lib/interaction-widgets/index.js +20 -0
- package/dist/lib/interaction-widgets/index.js.map +1 -0
- package/dist/lib/interaction-widgets/validation.d.ts +10 -0
- package/dist/lib/interaction-widgets/validation.d.ts.map +1 -0
- package/dist/lib/interaction-widgets/validation.js +214 -0
- package/dist/lib/interaction-widgets/validation.js.map +1 -0
- package/dist/lib/interaction-widgets/widget-types.d.ts +163 -0
- package/dist/lib/interaction-widgets/widget-types.d.ts.map +1 -0
- package/dist/lib/interaction-widgets/widget-types.js +22 -0
- package/dist/lib/interaction-widgets/widget-types.js.map +1 -0
- package/dist/lib/interactive-workspace-layout.d.ts +25 -0
- package/dist/lib/interactive-workspace-layout.d.ts.map +1 -0
- package/dist/lib/interactive-workspace-layout.js +56 -0
- package/dist/lib/interactive-workspace-layout.js.map +1 -0
- package/dist/lib/json-extraction.d.ts +2 -0
- package/dist/lib/json-extraction.d.ts.map +1 -0
- package/dist/lib/json-extraction.js +81 -0
- package/dist/lib/json-extraction.js.map +1 -0
- package/dist/lib/llm-stream/anthropic-adapter.d.ts +25 -0
- package/dist/lib/llm-stream/anthropic-adapter.d.ts.map +1 -0
- package/dist/lib/llm-stream/anthropic-adapter.js +278 -0
- package/dist/lib/llm-stream/anthropic-adapter.js.map +1 -0
- package/dist/lib/llm-stream/compaction.d.ts +16 -0
- package/dist/lib/llm-stream/compaction.d.ts.map +1 -0
- package/dist/lib/llm-stream/compaction.js +82 -0
- package/dist/lib/llm-stream/compaction.js.map +1 -0
- package/dist/lib/llm-stream/consume-stream.d.ts +17 -0
- package/dist/lib/llm-stream/consume-stream.d.ts.map +1 -0
- package/dist/lib/llm-stream/consume-stream.js +138 -0
- package/dist/lib/llm-stream/consume-stream.js.map +1 -0
- package/dist/lib/llm-stream/index.d.ts +6 -0
- package/dist/lib/llm-stream/index.d.ts.map +1 -0
- package/dist/lib/llm-stream/index.js +22 -0
- package/dist/lib/llm-stream/index.js.map +1 -0
- package/dist/lib/llm-stream/progress.d.ts +17 -0
- package/dist/lib/llm-stream/progress.d.ts.map +1 -0
- package/dist/lib/llm-stream/progress.js +12 -0
- package/dist/lib/llm-stream/progress.js.map +1 -0
- package/dist/lib/llm-stream/types.d.ts +56 -0
- package/dist/lib/llm-stream/types.d.ts.map +1 -0
- package/dist/lib/llm-stream/types.js +3 -0
- package/dist/lib/llm-stream/types.js.map +1 -0
- package/dist/lib/llm-stream-observer.d.ts +27 -0
- package/dist/lib/llm-stream-observer.d.ts.map +1 -0
- package/dist/lib/llm-stream-observer.js +55 -0
- package/dist/lib/llm-stream-observer.js.map +1 -0
- package/dist/lib/manifest/index.d.ts +5 -0
- package/dist/lib/manifest/index.d.ts.map +1 -0
- package/dist/lib/manifest/index.js +21 -0
- package/dist/lib/manifest/index.js.map +1 -0
- package/dist/lib/manifest/manifest.enums.d.ts +55 -0
- package/dist/lib/manifest/manifest.enums.d.ts.map +1 -0
- package/dist/lib/manifest/manifest.enums.js +278 -0
- package/dist/lib/manifest/manifest.enums.js.map +1 -0
- package/dist/lib/manifest/manifest.schema.d.ts +433 -0
- package/dist/lib/manifest/manifest.schema.d.ts.map +1 -0
- package/dist/lib/manifest/manifest.schema.js +327 -0
- package/dist/lib/manifest/manifest.schema.js.map +1 -0
- package/dist/lib/manifest/manifest.types.d.ts +146 -0
- package/dist/lib/manifest/manifest.types.d.ts.map +1 -0
- package/dist/lib/manifest/manifest.types.js +54 -0
- package/dist/lib/manifest/manifest.types.js.map +1 -0
- package/dist/lib/manifest/manifest.validation.d.ts +17 -0
- package/dist/lib/manifest/manifest.validation.d.ts.map +1 -0
- package/dist/lib/manifest/manifest.validation.js +353 -0
- package/dist/lib/manifest/manifest.validation.js.map +1 -0
- package/dist/lib/mcp-bridge-token.d.ts +63 -0
- package/dist/lib/mcp-bridge-token.d.ts.map +1 -0
- package/dist/lib/mcp-bridge-token.js +255 -0
- package/dist/lib/mcp-bridge-token.js.map +1 -0
- package/dist/lib/mcp-response-projection.d.ts +9 -0
- package/dist/lib/mcp-response-projection.d.ts.map +1 -0
- package/dist/lib/mcp-response-projection.js +57 -0
- package/dist/lib/mcp-response-projection.js.map +1 -0
- package/dist/lib/omit-undefined.d.ts +2 -0
- package/dist/lib/omit-undefined.d.ts.map +1 -0
- package/dist/lib/omit-undefined.js +9 -0
- package/dist/lib/omit-undefined.js.map +1 -0
- package/dist/lib/orval-client-config.d.ts +29 -0
- package/dist/lib/orval-client-config.d.ts.map +1 -0
- package/dist/lib/orval-client-config.js +30 -0
- package/dist/lib/orval-client-config.js.map +1 -0
- package/dist/lib/preview-token.d.ts +16 -0
- package/dist/lib/preview-token.d.ts.map +1 -0
- package/dist/lib/preview-token.js +71 -0
- package/dist/lib/preview-token.js.map +1 -0
- package/dist/lib/redaction/default-rules.d.ts +3 -0
- package/dist/lib/redaction/default-rules.d.ts.map +1 -0
- package/dist/lib/redaction/default-rules.js +66 -0
- package/dist/lib/redaction/default-rules.js.map +1 -0
- package/dist/lib/redaction/index.d.ts +5 -0
- package/dist/lib/redaction/index.d.ts.map +1 -0
- package/dist/lib/redaction/index.js +12 -0
- package/dist/lib/redaction/index.js.map +1 -0
- package/dist/lib/redaction/redaction-rule.d.ts +8 -0
- package/dist/lib/redaction/redaction-rule.d.ts.map +1 -0
- package/dist/lib/redaction/redaction-rule.js +3 -0
- package/dist/lib/redaction/redaction-rule.js.map +1 -0
- package/dist/lib/redaction/redaction.interceptor.d.ts +11 -0
- package/dist/lib/redaction/redaction.interceptor.d.ts.map +1 -0
- package/dist/lib/redaction/redaction.interceptor.js +41 -0
- package/dist/lib/redaction/redaction.interceptor.js.map +1 -0
- package/dist/lib/redaction/redaction.service.d.ts +9 -0
- package/dist/lib/redaction/redaction.service.d.ts.map +1 -0
- package/dist/lib/redaction/redaction.service.js +110 -0
- package/dist/lib/redaction/redaction.service.js.map +1 -0
- package/dist/lib/request-context.d.ts +34 -0
- package/dist/lib/request-context.d.ts.map +1 -0
- package/dist/lib/request-context.js +10 -0
- package/dist/lib/request-context.js.map +1 -0
- package/dist/lib/run-events/action-types.d.ts +40 -0
- package/dist/lib/run-events/action-types.d.ts.map +1 -0
- package/dist/lib/run-events/action-types.js +40 -0
- package/dist/lib/run-events/action-types.js.map +1 -0
- package/dist/lib/run-events/event-families.d.ts +96 -0
- package/dist/lib/run-events/event-families.d.ts.map +1 -0
- package/dist/lib/run-events/event-families.js +282 -0
- package/dist/lib/run-events/event-families.js.map +1 -0
- package/dist/lib/run-events/index.d.ts +7 -0
- package/dist/lib/run-events/index.d.ts.map +1 -0
- package/dist/lib/run-events/index.js +23 -0
- package/dist/lib/run-events/index.js.map +1 -0
- package/dist/lib/run-events/run-event.types.d.ts +60 -0
- package/dist/lib/run-events/run-event.types.d.ts.map +1 -0
- package/dist/lib/run-events/run-event.types.js +57 -0
- package/dist/lib/run-events/run-event.types.js.map +1 -0
- package/dist/lib/run-events/run-live-snapshot.types.d.ts +69 -0
- package/dist/lib/run-events/run-live-snapshot.types.d.ts.map +1 -0
- package/dist/lib/run-events/run-live-snapshot.types.js +17 -0
- package/dist/lib/run-events/run-live-snapshot.types.js.map +1 -0
- package/dist/lib/run-events/snapshot-reducer.d.ts +4 -0
- package/dist/lib/run-events/snapshot-reducer.d.ts.map +1 -0
- package/dist/lib/run-events/snapshot-reducer.js +313 -0
- package/dist/lib/run-events/snapshot-reducer.js.map +1 -0
- package/dist/lib/run-events/stream-contracts.d.ts +79 -0
- package/dist/lib/run-events/stream-contracts.d.ts.map +1 -0
- package/dist/lib/run-events/stream-contracts.js +27 -0
- package/dist/lib/run-events/stream-contracts.js.map +1 -0
- package/dist/lib/tag-taxonomy/concern-tags.d.ts +3 -0
- package/dist/lib/tag-taxonomy/concern-tags.d.ts.map +1 -0
- package/dist/lib/tag-taxonomy/concern-tags.js +26 -0
- package/dist/lib/tag-taxonomy/concern-tags.js.map +1 -0
- package/dist/lib/tag-taxonomy/index.d.ts +14 -0
- package/dist/lib/tag-taxonomy/index.d.ts.map +1 -0
- package/dist/lib/tag-taxonomy/index.js +59 -0
- package/dist/lib/tag-taxonomy/index.js.map +1 -0
- package/dist/lib/tag-taxonomy/lifecycle-tags.d.ts +3 -0
- package/dist/lib/tag-taxonomy/lifecycle-tags.d.ts.map +1 -0
- package/dist/lib/tag-taxonomy/lifecycle-tags.js +57 -0
- package/dist/lib/tag-taxonomy/lifecycle-tags.js.map +1 -0
- package/dist/lib/tag-taxonomy/stack-tags.d.ts +3 -0
- package/dist/lib/tag-taxonomy/stack-tags.d.ts.map +1 -0
- package/dist/lib/tag-taxonomy/stack-tags.js +26 -0
- package/dist/lib/tag-taxonomy/stack-tags.js.map +1 -0
- package/dist/lib/tag-taxonomy/team-tags.d.ts +3 -0
- package/dist/lib/tag-taxonomy/team-tags.d.ts.map +1 -0
- package/dist/lib/tag-taxonomy/team-tags.js +84 -0
- package/dist/lib/tag-taxonomy/team-tags.js.map +1 -0
- package/dist/lib/tag-taxonomy/types.d.ts +14 -0
- package/dist/lib/tag-taxonomy/types.d.ts.map +1 -0
- package/dist/lib/tag-taxonomy/types.js +3 -0
- package/dist/lib/tag-taxonomy/types.js.map +1 -0
- package/dist/lib/to-prisma-json.d.ts +6 -0
- package/dist/lib/to-prisma-json.d.ts.map +1 -0
- package/dist/lib/to-prisma-json.js +12 -0
- package/dist/lib/to-prisma-json.js.map +1 -0
- package/dist/lib/tool-usage-counter.d.ts +20 -0
- package/dist/lib/tool-usage-counter.d.ts.map +1 -0
- package/dist/lib/tool-usage-counter.js +50 -0
- package/dist/lib/tool-usage-counter.js.map +1 -0
- package/dist/lib/vote-feedback.d.ts +60 -0
- package/dist/lib/vote-feedback.d.ts.map +1 -0
- package/dist/lib/vote-feedback.js +57 -0
- package/dist/lib/vote-feedback.js.map +1 -0
- package/dist/lib/write-policy.d.ts +30 -0
- package/dist/lib/write-policy.d.ts.map +1 -0
- package/dist/lib/write-policy.js +54 -0
- package/dist/lib/write-policy.js.map +1 -0
- package/dist/lib/xema-path-builder.d.ts +7 -0
- package/dist/lib/xema-path-builder.d.ts.map +1 -0
- package/dist/lib/xema-path-builder.js +67 -0
- package/dist/lib/xema-path-builder.js.map +1 -0
- package/dist/nestjs/auth/auth-module-options.d.ts +16 -0
- package/dist/nestjs/auth/auth-module-options.d.ts.map +1 -0
- package/dist/nestjs/auth/auth-module-options.js +5 -0
- package/dist/nestjs/auth/auth-module-options.js.map +1 -0
- package/dist/nestjs/auth/auth.module.d.ts +7 -0
- package/dist/nestjs/auth/auth.module.d.ts.map +1 -0
- package/dist/nestjs/auth/auth.module.js +69 -0
- package/dist/nestjs/auth/auth.module.js.map +1 -0
- package/dist/nestjs/auth/configure-auth-middleware.d.ts +7 -0
- package/dist/nestjs/auth/configure-auth-middleware.d.ts.map +1 -0
- package/dist/nestjs/auth/configure-auth-middleware.js +30 -0
- package/dist/nestjs/auth/configure-auth-middleware.js.map +1 -0
- package/dist/nestjs/auth/index.d.ts +11 -0
- package/dist/nestjs/auth/index.d.ts.map +1 -0
- package/dist/nestjs/auth/index.js +36 -0
- package/dist/nestjs/auth/index.js.map +1 -0
- package/dist/nestjs/auth/internal-caller.guard.d.ts +6 -0
- package/dist/nestjs/auth/internal-caller.guard.d.ts.map +1 -0
- package/dist/nestjs/auth/internal-caller.guard.js +38 -0
- package/dist/nestjs/auth/internal-caller.guard.js.map +1 -0
- package/dist/nestjs/auth/org-claim.d.ts +13 -0
- package/dist/nestjs/auth/org-claim.d.ts.map +1 -0
- package/dist/nestjs/auth/org-claim.js +26 -0
- package/dist/nestjs/auth/org-claim.js.map +1 -0
- package/dist/nestjs/auth/org-role.d.ts +13 -0
- package/dist/nestjs/auth/org-role.d.ts.map +1 -0
- package/dist/nestjs/auth/org-role.guard.d.ts +9 -0
- package/dist/nestjs/auth/org-role.guard.d.ts.map +1 -0
- package/dist/nestjs/auth/org-role.guard.js +59 -0
- package/dist/nestjs/auth/org-role.guard.js.map +1 -0
- package/dist/nestjs/auth/org-role.js +75 -0
- package/dist/nestjs/auth/org-role.js.map +1 -0
- package/dist/nestjs/auth/service-actor.guard.d.ts +6 -0
- package/dist/nestjs/auth/service-actor.guard.d.ts.map +1 -0
- package/dist/nestjs/auth/service-actor.guard.js +49 -0
- package/dist/nestjs/auth/service-actor.guard.js.map +1 -0
- package/dist/nestjs/auth/service-token.guard.d.ts +16 -0
- package/dist/nestjs/auth/service-token.guard.d.ts.map +1 -0
- package/dist/nestjs/auth/service-token.guard.js +209 -0
- package/dist/nestjs/auth/service-token.guard.js.map +1 -0
- package/dist/nestjs/auth/token-class.guard.d.ts +9 -0
- package/dist/nestjs/auth/token-class.guard.d.ts.map +1 -0
- package/dist/nestjs/auth/token-class.guard.js +57 -0
- package/dist/nestjs/auth/token-class.guard.js.map +1 -0
- package/dist/nestjs/body-parsers.d.ts +7 -0
- package/dist/nestjs/body-parsers.d.ts.map +1 -0
- package/dist/nestjs/body-parsers.js +14 -0
- package/dist/nestjs/body-parsers.js.map +1 -0
- package/dist/nestjs/cors.config.d.ts +4 -0
- package/dist/nestjs/cors.config.d.ts.map +1 -0
- package/dist/nestjs/cors.config.js +74 -0
- package/dist/nestjs/cors.config.js.map +1 -0
- package/dist/nestjs/ctx.decorator.d.ts +3 -0
- package/dist/nestjs/ctx.decorator.d.ts.map +1 -0
- package/dist/nestjs/ctx.decorator.js +14 -0
- package/dist/nestjs/ctx.decorator.js.map +1 -0
- package/dist/nestjs/decorator-metadata.d.ts +6 -0
- package/dist/nestjs/decorator-metadata.d.ts.map +1 -0
- package/dist/nestjs/decorator-metadata.js +18 -0
- package/dist/nestjs/decorator-metadata.js.map +1 -0
- package/dist/nestjs/error-response.dto.d.ts +10 -0
- package/dist/nestjs/error-response.dto.d.ts.map +1 -0
- package/dist/nestjs/error-response.dto.js +46 -0
- package/dist/nestjs/error-response.dto.js.map +1 -0
- package/dist/nestjs/fetch-envelope.d.ts +5 -0
- package/dist/nestjs/fetch-envelope.d.ts.map +1 -0
- package/dist/nestjs/fetch-envelope.js +38 -0
- package/dist/nestjs/fetch-envelope.js.map +1 -0
- package/dist/nestjs/fetch-with-retry.d.ts +11 -0
- package/dist/nestjs/fetch-with-retry.d.ts.map +1 -0
- package/dist/nestjs/fetch-with-retry.js +100 -0
- package/dist/nestjs/fetch-with-retry.js.map +1 -0
- package/dist/nestjs/get-env-or-throw.d.ts +2 -0
- package/dist/nestjs/get-env-or-throw.d.ts.map +1 -0
- package/dist/nestjs/get-env-or-throw.js +11 -0
- package/dist/nestjs/get-env-or-throw.js.map +1 -0
- package/dist/nestjs/global-exception.filter.d.ts +10 -0
- package/dist/nestjs/global-exception.filter.d.ts.map +1 -0
- package/dist/nestjs/global-exception.filter.js +139 -0
- package/dist/nestjs/global-exception.filter.js.map +1 -0
- package/dist/nestjs/idempotency/idempotency.service.d.ts +6 -0
- package/dist/nestjs/idempotency/idempotency.service.d.ts.map +1 -0
- package/dist/nestjs/idempotency/idempotency.service.js +5 -0
- package/dist/nestjs/idempotency/idempotency.service.js.map +1 -0
- package/dist/nestjs/idempotency/idempotency.tokens.d.ts +2 -0
- package/dist/nestjs/idempotency/idempotency.tokens.d.ts.map +1 -0
- package/dist/nestjs/idempotency/idempotency.tokens.js +5 -0
- package/dist/nestjs/idempotency/idempotency.tokens.js.map +1 -0
- package/dist/nestjs/idempotency/index.d.ts +4 -0
- package/dist/nestjs/idempotency/index.d.ts.map +1 -0
- package/dist/nestjs/idempotency/index.js +11 -0
- package/dist/nestjs/idempotency/index.js.map +1 -0
- package/dist/nestjs/idempotency/prisma-idempotency.service.d.ts +20 -0
- package/dist/nestjs/idempotency/prisma-idempotency.service.d.ts.map +1 -0
- package/dist/nestjs/idempotency/prisma-idempotency.service.js +58 -0
- package/dist/nestjs/idempotency/prisma-idempotency.service.js.map +1 -0
- package/dist/nestjs/index.d.ts +26 -0
- package/dist/nestjs/index.d.ts.map +1 -0
- package/dist/nestjs/index.js +96 -0
- package/dist/nestjs/index.js.map +1 -0
- package/dist/nestjs/integration-webhooks/api-integration-envelope.decorator.d.ts +7 -0
- package/dist/nestjs/integration-webhooks/api-integration-envelope.decorator.d.ts.map +1 -0
- package/dist/nestjs/integration-webhooks/api-integration-envelope.decorator.js +27 -0
- package/dist/nestjs/integration-webhooks/api-integration-envelope.decorator.js.map +1 -0
- package/dist/nestjs/integration-webhooks/index.d.ts +5 -0
- package/dist/nestjs/integration-webhooks/index.d.ts.map +1 -0
- package/dist/nestjs/integration-webhooks/index.js +10 -0
- package/dist/nestjs/integration-webhooks/index.js.map +1 -0
- package/dist/nestjs/integration-webhooks/integration-envelope.pipe.d.ts +9 -0
- package/dist/nestjs/integration-webhooks/integration-envelope.pipe.d.ts.map +1 -0
- package/dist/nestjs/integration-webhooks/integration-envelope.pipe.js +100 -0
- package/dist/nestjs/integration-webhooks/integration-envelope.pipe.js.map +1 -0
- package/dist/nestjs/integration-webhooks/integration-envelope.types.d.ts +7 -0
- package/dist/nestjs/integration-webhooks/integration-envelope.types.d.ts.map +1 -0
- package/dist/nestjs/integration-webhooks/integration-envelope.types.js +3 -0
- package/dist/nestjs/integration-webhooks/integration-envelope.types.js.map +1 -0
- package/dist/nestjs/integration-webhooks/integration-webhook-envelope.dto.d.ts +14 -0
- package/dist/nestjs/integration-webhooks/integration-webhook-envelope.dto.d.ts.map +1 -0
- package/dist/nestjs/integration-webhooks/integration-webhook-envelope.dto.js +97 -0
- package/dist/nestjs/integration-webhooks/integration-webhook-envelope.dto.js.map +1 -0
- package/dist/nestjs/jwks/jwks-verifier.d.ts +48 -0
- package/dist/nestjs/jwks/jwks-verifier.d.ts.map +1 -0
- package/dist/nestjs/jwks/jwks-verifier.js +177 -0
- package/dist/nestjs/jwks/jwks-verifier.js.map +1 -0
- package/dist/nestjs/jwt-verification.guard.d.ts +25 -0
- package/dist/nestjs/jwt-verification.guard.d.ts.map +1 -0
- package/dist/nestjs/jwt-verification.guard.js +232 -0
- package/dist/nestjs/jwt-verification.guard.js.map +1 -0
- package/dist/nestjs/openapi-docs.enricher.d.ts +6 -0
- package/dist/nestjs/openapi-docs.enricher.d.ts.map +1 -0
- package/dist/nestjs/openapi-docs.enricher.js +296 -0
- package/dist/nestjs/openapi-docs.enricher.js.map +1 -0
- package/dist/nestjs/pagination.d.ts +25 -0
- package/dist/nestjs/pagination.d.ts.map +1 -0
- package/dist/nestjs/pagination.js +73 -0
- package/dist/nestjs/pagination.js.map +1 -0
- package/dist/nestjs/public.decorator.d.ts +3 -0
- package/dist/nestjs/public.decorator.d.ts.map +1 -0
- package/dist/nestjs/public.decorator.js +8 -0
- package/dist/nestjs/public.decorator.js.map +1 -0
- package/dist/nestjs/raw-response.decorator.d.ts +3 -0
- package/dist/nestjs/raw-response.decorator.d.ts.map +1 -0
- package/dist/nestjs/raw-response.decorator.js +8 -0
- package/dist/nestjs/raw-response.decorator.js.map +1 -0
- package/dist/nestjs/request-context.middleware.d.ts +27 -0
- package/dist/nestjs/request-context.middleware.d.ts.map +1 -0
- package/dist/nestjs/request-context.middleware.js +252 -0
- package/dist/nestjs/request-context.middleware.js.map +1 -0
- package/dist/nestjs/require-pipeline-run-id.d.ts +3 -0
- package/dist/nestjs/require-pipeline-run-id.d.ts.map +1 -0
- package/dist/nestjs/require-pipeline-run-id.js +11 -0
- package/dist/nestjs/require-pipeline-run-id.js.map +1 -0
- package/dist/nestjs/require-project-id.d.ts +3 -0
- package/dist/nestjs/require-project-id.d.ts.map +1 -0
- package/dist/nestjs/require-project-id.js +11 -0
- package/dist/nestjs/require-project-id.js.map +1 -0
- package/dist/nestjs/response-envelope.interceptor.d.ts +6 -0
- package/dist/nestjs/response-envelope.interceptor.d.ts.map +1 -0
- package/dist/nestjs/response-envelope.interceptor.js +48 -0
- package/dist/nestjs/response-envelope.interceptor.js.map +1 -0
- package/dist/nestjs/roles.decorator.d.ts +3 -0
- package/dist/nestjs/roles.decorator.d.ts.map +1 -0
- package/dist/nestjs/roles.decorator.js +8 -0
- package/dist/nestjs/roles.decorator.js.map +1 -0
- package/dist/nestjs/roles.guard.d.ts +6 -0
- package/dist/nestjs/roles.guard.d.ts.map +1 -0
- package/dist/nestjs/roles.guard.js +41 -0
- package/dist/nestjs/roles.guard.js.map +1 -0
- package/dist/nestjs/swagger-keycloak.d.ts +30 -0
- package/dist/nestjs/swagger-keycloak.d.ts.map +1 -0
- package/dist/nestjs/swagger-keycloak.js +75 -0
- package/dist/nestjs/swagger-keycloak.js.map +1 -0
- package/dist/nestjs/swagger.decorators.d.ts +8 -0
- package/dist/nestjs/swagger.decorators.d.ts.map +1 -0
- package/dist/nestjs/swagger.decorators.js +117 -0
- package/dist/nestjs/swagger.decorators.js.map +1 -0
- package/dist/schemas/xema/analysis.json +51 -0
- package/dist/schemas/xema/clarification-contract.json +49 -0
- package/dist/schemas/xema/context.json +79 -0
- package/dist/schemas/xema/index.d.ts +8 -0
- package/dist/schemas/xema/index.d.ts.map +1 -0
- package/dist/schemas/xema/index.js +30 -0
- package/dist/schemas/xema/index.js.map +1 -0
- package/dist/schemas/xema/manifest.json +32 -0
- package/dist/schemas/xema/review-history.json +42 -0
- package/package.json +76 -0
|
@@ -0,0 +1,232 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
12
|
+
return function (target, key) { decorator(target, key, paramIndex); }
|
|
13
|
+
};
|
|
14
|
+
var JwtVerificationGuard_1;
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.JwtVerificationGuard = void 0;
|
|
17
|
+
const common_1 = require("@nestjs/common");
|
|
18
|
+
const decorator_metadata_1 = require("./decorator-metadata");
|
|
19
|
+
const public_decorator_1 = require("./public.decorator");
|
|
20
|
+
const auth_module_options_1 = require("./auth/auth-module-options");
|
|
21
|
+
const request_context_1 = require("../lib/request-context");
|
|
22
|
+
const jwks_verifier_1 = require("./jwks/jwks-verifier");
|
|
23
|
+
const PUBLIC_PATH_PREFIXES = ['/health', '/api/docs', '/api/openapi.json'];
|
|
24
|
+
const PUBLIC_WEBHOOK_PREFIX = '/webhooks';
|
|
25
|
+
let JwtVerificationGuard = class JwtVerificationGuard {
|
|
26
|
+
static { JwtVerificationGuard_1 = this; }
|
|
27
|
+
authOptions;
|
|
28
|
+
logger = new common_1.Logger(JwtVerificationGuard_1.name);
|
|
29
|
+
jwks = new jwks_verifier_1.JwksVerifier(600_000);
|
|
30
|
+
static SINGLE_REALM_CACHE_KEY = '__single__';
|
|
31
|
+
multiRealmConfig = null;
|
|
32
|
+
resolvingConfig = null;
|
|
33
|
+
constructor(authOptions) {
|
|
34
|
+
this.authOptions = authOptions;
|
|
35
|
+
}
|
|
36
|
+
async canActivate(context) {
|
|
37
|
+
const isPublic = (0, decorator_metadata_1.readDecoratorOverride)(public_decorator_1.IS_PUBLIC_KEY, [
|
|
38
|
+
context.getHandler(),
|
|
39
|
+
context.getClass(),
|
|
40
|
+
]);
|
|
41
|
+
if (isPublic)
|
|
42
|
+
return true;
|
|
43
|
+
const request = context.switchToHttp().getRequest();
|
|
44
|
+
const path = request.path ?? request.url?.split('?')[0] ?? '';
|
|
45
|
+
if (this.isPublicPath(path))
|
|
46
|
+
return true;
|
|
47
|
+
const authHeader = request.headers.authorization;
|
|
48
|
+
if (!authHeader?.startsWith('Bearer ')) {
|
|
49
|
+
throw new common_1.UnauthorizedException('Missing or invalid Authorization header');
|
|
50
|
+
}
|
|
51
|
+
const token = authHeader.substring(7);
|
|
52
|
+
try {
|
|
53
|
+
const payload = await this.verifyToken(token);
|
|
54
|
+
this.attachRealmToContext(request, payload);
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
catch (error) {
|
|
58
|
+
if (error instanceof common_1.UnauthorizedException)
|
|
59
|
+
throw error;
|
|
60
|
+
const msg = error instanceof Error ? error.message : String(error);
|
|
61
|
+
this.logger.error({ message: 'JWT verification failed', error: msg });
|
|
62
|
+
throw new common_1.UnauthorizedException('Invalid token');
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
async verifyToken(token) {
|
|
66
|
+
const { payload } = this.decodeOrThrow(token);
|
|
67
|
+
const multiRealm = await this.resolveMultiRealmConfig();
|
|
68
|
+
if (multiRealm) {
|
|
69
|
+
await this.verifyMultiRealm(token, payload, multiRealm);
|
|
70
|
+
}
|
|
71
|
+
else {
|
|
72
|
+
await this.verifySingleRealm(token, payload);
|
|
73
|
+
}
|
|
74
|
+
return payload;
|
|
75
|
+
}
|
|
76
|
+
decodeOrThrow(token) {
|
|
77
|
+
try {
|
|
78
|
+
return this.jwks.decode(token);
|
|
79
|
+
}
|
|
80
|
+
catch (error) {
|
|
81
|
+
if (error instanceof jwks_verifier_1.JwksVerificationError) {
|
|
82
|
+
throw new common_1.UnauthorizedException(error.message);
|
|
83
|
+
}
|
|
84
|
+
throw error;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
async verifyWithJwks(token, cacheKey, jwksUrl) {
|
|
88
|
+
try {
|
|
89
|
+
await this.jwks.verify(token, { cacheKey, jwksUrl });
|
|
90
|
+
}
|
|
91
|
+
catch (error) {
|
|
92
|
+
if (error instanceof jwks_verifier_1.JwksVerificationError) {
|
|
93
|
+
throw new common_1.UnauthorizedException(error.message);
|
|
94
|
+
}
|
|
95
|
+
throw error;
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
async verifyMultiRealm(token, payload, config) {
|
|
99
|
+
if (!payload.iss) {
|
|
100
|
+
throw new common_1.UnauthorizedException('Token missing required issuer claim');
|
|
101
|
+
}
|
|
102
|
+
const realmName = this.extractRealmFromIssuer(payload.iss);
|
|
103
|
+
if (!realmName) {
|
|
104
|
+
throw new common_1.UnauthorizedException('Cannot determine realm from token issuer');
|
|
105
|
+
}
|
|
106
|
+
if (!config.allowedRealms.has(realmName)) {
|
|
107
|
+
throw new common_1.UnauthorizedException(`Realm '${realmName}' is not allowed`);
|
|
108
|
+
}
|
|
109
|
+
const validIssuers = config.keycloakBaseUrls.map((base) => `${base}/realms/${realmName}`);
|
|
110
|
+
if (!validIssuers.includes(payload.iss) && !payload.iss.endsWith(`/realms/${realmName}`)) {
|
|
111
|
+
throw new common_1.UnauthorizedException('Invalid token issuer');
|
|
112
|
+
}
|
|
113
|
+
const jwksUrl = `${config.keycloakBaseUrls[0]}/realms/${realmName}/protocol/openid-connect/certs`;
|
|
114
|
+
await this.verifyWithJwks(token, realmName, jwksUrl);
|
|
115
|
+
}
|
|
116
|
+
async verifySingleRealm(token, payload) {
|
|
117
|
+
const expectedIssuer = this.authOptions?.issuer;
|
|
118
|
+
if (expectedIssuer) {
|
|
119
|
+
if (!payload.iss) {
|
|
120
|
+
throw new common_1.UnauthorizedException('Token missing required issuer claim');
|
|
121
|
+
}
|
|
122
|
+
const allowedIssuers = expectedIssuer.split(',').map((s) => s.trim());
|
|
123
|
+
const realmSuffixes = [
|
|
124
|
+
...new Set(allowedIssuers.map((iss) => {
|
|
125
|
+
const match = iss.match(/(\/realms\/[^/]+)$/);
|
|
126
|
+
return match?.[1];
|
|
127
|
+
}).filter(Boolean)),
|
|
128
|
+
];
|
|
129
|
+
const issuerMatched = allowedIssuers.includes(payload.iss) ||
|
|
130
|
+
realmSuffixes.some((suffix) => payload.iss.endsWith(suffix));
|
|
131
|
+
if (!issuerMatched) {
|
|
132
|
+
throw new common_1.UnauthorizedException('Invalid token issuer');
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
const jwksUrl = this.authOptions?.jwksUrl;
|
|
136
|
+
if (!jwksUrl) {
|
|
137
|
+
throw new Error('AuthModule jwksUrl is not configured');
|
|
138
|
+
}
|
|
139
|
+
await this.verifyWithJwks(token, JwtVerificationGuard_1.SINGLE_REALM_CACHE_KEY, jwksUrl);
|
|
140
|
+
}
|
|
141
|
+
async resolveMultiRealmConfig() {
|
|
142
|
+
if (this.multiRealmConfig)
|
|
143
|
+
return this.multiRealmConfig;
|
|
144
|
+
if (this.resolvingConfig)
|
|
145
|
+
return this.resolvingConfig;
|
|
146
|
+
this.resolvingConfig = (async () => {
|
|
147
|
+
try {
|
|
148
|
+
const keycloakBaseUrl = await this.resolveKeycloakBaseUrl();
|
|
149
|
+
const allowedRealmsRaw = await this.resolveAllowedRealms();
|
|
150
|
+
if (keycloakBaseUrl && allowedRealmsRaw.length > 0) {
|
|
151
|
+
const keycloakBaseUrls = keycloakBaseUrl
|
|
152
|
+
.split(',')
|
|
153
|
+
.map((s) => s.trim().replace(/\/$/, ''));
|
|
154
|
+
this.appendIssuerBaseUrls(keycloakBaseUrls);
|
|
155
|
+
this.multiRealmConfig = {
|
|
156
|
+
keycloakBaseUrls,
|
|
157
|
+
allowedRealms: new Set(allowedRealmsRaw),
|
|
158
|
+
};
|
|
159
|
+
this.logger.log(`Multi-realm mode enabled: realms=[${allowedRealmsRaw.join(', ')}], base URLs=[${keycloakBaseUrls.join(', ')}]`);
|
|
160
|
+
return this.multiRealmConfig;
|
|
161
|
+
}
|
|
162
|
+
return null;
|
|
163
|
+
}
|
|
164
|
+
finally {
|
|
165
|
+
this.resolvingConfig = null;
|
|
166
|
+
}
|
|
167
|
+
})();
|
|
168
|
+
return this.resolvingConfig;
|
|
169
|
+
}
|
|
170
|
+
async resolveKeycloakBaseUrl() {
|
|
171
|
+
if (this.authOptions?.keycloakBaseUrl)
|
|
172
|
+
return this.authOptions.keycloakBaseUrl;
|
|
173
|
+
if (this.authOptions?.keycloakBaseUrlProvider) {
|
|
174
|
+
return (await this.authOptions.keycloakBaseUrlProvider()) ?? undefined;
|
|
175
|
+
}
|
|
176
|
+
return undefined;
|
|
177
|
+
}
|
|
178
|
+
async resolveAllowedRealms() {
|
|
179
|
+
if (this.authOptions?.allowedRealms && this.authOptions.allowedRealms.length > 0) {
|
|
180
|
+
return this.authOptions.allowedRealms;
|
|
181
|
+
}
|
|
182
|
+
if (this.authOptions?.allowedRealmsProvider) {
|
|
183
|
+
return await this.authOptions.allowedRealmsProvider();
|
|
184
|
+
}
|
|
185
|
+
return [];
|
|
186
|
+
}
|
|
187
|
+
appendIssuerBaseUrls(keycloakBaseUrls) {
|
|
188
|
+
const issuerRaw = this.authOptions?.issuer;
|
|
189
|
+
if (!issuerRaw)
|
|
190
|
+
return;
|
|
191
|
+
for (const iss of issuerRaw.split(',').map((s) => s.trim())) {
|
|
192
|
+
const base = iss.replace(/\/realms\/[^/]+$/, '');
|
|
193
|
+
if (base && !keycloakBaseUrls.includes(base)) {
|
|
194
|
+
keycloakBaseUrls.push(base);
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
extractRealmFromIssuer(issuer) {
|
|
199
|
+
const match = issuer.match(/\/realms\/([^/]+)$/);
|
|
200
|
+
return match?.[1] ?? null;
|
|
201
|
+
}
|
|
202
|
+
attachRealmToContext(request, payload) {
|
|
203
|
+
if (!payload.iss)
|
|
204
|
+
return;
|
|
205
|
+
const realmName = this.extractRealmFromIssuer(payload.iss);
|
|
206
|
+
if (!realmName)
|
|
207
|
+
return;
|
|
208
|
+
const ctx = request[request_context_1.REQUEST_CONTEXT];
|
|
209
|
+
if (ctx) {
|
|
210
|
+
ctx.realmId = realmName;
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
isPublicPath(path) {
|
|
214
|
+
for (const prefix of PUBLIC_PATH_PREFIXES) {
|
|
215
|
+
if (path === prefix || path.startsWith(prefix + '/'))
|
|
216
|
+
return true;
|
|
217
|
+
}
|
|
218
|
+
if (path === PUBLIC_WEBHOOK_PREFIX ||
|
|
219
|
+
path.startsWith(PUBLIC_WEBHOOK_PREFIX + '/')) {
|
|
220
|
+
return true;
|
|
221
|
+
}
|
|
222
|
+
return false;
|
|
223
|
+
}
|
|
224
|
+
};
|
|
225
|
+
exports.JwtVerificationGuard = JwtVerificationGuard;
|
|
226
|
+
exports.JwtVerificationGuard = JwtVerificationGuard = JwtVerificationGuard_1 = __decorate([
|
|
227
|
+
(0, common_1.Injectable)(),
|
|
228
|
+
__param(0, (0, common_1.Optional)()),
|
|
229
|
+
__param(0, (0, common_1.Inject)(auth_module_options_1.AUTH_MODULE_OPTIONS)),
|
|
230
|
+
__metadata("design:paramtypes", [Object])
|
|
231
|
+
], JwtVerificationGuard);
|
|
232
|
+
//# sourceMappingURL=jwt-verification.guard.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jwt-verification.guard.js","sourceRoot":"","sources":["../../src/nestjs/jwt-verification.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAQwB;AACxB,6DAA6D;AAE7D,yDAAmD;AACnD,oEAAiE;AAEjE,4DAAyD;AAEzD,wDAA2E;AAa3E,MAAM,oBAAoB,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC;AAC3E,MAAM,qBAAqB,GAAG,WAAW,CAAC;AAyBnC,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;;IA6BZ;IA5BF,MAAM,GAAG,IAAI,eAAM,CAAC,sBAAoB,CAAC,IAAI,CAAC,CAAC;IAS/C,IAAI,GAAG,IAAI,4BAAY,CAAC,OAAO,CAAC,CAAC;IAG1C,MAAM,CAAU,sBAAsB,GAAG,YAAY,CAAC;IAGtD,gBAAgB,GAGb,IAAI,CAAC;IAER,eAAe,GAGJ,IAAI,CAAC;IAExB,YAGmB,WAA+B;QAA/B,gBAAW,GAAX,WAAW,CAAoB;IAC/C,CAAC;IAEJ,KAAK,CAAC,WAAW,CAAC,OAAyB;QAEzC,MAAM,QAAQ,GAAG,IAAA,0CAAqB,EAAU,gCAAa,EAAE;YAC7D,OAAO,CAAC,UAAU,EAAE;YACpB,OAAO,CAAC,QAAQ,EAAE;SACnB,CAAC,CAAC;QACH,IAAI,QAAQ;YAAE,OAAO,IAAI,CAAC;QAE1B,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAW,CAAC;QAG7D,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9D,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;QAEzC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;QAEjD,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,8BAAqB,CAC7B,yCAAyC,CAC1C,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAEtC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAG9C,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAE5C,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,8BAAqB;gBAAE,MAAM,KAAK,CAAC;YAExD,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YACtE,MAAM,IAAI,8BAAqB,CAAC,eAAe,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,KAAa;QACrC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAE9C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAExD,IAAI,UAAU,EAAE,CAAC;YAEf,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YAEN,MAAM,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAQO,aAAa,CAAC,KAAa;QAIjC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,qCAAqB,EAAE,CAAC;gBAC3C,MAAM,IAAI,8BAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACjD,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAOO,KAAK,CAAC,cAAc,CAC1B,KAAa,EACb,QAAgB,EAChB,OAAe;QAEf,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QACvD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,qCAAqB,EAAE,CAAC;gBAC3C,MAAM,IAAI,8BAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACjD,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAC5B,KAAa,EACb,OAAmB,EACnB,MAAkE;QAElE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACjB,MAAM,IAAI,8BAAqB,CAAC,qCAAqC,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3D,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,8BAAqB,CAC7B,0CAA0C,CAC3C,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,8BAAqB,CAAC,UAAU,SAAS,kBAAkB,CAAC,CAAC;QACzE,CAAC;QAKD,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAC9C,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,WAAW,SAAS,EAAE,CACxC,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,SAAS,EAAE,CAAC,EAAE,CAAC;YACzF,MAAM,IAAI,8BAAqB,CAAC,sBAAsB,CAAC,CAAC;QAC1D,CAAC;QAGD,MAAM,OAAO,GAAG,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,SAAS,gCAAgC,CAAC;QAElG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC7B,KAAa,EACb,OAAmB;QAGnB,MAAM,cAAc,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC;QAChD,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;gBACjB,MAAM,IAAI,8BAAqB,CAAC,qCAAqC,CAAC,CAAC;YACzE,CAAC;YACD,MAAM,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAGtE,MAAM,aAAa,GAAG;gBACpB,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;oBACpC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;oBAC9C,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;gBACpB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;aACpB,CAAC;YACF,MAAM,aAAa,GACjB,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC;gBACpC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,GAAI,CAAC,QAAQ,CAAC,MAAO,CAAC,CAAC,CAAC;YACjE,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,8BAAqB,CAAC,sBAAsB,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;QAGD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC;QAC1C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,CAAC,cAAc,CACvB,KAAK,EACL,sBAAoB,CAAC,sBAAsB,EAC3C,OAAO,CACR,CAAC;IACJ,CAAC;IAIO,KAAK,CAAC,uBAAuB;QAKnC,IAAI,IAAI,CAAC,gBAAgB;YAAE,OAAO,IAAI,CAAC,gBAAgB,CAAC;QAGxD,IAAI,IAAI,CAAC,eAAe;YAAE,OAAO,IAAI,CAAC,eAAe,CAAC;QAEtD,IAAI,CAAC,eAAe,GAAG,CAAC,KAAK,IAAI,EAAE;YACjC,IAAI,CAAC;gBACH,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAC5D,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAE3D,IAAI,eAAe,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACnD,MAAM,gBAAgB,GAAG,eAAe;yBACrC,KAAK,CAAC,GAAG,CAAC;yBACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;oBAE3C,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;oBAE5C,IAAI,CAAC,gBAAgB,GAAG;wBACtB,gBAAgB;wBAChB,aAAa,EAAE,IAAI,GAAG,CAAC,gBAAgB,CAAC;qBACzC,CAAC;oBACF,IAAI,CAAC,MAAM,CAAC,GAAG,CACb,qCAAqC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAChH,CAAC;oBACF,OAAO,IAAI,CAAC,gBAAgB,CAAC;gBAC/B,CAAC;gBAKD,OAAO,IAAI,CAAC;YACd,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;YAC9B,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;QAEL,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAEO,KAAK,CAAC,sBAAsB;QAClC,IAAI,IAAI,CAAC,WAAW,EAAE,eAAe;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC;QAC/E,IAAI,IAAI,CAAC,WAAW,EAAE,uBAAuB,EAAE,CAAC;YAC9C,OAAO,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,CAAC,IAAI,SAAS,CAAC;QACzE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,oBAAoB;QAChC,IAAI,IAAI,CAAC,WAAW,EAAE,aAAa,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjF,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC;QACxC,CAAC;QACD,IAAI,IAAI,CAAC,WAAW,EAAE,qBAAqB,EAAE,CAAC;YAC5C,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,CAAC;QACxD,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAMO,oBAAoB,CAAC,gBAA0B;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC;QAC3C,IAAI,CAAC,SAAS;YAAE,OAAO;QACvB,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;YACjD,IAAI,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7C,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;IACH,CAAC;IAIO,sBAAsB,CAAC,MAAc;QAE3C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACjD,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IAC5B,CAAC;IAEO,oBAAoB,CAAC,OAAgB,EAAE,OAAmB;QAChE,IAAI,CAAC,OAAO,CAAC,GAAG;YAAE,OAAO;QACzB,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3D,IAAI,CAAC,SAAS;YAAE,OAAO;QAEvB,MAAM,GAAG,GAAI,OAA8C,CACzD,iCAAe,CACc,CAAC;QAChC,IAAI,GAAG,EAAE,CAAC;YACR,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC;QAC1B,CAAC;IACH,CAAC;IAEO,YAAY,CAAC,IAAY;QAC/B,KAAK,MAAM,MAAM,IAAI,oBAAoB,EAAE,CAAC;YAC1C,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAC;QACpE,CAAC;QACD,IACE,IAAI,KAAK,qBAAqB;YAC9B,IAAI,CAAC,UAAU,CAAC,qBAAqB,GAAG,GAAG,CAAC,EAC5C,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;;AA3TU,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;IA4BR,WAAA,IAAA,iBAAQ,GAAE,CAAA;IACV,WAAA,IAAA,eAAM,EAAC,yCAAmB,CAAC,CAAA;;GA5BnB,oBAAoB,CA4ThC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-docs.enricher.d.ts","sourceRoot":"","sources":["../../src/nestjs/openapi-docs.enricher.ts"],"names":[],"mappings":"AA8DA,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAqVD,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAE,wBAAwB,GAChC,IAAI,CAkBN"}
|
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.enhanceOpenApiDocumentation = enhanceOpenApiDocumentation;
|
|
4
|
+
const HTTP_METHODS = [
|
|
5
|
+
'get',
|
|
6
|
+
'put',
|
|
7
|
+
'post',
|
|
8
|
+
'delete',
|
|
9
|
+
'options',
|
|
10
|
+
'head',
|
|
11
|
+
'patch',
|
|
12
|
+
'trace',
|
|
13
|
+
];
|
|
14
|
+
const FIELD_EXAMPLE_BY_NAME = {
|
|
15
|
+
id: 'a3f84c60-40f9-4a9b-9f38-4a3db5f5d266',
|
|
16
|
+
orgId: 'org_4f2f9d8c',
|
|
17
|
+
organizationId: 'org_4f2f9d8c',
|
|
18
|
+
projectId: 'proj_8ac1f2d0',
|
|
19
|
+
pipelineRunId: 'run_7f8d5a21',
|
|
20
|
+
groupKey: 'implementation',
|
|
21
|
+
phaseKey: 'implementation',
|
|
22
|
+
status: 'active',
|
|
23
|
+
createdAt: '2026-04-07T12:00:00.000Z',
|
|
24
|
+
updatedAt: '2026-04-07T12:00:00.000Z',
|
|
25
|
+
deletedAt: '2026-04-07T12:00:00.000Z',
|
|
26
|
+
email: 'developer@example.com',
|
|
27
|
+
url: 'https://example.com/webhook',
|
|
28
|
+
webhookUrl: 'https://example.com/webhook',
|
|
29
|
+
name: 'Example Name',
|
|
30
|
+
title: 'Example Title',
|
|
31
|
+
slug: 'example-slug',
|
|
32
|
+
key: 'example_key',
|
|
33
|
+
description: 'Example description for this field.',
|
|
34
|
+
content: 'Example content payload',
|
|
35
|
+
};
|
|
36
|
+
function wordsFromIdentifier(value) {
|
|
37
|
+
return value
|
|
38
|
+
.replaceAll('{', '')
|
|
39
|
+
.replaceAll('}', '')
|
|
40
|
+
.replaceAll(/([a-z])([A-Z])/g, '$1 $2')
|
|
41
|
+
.split(/[_\-\s/]+/)
|
|
42
|
+
.map((part) => part.trim())
|
|
43
|
+
.filter(Boolean);
|
|
44
|
+
}
|
|
45
|
+
function toSentenceCase(value) {
|
|
46
|
+
if (!value)
|
|
47
|
+
return value;
|
|
48
|
+
return value.charAt(0).toUpperCase() + value.slice(1);
|
|
49
|
+
}
|
|
50
|
+
function humanize(value) {
|
|
51
|
+
return wordsFromIdentifier(value)
|
|
52
|
+
.map((word) => word.toLowerCase())
|
|
53
|
+
.join(' ');
|
|
54
|
+
}
|
|
55
|
+
function toPascalCase(value) {
|
|
56
|
+
return wordsFromIdentifier(value)
|
|
57
|
+
.map((word) => toSentenceCase(word.toLowerCase()))
|
|
58
|
+
.join('');
|
|
59
|
+
}
|
|
60
|
+
function nonPathSegments(path) {
|
|
61
|
+
return path
|
|
62
|
+
.split('/')
|
|
63
|
+
.map((segment) => segment.trim())
|
|
64
|
+
.filter((segment) => Boolean(segment) && !segment.startsWith('{'));
|
|
65
|
+
}
|
|
66
|
+
function getPrimaryResource(path) {
|
|
67
|
+
const segments = nonPathSegments(path);
|
|
68
|
+
if (segments.length === 0)
|
|
69
|
+
return 'resource';
|
|
70
|
+
return humanize(segments.at(-1) ?? 'resource');
|
|
71
|
+
}
|
|
72
|
+
function operationSummary(method, path) {
|
|
73
|
+
const resource = getPrimaryResource(path);
|
|
74
|
+
const hasPathParam = path.includes('{');
|
|
75
|
+
if (method === 'get') {
|
|
76
|
+
return hasPathParam
|
|
77
|
+
? `Get ${resource} by identifier`
|
|
78
|
+
: `List ${resource}`;
|
|
79
|
+
}
|
|
80
|
+
if (method === 'post') {
|
|
81
|
+
return `Create ${resource}`;
|
|
82
|
+
}
|
|
83
|
+
if (method === 'put') {
|
|
84
|
+
return `Replace ${resource}`;
|
|
85
|
+
}
|
|
86
|
+
if (method === 'patch') {
|
|
87
|
+
return `Update ${resource}`;
|
|
88
|
+
}
|
|
89
|
+
if (method === 'delete') {
|
|
90
|
+
return `Delete ${resource}`;
|
|
91
|
+
}
|
|
92
|
+
return `${method.toUpperCase()} ${resource}`;
|
|
93
|
+
}
|
|
94
|
+
function operationDescription(method, path, serviceName) {
|
|
95
|
+
const summary = operationSummary(method, path);
|
|
96
|
+
return (`${summary} in ${serviceName}. ` +
|
|
97
|
+
'This endpoint is fully documented with request and response schemas, ' +
|
|
98
|
+
'including concrete examples to help consumers integrate correctly. ');
|
|
99
|
+
}
|
|
100
|
+
function defaultTagForPath(path) {
|
|
101
|
+
const segments = nonPathSegments(path);
|
|
102
|
+
if (segments.length === 0)
|
|
103
|
+
return 'General';
|
|
104
|
+
return toPascalCase(segments[0]);
|
|
105
|
+
}
|
|
106
|
+
function inferStringExample(schema) {
|
|
107
|
+
if (schema.format === 'date-time')
|
|
108
|
+
return '2026-04-07T12:00:00.000Z';
|
|
109
|
+
if (schema.format === 'date')
|
|
110
|
+
return '2026-04-07';
|
|
111
|
+
if (schema.format === 'uuid')
|
|
112
|
+
return 'a3f84c60-40f9-4a9b-9f38-4a3db5f5d266';
|
|
113
|
+
if (schema.format === 'email')
|
|
114
|
+
return 'developer@example.com';
|
|
115
|
+
if (schema.format === 'uri')
|
|
116
|
+
return 'https://example.com/resource';
|
|
117
|
+
return 'example-value';
|
|
118
|
+
}
|
|
119
|
+
function inferPrimitiveExample(propertyName, schema) {
|
|
120
|
+
if (schema.example !== undefined)
|
|
121
|
+
return schema.example;
|
|
122
|
+
if (schema.default !== undefined)
|
|
123
|
+
return schema.default;
|
|
124
|
+
if (schema.enum && schema.enum.length > 0)
|
|
125
|
+
return schema.enum[0];
|
|
126
|
+
if (FIELD_EXAMPLE_BY_NAME[propertyName] !== undefined) {
|
|
127
|
+
return FIELD_EXAMPLE_BY_NAME[propertyName];
|
|
128
|
+
}
|
|
129
|
+
if (schema.type === 'string') {
|
|
130
|
+
return inferStringExample(schema);
|
|
131
|
+
}
|
|
132
|
+
if (schema.type === 'integer' || schema.type === 'number')
|
|
133
|
+
return 1;
|
|
134
|
+
if (schema.type === 'boolean')
|
|
135
|
+
return true;
|
|
136
|
+
return null;
|
|
137
|
+
}
|
|
138
|
+
function buildSchemaExample(schema, propertyName = 'value') {
|
|
139
|
+
if (!schema)
|
|
140
|
+
return null;
|
|
141
|
+
if (schema.$ref)
|
|
142
|
+
return { reference: schema.$ref };
|
|
143
|
+
if (Array.isArray(schema.oneOf) && schema.oneOf.length > 0) {
|
|
144
|
+
return buildSchemaExample(schema.oneOf[0], propertyName);
|
|
145
|
+
}
|
|
146
|
+
if (Array.isArray(schema.anyOf) && schema.anyOf.length > 0) {
|
|
147
|
+
return buildSchemaExample(schema.anyOf[0], propertyName);
|
|
148
|
+
}
|
|
149
|
+
if (Array.isArray(schema.allOf) && schema.allOf.length > 0) {
|
|
150
|
+
const merged = {};
|
|
151
|
+
schema.allOf.forEach((part) => {
|
|
152
|
+
const value = buildSchemaExample(part, propertyName);
|
|
153
|
+
if (value && typeof value === 'object' && !Array.isArray(value)) {
|
|
154
|
+
Object.assign(merged, value);
|
|
155
|
+
}
|
|
156
|
+
});
|
|
157
|
+
return Object.keys(merged).length > 0 ? merged : null;
|
|
158
|
+
}
|
|
159
|
+
if (schema.type === 'array') {
|
|
160
|
+
return [buildSchemaExample(schema.items, propertyName)];
|
|
161
|
+
}
|
|
162
|
+
if (schema.type === 'object' || schema.properties) {
|
|
163
|
+
const result = {};
|
|
164
|
+
const properties = schema.properties ?? {};
|
|
165
|
+
Object.entries(properties).forEach(([key, propertySchema]) => {
|
|
166
|
+
result[key] = buildSchemaExample(propertySchema, key);
|
|
167
|
+
});
|
|
168
|
+
if (Object.keys(result).length === 0 &&
|
|
169
|
+
schema.additionalProperties &&
|
|
170
|
+
typeof schema.additionalProperties === 'object') {
|
|
171
|
+
result.exampleKey = buildSchemaExample(schema.additionalProperties, 'exampleKey');
|
|
172
|
+
}
|
|
173
|
+
return result;
|
|
174
|
+
}
|
|
175
|
+
return inferPrimitiveExample(propertyName, schema);
|
|
176
|
+
}
|
|
177
|
+
function enrichSchemas(document) {
|
|
178
|
+
const schemas = document.components?.schemas;
|
|
179
|
+
if (!schemas)
|
|
180
|
+
return;
|
|
181
|
+
Object.entries(schemas).forEach(([schemaName, schema]) => {
|
|
182
|
+
const properties = schema.properties;
|
|
183
|
+
if (!properties)
|
|
184
|
+
return;
|
|
185
|
+
Object.entries(properties).forEach(([propertyName, propertySchema]) => {
|
|
186
|
+
if (!propertySchema.description) {
|
|
187
|
+
propertySchema.description =
|
|
188
|
+
`The ${humanize(propertyName)} for ${humanize(schemaName)}.`;
|
|
189
|
+
}
|
|
190
|
+
if (propertySchema.example === undefined) {
|
|
191
|
+
propertySchema.example = buildSchemaExample(propertySchema, propertyName);
|
|
192
|
+
}
|
|
193
|
+
});
|
|
194
|
+
});
|
|
195
|
+
}
|
|
196
|
+
function ensureTagDescriptions(document) {
|
|
197
|
+
const tags = (document.tags ??= []);
|
|
198
|
+
const known = new Set(tags.map((tag) => tag.name));
|
|
199
|
+
Object.entries(document.paths ?? {}).forEach(([path, pathItem]) => {
|
|
200
|
+
HTTP_METHODS.forEach((method) => {
|
|
201
|
+
const operation = pathItem[method];
|
|
202
|
+
if (!operation)
|
|
203
|
+
return;
|
|
204
|
+
if (!operation.tags || operation.tags.length === 0) {
|
|
205
|
+
operation.tags = [defaultTagForPath(path)];
|
|
206
|
+
}
|
|
207
|
+
operation.tags.forEach((tagName) => {
|
|
208
|
+
if (known.has(tagName))
|
|
209
|
+
return;
|
|
210
|
+
tags.push({
|
|
211
|
+
name: tagName,
|
|
212
|
+
description: `${tagName} endpoints in this service API.`,
|
|
213
|
+
});
|
|
214
|
+
known.add(tagName);
|
|
215
|
+
});
|
|
216
|
+
});
|
|
217
|
+
});
|
|
218
|
+
document.tags = tags.map((tag) => {
|
|
219
|
+
if (tag.description)
|
|
220
|
+
return tag;
|
|
221
|
+
return {
|
|
222
|
+
...tag,
|
|
223
|
+
description: `${tag.name} endpoints in this service API.`,
|
|
224
|
+
};
|
|
225
|
+
});
|
|
226
|
+
}
|
|
227
|
+
function enrichOperations(document, options) {
|
|
228
|
+
Object.entries(document.paths ?? {}).forEach(([path, pathItem]) => {
|
|
229
|
+
HTTP_METHODS.forEach((method) => {
|
|
230
|
+
const operation = pathItem[method];
|
|
231
|
+
if (!operation)
|
|
232
|
+
return;
|
|
233
|
+
if (!operation.summary) {
|
|
234
|
+
operation.summary = operationSummary(method, path);
|
|
235
|
+
}
|
|
236
|
+
if (!operation.description) {
|
|
237
|
+
operation.description = operationDescription(method, path, options.serviceName);
|
|
238
|
+
}
|
|
239
|
+
if (!operation.operationId) {
|
|
240
|
+
const resource = toPascalCase(getPrimaryResource(path));
|
|
241
|
+
operation.operationId = `${method}${resource}`;
|
|
242
|
+
}
|
|
243
|
+
const requestBody = operation.requestBody;
|
|
244
|
+
const requestBodyContent = requestBody?.content;
|
|
245
|
+
if (!requestBodyContent)
|
|
246
|
+
return;
|
|
247
|
+
Object.values(requestBodyContent).forEach((mediaType) => {
|
|
248
|
+
if (mediaType.example !== undefined || mediaType.examples) {
|
|
249
|
+
return;
|
|
250
|
+
}
|
|
251
|
+
const exampleValue = buildSchemaExample(mediaType.schema, 'request');
|
|
252
|
+
mediaType.examples = {
|
|
253
|
+
default: {
|
|
254
|
+
summary: 'Example request',
|
|
255
|
+
value: exampleValue,
|
|
256
|
+
},
|
|
257
|
+
};
|
|
258
|
+
});
|
|
259
|
+
});
|
|
260
|
+
});
|
|
261
|
+
}
|
|
262
|
+
const TENANT_HEADERS_DOC_SECTION = [
|
|
263
|
+
'',
|
|
264
|
+
'## Global request headers',
|
|
265
|
+
'',
|
|
266
|
+
'Every authenticated endpoint in this service expects the following headers.',
|
|
267
|
+
'`RequestContextMiddleware` enforces them and returns `400 Bad Request` when missing.',
|
|
268
|
+
'',
|
|
269
|
+
'| Header | Required | Purpose |',
|
|
270
|
+
'| --- | --- | --- |',
|
|
271
|
+
'| `Authorization: Bearer <jwt>` | yes | Keycloak access token (or service JWT for inter-service calls). |',
|
|
272
|
+
'| `X-Org-Id` | yes | Organization context. Frontend Orval clients attach it automatically from `cg_org_id` in `localStorage`. |',
|
|
273
|
+
'| `X-Project-Id` | conditional | Required for endpoints that call `requireProjectId`; optional otherwise. |',
|
|
274
|
+
'| `X-Correlation-Id` | optional | Request correlation id. Generated client-side when absent. |',
|
|
275
|
+
].join('\n');
|
|
276
|
+
function appendGlobalHeadersSection(description) {
|
|
277
|
+
if (description.includes('## Global request headers')) {
|
|
278
|
+
return description;
|
|
279
|
+
}
|
|
280
|
+
return `${description.trimEnd()}\n${TENANT_HEADERS_DOC_SECTION}\n`;
|
|
281
|
+
}
|
|
282
|
+
function enhanceOpenApiDocumentation(document, options) {
|
|
283
|
+
const openApiDocument = document;
|
|
284
|
+
openApiDocument.info ??= {
|
|
285
|
+
title: options.serviceName,
|
|
286
|
+
description: options.serviceDescription,
|
|
287
|
+
};
|
|
288
|
+
if (!openApiDocument.info.title) {
|
|
289
|
+
openApiDocument.info.title = options.serviceName;
|
|
290
|
+
}
|
|
291
|
+
openApiDocument.info.description = appendGlobalHeadersSection(openApiDocument.info.description || options.serviceDescription);
|
|
292
|
+
enrichSchemas(openApiDocument);
|
|
293
|
+
enrichOperations(openApiDocument, options);
|
|
294
|
+
ensureTagDescriptions(openApiDocument);
|
|
295
|
+
}
|
|
296
|
+
//# sourceMappingURL=openapi-docs.enricher.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-docs.enricher.js","sourceRoot":"","sources":["../../src/nestjs/openapi-docs.enricher.ts"],"names":[],"mappings":";;AAsZA,kEAqBC;AAxWD,MAAM,YAAY,GAAwB;IACxC,KAAK;IACL,KAAK;IACL,MAAM;IACN,QAAQ;IACR,SAAS;IACT,MAAM;IACN,OAAO;IACP,OAAO;CACR,CAAC;AAEF,MAAM,qBAAqB,GAA4B;IACrD,EAAE,EAAE,sCAAsC;IAC1C,KAAK,EAAE,cAAc;IACrB,cAAc,EAAE,cAAc;IAC9B,SAAS,EAAE,eAAe;IAC1B,aAAa,EAAE,cAAc;IAC7B,QAAQ,EAAE,gBAAgB;IAC1B,QAAQ,EAAE,gBAAgB;IAC1B,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,0BAA0B;IACrC,SAAS,EAAE,0BAA0B;IACrC,SAAS,EAAE,0BAA0B;IACrC,KAAK,EAAE,uBAAuB;IAC9B,GAAG,EAAE,6BAA6B;IAClC,UAAU,EAAE,6BAA6B;IACzC,IAAI,EAAE,cAAc;IACpB,KAAK,EAAE,eAAe;IACtB,IAAI,EAAE,cAAc;IACpB,GAAG,EAAE,aAAa;IAClB,WAAW,EAAE,qCAAqC;IAClD,OAAO,EAAE,yBAAyB;CACnC,CAAC;AAEF,SAAS,mBAAmB,CAAC,KAAa;IACxC,OAAO,KAAK;SACT,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,iBAAiB,EAAE,OAAO,CAAC;SACtC,KAAK,CAAC,WAAW,CAAC;SAClB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,OAAO,CAAC,CAAC;AACrB,CAAC;AAED,SAAS,cAAc,CAAC,KAAa;IACnC,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa;IAC7B,OAAO,mBAAmB,CAAC,KAAK,CAAC;SAC9B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;SACjC,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO,mBAAmB,CAAC,KAAK,CAAC;SAC9B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;SACjD,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,SAAS,eAAe,CAAC,IAAY;IACnC,OAAO,IAAI;SACR,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SAChC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAY;IACtC,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC;IAC7C,OAAO,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAyB,EAAE,IAAY;IAC/D,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAExC,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,OAAO,YAAY;YACjB,CAAC,CAAC,OAAO,QAAQ,gBAAgB;YACjC,CAAC,CAAC,QAAQ,QAAQ,EAAE,CAAC;IACzB,CAAC;IACD,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;QACtB,OAAO,UAAU,QAAQ,EAAE,CAAC;IAC9B,CAAC;IACD,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,OAAO,WAAW,QAAQ,EAAE,CAAC;IAC/B,CAAC;IACD,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,OAAO,UAAU,QAAQ,EAAE,CAAC;IAC9B,CAAC;IACD,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,OAAO,UAAU,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,OAAO,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,QAAQ,EAAE,CAAC;AAC/C,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAAyB,EACzB,IAAY,EACZ,WAAmB;IAEnB,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC/C,OAAO,CACL,GAAG,OAAO,OAAO,WAAW,IAAI;QAChC,uEAAuE;QACvE,qEAAqE,CACtE,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY;IACrC,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC5C,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,kBAAkB,CAAC,MAA2B;IACrD,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW;QAAE,OAAO,0BAA0B,CAAC;IACrE,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM;QAAE,OAAO,YAAY,CAAC;IAClD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM;QAAE,OAAO,sCAAsC,CAAC;IAC5E,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO;QAAE,OAAO,uBAAuB,CAAC;IAC9D,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK;QAAE,OAAO,8BAA8B,CAAC;IACnE,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,SAAS,qBAAqB,CAC5B,YAAoB,EACpB,MAA2B;IAE3B,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC,OAAO,CAAC;IACxD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC,OAAO,CAAC;IACxD,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjE,IAAI,qBAAqB,CAAC,YAAY,CAAC,KAAK,SAAS,EAAE,CAAC;QACtD,OAAO,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC;IACpE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAE3C,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAuC,EACvC,YAAY,GAAG,OAAO;IAEtB,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAEzB,IAAI,MAAM,CAAC,IAAI;QAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;IAEnD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3D,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3D,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3D,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;YACrD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IACxD,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QAClD,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;QAC3C,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE,EAAE;YAC3D,MAAM,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,IACE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;YAChC,MAAM,CAAC,oBAAoB;YAC3B,OAAO,MAAM,CAAC,oBAAoB,KAAK,QAAQ,EAC/C,CAAC;YACD,MAAM,CAAC,UAAU,GAAG,kBAAkB,CACpC,MAAM,CAAC,oBAAoB,EAC3B,YAAY,CACb,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,qBAAqB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,aAAa,CAAC,QAAyB;IAC9C,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7C,IAAI,CAAC,OAAO;QAAE,OAAO;IAErB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,EAAE;QACvD,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,UAAU;YAAE,OAAO;QAExB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,EAAE,cAAc,CAAC,EAAE,EAAE;YACpE,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC;gBAChC,cAAc,CAAC,WAAW;oBACxB,OAAO,QAAQ,CAAC,YAAY,CAAC,QAAQ,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;YACjE,CAAC;YAED,IAAI,cAAc,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBACzC,cAAc,CAAC,OAAO,GAAG,kBAAkB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,qBAAqB,CAAC,QAAyB;IACtD,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;IAEpC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAEnD,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE;QAChE,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC9B,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnC,IAAI,CAAC,SAAS;gBAAE,OAAO;YAEvB,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACnD,SAAS,CAAC,IAAI,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;YAC7C,CAAC;YAED,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACjC,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC;oBAAE,OAAO;gBAC/B,IAAI,CAAC,IAAI,CAAC;oBACR,IAAI,EAAE,OAAO;oBACb,WAAW,EAAE,GAAG,OAAO,iCAAiC;iBACzD,CAAC,CAAC;gBACH,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC/B,IAAI,GAAG,CAAC,WAAW;YAAE,OAAO,GAAG,CAAC;QAChC,OAAO;YACL,GAAG,GAAG;YACN,WAAW,EAAE,GAAG,GAAG,CAAC,IAAI,iCAAiC;SAC1D,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,gBAAgB,CACvB,QAAyB,EACzB,OAAiC;IAEjC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE;QAChE,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC9B,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnC,IAAI,CAAC,SAAS;gBAAE,OAAO;YAEvB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;gBACvB,SAAS,CAAC,OAAO,GAAG,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACrD,CAAC;YAED,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;gBAC3B,SAAS,CAAC,WAAW,GAAG,oBAAoB,CAC1C,MAAM,EACN,IAAI,EACJ,OAAO,CAAC,WAAW,CACpB,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;gBAC3B,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;gBACxD,SAAS,CAAC,WAAW,GAAG,GAAG,MAAM,GAAG,QAAQ,EAAE,CAAC;YACjD,CAAC;YAED,MAAM,WAAW,GAAG,SAAS,CAAC,WAEjB,CAAC;YACd,MAAM,kBAAkB,GAAG,WAAW,EAAE,OAAO,CAAC;YAChD,IAAI,CAAC,kBAAkB;gBAAE,OAAO;YAEhC,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBACtD,IAAI,SAAS,CAAC,OAAO,KAAK,SAAS,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;oBAC1D,OAAO;gBACT,CAAC;gBAED,MAAM,YAAY,GAAG,kBAAkB,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;gBACrE,SAAS,CAAC,QAAQ,GAAG;oBACnB,OAAO,EAAE;wBACP,OAAO,EAAE,iBAAiB;wBAC1B,KAAK,EAAE,YAAY;qBACpB;iBACF,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAcD,MAAM,0BAA0B,GAAG;IACjC,EAAE;IACF,2BAA2B;IAC3B,EAAE;IACF,6EAA6E;IAC7E,sFAAsF;IACtF,EAAE;IACF,iCAAiC;IACjC,qBAAqB;IACrB,2GAA2G;IAC3G,iIAAiI;IACjI,6GAA6G;IAC7G,gGAAgG;CACjG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEb,SAAS,0BAA0B,CAAC,WAAmB;IACrD,IAAI,WAAW,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAAE,CAAC;QACtD,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,KAAK,0BAA0B,IAAI,CAAC;AACrE,CAAC;AAED,SAAgB,2BAA2B,CACzC,QAAiB,EACjB,OAAiC;IAEjC,MAAM,eAAe,GAAG,QAA2B,CAAC;IAEpD,eAAe,CAAC,IAAI,KAAK;QACvB,KAAK,EAAE,OAAO,CAAC,WAAW;QAC1B,WAAW,EAAE,OAAO,CAAC,kBAAkB;KACxC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAChC,eAAe,CAAC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC;IACnD,CAAC;IACD,eAAe,CAAC,IAAI,CAAC,WAAW,GAAG,0BAA0B,CAC3D,eAAe,CAAC,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,kBAAkB,CAC/D,CAAC;IAEF,aAAa,CAAC,eAAe,CAAC,CAAC;IAC/B,gBAAgB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC3C,qBAAqB,CAAC,eAAe,CAAC,CAAC;AACzC,CAAC"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
export declare class PaginationQueryDto {
|
|
2
|
+
page?: number;
|
|
3
|
+
limit?: number;
|
|
4
|
+
}
|
|
5
|
+
export declare class PaginationMeta {
|
|
6
|
+
total: number;
|
|
7
|
+
page: number;
|
|
8
|
+
limit: number;
|
|
9
|
+
totalPages: number;
|
|
10
|
+
hasMore: boolean;
|
|
11
|
+
}
|
|
12
|
+
export declare function parsePagination(query: {
|
|
13
|
+
page?: number;
|
|
14
|
+
limit?: number;
|
|
15
|
+
}): {
|
|
16
|
+
skip: number;
|
|
17
|
+
take: number;
|
|
18
|
+
page: number;
|
|
19
|
+
limit: number;
|
|
20
|
+
};
|
|
21
|
+
export declare function buildPaginatedResponse<T>(items: T[], total: number, page: number, limit: number): {
|
|
22
|
+
data: T[];
|
|
23
|
+
pagination: PaginationMeta;
|
|
24
|
+
};
|
|
25
|
+
//# sourceMappingURL=pagination.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../src/nestjs/pagination.ts"],"names":[],"mappings":"AAsBA,qBAAa,kBAAkB;IAQ7B,IAAI,CAAC,EAAE,MAAM,CAAK;IAUlB,KAAK,CAAC,EAAE,MAAM,CAAM;CACrB;AAKD,qBAAa,cAAc;IACzB,KAAK,EAAG,MAAM,CAAC;IACf,IAAI,EAAG,MAAM,CAAC;IACd,KAAK,EAAG,MAAM,CAAC;IACf,UAAU,EAAG,MAAM,CAAC;IACpB,OAAO,EAAG,OAAO,CAAC;CACnB;AAeD,wBAAgB,eAAe,CAAC,KAAK,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAYA;AAOD,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,KAAK,EAAE,CAAC,EAAE,EACV,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ;IAAE,IAAI,EAAE,CAAC,EAAE,CAAC;IAAC,UAAU,EAAE,cAAc,CAAA;CAAE,CAY3C"}
|