@sublay/js 5.0.0 → 7.0.0

package/dist/modules/spaces/moderateSpaceEntity.d.ts

@@ -0,0 +1,12 @@
+import { SublayHttpClient } from "../../core/client";
+export interface ModerateSpaceEntityProps {
+    spaceId: string;
+    entityId: string;
+    action: "approve" | "remove";
+    reason?: string;
+}
+export interface ModerationResponse {
+    message: string;
+    moderationStatus: "approved" | "removed";
+}
+export declare function moderateSpaceEntity(client: SublayHttpClient, data: ModerateSpaceEntityProps): Promise<ModerationResponse>;

package/dist/modules/spaces/reorderRules.d.ts

@@ -0,0 +1,7 @@
+import { SublayHttpClient } from "../../core/client";
+import { Rule } from "../../interfaces/Rule";
+export interface ReorderRulesProps {
+    spaceId: string;
+    ruleIds: string[];
+}
+export declare function reorderRules(client: SublayHttpClient, data: ReorderRulesProps): Promise<Rule[]>;

package/dist/modules/spaces/unbanMember.d.ts

@@ -0,0 +1,13 @@
+import { SublayHttpClient } from "../../core/client";
+export interface UnbanMemberProps {
+    spaceId: string;
+    memberId: string;
+}
+export interface UnbanMemberResponse {
+    message: string;
+    membership: {
+        id: string;
+        status: "active";
+    };
+}
+export declare function unbanMember(client: SublayHttpClient, data: UnbanMemberProps): Promise<UnbanMemberResponse>;

package/dist/modules/spaces/updateDigestConfig.d.ts

@@ -0,0 +1,11 @@
+import { SublayHttpClient } from "../../core/client";
+import { DigestConfig } from "../../interfaces/Space";
+export interface UpdateDigestConfigProps {
+    spaceId: string;
+    digestEnabled?: boolean;
+    digestWebhookUrl?: string;
+    digestWebhookSecret?: string;
+    digestScheduleHour?: number;
+    digestTimezone?: string;
+}
+export declare function updateDigestConfig(client: SublayHttpClient, data: UpdateDigestConfigProps): Promise<DigestConfig>;

package/dist/modules/spaces/updateMemberRole.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+import { UpdateMemberRoleResponse, SpaceMemberRole } from "../../interfaces/Space";
+export interface UpdateMemberRoleProps {
+    spaceId: string;
+    memberId: string;
+    role: SpaceMemberRole;
+}
+export declare function updateMemberRole(client: SublayHttpClient, data: UpdateMemberRoleProps): Promise<UpdateMemberRoleResponse>;

package/dist/modules/spaces/updateRule.d.ts

@@ -0,0 +1,9 @@
+import { SublayHttpClient } from "../../core/client";
+import { Rule } from "../../interfaces/Rule";
+export interface UpdateRuleProps {
+    spaceId: string;
+    ruleId: string;
+    title?: string;
+    description?: string;
+}
+export declare function updateRule(client: SublayHttpClient, data: UpdateRuleProps): Promise<Rule>;

package/dist/modules/spaces/updateSpace.d.ts

@@ -0,0 +1,12 @@
+import { SublayHttpClient } from "../../core/client";
+import { Space, ReadingPermission, PostingPermission } from "../../interfaces/Space";
+export interface UpdateSpaceProps {
+    spaceId: string;
+    name?: string;
+    slug?: string;
+    description?: string;
+    readingPermission?: ReadingPermission;
+    postingPermission?: PostingPermission;
+    metadata?: Record<string, any>;
+}
+export declare function updateSpace(client: SublayHttpClient, data: UpdateSpaceProps): Promise<Space>;

package/dist/modules/storage/deleteFile.d.ts

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

package/dist/modules/storage/getFile.d.ts

