@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,160 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Message type schema
|
|
4
|
+
*/
|
|
5
|
+
export declare const MessageTypeSchema: z.ZodEnum<{
|
|
6
|
+
announcement: "announcement";
|
|
7
|
+
conversation: "conversation";
|
|
8
|
+
}>;
|
|
9
|
+
/**
|
|
10
|
+
* Message priority schema
|
|
11
|
+
*/
|
|
12
|
+
export declare const MessagePrioritySchema: z.ZodEnum<{
|
|
13
|
+
high: "high";
|
|
14
|
+
normal: "normal";
|
|
15
|
+
urgent: "urgent";
|
|
16
|
+
}>;
|
|
17
|
+
/**
|
|
18
|
+
* Channel/inbox-bucket schema. Open-ended string up to 50 chars so we
|
|
19
|
+
* can add new channels (support, help, billing, …) without a schema
|
|
20
|
+
* migration. Constrained to a-z/0-9/dash/underscore for URL safety and
|
|
21
|
+
* to keep filter conditions trivially indexable.
|
|
22
|
+
*/
|
|
23
|
+
export declare const MessageChannelSchema: z.ZodString;
|
|
24
|
+
/**
|
|
25
|
+
* Message filter schema for query parameters.
|
|
26
|
+
*
|
|
27
|
+
* Convention for `threadId`:
|
|
28
|
+
* - Omitted (undefined): no filter applied — returns messages regardless of thread.
|
|
29
|
+
* - `'root'` or `null`: filter for root messages only (translated to `threadId IS NULL`
|
|
30
|
+
* by the route layer / query builder). The string sentinel `'root'` is the
|
|
31
|
+
* wire form, since URL query params can't carry a true `null`.
|
|
32
|
+
* - A UUID: filter for messages in that specific thread.
|
|
33
|
+
*
|
|
34
|
+
* `isRead` is honored by `buildMessageConditions` in pipeline-data via a
|
|
35
|
+
* `jsonb_exists(read_by, $orgId)` check on `messages.read_by` for the requesting
|
|
36
|
+
* org (the function form, not the `?` operator, to avoid param-binding clashes).
|
|
37
|
+
*/
|
|
38
|
+
export declare const MessageFilterSchema: z.ZodObject<{
|
|
39
|
+
id: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodString]>>;
|
|
40
|
+
visibility: z.ZodOptional<z.ZodEnum<{
|
|
41
|
+
org: "org";
|
|
42
|
+
private: "private";
|
|
43
|
+
public: "public";
|
|
44
|
+
}>>;
|
|
45
|
+
isActive: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodPipe<z.ZodEnum<{
|
|
46
|
+
false: "false";
|
|
47
|
+
true: "true";
|
|
48
|
+
}>, z.ZodTransform<boolean, "false" | "true">>, z.ZodPipe<z.ZodString, z.ZodTransform<boolean, string>>]>>;
|
|
49
|
+
isDefault: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodPipe<z.ZodEnum<{
|
|
50
|
+
false: "false";
|
|
51
|
+
true: "true";
|
|
52
|
+
}>, z.ZodTransform<boolean, "false" | "true">>, z.ZodPipe<z.ZodString, z.ZodTransform<boolean, string>>]>>;
|
|
53
|
+
ownerId: z.ZodOptional<z.ZodString>;
|
|
54
|
+
lifecycle: z.ZodOptional<z.ZodEnum<{
|
|
55
|
+
deprecated: "deprecated";
|
|
56
|
+
experimental: "experimental";
|
|
57
|
+
production: "production";
|
|
58
|
+
}>>;
|
|
59
|
+
threadId: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"root">, z.ZodNull]>>;
|
|
60
|
+
recipientOrgId: z.ZodOptional<z.ZodString>;
|
|
61
|
+
messageType: z.ZodOptional<z.ZodEnum<{
|
|
62
|
+
announcement: "announcement";
|
|
63
|
+
conversation: "conversation";
|
|
64
|
+
}>>;
|
|
65
|
+
isRead: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodPipe<z.ZodEnum<{
|
|
66
|
+
false: "false";
|
|
67
|
+
true: "true";
|
|
68
|
+
}>, z.ZodTransform<boolean, "false" | "true">>, z.ZodPipe<z.ZodString, z.ZodTransform<boolean, string>>]>>;
|
|
69
|
+
priority: z.ZodOptional<z.ZodEnum<{
|
|
70
|
+
high: "high";
|
|
71
|
+
normal: "normal";
|
|
72
|
+
urgent: "urgent";
|
|
73
|
+
}>>;
|
|
74
|
+
channel: z.ZodOptional<z.ZodString>;
|
|
75
|
+
search: z.ZodOptional<z.ZodString>;
|
|
76
|
+
}, z.core.$strip>;
|
|
77
|
+
/**
|
|
78
|
+
* Upper bounds on free-text message fields. Without these an unbounded
|
|
79
|
+
* subject/content (e.g. a 1MB announcement) is persisted AND SSE-broadcast to
|
|
80
|
+
* every org. `subject` matches the `varchar(500)` DB column so we reject rather
|
|
81
|
+
* than silently truncate; `content` is a `text` column with no DB bound, so we
|
|
82
|
+
* cap it at a sane 32 KiB at the app layer.
|
|
83
|
+
*/
|
|
84
|
+
export declare const MESSAGE_SUBJECT_MAX = 500;
|
|
85
|
+
export declare const MESSAGE_CONTENT_MAX = 32768;
|
|
86
|
+
/** Max attachments linkable to a single message/reply. */
|
|
87
|
+
export declare const MESSAGE_MAX_ATTACHMENTS = 5;
|
|
88
|
+
/**
|
|
89
|
+
* Max attachment size (MiB) — env-overridable. The upload route enforces this
|
|
90
|
+
* (multer `fileSize`); kept here so the bound lives with the other message
|
|
91
|
+
* limits rather than only inline in the route.
|
|
92
|
+
*/
|
|
93
|
+
export declare const MESSAGE_ATTACHMENT_MAX_MB: number;
|
|
94
|
+
export declare const MESSAGE_ATTACHMENT_MAX_BYTES: number;
|
|
95
|
+
/**
|
|
96
|
+
* Allow-list of attachment MIME types — common images + documents + zip/yaml/json.
|
|
97
|
+
* Deliberately excludes executables/scripts/HTML/SVG (stored-XSS / drive-by).
|
|
98
|
+
* zip is a download container (doesn't render in-browser); yaml/json are plain
|
|
99
|
+
* text — none carry the drive-by risk of the excluded types. Extend here.
|
|
100
|
+
*/
|
|
101
|
+
export declare const MESSAGE_ATTACHMENT_ALLOWED_MIME: ReadonlySet<string>;
|
|
102
|
+
/**
|
|
103
|
+
* Safe filename extensions. Browsers frequently send `application/octet-stream`
|
|
104
|
+
* for archives + config files (.tar/.gz/.tgz/.yaml/…) because they have no
|
|
105
|
+
* reliable registered MIME type, so the MIME allow-list alone rejects them. These
|
|
106
|
+
* extensions are accepted as a fallback ONLY when the reported MIME is that
|
|
107
|
+
* generic type (see isAllowedAttachmentType) — so a known render/execute MIME
|
|
108
|
+
* (image/svg+xml, text/html, …) is never rescued by a spoofed extension. Still
|
|
109
|
+
* excludes .html/.svg/.js/.exe/… (never listed here).
|
|
110
|
+
*/
|
|
111
|
+
export declare const MESSAGE_ATTACHMENT_ALLOWED_EXT: ReadonlySet<string>;
|
|
112
|
+
/**
|
|
113
|
+
* True if an attachment is accepted. Accepts by MIME allow-list, OR — when the
|
|
114
|
+
* browser reports the generic `application/octet-stream` (unknown binary) — by a
|
|
115
|
+
* safe filename extension. octet-stream is served as a download (never rendered),
|
|
116
|
+
* so the extension fallback can't turn into a stored-XSS vector.
|
|
117
|
+
*/
|
|
118
|
+
export declare function isAllowedAttachmentType(mimetype: string, filename: string): boolean;
|
|
119
|
+
/** Attachment metadata DTO returned to clients (never exposes the storage key). */
|
|
120
|
+
export interface MessageAttachmentDTO {
|
|
121
|
+
id: string;
|
|
122
|
+
filename: string;
|
|
123
|
+
contentType: string;
|
|
124
|
+
sizeBytes: number;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Message creation schema
|
|
128
|
+
*/
|
|
129
|
+
export declare const MessageCreateSchema: z.ZodObject<{
|
|
130
|
+
recipientOrgId: z.ZodString;
|
|
131
|
+
recipientUserId: z.ZodOptional<z.ZodString>;
|
|
132
|
+
messageType: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
133
|
+
announcement: "announcement";
|
|
134
|
+
conversation: "conversation";
|
|
135
|
+
}>>>;
|
|
136
|
+
channel: z.ZodOptional<z.ZodString>;
|
|
137
|
+
subject: z.ZodString;
|
|
138
|
+
content: z.ZodString;
|
|
139
|
+
priority: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
140
|
+
high: "high";
|
|
141
|
+
normal: "normal";
|
|
142
|
+
urgent: "urgent";
|
|
143
|
+
}>>>;
|
|
144
|
+
attachmentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
145
|
+
}, z.core.$strip>;
|
|
146
|
+
/**
|
|
147
|
+
* Message reply schema
|
|
148
|
+
*/
|
|
149
|
+
export declare const MessageReplySchema: z.ZodObject<{
|
|
150
|
+
content: z.ZodString;
|
|
151
|
+
attachmentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
152
|
+
}, z.core.$strip>;
|
|
153
|
+
/**
|
|
154
|
+
* Edit an already-sent message's CONTENT (author-only, enforced server-side).
|
|
155
|
+
* Only the body is editable — subject/recipient/type/attachments are immutable
|
|
156
|
+
* after send (changing them would rewrite the conversation's routing/meaning).
|
|
157
|
+
*/
|
|
158
|
+
export declare const MessageEditSchema: z.ZodObject<{
|
|
159
|
+
content: z.ZodString;
|
|
160
|
+
}, z.core.$strip>;
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
import { z } from 'zod';
|
|
4
|
+
import { BaseFilterSchema, BooleanQuerySchema } from './common-schemas.js';
|
|
5
|
+
/**
|
|
6
|
+
* Message type schema
|
|
7
|
+
*/
|
|
8
|
+
export const MessageTypeSchema = z.enum(['announcement', 'conversation']);
|
|
9
|
+
/**
|
|
10
|
+
* Message priority schema
|
|
11
|
+
*/
|
|
12
|
+
export const MessagePrioritySchema = z.enum(['normal', 'high', 'urgent']);
|
|
13
|
+
/**
|
|
14
|
+
* Channel/inbox-bucket schema. Open-ended string up to 50 chars so we
|
|
15
|
+
* can add new channels (support, help, billing, …) without a schema
|
|
16
|
+
* migration. Constrained to a-z/0-9/dash/underscore for URL safety and
|
|
17
|
+
* to keep filter conditions trivially indexable.
|
|
18
|
+
*/
|
|
19
|
+
export const MessageChannelSchema = z.string().min(1).max(50).regex(/^[a-z0-9_-]+$/);
|
|
20
|
+
/**
|
|
21
|
+
* Message filter schema for query parameters.
|
|
22
|
+
*
|
|
23
|
+
* Convention for `threadId`:
|
|
24
|
+
* - Omitted (undefined): no filter applied — returns messages regardless of thread.
|
|
25
|
+
* - `'root'` or `null`: filter for root messages only (translated to `threadId IS NULL`
|
|
26
|
+
* by the route layer / query builder). The string sentinel `'root'` is the
|
|
27
|
+
* wire form, since URL query params can't carry a true `null`.
|
|
28
|
+
* - A UUID: filter for messages in that specific thread.
|
|
29
|
+
*
|
|
30
|
+
* `isRead` is honored by `buildMessageConditions` in pipeline-data via a
|
|
31
|
+
* `jsonb_exists(read_by, $orgId)` check on `messages.read_by` for the requesting
|
|
32
|
+
* org (the function form, not the `?` operator, to avoid param-binding clashes).
|
|
33
|
+
*/
|
|
34
|
+
export const MessageFilterSchema = BaseFilterSchema.extend({
|
|
35
|
+
threadId: z.union([z.string().uuid(), z.literal('root'), z.null()]).optional(),
|
|
36
|
+
recipientOrgId: z.string().min(1).optional(),
|
|
37
|
+
messageType: MessageTypeSchema.optional(),
|
|
38
|
+
isRead: BooleanQuerySchema.optional(),
|
|
39
|
+
priority: MessagePrioritySchema.optional(),
|
|
40
|
+
channel: MessageChannelSchema.optional(),
|
|
41
|
+
// Free-text inbox search over subject/content. Bounded so a pathological term
|
|
42
|
+
// can't blow up the LIKE; the query builder escapes wildcards + ignores blanks.
|
|
43
|
+
search: z.string().trim().min(1).max(200).optional(),
|
|
44
|
+
});
|
|
45
|
+
/**
|
|
46
|
+
* Upper bounds on free-text message fields. Without these an unbounded
|
|
47
|
+
* subject/content (e.g. a 1MB announcement) is persisted AND SSE-broadcast to
|
|
48
|
+
* every org. `subject` matches the `varchar(500)` DB column so we reject rather
|
|
49
|
+
* than silently truncate; `content` is a `text` column with no DB bound, so we
|
|
50
|
+
* cap it at a sane 32 KiB at the app layer.
|
|
51
|
+
*/
|
|
52
|
+
export const MESSAGE_SUBJECT_MAX = 500;
|
|
53
|
+
export const MESSAGE_CONTENT_MAX = 32768;
|
|
54
|
+
/** Max attachments linkable to a single message/reply. */
|
|
55
|
+
export const MESSAGE_MAX_ATTACHMENTS = 5;
|
|
56
|
+
/**
|
|
57
|
+
* Max attachment size (MiB) — env-overridable. The upload route enforces this
|
|
58
|
+
* (multer `fileSize`); kept here so the bound lives with the other message
|
|
59
|
+
* limits rather than only inline in the route.
|
|
60
|
+
*/
|
|
61
|
+
export const MESSAGE_ATTACHMENT_MAX_MB = Math.max(1, Number.parseInt(process.env.MESSAGE_ATTACHMENT_MAX_MB ?? '10', 10) || 10);
|
|
62
|
+
export const MESSAGE_ATTACHMENT_MAX_BYTES = MESSAGE_ATTACHMENT_MAX_MB * 1024 * 1024;
|
|
63
|
+
/**
|
|
64
|
+
* Allow-list of attachment MIME types — common images + documents + zip/yaml/json.
|
|
65
|
+
* Deliberately excludes executables/scripts/HTML/SVG (stored-XSS / drive-by).
|
|
66
|
+
* zip is a download container (doesn't render in-browser); yaml/json are plain
|
|
67
|
+
* text — none carry the drive-by risk of the excluded types. Extend here.
|
|
68
|
+
*/
|
|
69
|
+
export const MESSAGE_ATTACHMENT_ALLOWED_MIME = new Set([
|
|
70
|
+
'image/png', 'image/jpeg', 'image/gif', 'image/webp',
|
|
71
|
+
'application/pdf', 'text/plain', 'text/csv',
|
|
72
|
+
'application/msword',
|
|
73
|
+
'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
|
|
74
|
+
'application/vnd.ms-excel',
|
|
75
|
+
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
|
|
76
|
+
'application/vnd.openxmlformats-officedocument.presentationml.presentation',
|
|
77
|
+
// Archives (zip / gz / tar / tar.gz) — browsers report these variously by OS;
|
|
78
|
+
// cover the common variants. They download rather than render in-browser.
|
|
79
|
+
'application/zip', 'application/x-zip-compressed',
|
|
80
|
+
'application/gzip', 'application/x-gzip',
|
|
81
|
+
'application/x-tar', 'application/tar',
|
|
82
|
+
'application/x-compressed-tar',
|
|
83
|
+
// json (browsers may send application/json or text/json).
|
|
84
|
+
'application/json', 'text/json',
|
|
85
|
+
// yaml/yml — no single registered type; cover the common variants.
|
|
86
|
+
'application/x-yaml', 'application/yaml', 'text/yaml', 'text/x-yaml',
|
|
87
|
+
]);
|
|
88
|
+
/**
|
|
89
|
+
* Safe filename extensions. Browsers frequently send `application/octet-stream`
|
|
90
|
+
* for archives + config files (.tar/.gz/.tgz/.yaml/…) because they have no
|
|
91
|
+
* reliable registered MIME type, so the MIME allow-list alone rejects them. These
|
|
92
|
+
* extensions are accepted as a fallback ONLY when the reported MIME is that
|
|
93
|
+
* generic type (see isAllowedAttachmentType) — so a known render/execute MIME
|
|
94
|
+
* (image/svg+xml, text/html, …) is never rescued by a spoofed extension. Still
|
|
95
|
+
* excludes .html/.svg/.js/.exe/… (never listed here).
|
|
96
|
+
*/
|
|
97
|
+
export const MESSAGE_ATTACHMENT_ALLOWED_EXT = new Set([
|
|
98
|
+
'.png', '.jpg', '.jpeg', '.gif', '.webp',
|
|
99
|
+
'.pdf', '.txt', '.csv', '.doc', '.docx', '.xls', '.xlsx', '.ppt', '.pptx',
|
|
100
|
+
'.zip', '.gz', '.tgz', '.tar', '.json', '.yaml', '.yml',
|
|
101
|
+
]);
|
|
102
|
+
/**
|
|
103
|
+
* True if an attachment is accepted. Accepts by MIME allow-list, OR — when the
|
|
104
|
+
* browser reports the generic `application/octet-stream` (unknown binary) — by a
|
|
105
|
+
* safe filename extension. octet-stream is served as a download (never rendered),
|
|
106
|
+
* so the extension fallback can't turn into a stored-XSS vector.
|
|
107
|
+
*/
|
|
108
|
+
export function isAllowedAttachmentType(mimetype, filename) {
|
|
109
|
+
if (MESSAGE_ATTACHMENT_ALLOWED_MIME.has(mimetype))
|
|
110
|
+
return true;
|
|
111
|
+
if (mimetype !== 'application/octet-stream')
|
|
112
|
+
return false;
|
|
113
|
+
const dot = (filename || '').lastIndexOf('.');
|
|
114
|
+
if (dot < 0)
|
|
115
|
+
return false;
|
|
116
|
+
return MESSAGE_ATTACHMENT_ALLOWED_EXT.has(filename.slice(dot).toLowerCase());
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Attachment ids to link to a message. Each is the id returned by a prior
|
|
120
|
+
* POST /messages/attachments upload; the create route links only ids that belong
|
|
121
|
+
* to the caller (own org + uploader) and are still unattached.
|
|
122
|
+
*/
|
|
123
|
+
const AttachmentIdsSchema = z.array(z.string().uuid()).max(MESSAGE_MAX_ATTACHMENTS).optional();
|
|
124
|
+
/**
|
|
125
|
+
* Message creation schema
|
|
126
|
+
*/
|
|
127
|
+
export const MessageCreateSchema = z.object({
|
|
128
|
+
recipientOrgId: z.string().min(1, 'Recipient organization ID is required'),
|
|
129
|
+
// Optional per-user targeting WITHIN recipientOrgId. When set, only this user
|
|
130
|
+
// sees the conversation (enforced in buildMessageConditions). Conversation-only
|
|
131
|
+
// and requires a concrete recipient org — the route rejects it on announcements
|
|
132
|
+
// and '*' broadcasts. Bounded to the recipient_user_id column width.
|
|
133
|
+
recipientUserId: z.string().min(1).max(255).optional(),
|
|
134
|
+
messageType: MessageTypeSchema.optional().default('conversation'),
|
|
135
|
+
channel: MessageChannelSchema.optional(),
|
|
136
|
+
subject: z.string().min(1, 'Subject is required').max(MESSAGE_SUBJECT_MAX, `Subject must be at most ${MESSAGE_SUBJECT_MAX} characters`),
|
|
137
|
+
content: z.string().min(1, 'Content is required').max(MESSAGE_CONTENT_MAX, `Content must be at most ${MESSAGE_CONTENT_MAX} characters`),
|
|
138
|
+
priority: MessagePrioritySchema.optional().default('normal'),
|
|
139
|
+
attachmentIds: AttachmentIdsSchema,
|
|
140
|
+
});
|
|
141
|
+
/**
|
|
142
|
+
* Message reply schema
|
|
143
|
+
*/
|
|
144
|
+
export const MessageReplySchema = z.object({
|
|
145
|
+
content: z.string().min(1, 'Content is required').max(MESSAGE_CONTENT_MAX, `Content must be at most ${MESSAGE_CONTENT_MAX} characters`),
|
|
146
|
+
attachmentIds: AttachmentIdsSchema,
|
|
147
|
+
});
|
|
148
|
+
/**
|
|
149
|
+
* Edit an already-sent message's CONTENT (author-only, enforced server-side).
|
|
150
|
+
* Only the body is editable — subject/recipient/type/attachments are immutable
|
|
151
|
+
* after send (changing them would rewrite the conversation's routing/meaning).
|
|
152
|
+
*/
|
|
153
|
+
export const MessageEditSchema = z.object({
|
|
154
|
+
content: z.string().min(1, 'Content is required').max(MESSAGE_CONTENT_MAX, `Content must be at most ${MESSAGE_CONTENT_MAX} characters`),
|
|
155
|
+
});
|
|
156
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"message-schemas.js","sourceRoot":"","sources":["../../src/validation/message-schemas.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,sCAAsC;AAEtC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAE3E;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AAErF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,CAAC;IACzD,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC9E,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC5C,WAAW,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACrC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,EAAE;IAC1C,OAAO,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACxC,8EAA8E;IAC9E,gFAAgF;IAChF,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;CACrD,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AACvC,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,CAAC;AAEzC,0DAA0D;AAC1D,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC;AAEzC;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,IAAI,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;AAC/H,MAAM,CAAC,MAAM,4BAA4B,GAAG,yBAAyB,GAAG,IAAI,GAAG,IAAI,CAAC;AAEpF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAwB,IAAI,GAAG,CAAC;IAC1E,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY;IACpD,iBAAiB,EAAE,YAAY,EAAE,UAAU;IAC3C,oBAAoB;IACpB,yEAAyE;IACzE,0BAA0B;IAC1B,mEAAmE;IACnE,2EAA2E;IAC3E,8EAA8E;IAC9E,0EAA0E;IAC1E,iBAAiB,EAAE,8BAA8B;IACjD,kBAAkB,EAAE,oBAAoB;IACxC,mBAAmB,EAAE,iBAAiB;IACtC,8BAA8B;IAC9B,0DAA0D;IAC1D,kBAAkB,EAAE,WAAW;IAC/B,mEAAmE;IACnE,oBAAoB,EAAE,kBAAkB,EAAE,WAAW,EAAE,aAAa;CACrE,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAwB,IAAI,GAAG,CAAC;IACzE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO;IACxC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO;IACzE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM;CACxD,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,QAAgB,EAAE,QAAgB;IACxE,IAAI,+BAA+B,CAAC,GAAG,CAAC,QAAQ,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/D,IAAI,QAAQ,KAAK,0BAA0B;QAAE,OAAO,KAAK,CAAC;IAC1D,MAAM,GAAG,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAI,GAAG,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1B,OAAO,8BAA8B,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/E,CAAC;AAUD;;;;GAIG;AACH,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,QAAQ,EAAE,CAAC;AAE/F;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,uCAAuC,CAAC;IAC1E,8EAA8E;IAC9E,gFAAgF;IAChF,gFAAgF;IAChF,qEAAqE;IACrE,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IACtD,WAAW,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC;IACjE,OAAO,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACxC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,GAAG,CAAC,mBAAmB,EAAE,2BAA2B,mBAAmB,aAAa,CAAC;IACvI,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,GAAG,CAAC,mBAAmB,EAAE,2BAA2B,mBAAmB,aAAa,CAAC;IACvI,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC5D,aAAa,EAAE,mBAAmB;CACnC,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,GAAG,CAAC,mBAAmB,EAAE,2BAA2B,mBAAmB,aAAa,CAAC;IACvI,aAAa,EAAE,mBAAmB;CACnC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,GAAG,CAAC,mBAAmB,EAAE,2BAA2B,mBAAmB,aAAa,CAAC;CACxI,CAAC,CAAC","sourcesContent":["// Copyright 2026 Pipeline Builder Contributors\n// SPDX-License-Identifier: Apache-2.0\n\nimport { z } from 'zod';\nimport { BaseFilterSchema, BooleanQuerySchema } from './common-schemas.js';\n\n/**\n * Message type schema\n */\nexport const MessageTypeSchema = z.enum(['announcement', 'conversation']);\n\n/**\n * Message priority schema\n */\nexport const MessagePrioritySchema = z.enum(['normal', 'high', 'urgent']);\n\n/**\n * Channel/inbox-bucket schema. Open-ended string up to 50 chars so we\n * can add new channels (support, help, billing, …) without a schema\n * migration. Constrained to a-z/0-9/dash/underscore for URL safety and\n * to keep filter conditions trivially indexable.\n */\nexport const MessageChannelSchema = z.string().min(1).max(50).regex(/^[a-z0-9_-]+$/);\n\n/**\n * Message filter schema for query parameters.\n *\n * Convention for `threadId`:\n * - Omitted (undefined): no filter applied — returns messages regardless of thread.\n * - `'root'` or `null`: filter for root messages only (translated to `threadId IS NULL`\n *   by the route layer / query builder). The string sentinel `'root'` is the\n *   wire form, since URL query params can't carry a true `null`.\n * - A UUID: filter for messages in that specific thread.\n *\n * `isRead` is honored by `buildMessageConditions` in pipeline-data via a\n * `jsonb_exists(read_by, $orgId)` check on `messages.read_by` for the requesting\n * org (the function form, not the `?` operator, to avoid param-binding clashes).\n */\nexport const MessageFilterSchema = BaseFilterSchema.extend({\n  threadId: z.union([z.string().uuid(), z.literal('root'), z.null()]).optional(),\n  recipientOrgId: z.string().min(1).optional(),\n  messageType: MessageTypeSchema.optional(),\n  isRead: BooleanQuerySchema.optional(),\n  priority: MessagePrioritySchema.optional(),\n  channel: MessageChannelSchema.optional(),\n  // Free-text inbox search over subject/content. Bounded so a pathological term\n  // can't blow up the LIKE; the query builder escapes wildcards + ignores blanks.\n  search: z.string().trim().min(1).max(200).optional(),\n});\n\n/**\n * Upper bounds on free-text message fields. Without these an unbounded\n * subject/content (e.g. a 1MB announcement) is persisted AND SSE-broadcast to\n * every org. `subject` matches the `varchar(500)` DB column so we reject rather\n * than silently truncate; `content` is a `text` column with no DB bound, so we\n * cap it at a sane 32 KiB at the app layer.\n */\nexport const MESSAGE_SUBJECT_MAX = 500;\nexport const MESSAGE_CONTENT_MAX = 32768;\n\n/** Max attachments linkable to a single message/reply. */\nexport const MESSAGE_MAX_ATTACHMENTS = 5;\n\n/**\n * Max attachment size (MiB) — env-overridable. The upload route enforces this\n * (multer `fileSize`); kept here so the bound lives with the other message\n * limits rather than only inline in the route.\n */\nexport const MESSAGE_ATTACHMENT_MAX_MB = Math.max(1, Number.parseInt(process.env.MESSAGE_ATTACHMENT_MAX_MB ?? '10', 10) || 10);\nexport const MESSAGE_ATTACHMENT_MAX_BYTES = MESSAGE_ATTACHMENT_MAX_MB * 1024 * 1024;\n\n/**\n * Allow-list of attachment MIME types — common images + documents + zip/yaml/json.\n * Deliberately excludes executables/scripts/HTML/SVG (stored-XSS / drive-by).\n * zip is a download container (doesn't render in-browser); yaml/json are plain\n * text — none carry the drive-by risk of the excluded types. Extend here.\n */\nexport const MESSAGE_ATTACHMENT_ALLOWED_MIME: ReadonlySet<string> = new Set([\n  'image/png', 'image/jpeg', 'image/gif', 'image/webp',\n  'application/pdf', 'text/plain', 'text/csv',\n  'application/msword',\n  'application/vnd.openxmlformats-officedocument.wordprocessingml.document',\n  'application/vnd.ms-excel',\n  'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',\n  'application/vnd.openxmlformats-officedocument.presentationml.presentation',\n  // Archives (zip / gz / tar / tar.gz) — browsers report these variously by OS;\n  // cover the common variants. They download rather than render in-browser.\n  'application/zip', 'application/x-zip-compressed',\n  'application/gzip', 'application/x-gzip',\n  'application/x-tar', 'application/tar',\n  'application/x-compressed-tar',\n  // json (browsers may send application/json or text/json).\n  'application/json', 'text/json',\n  // yaml/yml — no single registered type; cover the common variants.\n  'application/x-yaml', 'application/yaml', 'text/yaml', 'text/x-yaml',\n]);\n\n/**\n * Safe filename extensions. Browsers frequently send `application/octet-stream`\n * for archives + config files (.tar/.gz/.tgz/.yaml/…) because they have no\n * reliable registered MIME type, so the MIME allow-list alone rejects them. These\n * extensions are accepted as a fallback ONLY when the reported MIME is that\n * generic type (see isAllowedAttachmentType) — so a known render/execute MIME\n * (image/svg+xml, text/html, …) is never rescued by a spoofed extension. Still\n * excludes .html/.svg/.js/.exe/… (never listed here).\n */\nexport const MESSAGE_ATTACHMENT_ALLOWED_EXT: ReadonlySet<string> = new Set([\n  '.png', '.jpg', '.jpeg', '.gif', '.webp',\n  '.pdf', '.txt', '.csv', '.doc', '.docx', '.xls', '.xlsx', '.ppt', '.pptx',\n  '.zip', '.gz', '.tgz', '.tar', '.json', '.yaml', '.yml',\n]);\n\n/**\n * True if an attachment is accepted. Accepts by MIME allow-list, OR — when the\n * browser reports the generic `application/octet-stream` (unknown binary) — by a\n * safe filename extension. octet-stream is served as a download (never rendered),\n * so the extension fallback can't turn into a stored-XSS vector.\n */\nexport function isAllowedAttachmentType(mimetype: string, filename: string): boolean {\n  if (MESSAGE_ATTACHMENT_ALLOWED_MIME.has(mimetype)) return true;\n  if (mimetype !== 'application/octet-stream') return false;\n  const dot = (filename || '').lastIndexOf('.');\n  if (dot < 0) return false;\n  return MESSAGE_ATTACHMENT_ALLOWED_EXT.has(filename.slice(dot).toLowerCase());\n}\n\n/** Attachment metadata DTO returned to clients (never exposes the storage key). */\nexport interface MessageAttachmentDTO {\n  id: string;\n  filename: string;\n  contentType: string;\n  sizeBytes: number;\n}\n\n/**\n * Attachment ids to link to a message. Each is the id returned by a prior\n * POST /messages/attachments upload; the create route links only ids that belong\n * to the caller (own org + uploader) and are still unattached.\n */\nconst AttachmentIdsSchema = z.array(z.string().uuid()).max(MESSAGE_MAX_ATTACHMENTS).optional();\n\n/**\n * Message creation schema\n */\nexport const MessageCreateSchema = z.object({\n  recipientOrgId: z.string().min(1, 'Recipient organization ID is required'),\n  // Optional per-user targeting WITHIN recipientOrgId. When set, only this user\n  // sees the conversation (enforced in buildMessageConditions). Conversation-only\n  // and requires a concrete recipient org — the route rejects it on announcements\n  // and '*' broadcasts. Bounded to the recipient_user_id column width.\n  recipientUserId: z.string().min(1).max(255).optional(),\n  messageType: MessageTypeSchema.optional().default('conversation'),\n  channel: MessageChannelSchema.optional(),\n  subject: z.string().min(1, 'Subject is required').max(MESSAGE_SUBJECT_MAX, `Subject must be at most ${MESSAGE_SUBJECT_MAX} characters`),\n  content: z.string().min(1, 'Content is required').max(MESSAGE_CONTENT_MAX, `Content must be at most ${MESSAGE_CONTENT_MAX} characters`),\n  priority: MessagePrioritySchema.optional().default('normal'),\n  attachmentIds: AttachmentIdsSchema,\n});\n\n/**\n * Message reply schema\n */\nexport const MessageReplySchema = z.object({\n  content: z.string().min(1, 'Content is required').max(MESSAGE_CONTENT_MAX, `Content must be at most ${MESSAGE_CONTENT_MAX} characters`),\n  attachmentIds: AttachmentIdsSchema,\n});\n\n/**\n * Edit an already-sent message's CONTENT (author-only, enforced server-side).\n * Only the body is editable — subject/recipient/type/attachments are immutable\n * after send (changing them would rewrite the conversation's routing/meaning).\n */\nexport const MessageEditSchema = z.object({\n  content: z.string().min(1, 'Content is required').max(MESSAGE_CONTENT_MAX, `Content must be at most ${MESSAGE_CONTENT_MAX} characters`),\n});\n"]}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import type { Request } from 'express';
|
|
2
|
+
import { ZodError, type ZodSchema } from 'zod';
|
|
3
|
+
/**
|
|
4
|
+
* Result type for validation operations.
|
|
5
|
+
*
|
|
6
|
+
* CANONICAL validation-result shape for the api-core public surface: a boolean-
|
|
7
|
+
* discriminated union (`if (!result.ok) …`). Use THIS for anything that parses
|
|
8
|
+
* against a Zod schema — `validate` / `validateBody` / `validateQuery`. The
|
|
9
|
+
* `ok` discriminant also carries the optional `zodError` for callers that want
|
|
10
|
+
* field-level detail.
|
|
11
|
+
*
|
|
12
|
+
* Note the deliberately-lighter sibling shape in `utils/params.ts`
|
|
13
|
+
* (`{ value } | { error }`, narrowed with `'error' in result`). That one is for
|
|
14
|
+
* simple inline request-parsing guards (`validateBulkArray`, `parseDateRange`,
|
|
15
|
+
* `parseReportInterval`) — NOT schema validation. The two are kept distinct on
|
|
16
|
+
* purpose: unifying `utils/params.ts` onto `{ ok }` would touch every
|
|
17
|
+
* `'error' in result` call site across the downstream services (pipeline,
|
|
18
|
+
* plugin, reporting, compliance, …) for no behavioural gain, so the convention
|
|
19
|
+
* is documented rather than force-migrated. Rule of thumb: Zod schema →
|
|
20
|
+
* `ValidationResult` (`ok`); ad-hoc parse guard → params.ts (`'error' in`).
|
|
21
|
+
*/
|
|
22
|
+
export type ValidationResult<T> = {
|
|
23
|
+
ok: true;
|
|
24
|
+
value: T;
|
|
25
|
+
} | {
|
|
26
|
+
ok: false;
|
|
27
|
+
error: string;
|
|
28
|
+
zodError?: ZodError;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Validate arbitrary data against a Zod schema.
|
|
32
|
+
*
|
|
33
|
+
* This is the core validation function used by the Express-specific helpers
|
|
34
|
+
* (`validateBody`, `validateQuery`). It can also be called directly when
|
|
35
|
+
* validating data that doesn't come from a request object.
|
|
36
|
+
*
|
|
37
|
+
* @param data - Data to validate
|
|
38
|
+
* @param schema - Zod schema for validation
|
|
39
|
+
* @returns Validation result with parsed data or error
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```typescript
|
|
43
|
+
* const result = validate(someData, MySchema);
|
|
44
|
+
* if (!result.ok) {
|
|
45
|
+
* return sendBadRequest(res, result.error);
|
|
46
|
+
* }
|
|
47
|
+
* const parsed = result.value;
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
export declare function validate<T>(data: unknown, schema: ZodSchema<T>): ValidationResult<T>;
|
|
51
|
+
/**
|
|
52
|
+
* Validate request query parameters with a Zod schema.
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```typescript
|
|
56
|
+
* const result = validateQuery(req, PipelineFilterSchema);
|
|
57
|
+
* if (!result.ok) return sendBadRequest(res, result.error);
|
|
58
|
+
* const filter = result.value;
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
export declare function validateQuery<T>(req: Request, schema: ZodSchema<T>): ValidationResult<T>;
|
|
62
|
+
/**
|
|
63
|
+
* Validate request body with a Zod schema.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```typescript
|
|
67
|
+
* const result = validateBody(req, PipelineCreateSchema);
|
|
68
|
+
* if (!result.ok) return sendBadRequest(res, result.error);
|
|
69
|
+
* const data = result.value;
|
|
70
|
+
* ```
|
|
71
|
+
*/
|
|
72
|
+
export declare function validateBody<T>(req: Request, schema: ZodSchema<T>): ValidationResult<T>;
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
import { ZodError } from 'zod';
|
|
4
|
+
/**
|
|
5
|
+
* Validate arbitrary data against a Zod schema.
|
|
6
|
+
*
|
|
7
|
+
* This is the core validation function used by the Express-specific helpers
|
|
8
|
+
* (`validateBody`, `validateQuery`). It can also be called directly when
|
|
9
|
+
* validating data that doesn't come from a request object.
|
|
10
|
+
*
|
|
11
|
+
* @param data - Data to validate
|
|
12
|
+
* @param schema - Zod schema for validation
|
|
13
|
+
* @returns Validation result with parsed data or error
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```typescript
|
|
17
|
+
* const result = validate(someData, MySchema);
|
|
18
|
+
* if (!result.ok) {
|
|
19
|
+
* return sendBadRequest(res, result.error);
|
|
20
|
+
* }
|
|
21
|
+
* const parsed = result.value;
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
export function validate(data, schema) {
|
|
25
|
+
try {
|
|
26
|
+
return { ok: true, value: schema.parse(data) };
|
|
27
|
+
}
|
|
28
|
+
catch (error) {
|
|
29
|
+
if (error instanceof ZodError) {
|
|
30
|
+
const firstIssue = error.issues[0];
|
|
31
|
+
const message = firstIssue
|
|
32
|
+
? `${firstIssue.path.join('.')}: ${firstIssue.message}`
|
|
33
|
+
: 'Validation failed';
|
|
34
|
+
return { ok: false, error: message, zodError: error };
|
|
35
|
+
}
|
|
36
|
+
return { ok: false, error: 'Validation failed' };
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Validate request query parameters with a Zod schema.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```typescript
|
|
44
|
+
* const result = validateQuery(req, PipelineFilterSchema);
|
|
45
|
+
* if (!result.ok) return sendBadRequest(res, result.error);
|
|
46
|
+
* const filter = result.value;
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
export function validateQuery(req, schema) {
|
|
50
|
+
return validate(req.query, schema);
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Validate request body with a Zod schema.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```typescript
|
|
57
|
+
* const result = validateBody(req, PipelineCreateSchema);
|
|
58
|
+
* if (!result.ok) return sendBadRequest(res, result.error);
|
|
59
|
+
* const data = result.value;
|
|
60
|
+
* ```
|
|
61
|
+
*/
|
|
62
|
+
export function validateBody(req, schema) {
|
|
63
|
+
return validate(req.body, schema);
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy92YWxpZGF0aW9uL21pZGRsZXdhcmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsK0NBQStDO0FBQy9DLHNDQUFzQztBQUd0QyxPQUFPLEVBQUUsUUFBUSxFQUFrQixNQUFNLEtBQUssQ0FBQztBQXlCL0M7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FtQkc7QUFDSCxNQUFNLFVBQVUsUUFBUSxDQUN0QixJQUFhLEVBQ2IsTUFBb0I7SUFFcEIsSUFBSSxDQUFDO1FBQ0gsT0FBTyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLE1BQU0sQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztJQUNqRCxDQUFDO0lBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztRQUNmLElBQUksS0FBSyxZQUFZLFFBQVEsRUFBRSxDQUFDO1lBQzlCLE1BQU0sVUFBVSxHQUFHLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDbkMsTUFBTSxPQUFPLEdBQUcsVUFBVTtnQkFDeEIsQ0FBQyxDQUFDLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEtBQUssVUFBVSxDQUFDLE9BQU8sRUFBRTtnQkFDdkQsQ0FBQyxDQUFDLG1CQUFtQixDQUFDO1lBQ3hCLE9BQU8sRUFBRSxFQUFFLEVBQUUsS0FBSyxFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsUUFBUSxFQUFFLEtBQUssRUFBRSxDQUFDO1FBQ3hELENBQUM7UUFDRCxPQUFPLEVBQUUsRUFBRSxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsbUJBQW1CLEVBQUUsQ0FBQztJQUNuRCxDQUFDO0FBQ0gsQ0FBQztBQUVEOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sVUFBVSxhQUFhLENBQUksR0FBWSxFQUFFLE1BQW9CO0lBQ2pFLE9BQU8sUUFBUSxDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsTUFBTSxDQUFDLENBQUM7QUFDckMsQ0FBQztBQUVEOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sVUFBVSxZQUFZLENBQUksR0FBWSxFQUFFLE1BQW9CO0lBQ2hFLE9BQU8sUUFBUSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7QUFDcEMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIENvcHlyaWdodCAyMDI2IFBpcGVsaW5lIEJ1aWxkZXIgQ29udHJpYnV0b3JzXG4vLyBTUERYLUxpY2Vuc2UtSWRlbnRpZmllcjogQXBhY2hlLTIuMFxuXG5pbXBvcnQgdHlwZSB7IFJlcXVlc3QgfSBmcm9tICdleHByZXNzJztcbmltcG9ydCB7IFpvZEVycm9yLCB0eXBlIFpvZFNjaGVtYSB9IGZyb20gJ3pvZCc7XG5cbi8qKlxuICogUmVzdWx0IHR5cGUgZm9yIHZhbGlkYXRpb24gb3BlcmF0aW9ucy5cbiAqXG4gKiBDQU5PTklDQUwgdmFsaWRhdGlvbi1yZXN1bHQgc2hhcGUgZm9yIHRoZSBhcGktY29yZSBwdWJsaWMgc3VyZmFjZTogYSBib29sZWFuLVxuICogZGlzY3JpbWluYXRlZCB1bmlvbiAoYGlmICghcmVzdWx0Lm9rKSDigKZgKS4gVXNlIFRISVMgZm9yIGFueXRoaW5nIHRoYXQgcGFyc2VzXG4gKiBhZ2FpbnN0IGEgWm9kIHNjaGVtYSDigJQgYHZhbGlkYXRlYCAvIGB2YWxpZGF0ZUJvZHlgIC8gYHZhbGlkYXRlUXVlcnlgLiBUaGVcbiAqIGBva2AgZGlzY3JpbWluYW50IGFsc28gY2FycmllcyB0aGUgb3B0aW9uYWwgYHpvZEVycm9yYCBmb3IgY2FsbGVycyB0aGF0IHdhbnRcbiAqIGZpZWxkLWxldmVsIGRldGFpbC5cbiAqXG4gKiBOb3RlIHRoZSBkZWxpYmVyYXRlbHktbGlnaHRlciBzaWJsaW5nIHNoYXBlIGluIGB1dGlscy9wYXJhbXMudHNgXG4gKiAoYHsgdmFsdWUgfSB8IHsgZXJyb3IgfWAsIG5hcnJvd2VkIHdpdGggYCdlcnJvcicgaW4gcmVzdWx0YCkuIFRoYXQgb25lIGlzIGZvclxuICogc2ltcGxlIGlubGluZSByZXF1ZXN0LXBhcnNpbmcgZ3VhcmRzIChgdmFsaWRhdGVCdWxrQXJyYXlgLCBgcGFyc2VEYXRlUmFuZ2VgLFxuICogYHBhcnNlUmVwb3J0SW50ZXJ2YWxgKSDigJQgTk9UIHNjaGVtYSB2YWxpZGF0aW9uLiBUaGUgdHdvIGFyZSBrZXB0IGRpc3RpbmN0IG9uXG4gKiBwdXJwb3NlOiB1bmlmeWluZyBgdXRpbHMvcGFyYW1zLnRzYCBvbnRvIGB7IG9rIH1gIHdvdWxkIHRvdWNoIGV2ZXJ5XG4gKiBgJ2Vycm9yJyBpbiByZXN1bHRgIGNhbGwgc2l0ZSBhY3Jvc3MgdGhlIGRvd25zdHJlYW0gc2VydmljZXMgKHBpcGVsaW5lLFxuICogcGx1Z2luLCByZXBvcnRpbmcsIGNvbXBsaWFuY2UsIOKApikgZm9yIG5vIGJlaGF2aW91cmFsIGdhaW4sIHNvIHRoZSBjb252ZW50aW9uXG4gKiBpcyBkb2N1bWVudGVkIHJhdGhlciB0aGFuIGZvcmNlLW1pZ3JhdGVkLiBSdWxlIG9mIHRodW1iOiBab2Qgc2NoZW1hIOKGklxuICogYFZhbGlkYXRpb25SZXN1bHRgIChgb2tgKTsgYWQtaG9jIHBhcnNlIGd1YXJkIOKGkiBwYXJhbXMudHMgKGAnZXJyb3InIGluYCkuXG4gKi9cbmV4cG9ydCB0eXBlIFZhbGlkYXRpb25SZXN1bHQ8VD4gPVxuICB8IHsgb2s6IHRydWU7IHZhbHVlOiBUIH1cbiAgfCB7IG9rOiBmYWxzZTsgZXJyb3I6IHN0cmluZzsgem9kRXJyb3I/OiBab2RFcnJvciB9O1xuXG4vKipcbiAqIFZhbGlkYXRlIGFyYml0cmFyeSBkYXRhIGFnYWluc3QgYSBab2Qgc2NoZW1hLlxuICpcbiAqIFRoaXMgaXMgdGhlIGNvcmUgdmFsaWRhdGlvbiBmdW5jdGlvbiB1c2VkIGJ5IHRoZSBFeHByZXNzLXNwZWNpZmljIGhlbHBlcnNcbiAqIChgdmFsaWRhdGVCb2R5YCwgYHZhbGlkYXRlUXVlcnlgKS4gSXQgY2FuIGFsc28gYmUgY2FsbGVkIGRpcmVjdGx5IHdoZW5cbiAqIHZhbGlkYXRpbmcgZGF0YSB0aGF0IGRvZXNuJ3QgY29tZSBmcm9tIGEgcmVxdWVzdCBvYmplY3QuXG4gKlxuICogQHBhcmFtIGRhdGEgLSBEYXRhIHRvIHZhbGlkYXRlXG4gKiBAcGFyYW0gc2NoZW1hIC0gWm9kIHNjaGVtYSBmb3IgdmFsaWRhdGlvblxuICogQHJldHVybnMgVmFsaWRhdGlvbiByZXN1bHQgd2l0aCBwYXJzZWQgZGF0YSBvciBlcnJvclxuICpcbiAqIEBleGFtcGxlXG4gKiBgYGB0eXBlc2NyaXB0XG4gKiBjb25zdCByZXN1bHQgPSB2YWxpZGF0ZShzb21lRGF0YSwgTXlTY2hlbWEpO1xuICogaWYgKCFyZXN1bHQub2spIHtcbiAqICAgcmV0dXJuIHNlbmRCYWRSZXF1ZXN0KHJlcywgcmVzdWx0LmVycm9yKTtcbiAqIH1cbiAqIGNvbnN0IHBhcnNlZCA9IHJlc3VsdC52YWx1ZTtcbiAqIGBgYFxuICovXG5leHBvcnQgZnVuY3Rpb24gdmFsaWRhdGU8VD4oXG4gIGRhdGE6IHVua25vd24sXG4gIHNjaGVtYTogWm9kU2NoZW1hPFQ+LFxuKTogVmFsaWRhdGlvblJlc3VsdDxUPiB7XG4gIHRyeSB7XG4gICAgcmV0dXJuIHsgb2s6IHRydWUsIHZhbHVlOiBzY2hlbWEucGFyc2UoZGF0YSkgfTtcbiAgfSBjYXRjaCAoZXJyb3IpIHtcbiAgICBpZiAoZXJyb3IgaW5zdGFuY2VvZiBab2RFcnJvcikge1xuICAgICAgY29uc3QgZmlyc3RJc3N1ZSA9IGVycm9yLmlzc3Vlc1swXTtcbiAgICAgIGNvbnN0IG1lc3NhZ2UgPSBmaXJzdElzc3VlXG4gICAgICAgID8gYCR7Zmlyc3RJc3N1ZS5wYXRoLmpvaW4oJy4nKX06ICR7Zmlyc3RJc3N1ZS5tZXNzYWdlfWBcbiAgICAgICAgOiAnVmFsaWRhdGlvbiBmYWlsZWQnO1xuICAgICAgcmV0dXJuIHsgb2s6IGZhbHNlLCBlcnJvcjogbWVzc2FnZSwgem9kRXJyb3I6IGVycm9yIH07XG4gICAgfVxuICAgIHJldHVybiB7IG9rOiBmYWxzZSwgZXJyb3I6ICdWYWxpZGF0aW9uIGZhaWxlZCcgfTtcbiAgfVxufVxuXG4vKipcbiAqIFZhbGlkYXRlIHJlcXVlc3QgcXVlcnkgcGFyYW1ldGVycyB3aXRoIGEgWm9kIHNjaGVtYS5cbiAqXG4gKiBAZXhhbXBsZVxuICogYGBgdHlwZXNjcmlwdFxuICogY29uc3QgcmVzdWx0ID0gdmFsaWRhdGVRdWVyeShyZXEsIFBpcGVsaW5lRmlsdGVyU2NoZW1hKTtcbiAqIGlmICghcmVzdWx0Lm9rKSByZXR1cm4gc2VuZEJhZFJlcXVlc3QocmVzLCByZXN1bHQuZXJyb3IpO1xuICogY29uc3QgZmlsdGVyID0gcmVzdWx0LnZhbHVlO1xuICogYGBgXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiB2YWxpZGF0ZVF1ZXJ5PFQ+KHJlcTogUmVxdWVzdCwgc2NoZW1hOiBab2RTY2hlbWE8VD4pOiBWYWxpZGF0aW9uUmVzdWx0PFQ+IHtcbiAgcmV0dXJuIHZhbGlkYXRlKHJlcS5xdWVyeSwgc2NoZW1hKTtcbn1cblxuLyoqXG4gKiBWYWxpZGF0ZSByZXF1ZXN0IGJvZHkgd2l0aCBhIFpvZCBzY2hlbWEuXG4gKlxuICogQGV4YW1wbGVcbiAqIGBgYHR5cGVzY3JpcHRcbiAqIGNvbnN0IHJlc3VsdCA9IHZhbGlkYXRlQm9keShyZXEsIFBpcGVsaW5lQ3JlYXRlU2NoZW1hKTtcbiAqIGlmICghcmVzdWx0Lm9rKSByZXR1cm4gc2VuZEJhZFJlcXVlc3QocmVzLCByZXN1bHQuZXJyb3IpO1xuICogY29uc3QgZGF0YSA9IHJlc3VsdC52YWx1ZTtcbiAqIGBgYFxuICovXG5leHBvcnQgZnVuY3Rpb24gdmFsaWRhdGVCb2R5PFQ+KHJlcTogUmVxdWVzdCwgc2NoZW1hOiBab2RTY2hlbWE8VD4pOiBWYWxpZGF0aW9uUmVzdWx0PFQ+IHtcbiAgcmV0dXJuIHZhbGlkYXRlKHJlcS5ib2R5LCBzY2hlbWEpO1xufVxuIl19
|