@marinoscar/platform-contract 0.1.0-next.3 → 0.1.0-next.4

package/dist/esm/sharing/groups.js

@@ -0,0 +1,372 @@
+// =============================================================================
+// Groups: the wire shapes of `/api/groups` (issue #728, PP-7.1)
+// =============================================================================
+//
+// A group is a set of users inside ONE organization that can own and share
+// content; it is never a tenant (spec decision D6). The API's sharing slice
+// (`@marinoscar/platform-api/sharing`) wraps these schemas as its nestjs-zod
+// DTOs, so the OpenAPI document is generated from them.
+//
+//   GET    /api/groups?scope=mine|all          groupListQuerySchema       -> groupListSchema
+//   POST   /api/groups                         createGroupSchema          -> groupSchema
+//   GET    /api/groups/:id                                                -> groupSchema
+//   PATCH  /api/groups/:id (If-Match)          updateGroupSchema          -> groupSchema
+//   GET    /api/groups/:id/members             pageQuerySchema            -> groupMemberListSchema
+//   POST   /api/groups/:id/members             addGroupMemberSchema       -> groupMemberSchema
+//   PATCH  /api/groups/:id/members/:userId     updateGroupMemberSchema    -> groupMemberSchema
+//   GET    /api/groups/:id/invites             groupInviteListQuerySchema -> groupInviteListSchema
+//   POST   /api/groups/:id/invites             createGroupInviteSchema    -> groupInviteSchema
+//   GET    /api/groups/invites/mine                                       -> myGroupInviteListSchema
+//   POST   /api/groups/invites/:inviteId/accept                           -> groupMembershipSchema
+// =============================================================================
+import { z } from 'zod';
+import { GROUP_INVITE_LIST_FILTERS, GROUP_INVITE_STATUSES, GROUP_LIST_SCOPES, SHARING_IDENTIFIER_PATTERN, SHARING_LIMITS } from './constants.js';
+import { wireEnum } from './enum.js';
+/**
+ * A group role on the wire: the id of a registered group role (`admin`,
+ * `editor`, `viewer` and any the app registered with `registerGroupRole`).
+ * Only the shape is checked here; the API refuses an id nobody registered
+ * (422 `GROUP_ROLE_UNKNOWN`).
+ *
+ * @stability experimental
+ */
+export const groupRoleSchema = z
+    .string()
+    .max(SHARING_LIMITS.grantIdentifierMax)
+    .regex(SHARING_IDENTIFIER_PATTERN, 'A group role is lower-case snake_case')
+    .describe('A registered group role id (`admin`, `editor`, `viewer` or an app role).');
+/**
+ * One registered group role as `GET /api/sharing/group-roles` describes it:
+ * what a role picker needs.
+ *
+ * @stability experimental
+ */
+export const groupRoleDescriptorSchema = z.object({
+    /** The role id (`admin`, `commenter`). */
+    id: groupRoleSchema,
+    /** The label a picker shows. */
+    label: z.string(),
+    /** A sentence about what the role may do, or `null`. */
+    description: z.string().nullable(),
+    /** What the role may do in the group: `manage`, `write`, `read` or an app action. */
+    actions: z.array(z.string()),
+    /** Whether the platform ships the role (`admin`, `editor`, `viewer`). */
+    builtin: z.boolean(),
+});
+/**
+ * `GET /api/sharing/group-roles` response: the registered roles, strongest first.
+ *
+ * @stability experimental
+ */
+export const groupRoleListSchema = z.object({
+    /** The roles. */
+    items: z.array(groupRoleDescriptorSchema),
+});
+/**
+ * An e-mail address, trimmed and lower-cased (invites are stored lower-cased).
+ *
+ * @stability experimental
+ */
+export const groupEmailSchema = z
+    .string()
+    .trim()
+    .max(SHARING_LIMITS.emailMax)
+    .email('Invalid email format')
+    .transform((email) => email.toLowerCase());
+/**
+ * `page` and `pageSize` of a list, coerced from the query string.
+ *
+ * @stability experimental
+ */
+export const pageQuerySchema = z.object({
+    /** 1-based page number. */
+    page: z.coerce.number().int().min(1).default(1),
+    /** Items per page, 1..{@link SHARING_LIMITS}.pageSizeMax. */
+    pageSize: z.coerce.number().int().min(1).max(SHARING_LIMITS.pageSizeMax).default(SHARING_LIMITS.pageSizeDefault),
+});
+/**
+ * `GET /api/groups` query: `scope=mine` (groups the caller belongs to, the
+ * default) or `scope=all` (every group of the organization; needs
+ * `groups:admin`), plus the page.
+ *
+ * @stability experimental
+ */
+export const groupListQuerySchema = pageQuerySchema.extend({
+    /** `mine` or `all`. */
+    scope: wireEnum(GROUP_LIST_SCOPES)
+        .default('mine')
+        .describe('`mine`: groups you belong to. `all`: every group of the organization (needs `groups:admin`).'),
+});
+/**
+ * Free-form app data on a group (`groups.metadata`): an object, at most 32
+ * keys. Never secret material.
+ *
+ * @stability experimental
+ */
+export const groupMetadataSchema = z
+    .record(z.string().max(64), z.unknown())
+    .refine((value) => Object.keys(value).length <= 32, 'At most 32 metadata keys')
+    .describe('App-defined fields of the group (JSON object, at most 32 keys). Never secret material.');
+/**
+ * `POST /api/groups` body.
+ *
+ * @stability experimental
+ */
+export const createGroupSchema = z
+    .object({
+    /** The group's display name. */
+    name: z.string().trim().min(1).max(SHARING_LIMITS.groupNameMax),
+    /** An optional description. */
+    description: z.string().trim().max(SHARING_LIMITS.groupDescriptionMax).nullish(),
+    /** App-defined fields. */
+    metadata: groupMetadataSchema.nullish(),
+})
+    .strict();
+/**
+ * `PATCH /api/groups/:id` body: at least one field. Send the group's
+ * `version` in `If-Match`.
+ *
+ * @stability experimental
+ */
+export const updateGroupSchema = z
+    .object({
+    /** A new display name. */
+    name: z.string().trim().min(1).max(SHARING_LIMITS.groupNameMax).optional(),
+    /** A new description; `null` clears it. */
+    description: z.string().trim().max(SHARING_LIMITS.groupDescriptionMax).nullable().optional(),
+    /** New app-defined fields (replaces the object); `null` clears it. */
+    metadata: groupMetadataSchema.nullable().optional(),
+})
+    .strict()
+    .refine((body) => Object.keys(body).length > 0, 'Send at least one field');
+/**
+ * One group as the API returns it.
+ *
+ * @stability experimental
+ */
+export const groupSchema = z.object({
+    /** The group's id. */
+    id: z.uuid(),
+    /** The organization the group lives in. */
+    orgId: z.uuid(),
+    /** Display name. */
+    name: z.string(),
+    /** Description, or `null`. */
+    description: z.string().nullable(),
+    /** App-defined fields, or `null`. */
+    metadata: z.record(z.string(), z.unknown()).nullable(),
+    /** Who created it, or `null` (deleted user). */
+    createdById: z.uuid().nullable(),
+    /** Optimistic-concurrency version: send it in `If-Match` to PATCH. */
+    version: z.number().int(),
+    /** The caller's role in the group, or `null` (a `groups:admin` holder who is not a member). */
+    myRole: groupRoleSchema.nullable(),
+    /** How many members the group has. */
+    memberCount: z.number().int(),
+    /** When it was created. */
+    createdAt: z.iso.datetime(),
+    /** When it last changed. */
+    updatedAt: z.iso.datetime(),
+});
+/**
+ * A page of groups (`page`, `pageSize`, `items`, `total`, `totalPages`).
+ *
+ * @stability experimental
+ */
+export const groupListSchema = z.object({
+    /** The groups of this page. */
+    items: z.array(groupSchema),
+    /** Groups in the whole list. */
+    total: z.number().int(),
+    /** This page's number. */
+    page: z.number().int(),
+    /** The page size. */
+    pageSize: z.number().int(),
+    /** Pages in the whole list. */
+    totalPages: z.number().int(),
+});
+/**
+ * `POST /api/groups/:id/members` body: exactly one of `email` and `userId`,
+ * plus the role (default `viewer`). The person must already be a member of the
+ * group's organization.
+ *
+ * @stability experimental
+ */
+export const addGroupMemberSchema = z
+    .object({
+    /** The person's e-mail (looked up among the organization's members). */
+    email: groupEmailSchema.optional(),
+    /** The person's user id. */
+    userId: z.uuid().optional(),
+    /** Their role in the group. */
+    role: groupRoleSchema.default('viewer'),
+})
+    .strict()
+    .refine((body) => (body.email === undefined) !== (body.userId === undefined), 'Send exactly one of email and userId');
+/**
+ * `PATCH /api/groups/:id/members/:userId` body.
+ *
+ * @stability experimental
+ */
+export const updateGroupMemberSchema = z
+    .object({
+    /** The member's new role. */
+    role: groupRoleSchema,
+})
+    .strict();
+/**
+ * One member of a group.
+ *
+ * @stability experimental
+ */
+export const groupMemberSchema = z.object({
+    /** The group. */
+    groupId: z.uuid(),
+    /** The member. */
+    userId: z.uuid(),
+    /** Their role in the group. */
+    role: groupRoleSchema,
+    /** Their e-mail address. */
+    email: z.string(),
+    /** Their display name, or `null`. */
+    displayName: z.string().nullable(),
+    /** Who added them, or `null`. */
+    addedById: z.uuid().nullable(),
+    /** When they joined. */
+    createdAt: z.iso.datetime(),
+});
+/**
+ * A page of members (`page`, `pageSize`, `items`, `total`, `totalPages`).
+ *
+ * @stability experimental
+ */
+export const groupMemberListSchema = z.object({
+    /** The members of this page, admins first. */
+    items: z.array(groupMemberSchema),
+    /** Members in the group. */
+    total: z.number().int(),
+    /** This page's number. */
+    page: z.number().int(),
+    /** The page size. */
+    pageSize: z.number().int(),
+    /** Pages in the whole list. */
+    totalPages: z.number().int(),
+});
+/**
+ * `POST /api/groups/:id/invites` body.
+ *
+ * @stability experimental
+ */
+export const createGroupInviteSchema = z
+    .object({
+    /** The address to invite (stored lower-cased). */
+    email: groupEmailSchema,
+    /** The role the invitee gets on acceptance. */
+    role: groupRoleSchema.default('viewer'),
+})
+    .strict();
+/**
+ * `GET /api/groups/:id/invites` query: the page, and `status=pending` (the
+ * default) or `all`.
+ *
+ * @stability experimental
+ */
+export const groupInviteListQuerySchema = pageQuerySchema.extend({
+    /** `pending` (default) or `all`. */
+    status: wireEnum(GROUP_INVITE_LIST_FILTERS).default('pending'),
+});
+/**
+ * One invitation to a group, as the group's administrators see it.
+ *
+ * @stability experimental
+ */
+export const groupInviteSchema = z.object({
+    /** The invite's id. */
+    id: z.uuid(),
+    /** The group. */
+    groupId: z.uuid(),
+    /** The group's organization. */
+    orgId: z.uuid(),
+    /** The invited address. */
+    email: z.string(),
+    /** The role on acceptance. */
+    role: groupRoleSchema,
+    /** What the invite currently is. */
+    status: wireEnum(GROUP_INVITE_STATUSES),
+    /** Who sent it, or `null`. */
+    invitedById: z.uuid().nullable(),
+    /** After this instant the invite can no longer be accepted; `null` never expires. */
+    expiresAt: z.iso.datetime().nullable(),
+    /** When it was accepted, or `null`. */
+    acceptedAt: z.iso.datetime().nullable(),
+    /** When it was declined, or `null`. */
+    declinedAt: z.iso.datetime().nullable(),
+    /** When it was revoked, or `null`. */
+    revokedAt: z.iso.datetime().nullable(),
+    /** When it was sent. */
+    createdAt: z.iso.datetime(),
+});
+/**
+ * A page of invites (`page`, `pageSize`, `items`, `total`, `totalPages`).
+ *
+ * @stability experimental
+ */
+export const groupInviteListSchema = z.object({
+    /** The invites of this page, newest first. */
+    items: z.array(groupInviteSchema),
+    /** Invites in the whole list. */
+    total: z.number().int(),
+    /** This page's number. */
+    page: z.number().int(),
+    /** The page size. */
+    pageSize: z.number().int(),
+    /** Pages in the whole list. */
+    totalPages: z.number().int(),
+});
+/**
+ * One pending invitation addressed to the caller (`GET /api/groups/invites/mine`).
+ * It carries the group's name, never the address (it is the caller's own).
+ *
+ * @stability experimental
+ */
+export const myGroupInviteSchema = z.object({
+    /** The invite's id: accept or decline it by this id. */
+    id: z.uuid(),
+    /** The group. */
+    groupId: z.uuid(),
+    /** The group's display name. */
+    groupName: z.string(),
+    /** The group's organization. */
+    orgId: z.uuid(),
+    /** The role on acceptance. */
+    role: groupRoleSchema,
+    /** Who sent it, or `null`. */
+    invitedById: z.uuid().nullable(),
+    /** When it expires, or `null`. */
+    expiresAt: z.iso.datetime().nullable(),
+    /** When it was sent. */
+    createdAt: z.iso.datetime(),
+});
+/**
+ * The caller's pending invitations, across every organization they belong to.
+ *
+ * @stability experimental
+ */
+export const myGroupInviteListSchema = z.object({
+    /** Newest first. */
+    items: z.array(myGroupInviteSchema),
+});
+/**
+ * The membership an accepted invite produced.
+ *
+ * @stability experimental
+ */
+export const groupMembershipSchema = z.object({
+    /** The group joined. */
+    groupId: z.uuid(),
+    /** Its organization. */
+    orgId: z.uuid(),
+    /** The role held. */
+    role: groupRoleSchema,
+});
+//# sourceMappingURL=groups.js.map