@@ -0,0 +1,34 @@
+import { SublayHttpClient } from "../../core/client";
+import { UploadedImageVariant } from "./uploadImage";
+export interface GetFileImage {
+    originalWidth: number;
+    originalHeight: number;
+    variants: Record<string, UploadedImageVariant>;
+    processingStatus: "completed" | "failed";
+    format: string;
+    quality: number;
+    exifStripped: boolean;
+}
+/** Shape returned by `GET /storage/:fileId` (a flat projection, not the populated `File` model). */
+export interface GetFileResponse {
+    fileId: string;
+    type: string;
+    originalPath: string;
+    originalSize: number;
+    originalMimeType: string;
+    position: number | null;
+    metadata: Record<string, any> | null;
+    /** ISO-8601 timestamp. */
+    createdAt: string;
+    /** ISO-8601 timestamp. */
+    updatedAt: string;
+    userId?: string;
+    entityId?: string;
+    commentId?: string;
+    spaceId?: string;
+    image?: GetFileImage;
+}
+export interface GetFileProps {
+    fileId: string;
+}
+export declare function getFile(client: SublayHttpClient, data: GetFileProps): Promise<GetFileResponse>;

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

@@ -0,0 +1,4 @@
+export { uploadImage } from "./uploadImage";
+export { uploadFile } from "./uploadFile";
+export { getFile } from "./getFile";
+export { deleteFile } from "./deleteFile";

package/dist/modules/storage/uploadFile.d.ts

@@ -0,0 +1,30 @@
+import { SublayHttpClient } from "../../core/client";
+export interface UploadFileResponse {
+    fileId: string;
+    type: string;
+    relativePath: string;
+    publicPath: string;
+    size: number;
+    mimeType: string;
+    /** ISO-8601 timestamp. */
+    createdAt: string;
+}
+export interface UploadFileProps {
+    /** The file to upload, as a browser `File` or `Blob`. */
+    file: Blob | File;
+    /** Optional filename for the multipart part (defaults to the `File.name` or `"upload"`). */
+    filename?: string;
+    /**
+     * Storage path segments for the file, e.g. ["avatars", userId]. Required by
+     * the server (`uploadFileBodySchema.pathParts`).
+     */
+    pathParts: string[];
+    /** Ordering within the associated entity/comment/space. */
+    position?: number;
+    metadata?: Record<string, any>;
+    /** Only one of entityId/commentId/spaceId may be set. */
+    entityId?: string;
+    commentId?: string;
+    spaceId?: string;
+}
+export declare function uploadFile(client: SublayHttpClient, data: UploadFileProps): Promise<UploadFileResponse>;

package/dist/modules/storage/uploadImage.d.ts

@@ -0,0 +1,41 @@
+import { SublayHttpClient } from "../../core/client";
+import { ImageOptions } from "../../interfaces/ImageProcessing";
+export interface UploadedImageVariant {
+    path: string;
+    width: number;
+    height: number;
+    size: number;
+    format: string;
+    publicPath: string;
+}
+export interface UploadImageResponse {
+    fileId: string;
+    type: "image";
+    originalPath: string;
+    originalSize: number;
+    originalWidth: number;
+    originalHeight: number;
+    variants: Record<string, UploadedImageVariant>;
+    format: string;
+    quality: number;
+    /** ISO-8601 timestamp. */
+    createdAt: string;
+}
+export interface UploadImageProps {
+    /** The image to upload, as a browser `File` or `Blob`. */
+    file: Blob | File;
+    /** Optional filename for the multipart part (defaults to the `File.name` or `"upload"`). */
+    filename?: string;
+    /**
+     * Image-processing configuration. A discriminated union on `mode` mirroring
+     * the server's `uploadImageBodySchema` — see {@link ImageOptions}.
+     */
+    imageOptions: ImageOptions;
+    /** Storage path segments, e.g. ["spaces", spaceId, "banner"]. */
+    pathParts?: string[];
+    /** Only one of entityId/commentId/spaceId may be set. */
+    entityId?: string;
+    commentId?: string;
+    spaceId?: string;
+}
+export declare function uploadImage(client: SublayHttpClient, data: UploadImageProps): Promise<UploadImageResponse>;

