@pipeline-builder/api-core 3.4.57 → 3.4.58
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/README.md +13 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,9 +20,10 @@ Core server-side utilities shared by every backend service in [Pipeline Builder]
|
|
|
20
20
|
Tokens satisfy the standard `requireAuth` middleware unmodified (sub: `service:<name>`, role: `owner`, type: `access`). Use for inter-service HTTP calls (billing → message renewals, platform → billing on register, etc.).
|
|
21
21
|
|
|
22
22
|
### Request/Response Utilities
|
|
23
|
-
- `sendSuccess`, `sendError`, `sendBadRequest`, `sendInternalError`, `sendPaginated`, `sendPaginatedNested`
|
|
23
|
+
- `sendSuccess`, `sendError`, `sendBadRequest`, `sendInternalError`, `sendQuotaExceeded`, `sendPaginated`, `sendPaginatedNested`
|
|
24
24
|
- `extractDbError` — Extract database error details
|
|
25
25
|
- `ErrorCode`, `getStatusForErrorCode` — Standard error codes
|
|
26
|
+
- `AppError`, `NotFoundError`, `ForbiddenError`, `ValidationError`, `ConflictError`, `UnauthorizedError` — Typed HTTP error classes
|
|
26
27
|
|
|
27
28
|
### Parameter Parsing
|
|
28
29
|
- `getParam`, `getRequiredParam`, `getParams`, `getOrgId`, `getAuthHeader`
|
|
@@ -31,10 +32,12 @@ Tokens satisfy the standard `requireAuth` middleware unmodified (sub: `service:<
|
|
|
31
32
|
### Validation Schemas (Zod)
|
|
32
33
|
- `AIGenerateBodySchema` — Validates AI generation requests (prompt, provider, model)
|
|
33
34
|
- `AIGenerateFromUrlBodySchema` — Validates Git URL generation requests (gitUrl, provider, model, apiKey?, repoToken?)
|
|
35
|
+
- Plugin, pipeline, and message schemas (`PluginCreateSchema`, `PipelineFilterSchema`, `MessageCreateSchema`, etc.) plus shared building blocks (`PaginationSchema`, `UUIDSchema`, `AccessModifierSchema`)
|
|
34
36
|
|
|
35
37
|
### Internal HTTP Client
|
|
36
38
|
- `InternalHttpClient`, `createSafeClient` — Service-to-service HTTP communication
|
|
37
39
|
- `ServiceConfig`, `RequestOptions` — Client types
|
|
40
|
+
- `createComplianceClient` / `ComplianceClient` — Typed client for the compliance service, built on the safe HTTP client
|
|
38
41
|
|
|
39
42
|
### AI Provider Constants
|
|
40
43
|
- `AI_PROVIDER_CATALOG` — Static provider/model catalog
|
|
@@ -44,10 +47,17 @@ Tokens satisfy the standard `requireAuth` middleware unmodified (sub: `service:<
|
|
|
44
47
|
### Logging
|
|
45
48
|
- `createLogger` — Winston logger factory
|
|
46
49
|
|
|
50
|
+
### Caching & Events
|
|
51
|
+
- `CacheService`, `createCacheService` — In-memory TTL cache with an optional Redis backend
|
|
52
|
+
- `entityEvents` — Process-local domain event pub/sub for entity changes
|
|
53
|
+
|
|
54
|
+
### OpenAPI
|
|
55
|
+
- `registry`, `generateOpenApiSpec` — Shared schema registry and OpenAPI spec generation, so services expose consistent API documentation
|
|
56
|
+
|
|
47
57
|
### Quota Service
|
|
48
58
|
- `QuotaService` (type), `createQuotaService` — Quota enforcement client
|
|
49
|
-
- `QuotaType` — `'plugins' | 'pipelines' | 'apiCalls' | 'aiCalls'`
|
|
50
|
-
- `QuotaCheckResult`, `QuotaTier
|
|
59
|
+
- `QuotaType` — `'plugins' | 'pipelines' | 'apiCalls' | 'aiCalls' | 'storageBytes' | 'dashboards' | 'alertRules' | 'alertDestinations' | 'idpConfigs'`
|
|
60
|
+
- `QuotaCheckResult`, `QuotaTier` (`'developer' | 'pro' | 'unlimited'`), `QUOTA_TIERS`, `getTierLimits` — Quota domain types and tier presets
|
|
51
61
|
|
|
52
62
|
### Health Endpoints
|
|
53
63
|
- `createHealthRouter({ serviceName, version?, checkDependencies? })` — registers `GET /health` (liveness; always 200 unless process is dead) and `GET /ready` (readiness; 503 when any dependency is `'disconnected'`). Use as Kubernetes/ECS liveness + readiness probes respectively.
|