@sublay/js 7.2.0 → 7.4.0

package/dist/interfaces/Event.d.ts

@@ -0,0 +1,66 @@
+import { User } from "./User";
+import { Space } from "./Space";
+import { File } from "./File";
+export type EventType = "online" | "physical" | "hybrid";
+export type EventVisibility = "public" | "members" | "invite";
+export type EventStatus = "active" | "cancelled";
+export type RsvpStatus = "going" | "maybe" | "not_going";
+export interface RsvpCounts {
+    going: number;
+    maybe: number;
+    not_going: number;
+}
+export interface Event {
+    id: string;
+    shortId: string;
+    projectId: string;
+    userId: string | null;
+    user?: User | null;
+    title: string;
+    description: string | null;
+    startTime: string;
+    endTime: string | null;
+    timezone: string | null;
+    type: EventType;
+    url: string | null;
+    venueName: string | null;
+    address: string | null;
+    location: {
+        type: "Point";
+        coordinates: [number, number];
+    } | null;
+    spaceId: string | null;
+    space?: Space | null;
+    visibility: EventVisibility;
+    status: EventStatus;
+    allowMaybe: boolean;
+    guestListVisible: boolean;
+    capacity: number | null;
+    hostIds: string[];
+    coverImageId: string | null;
+    files?: File[];
+    rsvpCounts: RsvpCounts;
+    userRsvp?: RsvpStatus | null;
+    metadata: Record<string, any>;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+}
+export interface EventRsvp {
+    id: string;
+    eventId: string;
+    userId: string;
+    user?: User | null;
+    status: RsvpStatus;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface EventInvite {
+    id: string;
+    eventId: string;
+    userId: string;
+    user?: User | null;
+    invitedAt: string;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/interfaces/SpaceReputation.d.ts

@@ -20,18 +20,37 @@
  */
 export interface SpaceReputationContextParams {
     /**
+     * Opt into space-scoped reputation enrichment. The primary form: an object
+     * describing the space and whether to include descendants.
+     *
+     * - `spaceId` — a space `<uuid>` (reputation within that specific space),
+     *   `"none"` (no space context — global reputation only), or `"context"`
+     *   (derive the space from each record's own context, e.g. a feed enriches
+     *   each row's author with reputation in that row's space).
+     * - `includeDescendants` — whether to include descendant spaces when
+     *   computing space-scoped reputation. Only honored with an explicit space
+     *   `<uuid>` (ignored for `"none"` / `"context"`).
+     */
+    spaceReputation?: {
+        spaceId: string | "none" | "context";
+        includeDescendants?: boolean;
+    };
+    /**
+     * @deprecated Pass the `spaceReputation` object instead. Retained for
+     * back-compat; removal is a later major version.
+     *
      * Opt into space-scoped reputation enrichment. Accepted forms:
      * - a space `<uuid>` — reputation within that specific space;
      * - `"none"` — no space context (global reputation only);
      * - `"context"` — derive the space from each record's own context
      *   (e.g. a feed enriches each row's author with reputation in that row's
      *   space).
-     *
-     * Plain `string` — a `string | "none" | "context"` union adds no safety
-     * since a uuid is already a string.
      */
     spaceReputationId?: string;
     /**
+     * @deprecated Pass the `spaceReputation` object (`includeDescendants`)
+     * instead. Retained for back-compat; removal is a later major version.
+     *
      * Whether to include descendant spaces when computing space-scoped
      * reputation. Only honored with an explicit space `<uuid>` (ignored for
      * `"none"` / `"context"`).
@@ -43,18 +62,37 @@ export interface SpaceReputationContextParams {
  */
 export interface SpaceReputationUserParams {
     /**
+     * Opt into space-scoped reputation enrichment. The primary form: an object
+     * describing the space and whether to include descendants.
+     *
+     * - `spaceId` — a space `<uuid>` (reputation within that specific space) or
+     *   `"none"` (no space context — global reputation only). `"context"` is
+     *   **rejected by the server (400)** on user-direct endpoints — there is no
+     *   per-record context to derive a space from.
+     * - `includeDescendants` — whether to include descendant spaces when
+     *   computing space-scoped reputation. Only honored with an explicit space
+     *   `<uuid>`.
+     */
+    spaceReputation?: {
+        spaceId: string | "none";
+        includeDescendants?: boolean;
+    };
+    /**
+     * @deprecated Pass the `spaceReputation` object instead. Retained for
+     * back-compat; removal is a later major version.
+     *
      * Opt into space-scoped reputation enrichment. Accepted forms:
      * - a space `<uuid>` — reputation within that specific space;
      * - `"none"` — no space context (global reputation only).
      *
      * `"context"` is **rejected by the server (400)** on user-direct endpoints —
      * there is no per-record context to derive a space from.
-     *
-     * Plain `string` — a `string | "none"` union adds no safety since a uuid is
-     * already a string.
      */
     spaceReputationId?: string;
     /**
+     * @deprecated Pass the `spaceReputation` object (`includeDescendants`)
+     * instead. Retained for back-compat; removal is a later major version.
+     *
      * Whether to include descendant spaces when computing space-scoped
      * reputation. Only honored with an explicit space `<uuid>`.
      */

package/dist/modules/comments/fetchManyComments.d.ts

@@ -8,7 +8,17 @@ export interface FetchManyCommentsProps extends SpaceReputationContextParams {
     parentId?: string;
     page?: number;
     limit?: number;
-    sortBy?: "new" | "old" | "top" | "controversial";
+    sortBy?: "createdAt" | "top" | "controversial"
+    /** @deprecated Use "createdAt" instead. "new" is a directional alias for
+     * createdAt DESC, removed in v8; the server still accepts it (identical
+     * behavior) but responds with deprecation headers. */
+     | "new"
+    /** @deprecated Use "createdAt" with sortDir:"asc" instead. "old" is a
+     * directional alias for createdAt ASC, removed in v8; the server still
+     * accepts it (identical behavior) but responds with deprecation headers. */
+     | "old";
+    /** Sort direction for `sortBy: "createdAt"`. Defaults to "desc". */
+    sortDir?: "asc" | "desc";
     include?: string;
     sourceId?: string;
 }

package/dist/modules/entities/fetchManyEntities.d.ts

@@ -35,7 +35,11 @@ export interface LocationFilters {
 export interface FetchManyEntitiesProps extends SpaceReputationContextParams {
     sourceId?: string;
     spaceId?: string;
-    sortBy?: "new" | "hot" | "top" | "controversial" | (string & {});
+    sortBy?: "createdAt" | "hot" | "top" | "controversial"
+    /** @deprecated Use "createdAt" instead. "new" is a directional alias removed
+     * in v8; the server still accepts it (identical behavior) but responds with
+     * deprecation headers. */
+     | "new" | (string & {});
     sortDir?: "asc" | "desc";
     sortType?: "auto" | "numeric" | "text" | "boolean" | "timestamp";
     sortByReaction?: "upvote" | "downvote" | "like" | "love" | "wow" | "sad" | "angry" | "funny";

package/dist/modules/events/addHost.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event } from "../../interfaces/Event";
+export interface AddHostProps {
+    eventId: string;
+    /** The user to grant host on the event. */
+    userId: string;
+}
+export declare function addHost(client: SublayHttpClient, data: AddHostProps): Promise<Event>;

package/dist/modules/events/addInvite.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event } from "../../interfaces/Event";
+export interface AddInviteProps {
+    eventId: string;
+    /** The user to invite (userId only — never a foreignId). Idempotent. */
+    userId: string;
+}
+export declare function addInvite(client: SublayHttpClient, data: AddInviteProps): Promise<Event>;

package/dist/modules/events/cancelEvent.d.ts

@@ -0,0 +1,6 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event } from "../../interfaces/Event";
+export interface CancelEventProps {
+    eventId: string;
+}
+export declare function cancelEvent(client: SublayHttpClient, data: CancelEventProps): Promise<Event>;

package/dist/modules/events/createEvent.d.ts

@@ -0,0 +1,49 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event, EventType, EventVisibility } from "../../interfaces/Event";
+import { ImageOptions } from "../../interfaces/ImageProcessing";
+/** A single cover image plus its processing options (stored as Event.coverImageId). */
+export interface EventCoverUpload {
+    file: Blob | File;
+    /** Image-processing config (must include `mode`) — see {@link ImageOptions}. */
+    options: ImageOptions;
+}
+/** A gallery image set plus shared processing options (Files with eventId + position). */
+export interface EventGalleryUpload {
+    files: (Blob | File)[];
+    /** Image-processing config applied to every gallery image — see {@link ImageOptions}. */
+    options: ImageOptions;
+}
+export interface CreateEventProps {
+    title: string;
+    description?: string;
+    startTime: string;
+    endTime?: string;
+    timezone?: string;
+    type: EventType;
+    url?: string;
+    venueName?: string;
+    address?: string;
+    location?: {
+        latitude: number;
+        longitude: number;
+    };
+    spaceId?: string;
+    visibility?: EventVisibility;
+    capacity?: number;
+    allowMaybe?: boolean;
+    guestListVisible?: boolean;
+    /** Additional host user IDs (the logged-in user is auto-added as a host). */
+    hostIds?: string[];
+    metadata?: Record<string, any>;
+    /**
+     * Inline cover image (single). When present the request is sent as
+     * `multipart/form-data`. Requires the `files-images` bundle.
+     */
+    cover?: EventCoverUpload;
+    /**
+     * Inline gallery images (multi). When present the request is sent as
+     * `multipart/form-data`. Requires the `files-images` bundle.
+     */
+    gallery?: EventGalleryUpload;
+}
+export declare function createEvent(client: SublayHttpClient, data: CreateEventProps): Promise<Event>;

package/dist/modules/events/deleteEvent.d.ts

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

package/dist/modules/events/fetchEvent.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event } from "../../interfaces/Event";
+export interface FetchEventProps {
+    eventId: string;
+    /** Comma-separated associations to expand, e.g. "user,space,files,userRsvp". */
+    include?: string;
+}
+export declare function fetchEvent(client: SublayHttpClient, data: FetchEventProps): Promise<Event>;

package/dist/modules/events/fetchEventRsvps.d.ts

@@ -0,0 +1,19 @@
+import { SublayHttpClient } from "../../core/client";
+import { EventRsvp } from "../../interfaces/Event";
+import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
+export interface FetchEventRsvpsProps {
+    eventId: string;
+    page?: number;
+    limit?: number;
+    /**
+     * Comma-separated RSVP statuses to filter by, e.g. "going,maybe". When
+     * omitted, all statuses are returned.
+     */
+    status?: string;
+}
+/**
+ * Named RSVP (guest) list. Visible to hosts always, or to any viewer when the
+ * event's `guestListVisible` is true; otherwise 403. RSVP counts themselves are
+ * public via the event's `rsvpCounts`.
+ */
+export declare function fetchEventRsvps(client: SublayHttpClient, data: FetchEventRsvpsProps): Promise<PaginatedResponse<EventRsvp>>;

package/dist/modules/events/fetchInvitees.d.ts

@@ -0,0 +1,12 @@
+import { SublayHttpClient } from "../../core/client";
+import { EventInvite } from "../../interfaces/Event";
+import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
+export interface FetchInviteesProps {
+    eventId: string;
+    page?: number;
+    limit?: number;
+}
+/**
+ * Host-only invitee (guest) list. Non-hosts get 403.
+ */
+export declare function fetchInvitees(client: SublayHttpClient, data: FetchInviteesProps): Promise<PaginatedResponse<EventInvite>>;

package/dist/modules/events/fetchManyEvents.d.ts

@@ -0,0 +1,42 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event, EventType, EventStatus } from "../../interfaces/Event";
+import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
+export interface EventTextFilters {
+    hasTitle?: "true" | "false";
+    includes?: string | string[];
+    doesNotInclude?: string | string[];
+}
+export interface EventDescriptionFilters {
+    hasDescription?: "true" | "false";
+    includes?: string | string[];
+    doesNotInclude?: string | string[];
+}
+export interface EventLocationFilters {
+    latitude: string;
+    longitude: string;
+    radius: string;
+}
+export interface FetchManyEventsProps {
+    page?: number;
+    limit?: number;
+    sortBy?: "startTime" | "going";
+    sortDir?: "asc" | "desc";
+    timeWindow?: "upcoming" | "ongoing" | "past";
+    startsAfter?: string;
+    startsBefore?: string;
+    spaceId?: string;
+    hostId?: string;
+    type?: EventType;
+    status?: EventStatus;
+    /**
+     * Comma-separated RSVP statuses the logged-in user RSVP'd with, e.g.
+     * "going,maybe". Filters to events the caller has that RSVP on.
+     */
+    myRsvp?: string;
+    locationFilters?: EventLocationFilters;
+    titleFilters?: EventTextFilters;
+    descriptionFilters?: EventDescriptionFilters;
+    /** Comma-separated associations to expand, e.g. "user,space,files,userRsvp". */
+    include?: string;
+}
+export declare function fetchManyEvents(client: SublayHttpClient, data?: FetchManyEventsProps): Promise<PaginatedResponse<Event>>;

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