package/dist/modules/users/checkUsernameAvailability.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+export interface CheckUsernameAvailabilityProps {
+    username: string;
+}
+export interface CheckUsernameAvailabilityResponse {
+    available: boolean;
+}
+export declare function checkUsernameAvailability(client: SublayHttpClient, data: CheckUsernameAvailabilityProps): Promise<CheckUsernameAvailabilityResponse>;

package/dist/modules/users/createFollow.d.ts

@@ -0,0 +1,7 @@
+import { SublayHttpClient } from "../../core/client";
+import { Follow } from "../../interfaces/Follow";
+export interface CreateFollowProps {
+    /** The user being followed (the target). The follower is the token holder. */
+    userId: string;
+}
+export declare function createFollow(client: SublayHttpClient, data: CreateFollowProps): Promise<Follow>;

package/dist/modules/users/deleteFollow.d.ts

@@ -0,0 +1,6 @@
+import { SublayHttpClient } from "../../core/client";
+export interface DeleteFollowProps {
+    /** The user being unfollowed (the target). The follower is the token holder. */
+    userId: string;
+}
+export declare function deleteFollow(client: SublayHttpClient, data: DeleteFollowProps): Promise<void>;

package/dist/modules/users/fetchConnectionStatus.d.ts

@@ -0,0 +1,10 @@
+import { SublayHttpClient } from "../../core/client";
+import { ConnectionStatusResponse } from "../../interfaces/Connection";
+export interface FetchConnectionStatusProps {
+    /**
+     * The other user in the connection (the target). The status is from the
+     * perspective of the token holder.
+     */
+    userId: string;
+}
+export declare function fetchConnectionStatus(client: SublayHttpClient, data: FetchConnectionStatusProps): Promise<ConnectionStatusResponse>;

package/dist/modules/users/fetchConnectionsByUserId.d.ts

@@ -0,0 +1,9 @@
+import { SublayHttpClient } from "../../core/client";
+import { EstablishedConnection } from "../../interfaces/Connection";
+import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
+export interface FetchConnectionsByUserIdProps {
+    userId: string;
+    page?: number;
+    limit?: number;
+}
+export declare function fetchConnectionsByUserId(client: SublayHttpClient, data: FetchConnectionsByUserIdProps): Promise<PaginatedResponse<EstablishedConnection>>;

package/dist/modules/users/fetchConnectionsCountByUserId.d.ts

@@ -0,0 +1,6 @@
+import { SublayHttpClient } from "../../core/client";
+import { ConnectionCountResponse } from "../../interfaces/Connection";
+export interface FetchConnectionsCountByUserIdProps {
+    userId: string;
+}
+export declare function fetchConnectionsCountByUserId(client: SublayHttpClient, data: FetchConnectionsCountByUserIdProps): Promise<ConnectionCountResponse>;

package/dist/modules/users/fetchFollowStatus.d.ts

@@ -0,0 +1,14 @@
+import { SublayHttpClient } from "../../core/client";
+export interface FetchFollowStatusProps {
+    /**
+     * The user whose follow relationship is being checked (the target). The
+     * status is from the perspective of the token holder.
+     */
+    userId: string;
+}
+export interface FollowStatusResponse {
+    isFollowing: boolean;
+    followId?: string;
+    followedAt?: string;
+}
+export declare function fetchFollowStatus(client: SublayHttpClient, data: FetchFollowStatusProps): Promise<FollowStatusResponse>;

package/dist/modules/users/fetchFollowersByUserId.d.ts

@@ -0,0 +1,9 @@
+import { SublayHttpClient } from "../../core/client";
+import { FollowListItem } from "../../interfaces/Follow";
+import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
+export interface FetchFollowersByUserIdProps {
+    userId: string;
+    page?: number;
+    limit?: number;
+}
+export declare function fetchFollowersByUserId(client: SublayHttpClient, data: FetchFollowersByUserIdProps): Promise<PaginatedResponse<FollowListItem>>;