package/dist/esm/sharing/groups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"groups.js","sourceRoot":"","sources":["../../../src/sharing/groups.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gEAAgE;AAChE,gFAAgF;AAChF,EAAE;AACF,2EAA2E;AAC3E,4EAA4E;AAC5E,6EAA6E;AAC7E,wDAAwD;AACxD,EAAE;AACF,6FAA6F;AAC7F,yFAAyF;AACzF,yFAAyF;AACzF,yFAAyF;AACzF,mGAAmG;AACnG,+FAA+F;AAC/F,+FAA+F;AAC/F,mGAAmG;AACnG,+FAA+F;AAC/F,qGAAqG;AACrG,mGAAmG;AACnG,gFAAgF;AAEhF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACjJ,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,EAAE;KACR,GAAG,CAAC,cAAc,CAAC,kBAAkB,CAAC;KACtC,KAAK,CAAC,0BAA0B,EAAE,uCAAuC,CAAC;KAC1E,QAAQ,CAAC,0EAA0E,CAAC,CAAC;AAExF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,0CAA0C;IAC1C,EAAE,EAAE,eAAe;IACnB,gCAAgC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,wDAAwD;IACxD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,qFAAqF;IACrF,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,yEAAyE;IACzE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,iBAAiB;IACjB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC;CAC1C,CAAC,CAAC;AAgBH;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC;KAC5B,KAAK,CAAC,sBAAsB,CAAC;KAC7B,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAE7C;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,2BAA2B;IAC3B,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,6DAA6D;IAC7D,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC;CACjH,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC,MAAM,CAAC;IACzD,uBAAuB;IACvB,KAAK,EAAE,QAAQ,CAAC,iBAAiB,CAAC;SAC/B,OAAO,CAAC,MAAM,CAAC;SACf,QAAQ,CAAC,8FAA8F,CAAC;CAC5G,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;KACvC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,0BAA0B,CAAC;KAC9E,QAAQ,CAAC,wFAAwF,CAAC,CAAC;AAEtG;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,gCAAgC;IAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC;IAC/D,+BAA+B;IAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,OAAO,EAAE;IAChF,0BAA0B;IAC1B,QAAQ,EAAE,mBAAmB,CAAC,OAAO,EAAE;CACxC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,0BAA0B;IAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;IAC1E,2CAA2C;IAC3C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC5F,sEAAsE;IACtE,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACpD,CAAC;KACD,MAAM,EAAE;KACR,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,yBAAyB,CAAC,CAAC;AAE7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,sBAAsB;IACtB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;IACZ,2CAA2C;IAC3C,KAAK,EAAE,CAAC,CAAC,IAAI,EAAE;IACf,oBAAoB;IACpB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,8BAA8B;IAC9B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,qCAAqC;IACrC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IACtD,gDAAgD;IAChD,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAChC,sEAAsE;IACtE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzB,+FAA+F;IAC/F,MAAM,EAAE,eAAe,CAAC,QAAQ,EAAE;IAClC,sCAAsC;IACtC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC7B,2BAA2B;IAC3B,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAC3B,4BAA4B;IAC5B,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,+BAA+B;IAC/B,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC;IAC3B,gCAAgC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvB,0BAA0B;IAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACtB,qBAAqB;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC1B,+BAA+B;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,wEAAwE;IACxE,KAAK,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IAClC,4BAA4B;IAC5B,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAC3B,+BAA+B;IAC/B,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC;CACxC,CAAC;KACD,MAAM,EAAE;KACR,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,EAAE,sCAAsC,CAAC,CAAC;AAExH;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,CAAC;IACN,6BAA6B;IAC7B,IAAI,EAAE,eAAe;CACtB,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,iBAAiB;IACjB,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;IACjB,kBAAkB;IAClB,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE;IAChB,+BAA+B;IAC/B,IAAI,EAAE,eAAe;IACrB,4BAA4B;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,qCAAqC;IACrC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,iCAAiC;IACjC,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAC9B,wBAAwB;IACxB,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,8CAA8C;IAC9C,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;IACjC,4BAA4B;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvB,0BAA0B;IAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACtB,qBAAqB;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC1B,+BAA+B;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,CAAC;IACN,kDAAkD;IAClD,KAAK,EAAE,gBAAgB;IACvB,+CAA+C;IAC/C,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC;CACxC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,eAAe,CAAC,MAAM,CAAC;IAC/D,oCAAoC;IACpC,MAAM,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;CAC/D,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,uBAAuB;IACvB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;IACZ,iBAAiB;IACjB,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;IACjB,gCAAgC;IAChC,KAAK,EAAE,CAAC,CAAC,IAAI,EAAE;IACf,2BAA2B;IAC3B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,8BAA8B;IAC9B,IAAI,EAAE,eAAe;IACrB,oCAAoC;IACpC,MAAM,EAAE,QAAQ,CAAC,qBAAqB,CAAC;IACvC,8BAA8B;IAC9B,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAChC,qFAAqF;IACrF,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACtC,uCAAuC;IACvC,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACvC,uCAAuC;IACvC,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACvC,sCAAsC;IACtC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACtC,wBAAwB;IACxB,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,8CAA8C;IAC9C,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;IACjC,iCAAiC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvB,0BAA0B;IAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACtB,qBAAqB;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC1B,+BAA+B;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,wDAAwD;IACxD,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;IACZ,iBAAiB;IACjB,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;IACjB,gCAAgC;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,gCAAgC;IAChC,KAAK,EAAE,CAAC,CAAC,IAAI,EAAE;IACf,8BAA8B;IAC9B,IAAI,EAAE,eAAe;IACrB,8BAA8B;IAC9B,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAChC,kCAAkC;IAClC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACtC,wBAAwB;IACxB,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,oBAAoB;IACpB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;CACpC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,wBAAwB;IACxB,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;IACjB,wBAAwB;IACxB,KAAK,EAAE,CAAC,CAAC,IAAI,EAAE;IACf,qBAAqB;IACrB,IAAI,EAAE,eAAe;CACtB,CAAC,CAAC"}

