@sublay/js 5.0.0 → 7.0.0

package/dist/interfaces/Reaction.d.ts

@@ -0,0 +1,23 @@
+import { User } from "./User";
+export type ReactionType = "upvote" | "downvote" | "like" | "love" | "wow" | "sad" | "angry" | "funny";
+export interface ReactionCounts {
+    upvote: number;
+    downvote: number;
+    like: number;
+    love: number;
+    wow: number;
+    sad: number;
+    angry: number;
+    funny: number;
+}
+export interface Reaction {
+    id: string;
+    projectId: string;
+    targetType: "entity" | "comment";
+    targetId: string;
+    userId: string;
+    reactionType: ReactionType;
+    createdAt: string;
+    updatedAt: string;
+    user?: User;
+}

package/dist/interfaces/Report.d.ts

@@ -0,0 +1,32 @@
+import { Entity } from "./Entity";
+import { Comment } from "./Comment";
+import { Space } from "./Space";
+export type ReportTargetType = "entity" | "comment";
+export type ReportStatus = "pending" | "on-hold" | "escalated" | "dismissed" | "actioned";
+export interface UserReport {
+    id: string;
+    projectId: string;
+    reportId: string;
+    userId: string;
+    reason: string;
+    details: string | null;
+    createdAt: string;
+}
+export interface Report {
+    id: string;
+    projectId: string;
+    spaceId: string | null;
+    targetId: string;
+    targetType: ReportTargetType;
+    status: ReportStatus;
+    reporterCount: number;
+    createdAt: string;
+    updatedAt: string;
+    userReports?: UserReport[];
+    target?: Entity | Comment | null;
+    space?: Space | null;
+}
+export interface CreateReportResponse {
+    message: string;
+    code: "report/created" | "report/updated" | "report/already-reported";
+}

package/dist/interfaces/Rule.d.ts