package/dist/modules/users/fetchFollowersCountByUserId.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+export interface FetchFollowersCountByUserIdProps {
+    userId: string;
+}
+export interface FollowersCountResponse {
+    count: number;
+}
+export declare function fetchFollowersCountByUserId(client: SublayHttpClient, data: FetchFollowersCountByUserIdProps): Promise<FollowersCountResponse>;

package/dist/modules/users/fetchFollowingByUserId.d.ts

@@ -0,0 +1,9 @@
+import { SublayHttpClient } from "../../core/client";
+import { FollowListItem } from "../../interfaces/Follow";
+import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
+export interface FetchFollowingByUserIdProps {
+    userId: string;
+    page?: number;
+    limit?: number;
+}
+export declare function fetchFollowingByUserId(client: SublayHttpClient, data: FetchFollowingByUserIdProps): Promise<PaginatedResponse<FollowListItem>>;

package/dist/modules/users/fetchFollowingCountByUserId.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+export interface FetchFollowingCountByUserIdProps {
+    userId: string;
+}
+export interface FollowingCountResponse {
+    count: number;
+}
+export declare function fetchFollowingCountByUserId(client: SublayHttpClient, data: FetchFollowingCountByUserIdProps): Promise<FollowingCountResponse>;

package/dist/modules/users/fetchUserByForeignId.d.ts

@@ -1,11 +1,7 @@
 import { SublayHttpClient } from "../../core/client";
+import { User } from "../../interfaces/User";
 export interface FetchUserByForeignIdProps {
     foreignId: string;
-    name?: string;
-    username?: string;
-    avatar?: string;
-    bio?: string;
-    metadata?: Record<string, any>;
-    secureMetadata?: Record<string, any>;
+    include?: string;
 }
-export declare function fetchUserByForeignId(client: SublayHttpClient, data: FetchUserByForeignIdProps): Promise<any>;
+export declare function fetchUserByForeignId(client: SublayHttpClient, data: FetchUserByForeignIdProps): Promise<User>;

package/dist/modules/users/fetchUserById.d.ts

@@ -1,5 +1,7 @@
 import { SublayHttpClient } from "../../core/client";
+import { User } from "../../interfaces/User";
 export interface FetchUserByIdProps {
     userId: string;
+    include?: string;
 }
-export declare function fetchUserById(client: SublayHttpClient, data: FetchUserByIdProps): Promise<any>;
+export declare function fetchUserById(client: SublayHttpClient, data: FetchUserByIdProps): Promise<User>;

package/dist/modules/users/fetchUserByUsername.d.ts

@@ -0,0 +1,7 @@
+import { SublayHttpClient } from "../../core/client";
+import { User } from "../../interfaces/User";
+export interface FetchUserByUsernameProps {
+    username: string;
+    include?: string;
+}
+export declare function fetchUserByUsername(client: SublayHttpClient, data: FetchUserByUsernameProps): Promise<User>;

package/dist/modules/users/fetchUserSuggestions.d.ts

@@ -0,0 +1,6 @@
+import { SublayHttpClient } from "../../core/client";
+import { User } from "../../interfaces/User";
+export interface FetchUserSuggestionsProps {
+    query: string;
+}
+export declare function fetchUserSuggestions(client: SublayHttpClient, data: FetchUserSuggestionsProps): Promise<User[]>;

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

