npm - @headless-lms/server - Versions diffs - 0.2.0 → 0.4.0 - Mend

@headless-lms/server 0.2.0 → 0.4.0

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.

Files changed (351) hide show

package/dist/http/schemas/notifications.d.ts ADDED Viewed

@@ -0,0 +1,550 @@
+import { z } from "zod";
+//#region src/http/schemas/notifications.d.ts
+declare const NotificationIdParam: z.ZodObject<{
+  notificationId: z.ZodString;
+}, z.core.$strip>;
+declare const NotificationFilterQuery: z.ZodObject<{
+  scope: z.ZodOptional<z.ZodEnum<{
+    org: "org";
+    community: "community";
+  }>>;
+  communityId: z.ZodOptional<z.ZodString>;
+  includeOrg: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodBoolean>>;
+  category: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>, z.ZodArray<z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>>>;
+  reason: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>, z.ZodArray<z.ZodType<"moderator" | "subject" | "post_author" | "comment_author" | "message_author" | "follower" | "thread_participant" | "mentioned" | "participant" | "space_member" | "community_member" | "course_member" | "staff", string, z.core.$ZodTypeInternals<"moderator" | "subject" | "post_author" | "comment_author" | "message_author" | "follower" | "thread_participant" | "mentioned" | "participant" | "space_member" | "community_member" | "course_member" | "staff", string>>>>>;
+  type: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>, z.ZodArray<z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>>>;
+  unread: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodBoolean>>;
+}, z.core.$strict>;
+declare const NotificationListQuery: z.ZodObject<{
+  page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+  scope: z.ZodOptional<z.ZodEnum<{
+    org: "org";
+    community: "community";
+  }>>;
+  communityId: z.ZodOptional<z.ZodString>;
+  includeOrg: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodBoolean>>;
+  category: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>, z.ZodArray<z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>>>;
+  reason: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>, z.ZodArray<z.ZodType<"moderator" | "subject" | "post_author" | "comment_author" | "message_author" | "follower" | "thread_participant" | "mentioned" | "participant" | "space_member" | "community_member" | "course_member" | "staff", string, z.core.$ZodTypeInternals<"moderator" | "subject" | "post_author" | "comment_author" | "message_author" | "follower" | "thread_participant" | "mentioned" | "participant" | "space_member" | "community_member" | "course_member" | "staff", string>>>>>;
+  type: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>, z.ZodArray<z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>>>;
+  unread: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodBoolean>>;
+}, z.core.$strict>;
+declare const NotificationView: z.ZodObject<{
+  id: z.ZodString;
+  type: z.ZodString;
+  scope: z.ZodEnum<{
+    org: "org";
+    community: "community";
+    space: "space";
+    chat: "chat";
+  }>;
+  reasons: z.ZodArray<z.ZodEnum<{
+    moderator: "moderator";
+    subject: "subject";
+    post_author: "post_author";
+    comment_author: "comment_author";
+    message_author: "message_author";
+    follower: "follower";
+    thread_participant: "thread_participant";
+    mentioned: "mentioned";
+    participant: "participant";
+    space_member: "space_member";
+    community_member: "community_member";
+    course_member: "course_member";
+    staff: "staff";
+  }>>;
+  matchedReason: z.ZodEnum<{
+    moderator: "moderator";
+    subject: "subject";
+    post_author: "post_author";
+    comment_author: "comment_author";
+    message_author: "message_author";
+    follower: "follower";
+    thread_participant: "thread_participant";
+    mentioned: "mentioned";
+    participant: "participant";
+    space_member: "space_member";
+    community_member: "community_member";
+    course_member: "course_member";
+    staff: "staff";
+  }>;
+  category: z.ZodString;
+  display: z.ZodRecord<z.ZodString, z.ZodType<import("@headless-lms/core/types").JsonValue, unknown, z.core.$ZodTypeInternals<import("@headless-lms/core/types").JsonValue, unknown>>>;
+  community: z.ZodNullable<z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+  }, z.core.$strip>>;
+  space: z.ZodNullable<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+  }, z.core.$strip>>;
+  actor: z.ZodNullable<z.ZodObject<{
+    orgUserId: z.ZodString;
+    name: z.ZodNullable<z.ZodString>;
+    imageUrl: z.ZodNullable<z.ZodString>;
+  }, z.core.$strip>>;
+  subject: z.ZodNullable<z.ZodObject<{
+    type: z.ZodEnum<{
+      message: "message";
+      community: "community";
+      space: "space";
+      chat: "chat";
+      post: "post";
+      comment: "comment";
+      course: "course";
+      download: "download";
+      bundle: "bundle";
+      activity: "activity";
+    }>;
+    id: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    excerpt: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  parent: z.ZodNullable<z.ZodObject<{
+    type: z.ZodEnum<{
+      message: "message";
+      community: "community";
+      space: "space";
+      chat: "chat";
+      post: "post";
+      comment: "comment";
+      course: "course";
+      download: "download";
+      bundle: "bundle";
+      activity: "activity";
+    }>;
+    id: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    excerpt: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  createdAt: z.ZodCoercedDate<unknown>;
+  readAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+}, z.core.$strip>;
+declare const NotificationsPage: z.ZodObject<{
+  rows: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodString;
+    scope: z.ZodEnum<{
+      org: "org";
+      community: "community";
+      space: "space";
+      chat: "chat";
+    }>;
+    reasons: z.ZodArray<z.ZodEnum<{
+      moderator: "moderator";
+      subject: "subject";
+      post_author: "post_author";
+      comment_author: "comment_author";
+      message_author: "message_author";
+      follower: "follower";
+      thread_participant: "thread_participant";
+      mentioned: "mentioned";
+      participant: "participant";
+      space_member: "space_member";
+      community_member: "community_member";
+      course_member: "course_member";
+      staff: "staff";
+    }>>;
+    matchedReason: z.ZodEnum<{
+      moderator: "moderator";
+      subject: "subject";
+      post_author: "post_author";
+      comment_author: "comment_author";
+      message_author: "message_author";
+      follower: "follower";
+      thread_participant: "thread_participant";
+      mentioned: "mentioned";
+      participant: "participant";
+      space_member: "space_member";
+      community_member: "community_member";
+      course_member: "course_member";
+      staff: "staff";
+    }>;
+    category: z.ZodString;
+    display: z.ZodRecord<z.ZodString, z.ZodType<import("@headless-lms/core/types").JsonValue, unknown, z.core.$ZodTypeInternals<import("@headless-lms/core/types").JsonValue, unknown>>>;
+    community: z.ZodNullable<z.ZodObject<{
+      id: z.ZodString;
+      title: z.ZodString;
+    }, z.core.$strip>>;
+    space: z.ZodNullable<z.ZodObject<{
+      id: z.ZodString;
+      name: z.ZodString;
+    }, z.core.$strip>>;
+    actor: z.ZodNullable<z.ZodObject<{
+      orgUserId: z.ZodString;
+      name: z.ZodNullable<z.ZodString>;
+      imageUrl: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+    subject: z.ZodNullable<z.ZodObject<{
+      type: z.ZodEnum<{
+        message: "message";
+        community: "community";
+        space: "space";
+        chat: "chat";
+        post: "post";
+        comment: "comment";
+        course: "course";
+        download: "download";
+        bundle: "bundle";
+        activity: "activity";
+      }>;
+      id: z.ZodString;
+      title: z.ZodOptional<z.ZodString>;
+      excerpt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    parent: z.ZodNullable<z.ZodObject<{
+      type: z.ZodEnum<{
+        message: "message";
+        community: "community";
+        space: "space";
+        chat: "chat";
+        post: "post";
+        comment: "comment";
+        course: "course";
+        download: "download";
+        bundle: "bundle";
+        activity: "activity";
+      }>;
+      id: z.ZodString;
+      title: z.ZodOptional<z.ZodString>;
+      excerpt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    createdAt: z.ZodCoercedDate<unknown>;
+    readAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+  }, z.core.$strip>>;
+  total: z.ZodNumber;
+  page: z.ZodNumber;
+  pageSize: z.ZodNumber;
+  unreadCount: z.ZodNumber;
+}, z.core.$strip>;
+declare const NotificationUnreadCounts: z.ZodObject<{
+  org: z.ZodNumber;
+  communities: z.ZodArray<z.ZodObject<{
+    communityId: z.ZodString;
+    unread: z.ZodNumber;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const NotificationCategory: z.ZodObject<{
+  key: z.ZodString;
+  covers: z.ZodArray<z.ZodObject<{
+    type: z.ZodString;
+    reasons: z.ZodArray<z.ZodEnum<{
+      moderator: "moderator";
+      subject: "subject";
+      post_author: "post_author";
+      comment_author: "comment_author";
+      message_author: "message_author";
+      follower: "follower";
+      thread_participant: "thread_participant";
+      mentioned: "mentioned";
+      participant: "participant";
+      space_member: "space_member";
+      community_member: "community_member";
+      course_member: "course_member";
+      staff: "staff";
+    }>>;
+  }, z.core.$strict>>;
+  channels: z.ZodRecord<z.ZodString, z.ZodObject<{
+    default: z.ZodBoolean;
+    locked: z.ZodBoolean;
+  }, z.core.$strict>>;
+  perSpace: z.ZodOptional<z.ZodBoolean>;
+  spaceDefaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodBoolean>>>;
+}, z.core.$strict>;
+declare const NotificationCategoryList: z.ZodObject<{
+  categories: z.ZodArray<z.ZodObject<{
+    key: z.ZodString;
+    covers: z.ZodArray<z.ZodObject<{
+      type: z.ZodString;
+      reasons: z.ZodArray<z.ZodEnum<{
+        moderator: "moderator";
+        subject: "subject";
+        post_author: "post_author";
+        comment_author: "comment_author";
+        message_author: "message_author";
+        follower: "follower";
+        thread_participant: "thread_participant";
+        mentioned: "mentioned";
+        participant: "participant";
+        space_member: "space_member";
+        community_member: "community_member";
+        course_member: "course_member";
+        staff: "staff";
+      }>>;
+    }, z.core.$strict>>;
+    channels: z.ZodRecord<z.ZodString, z.ZodObject<{
+      default: z.ZodBoolean;
+      locked: z.ZodBoolean;
+    }, z.core.$strict>>;
+    perSpace: z.ZodOptional<z.ZodBoolean>;
+    spaceDefaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodBoolean>>>;
+  }, z.core.$strict>>;
+  source: z.ZodEnum<{
+    default: "default";
+    stored: "stored";
+  }>;
+}, z.core.$strip>;
+declare const ReplaceNotificationCategories: z.ZodObject<{
+  categories: z.ZodArray<z.ZodObject<{
+    key: z.ZodString;
+    covers: z.ZodArray<z.ZodObject<{
+      type: z.ZodString;
+      reasons: z.ZodArray<z.ZodEnum<{
+        moderator: "moderator";
+        subject: "subject";
+        post_author: "post_author";
+        comment_author: "comment_author";
+        message_author: "message_author";
+        follower: "follower";
+        thread_participant: "thread_participant";
+        mentioned: "mentioned";
+        participant: "participant";
+        space_member: "space_member";
+        community_member: "community_member";
+        course_member: "course_member";
+        staff: "staff";
+      }>>;
+    }, z.core.$strict>>;
+    channels: z.ZodRecord<z.ZodString, z.ZodObject<{
+      default: z.ZodBoolean;
+      locked: z.ZodBoolean;
+    }, z.core.$strict>>;
+    perSpace: z.ZodOptional<z.ZodBoolean>;
+    spaceDefaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodBoolean>>>;
+  }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const NotificationCategoryDefaults: z.ZodObject<{
+  categories: z.ZodArray<z.ZodObject<{
+    key: z.ZodString;
+    covers: z.ZodArray<z.ZodObject<{
+      type: z.ZodString;
+      reasons: z.ZodArray<z.ZodEnum<{
+        moderator: "moderator";
+        subject: "subject";
+        post_author: "post_author";
+        comment_author: "comment_author";
+        message_author: "message_author";
+        follower: "follower";
+        thread_participant: "thread_participant";
+        mentioned: "mentioned";
+        participant: "participant";
+        space_member: "space_member";
+        community_member: "community_member";
+        course_member: "course_member";
+        staff: "staff";
+      }>>;
+    }, z.core.$strict>>;
+    channels: z.ZodRecord<z.ZodString, z.ZodObject<{
+      default: z.ZodBoolean;
+      locked: z.ZodBoolean;
+    }, z.core.$strict>>;
+    perSpace: z.ZodOptional<z.ZodBoolean>;
+    spaceDefaults: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodBoolean>>>;
+  }, z.core.$strict>>;
+}, z.core.$strip>;
+declare const NotificationListScopeQuery: z.ZodObject<{
+  scope: z.ZodEnum<{
+    org: "org";
+    community: "community";
+  }>;
+}, z.core.$strict>;
+declare const NotificationTypeInfo: z.ZodObject<{
+  type: z.ZodString;
+  scopes: z.ZodArray<z.ZodEnum<{
+    org: "org";
+    community: "community";
+    space: "space";
+    chat: "chat";
+  }>>;
+  reasons: z.ZodArray<z.ZodEnum<{
+    moderator: "moderator";
+    subject: "subject";
+    post_author: "post_author";
+    comment_author: "comment_author";
+    message_author: "message_author";
+    follower: "follower";
+    thread_participant: "thread_participant";
+    mentioned: "mentioned";
+    participant: "participant";
+    space_member: "space_member";
+    community_member: "community_member";
+    course_member: "course_member";
+    staff: "staff";
+  }>>;
+}, z.core.$strip>;
+declare const NotificationTypeInfos: z.ZodArray<z.ZodObject<{
+  type: z.ZodString;
+  scopes: z.ZodArray<z.ZodEnum<{
+    org: "org";
+    community: "community";
+    space: "space";
+    chat: "chat";
+  }>>;
+  reasons: z.ZodArray<z.ZodEnum<{
+    moderator: "moderator";
+    subject: "subject";
+    post_author: "post_author";
+    comment_author: "comment_author";
+    message_author: "message_author";
+    follower: "follower";
+    thread_participant: "thread_participant";
+    mentioned: "mentioned";
+    participant: "participant";
+    space_member: "space_member";
+    community_member: "community_member";
+    course_member: "course_member";
+    staff: "staff";
+  }>>;
+}, z.core.$strip>>;
+declare const NotificationChannelInfos: z.ZodArray<z.ZodObject<{
+  channel: z.ZodString;
+}, z.core.$strip>>;
+declare const CommunityNotificationSettings: z.ZodObject<{
+  communityId: z.ZodString;
+  digest: z.ZodNullable<z.ZodObject<{
+    cadence: z.ZodEnum<{
+      daily: "daily";
+      weekly: "weekly";
+    }>;
+    weekday: z.ZodNumber;
+    hour: z.ZodNumber;
+    timeZone: z.ZodString;
+  }, z.core.$strict>>;
+  categories: z.ZodArray<z.ZodObject<{
+    key: z.ZodString;
+    perSpace: z.ZodBoolean;
+    channels: z.ZodArray<z.ZodObject<{
+      channel: z.ZodString;
+      enabled: z.ZodBoolean;
+      default: z.ZodBoolean;
+      source: z.ZodEnum<{
+        default: "default";
+        community: "community";
+        space: "space";
+        locked: "locked";
+        spaceDefault: "spaceDefault";
+      }>;
+      locked: z.ZodBoolean;
+    }, z.core.$strip>>;
+    spaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
+      spaceId: z.ZodString;
+      name: z.ZodString;
+      channels: z.ZodArray<z.ZodObject<{
+        channel: z.ZodString;
+        enabled: z.ZodBoolean;
+        default: z.ZodBoolean;
+        source: z.ZodEnum<{
+          default: "default";
+          community: "community";
+          space: "space";
+          locked: "locked";
+          spaceDefault: "spaceDefault";
+        }>;
+        locked: z.ZodBoolean;
+      }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const OrgNotificationSettings: z.ZodObject<{
+  categories: z.ZodArray<z.ZodObject<{
+    key: z.ZodString;
+    perSpace: z.ZodBoolean;
+    channels: z.ZodArray<z.ZodObject<{
+      channel: z.ZodString;
+      enabled: z.ZodBoolean;
+      default: z.ZodBoolean;
+      source: z.ZodEnum<{
+        default: "default";
+        community: "community";
+        space: "space";
+        locked: "locked";
+        spaceDefault: "spaceDefault";
+      }>;
+      locked: z.ZodBoolean;
+    }, z.core.$strip>>;
+    spaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
+      spaceId: z.ZodString;
+      name: z.ZodString;
+      channels: z.ZodArray<z.ZodObject<{
+        channel: z.ZodString;
+        enabled: z.ZodBoolean;
+        default: z.ZodBoolean;
+        source: z.ZodEnum<{
+          default: "default";
+          community: "community";
+          space: "space";
+          locked: "locked";
+          spaceDefault: "spaceDefault";
+        }>;
+        locked: z.ZodBoolean;
+      }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const PatchNotificationSettings: z.ZodObject<{
+  settings: z.ZodArray<z.ZodObject<{
+    category: z.ZodString;
+    spaceId: z.ZodOptional<z.ZodString>;
+    channel: z.ZodString;
+    enabled: z.ZodNullable<z.ZodBoolean>;
+  }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const Device: z.ZodObject<{
+  id: z.ZodString;
+  provider: z.ZodEnum<{
+    apns: "apns";
+    fcm: "fcm";
+    webpush: "webpush";
+  }>;
+  token: z.ZodString;
+  p256dh: z.ZodNullable<z.ZodString>;
+  auth: z.ZodNullable<z.ZodString>;
+  appId: z.ZodNullable<z.ZodString>;
+  environment: z.ZodNullable<z.ZodEnum<{
+    production: "production";
+    sandbox: "sandbox";
+  }>>;
+}, z.core.$strip>;
+declare const DeviceList: z.ZodArray<z.ZodObject<{
+  lastSeenAt: z.ZodCoercedDate<unknown>;
+  id: z.ZodString;
+  provider: z.ZodEnum<{
+    apns: "apns";
+    fcm: "fcm";
+    webpush: "webpush";
+  }>;
+  token: z.ZodString;
+  p256dh: z.ZodNullable<z.ZodString>;
+  auth: z.ZodNullable<z.ZodString>;
+  appId: z.ZodNullable<z.ZodString>;
+  environment: z.ZodNullable<z.ZodEnum<{
+    production: "production";
+    sandbox: "sandbox";
+  }>>;
+}, z.core.$strip>>;
+declare const DeviceIdParam: z.ZodObject<{
+  deviceId: z.ZodString;
+}, z.core.$strip>;
+declare const RegisterDevice: z.ZodObject<{
+  provider: z.ZodEnum<{
+    apns: "apns";
+    fcm: "fcm";
+    webpush: "webpush";
+  }>;
+  token: z.ZodString;
+  keys: z.ZodOptional<z.ZodObject<{
+    p256dh: z.ZodString;
+    auth: z.ZodString;
+  }, z.core.$strict>>;
+  appId: z.ZodOptional<z.ZodString>;
+  environment: z.ZodOptional<z.ZodEnum<{
+    production: "production";
+    sandbox: "sandbox";
+  }>>;
+}, z.core.$strict>;
+declare const PushConfigView: z.ZodObject<{
+  vapidPublicKey: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+//#endregion
+export { CommunityNotificationSettings, Device, DeviceIdParam, DeviceList, NotificationCategory, NotificationCategoryDefaults, NotificationCategoryList, NotificationChannelInfos, NotificationFilterQuery, NotificationIdParam, NotificationListQuery, NotificationListScopeQuery, NotificationTypeInfo, NotificationTypeInfos, NotificationUnreadCounts, NotificationView, NotificationsPage, OrgNotificationSettings, PatchNotificationSettings, PushConfigView, RegisterDevice, ReplaceNotificationCategories };
+//# sourceMappingURL=notifications.d.ts.map