@pipeline-builder/api-core 0.0.1
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 +202 -0
- package/README.md +98 -0
- package/lib/constants/ai-providers.d.ts +52 -0
- package/lib/constants/ai-providers.js +129 -0
- package/lib/constants/http-status.d.ts +20 -0
- package/lib/constants/http-status.js +26 -0
- package/lib/constants/index.d.ts +3 -0
- package/lib/constants/index.js +6 -0
- package/lib/constants/time.d.ts +10 -0
- package/lib/constants/time.js +13 -0
- package/lib/errors/app-errors.d.ts +30 -0
- package/lib/errors/app-errors.js +53 -0
- package/lib/errors/index.d.ts +1 -0
- package/lib/errors/index.js +4 -0
- package/lib/helpers/access-helpers.d.ts +63 -0
- package/lib/helpers/access-helpers.js +82 -0
- package/lib/helpers/crud-helpers.d.ts +9 -0
- package/lib/helpers/crud-helpers.js +23 -0
- package/lib/helpers/index.d.ts +6 -0
- package/lib/helpers/index.js +9 -0
- package/lib/helpers/org-hierarchy-http.d.ts +74 -0
- package/lib/helpers/org-hierarchy-http.js +144 -0
- package/lib/helpers/org-hierarchy.d.ts +57 -0
- package/lib/helpers/org-hierarchy.js +110 -0
- package/lib/helpers/restore-helpers.d.ts +49 -0
- package/lib/helpers/restore-helpers.js +78 -0
- package/lib/helpers/sse-helpers.d.ts +20 -0
- package/lib/helpers/sse-helpers.js +45 -0
- package/lib/index.d.ts +58 -0
- package/lib/index.js +71 -0
- package/lib/middleware/auth.d.ts +208 -0
- package/lib/middleware/auth.js +588 -0
- package/lib/middleware/index.d.ts +3 -0
- package/lib/middleware/index.js +6 -0
- package/lib/middleware/mongo-sanitize.d.ts +32 -0
- package/lib/middleware/mongo-sanitize.js +100 -0
- package/lib/middleware/step-up.d.ts +45 -0
- package/lib/middleware/step-up.js +138 -0
- package/lib/openapi/extend-zod.d.ts +1 -0
- package/lib/openapi/extend-zod.js +6 -0
- package/lib/openapi/index.d.ts +2 -0
- package/lib/openapi/index.js +5 -0
- package/lib/openapi/registry.d.ts +17 -0
- package/lib/openapi/registry.js +38 -0
- package/lib/openapi/routes/ask-routes.d.ts +7 -0
- package/lib/openapi/routes/ask-routes.js +62 -0
- package/lib/openapi/routes/billing-routes.d.ts +1 -0
- package/lib/openapi/routes/billing-routes.js +66 -0
- package/lib/openapi/routes/image-registry-routes.d.ts +7 -0
- package/lib/openapi/routes/image-registry-routes.js +98 -0
- package/lib/openapi/routes/index.d.ts +5 -0
- package/lib/openapi/routes/index.js +28 -0
- package/lib/openapi/routes/message-routes.d.ts +1 -0
- package/lib/openapi/routes/message-routes.js +105 -0
- package/lib/openapi/routes/pipeline-routes.d.ts +1 -0
- package/lib/openapi/routes/pipeline-routes.js +105 -0
- package/lib/openapi/routes/pipeline-template-routes.d.ts +1 -0
- package/lib/openapi/routes/pipeline-template-routes.js +61 -0
- package/lib/openapi/routes/plugin-routes.d.ts +1 -0
- package/lib/openapi/routes/plugin-routes.js +96 -0
- package/lib/openapi/routes/quota-routes.d.ts +1 -0
- package/lib/openapi/routes/quota-routes.js +62 -0
- package/lib/openapi/schema-registry.d.ts +25 -0
- package/lib/openapi/schema-registry.js +91 -0
- package/lib/routes/health.d.ts +41 -0
- package/lib/routes/health.js +82 -0
- package/lib/routes/index.d.ts +1 -0
- package/lib/routes/index.js +4 -0
- package/lib/services/audit-spool.d.ts +80 -0
- package/lib/services/audit-spool.js +172 -0
- package/lib/services/cache-service.d.ts +124 -0
- package/lib/services/cache-service.js +276 -0
- package/lib/services/circuit-breaker.d.ts +45 -0
- package/lib/services/circuit-breaker.js +138 -0
- package/lib/services/compliance-client.d.ts +46 -0
- package/lib/services/compliance-client.js +128 -0
- package/lib/services/compliance-event-subscriber.d.ts +16 -0
- package/lib/services/compliance-event-subscriber.js +72 -0
- package/lib/services/durable-event-bus.d.ts +96 -0
- package/lib/services/durable-event-bus.js +204 -0
- package/lib/services/entity-events.d.ts +48 -0
- package/lib/services/entity-events.js +79 -0
- package/lib/services/env-redis.d.ts +44 -0
- package/lib/services/env-redis.js +94 -0
- package/lib/services/http-client.d.ts +143 -0
- package/lib/services/http-client.js +335 -0
- package/lib/services/index.d.ts +18 -0
- package/lib/services/index.js +20 -0
- package/lib/services/leader-lock.d.ts +45 -0
- package/lib/services/leader-lock.js +85 -0
- package/lib/services/quota.d.ts +130 -0
- package/lib/services/quota.js +264 -0
- package/lib/services/remote-audit-client.d.ts +160 -0
- package/lib/services/remote-audit-client.js +390 -0
- package/lib/services/retry-strategy.d.ts +74 -0
- package/lib/services/retry-strategy.js +118 -0
- package/lib/services/scheduler.d.ts +41 -0
- package/lib/services/scheduler.js +86 -0
- package/lib/services/service-boot.d.ts +20 -0
- package/lib/services/service-boot.js +28 -0
- package/lib/services/sse-ticket-store.d.ts +51 -0
- package/lib/services/sse-ticket-store.js +130 -0
- package/lib/services/token-revocation.d.ts +52 -0
- package/lib/services/token-revocation.js +120 -0
- package/lib/testing/tier-mock.d.ts +44 -0
- package/lib/testing/tier-mock.js +65 -0
- package/lib/types/audit-events.d.ts +69 -0
- package/lib/types/audit-events.js +4 -0
- package/lib/types/catalog-metadata.d.ts +36 -0
- package/lib/types/catalog-metadata.js +21 -0
- package/lib/types/common.d.ts +255 -0
- package/lib/types/common.js +41 -0
- package/lib/types/error-codes.d.ts +54 -0
- package/lib/types/error-codes.js +107 -0
- package/lib/types/feature-flags.d.ts +36 -0
- package/lib/types/feature-flags.js +128 -0
- package/lib/types/http.d.ts +27 -0
- package/lib/types/http.js +4 -0
- package/lib/types/index.d.ts +11 -0
- package/lib/types/index.js +14 -0
- package/lib/types/permissions.d.ts +65 -0
- package/lib/types/permissions.js +131 -0
- package/lib/types/pipeline-template.d.ts +30 -0
- package/lib/types/pipeline-template.js +13 -0
- package/lib/types/pipeline.d.ts +59 -0
- package/lib/types/pipeline.js +31 -0
- package/lib/types/quota-tiers.d.ts +79 -0
- package/lib/types/quota-tiers.js +221 -0
- package/lib/types/visibility.d.ts +20 -0
- package/lib/types/visibility.js +22 -0
- package/lib/utils/alias-resolver.d.ts +37 -0
- package/lib/utils/alias-resolver.js +68 -0
- package/lib/utils/audit.d.ts +15 -0
- package/lib/utils/audit.js +39 -0
- package/lib/utils/aws-scrub.d.ts +11 -0
- package/lib/utils/aws-scrub.js +67 -0
- package/lib/utils/compliance-attributes.d.ts +6 -0
- package/lib/utils/compliance-attributes.js +69 -0
- package/lib/utils/concurrency.d.ts +9 -0
- package/lib/utils/concurrency.js +29 -0
- package/lib/utils/crash-handlers.d.ts +18 -0
- package/lib/utils/crash-handlers.js +36 -0
- package/lib/utils/env.d.ts +28 -0
- package/lib/utils/env.js +54 -0
- package/lib/utils/headers.d.ts +18 -0
- package/lib/utils/headers.js +21 -0
- package/lib/utils/identity.d.ts +40 -0
- package/lib/utils/identity.js +51 -0
- package/lib/utils/index.d.ts +17 -0
- package/lib/utils/index.js +20 -0
- package/lib/utils/logger.d.ts +38 -0
- package/lib/utils/logger.js +174 -0
- package/lib/utils/metric-emitter.d.ts +36 -0
- package/lib/utils/metric-emitter.js +32 -0
- package/lib/utils/object.d.ts +13 -0
- package/lib/utils/object.js +18 -0
- package/lib/utils/params.d.ts +150 -0
- package/lib/utils/params.js +206 -0
- package/lib/utils/response.d.ts +117 -0
- package/lib/utils/response.js +223 -0
- package/lib/utils/safe-require.d.ts +13 -0
- package/lib/utils/safe-require.js +19 -0
- package/lib/utils/secret-encryption.d.ts +176 -0
- package/lib/utils/secret-encryption.js +374 -0
- package/lib/utils/ssrf.d.ts +30 -0
- package/lib/utils/ssrf.js +106 -0
- package/lib/validation/ai-schemas.d.ts +56 -0
- package/lib/validation/ai-schemas.js +78 -0
- package/lib/validation/common-schemas.d.ts +133 -0
- package/lib/validation/common-schemas.js +94 -0
- package/lib/validation/index.d.ts +7 -0
- package/lib/validation/index.js +10 -0
- package/lib/validation/message-schemas.d.ts +160 -0
- package/lib/validation/message-schemas.js +156 -0
- package/lib/validation/middleware.d.ts +72 -0
- package/lib/validation/middleware.js +65 -0
- package/lib/validation/pipeline-schemas.d.ts +181 -0
- package/lib/validation/pipeline-schemas.js +101 -0
- package/lib/validation/pipeline-template-schemas.d.ts +155 -0
- package/lib/validation/pipeline-template-schemas.js +66 -0
- package/lib/validation/plugin-schemas.d.ts +171 -0
- package/lib/validation/plugin-schemas.js +81 -0
- package/openapi.yaml +292 -0
- package/package.json +167 -0
|
@@ -0,0 +1,255 @@
|
|
|
1
|
+
import type { Permission } from './permissions.js';
|
|
2
|
+
import type { QuotaTier } from './quota-tiers.js';
|
|
3
|
+
/**
|
|
4
|
+
* Capability scope catalog for machine/automation tokens. A scoped token carries
|
|
5
|
+
* exactly one of these instead of role-based permissions; endpoints that accept a
|
|
6
|
+
* scoped identity check it via `hasScope`. Kept a closed union (mirroring
|
|
7
|
+
* {@link Permission}) so a typo on either the mint or the check side is a compile
|
|
8
|
+
* error. Add a value here when introducing a new scoped-token surface.
|
|
9
|
+
*/
|
|
10
|
+
export type TokenScope = 'reporting:ingest';
|
|
11
|
+
/**
|
|
12
|
+
* Quota type identifiers.
|
|
13
|
+
*
|
|
14
|
+
* - `plugins` / `pipelines` — count of created entities
|
|
15
|
+
* - `apiCalls` — generic API call count (read-heavy paths)
|
|
16
|
+
* - `aiCalls` — AI provider invocations (counted separately because each call
|
|
17
|
+
* has external dollar cost; sized smaller than apiCalls per tier)
|
|
18
|
+
* - `storageBytes` — registry storage budget per org. Unlike the others
|
|
19
|
+
* (which count discrete events), this is a measured total recomputed
|
|
20
|
+
* on demand. Incremented by the image-registry's push-gate before
|
|
21
|
+
* issuing a token whose scope includes `push`; the GC scheduler
|
|
22
|
+
* eventually frees the bytes, then the next push-gate check reads
|
|
23
|
+
* the lower value. NOT a counter-style quota in the sense of
|
|
24
|
+
* `incrementUsage` — the registry pushes the measured total via
|
|
25
|
+
* `updateLimits`/`resetUsage` flows. Tier limits are bytes.
|
|
26
|
+
* - `dashboards` / `alertRules` / `alertDestinations` / `idpConfigs` —
|
|
27
|
+
* resource-count quotas added to close per-org DoS surfaces in the
|
|
28
|
+
* user-editable feature tables. Without these caps a single org could
|
|
29
|
+
* spam thousands of dashboards / rules and bloat the shared Postgres /
|
|
30
|
+
* Mongo working sets. Counted at create time; decremented on delete.
|
|
31
|
+
*/
|
|
32
|
+
export type QuotaType = 'plugins' | 'pipelines' | 'apiCalls' | 'aiCalls' | 'storageBytes' | 'dashboards' | 'alertRules' | 'alertDestinations' | 'idpConfigs';
|
|
33
|
+
/**
|
|
34
|
+
* Valid quota type values.
|
|
35
|
+
*/
|
|
36
|
+
export declare const VALID_QUOTA_TYPES: readonly ['plugins', 'pipelines', 'apiCalls', 'aiCalls', 'storageBytes', 'dashboards', 'alertRules', 'alertDestinations', 'idpConfigs'];
|
|
37
|
+
/**
|
|
38
|
+
* Type guard to check if a value is a valid QuotaType.
|
|
39
|
+
*
|
|
40
|
+
* @param value - Value to check
|
|
41
|
+
* @returns True if value is a valid QuotaType
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```typescript
|
|
45
|
+
* if (isValidQuotaType(req.body.quotaType)) {
|
|
46
|
+
* // quotaType is guaranteed to be QuotaType
|
|
47
|
+
* }
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
export declare function isValidQuotaType(value: unknown): value is QuotaType;
|
|
51
|
+
/**
|
|
52
|
+
* Result from quota check operation.
|
|
53
|
+
*/
|
|
54
|
+
export interface QuotaCheckResult {
|
|
55
|
+
/** Whether the request is allowed */
|
|
56
|
+
allowed: boolean;
|
|
57
|
+
/** Maximum quota limit (-1 for unlimited) */
|
|
58
|
+
limit: number;
|
|
59
|
+
/** Current usage count */
|
|
60
|
+
used: number;
|
|
61
|
+
/** Remaining quota (-1 for unlimited) */
|
|
62
|
+
remaining: number;
|
|
63
|
+
/** ISO timestamp when quota resets */
|
|
64
|
+
resetAt: string;
|
|
65
|
+
/** Whether quota is unlimited */
|
|
66
|
+
unlimited: boolean;
|
|
67
|
+
/**
|
|
68
|
+
* True ONLY when this result is the fail-open sentinel returned because the
|
|
69
|
+
* quota service was unreachable / returned non-ok (not a real quota reading).
|
|
70
|
+
* Lets fail-closed callers (e.g. the registry storage push-gate) distinguish
|
|
71
|
+
* an outage from a genuine `limit: -1` (unlimited) org. Absent on real results.
|
|
72
|
+
*/
|
|
73
|
+
failOpen?: boolean;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Quota information for error responses.
|
|
77
|
+
*/
|
|
78
|
+
export interface QuotaInfo {
|
|
79
|
+
type: QuotaType;
|
|
80
|
+
limit: number;
|
|
81
|
+
used: number;
|
|
82
|
+
remaining: number;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Standard API success response.
|
|
86
|
+
*/
|
|
87
|
+
export interface ApiSuccessResponse<T = unknown> {
|
|
88
|
+
success: true;
|
|
89
|
+
statusCode: number;
|
|
90
|
+
data?: T;
|
|
91
|
+
message?: string;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Standard API error response.
|
|
95
|
+
*/
|
|
96
|
+
export interface ApiErrorResponse {
|
|
97
|
+
success: false;
|
|
98
|
+
statusCode: number;
|
|
99
|
+
message: string;
|
|
100
|
+
code?: string;
|
|
101
|
+
details?: unknown;
|
|
102
|
+
quota?: QuotaInfo;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Combined API response type.
|
|
106
|
+
*/
|
|
107
|
+
export type ApiResponse<T = unknown> = ApiSuccessResponse<T> | ApiErrorResponse;
|
|
108
|
+
/**
|
|
109
|
+
* JWT payload from access tokens.
|
|
110
|
+
*
|
|
111
|
+
* Users can belong to multiple organizations. The token is scoped to one
|
|
112
|
+
* active organization at a time. The `role` field is the user's per-org
|
|
113
|
+
* role in that organization (from the UserOrganization junction collection),
|
|
114
|
+
* and `isAdmin` is derived as `role === 'admin' || role === 'owner'`.
|
|
115
|
+
*
|
|
116
|
+
* Use `POST /auth/switch-org` to change the active organization, which
|
|
117
|
+
* re-issues tokens with the new org's role and context.
|
|
118
|
+
*/
|
|
119
|
+
/**
|
|
120
|
+
* Coarse per-org membership label, DERIVED from the Roles a user is assigned
|
|
121
|
+
* (the highest `grantsRole` among them; `owner` is set only by ownership
|
|
122
|
+
* transfer). It is a display/authority label — driving `isAdmin`, ownership,
|
|
123
|
+
* and seat accounting — NOT a permission source. Effective permissions come
|
|
124
|
+
* solely from the user's assigned Roles (see `resolveUserPermissions`). Not a
|
|
125
|
+
* global role.
|
|
126
|
+
*/
|
|
127
|
+
export type OrgRole = 'owner' | 'admin' | 'member';
|
|
128
|
+
export interface JwtPayload {
|
|
129
|
+
/** User ID (subject) */
|
|
130
|
+
sub: string;
|
|
131
|
+
/** Username */
|
|
132
|
+
username: string;
|
|
133
|
+
/** User email */
|
|
134
|
+
email: string;
|
|
135
|
+
/** Per-org role in the active organization ('owner' | 'admin' | 'member'). Not a global role. */
|
|
136
|
+
role: OrgRole;
|
|
137
|
+
/** Derived: true when role is 'admin' or 'owner' in the active organization */
|
|
138
|
+
isAdmin?: boolean;
|
|
139
|
+
/**
|
|
140
|
+
* Resolved fine-grained permissions for the active org/team — the union of
|
|
141
|
+
* the permissions carried by every Role the user is assigned (see
|
|
142
|
+
* `resolveUserPermissions`). Absent on machine/scoped tokens. Superadmins are
|
|
143
|
+
* granted all permissions implicitly and may omit this. Endpoints enforce via
|
|
144
|
+
* `requirePermission(...)`.
|
|
145
|
+
*/
|
|
146
|
+
permissions?: Permission[];
|
|
147
|
+
/**
|
|
148
|
+
* Global super-admin flag (cross-org). When `true`, the user is treated
|
|
149
|
+
* as a system administrator regardless of which org they're currently
|
|
150
|
+
* acting under. This is the SOLE signal for sysadmin authority — the old path
|
|
151
|
+
* (membership in the well-known "system" org with role admin/owner) has been
|
|
152
|
+
* removed because it conflated "Pipeline Builder operator" with "real customer
|
|
153
|
+
* tenant" in the data model. Grant sysadmin only via `isSuperAdmin`.
|
|
154
|
+
*/
|
|
155
|
+
isSuperAdmin?: boolean;
|
|
156
|
+
/** Organization's quota tier. */
|
|
157
|
+
tier?: QuotaTier;
|
|
158
|
+
/** Resolved feature flags for this user/org */
|
|
159
|
+
features?: string[];
|
|
160
|
+
/**
|
|
161
|
+
* Narrow capability scope for machine/automation tokens (e.g.
|
|
162
|
+
* `'reporting:ingest'`). Absent on normal interactive user tokens. Endpoints
|
|
163
|
+
* that accept a scoped identity check this (see `hasScope`) instead of role;
|
|
164
|
+
* a scoped token is minted with minimal role for least-privilege.
|
|
165
|
+
*/
|
|
166
|
+
scope?: TokenScope;
|
|
167
|
+
/** Active organization ID (from UserOrganization membership) */
|
|
168
|
+
organizationId?: string;
|
|
169
|
+
/** Active organization name */
|
|
170
|
+
organizationName?: string;
|
|
171
|
+
/**
|
|
172
|
+
* Org → team hierarchy (org-team-hierarchy proposal, phase 1).
|
|
173
|
+
* `parentOrganizationId` is the active org's direct parent; `rootOrganizationId`
|
|
174
|
+
* is the top of its ancestry chain. Both are **omitted for flat (root) orgs** —
|
|
175
|
+
* consumers should treat the effective root as `rootOrganizationId ?? organizationId`
|
|
176
|
+
* (use the shared {@link effectiveRootOrgId} accessor rather than coalescing inline).
|
|
177
|
+
* Currently every org is flat, so these are absent on all tokens today.
|
|
178
|
+
*/
|
|
179
|
+
parentOrganizationId?: string;
|
|
180
|
+
/** Root organization ID of the active org's ancestry chain (see `parentOrganizationId`). */
|
|
181
|
+
rootOrganizationId?: string;
|
|
182
|
+
/**
|
|
183
|
+
* Set on tokens issued by the sysadmin impersonation flow
|
|
184
|
+
* (`POST /admin/impersonate/:userId`). Carries the original sysadmin's
|
|
185
|
+
* user id so audit events still attribute actions correctly.
|
|
186
|
+
*/
|
|
187
|
+
impersonatorId?: string;
|
|
188
|
+
/**
|
|
189
|
+
* When true, the token is read-only — any non-GET request is rejected
|
|
190
|
+
* upstream by the platform's read-only impersonation gate. Lets
|
|
191
|
+
* sysadmins "view as user X" without risking a destructive action.
|
|
192
|
+
*/
|
|
193
|
+
impersonationReadOnly?: boolean;
|
|
194
|
+
/**
|
|
195
|
+
* The user's `tokenVersion` at the moment this token was issued. Every
|
|
196
|
+
* privilege change (deactivate / role or tier downgrade / membership or
|
|
197
|
+
* ownership change / password change / logout-all) increments the user's
|
|
198
|
+
* server-side `tokenVersion`, so a token whose embedded version is behind the
|
|
199
|
+
* current one has been REVOKED. Platform validates this against Mongo; the
|
|
200
|
+
* stateless services validate it against a Redis-published current-version
|
|
201
|
+
* store (see `setTokenRevocationStore`). Absent on machine/service tokens.
|
|
202
|
+
*/
|
|
203
|
+
tokenVersion?: number;
|
|
204
|
+
/** Token type */
|
|
205
|
+
type: 'access' | 'refresh';
|
|
206
|
+
/** Issued at timestamp */
|
|
207
|
+
iat?: number;
|
|
208
|
+
/** Expiration timestamp */
|
|
209
|
+
exp?: number;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* The account boundary (root org) for a token's active org.
|
|
213
|
+
*
|
|
214
|
+
* The account root is `rootOrganizationId ?? organizationId`: a flat (root) org
|
|
215
|
+
* omits `rootOrganizationId`, so it IS its own root; a team (child) org carries
|
|
216
|
+
* the top of its ancestry chain. Every account-scoped read (quota/seat/billing
|
|
217
|
+
* pooling) must resolve through this coalesce rather than reading
|
|
218
|
+
* `organizationId` directly — the latter silently works today (all orgs flat)
|
|
219
|
+
* but would bind to the team instead of the account once teams exist.
|
|
220
|
+
*
|
|
221
|
+
* @returns the effective root org id, or `undefined` when neither field is set.
|
|
222
|
+
*/
|
|
223
|
+
export declare function effectiveRootOrgId(payload: Pick<JwtPayload, 'organizationId' | 'rootOrganizationId'>): string | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* Extended Express Request with user property.
|
|
226
|
+
*/
|
|
227
|
+
declare global {
|
|
228
|
+
namespace Express {
|
|
229
|
+
interface Request {
|
|
230
|
+
user?: JwtPayload;
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Service configuration for internal HTTP client.
|
|
236
|
+
*/
|
|
237
|
+
export interface ServiceConfig {
|
|
238
|
+
/** Service hostname */
|
|
239
|
+
host: string;
|
|
240
|
+
/** Service port */
|
|
241
|
+
port: number;
|
|
242
|
+
/** Request timeout in milliseconds */
|
|
243
|
+
timeout?: number;
|
|
244
|
+
}
|
|
245
|
+
/**
|
|
246
|
+
* Health check response.
|
|
247
|
+
*/
|
|
248
|
+
export interface HealthCheckResponse {
|
|
249
|
+
status: 'healthy' | 'unhealthy';
|
|
250
|
+
service: string;
|
|
251
|
+
timestamp: string;
|
|
252
|
+
uptime: number;
|
|
253
|
+
version?: string;
|
|
254
|
+
dependencies?: Record<string, 'connected' | 'disconnected' | 'unknown'>;
|
|
255
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
/**
|
|
4
|
+
* Valid quota type values.
|
|
5
|
+
*/
|
|
6
|
+
export const VALID_QUOTA_TYPES = [
|
|
7
|
+
'plugins', 'pipelines', 'apiCalls', 'aiCalls', 'storageBytes',
|
|
8
|
+
'dashboards', 'alertRules', 'alertDestinations', 'idpConfigs',
|
|
9
|
+
];
|
|
10
|
+
/**
|
|
11
|
+
* Type guard to check if a value is a valid QuotaType.
|
|
12
|
+
*
|
|
13
|
+
* @param value - Value to check
|
|
14
|
+
* @returns True if value is a valid QuotaType
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* if (isValidQuotaType(req.body.quotaType)) {
|
|
19
|
+
* // quotaType is guaranteed to be QuotaType
|
|
20
|
+
* }
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
export function isValidQuotaType(value) {
|
|
24
|
+
return typeof value === 'string' && VALID_QUOTA_TYPES.includes(value);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* The account boundary (root org) for a token's active org.
|
|
28
|
+
*
|
|
29
|
+
* The account root is `rootOrganizationId ?? organizationId`: a flat (root) org
|
|
30
|
+
* omits `rootOrganizationId`, so it IS its own root; a team (child) org carries
|
|
31
|
+
* the top of its ancestry chain. Every account-scoped read (quota/seat/billing
|
|
32
|
+
* pooling) must resolve through this coalesce rather than reading
|
|
33
|
+
* `organizationId` directly — the latter silently works today (all orgs flat)
|
|
34
|
+
* but would bind to the team instead of the account once teams exist.
|
|
35
|
+
*
|
|
36
|
+
* @returns the effective root org id, or `undefined` when neither field is set.
|
|
37
|
+
*/
|
|
38
|
+
export function effectiveRootOrgId(payload) {
|
|
39
|
+
return payload.rootOrganizationId ?? payload.organizationId;
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/types/common.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,sCAAsC;AA0CtC;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,cAAc;IAC7D,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY;CACrD,CAAC;AAEX;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,iBAAiB,CAAC,QAAQ,CAAC,KAAkB,CAAC,CAAC;AACrF,CAAC;AAyKD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAkE;IAElE,OAAO,OAAO,CAAC,kBAAkB,IAAI,OAAO,CAAC,cAAc,CAAC;AAC9D,CAAC","sourcesContent":["// Copyright 2026 Pipeline Builder Contributors\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { Permission } from './permissions.js';\nimport type { QuotaTier } from './quota-tiers.js';\n\n/**\n * Capability scope catalog for machine/automation tokens. A scoped token carries\n * exactly one of these instead of role-based permissions; endpoints that accept a\n * scoped identity check it via `hasScope`. Kept a closed union (mirroring\n * {@link Permission}) so a typo on either the mint or the check side is a compile\n * error. Add a value here when introducing a new scoped-token surface.\n */\nexport type TokenScope = 'reporting:ingest';\n\n/**\n * Quota type identifiers.\n *\n * - `plugins` / `pipelines` — count of created entities\n * - `apiCalls` — generic API call count (read-heavy paths)\n * - `aiCalls` — AI provider invocations (counted separately because each call\n *   has external dollar cost; sized smaller than apiCalls per tier)\n * - `storageBytes` — registry storage budget per org. Unlike the others\n *   (which count discrete events), this is a measured total recomputed\n *   on demand. Incremented by the image-registry's push-gate before\n *   issuing a token whose scope includes `push`; the GC scheduler\n *   eventually frees the bytes, then the next push-gate check reads\n *   the lower value. NOT a counter-style quota in the sense of\n *   `incrementUsage` — the registry pushes the measured total via\n *   `updateLimits`/`resetUsage` flows. Tier limits are bytes.\n * - `dashboards` / `alertRules` / `alertDestinations` / `idpConfigs` —\n *   resource-count quotas added to close per-org DoS surfaces in the\n *   user-editable feature tables. Without these caps a single org could\n *   spam thousands of dashboards / rules and bloat the shared Postgres /\n *   Mongo working sets. Counted at create time; decremented on delete.\n */\n// NOTE: `seats` is intentionally NOT here. It's a tier limit (QuotaTierLimits)\n// enforced by comparing the org's LIVE member count at invite time — not an\n// incrementing per-period counter like the consumable quotas below.\nexport type QuotaType =\n  | 'plugins' | 'pipelines' | 'apiCalls' | 'aiCalls' | 'storageBytes'\n  | 'dashboards' | 'alertRules' | 'alertDestinations' | 'idpConfigs';\n\n/**\n * Valid quota type values.\n */\nexport const VALID_QUOTA_TYPES = [\n  'plugins', 'pipelines', 'apiCalls', 'aiCalls', 'storageBytes',\n  'dashboards', 'alertRules', 'alertDestinations', 'idpConfigs',\n] as const;\n\n/**\n * Type guard to check if a value is a valid QuotaType.\n *\n * @param value - Value to check\n * @returns True if value is a valid QuotaType\n *\n * @example\n * ```typescript\n * if (isValidQuotaType(req.body.quotaType)) {\n *   // quotaType is guaranteed to be QuotaType\n * }\n * ```\n */\nexport function isValidQuotaType(value: unknown): value is QuotaType {\n  return typeof value === 'string' && VALID_QUOTA_TYPES.includes(value as QuotaType);\n}\n\n/**\n * Result from quota check operation.\n */\nexport interface QuotaCheckResult {\n  /** Whether the request is allowed */\n  allowed: boolean;\n  /** Maximum quota limit (-1 for unlimited) */\n  limit: number;\n  /** Current usage count */\n  used: number;\n  /** Remaining quota (-1 for unlimited) */\n  remaining: number;\n  /** ISO timestamp when quota resets */\n  resetAt: string;\n  /** Whether quota is unlimited */\n  unlimited: boolean;\n  /**\n   * True ONLY when this result is the fail-open sentinel returned because the\n   * quota service was unreachable / returned non-ok (not a real quota reading).\n   * Lets fail-closed callers (e.g. the registry storage push-gate) distinguish\n   * an outage from a genuine `limit: -1` (unlimited) org. Absent on real results.\n   */\n  failOpen?: boolean;\n}\n\n/**\n * Quota information for error responses.\n */\nexport interface QuotaInfo {\n  type: QuotaType;\n  limit: number;\n  used: number;\n  remaining: number;\n}\n\n/**\n * Standard API success response.\n */\nexport interface ApiSuccessResponse<T = unknown> {\n  success: true;\n  statusCode: number;\n  data?: T;\n  message?: string;\n}\n\n/**\n * Standard API error response.\n */\nexport interface ApiErrorResponse {\n  success: false;\n  statusCode: number;\n  message: string;\n  code?: string;\n  details?: unknown;\n  quota?: QuotaInfo;\n}\n\n/**\n * Combined API response type.\n */\nexport type ApiResponse<T = unknown> = ApiSuccessResponse<T> | ApiErrorResponse;\n\n/**\n * JWT payload from access tokens.\n *\n * Users can belong to multiple organizations. The token is scoped to one\n * active organization at a time. The `role` field is the user's per-org\n * role in that organization (from the UserOrganization junction collection),\n * and `isAdmin` is derived as `role === 'admin' || role === 'owner'`.\n *\n * Use `POST /auth/switch-org` to change the active organization, which\n * re-issues tokens with the new org's role and context.\n */\n/**\n * Coarse per-org membership label, DERIVED from the Roles a user is assigned\n * (the highest `grantsRole` among them; `owner` is set only by ownership\n * transfer). It is a display/authority label — driving `isAdmin`, ownership,\n * and seat accounting — NOT a permission source. Effective permissions come\n * solely from the user's assigned Roles (see `resolveUserPermissions`). Not a\n * global role.\n */\nexport type OrgRole = 'owner' | 'admin' | 'member';\n\nexport interface JwtPayload {\n  /** User ID (subject) */\n  sub: string;\n  /** Username */\n  username: string;\n  /** User email */\n  email: string;\n  /** Per-org role in the active organization ('owner' | 'admin' | 'member'). Not a global role. */\n  role: OrgRole;\n  /** Derived: true when role is 'admin' or 'owner' in the active organization */\n  isAdmin?: boolean;\n  /**\n   * Resolved fine-grained permissions for the active org/team — the union of\n   * the permissions carried by every Role the user is assigned (see\n   * `resolveUserPermissions`). Absent on machine/scoped tokens. Superadmins are\n   * granted all permissions implicitly and may omit this. Endpoints enforce via\n   * `requirePermission(...)`.\n   */\n  permissions?: Permission[];\n  /**\n   * Global super-admin flag (cross-org). When `true`, the user is treated\n   * as a system administrator regardless of which org they're currently\n   * acting under. This is the SOLE signal for sysadmin authority — the old path\n   * (membership in the well-known \"system\" org with role admin/owner) has been\n   * removed because it conflated \"Pipeline Builder operator\" with \"real customer\n   * tenant\" in the data model. Grant sysadmin only via `isSuperAdmin`.\n   */\n  isSuperAdmin?: boolean;\n  /** Organization's quota tier. */\n  tier?: QuotaTier;\n  /** Resolved feature flags for this user/org */\n  features?: string[];\n  /**\n   * Narrow capability scope for machine/automation tokens (e.g.\n   * `'reporting:ingest'`). Absent on normal interactive user tokens. Endpoints\n   * that accept a scoped identity check this (see `hasScope`) instead of role;\n   * a scoped token is minted with minimal role for least-privilege.\n   */\n  scope?: TokenScope;\n  /** Active organization ID (from UserOrganization membership) */\n  organizationId?: string;\n  /** Active organization name */\n  organizationName?: string;\n  /**\n   * Org → team hierarchy (org-team-hierarchy proposal, phase 1).\n   * `parentOrganizationId` is the active org's direct parent; `rootOrganizationId`\n   * is the top of its ancestry chain. Both are **omitted for flat (root) orgs** —\n   * consumers should treat the effective root as `rootOrganizationId ?? organizationId`\n   * (use the shared {@link effectiveRootOrgId} accessor rather than coalescing inline).\n   * Currently every org is flat, so these are absent on all tokens today.\n   */\n  parentOrganizationId?: string;\n  /** Root organization ID of the active org's ancestry chain (see `parentOrganizationId`). */\n  rootOrganizationId?: string;\n  /**\n   * Set on tokens issued by the sysadmin impersonation flow\n   * (`POST /admin/impersonate/:userId`). Carries the original sysadmin's\n   * user id so audit events still attribute actions correctly.\n   */\n  impersonatorId?: string;\n  /**\n   * When true, the token is read-only — any non-GET request is rejected\n   * upstream by the platform's read-only impersonation gate. Lets\n   * sysadmins \"view as user X\" without risking a destructive action.\n   */\n  impersonationReadOnly?: boolean;\n  /**\n   * The user's `tokenVersion` at the moment this token was issued. Every\n   * privilege change (deactivate / role or tier downgrade / membership or\n   * ownership change / password change / logout-all) increments the user's\n   * server-side `tokenVersion`, so a token whose embedded version is behind the\n   * current one has been REVOKED. Platform validates this against Mongo; the\n   * stateless services validate it against a Redis-published current-version\n   * store (see `setTokenRevocationStore`). Absent on machine/service tokens.\n   */\n  tokenVersion?: number;\n  /** Token type */\n  type: 'access' | 'refresh';\n  /** Issued at timestamp */\n  iat?: number;\n  /** Expiration timestamp */\n  exp?: number;\n}\n\n/**\n * The account boundary (root org) for a token's active org.\n *\n * The account root is `rootOrganizationId ?? organizationId`: a flat (root) org\n * omits `rootOrganizationId`, so it IS its own root; a team (child) org carries\n * the top of its ancestry chain. Every account-scoped read (quota/seat/billing\n * pooling) must resolve through this coalesce rather than reading\n * `organizationId` directly — the latter silently works today (all orgs flat)\n * but would bind to the team instead of the account once teams exist.\n *\n * @returns the effective root org id, or `undefined` when neither field is set.\n */\nexport function effectiveRootOrgId(\n  payload: Pick<JwtPayload, 'organizationId' | 'rootOrganizationId'>,\n): string | undefined {\n  return payload.rootOrganizationId ?? payload.organizationId;\n}\n\n/**\n * Extended Express Request with user property.\n */\ndeclare global {\n  namespace Express {\n    interface Request {\n      user?: JwtPayload;\n    }\n  }\n}\n\n/**\n * Service configuration for internal HTTP client.\n */\nexport interface ServiceConfig {\n  /** Service hostname */\n  host: string;\n  /** Service port */\n  port: number;\n  /** Request timeout in milliseconds */\n  timeout?: number;\n}\n\n/**\n * Health check response.\n */\nexport interface HealthCheckResponse {\n  status: 'healthy' | 'unhealthy';\n  service: string;\n  timestamp: string;\n  uptime: number;\n  version?: string;\n  dependencies?: Record<string, 'connected' | 'disconnected' | 'unknown'>;\n}\n"]}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Standardized error codes used across all API microservices.
|
|
3
|
+
* Use these codes in error responses for consistent client handling.
|
|
4
|
+
*
|
|
5
|
+
* Each HTTP status category has one primary code. Use the `details`
|
|
6
|
+
* field in error responses for sub-type information (e.g. which quota
|
|
7
|
+
* was exceeded, which field failed validation).
|
|
8
|
+
*/
|
|
9
|
+
export declare enum ErrorCode {
|
|
10
|
+
UNAUTHORIZED = "UNAUTHORIZED",
|
|
11
|
+
TOKEN_EXPIRED = "TOKEN_EXPIRED",
|
|
12
|
+
TOKEN_INVALID = "TOKEN_INVALID",
|
|
13
|
+
TOKEN_MISSING = "TOKEN_MISSING",
|
|
14
|
+
TOKEN_REVOKED = "TOKEN_REVOKED",
|
|
15
|
+
INSUFFICIENT_PERMISSIONS = "INSUFFICIENT_PERMISSIONS",
|
|
16
|
+
ORG_MISMATCH = "ORG_MISMATCH",
|
|
17
|
+
COMPLIANCE_VIOLATION = "COMPLIANCE_VIOLATION",
|
|
18
|
+
NOT_FOUND = "NOT_FOUND",
|
|
19
|
+
ORG_NOT_FOUND = "ORG_NOT_FOUND",
|
|
20
|
+
VALIDATION_ERROR = "VALIDATION_ERROR",
|
|
21
|
+
MISSING_REQUIRED_FIELD = "MISSING_REQUIRED_FIELD",
|
|
22
|
+
TEMPLATE_UNKNOWN_PATH = "TEMPLATE_UNKNOWN_PATH",
|
|
23
|
+
TEMPLATE_CYCLE = "TEMPLATE_CYCLE",
|
|
24
|
+
TEMPLATE_PARSE_ERROR = "TEMPLATE_PARSE_ERROR",
|
|
25
|
+
TEMPLATE_TYPE_MISMATCH = "TEMPLATE_TYPE_MISMATCH",
|
|
26
|
+
TEMPLATE_SECRETS_RESERVED = "TEMPLATE_SECRETS_RESERVED",
|
|
27
|
+
TEMPLATE_CONTRACT_VIOLATION = "TEMPLATE_CONTRACT_VIOLATION",
|
|
28
|
+
TEMPLATE_SIZE_EXCEEDED = "TEMPLATE_SIZE_EXCEEDED",
|
|
29
|
+
TEMPLATE_VALIDATION_FAILED = "TEMPLATE_VALIDATION_FAILED",
|
|
30
|
+
QUOTA_EXCEEDED = "QUOTA_EXCEEDED",
|
|
31
|
+
RATE_LIMIT_EXCEEDED = "RATE_LIMIT_EXCEEDED",
|
|
32
|
+
PAYLOAD_TOO_LARGE = "PAYLOAD_TOO_LARGE",
|
|
33
|
+
CONFLICT = "CONFLICT",
|
|
34
|
+
DUPLICATE_ENTRY = "DUPLICATE_ENTRY",
|
|
35
|
+
SCAN_CONFLICT = "SCAN_CONFLICT",
|
|
36
|
+
PAYMENT_METHOD_REQUIRED = "PAYMENT_METHOD_REQUIRED",// 402
|
|
37
|
+
DISCOUNT_CEILING_EXCEEDED = "DISCOUNT_CEILING_EXCEEDED",// 400
|
|
38
|
+
DISCOUNT_NOT_FOUND = "DISCOUNT_NOT_FOUND",// 404
|
|
39
|
+
DISCOUNT_INACTIVE = "DISCOUNT_INACTIVE",// 409
|
|
40
|
+
PLAN_OVER_CAP = "PLAN_OVER_CAP",// 409
|
|
41
|
+
ADDON_OVER_CAP = "ADDON_OVER_CAP",// 409
|
|
42
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
43
|
+
DATABASE_ERROR = "DATABASE_ERROR",
|
|
44
|
+
SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
|
|
45
|
+
COMPLIANCE_SERVICE_UNAVAILABLE = "COMPLIANCE_SERVICE_UNAVAILABLE"
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Maps error codes to their default HTTP status codes.
|
|
49
|
+
*/
|
|
50
|
+
export declare const ErrorCodeStatus: Record<ErrorCode, number>;
|
|
51
|
+
/**
|
|
52
|
+
* Get the HTTP status code for an error code.
|
|
53
|
+
*/
|
|
54
|
+
export declare function getStatusForErrorCode(code: ErrorCode): number;
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
/**
|
|
4
|
+
* Standardized error codes used across all API microservices.
|
|
5
|
+
* Use these codes in error responses for consistent client handling.
|
|
6
|
+
*
|
|
7
|
+
* Each HTTP status category has one primary code. Use the `details`
|
|
8
|
+
* field in error responses for sub-type information (e.g. which quota
|
|
9
|
+
* was exceeded, which field failed validation).
|
|
10
|
+
*/
|
|
11
|
+
export var ErrorCode;
|
|
12
|
+
(function (ErrorCode) {
|
|
13
|
+
// Authentication errors (401)
|
|
14
|
+
ErrorCode["UNAUTHORIZED"] = "UNAUTHORIZED";
|
|
15
|
+
ErrorCode["TOKEN_EXPIRED"] = "TOKEN_EXPIRED";
|
|
16
|
+
ErrorCode["TOKEN_INVALID"] = "TOKEN_INVALID";
|
|
17
|
+
ErrorCode["TOKEN_MISSING"] = "TOKEN_MISSING";
|
|
18
|
+
ErrorCode["TOKEN_REVOKED"] = "TOKEN_REVOKED";
|
|
19
|
+
// Authorization errors (403)
|
|
20
|
+
ErrorCode["INSUFFICIENT_PERMISSIONS"] = "INSUFFICIENT_PERMISSIONS";
|
|
21
|
+
ErrorCode["ORG_MISMATCH"] = "ORG_MISMATCH";
|
|
22
|
+
ErrorCode["COMPLIANCE_VIOLATION"] = "COMPLIANCE_VIOLATION";
|
|
23
|
+
// Not found errors (404)
|
|
24
|
+
ErrorCode["NOT_FOUND"] = "NOT_FOUND";
|
|
25
|
+
ErrorCode["ORG_NOT_FOUND"] = "ORG_NOT_FOUND";
|
|
26
|
+
// Validation errors (400)
|
|
27
|
+
ErrorCode["VALIDATION_ERROR"] = "VALIDATION_ERROR";
|
|
28
|
+
ErrorCode["MISSING_REQUIRED_FIELD"] = "MISSING_REQUIRED_FIELD";
|
|
29
|
+
ErrorCode["TEMPLATE_UNKNOWN_PATH"] = "TEMPLATE_UNKNOWN_PATH";
|
|
30
|
+
ErrorCode["TEMPLATE_CYCLE"] = "TEMPLATE_CYCLE";
|
|
31
|
+
ErrorCode["TEMPLATE_PARSE_ERROR"] = "TEMPLATE_PARSE_ERROR";
|
|
32
|
+
ErrorCode["TEMPLATE_TYPE_MISMATCH"] = "TEMPLATE_TYPE_MISMATCH";
|
|
33
|
+
ErrorCode["TEMPLATE_SECRETS_RESERVED"] = "TEMPLATE_SECRETS_RESERVED";
|
|
34
|
+
ErrorCode["TEMPLATE_CONTRACT_VIOLATION"] = "TEMPLATE_CONTRACT_VIOLATION";
|
|
35
|
+
ErrorCode["TEMPLATE_SIZE_EXCEEDED"] = "TEMPLATE_SIZE_EXCEEDED";
|
|
36
|
+
ErrorCode["TEMPLATE_VALIDATION_FAILED"] = "TEMPLATE_VALIDATION_FAILED";
|
|
37
|
+
// Quota/Rate limit errors (429)
|
|
38
|
+
ErrorCode["QUOTA_EXCEEDED"] = "QUOTA_EXCEEDED";
|
|
39
|
+
ErrorCode["RATE_LIMIT_EXCEEDED"] = "RATE_LIMIT_EXCEEDED";
|
|
40
|
+
// Payload errors (413)
|
|
41
|
+
ErrorCode["PAYLOAD_TOO_LARGE"] = "PAYLOAD_TOO_LARGE";
|
|
42
|
+
// Conflict errors (409)
|
|
43
|
+
ErrorCode["CONFLICT"] = "CONFLICT";
|
|
44
|
+
ErrorCode["DUPLICATE_ENTRY"] = "DUPLICATE_ENTRY";
|
|
45
|
+
ErrorCode["SCAN_CONFLICT"] = "SCAN_CONFLICT";
|
|
46
|
+
// Billing errors
|
|
47
|
+
ErrorCode["PAYMENT_METHOD_REQUIRED"] = "PAYMENT_METHOD_REQUIRED";
|
|
48
|
+
ErrorCode["DISCOUNT_CEILING_EXCEEDED"] = "DISCOUNT_CEILING_EXCEEDED";
|
|
49
|
+
ErrorCode["DISCOUNT_NOT_FOUND"] = "DISCOUNT_NOT_FOUND";
|
|
50
|
+
ErrorCode["DISCOUNT_INACTIVE"] = "DISCOUNT_INACTIVE";
|
|
51
|
+
ErrorCode["PLAN_OVER_CAP"] = "PLAN_OVER_CAP";
|
|
52
|
+
ErrorCode["ADDON_OVER_CAP"] = "ADDON_OVER_CAP";
|
|
53
|
+
// Server errors (500)
|
|
54
|
+
ErrorCode["INTERNAL_ERROR"] = "INTERNAL_ERROR";
|
|
55
|
+
ErrorCode["DATABASE_ERROR"] = "DATABASE_ERROR";
|
|
56
|
+
// Service unavailable (503)
|
|
57
|
+
ErrorCode["SERVICE_UNAVAILABLE"] = "SERVICE_UNAVAILABLE";
|
|
58
|
+
ErrorCode["COMPLIANCE_SERVICE_UNAVAILABLE"] = "COMPLIANCE_SERVICE_UNAVAILABLE";
|
|
59
|
+
})(ErrorCode || (ErrorCode = {}));
|
|
60
|
+
/**
|
|
61
|
+
* Maps error codes to their default HTTP status codes.
|
|
62
|
+
*/
|
|
63
|
+
export const ErrorCodeStatus = {
|
|
64
|
+
[ErrorCode.UNAUTHORIZED]: 401,
|
|
65
|
+
[ErrorCode.TOKEN_EXPIRED]: 401,
|
|
66
|
+
[ErrorCode.TOKEN_INVALID]: 401,
|
|
67
|
+
[ErrorCode.TOKEN_MISSING]: 401,
|
|
68
|
+
[ErrorCode.TOKEN_REVOKED]: 401,
|
|
69
|
+
[ErrorCode.INSUFFICIENT_PERMISSIONS]: 403,
|
|
70
|
+
[ErrorCode.ORG_MISMATCH]: 403,
|
|
71
|
+
[ErrorCode.COMPLIANCE_VIOLATION]: 403,
|
|
72
|
+
[ErrorCode.NOT_FOUND]: 404,
|
|
73
|
+
[ErrorCode.ORG_NOT_FOUND]: 404,
|
|
74
|
+
[ErrorCode.VALIDATION_ERROR]: 400,
|
|
75
|
+
[ErrorCode.MISSING_REQUIRED_FIELD]: 400,
|
|
76
|
+
[ErrorCode.TEMPLATE_UNKNOWN_PATH]: 400,
|
|
77
|
+
[ErrorCode.TEMPLATE_CYCLE]: 400,
|
|
78
|
+
[ErrorCode.TEMPLATE_PARSE_ERROR]: 400,
|
|
79
|
+
[ErrorCode.TEMPLATE_TYPE_MISMATCH]: 400,
|
|
80
|
+
[ErrorCode.TEMPLATE_SECRETS_RESERVED]: 400,
|
|
81
|
+
[ErrorCode.TEMPLATE_CONTRACT_VIOLATION]: 400,
|
|
82
|
+
[ErrorCode.TEMPLATE_SIZE_EXCEEDED]: 400,
|
|
83
|
+
[ErrorCode.TEMPLATE_VALIDATION_FAILED]: 400,
|
|
84
|
+
[ErrorCode.QUOTA_EXCEEDED]: 429,
|
|
85
|
+
[ErrorCode.RATE_LIMIT_EXCEEDED]: 429,
|
|
86
|
+
[ErrorCode.PAYLOAD_TOO_LARGE]: 413,
|
|
87
|
+
[ErrorCode.CONFLICT]: 409,
|
|
88
|
+
[ErrorCode.DUPLICATE_ENTRY]: 409,
|
|
89
|
+
[ErrorCode.SCAN_CONFLICT]: 409,
|
|
90
|
+
[ErrorCode.PAYMENT_METHOD_REQUIRED]: 402,
|
|
91
|
+
[ErrorCode.DISCOUNT_CEILING_EXCEEDED]: 400,
|
|
92
|
+
[ErrorCode.DISCOUNT_NOT_FOUND]: 404,
|
|
93
|
+
[ErrorCode.DISCOUNT_INACTIVE]: 409,
|
|
94
|
+
[ErrorCode.PLAN_OVER_CAP]: 409,
|
|
95
|
+
[ErrorCode.ADDON_OVER_CAP]: 409,
|
|
96
|
+
[ErrorCode.INTERNAL_ERROR]: 500,
|
|
97
|
+
[ErrorCode.DATABASE_ERROR]: 500,
|
|
98
|
+
[ErrorCode.SERVICE_UNAVAILABLE]: 503,
|
|
99
|
+
[ErrorCode.COMPLIANCE_SERVICE_UNAVAILABLE]: 503,
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* Get the HTTP status code for an error code.
|
|
103
|
+
*/
|
|
104
|
+
export function getStatusForErrorCode(code) {
|
|
105
|
+
return ErrorCodeStatus[code] ?? 500;
|
|
106
|
+
}
|
|
107
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"error-codes.js","sourceRoot":"","sources":["../../src/types/error-codes.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,sCAAsC;AAEtC;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,SAwDX;AAxDD,WAAY,SAAS;IACnB,8BAA8B;IAC9B,0CAA6B,CAAA;IAC7B,4CAA+B,CAAA;IAC/B,4CAA+B,CAAA;IAC/B,4CAA+B,CAAA;IAC/B,4CAA+B,CAAA;IAE/B,6BAA6B;IAC7B,kEAAqD,CAAA;IACrD,0CAA6B,CAAA;IAC7B,0DAA6C,CAAA;IAE7C,yBAAyB;IACzB,oCAAuB,CAAA;IACvB,4CAA+B,CAAA;IAE/B,0BAA0B;IAC1B,kDAAqC,CAAA;IACrC,8DAAiD,CAAA;IACjD,4DAA+C,CAAA;IAC/C,8CAAiC,CAAA;IACjC,0DAA6C,CAAA;IAC7C,8DAAiD,CAAA;IACjD,oEAAuD,CAAA;IACvD,wEAA2D,CAAA;IAC3D,8DAAiD,CAAA;IACjD,sEAAyD,CAAA;IAEzD,gCAAgC;IAChC,8CAAiC,CAAA;IACjC,wDAA2C,CAAA;IAE3C,uBAAuB;IACvB,oDAAuC,CAAA;IAEvC,wBAAwB;IACxB,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,4CAA+B,CAAA;IAE/B,iBAAiB;IACjB,gEAAmD,CAAA;IACnD,oEAAuD,CAAA;IACvD,sDAAyC,CAAA;IACzC,oDAAuC,CAAA;IACvC,4CAA+B,CAAA;IAC/B,8CAAiC,CAAA;IAEjC,sBAAsB;IACtB,8CAAiC,CAAA;IACjC,8CAAiC,CAAA;IAEjC,4BAA4B;IAC5B,wDAA2C,CAAA;IAC3C,8EAAiE,CAAA;AACnE,CAAC,EAxDW,SAAS,KAAT,SAAS,QAwDpB;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAA8B;IACxD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,GAAG;IAC7B,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG;IAC9B,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG;IAC9B,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG;IAC9B,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG;IAC9B,CAAC,SAAS,CAAC,wBAAwB,CAAC,EAAE,GAAG;IACzC,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,GAAG;IAC7B,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,GAAG;IACrC,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,GAAG;IAC1B,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG;IAC9B,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,GAAG;IACjC,CAAC,SAAS,CAAC,sBAAsB,CAAC,EAAE,GAAG;IACvC,CAAC,SAAS,CAAC,qBAAqB,CAAC,EAAE,GAAG;IACtC,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,GAAG;IAC/B,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,GAAG;IACrC,CAAC,SAAS,CAAC,sBAAsB,CAAC,EAAE,GAAG;IACvC,CAAC,SAAS,CAAC,yBAAyB,CAAC,EAAE,GAAG;IAC1C,CAAC,SAAS,CAAC,2BAA2B,CAAC,EAAE,GAAG;IAC5C,CAAC,SAAS,CAAC,sBAAsB,CAAC,EAAE,GAAG;IACvC,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,GAAG;IAC3C,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,GAAG;IAC/B,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,GAAG;IACpC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,GAAG;IAClC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,GAAG;IACzB,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,GAAG;IAChC,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG;IAC9B,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,GAAG;IACxC,CAAC,SAAS,CAAC,yBAAyB,CAAC,EAAE,GAAG;IAC1C,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,GAAG;IACnC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,GAAG;IAClC,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG;IAC9B,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,GAAG;IAC/B,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,GAAG;IAC/B,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,GAAG;IAC/B,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,GAAG;IACpC,CAAC,SAAS,CAAC,8BAA8B,CAAC,EAAE,GAAG;CAChD,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAe;IACnD,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC;AACtC,CAAC","sourcesContent":["// Copyright 2026 Pipeline Builder Contributors\n// SPDX-License-Identifier: Apache-2.0\n\n/**\n * Standardized error codes used across all API microservices.\n * Use these codes in error responses for consistent client handling.\n *\n * Each HTTP status category has one primary code. Use the `details`\n * field in error responses for sub-type information (e.g. which quota\n * was exceeded, which field failed validation).\n */\nexport enum ErrorCode {\n  // Authentication errors (401)\n  UNAUTHORIZED = 'UNAUTHORIZED',\n  TOKEN_EXPIRED = 'TOKEN_EXPIRED',\n  TOKEN_INVALID = 'TOKEN_INVALID',\n  TOKEN_MISSING = 'TOKEN_MISSING',\n  TOKEN_REVOKED = 'TOKEN_REVOKED',\n\n  // Authorization errors (403)\n  INSUFFICIENT_PERMISSIONS = 'INSUFFICIENT_PERMISSIONS',\n  ORG_MISMATCH = 'ORG_MISMATCH',\n  COMPLIANCE_VIOLATION = 'COMPLIANCE_VIOLATION',\n\n  // Not found errors (404)\n  NOT_FOUND = 'NOT_FOUND',\n  ORG_NOT_FOUND = 'ORG_NOT_FOUND',\n\n  // Validation errors (400)\n  VALIDATION_ERROR = 'VALIDATION_ERROR',\n  MISSING_REQUIRED_FIELD = 'MISSING_REQUIRED_FIELD',\n  TEMPLATE_UNKNOWN_PATH = 'TEMPLATE_UNKNOWN_PATH',\n  TEMPLATE_CYCLE = 'TEMPLATE_CYCLE',\n  TEMPLATE_PARSE_ERROR = 'TEMPLATE_PARSE_ERROR',\n  TEMPLATE_TYPE_MISMATCH = 'TEMPLATE_TYPE_MISMATCH',\n  TEMPLATE_SECRETS_RESERVED = 'TEMPLATE_SECRETS_RESERVED',\n  TEMPLATE_CONTRACT_VIOLATION = 'TEMPLATE_CONTRACT_VIOLATION',\n  TEMPLATE_SIZE_EXCEEDED = 'TEMPLATE_SIZE_EXCEEDED',\n  TEMPLATE_VALIDATION_FAILED = 'TEMPLATE_VALIDATION_FAILED',\n\n  // Quota/Rate limit errors (429)\n  QUOTA_EXCEEDED = 'QUOTA_EXCEEDED',\n  RATE_LIMIT_EXCEEDED = 'RATE_LIMIT_EXCEEDED',\n\n  // Payload errors (413)\n  PAYLOAD_TOO_LARGE = 'PAYLOAD_TOO_LARGE',\n\n  // Conflict errors (409)\n  CONFLICT = 'CONFLICT',\n  DUPLICATE_ENTRY = 'DUPLICATE_ENTRY',\n  SCAN_CONFLICT = 'SCAN_CONFLICT',\n\n  // Billing errors\n  PAYMENT_METHOD_REQUIRED = 'PAYMENT_METHOD_REQUIRED', // 402\n  DISCOUNT_CEILING_EXCEEDED = 'DISCOUNT_CEILING_EXCEEDED', // 400\n  DISCOUNT_NOT_FOUND = 'DISCOUNT_NOT_FOUND', // 404\n  DISCOUNT_INACTIVE = 'DISCOUNT_INACTIVE', // 409\n  PLAN_OVER_CAP = 'PLAN_OVER_CAP', // 409\n  ADDON_OVER_CAP = 'ADDON_OVER_CAP', // 409\n\n  // Server errors (500)\n  INTERNAL_ERROR = 'INTERNAL_ERROR',\n  DATABASE_ERROR = 'DATABASE_ERROR',\n\n  // Service unavailable (503)\n  SERVICE_UNAVAILABLE = 'SERVICE_UNAVAILABLE',\n  COMPLIANCE_SERVICE_UNAVAILABLE = 'COMPLIANCE_SERVICE_UNAVAILABLE',\n}\n\n/**\n * Maps error codes to their default HTTP status codes.\n */\nexport const ErrorCodeStatus: Record<ErrorCode, number> = {\n  [ErrorCode.UNAUTHORIZED]: 401,\n  [ErrorCode.TOKEN_EXPIRED]: 401,\n  [ErrorCode.TOKEN_INVALID]: 401,\n  [ErrorCode.TOKEN_MISSING]: 401,\n  [ErrorCode.TOKEN_REVOKED]: 401,\n  [ErrorCode.INSUFFICIENT_PERMISSIONS]: 403,\n  [ErrorCode.ORG_MISMATCH]: 403,\n  [ErrorCode.COMPLIANCE_VIOLATION]: 403,\n  [ErrorCode.NOT_FOUND]: 404,\n  [ErrorCode.ORG_NOT_FOUND]: 404,\n  [ErrorCode.VALIDATION_ERROR]: 400,\n  [ErrorCode.MISSING_REQUIRED_FIELD]: 400,\n  [ErrorCode.TEMPLATE_UNKNOWN_PATH]: 400,\n  [ErrorCode.TEMPLATE_CYCLE]: 400,\n  [ErrorCode.TEMPLATE_PARSE_ERROR]: 400,\n  [ErrorCode.TEMPLATE_TYPE_MISMATCH]: 400,\n  [ErrorCode.TEMPLATE_SECRETS_RESERVED]: 400,\n  [ErrorCode.TEMPLATE_CONTRACT_VIOLATION]: 400,\n  [ErrorCode.TEMPLATE_SIZE_EXCEEDED]: 400,\n  [ErrorCode.TEMPLATE_VALIDATION_FAILED]: 400,\n  [ErrorCode.QUOTA_EXCEEDED]: 429,\n  [ErrorCode.RATE_LIMIT_EXCEEDED]: 429,\n  [ErrorCode.PAYLOAD_TOO_LARGE]: 413,\n  [ErrorCode.CONFLICT]: 409,\n  [ErrorCode.DUPLICATE_ENTRY]: 409,\n  [ErrorCode.SCAN_CONFLICT]: 409,\n  [ErrorCode.PAYMENT_METHOD_REQUIRED]: 402,\n  [ErrorCode.DISCOUNT_CEILING_EXCEEDED]: 400,\n  [ErrorCode.DISCOUNT_NOT_FOUND]: 404,\n  [ErrorCode.DISCOUNT_INACTIVE]: 409,\n  [ErrorCode.PLAN_OVER_CAP]: 409,\n  [ErrorCode.ADDON_OVER_CAP]: 409,\n  [ErrorCode.INTERNAL_ERROR]: 500,\n  [ErrorCode.DATABASE_ERROR]: 500,\n  [ErrorCode.SERVICE_UNAVAILABLE]: 503,\n  [ErrorCode.COMPLIANCE_SERVICE_UNAVAILABLE]: 503,\n};\n\n/**\n * Get the HTTP status code for an error code.\n */\nexport function getStatusForErrorCode(code: ErrorCode): number {\n  return ErrorCodeStatus[code] ?? 500;\n}\n"]}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { QuotaTier } from './quota-tiers.js';
|
|
2
|
+
/** Canonical feature flag identifiers. */
|
|
3
|
+
export type FeatureFlag = 'priority_support' | 'custom_integrations' | 'ai_generation' | 'bulk_operations' | 'audit_log' | 'sso' | 'advanced_reporting' | 'team_usage_analytics' | 'compliance_standard' | 'compliance_advanced';
|
|
4
|
+
/** All valid feature flags (order determines display order). */
|
|
5
|
+
export declare const ALL_FEATURE_FLAGS: readonly FeatureFlag[];
|
|
6
|
+
/** Check whether a string is a valid FeatureFlag. */
|
|
7
|
+
export declare function isValidFeatureFlag(value: string): value is FeatureFlag;
|
|
8
|
+
/** Features enabled by default for each tier. */
|
|
9
|
+
export declare const TIER_FEATURES: Record<QuotaTier, readonly FeatureFlag[]>;
|
|
10
|
+
/** Human-readable metadata for each feature flag. */
|
|
11
|
+
export declare const FEATURE_METADATA: Record<FeatureFlag, {
|
|
12
|
+
label: string;
|
|
13
|
+
description: string;
|
|
14
|
+
}>;
|
|
15
|
+
/**
|
|
16
|
+
* Resolve a user's effective feature set.
|
|
17
|
+
*
|
|
18
|
+
* 1. Sysadmins (isSuperAdmin) always get ALL features.
|
|
19
|
+
* 2. Start with the tier's default features.
|
|
20
|
+
* 3. Apply per-user overrides: `true` adds a feature, `false` removes it.
|
|
21
|
+
* 4. Invalid override keys are silently ignored.
|
|
22
|
+
*
|
|
23
|
+
* @param tier - The organization's quota tier
|
|
24
|
+
* @param opts - Resolution options:
|
|
25
|
+
* - `overrides`: per-user overrides (key = feature flag, value = enabled)
|
|
26
|
+
* - `isSuperAdmin`: whether the user has the global super-admin flag
|
|
27
|
+
* - `accountFeatures`: account-level entitlements (e.g. purchased add-on
|
|
28
|
+
* bundles). A NAMED field so it can never be silently dropped by a caller
|
|
29
|
+
* that omits a trailing positional arg.
|
|
30
|
+
* @returns Sorted array of enabled feature flags
|
|
31
|
+
*/
|
|
32
|
+
export declare function resolveUserFeatures(tier: QuotaTier, opts?: {
|
|
33
|
+
overrides?: Record<string, boolean> | null;
|
|
34
|
+
isSuperAdmin?: boolean;
|
|
35
|
+
accountFeatures?: readonly string[] | null;
|
|
36
|
+
}): FeatureFlag[];
|