@@ -0,0 +1,14 @@
+export { createEvent } from "./createEvent";
+export { fetchEvent } from "./fetchEvent";
+export { fetchManyEvents } from "./fetchManyEvents";
+export { updateEvent } from "./updateEvent";
+export { cancelEvent } from "./cancelEvent";
+export { deleteEvent } from "./deleteEvent";
+export { setRsvp } from "./setRsvp";
+export { withdrawRsvp } from "./withdrawRsvp";
+export { addHost } from "./addHost";
+export { removeHost } from "./removeHost";
+export { addInvite } from "./addInvite";
+export { removeInvite } from "./removeInvite";
+export { fetchInvitees } from "./fetchInvitees";
+export { fetchEventRsvps } from "./fetchEventRsvps";

package/dist/modules/events/removeHost.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event } from "../../interfaces/Event";
+export interface RemoveHostProps {
+    eventId: string;
+    /** The host to remove. Rejected if it would leave the event with no hosts. */
+    userId: string;
+}
+export declare function removeHost(client: SublayHttpClient, data: RemoveHostProps): Promise<Event>;

package/dist/modules/events/removeInvite.d.ts

@@ -0,0 +1,8 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event } from "../../interfaces/Event";
+export interface RemoveInviteProps {
+    eventId: string;
+    /** The invitee to remove. Also drops their RSVP and revokes access. */
+    userId: string;
+}
+export declare function removeInvite(client: SublayHttpClient, data: RemoveInviteProps): Promise<Event>;