package/dist/esm/sharing/index.d.ts

@@ -0,0 +1,5 @@
+export { ACCESS_SCOPES, BUILTIN_GRANTEE_KINDS, BUILTIN_GROUP_ROLES, GRANTEE_KIND_ID_PATTERN, GRANTEE_KIND_INPUTS, GRANT_GRANTEE_KINDS, GROUP_INVITE_LIST_FILTERS, GROUP_INVITE_STATUSES, GROUP_LIST_SCOPES, GROUP_ROLES, LINK_TOKEN_HEADER, LINK_TOKEN_PATTERN, LINK_TOKEN_PREFIX, SHARED_WITH_ME_VIA, SHARING_IDENTIFIER_PATTERN, SHARING_LIMITS, buildLinkUrl, } from './constants.js';
+export type { AccessScope, BuiltinGranteeKind, BuiltinGroupRole, GranteeKindInput, GrantGranteeKind, GroupInviteStatus, GroupRole, SharingEnumEntries } from './constants.js';
+export { addGroupMemberSchema, createGroupInviteSchema, createGroupSchema, groupEmailSchema, groupInviteListQuerySchema, groupInviteListSchema, groupInviteSchema, groupListQuerySchema, groupListSchema, groupMemberListSchema, groupMemberSchema, groupMembershipSchema, groupMetadataSchema, groupRoleDescriptorSchema, groupRoleListSchema, groupRoleSchema, groupSchema, myGroupInviteListSchema, myGroupInviteSchema, pageQuerySchema, updateGroupMemberSchema, updateGroupSchema, createGrantSchema, customGranteeSchema, grantGranteeInputSchema, granteeKindDescriptorSchema, granteeKindIdSchema, granteeKindListSchema, grantGranteeKindSchema, grantGranteeViewSchema, grantListQuerySchema, grantListSchema, grantRoleSchema, grantSchema, groupGranteeSchema, issuedLinkGrantSchema, linkGrantCreateSchema, linkGrantListSchema, linkGrantViewSchema, publicLinkResolutionSchema, resourceTypeSchema, sharedWithMeItemSchema, sharedWithMeListSchema, sharedWithMeQuerySchema, updateGrantSchema, userGranteeSchema, } from './schemas.js';
+export type { AddGroupMemberInput, CreateGroupInput, CreateGroupInviteInput, GroupDto, GroupRoleDescriptor, GroupRoleList, GroupInviteDto, GroupInviteList, GroupInviteListQuery, GroupList, GroupListQuery, GroupMemberDto, GroupMemberList, GroupMembershipDto, MyGroupInviteDto, MyGroupInviteList, PageQuery, UpdateGroupInput, UpdateGroupMemberInput, CreateGrantInput, GrantDto, GrantGranteeInput, GranteeKindDescriptor, GranteeKindList, CustomGranteeInput, GrantGranteeView, GrantList, GrantListQuery, IssuedLinkGrant, LinkGrantCreate, LinkGrantList, LinkGrantView, PublicLinkResolution, SharedWithMeItem, SharedWithMeList, SharedWithMeQuery, UpdateGrantInput, } from './schemas.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/sharing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sharing/index.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,aAAa,EACb,qBAAqB,EACrB,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,cAAc,EACd,YAAY,GACb,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAC9K,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,iBAAiB,EACjB,gBAAgB,EAChB,0BAA0B,EAC1B,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,uBAAuB,EACvB,mBAAmB,EACnB,eAAe,EACf,uBAAuB,EACvB,iBAAiB,EAEjB,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,2BAA2B,EAC3B,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,0BAA0B,EAC1B,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,mBAAmB,EACnB,gBAAgB,EAChB,sBAAsB,EACtB,QAAQ,EACR,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,sBAAsB,EAEtB,gBAAgB,EAChB,QAAQ,EACR,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,cAAc,EACd,eAAe,EACf,eAAe,EACf,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,cAAc,CAAC"}