@@ -1,3 +1,18 @@
-import { fetchUserById } from "./fetchUserById";
-import { fetchUserByForeignId } from "./fetchUserByForeignId";
-export { fetchUserById, fetchUserByForeignId };
+export { fetchUserById } from "./fetchUserById";
+export { fetchUserByForeignId } from "./fetchUserByForeignId";
+export { fetchUserByUsername } from "./fetchUserByUsername";
+export { fetchUserSuggestions } from "./fetchUserSuggestions";
+export { checkUsernameAvailability } from "./checkUsernameAvailability";
+export { updateUser } from "./updateUser";
+export { fetchFollowersByUserId } from "./fetchFollowersByUserId";
+export { fetchFollowersCountByUserId } from "./fetchFollowersCountByUserId";
+export { fetchFollowingByUserId } from "./fetchFollowingByUserId";
+export { fetchFollowingCountByUserId } from "./fetchFollowingCountByUserId";
+export { fetchConnectionsByUserId } from "./fetchConnectionsByUserId";
+export { fetchConnectionsCountByUserId } from "./fetchConnectionsCountByUserId";
+export { createFollow } from "./createFollow";
+export { deleteFollow } from "./deleteFollow";
+export { fetchFollowStatus } from "./fetchFollowStatus";
+export { requestConnection } from "./requestConnection";
+export { fetchConnectionStatus } from "./fetchConnectionStatus";
+export { removeConnectionByUserId } from "./removeConnectionByUserId";

package/dist/modules/users/removeConnectionByUserId.d.ts

@@ -0,0 +1,10 @@
+import { SublayHttpClient } from "../../core/client";
+import { RemoveConnectionByUserIdResponse } from "../../interfaces/Connection";
+export interface RemoveConnectionByUserIdProps {
+    /**
+     * The other user in the connection (the target). The token holder is the
+     * user withdrawing/declining/disconnecting.
+     */
+    userId: string;
+}
+export declare function removeConnectionByUserId(client: SublayHttpClient, data: RemoveConnectionByUserIdProps): Promise<RemoveConnectionByUserIdResponse>;

package/dist/modules/users/requestConnection.d.ts

@@ -0,0 +1,11 @@
+import { SublayHttpClient } from "../../core/client";
+import { ConnectionRequestResponse } from "../../interfaces/Connection";
+export interface RequestConnectionProps {
+    /**
+     * The user the connection is requested with (the target). The requester is
+     * the token holder.
+     */
+    userId: string;
+    message?: string;
+}
+export declare function requestConnection(client: SublayHttpClient, data: RequestConnectionProps): Promise<ConnectionRequestResponse>;

package/dist/modules/users/updateUser.d.ts

@@ -0,0 +1,32 @@
+import { SublayHttpClient } from "../../core/client";
+import { AuthUser } from "../../interfaces/User";
+import { ImageOptions } from "../../interfaces/ImageProcessing";
+/** A file plus the image-processing options the server requires alongside it. */
+export interface UserImageUpload {
+    file: Blob | File;
+    /** Image-processing config (must include `mode`) — see {@link ImageOptions}. */
+    options: ImageOptions;
+}
+export interface UpdateUserProps {
+    /** The user to update (the target). A user token may only update itself. */
+    userId: string;
+    name?: string;
+    username?: string;
+    avatar?: string;
+    bio?: string;
+    birthdate?: string;
+    location?: {
+        latitude: number;
+        longitude: number;
+    } | null;
+    metadata?: Record<string, any>;
+    secureMetadata?: Record<string, any>;
+    /**
+     * New avatar image. When present the request is sent as `multipart/form-data`.
+     * The server processes the image per `options` and replaces the old avatar.
+     */
+    avatarFile?: UserImageUpload;
+    /** New banner image; same contract as {@link UpdateUserProps.avatarFile}. */
+    bannerFile?: UserImageUpload;
+}
+export declare function updateUser(client: SublayHttpClient, data: UpdateUserProps): Promise<AuthUser>;

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@sublay/js",
-  "version": "5.0.0",
+  "version": "7.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "description": "Official JavaScript SDK for Sublay",
   "author": "Sublay team",
   "license": "ISC",
@@ -11,9 +14,9 @@
   },
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.js"
     }
   },
   "dependencies": {