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

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

@@ -0,0 +1,410 @@
+import { z } from 'zod';
+/**
+ * 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 declare const groupRoleSchema: z.ZodString;
+/**
+ * One registered group role as `GET /api/sharing/group-roles` describes it:
+ * what a role picker needs.
+ *
+ * @stability experimental
+ */
+export declare const groupRoleDescriptorSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    actions: z.ZodArray<z.ZodString>;
+    builtin: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * `GET /api/sharing/group-roles` response: the registered roles, strongest first.
+ *
+ * @stability experimental
+ */
+export declare const groupRoleListSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        actions: z.ZodArray<z.ZodString>;
+        builtin: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * One registered group role.
+ *
+ * @stability experimental
+ */
+export type GroupRoleDescriptor = z.output<typeof groupRoleDescriptorSchema>;
+/**
+ * The `GET /api/sharing/group-roles` response.
+ *
+ * @stability experimental
+ */
+export type GroupRoleList = z.output<typeof groupRoleListSchema>;
+/**
+ * An e-mail address, trimmed and lower-cased (invites are stored lower-cased).
+ *
+ * @stability experimental
+ */
+export declare const groupEmailSchema: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+/**
+ * `page` and `pageSize` of a list, coerced from the query string.
+ *
+ * @stability experimental
+ */
+export declare const pageQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strip>;
+/**
+ * `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 declare const groupListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    scope: z.ZodDefault<z.ZodEnum<import("./constants.js").SharingEnumEntries<"all" | "mine">>>;
+}, z.core.$strip>;
+/**
+ * Free-form app data on a group (`groups.metadata`): an object, at most 32
+ * keys. Never secret material.
+ *
+ * @stability experimental
+ */
+export declare const groupMetadataSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+/**
+ * `POST /api/groups` body.
+ *
+ * @stability experimental
+ */
+export declare const createGroupSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, z.core.$strict>;
+/**
+ * `PATCH /api/groups/:id` body: at least one field. Send the group's
+ * `version` in `If-Match`.
+ *
+ * @stability experimental
+ */
+export declare const updateGroupSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, z.core.$strict>;
+/**
+ * One group as the API returns it.
+ *
+ * @stability experimental
+ */
+export declare const groupSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    orgId: z.ZodUUID;
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    createdById: z.ZodNullable<z.ZodUUID>;
+    version: z.ZodNumber;
+    myRole: z.ZodNullable<z.ZodString>;
+    memberCount: z.ZodNumber;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+/**
+ * A page of groups (`page`, `pageSize`, `items`, `total`, `totalPages`).
+ *
+ * @stability experimental
+ */
+export declare const groupListSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        orgId: z.ZodUUID;
+        name: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        createdById: z.ZodNullable<z.ZodUUID>;
+        version: z.ZodNumber;
+        myRole: z.ZodNullable<z.ZodString>;
+        memberCount: z.ZodNumber;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+    totalPages: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * `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 declare const addGroupMemberSchema: z.ZodObject<{
+    email: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+    userId: z.ZodOptional<z.ZodUUID>;
+    role: z.ZodDefault<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * `PATCH /api/groups/:id/members/:userId` body.
+ *
+ * @stability experimental
+ */
+export declare const updateGroupMemberSchema: z.ZodObject<{
+    role: z.ZodString;
+}, z.core.$strict>;
+/**
+ * One member of a group.
+ *
+ * @stability experimental
+ */
+export declare const groupMemberSchema: z.ZodObject<{
+    groupId: z.ZodUUID;
+    userId: z.ZodUUID;
+    role: z.ZodString;
+    email: z.ZodString;
+    displayName: z.ZodNullable<z.ZodString>;
+    addedById: z.ZodNullable<z.ZodUUID>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+/**
+ * A page of members (`page`, `pageSize`, `items`, `total`, `totalPages`).
+ *
+ * @stability experimental
+ */
+export declare const groupMemberListSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        groupId: z.ZodUUID;
+        userId: z.ZodUUID;
+        role: z.ZodString;
+        email: z.ZodString;
+        displayName: z.ZodNullable<z.ZodString>;
+        addedById: z.ZodNullable<z.ZodUUID>;
+        createdAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+    totalPages: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * `POST /api/groups/:id/invites` body.
+ *
+ * @stability experimental
+ */
+export declare const createGroupInviteSchema: z.ZodObject<{
+    email: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    role: z.ZodDefault<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * `GET /api/groups/:id/invites` query: the page, and `status=pending` (the
+ * default) or `all`.
+ *
+ * @stability experimental
+ */
+export declare const groupInviteListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    status: z.ZodDefault<z.ZodEnum<import("./constants.js").SharingEnumEntries<"pending" | "all">>>;
+}, z.core.$strip>;
+/**
+ * One invitation to a group, as the group's administrators see it.
+ *
+ * @stability experimental
+ */
+export declare const groupInviteSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    groupId: z.ZodUUID;
+    orgId: z.ZodUUID;
+    email: z.ZodString;
+    role: z.ZodString;
+    status: z.ZodEnum<import("./constants.js").SharingEnumEntries<"pending" | "expired" | "accepted" | "revoked" | "declined">>;
+    invitedById: z.ZodNullable<z.ZodUUID>;
+    expiresAt: z.ZodNullable<z.ZodISODateTime>;
+    acceptedAt: z.ZodNullable<z.ZodISODateTime>;
+    declinedAt: z.ZodNullable<z.ZodISODateTime>;
+    revokedAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+/**
+ * A page of invites (`page`, `pageSize`, `items`, `total`, `totalPages`).
+ *
+ * @stability experimental
+ */
+export declare const groupInviteListSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        groupId: z.ZodUUID;
+        orgId: z.ZodUUID;
+        email: z.ZodString;
+        role: z.ZodString;
+        status: z.ZodEnum<import("./constants.js").SharingEnumEntries<"pending" | "expired" | "accepted" | "revoked" | "declined">>;
+        invitedById: z.ZodNullable<z.ZodUUID>;
+        expiresAt: z.ZodNullable<z.ZodISODateTime>;
+        acceptedAt: z.ZodNullable<z.ZodISODateTime>;
+        declinedAt: z.ZodNullable<z.ZodISODateTime>;
+        revokedAt: z.ZodNullable<z.ZodISODateTime>;
+        createdAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+    totalPages: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * 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 declare const myGroupInviteSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    groupId: z.ZodUUID;
+    groupName: z.ZodString;
+    orgId: z.ZodUUID;
+    role: z.ZodString;
+    invitedById: z.ZodNullable<z.ZodUUID>;
+    expiresAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+/**
+ * The caller's pending invitations, across every organization they belong to.
+ *
+ * @stability experimental
+ */
+export declare const myGroupInviteListSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        groupId: z.ZodUUID;
+        groupName: z.ZodString;
+        orgId: z.ZodUUID;
+        role: z.ZodString;
+        invitedById: z.ZodNullable<z.ZodUUID>;
+        expiresAt: z.ZodNullable<z.ZodISODateTime>;
+        createdAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * The membership an accepted invite produced.
+ *
+ * @stability experimental
+ */
+export declare const groupMembershipSchema: z.ZodObject<{
+    groupId: z.ZodUUID;
+    orgId: z.ZodUUID;
+    role: z.ZodString;
+}, z.core.$strip>;
+/**
+ * The `GET /api/groups` query, parsed.
+ *
+ * @stability experimental
+ */
+export type GroupListQuery = z.output<typeof groupListQuerySchema>;
+/**
+ * A list's page parameters, parsed.
+ *
+ * @stability experimental
+ */
+export type PageQuery = z.output<typeof pageQuerySchema>;
+/**
+ * The `POST /api/groups` body, parsed.
+ *
+ * @stability experimental
+ */
+export type CreateGroupInput = z.output<typeof createGroupSchema>;
+/**
+ * The `PATCH /api/groups/:id` body, parsed.
+ *
+ * @stability experimental
+ */
+export type UpdateGroupInput = z.output<typeof updateGroupSchema>;
+/**
+ * One group on the wire.
+ *
+ * @stability experimental
+ */
+export type GroupDto = z.output<typeof groupSchema>;
+/**
+ * A page of groups.
+ *
+ * @stability experimental
+ */
+export type GroupList = z.output<typeof groupListSchema>;
+/**
+ * The `POST /api/groups/:id/members` body, parsed.
+ *
+ * @stability experimental
+ */
+export type AddGroupMemberInput = z.output<typeof addGroupMemberSchema>;
+/**
+ * The `PATCH /api/groups/:id/members/:userId` body, parsed.
+ *
+ * @stability experimental
+ */
+export type UpdateGroupMemberInput = z.output<typeof updateGroupMemberSchema>;
+/**
+ * One member on the wire.
+ *
+ * @stability experimental
+ */
+export type GroupMemberDto = z.output<typeof groupMemberSchema>;
+/**
+ * A page of members.
+ *
+ * @stability experimental
+ */
+export type GroupMemberList = z.output<typeof groupMemberListSchema>;
+/**
+ * The `POST /api/groups/:id/invites` body, parsed.
+ *
+ * @stability experimental
+ */
+export type CreateGroupInviteInput = z.output<typeof createGroupInviteSchema>;
+/**
+ * The `GET /api/groups/:id/invites` query, parsed.
+ *
+ * @stability experimental
+ */
+export type GroupInviteListQuery = z.output<typeof groupInviteListQuerySchema>;
+/**
+ * One invite on the wire.
+ *
+ * @stability experimental
+ */
+export type GroupInviteDto = z.output<typeof groupInviteSchema>;
+/**
+ * A page of invites.
+ *
+ * @stability experimental
+ */
+export type GroupInviteList = z.output<typeof groupInviteListSchema>;
+/**
+ * One of the caller's pending invites.
+ *
+ * @stability experimental
+ */
+export type MyGroupInviteDto = z.output<typeof myGroupInviteSchema>;
+/**
+ * The caller's pending invites.
+ *
+ * @stability experimental
+ */
+export type MyGroupInviteList = z.output<typeof myGroupInviteListSchema>;
+/**
+ * The membership an accepted invite produced.
+ *
+ * @stability experimental
+ */
+export type GroupMembershipDto = z.output<typeof groupMembershipSchema>;
+//# sourceMappingURL=groups.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"groups.d.ts","sourceRoot":"","sources":["../../../src/sharing/groups.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,aAI2D,CAAC;AAExF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;;;;;;iBAWpC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;iBAG9B,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE7E;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,wDAKe,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;iBAK1B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;iBAK/B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,wCAGqE,CAAC;AAEtG;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;kBASnB,CAAC;AAEZ;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;kBAU8C,CAAC;AAE7E;;;;GAIG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;iBAuBtB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;iBAW1B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;kBAUsF,CAAC;AAExH;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;kBAKzB,CAAC;AAEZ;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;iBAe5B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;iBAWhC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;kBAOzB,CAAC;AAEZ;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B;;;;iBAGrC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;iBAyB5B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;iBAWhC,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;iBAiB9B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;iBAGlC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;iBAOhC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAC;AACnE;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,eAAe,CAAC,CAAC;AACzD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAClE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAClE;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,WAAW,CAAC,CAAC;AACpD;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,eAAe,CAAC,CAAC;AACzD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAC;AACxE;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAC9E;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAChE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACrE;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAC9E;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC/E;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAChE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACrE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACpE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACzE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAC"}