package/dist/esm/sharing/index.js

@@ -0,0 +1,11 @@
+// `@marinoscar/platform-contract/sharing`: the wire shapes of the sharing
+// routes: groups, their members and their invites (issue #728, PP-7.1), and
+// grants of every kind, link shares included (issue #729, PP-7.2). The
+// API's sharing slice wraps the schemas as its nestjs-zod DTOs. constants.ts is
+// zod-free. Documented in
+// ./README.md. Explicit named exports only.
+export { ACCESS_SCOPES, BUILTIN_GRANTEE_KINDS, BUILTIN_GROUP_ROLES, GRANTEE_KIND_ID_PATTERN, GRANTEE_KIND_INPUTS, GRANT_GRANTEE_KINDS, GROUP_INVITE_LIST_FILTERS, GROUP_INVITE_STATUSES, GROUP_LIST_SCOPES, GROUP_ROLES, LINK_TOKEN_HEADER, LINK_TOKEN_PATTERN, LINK_TOKEN_PREFIX, SHARED_WITH_ME_VIA, SHARING_IDENTIFIER_PATTERN, SHARING_LIMITS, buildLinkUrl, } from './constants.js';
+export { addGroupMemberSchema, createGroupInviteSchema, createGroupSchema, groupEmailSchema, groupInviteListQuerySchema, groupInviteListSchema, groupInviteSchema, groupListQuerySchema, groupListSchema, groupMemberListSchema, groupMemberSchema, groupMembershipSchema, groupMetadataSchema, groupRoleDescriptorSchema, groupRoleListSchema, groupRoleSchema, groupSchema, myGroupInviteListSchema, myGroupInviteSchema, pageQuerySchema, updateGroupMemberSchema, updateGroupSchema, 
+// grants (#729) and link shares (#730)
+createGrantSchema, customGranteeSchema, grantGranteeInputSchema, granteeKindDescriptorSchema, granteeKindIdSchema, granteeKindListSchema, grantGranteeKindSchema, grantGranteeViewSchema, grantListQuerySchema, grantListSchema, grantRoleSchema, grantSchema, groupGranteeSchema, issuedLinkGrantSchema, linkGrantCreateSchema, linkGrantListSchema, linkGrantViewSchema, publicLinkResolutionSchema, resourceTypeSchema, sharedWithMeItemSchema, sharedWithMeListSchema, sharedWithMeQuerySchema, updateGrantSchema, userGranteeSchema, } from './schemas.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/sharing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sharing/index.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,4EAA4E;AAC5E,uEAAuE;AACvE,gFAAgF;AAChF,0BAA0B;AAC1B,4CAA4C;AAE5C,OAAO,EACL,aAAa,EACb,qBAAqB,EACrB,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,cAAc,EACd,YAAY,GACb,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,iBAAiB,EACjB,gBAAgB,EAChB,0BAA0B,EAC1B,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,iBAAiB,EACjB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,uBAAuB,EACvB,mBAAmB,EACnB,eAAe,EACf,uBAAuB,EACvB,iBAAiB;AACjB,uCAAuC;AACvC,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,2BAA2B,EAC3B,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,0BAA0B,EAC1B,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,cAAc,CAAC"}