package/dist/modules/events/setRsvp.d.ts

@@ -0,0 +1,7 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event, RsvpStatus } from "../../interfaces/Event";
+export interface SetRsvpProps {
+    eventId: string;
+    status: RsvpStatus;
+}
+export declare function setRsvp(client: SublayHttpClient, data: SetRsvpProps): Promise<Event>;

package/dist/modules/events/updateEvent.d.ts

@@ -0,0 +1,43 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event, EventType, EventVisibility } from "../../interfaces/Event";
+import type { EventCoverUpload, EventGalleryUpload } from "./createEvent";
+export interface UpdateEventProps {
+    eventId: string;
+    title?: string;
+    description?: string;
+    startTime?: string;
+    endTime?: string;
+    timezone?: string;
+    type?: EventType;
+    url?: string;
+    venueName?: string;
+    address?: string;
+    location?: {
+        latitude: number;
+        longitude: number;
+    };
+    visibility?: EventVisibility;
+    capacity?: number;
+    allowMaybe?: boolean;
+    guestListVisible?: boolean;
+    metadata?: Record<string, any>;
+    /**
+     * File IDs of existing event images to REMOVE (gallery photos and/or the
+     * current cover). Combine with `gallery` (append) + `cover` (replace) to fully
+     * curate the image set in one update. Sent in the JSON body, or — when an
+     * image file is also attached — as a JSON-string field the server parses.
+     */
+    removeImageIds?: string[];
+    /**
+     * New cover image (single) — REPLACES the existing cover. When present the
+     * request is sent as `multipart/form-data`. Requires the `files-images` bundle.
+     */
+    cover?: EventCoverUpload;
+    /**
+     * Gallery images (multi) — APPENDED to the event's existing images. When
+     * present the request is sent as `multipart/form-data`. Requires the
+     * `files-images` bundle.
+     */
+    gallery?: EventGalleryUpload;
+}
+export declare function updateEvent(client: SublayHttpClient, data: UpdateEventProps): Promise<Event>;

