@sublay/js 5.0.0 → 7.0.1

package/dist/interfaces/AppNotification.d.ts

@@ -0,0 +1,258 @@
+type AppNotificationType = "system" | "entity-comment" | "comment-reply" | "entity-mention" | "comment-mention" | "entity-upvote" | "comment-upvote" | "entity-reaction" | "comment-reaction" | "entity-reaction-milestone-specific" | "entity-reaction-milestone-total" | "comment-reaction-milestone-specific" | "comment-reaction-milestone-total" | "new-follow" | "connection-request" | "connection-accepted" | "space-membership-approved";
+interface BaseAppNotification {
+    id: string;
+    userId: string;
+    type: AppNotificationType;
+    isRead: boolean;
+    metadata: Record<string, any>;
+    createdAt: string;
+}
+export interface SystemNotification extends BaseAppNotification {
+    type: "system";
+    action: string;
+    metadata: {
+        title?: string;
+        content?: string;
+        buttonData: {
+            text: string;
+            url: string;
+        } | null;
+    };
+}
+export interface EntityCommentNotification extends BaseAppNotification {
+    type: "entity-comment";
+    action: "open-comment";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        commentId: string;
+        commentContent: string | null | undefined;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export interface CommentReplyNotification extends BaseAppNotification {
+    type: "comment-reply";
+    action: "open-comment";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        commentId: string;
+        commentContent: string | null | undefined;
+        replyId: string;
+        replyContent: string | null | undefined;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export interface EntityMentionNotification extends BaseAppNotification {
+    type: "entity-mention";
+    action: "open-entity";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export interface CommentMentionNotification extends BaseAppNotification {
+    type: "comment-mention";
+    action: "open-comment";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        commentId: string;
+        commentContent: string | null | undefined;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export interface EntityUpvoteNotification extends BaseAppNotification {
+    type: "entity-upvote";
+    action: "open-entity";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export interface CommentUpvoteNotification extends BaseAppNotification {
+    type: "comment-upvote";
+    action: "open-comment";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        commentId: string;
+        commentContent: string | null | undefined;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export interface EntityReactionNotification extends BaseAppNotification {
+    type: "entity-reaction";
+    action: "open-entity";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        reactionType: string;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export interface CommentReactionNotification extends BaseAppNotification {
+    type: "comment-reaction";
+    action: "open-comment";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        commentId: string;
+        commentContent: string | null | undefined;
+        reactionType: string;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+interface MilestoneUser {
+    id: string;
+    name: string | null | undefined;
+    username: string | null | undefined;
+    avatar: string | null | undefined;
+}
+export interface EntityReactionMilestoneSpecificNotification extends BaseAppNotification {
+    type: "entity-reaction-milestone-specific";
+    action: "open-entity";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        reactionType: string;
+        milestoneCount: number;
+        lastThreeUsers: MilestoneUser[];
+    };
+}
+export interface EntityReactionMilestoneTotalNotification extends BaseAppNotification {
+    type: "entity-reaction-milestone-total";
+    action: "open-entity";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        milestoneCount: number;
+        reactionCounts: Record<string, number>;
+        lastThreeUsers: MilestoneUser[];
+    };
+}
+export interface CommentReactionMilestoneSpecificNotification extends BaseAppNotification {
+    type: "comment-reaction-milestone-specific";
+    action: "open-comment";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        commentId: string;
+        commentContent: string | null | undefined;
+        reactionType: string;
+        milestoneCount: number;
+        lastThreeUsers: MilestoneUser[];
+    };
+}
+export interface CommentReactionMilestoneTotalNotification extends BaseAppNotification {
+    type: "comment-reaction-milestone-total";
+    action: "open-comment";
+    metadata: {
+        entityId: string;
+        entityShortId: string;
+        entityTitle: string | null | undefined;
+        entityContent: string | null | undefined;
+        commentId: string;
+        commentContent: string | null | undefined;
+        milestoneCount: number;
+        reactionCounts: Record<string, number>;
+        lastThreeUsers: MilestoneUser[];
+    };
+}
+export interface SpaceMembershipApprovedNotification extends BaseAppNotification {
+    type: "space-membership-approved";
+    action: "open-space";
+    metadata: {
+        spaceId: string;
+        spaceName: string;
+        spaceShortId: string;
+        spaceSlug: string | null | undefined;
+        spaceAvatar: string | null | undefined;
+    };
+}
+export interface NewFollowNotification extends BaseAppNotification {
+    type: "new-follow";
+    action: "open-profile";
+    metadata: {
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export interface ConnectionRequestNotification extends BaseAppNotification {
+    type: "connection-request";
+    action: "open-profile";
+    metadata: {
+        connectionId: string;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export interface ConnectionAcceptedNotification extends BaseAppNotification {
+    type: "connection-accepted";
+    action: "open-profile";
+    metadata: {
+        connectionId: string;
+        initiatorId: string;
+        initiatorName: string | null | undefined;
+        initiatorUsername: string | null | undefined;
+        initiatorAvatar: string | null | undefined;
+    };
+}
+export type UnifiedAppNotification = SystemNotification | EntityCommentNotification | CommentReplyNotification | EntityMentionNotification | CommentMentionNotification | EntityUpvoteNotification | CommentUpvoteNotification | EntityReactionNotification | CommentReactionNotification | EntityReactionMilestoneSpecificNotification | EntityReactionMilestoneTotalNotification | CommentReactionMilestoneSpecificNotification | CommentReactionMilestoneTotalNotification | NewFollowNotification | ConnectionRequestNotification | ConnectionAcceptedNotification | SpaceMembershipApprovedNotification;
+export type PotentiallyPopulatedUnifiedAppNotification = UnifiedAppNotification & {
+    title?: string;
+    content?: string;
+};
+export {};

package/dist/interfaces/ChatMessage.d.ts

@@ -0,0 +1,32 @@
+import { GifData } from "./Comment";
+import { File } from "./File";
+import { Mention } from "./Mention";
+import { User } from "./User";
+export interface ChatMessage {
+    id: string;
+    projectId: string;
+    conversationId: string;
+    userId: string | null;
+    content: string | null;
+    gif: GifData | null;
+    mentions: Mention[];
+    files?: File[];
+    metadata: Record<string, any>;
+    parentMessageId: string | null;
+    quotedMessageId: string | null;
+    threadReplyCount: number;
+    reactionCounts: Record<string, number>;
+    userReactions: string[];
+    editedAt: string | null;
+    userDeletedAt: string | null;
+    moderationStatus: "approved" | "removed" | null;
+    moderatedAt: string | null;
+    moderatedById: string | null;
+    moderatedByType: "client" | "user" | null;
+    moderationReason: string | null;
+    createdAt: string;
+    updatedAt: string;
+    user: User | null;
+    quotedMessage?: ChatMessage | null;
+    parentMessage?: ChatMessage | null;
+}

package/dist/interfaces/Collection.d.ts

@@ -0,0 +1,10 @@
+export interface Collection {
+    id: string;
+    projectId: string;
+    userId: string;
+    parentId: string | null;
+    name: string;
+    entityCount: number;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/interfaces/Comment.d.ts

@@ -0,0 +1,42 @@
+import { Entity } from "./Entity";
+import { Mention } from "./Mention";
+import { User } from "./User";
+import { ReactionCounts, ReactionType } from "./Reaction";
+export interface GifData {
+    id: string;
+    url: string;
+    gifUrl: string;
+    gifPreviewUrl: string;
+    altText: string;
+    aspectRatio: string;
+}
+export interface Comment {
+    id: string;
+    projectId: string;
+    foreignId: string | null;
+    entityId: string;
+    entity?: Entity;
+    userId: string;
+    user?: User;
+    parentId: string | null;
+    parentComment?: Comment;
+    content: string | null;
+    gif: GifData | null;
+    mentions: Mention[];
+    upvotes: string[];
+    downvotes: string[];
+    reactionCounts: ReactionCounts;
+    userReaction?: ReactionType | null;
+    repliesCount: number;
+    metadata: Record<string, any>;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    parentDeletedAt: string | null;
+    userDeletedAt: string | null;
+    moderationStatus: "approved" | "removed" | null;
+    moderatedAt: string | null;
+    moderatedById: string | null;
+    moderatedByType: "client" | "user" | null;
+    moderationReason: string | null;
+}

package/dist/interfaces/Connection.d.ts

@@ -0,0 +1,67 @@
+import { User } from "./User";
+export interface Connection {
+    id: string;
+    message?: string;
+    createdAt: string;
+}
+/** Returned by `POST /users/:userId/connection` (requestConnection). */
+export interface ConnectionRequestResponse {
+    id: string;
+    status: string;
+    createdAt: string;
+}
+export interface EstablishedConnection {
+    id: string;
+    connectedUser: User;
+    connectedAt: string;
+}
+export interface PendingConnection extends Connection {
+    user: User;
+    type: "received" | "sent";
+}
+export interface ConnectionRequestParams {
+    userId: string;
+    message?: string;
+}
+export interface ConnectionActionResponse {
+    id: string;
+    status: string;
+    createdAt?: string;
+    respondedAt?: string;
+}
+export interface ConnectionWithdrawResponse {
+    message: string;
+}
+export interface ConnectionCountResponse {
+    count: number;
+}
+export interface RemoveConnectionByUserIdResponse {
+    id?: string;
+    status?: string;
+    respondedAt?: string;
+    message?: string;
+    action?: "withdraw" | "disconnect" | "decline";
+}
+export interface ConnectionStatusNone {
+    status: "none";
+}
+export interface ConnectionStatusPending {
+    status: "pending";
+    type: "sent" | "received";
+    connectionId: string;
+    createdAt: string;
+}
+export interface ConnectionStatusConnected {
+    status: "connected";
+    connectionId: string;
+    connectedAt: string;
+    requestedAt: string;
+}
+export interface ConnectionStatusDeclined {
+    status: "declined";
+    type: "sent" | "received";
+    connectionId: string;
+    respondedAt: string;
+}
+export type ConnectionStatusResponse = ConnectionStatusNone | ConnectionStatusPending | ConnectionStatusConnected | ConnectionStatusDeclined;
+export type ConnectionStatus = "none" | "pending-sent" | "pending-received" | "connected" | "declined-sent" | "declined-received";

package/dist/interfaces/Conversation.d.ts

@@ -0,0 +1,25 @@
+import { File } from "./File";
+import { ChatMessage } from "./ChatMessage";
+import { ConversationMember } from "./ConversationMember";
+export interface Conversation {
+    id: string;
+    projectId: string;
+    type: "direct" | "group" | "space";
+    name: string | null;
+    description: string | null;
+    spaceId: string | null;
+    createdById: string | null;
+    avatarFileId: string | null;
+    lastMessageAt: string | null;
+    postingPermission: "members" | "admins" | null;
+    metadata: Record<string, any>;
+    createdAt: string;
+    updatedAt: string;
+    memberCount?: number;
+    currentMember?: ConversationMember;
+    avatarFile?: File;
+}
+export interface ConversationPreview extends Conversation {
+    unreadCount: number;
+    lastMessage: ChatMessage | null;
+}

package/dist/interfaces/ConversationMember.d.ts

@@ -0,0 +1,16 @@
+import { User } from "./User";
+export type ConversationMemberRole = "admin" | "member";
+export interface ConversationMember {
+    id: string;
+    projectId: string;
+    conversationId: string;
+    userId: string;
+    role: ConversationMemberRole | null;
+    lastReadAt: string | null;
+    mutedUntil: string | null;
+    isActive: boolean;
+    leftAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    user?: User;
+}

package/dist/interfaces/Entity.d.ts

@@ -0,0 +1,53 @@
+import { Mention } from "./Mention";
+import { User } from "./User";
+import { Space } from "./Space";
+import { ReactionCounts, ReactionType } from "./Reaction";
+import { File } from "./File";
+export interface TopComment {
+    id: string;
+    user: User;
+    upvotesCount: number;
+    content: string;
+    createdAt: string;
+}
+export interface Entity {
+    id: string;
+    foreignId: string | null;
+    shortId: string;
+    projectId: string;
+    sourceId: string | null;
+    spaceId: string | null;
+    space?: Space | null;
+    userId: string | null;
+    user?: User | null;
+    title: string | null;
+    content: string | null;
+    mentions: Mention[];
+    attachments: Record<string, any>[];
+    files?: File[];
+    keywords: string[];
+    upvotes: string[];
+    downvotes: string[];
+    reactionCounts: ReactionCounts;
+    userReaction?: ReactionType | null;
+    repliesCount: number;
+    views: number;
+    score: number;
+    scoreUpdatedAt: string;
+    location: {
+        type: "Point";
+        coordinates: [number, number];
+    } | null;
+    metadata: Record<string, any>;
+    topComment: TopComment | null;
+    isSaved?: boolean;
+    isDraft: boolean | null;
+    moderationStatus: "approved" | "removed" | null;
+    moderatedAt: string | null;
+    moderatedById: string | null;
+    moderatedByType: "client" | "user" | null;
+    moderationReason: string | null;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+}

package/dist/interfaces/File.d.ts

@@ -0,0 +1,39 @@
+export interface FileImageVariant {
+    path: string;
+    publicPath: string;
+    width: number;
+    height: number;
+    size: number;
+    format: string;
+}
+export interface FileImage {
+    fileId: string;
+    originalWidth: number;
+    originalHeight: number;
+    variants: Record<string, FileImageVariant>;
+    processingStatus: "completed" | "failed";
+    processingError: string | null;
+    format: string;
+    quality: number;
+    exifStripped: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface File {
+    id: string;
+    projectId: string;
+    userId: string | null;
+    entityId: string | null;
+    commentId: string | null;
+    chatMessageId: string | null;
+    spaceId: string | null;
+    type: "image" | "video" | "document" | "other";
+    originalPath: string;
+    originalSize: number;
+    originalMimeType: string;
+    position: number;
+    metadata: Record<string, any>;
+    image?: FileImage;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/interfaces/Follow.d.ts

@@ -0,0 +1,19 @@
+import { User } from "./User";
+export interface Follow {
+    id: string;
+    projectId: string;
+    followerId: string;
+    followedId: string;
+    createdAt: string;
+}
+/**
+ * An entry in a follower/following list. The list endpoints
+ * (`/follows/(followers|following)` and `/users/:userId/(followers|following)`)
+ * return the follow id, the populated other user, and when the follow happened
+ * — NOT the raw {@link Follow} row.
+ */
+export interface FollowListItem {
+    followId: string;
+    user: User;
+    followedAt: string;
+}

package/dist/interfaces/HostedApp.d.ts

@@ -0,0 +1,11 @@
+export interface HostedApp {
+    id: string;
+    projectId: string;
+    name: string;
+    type: "discord-board";
+    subdomain: string;
+    metadata: Record<string, any>;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+}

package/dist/interfaces/ImageProcessing.d.ts

@@ -0,0 +1,62 @@
+export type ImageFit = "cover" | "contain" | "inside" | "outside";
+export type ImageFormat = "webp" | "jpeg" | "png" | "original";
+interface BaseImageOptions {
+    /** 1–100. Output quality. */
+    quality?: number;
+    format?: ImageFormat;
+    stripExif?: boolean;
+}
+/** Mode 1 — explicit width/height per named variant. */
+export interface ExactDimensionsOptions extends BaseImageOptions {
+    mode: "exact-dimensions";
+    /** Keyed by variant name, e.g. `{ thumbnail: { width, height } }`. 50–10000. */
+    dimensions: Record<string, {
+        width: number;
+        height: number;
+    }>;
+    fit?: ImageFit;
+}
+/** Mode 2a — fixed aspect ratio, sized by width per variant. */
+export interface AspectRatioWidthOptions extends BaseImageOptions {
+    mode: "aspect-ratio-width-based";
+    aspectRatio: {
+        width: number;
+        height: number;
+    };
+    /** Keyed by variant name → target width (50–10000). */
+    widths: Record<string, number>;
+    fit?: ImageFit;
+}
+/** Mode 2b — fixed aspect ratio, sized by height per variant. */
+export interface AspectRatioHeightOptions extends BaseImageOptions {
+    mode: "aspect-ratio-height-based";
+    aspectRatio: {
+        width: number;
+        height: number;
+    };
+    /** Keyed by variant name → target height (50–10000). */
+    heights: Record<string, number>;
+    fit?: ImageFit;
+}
+/** Mode 3 — preserve the source aspect ratio, bounded per variant. */
+export interface OriginalAspectOptions extends BaseImageOptions {
+    mode: "original-aspect";
+    /** Keyed by variant name → bounding size (50–10000). */
+    sizes: Record<string, number>;
+    /** Server restricts this mode to `inside` | `outside`. */
+    fit?: "inside" | "outside";
+}
+/** Mode 4 — multiple aspect ratios, sized per variant. */
+export interface MultiAspectRatioOptions extends BaseImageOptions {
+    mode: "multi-aspect-ratio";
+    /** 1–10 aspect ratios. */
+    aspectRatios: {
+        width: number;
+        height: number;
+    }[];
+    /** Keyed by variant name → target size (50–10000). */
+    sizes: Record<string, number>;
+    fit?: ImageFit;
+}
+export type ImageOptions = ExactDimensionsOptions | AspectRatioWidthOptions | AspectRatioHeightOptions | OriginalAspectOptions | MultiAspectRatioOptions;
+export {};

package/dist/interfaces/Mention.d.ts

@@ -0,0 +1,12 @@
+export type Mention = UserMention | SpaceMention;
+export interface UserMention {
+    type: "user";
+    id: string;
+    foreignId?: string | null;
+    username: string;
+}
+export interface SpaceMention {
+    type: "space";
+    id: string;
+    slug: string;
+}

package/dist/interfaces/OAuthIdentity.d.ts

@@ -0,0 +1,13 @@
+export interface OAuthIdentity {
+    id: string;
+    provider: string;
+    providerAccountId: string;
+    email: string | null;
+    name: string | null;
+    avatar: string | null;
+    isVerified: boolean;
+    createdAt: string;
+}
+export interface ListIdentitiesResponse {
+    identities: OAuthIdentity[];
+}

package/dist/interfaces/Project.d.ts

@@ -0,0 +1,14 @@
+export interface Project {
+    id: string;
+    clientId: string;
+    name: string;
+    integrations: {
+        id: string;
+        projectId: string;
+        name: string;
+        data: Record<string, any>;
+        createdAt: string;
+    }[];
+    createdAt: string;
+    updatedAt: string;
+}