@headless-lms/server 0.3.0 → 0.5.0

package/dist/http/schemas/assets.d.ts

@@ -8,8 +8,8 @@ declare const AssetKind: z.ZodEnum<{
 }>;
 type AssetKind = z.infer<typeof AssetKind>;
 declare const AssetSource: z.ZodEnum<{
-  library: "library";
   member: "member";
+  library: "library";
 }>;
 type AssetSource = z.infer<typeof AssetSource>;
 declare const AssetStatus: z.ZodEnum<{
@@ -26,10 +26,11 @@ declare const Asset: z.ZodObject<{
   }>;
   createdAt: z.ZodCoercedDate<unknown>;
   updatedAt: z.ZodCoercedDate<unknown>;
-  uploadedBy: z.ZodString;
+  contentId: z.ZodNullable<z.ZodString>;
   filename: z.ZodString;
   contentType: z.ZodString;
   size: z.ZodNumber;
+  uploadedBy: z.ZodString;
   kind: z.ZodEnum<{
     image: "image";
     video: "video";
@@ -37,8 +38,8 @@ declare const Asset: z.ZodObject<{
     document: "document";
   }>;
   source: z.ZodEnum<{
-    library: "library";
     member: "member";
+    library: "library";
   }>;
   url: z.ZodNullable<z.ZodString>;
   downloadUrl: z.ZodNullable<z.ZodString>;
@@ -56,9 +57,10 @@ declare const AssetsQuery: z.ZodObject<{
     document: "document";
   }>>;
   source: z.ZodOptional<z.ZodEnum<{
-    library: "library";
     member: "member";
+    library: "library";
   }>>;
+  contentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 type AssetsQuery = z.infer<typeof AssetsQuery>;
 declare const AssetsPage: z.ZodObject<{
@@ -71,10 +73,11 @@ declare const AssetsPage: z.ZodObject<{
     }>;
     createdAt: z.ZodCoercedDate<unknown>;
     updatedAt: z.ZodCoercedDate<unknown>;
-    uploadedBy: z.ZodString;
+    contentId: z.ZodNullable<z.ZodString>;
     filename: z.ZodString;
     contentType: z.ZodString;
     size: z.ZodNumber;
+    uploadedBy: z.ZodString;
     kind: z.ZodEnum<{
       image: "image";
       video: "video";
@@ -82,8 +85,8 @@ declare const AssetsPage: z.ZodObject<{
       document: "document";
     }>;
     source: z.ZodEnum<{
-      library: "library";
       member: "member";
+      library: "library";
     }>;
     url: z.ZodNullable<z.ZodString>;
     downloadUrl: z.ZodNullable<z.ZodString>;
@@ -100,6 +103,7 @@ type AssetIdParam = z.infer<typeof AssetIdParam>;
 declare const RequestUpload: z.ZodObject<{
   filename: z.ZodString;
   contentType: z.ZodString;
+  contentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 type RequestUpload = z.infer<typeof RequestUpload>;
 declare const RequestMemberUpload: z.ZodObject<{
@@ -121,10 +125,11 @@ declare const UploadTicket: z.ZodObject<{
     }>;
     createdAt: z.ZodCoercedDate<unknown>;
     updatedAt: z.ZodCoercedDate<unknown>;
-    uploadedBy: z.ZodString;
+    contentId: z.ZodNullable<z.ZodString>;
     filename: z.ZodString;
     contentType: z.ZodString;
     size: z.ZodNumber;
+    uploadedBy: z.ZodString;
     kind: z.ZodEnum<{
       image: "image";
       video: "video";
@@ -132,8 +137,8 @@ declare const UploadTicket: z.ZodObject<{
       document: "document";
     }>;
     source: z.ZodEnum<{
-      library: "library";
       member: "member";
+      library: "library";
     }>;
     url: z.ZodNullable<z.ZodString>;
     downloadUrl: z.ZodNullable<z.ZodString>;

package/dist/http/schemas/assets.js

@@ -1,10 +1,9 @@
 import { ListQuery, paginated } from "./shared.js";
-import { MEMBER_IMAGE_TYPE } from "@headless-lms/core/assets";
 import { z } from "zod";
 import { assetKindSchema, assetSourceSchema, assetStatusSchema, assetViewSchema, uploadTicketSchema } from "@headless-lms/core/schemas";
 //#region src/http/schemas/assets.ts
 const AssetKind = assetKindSchema.describe("The media class, derived by the server from the content type.");
-const AssetSource = assetSourceSchema.describe("Where the file came from: `library` is the org's media uploaded by staff, `member` is a person's own upload.");
+const AssetSource = assetSourceSchema.describe("Where the file came from: `library` is the org's media, `member` is a person's own upload.");
 const AssetStatus = assetStatusSchema;
 const Asset = assetViewSchema.omit({ key: true }).extend({
 	kind: AssetKind,
@@ -14,18 +13,20 @@ const Asset = assetViewSchema.omit({ key: true }).extend({
 }).strip();
 const AssetsQuery = ListQuery.extend({
 	kind: AssetKind.optional(),
-	source: AssetSource.optional().describe("Defaults to `library`.")
+	source: AssetSource.optional().describe("Defaults to `library`."),
+	contentId: z.string().optional().describe("Only the files uploaded for this content item.")
 });
 const AssetsPage = paginated(Asset);
 const AssetIdParam = z.object({ id: z.string() });
 const Filename = z.string().trim().min(1).max(255);
 const RequestUpload = z.object({
 	filename: Filename,
-	contentType: z.string().min(1).max(255).describe("The media class is derived from this.")
+	contentType: z.string().min(1).max(255).describe("The media class is derived from this."),
+	contentId: z.string().optional().describe("The course, download or community the file is for.")
 });
 const RequestMemberUpload = z.object({
 	filename: Filename,
-	contentType: z.string().regex(MEMBER_IMAGE_TYPE, "A member upload must be a PNG, JPEG, GIF, WebP or AVIF image").describe("One of `image/png`, `image/jpeg`, `image/gif`, `image/webp` or `image/avif`. The stored type and size are checked when the upload is finalized.")
+	contentType: z.string().min(1).max(255).describe("Any type. Only `image/png`, `image/jpeg`, `image/gif`, `image/webp` and `image/avif` count as images (a profile photo, a post cover, a message attachment); every other type is a file a post can show. The stored type and size are checked when the upload is finalized.")
 });
 const UploadTicket = uploadTicketSchema.extend({ asset: Asset });
 //#endregion

package/dist/http/schemas/assets.js.map

@@ -1 +1 @@
-{"version":3,"file":"assets.js","names":[],"sources":["../../../src/http/schemas/assets.ts"],"sourcesContent":["import { z } from 'zod';\nimport {\n  assetKindSchema,\n  assetSourceSchema,\n  assetStatusSchema,\n  assetViewSchema,\n  uploadTicketSchema,\n} from '@headless-lms/core/schemas';\nimport { MEMBER_IMAGE_TYPE } from '@headless-lms/core/assets';\nimport { ListQuery, paginated } from './shared.js';\n\nexport const AssetKind = assetKindSchema.describe(\n  'The media class, derived by the server from the content type.',\n);\nexport type AssetKind = z.infer<typeof AssetKind>;\n\nexport const AssetSource = assetSourceSchema.describe(\n  \"Where the file came from: `library` is the org's media uploaded by staff, `member` is a person's own upload.\",\n);\nexport type AssetSource = z.infer<typeof AssetSource>;\n\nexport const AssetStatus = assetStatusSchema;\nexport type AssetStatus = z.infer<typeof AssetStatus>;\n\nexport const Asset = assetViewSchema\n  .omit({ key: true })\n  .extend({\n    kind: AssetKind,\n    source: AssetSource,\n    url: z\n      .string()\n      .nullable()\n      .describe(\n        'A short-lived signed URL that shows a ready library file. `null` while pending and for a member upload, which is served with what it is attached to.',\n      ),\n    downloadUrl: z\n      .string()\n      .nullable()\n      .describe('The same file as a download saved under its filename. `null` when `url` is.'),\n  })\n  .strip();\nexport type Asset = z.infer<typeof Asset>;\n\nexport const AssetsQuery = ListQuery.extend({\n  kind: AssetKind.optional(),\n  source: AssetSource.optional().describe('Defaults to `library`.'),\n});\nexport type AssetsQuery = z.infer<typeof AssetsQuery>;\n\nexport const AssetsPage = paginated(Asset);\nexport type AssetsPage = z.infer<typeof AssetsPage>;\n\nexport const AssetIdParam = z.object({ id: z.string() });\nexport type AssetIdParam = z.infer<typeof AssetIdParam>;\n\nconst Filename = z.string().trim().min(1).max(255);\n\nexport const RequestUpload = z.object({\n  filename: Filename,\n  contentType: z.string().min(1).max(255).describe('The media class is derived from this.'),\n});\nexport type RequestUpload = z.infer<typeof RequestUpload>;\n\nexport const RequestMemberUpload = z.object({\n  filename: Filename,\n  contentType: z\n    .string()\n    .regex(MEMBER_IMAGE_TYPE, 'A member upload must be a PNG, JPEG, GIF, WebP or AVIF image')\n    .describe(\n      'One of `image/png`, `image/jpeg`, `image/gif`, `image/webp` or `image/avif`. The stored type and size are checked when the upload is finalized.',\n    ),\n});\nexport type RequestMemberUpload = z.infer<typeof RequestMemberUpload>;\n\nexport const UploadTicket = uploadTicketSchema.extend({ asset: Asset });\nexport type UploadTicket = z.infer<typeof UploadTicket>;\n"],"mappings":";;;;;AAWA,MAAa,YAAY,gBAAgB,SACvC,+DACF;AAGA,MAAa,cAAc,kBAAkB,SAC3C,8GACF;AAGA,MAAa,cAAc;AAG3B,MAAa,QAAQ,gBAClB,KAAK,EAAE,KAAK,KAAK,CAAC,CAAC,CACnB,OAAO;CACN,MAAM;CACN,QAAQ;CACR,KAAK,EACF,OAAO,CAAC,CACR,SAAS,CAAC,CACV,SACC,sJACF;CACF,aAAa,EACV,OAAO,CAAC,CACR,SAAS,CAAC,CACV,SAAS,6EAA6E;AAC3F,CAAC,CAAC,CACD,MAAM;AAGT,MAAa,cAAc,UAAU,OAAO;CAC1C,MAAM,UAAU,SAAS;CACzB,QAAQ,YAAY,SAAS,CAAC,CAAC,SAAS,wBAAwB;AAClE,CAAC;AAGD,MAAa,aAAa,UAAU,KAAK;AAGzC,MAAa,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAGvD,MAAM,WAAW,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG;AAEjD,MAAa,gBAAgB,EAAE,OAAO;CACpC,UAAU;CACV,aAAa,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,SAAS,uCAAuC;AAC1F,CAAC;AAGD,MAAa,sBAAsB,EAAE,OAAO;CAC1C,UAAU;CACV,aAAa,EACV,OAAO,CAAC,CACR,MAAM,mBAAmB,8DAA8D,CAAC,CACxF,SACC,iJACF;AACJ,CAAC;AAGD,MAAa,eAAe,mBAAmB,OAAO,EAAE,OAAO,MAAM,CAAC"}
+{"version":3,"file":"assets.js","names":[],"sources":["../../../src/http/schemas/assets.ts"],"sourcesContent":["import { z } from 'zod';\nimport {\n  assetKindSchema,\n  assetSourceSchema,\n  assetStatusSchema,\n  assetViewSchema,\n  uploadTicketSchema,\n} from '@headless-lms/core/schemas';\nimport { ListQuery, paginated } from './shared.js';\n\nexport const AssetKind = assetKindSchema.describe(\n  'The media class, derived by the server from the content type.',\n);\nexport type AssetKind = z.infer<typeof AssetKind>;\n\nexport const AssetSource = assetSourceSchema.describe(\n  \"Where the file came from: `library` is the org's media, `member` is a person's own upload.\",\n);\nexport type AssetSource = z.infer<typeof AssetSource>;\n\nexport const AssetStatus = assetStatusSchema;\nexport type AssetStatus = z.infer<typeof AssetStatus>;\n\nexport const Asset = assetViewSchema\n  .omit({ key: true })\n  .extend({\n    kind: AssetKind,\n    source: AssetSource,\n    url: z\n      .string()\n      .nullable()\n      .describe(\n        'A short-lived signed URL that shows a ready library file. `null` while pending and for a member upload, which is served with what it is attached to.',\n      ),\n    downloadUrl: z\n      .string()\n      .nullable()\n      .describe('The same file as a download saved under its filename. `null` when `url` is.'),\n  })\n  .strip();\nexport type Asset = z.infer<typeof Asset>;\n\nexport const AssetsQuery = ListQuery.extend({\n  kind: AssetKind.optional(),\n  source: AssetSource.optional().describe('Defaults to `library`.'),\n  contentId: z.string().optional().describe('Only the files uploaded for this content item.'),\n});\nexport type AssetsQuery = z.infer<typeof AssetsQuery>;\n\nexport const AssetsPage = paginated(Asset);\nexport type AssetsPage = z.infer<typeof AssetsPage>;\n\nexport const AssetIdParam = z.object({ id: z.string() });\nexport type AssetIdParam = z.infer<typeof AssetIdParam>;\n\nconst Filename = z.string().trim().min(1).max(255);\n\nexport const RequestUpload = z.object({\n  filename: Filename,\n  contentType: z.string().min(1).max(255).describe('The media class is derived from this.'),\n  contentId: z.string().optional().describe('The course, download or community the file is for.'),\n});\nexport type RequestUpload = z.infer<typeof RequestUpload>;\n\nexport const RequestMemberUpload = z.object({\n  filename: Filename,\n  contentType: z\n    .string()\n    .min(1)\n    .max(255)\n    .describe(\n      'Any type. Only `image/png`, `image/jpeg`, `image/gif`, `image/webp` and `image/avif` count as images (a profile photo, a post cover, a message attachment); every other type is a file a post can show. The stored type and size are checked when the upload is finalized.',\n    ),\n});\nexport type RequestMemberUpload = z.infer<typeof RequestMemberUpload>;\n\nexport const UploadTicket = uploadTicketSchema.extend({ asset: Asset });\nexport type UploadTicket = z.infer<typeof UploadTicket>;\n"],"mappings":";;;;AAUA,MAAa,YAAY,gBAAgB,SACvC,+DACF;AAGA,MAAa,cAAc,kBAAkB,SAC3C,4FACF;AAGA,MAAa,cAAc;AAG3B,MAAa,QAAQ,gBAClB,KAAK,EAAE,KAAK,KAAK,CAAC,CAAC,CACnB,OAAO;CACN,MAAM;CACN,QAAQ;CACR,KAAK,EACF,OAAO,CAAC,CACR,SAAS,CAAC,CACV,SACC,sJACF;CACF,aAAa,EACV,OAAO,CAAC,CACR,SAAS,CAAC,CACV,SAAS,6EAA6E;AAC3F,CAAC,CAAC,CACD,MAAM;AAGT,MAAa,cAAc,UAAU,OAAO;CAC1C,MAAM,UAAU,SAAS;CACzB,QAAQ,YAAY,SAAS,CAAC,CAAC,SAAS,wBAAwB;CAChE,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,gDAAgD;AAC5F,CAAC;AAGD,MAAa,aAAa,UAAU,KAAK;AAGzC,MAAa,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAGvD,MAAM,WAAW,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG;AAEjD,MAAa,gBAAgB,EAAE,OAAO;CACpC,UAAU;CACV,aAAa,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,SAAS,uCAAuC;CACxF,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,oDAAoD;AAChG,CAAC;AAGD,MAAa,sBAAsB,EAAE,OAAO;CAC1C,UAAU;CACV,aAAa,EACV,OAAO,CAAC,CACR,IAAI,CAAC,CAAC,CACN,IAAI,GAAG,CAAC,CACR,SACC,4QACF;AACJ,CAAC;AAGD,MAAa,eAAe,mBAAmB,OAAO,EAAE,OAAO,MAAM,CAAC"}

package/dist/http/schemas/automations.d.ts

@@ -30,10 +30,6 @@ declare const Automation: z.ZodObject<{
   }, z.core.$strict>>;
   enabled: z.ZodBoolean;
   filter: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodType<import("@headless-lms/core/types").JsonValue, unknown, z.core.$ZodTypeInternals<import("@headless-lms/core/types").JsonValue, unknown>>>>;
-  source: z.ZodEnum<{
-    system: "system";
-    user: "user";
-  }>;
   createdAt: z.ZodCoercedDate<unknown>;
   updatedAt: z.ZodCoercedDate<unknown>;
 }, z.core.$strict>;
@@ -97,8 +93,8 @@ declare const AvailableTriggers: z.ZodObject<{
 }, z.core.$strict>;
 type AvailableTriggers = z.infer<typeof AvailableTriggers>;
 declare const AutomationRunStatus: z.ZodEnum<{
-  running: "running";
   completed: "completed";
+  running: "running";
   failed: "failed";
 }>;
 type AutomationRunStatus = z.infer<typeof AutomationRunStatus>;
@@ -121,8 +117,8 @@ declare const AutomationRun: z.ZodObject<{
   eventId: z.ZodString;
   event: z.ZodType<import("@headless-lms/core/types").DomainEvent<unknown, string, number>, unknown, z.core.$ZodTypeInternals<import("@headless-lms/core/types").DomainEvent<unknown, string, number>, unknown>>;
   status: z.ZodEnum<{
-    running: "running";
     completed: "completed";
+    running: "running";
     failed: "failed";
   }>;
   actionResults: z.ZodArray<z.ZodObject<{
@@ -147,8 +143,8 @@ declare const AutomationRunsQuery: z.ZodObject<{
   search: z.ZodOptional<z.ZodString>;
   sort: z.ZodOptional<z.ZodString>;
   status: z.ZodOptional<z.ZodEnum<{
-    running: "running";
     completed: "completed";
+    running: "running";
     failed: "failed";
   }>>;
 }, z.core.$strip>;
@@ -162,8 +158,8 @@ declare const AutomationRunsPage: z.ZodObject<{
     eventId: z.ZodString;
     event: z.ZodType<import("@headless-lms/core/types").DomainEvent<unknown, string, number>, unknown, z.core.$ZodTypeInternals<import("@headless-lms/core/types").DomainEvent<unknown, string, number>, unknown>>;
     status: z.ZodEnum<{
-      running: "running";
       completed: "completed";
+      running: "running";
       failed: "failed";
     }>;
     actionResults: z.ZodArray<z.ZodObject<{

package/dist/http/schemas/chats.d.ts

@@ -44,6 +44,7 @@ declare const MessageView: z.ZodObject<{
   orgUserId: z.ZodString;
   body: z.ZodString;
   replyToId: z.ZodNullable<z.ZodString>;
+  clientId: z.ZodNullable<z.ZodUUID>;
   editedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
   deletedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
   createdAt: z.ZodCoercedDate<unknown>;
@@ -57,13 +58,8 @@ declare const MessageView: z.ZodObject<{
     image: z.ZodNullable<z.ZodString>;
     imageAssetId: z.ZodNullable<z.ZodString>;
     imageUrl: z.ZodNullable<z.ZodString>;
-    role: z.ZodEnum<{
-      owner: "owner";
-      admin: "admin";
-      instructor: "instructor";
-      moderator: "moderator";
-      student: "student";
-    }>;
+    team: z.ZodBoolean;
+    roleName: z.ZodNullable<z.ZodString>;
   }, z.core.$strict>;
   attachments: z.ZodArray<z.ZodObject<{
     assetId: z.ZodString;
@@ -71,6 +67,10 @@ declare const MessageView: z.ZodObject<{
   }, z.core.$strict>>;
   reactions: z.ZodRecord<z.ZodString, z.ZodNumber>;
   viewerReaction: z.ZodNullable<z.ZodString>;
+  mentions: z.ZodArray<z.ZodObject<{
+    orgUserId: z.ZodString;
+    name: z.ZodString;
+  }, z.core.$strict>>;
 }, z.core.$strict>;
 declare const MessagesPage: z.ZodObject<{
   rows: z.ZodArray<z.ZodObject<{
@@ -81,6 +81,7 @@ declare const MessagesPage: z.ZodObject<{
     orgUserId: z.ZodString;
     body: z.ZodString;
     replyToId: z.ZodNullable<z.ZodString>;
+    clientId: z.ZodNullable<z.ZodUUID>;
     editedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
     deletedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
     createdAt: z.ZodCoercedDate<unknown>;
@@ -94,13 +95,8 @@ declare const MessagesPage: z.ZodObject<{
       image: z.ZodNullable<z.ZodString>;
       imageAssetId: z.ZodNullable<z.ZodString>;
       imageUrl: z.ZodNullable<z.ZodString>;
-      role: z.ZodEnum<{
-        owner: "owner";
-        admin: "admin";
-        instructor: "instructor";
-        moderator: "moderator";
-        student: "student";
-      }>;
+      team: z.ZodBoolean;
+      roleName: z.ZodNullable<z.ZodString>;
     }, z.core.$strict>;
     attachments: z.ZodArray<z.ZodObject<{
       assetId: z.ZodString;
@@ -108,6 +104,10 @@ declare const MessagesPage: z.ZodObject<{
     }, z.core.$strict>>;
     reactions: z.ZodRecord<z.ZodString, z.ZodNumber>;
     viewerReaction: z.ZodNullable<z.ZodString>;
+    mentions: z.ZodArray<z.ZodObject<{
+      orgUserId: z.ZodString;
+      name: z.ZodString;
+    }, z.core.$strict>>;
   }, z.core.$strict>>;
   total: z.ZodNumber;
   page: z.ZodNumber;
@@ -134,9 +134,26 @@ declare const ChatListItem: z.ZodObject<{
     updatedAt: z.ZodCoercedDate<unknown>;
   }, z.core.$strict>;
   participantIds: z.ZodArray<z.ZodString>;
+  participants: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    firstName: z.ZodNullable<z.ZodString>;
+    lastName: z.ZodNullable<z.ZodString>;
+    displayName: z.ZodNullable<z.ZodString>;
+    headline: z.ZodNullable<z.ZodString>;
+    image: z.ZodNullable<z.ZodString>;
+    imageAssetId: z.ZodNullable<z.ZodString>;
+    imageUrl: z.ZodNullable<z.ZodString>;
+    team: z.ZodBoolean;
+    roleName: z.ZodNullable<z.ZodString>;
+  }, z.core.$strict>>;
   lastReadMessageId: z.ZodNullable<z.ZodString>;
-  muted: z.ZodBoolean;
-  mutedUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+  subscription: z.ZodNullable<z.ZodObject<{
+    state: z.ZodEnum<{
+      following: "following";
+      muted: "muted";
+    }>;
+    mutedUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+  }, z.core.$strict>>;
   unread: z.ZodNumber;
   lastMessage: z.ZodNullable<z.ZodObject<{
     id: z.ZodString;
@@ -168,9 +185,26 @@ declare const ChatsPage: z.ZodObject<{
       updatedAt: z.ZodCoercedDate<unknown>;
     }, z.core.$strict>;
     participantIds: z.ZodArray<z.ZodString>;
+    participants: z.ZodArray<z.ZodObject<{
+      id: z.ZodString;
+      firstName: z.ZodNullable<z.ZodString>;
+      lastName: z.ZodNullable<z.ZodString>;
+      displayName: z.ZodNullable<z.ZodString>;
+      headline: z.ZodNullable<z.ZodString>;
+      image: z.ZodNullable<z.ZodString>;
+      imageAssetId: z.ZodNullable<z.ZodString>;
+      imageUrl: z.ZodNullable<z.ZodString>;
+      team: z.ZodBoolean;
+      roleName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
     lastReadMessageId: z.ZodNullable<z.ZodString>;
-    muted: z.ZodBoolean;
-    mutedUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    subscription: z.ZodNullable<z.ZodObject<{
+      state: z.ZodEnum<{
+        following: "following";
+        muted: "muted";
+      }>;
+      mutedUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    }, z.core.$strict>>;
     unread: z.ZodNumber;
     lastMessage: z.ZodNullable<z.ZodObject<{
       id: z.ZodString;
@@ -184,6 +218,172 @@ declare const ChatsPage: z.ZodObject<{
   page: z.ZodNumber;
   pageSize: z.ZodNumber;
 }, z.core.$strip>;
+declare const ChatListQuery: z.ZodObject<{
+  page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  requests: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodBoolean>>;
+}, z.core.$strict>;
+declare const ChatUnreadSummary: z.ZodObject<{
+  unread: z.ZodNumber;
+  requests: z.ZodNumber;
+}, z.core.$strict>;
+declare const ChatLiveEvent: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  type: z.ZodLiteral<"ready">;
+  heartbeatMs: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"message.created">;
+  chatId: z.ZodString;
+  message: z.ZodObject<{
+    orgId: z.ZodString;
+    id: z.ZodString;
+    communityId: z.ZodString;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+    orgUserId: z.ZodString;
+    chatId: z.ZodString;
+    body: z.ZodString;
+    replyToId: z.ZodNullable<z.ZodString>;
+    clientId: z.ZodNullable<z.ZodUUID>;
+    editedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    deletedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    sender: z.ZodObject<{
+      id: z.ZodString;
+      firstName: z.ZodNullable<z.ZodString>;
+      lastName: z.ZodNullable<z.ZodString>;
+      displayName: z.ZodNullable<z.ZodString>;
+      headline: z.ZodNullable<z.ZodString>;
+      image: z.ZodNullable<z.ZodString>;
+      imageAssetId: z.ZodNullable<z.ZodString>;
+      imageUrl: z.ZodNullable<z.ZodString>;
+      team: z.ZodBoolean;
+      roleName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    attachments: z.ZodArray<z.ZodObject<{
+      assetId: z.ZodString;
+      url: z.ZodString;
+    }, z.core.$strict>>;
+    reactions: z.ZodRecord<z.ZodString, z.ZodNumber>;
+    mentions: z.ZodArray<z.ZodObject<{
+      orgUserId: z.ZodString;
+      name: z.ZodString;
+    }, z.core.$strict>>;
+  }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"message.updated">;
+  chatId: z.ZodString;
+  message: z.ZodObject<{
+    orgId: z.ZodString;
+    id: z.ZodString;
+    communityId: z.ZodString;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+    orgUserId: z.ZodString;
+    chatId: z.ZodString;
+    body: z.ZodString;
+    replyToId: z.ZodNullable<z.ZodString>;
+    clientId: z.ZodNullable<z.ZodUUID>;
+    editedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    deletedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    sender: z.ZodObject<{
+      id: z.ZodString;
+      firstName: z.ZodNullable<z.ZodString>;
+      lastName: z.ZodNullable<z.ZodString>;
+      displayName: z.ZodNullable<z.ZodString>;
+      headline: z.ZodNullable<z.ZodString>;
+      image: z.ZodNullable<z.ZodString>;
+      imageAssetId: z.ZodNullable<z.ZodString>;
+      imageUrl: z.ZodNullable<z.ZodString>;
+      team: z.ZodBoolean;
+      roleName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    attachments: z.ZodArray<z.ZodObject<{
+      assetId: z.ZodString;
+      url: z.ZodString;
+    }, z.core.$strict>>;
+    reactions: z.ZodRecord<z.ZodString, z.ZodNumber>;
+    mentions: z.ZodArray<z.ZodObject<{
+      orgUserId: z.ZodString;
+      name: z.ZodString;
+    }, z.core.$strict>>;
+  }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"message.deleted">;
+  chatId: z.ZodString;
+  messageId: z.ZodString;
+  deletedAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"message.reactions">;
+  chatId: z.ZodString;
+  messageId: z.ZodString;
+  reactions: z.ZodRecord<z.ZodString, z.ZodNumber>;
+  orgUserId: z.ZodString;
+  reaction: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"chat.updated">;
+  chatId: z.ZodString;
+  chat: z.ZodObject<{
+    orgId: z.ZodString;
+    id: z.ZodString;
+    communityId: z.ZodString;
+    kind: z.ZodEnum<{
+      direct: "direct";
+      group: "group";
+    }>;
+    status: z.ZodEnum<{
+      pending: "pending";
+      open: "open";
+      closed: "closed";
+    }>;
+    createdBy: z.ZodNullable<z.ZodString>;
+    lockedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    lockedBy: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+  }, z.core.$strict>;
+  participants: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    firstName: z.ZodNullable<z.ZodString>;
+    lastName: z.ZodNullable<z.ZodString>;
+    displayName: z.ZodNullable<z.ZodString>;
+    headline: z.ZodNullable<z.ZodString>;
+    image: z.ZodNullable<z.ZodString>;
+    imageAssetId: z.ZodNullable<z.ZodString>;
+    imageUrl: z.ZodNullable<z.ZodString>;
+    team: z.ZodBoolean;
+    roleName: z.ZodNullable<z.ZodString>;
+  }, z.core.$strict>>;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"chat.removed">;
+  chatId: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"chat.state">;
+  chatId: z.ZodString;
+  unread: z.ZodNumber;
+  lastReadMessageId: z.ZodNullable<z.ZodString>;
+  subscription: z.ZodNullable<z.ZodObject<{
+    state: z.ZodEnum<{
+      following: "following";
+      muted: "muted";
+    }>;
+    mutedUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+  }, z.core.$strict>>;
+}, z.core.$strict>, z.ZodObject<{
+  unread: z.ZodNumber;
+  requests: z.ZodNumber;
+  type: z.ZodLiteral<"unread">;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"typing">;
+  chatId: z.ZodString;
+  orgUserId: z.ZodString;
+  until: z.ZodCoercedDate<unknown>;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"resync">;
+}, z.core.$strict>, z.ZodObject<{
+  type: z.ZodLiteral<"closed">;
+  reason: z.ZodEnum<{
+    shutdown: "shutdown";
+  }>;
+}, z.core.$strict>], "type">;
 declare const MessageQueueEntry: z.ZodObject<{
   message: z.ZodObject<{
     orgId: z.ZodString;
@@ -193,6 +393,7 @@ declare const MessageQueueEntry: z.ZodObject<{
     orgUserId: z.ZodString;
     body: z.ZodString;
     replyToId: z.ZodNullable<z.ZodString>;
+    clientId: z.ZodNullable<z.ZodUUID>;
     editedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
     deletedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
     createdAt: z.ZodCoercedDate<unknown>;
@@ -206,13 +407,8 @@ declare const MessageQueueEntry: z.ZodObject<{
       image: z.ZodNullable<z.ZodString>;
       imageAssetId: z.ZodNullable<z.ZodString>;
       imageUrl: z.ZodNullable<z.ZodString>;
-      role: z.ZodEnum<{
-        owner: "owner";
-        admin: "admin";
-        instructor: "instructor";
-        moderator: "moderator";
-        student: "student";
-      }>;
+      team: z.ZodBoolean;
+      roleName: z.ZodNullable<z.ZodString>;
     }, z.core.$strict>;
     attachments: z.ZodArray<z.ZodObject<{
       assetId: z.ZodString;
@@ -220,6 +416,10 @@ declare const MessageQueueEntry: z.ZodObject<{
     }, z.core.$strict>>;
     reactions: z.ZodRecord<z.ZodString, z.ZodNumber>;
     viewerReaction: z.ZodNullable<z.ZodString>;
+    mentions: z.ZodArray<z.ZodObject<{
+      orgUserId: z.ZodString;
+      name: z.ZodString;
+    }, z.core.$strict>>;
   }, z.core.$strict>;
   flags: z.ZodArray<z.ZodObject<{
     orgId: z.ZodString;
@@ -269,6 +469,7 @@ declare const MessageQueue: z.ZodObject<{
       orgUserId: z.ZodString;
       body: z.ZodString;
       replyToId: z.ZodNullable<z.ZodString>;
+      clientId: z.ZodNullable<z.ZodUUID>;
       editedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
       deletedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
       createdAt: z.ZodCoercedDate<unknown>;
@@ -282,13 +483,8 @@ declare const MessageQueue: z.ZodObject<{
         image: z.ZodNullable<z.ZodString>;
         imageAssetId: z.ZodNullable<z.ZodString>;
         imageUrl: z.ZodNullable<z.ZodString>;
-        role: z.ZodEnum<{
-          owner: "owner";
-          admin: "admin";
-          instructor: "instructor";
-          moderator: "moderator";
-          student: "student";
-        }>;
+        team: z.ZodBoolean;
+        roleName: z.ZodNullable<z.ZodString>;
       }, z.core.$strict>;
       attachments: z.ZodArray<z.ZodObject<{
         assetId: z.ZodString;
@@ -296,6 +492,10 @@ declare const MessageQueue: z.ZodObject<{
       }, z.core.$strict>>;
       reactions: z.ZodRecord<z.ZodString, z.ZodNumber>;
       viewerReaction: z.ZodNullable<z.ZodString>;
+      mentions: z.ZodArray<z.ZodObject<{
+        orgUserId: z.ZodString;
+        name: z.ZodString;
+      }, z.core.$strict>>;
     }, z.core.$strict>;
     flags: z.ZodArray<z.ZodObject<{
       orgId: z.ZodString;
@@ -350,6 +550,7 @@ declare const SendMessage: z.ZodObject<{
   body: z.ZodString;
   replyToId: z.ZodDefault<z.ZodNullable<z.ZodString>>;
   assetIds: z.ZodDefault<z.ZodArray<z.ZodString>>;
+  clientId: z.ZodOptional<z.ZodUUID>;
 }, z.core.$strict>;
 declare const EditMessage: z.ZodObject<{
   body: z.ZodString;
@@ -357,9 +558,6 @@ declare const EditMessage: z.ZodObject<{
 declare const MarkRead: z.ZodObject<{
   messageId: z.ZodString;
 }, z.core.$strict>;
-declare const MuteChat: z.ZodObject<{
-  until: z.ZodOptional<z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>>;
-}, z.core.$strict>;
 declare const OrgUserBody: z.ZodObject<{
   orgUserId: z.ZodString;
 }, z.core.$strict>;
@@ -381,6 +579,10 @@ declare const BlockParam: z.ZodObject<{
   communityId: z.ZodString;
   orgUserId: z.ZodString;
 }, z.core.$strip>;
+declare const DirectChatParam: z.ZodObject<{
+  communityId: z.ZodString;
+  orgUserId: z.ZodString;
+}, z.core.$strip>;
 //#endregion
-export { BlockParam, Chat, ChatIdParam, ChatListItem, ChatsPage, CommunityParam, EditMessage, MarkRead, MessageFlag, MessageIdParam, MessageQueue, MessageQueueEntry, MessageView, MessagesPage, MuteChat, OrgUserBody, ResolveMessageFlags, SendMessage, StartDirectChat, StartGroupChat };
+export { BlockParam, Chat, ChatIdParam, ChatListItem, ChatListQuery, ChatLiveEvent, ChatUnreadSummary, ChatsPage, CommunityParam, DirectChatParam, EditMessage, MarkRead, MessageFlag, MessageIdParam, MessageQueue, MessageQueueEntry, MessageView, MessagesPage, OrgUserBody, ResolveMessageFlags, SendMessage, StartDirectChat, StartGroupChat };
 //# sourceMappingURL=chats.d.ts.map

package/dist/http/schemas/chats.js

@@ -1,6 +1,6 @@
-import { DateTimeInput, paginated } from "./shared.js";
+import { PageQuery, paginated } from "./shared.js";
 import { z } from "zod";
-import { chatLastMessageSchema, chatSchema, idSchema, messageFlagResolutionSchema, messageFlagSchema, messageViewSchema } from "@headless-lms/core/schemas";
+import { chatLastMessageSchema, chatLiveEventSchema, chatSchema, chatUnreadSummarySchema, commentAuthorSchema, idSchema, messageFlagResolutionSchema, messageFlagSchema, messageViewSchema, subscriptionViewSchema } from "@headless-lms/core/schemas";
 //#region src/http/schemas/chats.ts
 const Chat = chatSchema;
 const MessageFlag = messageFlagSchema;
@@ -9,13 +9,16 @@ const MessagesPage = paginated(MessageView);
 const ChatListItem = z.object({
 	chat: Chat,
 	participantIds: z.array(z.string()),
+	participants: z.array(commentAuthorSchema).describe("The profiles of the people in `participantIds`"),
 	lastReadMessageId: z.string().nullable(),
-	muted: z.boolean(),
-	mutedUntil: z.coerce.date().nullable(),
+	subscription: subscriptionViewSchema.nullable().describe("Your mute on this chat while it applies; null when none"),
 	unread: z.number().int(),
 	lastMessage: chatLastMessageSchema.nullable()
 });
 const ChatsPage = paginated(ChatListItem);
+const ChatListQuery = PageQuery.extend({ requests: z.stringbool().optional().describe("`true` for only the pending message requests to you, `false` for everything else; omit for every chat") }).strict();
+const ChatUnreadSummary = chatUnreadSummarySchema;
+const ChatLiveEvent = chatLiveEventSchema;
 const MessageQueueEntry = z.object({
 	message: MessageView,
 	flags: z.array(MessageFlag),
@@ -38,11 +41,11 @@ const StartGroupChat = z.object({
 const SendMessage = z.object({
 	body: MessageBody,
 	replyToId: idSchema.nullable().default(null).describe("A message in the same chat this one answers"),
-	assetIds: Attachments
+	assetIds: Attachments,
+	clientId: z.uuid().optional().describe("Your id for this send. Sending again with the same id returns the message already sent.")
 }).strict();
 const EditMessage = z.object({ body: MessageBody }).strict();
 const MarkRead = z.object({ messageId: idSchema.describe("The newest message you have read in this chat") }).strict();
-const MuteChat = z.object({ until: DateTimeInput.optional().describe("When the mute ends. Omit to mute until you unmute") }).strict();
 const OrgUserBody = z.object({ orgUserId: idSchema }).strict();
 const ResolveMessageFlags = z.object({ resolution: messageFlagResolutionSchema.extract(["dismissed"]).describe("`dismissed` closes the open flags and leaves the message up. Deleting the message or locking the chat resolves its flags as `deleted` or `locked` instead.") }).strict();
 const ChatIdParam = z.object({ chatId: z.string() });
@@ -52,7 +55,11 @@ const BlockParam = z.object({
 	communityId: z.string(),
 	orgUserId: z.string()
 });
+const DirectChatParam = z.object({
+	communityId: z.string(),
+	orgUserId: z.string()
+});
 //#endregion
-export { BlockParam, Chat, ChatIdParam, ChatListItem, ChatsPage, CommunityParam, EditMessage, MarkRead, MessageFlag, MessageIdParam, MessageQueue, MessageQueueEntry, MessageView, MessagesPage, MuteChat, OrgUserBody, ResolveMessageFlags, SendMessage, StartDirectChat, StartGroupChat };
+export { BlockParam, Chat, ChatIdParam, ChatListItem, ChatListQuery, ChatLiveEvent, ChatUnreadSummary, ChatsPage, CommunityParam, DirectChatParam, EditMessage, MarkRead, MessageFlag, MessageIdParam, MessageQueue, MessageQueueEntry, MessageView, MessagesPage, OrgUserBody, ResolveMessageFlags, SendMessage, StartDirectChat, StartGroupChat };
 
 //# sourceMappingURL=chats.js.map