package/dist/modules/events/withdrawRsvp.d.ts

@@ -0,0 +1,6 @@
+import { SublayHttpClient } from "../../core/client";
+import { Event } from "../../interfaces/Event";
+export interface WithdrawRsvpProps {
+    eventId: string;
+}
+export declare function withdrawRsvp(client: SublayHttpClient, data: WithdrawRsvpProps): Promise<Event>;

package/dist/modules/search/askContent.d.ts

@@ -5,6 +5,12 @@ export interface AskContentProps extends SpaceReputationContextParams {
     query: string;
     sourceTypes?: ("entity" | "comment" | "message")[];
     spaceId?: string;
+    /**
+     * With a `spaceId`, also search every space nested under it (children,
+     * grandchildren — the whole subtree, any depth). Ignored without a `spaceId`.
+     * Defaults to false (exact-space search).
+     */
+    includeChildSpaces?: boolean;
     conversationId?: string;
     limit?: number;
     /** Abort the in-flight stream (e.g. when the user navigates away). */

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

@@ -2,3 +2,4 @@ export { searchContent } from "./searchContent";
 export { searchUsers } from "./searchUsers";
 export { searchSpaces } from "./searchSpaces";
 export { askContent } from "./askContent";
+export { matchUsers } from "./matchUsers";

package/dist/modules/search/matchUsers.d.ts

@@ -0,0 +1,36 @@
+import { SublayHttpClient } from "../../core/client";
+import { User } from "../../interfaces/User";
+export interface MatchUsersProps {
+    mode: "passive" | "directed";
+    query?: string;
+    limit?: number;
+    spaceId?: string;
+    includeChildSpaces?: boolean;
+    includeSampleContent?: boolean;
+    excludeSelf?: boolean;
+}
+export interface MatchFacetRef {
+    id: string;
+    hotness: number;
+}
+export interface SampleContent {
+    sourceType: "entity" | "comment" | "message";
+    recordId: string;
+    content: string;
+    similarity: number;
+}
+export interface MatchedFacet {
+    similarity: number;
+    askerFacet?: MatchFacetRef;
+    candidateFacet: MatchFacetRef;
+    sampleContent?: SampleContent[];
+}
+export interface UserMatchResult {
+    user: User;
+    score: number;
+    matchedFacets: MatchedFacet[];
+}
+export interface MatchUsersResponse {
+    results: UserMatchResult[];
+}
+export declare function matchUsers(client: SublayHttpClient, data: MatchUsersProps): Promise<MatchUsersResponse>;

package/dist/modules/search/searchContent.d.ts

@@ -7,6 +7,12 @@ export interface SearchContentProps extends SpaceReputationContextParams {
     query: string;
     sourceTypes?: ("entity" | "comment" | "message")[];
     spaceId?: string;
+    /**
+     * With a `spaceId`, also search every space nested under it (children,
+     * grandchildren — the whole subtree, any depth). Ignored without a `spaceId`.
+     * Defaults to false (exact-space search).
+     */
+    includeChildSpaces?: boolean;
     conversationId?: string;
     limit?: number;
 }

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

@@ -1,5 +1,12 @@
 import { SublayHttpClient } from "../../core/client";
 import { Space, ReadingPermission, PostingPermission } from "../../interfaces/Space";
+import { ImageOptions } from "../../interfaces/ImageProcessing";
+/** A file plus the image-processing options the server requires alongside it. */
+export interface SpaceImageUpload {
+    file: Blob | File;
+    /** Image-processing config (must include `mode`) — see {@link ImageOptions}. */
+    options: ImageOptions;
+}
 export interface CreateSpaceProps {
     name: string;
     slug?: string;
@@ -9,5 +16,12 @@ export interface CreateSpaceProps {
     requireJoinApproval?: boolean;
     parentSpaceId?: string;
     metadata?: Record<string, any>;
+    /**
+     * Avatar image. When present the request is sent as `multipart/form-data` and
+     * the server processes the image per `options`.
+     */
+    avatarFile?: SpaceImageUpload;
+    /** Banner image; same contract as {@link CreateSpaceProps.avatarFile}. */
+    bannerFile?: SpaceImageUpload;
 }
 export declare function createSpace(client: SublayHttpClient, data: CreateSpaceProps): Promise<Space>;

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

@@ -1,5 +1,6 @@
 import { SublayHttpClient } from "../../core/client";
 import { Space, ReadingPermission, PostingPermission } from "../../interfaces/Space";
+import type { SpaceImageUpload } from "./createSpace";
 export interface UpdateSpaceProps {
     spaceId: string;
     name?: string;
@@ -8,5 +9,12 @@ export interface UpdateSpaceProps {
     readingPermission?: ReadingPermission;
     postingPermission?: PostingPermission;
     metadata?: Record<string, any>;
+    /**
+     * New avatar image. When present the request is sent as `multipart/form-data`
+     * and the server processes the image per `options`, replacing the old avatar.
+     */
+    avatarFile?: SpaceImageUpload;
+    /** New banner image; same contract as {@link UpdateSpaceProps.avatarFile}. */
+    bannerFile?: SpaceImageUpload;
 }
 export declare function updateSpace(client: SublayHttpClient, data: UpdateSpaceProps): Promise<Space>;

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

@@ -33,9 +33,10 @@ export interface UploadImageProps {
     imageOptions: ImageOptions;
     /** Storage path segments, e.g. ["spaces", spaceId, "banner"]. */
     pathParts?: string[];
-    /** Only one of entityId/commentId/spaceId may be set. */
+    /** Only one of entityId/commentId/spaceId/eventId may be set. */
     entityId?: string;
     commentId?: string;
     spaceId?: string;
+    eventId?: string;
 }
 export declare function uploadImage(client: SublayHttpClient, data: UploadImageProps): Promise<UploadImageResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sublay/js",
-  "version": "7.2.0",
+  "version": "7.4.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -36,8 +36,8 @@
     "test": "jest",
     "version:patch": "pnpm version patch --no-git-tag-version --no-git-checks",
     "version:minor": "pnpm version minor --no-git-tag-version --no-git-checks",
-    "publish-beta": "pnpm publish --tag beta --no-git-checks",
-    "publish-prod": "pnpm publish --no-git-checks",
+    "publish-beta": "pnpm test && pnpm publish --tag beta --no-git-checks",
+    "publish-prod": "pnpm test && pnpm publish --no-git-checks",
     "publish-beta:patch": "pnpm version:patch && pnpm publish-beta",
     "publish-beta:minor": "pnpm version:minor && pnpm publish-beta",
     "publish-prod:patch": "pnpm version:patch && pnpm publish-prod",