package/dist/esm/sharing/schemas.d.ts

@@ -0,0 +1,3 @@
+export * from './groups.js';
+export * from './grants.js';
+//# sourceMappingURL=schemas.d.ts.map

package/dist/esm/sharing/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/sharing/schemas.ts"],"names":[],"mappings":"AAEA,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC"}

package/dist/esm/sharing/schemas.js

@@ -0,0 +1,5 @@
+// The sharing schemas, by route group (issue #728). Groups, members and
+// invites live in ./groups.ts; grants (#729) and link shares (#730) join here.
+export * from './groups.js';
+export * from './grants.js';
+//# sourceMappingURL=schemas.js.map

package/dist/esm/sharing/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/sharing/schemas.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,+EAA+E;AAC/E,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC"}

package/dist/esm/storage/constants.d.ts

@@ -0,0 +1,111 @@
+/**
+ * The pattern every storage driver id must match: a lower-case letter, then
+ * letters, digits and hyphens, 2 to 48 characters. The same pattern as every
+ * pluggable id (`PLUGGABLE_ID_PATTERN` of `@marinoscar/platform-contract/settings`).
+ * An id is the key its settings are stored under, so it is permanent once a
+ * row exists.
+ *
+ * @stability experimental
+ */
+export declare const STORAGE_DRIVER_ID_PATTERN: RegExp;
+/**
+ * The storage drivers the platform SHIPS (S3-compatible object stores). Not a
+ * closed set: an app or package registers more with `registerStorageDriver`
+ * (`@marinoscar/platform-api/storage`) and its id is any
+ * {@link STORAGE_DRIVER_ID_PATTERN} string. Use this list for defaults, labels
+ * and the "is this one of the S3 flavours" question, never to validate an id.
+ *
+ *  - `s3`           - AWS S3 proper. `region` is required by the SDK;
+ *                     `endpoint` is left empty and the SDK derives it.
+ *  - `r2`           - Cloudflare R2: its `region` is literally `auto`, and its
+ *                     endpoint is DERIVED from `accountId`.
+ *  - `s3compatible` - MinIO, Backblaze B2, Wasabi, Ceph RGW and anything else
+ *                     speaking the same protocol at an operator-supplied
+ *                     `endpoint`.
+ *
+ * @stability experimental
+ */
+export declare const BUILTIN_STORAGE_PROVIDER_KINDS: readonly ["s3", "r2", "s3compatible"];
+/**
+ * The built-in storage provider kinds.
+ *
+ * @deprecated Use `BUILTIN_STORAGE_PROVIDER_KINDS`. The list is no longer
+ *   the set of valid providers: any registered storage driver id is one.
+ * @stability stable
+ */
+export declare const STORAGE_PROVIDER_KINDS: readonly ["s3", "r2", "s3compatible"];
+/**
+ * One of {@link BUILTIN_STORAGE_PROVIDER_KINDS}.
+ *
+ * @stability experimental
+ */
+export type BuiltinStorageProviderKind = (typeof BUILTIN_STORAGE_PROVIDER_KINDS)[number];
+/**
+ * A configured object-storage provider: the id of a registered storage driver.
+ * A plain string since storage drivers became pluggable (PP-14.7); the
+ * built-ins are {@link BuiltinStorageProviderKind}.
+ *
+ * @stability stable
+ */
+export type StorageProviderKind = string;
+/**
+ * The names of the legacy flat fields the `storage` namespace stored before
+ * drivers had a settings record of their own. They are a read-only view of the
+ * active built-in driver's settings; the namespace stores the new shape
+ * (`provider` plus `drivers`).
+ *
+ * @stability experimental
+ */
+export declare const LEGACY_STORAGE_FLAT_FIELDS: readonly ["bucket", "region", "endpoint", "accountId", "accessKeyId", "forcePathStyle"];
+/**
+ * The five `StorageObjectStatus` values of the `storage` fragment, in its
+ * declaration order (the order the OpenAPI enum lists them in).
+ *
+ * @stability stable
+ */
+export declare const STORAGE_OBJECT_STATUSES: readonly ["pending", "uploading", "processing", "ready", "failed"];
+/**
+ * One storage object status.
+ *
+ * @stability stable
+ */
+export type StorageObjectStatusName = (typeof STORAGE_OBJECT_STATUSES)[number];
+/**
+ * Every field the BUILT-IN (S3 family) storage drivers can be missing, in the
+ * order the admin page and the 503 list them. `secretAccessKey` is the
+ * credential store's half; the rest are the driver's settings. A driver an app
+ * registers reports its own field names, so the wire shape of `missing` is a
+ * list of strings; this list names the built-ins' values.
+ *
+ * @stability stable
+ */
+export declare const MISSING_STORAGE_CONFIG_FIELDS: readonly ["bucket", "region", "endpoint", "accountId", "accessKeyId", "secretAccessKey"];
+/**
+ * Field names the `storage` settings namespace may never declare, at any
+ * case: the secret half of the storage credential lives in the encrypted
+ * credential store at `(purpose 'storage', name 'default')`, never in the
+ * settings blob `GET /api/system-settings` returns wholesale.
+ *
+ * `accessKeyId` is deliberately ABSENT: it is an identifier that travels in
+ * the clear in every SigV4 `Authorization` header and authorises nothing by
+ * itself. The settings slice's own list (`SETTINGS_SECRET_FIELD_NAMES` of
+ * `@marinoscar/platform-api/settings`) is the registry-time check of every
+ * namespace; this is the contract's compile-time copy for the one namespace
+ * it owns.
+ *
+ * @stability stable
+ */
+export declare const STORAGE_SECRET_FIELD_NAMES: readonly ["secretAccessKey", "secretKey", "sessionToken", "secret", "password", "apiKey", "token", "privateKey"];
+/**
+ * The entries of a zod enum built from a value list (`{ s3: 's3', ... }`):
+ * the schemas cast `z.enum(list)` to `z.ZodEnum<StorageEnum<typeof list>>`
+ * so the declarations name the list instead of spelling every entry.
+ *
+ * @typeParam T - the value list.
+ *
+ * @stability experimental
+ */
+export type StorageEnum<T extends readonly string[]> = {
+    [K in T[number]]: K;
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/esm/storage/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/storage/constants.ts"],"names":[],"mappings":"AAUA;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,QAA2B,CAAC;AAElE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,8BAA8B,uCAAwC,CAAC;AAEpF;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,uCAAiC,CAAC;AAErE;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,8BAA8B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzF;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B,yFAA0F,CAAC;AAElI;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,oEAAqE,CAAC;AAE1G;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/E;;;;;;;;GAQG;AACH,eAAO,MAAM,6BAA6B,0FAOhC,CAAC;AAEX;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,0BAA0B,kHAS7B,CAAC;AAEX;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,IAAI;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,CAAC"}

package/dist/esm/storage/constants.js

@@ -0,0 +1,104 @@
+// =============================================================================
+// Storage: plain values of the storage slice's wire shapes (issue #736, PP-8.3)
+// =============================================================================
+//
+// Zod-free, so a consumer that needs only a provider list or a status list
+// (the web app) never bundles the schemas or zod. Moved from the API's
+// `common/schemas/settings.schema.ts` and `storage/config/storage-config.ts`
+// with their comments; the API re-exports them.
+// =============================================================================
+/**
+ * The pattern every storage driver id must match: a lower-case letter, then
+ * letters, digits and hyphens, 2 to 48 characters. The same pattern as every
+ * pluggable id (`PLUGGABLE_ID_PATTERN` of `@marinoscar/platform-contract/settings`).
+ * An id is the key its settings are stored under, so it is permanent once a
+ * row exists.
+ *
+ * @stability experimental
+ */
+export const STORAGE_DRIVER_ID_PATTERN = /^[a-z][a-z0-9-]{1,47}$/;
+/**
+ * The storage drivers the platform SHIPS (S3-compatible object stores). Not a
+ * closed set: an app or package registers more with `registerStorageDriver`
+ * (`@marinoscar/platform-api/storage`) and its id is any
+ * {@link STORAGE_DRIVER_ID_PATTERN} string. Use this list for defaults, labels
+ * and the "is this one of the S3 flavours" question, never to validate an id.
+ *
+ *  - `s3`           - AWS S3 proper. `region` is required by the SDK;
+ *                     `endpoint` is left empty and the SDK derives it.
+ *  - `r2`           - Cloudflare R2: its `region` is literally `auto`, and its
+ *                     endpoint is DERIVED from `accountId`.
+ *  - `s3compatible` - MinIO, Backblaze B2, Wasabi, Ceph RGW and anything else
+ *                     speaking the same protocol at an operator-supplied
+ *                     `endpoint`.
+ *
+ * @stability experimental
+ */
+export const BUILTIN_STORAGE_PROVIDER_KINDS = ['s3', 'r2', 's3compatible'];
+/**
+ * The built-in storage provider kinds.
+ *
+ * @deprecated Use `BUILTIN_STORAGE_PROVIDER_KINDS`. The list is no longer
+ *   the set of valid providers: any registered storage driver id is one.
+ * @stability stable
+ */
+export const STORAGE_PROVIDER_KINDS = BUILTIN_STORAGE_PROVIDER_KINDS;
+/**
+ * The names of the legacy flat fields the `storage` namespace stored before
+ * drivers had a settings record of their own. They are a read-only view of the
+ * active built-in driver's settings; the namespace stores the new shape
+ * (`provider` plus `drivers`).
+ *
+ * @stability experimental
+ */
+export const LEGACY_STORAGE_FLAT_FIELDS = ['bucket', 'region', 'endpoint', 'accountId', 'accessKeyId', 'forcePathStyle'];
+/**
+ * The five `StorageObjectStatus` values of the `storage` fragment, in its
+ * declaration order (the order the OpenAPI enum lists them in).
+ *
+ * @stability stable
+ */
+export const STORAGE_OBJECT_STATUSES = ['pending', 'uploading', 'processing', 'ready', 'failed'];
+/**
+ * Every field the BUILT-IN (S3 family) storage drivers can be missing, in the
+ * order the admin page and the 503 list them. `secretAccessKey` is the
+ * credential store's half; the rest are the driver's settings. A driver an app
+ * registers reports its own field names, so the wire shape of `missing` is a
+ * list of strings; this list names the built-ins' values.
+ *
+ * @stability stable
+ */
+export const MISSING_STORAGE_CONFIG_FIELDS = [
+    'bucket',
+    'region',
+    'endpoint',
+    'accountId',
+    'accessKeyId',
+    'secretAccessKey',
+];
+/**
+ * Field names the `storage` settings namespace may never declare, at any
+ * case: the secret half of the storage credential lives in the encrypted
+ * credential store at `(purpose 'storage', name 'default')`, never in the
+ * settings blob `GET /api/system-settings` returns wholesale.
+ *
+ * `accessKeyId` is deliberately ABSENT: it is an identifier that travels in
+ * the clear in every SigV4 `Authorization` header and authorises nothing by
+ * itself. The settings slice's own list (`SETTINGS_SECRET_FIELD_NAMES` of
+ * `@marinoscar/platform-api/settings`) is the registry-time check of every
+ * namespace; this is the contract's compile-time copy for the one namespace
+ * it owns.
+ *
+ * @stability stable
+ */
+export const STORAGE_SECRET_FIELD_NAMES = [
+    'secretAccessKey',
+    'secretKey',
+    'sessionToken',
+    'secret',
+    'password',
+    'apiKey',
+    'token',
+    'privateKey',
+];
+//# sourceMappingURL=constants.js.map

package/dist/esm/storage/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/storage/constants.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAChF,EAAE;AACF,2EAA2E;AAC3E,uEAAuE;AACvE,6EAA6E;AAC7E,gDAAgD;AAChD,gFAAgF;AAEhF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,wBAAwB,CAAC;AAElE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,CAAU,CAAC;AAEpF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,8BAA8B,CAAC;AAkBrE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,CAAU,CAAC;AAElI;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC;AAS1G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,WAAW;IACX,aAAa;IACb,iBAAiB;CACT,CAAC;AAEX;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,iBAAiB;IACjB,WAAW;IACX,cAAc;IACd,QAAQ;IACR,UAAU;IACV,QAAQ;IACR,OAAO;IACP,YAAY;CACJ,CAAC"}