@@ -0,0 +1,22 @@
+export interface Rule {
+    id: string;
+    projectId: string;
+    spaceId: string;
+    title: string;
+    description: string | null;
+    order: number;
+    lastApprovedBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface FetchManyRulesResponse {
+    data: Rule[];
+    count: number;
+}
+export interface DeleteRuleResponse {
+    message: string;
+    deletedRule: {
+        id: string;
+        title: string;
+    };
+}

package/dist/interfaces/Space.d.ts

@@ -0,0 +1,141 @@
+import { PaginatedResponse } from "./IPaginatedResponse";
+import { File } from "./File";
+export type ReadingPermission = "anyone" | "members";
+export type PostingPermission = "anyone" | "members" | "admins";
+export type SpaceMemberRole = "admin" | "moderator" | "member";
+export type SpaceMemberStatus = "pending" | "active" | "banned" | "rejected";
+export interface SpaceMemberPermissions {
+    isAdmin: boolean;
+    isModerator: boolean;
+    isMember: boolean;
+    status: "pending" | "active" | "banned" | null;
+    canPost: boolean;
+    canModerate: boolean;
+    canRead: boolean;
+}
+export interface SpacePreview {
+    id: string;
+    shortId: string;
+    name: string;
+    slug: string | null;
+    avatarFileId: string | null;
+    readingPermission?: ReadingPermission;
+    parentSpaceId?: string | null;
+    depth?: number;
+    avatarFile?: File;
+}
+export interface Space {
+    id: string;
+    projectId: string;
+    shortId: string;
+    slug: string | null;
+    name: string;
+    description: string | null;
+    avatarFileId: string | null;
+    bannerFileId: string | null;
+    userId: string;
+    readingPermission: ReadingPermission;
+    postingPermission: PostingPermission;
+    requireJoinApproval: boolean;
+    parentSpaceId: string | null;
+    depth: number;
+    metadata: Record<string, any>;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    membersCount: number;
+    childSpacesCount: number;
+    isMember?: boolean;
+    avatarFile?: File;
+    bannerFile?: File;
+}
+export interface SpaceDetailed extends Space {
+    memberPermissions: SpaceMemberPermissions | null;
+    parentSpace: SpacePreview | null;
+    childSpaces: SpacePreview[];
+}
+export interface UserSpaceItem {
+    space: Space;
+    membership: {
+        membershipId: string;
+        role: SpaceMemberRole;
+        status: SpaceMemberStatus;
+        joinedAt: string;
+    };
+}
+export type UserSpacesResponse = PaginatedResponse<UserSpaceItem>;
+export interface JoinSpaceResponse {
+    message: string;
+    membership: {
+        id: string;
+        spaceId: string;
+        userId: string;
+        role: "member";
+        status: "pending" | "active";
+        joinedAt: string;
+    };
+}
+export interface LeaveSpaceResponse {
+    message: string;
+}
+export interface UpdateMemberRoleResponse {
+    message: string;
+    membership: {
+        id: string;
+        role: SpaceMemberRole;
+        status: string;
+        joinedAt: string;
+        userId: string;
+    };
+}
+export interface ApproveMemberResponse {
+    message: string;
+    membership: {
+        id: string;
+        status: "active";
+        joinedAt: string;
+    };
+}
+export interface DeclineMemberResponse {
+    message: string;
+    membership: {
+        id: string;
+        status: "rejected";
+    };
+}
+export interface CheckMyMembershipResponse {
+    isMember: boolean;
+    role: "admin" | "moderator" | "member" | null;
+    status: "pending" | "active" | "banned" | "rejected" | null;
+    joinedAt: string | null;
+    permissions: {
+        canPost: boolean;
+        canModerate: boolean;
+        canRead: boolean;
+        isAdmin: boolean;
+        isModerator: boolean;
+    };
+}
+export interface DeleteSpaceResponse {
+    message: string;
+    deletedSpace: {
+        id: string;
+        name: string;
+    };
+    counts: {
+        entities: number;
+        members: number;
+        childSpaces: number;
+    };
+}
+export interface DigestConfig {
+    digestEnabled: boolean;
+    digestWebhookUrl: string | null;
+    digestWebhookSecret: string | null;
+    digestScheduleHour: number | null;
+    digestTimezone: string | null;
+}
+export interface SpaceBreadcrumb {
+    breadcrumb: SpacePreview[];
+    depth: number;
+}

package/dist/interfaces/SpaceMember.d.ts

@@ -0,0 +1,29 @@
+import { PaginatedResponse } from "./IPaginatedResponse";
+import { SpaceMemberRole, SpaceMemberStatus } from "./Space";
+export interface SpaceMember {
+    id: string;
+    projectId: string;
+    spaceId: string;
+    userId: string;
+    role: SpaceMemberRole;
+    status: SpaceMemberStatus;
+    joinedAt: string;
+    createdAt: string;
+}
+export interface SpaceMemberWithUser {
+    membershipId: string;
+    role: SpaceMemberRole;
+    status: SpaceMemberStatus;
+    joinedAt: string;
+    user: {
+        id: string;
+        username: string;
+        displayName: string;
+        avatar: string;
+        metadata: object;
+    };
+}
+export type SpaceMembersResponse = PaginatedResponse<SpaceMemberWithUser>;
+export interface SpaceTeamResponse {
+    data: SpaceMemberWithUser[];
+}

package/dist/interfaces/User.d.ts

@@ -0,0 +1,39 @@
+import { File } from "./File";
+export type UserRole = "admin" | "moderator" | "visitor";
+export type UserFull = {
+    id: string;
+    projectId: string;
+    foreignId: string | null;
+    role: UserRole;
+    email: string | null;
+    name: string | null;
+    username: string | null;
+    avatar: string | null;
+    avatarFileId: string | null;
+    bannerFileId: string | null;
+    avatarFile?: File | null;
+    bannerFile?: File | null;
+    bio: string | null;
+    birthdate: string | null;
+    location: {
+        type: "Point";
+        coordinates: [number, number];
+    } | null;
+    metadata: Record<string, any>;
+    secureMetadata: Record<string, any>;
+    reputation: number;
+    isVerified: boolean;
+    isActive: boolean;
+    lastActive: string;
+    createdAt: string;
+    updatedAt: string;
+};
+export type AuthUser = Omit<UserFull, "secureMetadata"> & {
+    suspensions: {
+        reason: string | null;
+        startDate: string;
+        endDate: string | null;
+    }[];
+    authMethods: string[];
+};
+export type User = Omit<UserFull, "email" | "secureMetadata" | "isVerified" | "isActive" | "lastActive" | "updatedAt">;

package/dist/modules/app-notifications/countUnreadNotifications.d.ts

@@ -0,0 +1,2 @@
+import { SublayHttpClient } from "../../core/client";
+export declare function countUnreadNotifications(client: SublayHttpClient): Promise<number>;

package/dist/modules/app-notifications/fetchNotifications.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+import { UnifiedAppNotification } from "../../interfaces/AppNotification";
+import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
+export interface FetchNotificationsProps {
+    page?: number;
+    limit?: number;
+}
+export declare function fetchNotifications(client: SublayHttpClient, data?: FetchNotificationsProps): Promise<PaginatedResponse<UnifiedAppNotification>>;

package/dist/modules/app-notifications/index.d.ts

@@ -0,0 +1,4 @@
+export { fetchNotifications } from "./fetchNotifications";
+export { countUnreadNotifications } from "./countUnreadNotifications";
+export { markNotificationAsRead } from "./markNotificationAsRead";
+export { markAllNotificationsAsRead } from "./markAllNotificationsAsRead";

package/dist/modules/app-notifications/markAllNotificationsAsRead.d.ts

@@ -0,0 +1,5 @@
+import { SublayHttpClient } from "../../core/client";
+export interface MarkAllNotificationsAsReadResponse {
+    markedAsRead: number;
+}
+export declare function markAllNotificationsAsRead(client: SublayHttpClient): Promise<MarkAllNotificationsAsReadResponse>;

package/dist/modules/app-notifications/markNotificationAsRead.d.ts

@@ -0,0 +1,5 @@
+import { SublayHttpClient } from "../../core/client";
+export interface MarkNotificationAsReadProps {
+    notificationId: string;
+}
+export declare function markNotificationAsRead(client: SublayHttpClient, data: MarkNotificationAsReadProps): Promise<void>;

package/dist/modules/auth/changePassword.d.ts

@@ -0,0 +1,11 @@
+import { SublayHttpClient } from "../../core/client";
+export interface ChangePasswordProps {
+    /** The user's current password (verified before the change). */
+    password: string;
+    newPassword: string;
+}
+export interface ChangePasswordResponse {
+    success: boolean;
+    message: string;
+}
+export declare function changePassword(client: SublayHttpClient, data: ChangePasswordProps): Promise<ChangePasswordResponse>;

package/dist/modules/auth/index.d.ts

@@ -0,0 +1,10 @@
+export { signUp } from "./signUp";
+export { signIn } from "./signIn";
+export { signOut } from "./signOut";
+export { requestNewAccessToken } from "./requestNewAccessToken";
+export { verifyExternalUser } from "./verifyExternalUser";
+export { requestPasswordReset } from "./requestPasswordReset";
+export { resetPassword } from "./resetPassword";
+export { changePassword } from "./changePassword";
+export { verifyEmail } from "./verifyEmail";
+export { sendVerificationEmail } from "./sendVerificationEmail";

package/dist/modules/auth/requestNewAccessToken.d.ts

@@ -0,0 +1,16 @@
+import { SublayHttpClient } from "../../core/client";
+export interface RequestNewAccessTokenProps {
+    /** Defaults to the SDK's stored refresh token (SDK-managed mode). */
+    refreshToken?: string;
+}
+export interface RequestNewAccessTokenResponse {
+    accessToken: string;
+    /** The server rotates the refresh token on every refresh and returns the new one. */
+    refreshToken?: string;
+}
+/**
+ * Manually rotate the access token. The SDK auto-refreshes on 403 in
+ * SDK-managed mode, so this is rarely needed directly; it's exposed for parity
+ * and for host-managed callers that own their own refresh flow.
+ */
+export declare function requestNewAccessToken(client: SublayHttpClient, data?: RequestNewAccessTokenProps): Promise<RequestNewAccessTokenResponse>;

package/dist/modules/auth/requestPasswordReset.d.ts

@@ -0,0 +1,5 @@
+import { SublayHttpClient } from "../../core/client";
+export interface RequestPasswordResetProps {
+    email: string;
+}
+export declare function requestPasswordReset(client: SublayHttpClient, data: RequestPasswordResetProps): Promise<void>;

package/dist/modules/auth/resetPassword.d.ts

@@ -0,0 +1,6 @@
+import { SublayHttpClient } from "../../core/client";
+export interface ResetPasswordProps {
+    token: string;
+    newPassword: string;
+}
+export declare function resetPassword(client: SublayHttpClient, data: ResetPasswordProps): Promise<void>;

package/dist/modules/auth/sendVerificationEmail.d.ts

@@ -0,0 +1,13 @@
+import { SublayHttpClient } from "../../core/client";
+export interface SendVerificationEmailProps {
+    /** "code" emails a short token; "link" emails a verification URL. Defaults to "code". */
+    mode?: "code" | "link";
+    tokenFormat?: "hex" | "numeric" | "alpha" | "alphanumeric";
+    tokenLength?: number;
+    /** For mode "link": where to send the user after the link is verified. */
+    redirectUrl?: string;
+}
+export interface SendVerificationEmailResponse {
+    success: boolean;
+}
+export declare function sendVerificationEmail(client: SublayHttpClient, data?: SendVerificationEmailProps): Promise<SendVerificationEmailResponse>;

package/dist/modules/auth/signIn.d.ts

@@ -0,0 +1,12 @@
+import { SublayHttpClient } from "../../core/client";
+import { AuthUser } from "../../interfaces/User";
+export interface SignInProps {
+    email: string;
+    password: string;
+}
+export interface SignInResponse {
+    user: AuthUser;
+    accessToken: string;
+    refreshToken: string;
+}
+export declare function signIn(client: SublayHttpClient, data: SignInProps): Promise<SignInResponse>;

package/dist/modules/auth/signOut.d.ts

@@ -0,0 +1,9 @@
+import { SublayHttpClient } from "../../core/client";
+export interface SignOutProps {
+    /**
+     * Defaults to the SDK's stored refresh token (SDK-managed mode). Pass it
+     * explicitly in host-managed mode, where the SDK holds no refresh token.
+     */
+    refreshToken?: string;
+}
+export declare function signOut(client: SublayHttpClient, data?: SignOutProps): Promise<void>;

package/dist/modules/auth/signUp.d.ts

@@ -0,0 +1,24 @@
+import { SublayHttpClient } from "../../core/client";
+import { AuthUser } from "../../interfaces/User";
+export interface SignUpProps {
+    email: string;
+    password: string;
+    name?: string;
+    username?: string;
+    avatar?: string;
+    bio?: string;
+    location?: {
+        latitude: number;
+        longitude: number;
+    };
+    /** ISO 8601 datetime string. */
+    birthdate?: string;
+    metadata?: Record<string, any>;
+    secureMetadata?: Record<string, any>;
+}
+export interface SignUpResponse {
+    user: AuthUser;
+    accessToken: string;
+    refreshToken: string;
+}
+export declare function signUp(client: SublayHttpClient, data: SignUpProps): Promise<SignUpResponse>;

package/dist/modules/auth/verifyEmail.d.ts

@@ -0,0 +1,5 @@
+import { SublayHttpClient } from "../../core/client";
+export interface VerifyEmailProps {
+    token: string;
+}
+export declare function verifyEmail(client: SublayHttpClient, data: VerifyEmailProps): Promise<void>;

package/dist/modules/auth/verifyExternalUser.d.ts

@@ -0,0 +1,11 @@
+import { SublayHttpClient } from "../../core/client";
+import { AuthUser } from "../../interfaces/User";
+export interface VerifyExternalUserProps {
+    userJwt: string;
+}
+export interface VerifyExternalUserResponse {
+    user: AuthUser;
+    accessToken: string;
+    refreshToken: string;
+}
+export declare function verifyExternalUser(client: SublayHttpClient, data: VerifyExternalUserProps): Promise<VerifyExternalUserResponse>;

package/dist/modules/chat/addMember.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+import { ConversationMember } from "../../interfaces/ConversationMember";
+export interface AddMemberProps {
+    conversationId: string;
+    /** The member to add (the target). */
+    userId: string;
+}
+export declare function addMember(client: SublayHttpClient, data: AddMemberProps): Promise<ConversationMember>;

package/dist/modules/chat/changeMemberRole.d.ts

@@ -0,0 +1,9 @@
+import { SublayHttpClient } from "../../core/client";
+import { ConversationMember, ConversationMemberRole } from "../../interfaces/ConversationMember";
+export interface ChangeMemberRoleProps {
+    conversationId: string;
+    /** The member whose role changes (the target). */
+    userId: string;
+    role: ConversationMemberRole;
+}
+export declare function changeMemberRole(client: SublayHttpClient, data: ChangeMemberRoleProps): Promise<ConversationMember>;

package/dist/modules/chat/createDirectConversation.d.ts

@@ -0,0 +1,7 @@
+import { SublayHttpClient } from "../../core/client";
+import { Conversation } from "../../interfaces/Conversation";
+export interface CreateDirectConversationProps {
+    /** The other participant (the target). */
+    userId: string;
+}
+export declare function createDirectConversation(client: SublayHttpClient, data: CreateDirectConversationProps): Promise<Conversation>;

package/dist/modules/chat/createGroupConversation.d.ts

@@ -0,0 +1,10 @@
+import { SublayHttpClient } from "../../core/client";
+import { Conversation } from "../../interfaces/Conversation";
+export interface CreateGroupConversationProps {
+    name?: string;
+    description?: string;
+    /** Member user IDs to add to the group. Defaults to []. */
+    memberIds?: string[];
+    metadata?: Record<string, any>;
+}
+export declare function createGroupConversation(client: SublayHttpClient, data: CreateGroupConversationProps): Promise<Conversation>;

package/dist/modules/chat/deleteConversation.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+export interface DeleteConversationProps {
+    conversationId: string;
+}
+export interface DeleteConversationResponse {
+    message: string;
+}
+export declare function deleteConversation(client: SublayHttpClient, data: DeleteConversationProps): Promise<DeleteConversationResponse>;

package/dist/modules/chat/deleteMessage.d.ts

@@ -0,0 +1,11 @@
+import { SublayHttpClient } from "../../core/client";
+export interface DeleteMessageProps {
+    conversationId: string;
+    messageId: string;
+}
+export interface DeleteMessageResponse {
+    message: string;
+    /** Present when the author soft-deletes their own message. */
+    userDeletedAt?: string;
+}
+export declare function deleteMessage(client: SublayHttpClient, data: DeleteMessageProps): Promise<DeleteMessageResponse>;

package/dist/modules/chat/editMessage.d.ts

@@ -0,0 +1,13 @@
+import { SublayHttpClient } from "../../core/client";
+import { ChatMessage } from "../../interfaces/ChatMessage";
+import { Mention } from "../../interfaces/Mention";
+export interface EditMessageProps {
+    conversationId: string;
+    messageId: string;
+    content?: string;
+    /** A GIF URL, or null to clear it. */
+    gif?: string | null;
+    mentions?: Mention[];
+    metadata?: Record<string, any> | null;
+}
+export declare function editMessage(client: SublayHttpClient, data: EditMessageProps): Promise<ChatMessage>;

package/dist/modules/chat/getConversation.d.ts

@@ -0,0 +1,6 @@
+import { SublayHttpClient } from "../../core/client";
+import { Conversation } from "../../interfaces/Conversation";
+export interface GetConversationProps {
+    conversationId: string;
+}
+export declare function getConversation(client: SublayHttpClient, data: GetConversationProps): Promise<Conversation>;

package/dist/modules/chat/getMessage.d.ts

@@ -0,0 +1,7 @@
+import { SublayHttpClient } from "../../core/client";
+import { ChatMessage } from "../../interfaces/ChatMessage";
+export interface GetMessageProps {
+    conversationId: string;
+    messageId: string;
+}
+export declare function getMessage(client: SublayHttpClient, data: GetMessageProps): Promise<ChatMessage>;

package/dist/modules/chat/getUnreadCount.d.ts

@@ -0,0 +1,6 @@
+import { SublayHttpClient } from "../../core/client";
+export interface UnreadCountResponse {
+    totalUnread: number;
+    unreadConversationCount: number;
+}
+export declare function getUnreadCount(client: SublayHttpClient): Promise<UnreadCountResponse>;

package/dist/modules/chat/index.d.ts

@@ -0,0 +1,21 @@
+export { listConversations } from "./listConversations";
+export { createGroupConversation } from "./createGroupConversation";
+export { createDirectConversation } from "./createDirectConversation";
+export { getConversation } from "./getConversation";
+export { updateConversation } from "./updateConversation";
+export { deleteConversation } from "./deleteConversation";
+export { getUnreadCount } from "./getUnreadCount";
+export { listMembers } from "./listMembers";
+export { addMember } from "./addMember";
+export { removeMember } from "./removeMember";
+export { leaveConversation } from "./leaveConversation";
+export { changeMemberRole } from "./changeMemberRole";
+export { listMessages } from "./listMessages";
+export { sendMessage } from "./sendMessage";
+export { getMessage } from "./getMessage";
+export { editMessage } from "./editMessage";
+export { deleteMessage } from "./deleteMessage";
+export { toggleReaction } from "./toggleReaction";
+export { listReactions } from "./listReactions";
+export { markAsRead } from "./markAsRead";
+export { reportMessage } from "./reportMessage";

package/dist/modules/chat/leaveConversation.d.ts

@@ -0,0 +1,7 @@
+import { SublayHttpClient } from "../../core/client";
+export interface LeaveConversationProps {
+    conversationId: string;
+}
+export declare function leaveConversation(client: SublayHttpClient, data: LeaveConversationProps): Promise<{
+    message: string;
+}>;

package/dist/modules/chat/listConversations.d.ts

@@ -0,0 +1,17 @@
+import { SublayHttpClient } from "../../core/client";
+import { ConversationPreview } from "../../interfaces/Conversation";
+export interface ListConversationsProps {
+    /** Comma-separated conversation types, e.g. "direct,group,space". */
+    types?: string;
+    /** Cursor for keyset pagination: the `lastMessageAt` of the last item from the previous page (ISO datetime). */
+    cursor?: string;
+    /** Tie-breaker cursor: the `createdAt` of the last item from the previous page (ISO datetime). */
+    cursorCreatedAt?: string;
+    /** Default 20, max 50. */
+    limit?: number;
+}
+export interface ListConversationsResponse {
+    conversations: ConversationPreview[];
+    hasMore: boolean;
+}
+export declare function listConversations(client: SublayHttpClient, data?: ListConversationsProps): Promise<ListConversationsResponse>;

package/dist/modules/chat/listMembers.d.ts

@@ -0,0 +1,10 @@
+import { SublayHttpClient } from "../../core/client";
+import { ConversationMember } from "../../interfaces/ConversationMember";
+import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
+export interface ListMembersProps {
+    conversationId: string;
+    page?: number;
+    limit?: number;
+    role?: "admin" | "member";
+}
+export declare function listMembers(client: SublayHttpClient, data: ListMembersProps): Promise<PaginatedResponse<ConversationMember>>;

package/dist/modules/chat/listMessages.d.ts

@@ -0,0 +1,23 @@
+import { SublayHttpClient } from "../../core/client";
+import { ChatMessage } from "../../interfaces/ChatMessage";
+export interface ListMessagesProps {
+    conversationId: string;
+    /** Restrict to replies of this message (thread view). */
+    parentId?: string;
+    /** Keyset pagination: ISO timestamp; return messages created before this. Mutually exclusive with `after`. */
+    before?: string;
+    /** Keyset pagination: ISO timestamp; return messages created after this. Mutually exclusive with `before`. */
+    after?: string;
+    /** Page size (default 50, max 100). */
+    limit?: number;
+    sort?: "asc" | "desc";
+    /** Comma-separated associations to populate, e.g. "files". */
+    include?: string;
+}
+export interface ListMessagesResponse {
+    messages: ChatMessage[];
+    hasMore: boolean;
+    oldestCreatedAt: string | null;
+    newestCreatedAt: string | null;
+}
+export declare function listMessages(client: SublayHttpClient, data: ListMessagesProps): Promise<ListMessagesResponse>;