@sublay/js 7.8.0 → 7.9.0

package/dist/index.js

@@ -1978,6 +1978,49 @@ async function fetchModeratedReports(client, data) {
   return response.data;
 }
 
+// src/modules/reputation/index.ts
+var reputation_exports = {};
+__export(reputation_exports, {
+  createGrant: () => createGrant,
+  listGrants: () => listGrants
+});
+
+// src/modules/reputation/createGrant.ts
+async function createGrant(client, data) {
+  const response = await client.projectInstance.post(
+    "/reputation-grants",
+    data
+  );
+  return response.data;
+}
+
+// src/modules/reputation/listGrants.ts
+async function listGrants(client, data) {
+  const {
+    spaceReputation,
+    spaceReputationId,
+    spaceReputationDescendants,
+    ...rest
+  } = data;
+  const response = await client.projectInstance.get(
+    "/reputation-grants",
+    {
+      params: {
+        ...rest,
+        // `spaceReputationId=context` scores each hydrated user against THAT
+        // GRANT'S own bucket. Normalized rather than spread raw — axios would
+        // bracket-encode the object and the server would ignore it.
+        ...buildSpaceReputationParams({
+          spaceReputation,
+          spaceReputationId,
+          spaceReputationDescendants
+        })
+      }
+    }
+  );
+  return response.data;
+}
+
 // src/modules/search/index.ts
 var search_exports = {};
 __export(search_exports, {
@@ -2598,11 +2641,9 @@ __export(workspaces_exports, {
 
 // src/modules/workspaces/createWorkspace.ts
 async function createWorkspace(client, data) {
-  const body = { ...data };
-  delete body.userId;
   const response = await client.projectInstance.post(
     "/workspaces",
-    body
+    data
   );
   return response.data;
 }
@@ -2619,17 +2660,13 @@ async function fetchWorkspace(client, data) {
 
 // src/modules/workspaces/fetchManyWorkspaces.ts
 async function fetchManyWorkspaces(client, data = {}) {
-  const params = { ...data };
-  delete params.userId;
-  const response = await client.projectInstance.get("/workspaces", { params });
+  const response = await client.projectInstance.get("/workspaces", { params: data });
   return response.data;
 }
 
 // src/modules/workspaces/updateWorkspace.ts
 async function updateWorkspace(client, data) {
-  const { workspaceId, ...rest } = data;
-  const body = { ...rest };
-  delete body.userId;
+  const { workspaceId, ...body } = data;
   const response = await client.projectInstance.patch(
     `/workspaces/${workspaceId}`,
     body
@@ -2658,9 +2695,7 @@ async function deleteWorkspace(client, data) {
 
 // src/modules/workspaces/transferWorkspaceOwnership.ts
 async function transferWorkspaceOwnership(client, data) {
-  const { workspaceId, ...rest } = data;
-  const body = { ...rest };
-  delete body.userId;
+  const { workspaceId, ...body } = data;
   const response = await client.projectInstance.post(
     `/workspaces/${workspaceId}/transfer-ownership`,
     body
@@ -2670,9 +2705,7 @@ async function transferWorkspaceOwnership(client, data) {
 
 // src/modules/workspaces/fetchWorkspaceMembers.ts
 async function fetchWorkspaceMembers(client, data) {
-  const { workspaceId, ...rest } = data;
-  const params = { ...rest };
-  delete params.userId;
+  const { workspaceId, ...params } = data;
   const response = await client.projectInstance.get(`/workspaces/${workspaceId}/members`, { params });
   return response.data;
 }
@@ -2688,9 +2721,7 @@ async function fetchWorkspaceMemberStanding(client, data) {
 
 // src/modules/workspaces/updateWorkspaceMember.ts
 async function updateWorkspaceMember(client, data) {
-  const { workspaceId, targetUserId, ...rest } = data;
-  const body = { ...rest };
-  delete body.userId;
+  const { workspaceId, targetUserId, ...body } = data;
   const response = await client.projectInstance.patch(
     `/workspaces/${workspaceId}/members/${targetUserId}`,
     body
@@ -2908,6 +2939,7 @@ var PUSH_EVENT_TYPES = [
   "event-invite",
   "event-updated",
   "event-cancelled",
+  "reputation-grant",
   "message"
 ];
 var MUTE_DURATIONS = ["8h", "24h", "1w", "forever"];
@@ -2926,6 +2958,7 @@ var SublayClient = class _SublayClient {
   connections;
   appNotifications;
   reports;
+  reputation;
   search;
   storage;
   oauth;
@@ -2945,6 +2978,7 @@ var SublayClient = class _SublayClient {
     this.connections = bindModule(connections_exports, this.http);
     this.appNotifications = bindModule(app_notifications_exports, this.http);
     this.reports = bindModule(reports_exports, this.http);
+    this.reputation = bindModule(reputation_exports, this.http);
     this.search = bindModule(search_exports, this.http);
     this.storage = bindModule(storage_exports, this.http);
     this.oauth = bindModule(oauth_exports, this.http);

package/dist/index.mjs

@@ -1946,6 +1946,49 @@ async function fetchModeratedReports(client, data) {
   return response.data;
 }
 
+// src/modules/reputation/index.ts
+var reputation_exports = {};
+__export(reputation_exports, {
+  createGrant: () => createGrant,
+  listGrants: () => listGrants
+});
+
+// src/modules/reputation/createGrant.ts
+async function createGrant(client, data) {
+  const response = await client.projectInstance.post(
+    "/reputation-grants",
+    data
+  );
+  return response.data;
+}
+
+// src/modules/reputation/listGrants.ts
+async function listGrants(client, data) {
+  const {
+    spaceReputation,
+    spaceReputationId,
+    spaceReputationDescendants,
+    ...rest
+  } = data;
+  const response = await client.projectInstance.get(
+    "/reputation-grants",
+    {
+      params: {
+        ...rest,
+        // `spaceReputationId=context` scores each hydrated user against THAT
+        // GRANT'S own bucket. Normalized rather than spread raw — axios would
+        // bracket-encode the object and the server would ignore it.
+        ...buildSpaceReputationParams({
+          spaceReputation,
+          spaceReputationId,
+          spaceReputationDescendants
+        })
+      }
+    }
+  );
+  return response.data;
+}
+
 // src/modules/search/index.ts
 var search_exports = {};
 __export(search_exports, {
@@ -2566,11 +2609,9 @@ __export(workspaces_exports, {
 
 // src/modules/workspaces/createWorkspace.ts
 async function createWorkspace(client, data) {
-  const body = { ...data };
-  delete body.userId;
   const response = await client.projectInstance.post(
     "/workspaces",
-    body
+    data
   );
   return response.data;
 }
@@ -2587,17 +2628,13 @@ async function fetchWorkspace(client, data) {
 
 // src/modules/workspaces/fetchManyWorkspaces.ts
 async function fetchManyWorkspaces(client, data = {}) {
-  const params = { ...data };
-  delete params.userId;
-  const response = await client.projectInstance.get("/workspaces", { params });
+  const response = await client.projectInstance.get("/workspaces", { params: data });
   return response.data;
 }
 
 // src/modules/workspaces/updateWorkspace.ts
 async function updateWorkspace(client, data) {
-  const { workspaceId, ...rest } = data;
-  const body = { ...rest };
-  delete body.userId;
+  const { workspaceId, ...body } = data;
   const response = await client.projectInstance.patch(
     `/workspaces/${workspaceId}`,
     body
@@ -2626,9 +2663,7 @@ async function deleteWorkspace(client, data) {
 
 // src/modules/workspaces/transferWorkspaceOwnership.ts
 async function transferWorkspaceOwnership(client, data) {
-  const { workspaceId, ...rest } = data;
-  const body = { ...rest };
-  delete body.userId;
+  const { workspaceId, ...body } = data;
   const response = await client.projectInstance.post(
     `/workspaces/${workspaceId}/transfer-ownership`,
     body
@@ -2638,9 +2673,7 @@ async function transferWorkspaceOwnership(client, data) {
 
 // src/modules/workspaces/fetchWorkspaceMembers.ts
 async function fetchWorkspaceMembers(client, data) {
-  const { workspaceId, ...rest } = data;
-  const params = { ...rest };
-  delete params.userId;
+  const { workspaceId, ...params } = data;
   const response = await client.projectInstance.get(`/workspaces/${workspaceId}/members`, { params });
   return response.data;
 }
@@ -2656,9 +2689,7 @@ async function fetchWorkspaceMemberStanding(client, data) {
 
 // src/modules/workspaces/updateWorkspaceMember.ts
 async function updateWorkspaceMember(client, data) {
-  const { workspaceId, targetUserId, ...rest } = data;
-  const body = { ...rest };
-  delete body.userId;
+  const { workspaceId, targetUserId, ...body } = data;
   const response = await client.projectInstance.patch(
     `/workspaces/${workspaceId}/members/${targetUserId}`,
     body
@@ -2876,6 +2907,7 @@ var PUSH_EVENT_TYPES = [
   "event-invite",
   "event-updated",
   "event-cancelled",
+  "reputation-grant",
   "message"
 ];
 var MUTE_DURATIONS = ["8h", "24h", "1w", "forever"];
@@ -2894,6 +2926,7 @@ var SublayClient = class _SublayClient {
   connections;
   appNotifications;
   reports;
+  reputation;
   search;
   storage;
   oauth;
@@ -2913,6 +2946,7 @@ var SublayClient = class _SublayClient {
     this.connections = bindModule(connections_exports, this.http);
     this.appNotifications = bindModule(app_notifications_exports, this.http);
     this.reports = bindModule(reports_exports, this.http);
+    this.reputation = bindModule(reputation_exports, this.http);
     this.search = bindModule(search_exports, this.http);
     this.storage = bindModule(storage_exports, this.http);
     this.oauth = bindModule(oauth_exports, this.http);

package/dist/interfaces/ChatMessage.d.ts

@@ -1,3 +1,4 @@
+import { GrantSummary } from "./ReputationGrant";
 import { GifData } from "./Comment";
 import { File } from "./File";
 import { Mention } from "./Mention";
@@ -17,6 +18,13 @@ export interface ChatMessage {
     threadReplyCount: number;
     reactionCounts: Record<string, number>;
     userReactions: string[];
+    /**
+     * Reputation-grant summary. Opt-in — present exactly when the read requested
+     * `include=grants`. Once requested the server always returns the object,
+     * zero-filled rather than omitted, on projects with no grants and on projects
+     * without the reputation bundle alike.
+     */
+    grants?: GrantSummary;
     editedAt: string | null;
     userDeletedAt: string | null;
     moderationStatus: "approved" | "removed" | null;

package/dist/interfaces/Comment.d.ts

@@ -1,3 +1,4 @@
+import { GrantSummary } from "./ReputationGrant";
 import { Entity } from "./Entity";
 import { Mention } from "./Mention";
 import { User } from "./User";
@@ -28,6 +29,13 @@ export interface Comment {
     reactionCounts: ReactionCounts;
     userReaction?: ReactionType | null;
     repliesCount: number;
+    /**
+     * Reputation-grant summary. Opt-in — present exactly when the read requested
+     * `include=grants`. Once requested the server always returns the object,
+     * zero-filled rather than omitted, on projects with no grants and on projects
+     * without the reputation bundle alike.
+     */
+    grants?: GrantSummary;
     metadata: Record<string, any>;
     createdAt: string;
     updatedAt: string;

package/dist/interfaces/Entity.d.ts

@@ -1,3 +1,4 @@
+import { GrantSummary } from "./ReputationGrant";
 import { Mention } from "./Mention";
 import { User } from "./User";
 import { Space } from "./Space";
@@ -43,6 +44,13 @@ export interface Entity {
     nsfwEffective: boolean;
     topComment: TopComment | null;
     isSaved?: boolean;
+    /**
+     * Reputation-grant summary. Opt-in — present exactly when the read requested
+     * `include=grants`. Once requested the server always returns the object,
+     * zero-filled rather than omitted, on projects with no grants and on projects
+     * without the reputation bundle alike.
+     */
+    grants?: GrantSummary;
     isDraft: boolean | null;
     moderationStatus: "approved" | "removed" | null;
     moderatedAt: string | null;

package/dist/interfaces/Push.d.ts

@@ -4,7 +4,7 @@
  * (server `src/constants/push/pushEvents.ts`); these are the only names a
  * `disabledTypes` set may contain.
  */
-export declare const PUSH_EVENT_TYPES: readonly ["entity-comment", "comment-reply", "entity-mention", "comment-mention", "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", "event-invite", "event-updated", "event-cancelled", "message"];
+export declare const PUSH_EVENT_TYPES: readonly ["entity-comment", "comment-reply", "entity-mention", "comment-mention", "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", "event-invite", "event-updated", "event-cancelled", "reputation-grant", "message"];
 export type PushEventType = (typeof PUSH_EVENT_TYPES)[number];
 /**
  * The four conversation-mute duration choices. Send the CHOICE, never a raw

package/dist/interfaces/ReputationGrant.d.ts

@@ -0,0 +1,85 @@
+import { User } from "./User";
+/** The three grantable target kinds. Polymorphic — `targetId` carries no FK. */
+export type ReputationGrantTargetType = "entity" | "comment" | "chat-message";
+/**
+ * Who created the grant. `"user"` is a debited transfer (reputation moved out
+ * of `senderId`'s bucket); `"app"` is a mint issued by the project itself with
+ * a null `senderId`. Persisted rather than inferred from `senderId`, which is
+ * also null for a transfer whose sender was later deleted.
+ */
+export type ReputationGrantSourceType = "user" | "app";
+/**
+ * The "which item was rewarded" pair, as a both-or-neither union.
+ *
+ * Modelled as a two-branch union rather than two independent optional fields so
+ * a half-filled target — `{ targetType }` with no `targetId`, or the reverse —
+ * does not compile. The server answers that shape with
+ * `400 reputation-grant/invalid-body` on the write (a shared
+ * `bothOrNeitherTarget` refinement) and
+ * `400 reputation-grant/invalid-filter` on the list, so the union turns a
+ * guaranteed round trip into a red squiggle.
+ *
+ * The empty branch is `?: undefined`, NOT `?: null` — deliberately, and for the
+ * same reason `metadata` is not nullable: `grantBodyFields.targetType` is
+ * `.optional()` with no `.nullable()`, so an explicit `targetType: null` is
+ * rejected. Omit both keys to mean "no target".
+ *
+ * Building the pair conditionally needs one accommodation: an inline
+ * conditional spread of just these two keys widens both to `T | undefined` and
+ * then matches neither branch. Either branch the whole argument, or name this
+ * type on a helper and spread that:
+ *
+ * ```ts
+ * const target: ReputationGrantTargetFilter = item
+ *   ? { targetType: "entity", targetId: item.id }
+ *   : {};
+ * await listGrants(client, { ...base, ...target });
+ * ```
+ */
+export type ReputationGrantTargetFilter = {
+    /** The kind of item rewarded. Requires `targetId` alongside it. */
+    targetType: ReputationGrantTargetType;
+    /** The rewarded item's id. Requires `targetType` alongside it. */
+    targetId: string;
+} | {
+    targetType?: undefined;
+    targetId?: undefined;
+};
+/**
+ * Per-item reputation-grant summary. Covers positive grants only — negative
+ * grants (app deductions) are invisible on every public read surface.
+ */
+export interface GrantSummary {
+    /** Sum of positive grant amounts on the item. */
+    total: number;
+    /** Number of positive grants on the item. */
+    count: number;
+    /** The calling user's own summed positive grants on the item. */
+    viewerTotal: number;
+}
+/**
+ * A single reputation movement. Rows are append-only — nothing updates or
+ * soft-deletes them — so the table is the audit log behind every balance.
+ */
+export interface ReputationGrant {
+    id: string;
+    sourceType: ReputationGrantSourceType;
+    /** Null for an app mint, and for a transfer whose sender was deleted. */
+    senderId: string | null;
+    /** Populated when the list is called with `include: "user"`. */
+    sender?: User | null;
+    recipientId: string;
+    /** Populated when the list is called with `include: "user"`. */
+    recipient?: User | null;
+    /** Non-zero. Negative only when `sourceType` is `"app"`. */
+    amount: number;
+    /** The bucket both legs moved in; null = the project-general bucket. */
+    spaceId: string | null;
+    /** Both null or both non-null. */
+    targetType: ReputationGrantTargetType | null;
+    targetId: string | null;
+    note: string | null;
+    metadata: Record<string, any> | null;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/interfaces/Workspace.d.ts

@@ -60,6 +60,29 @@ export interface WorkspaceInvitation {
 export interface WorkspaceRosterReason {
     type: "owner" | "member" | "ancestor-owner" | "reach-holder" | "descendant-member";
     rank?: number;
+    /**
+     * The SAME ladder position, expressed as an offset from the CALLER: `1` = one
+     * rung below you, `0` = your peer, `-3` = three rungs above you. The caller's
+     * own anchor is their member row on this workspace if they hold one, and apex
+     * (one step above rank 0) if they do not — so a rank-0 member reads back as
+     * `relativeRank: 1` for an owner.
+     *
+     * Authority-bearing and fenced WITH `rank`, never beside it: it is `rank`
+     * minus a number the caller already knows, so leaking it leaks `rank` exactly.
+     *
+     * Present on same-node `member` reasons only. `descendant-member` entries
+     * carry `rank` but NEVER `relativeRank` — rank is per-workspace, so an offset
+     * measured against your standing on THIS node would be arithmetic across two
+     * different ladders. Use their absolute `rank` there.
+     *
+     * Note the deliberate asymmetry with the fence described above: the FENCE is
+     * per node (a descendant row may or may not carry `rank` depending on your
+     * standing there), but PRESENCE of `relativeRank` is not — it is absent on
+     * every `descendant-member` row, unconditionally, however much authority you
+     * hold. A field that appears and disappears by who is asking is worse to
+     * consume than one that is uniformly absent.
+     */
+    relativeRank?: number;
     capabilities?: WorkspaceCapability[];
     permissions?: string[];
     title?: string | null;
@@ -99,6 +122,13 @@ export interface WorkspaceMemberStanding {
     capabilities?: WorkspaceCapability[];
     permissions?: string[];
     rank?: number | null;
+    /**
+     * `rank` expressed as an offset from the CALLER (negative = senior to you).
+     * `null` exactly when `rank` is `null` — a target with no direct member row
+     * here sits outside the ladder and has no position to measure. Fenced with
+     * `rank`: absent (not null) for a caller who may not see it.
+     */
+    relativeRank?: number | null;
     title: string | null;
     metadata: Record<string, any>;
 }

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

@@ -4,5 +4,10 @@ import { SpaceReputationContextParams } from "../../interfaces/SpaceReputation";
 export interface GetMessageProps extends SpaceReputationContextParams {
     conversationId: string;
     messageId: string;
+    /**
+     * Comma-separated associations to populate. Only `"grants"` is supported
+     * here — it attaches the message's reputation-grant summary.
+     */
+    include?: string;
 }
 export declare function getMessage(client: SublayHttpClient, data: GetMessageProps): Promise<ChatMessage>;

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

@@ -20,7 +20,11 @@ export interface ListMessagesProps extends SpaceReputationContextParams {
     /** Page size (default 50, max 100). */
     limit?: number;
     sort?: "asc" | "desc";
-    /** Comma-separated associations to populate, e.g. "files". */
+    /**
+     * Comma-separated associations to populate: `"files"` (message
+     * attachments) and `"grants"` (the reputation-grant summary). Combine
+     * them as `"files,grants"` — the server splits and trims this itself.
+     */
     include?: string;
     /** Optional filters, e.g. `{ hasReplies: true }`. */
     filters?: MessageFilters;

package/dist/modules/reputation/createGrant.d.ts

@@ -0,0 +1,45 @@
+import { SublayHttpClient } from "../../core/client";
+import { ReputationGrant, ReputationGrantTargetFilter } from "../../interfaces/ReputationGrant";
+interface CreateGrantBaseProps {
+    /** The user receiving the reputation. Cannot be the logged-in user. */
+    recipientId: string;
+    /**
+     * Positive integer. A user transfer can never mint (negatives) nor be a
+     * no-op (zero) — minting is service-key-only and lives in `@sublay/node`.
+     */
+    amount: number;
+    /** The bucket both legs move in. Omitted/null = the project-general bucket. */
+    spaceId?: string | null;
+    /**
+     * Free-text reason. Trimmed and capped at 2000 characters server-side.
+     * Genuinely nullable — an explicit `null` is accepted and means "no note".
+     */
+    note?: string | null;
+    /**
+     * Arbitrary JSON, capped at 1 MB server-side.
+     *
+     * NOT nullable — deliberately asymmetric with `note` directly above, not a
+     * typo. The server's shared `metadataSchema` is `z.record(...).optional()`
+     * with no `.nullable()`, so an explicit `metadata: null` is rejected with
+     * `400 reputation-grant/invalid-body`. Omit the key to mean "no metadata".
+     */
+    metadata?: Record<string, any>;
+}
+/**
+ * `targetType` and `targetId` are supplied together or not at all — the
+ * both-or-neither pair is carried by {@link ReputationGrantTargetFilter}, which
+ * makes the half-filled shape a compile error instead of a
+ * `400 reputation-grant/invalid-body`.
+ */
+export type CreateGrantProps = CreateGrantBaseProps & ReputationGrantTargetFilter;
+/**
+ * Transfers reputation from the logged-in user to another user — a **debited
+ * transfer**: the amount leaves the sender's bucket and lands in the
+ * recipient's bucket in the same space. Nothing is created.
+ *
+ * There is no actor field: the sender is always the user the token belongs to.
+ * Naming somebody else as the sender requires a service key, which this SDK
+ * never holds.
+ */
+export declare function createGrant(client: SublayHttpClient, data: CreateGrantProps): Promise<ReputationGrant>;
+export {};

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

@@ -0,0 +1,2 @@
+export { createGrant } from "./createGrant";
+export { listGrants } from "./listGrants";

package/dist/modules/reputation/listGrants.d.ts

@@ -0,0 +1,45 @@
+import { SublayHttpClient } from "../../core/client";
+import { GrantSummary, ReputationGrant, ReputationGrantTargetFilter } from "../../interfaces/ReputationGrant";
+import { PaginatedResponse } from "../../interfaces/IPaginatedResponse";
+import { SpaceReputationContextParams } from "../../interfaces/SpaceReputation";
+interface ListGrantsBaseProps extends SpaceReputationContextParams {
+    page?: number;
+    limit?: number;
+    /** What this user received. */
+    recipientId?: string;
+    /** What this user sent. */
+    senderId?: string;
+    /** Associations to expand. Only `"user"` is supported (hydrates both parties). */
+    include?: string;
+}
+/**
+ * The third filter shape — "who rewarded this item" — is the
+ * {@link ReputationGrantTargetFilter} pair, so a half-filled target is a
+ * compile error rather than a `400 reputation-grant/invalid-filter`.
+ *
+ * Mutual exclusivity between the three shapes is NOT expressed in the type: a
+ * three-way exclusive union would multiply out across every pagination and
+ * space-reputation field and make the props unreadable, for a rule the server
+ * reports clearly. Only the both-or-neither pairing is typed.
+ */
+export type ListGrantsProps = ListGrantsBaseProps & ReputationGrantTargetFilter;
+/**
+ * The `summary` block rides alongside the page envelope, and only on the
+ * target filter shape.
+ */
+export interface ListGrantsResponse extends PaginatedResponse<ReputationGrant> {
+    summary?: GrantSummary;
+}
+/**
+ * Lists reputation grants.
+ *
+ * Exactly one filter shape per request — `recipientId`, `senderId`, or
+ * `targetType` + `targetId`. Supplying none or combining two is a `400`; the
+ * shapes are not AND-ed, which is what keeps the `summary` block reconcilable
+ * with the rows beneath it.
+ *
+ * Only positive grants are ever returned. Negative grants are app moderation
+ * deductions and are unreadable from every public surface.
+ */
+export declare function listGrants(client: SublayHttpClient, data: ListGrantsProps): Promise<ListGrantsResponse>;
+export {};

package/dist/modules/workspaces/createWorkspaceInvite.d.ts

@@ -7,11 +7,60 @@ export interface CreateWorkspaceInviteProps {
     username?: string;
     capabilities?: WorkspaceCapability[];
     permissions?: string[];
-    rank: number;
+    /**
+     * The invited rank, ABSOLUTE — a position on this workspace's ladder (smaller
+     * = more senior). The escape hatch, and what tier-constant apps want, since
+     * they compute the number anyway.
+     *
+     * Optional, and mutually exclusive with `relativeRank` — sending both is a
+     * 400. Sending NEITHER defaults to `relativeRank: 1`, one rung below the
+     * inviter, which is well defined for every actor and can never fail the rank
+     * floor.
+     *
+     * ⚠️ That default is for a NEW invitation. Re-inviting a target who already
+     * has a live pending invite updates it in place, and there omitting both rank
+     * fields PRESERVES the stored rank instead of re-defaulting it. See the
+     * function doc below.
+     */
+    rank?: number;
+    /**
+     * The invited rank, RELATIVE to the inviter: `1` = one rung below me, `2` =
+     * two rungs below, and so on. The documented happy path — every governance
+     * rule about rank is relative, so this is what callers usually mean.
+     *
+     * Must be `>= 1` on a write. `0` would mean "a peer", which the assign rule
+     * forbids (you cannot clone your own authority), and a negative offset would
+     * mint someone senior to you; both are a 400. Both rank fields are also capped at `2147483647` (int4), and the RESOLVED sum is bounded too — an in-range anchor plus an in-range offset can still overflow, which is a 400 rather than a 500.
+     *
+     * The anchor is the inviter's OWN rank if they hold a member row on this
+     * workspace, and apex (one step above rank 0) if they do not — so an owner's
+     * `relativeRank: 1` lands on rank 0, while a rank-3 member's lands on rank 4.
+     *
+     * ⚠️ A SNAPSHOT, not a live link: the offset is resolved to an absolute rank
+     * once, at invite time, and frozen. It does not track the inviter's later
+     * promotions or demotions.
+     */
+    relativeRank?: number;
     title?: string | null;
 }
 /**
  * Create an invitation (requires the `invite` capability on the workspace). The
  * inviter is the bearer-token user.
+ *
+ * The invited rank comes in either coordinate — `rank` (absolute) or
+ * `relativeRank` (an offset from the inviter) — never both. Omitting both
+ * defaults to `relativeRank: 1`, one rung below the inviter, which is the
+ * documented happy path and can never fail the rank floor.
+ *
+ * ⚠️ This route doubles as an UPSERT, and the default above applies only to a
+ * NEW invitation. Re-inviting a target who already holds a live pending invite
+ * refreshes THAT invitation in place — same id, expiry reset — and on that
+ * branch an omitted grant field is PRESERVED, not re-defaulted or blanked:
+ * `rank`, `capabilities`, `permissions` and `title` all keep their stored
+ * values. A "Resend invitation" button that posts only the address therefore
+ * cannot silently re-rank the invitee to one below whoever clicked it. An
+ * explicit value still overwrites, and an explicit `relativeRank` re-resolves
+ * against the CURRENT caller. Full semantics:
+ * https://docs.sublay.io/api-reference/workspaces/invitations/create-invite
  */
 export declare function createWorkspaceInvite(client: SublayHttpClient, data: CreateWorkspaceInviteProps): Promise<WorkspaceInvitation>;

package/dist/modules/workspaces/deleteWorkspace.d.ts

@@ -7,7 +7,7 @@ export interface DeleteWorkspaceResponse {
 }
 /**
  * Owner-only delete (own owner or an ancestor owner). Cascades the whole
- * subtree transactionally. The actor is the bearer-token user — no `userId`
- * body is sent.
+ * subtree transactionally. The actor is the bearer-token user — no actor
+ * field is sent.
  */
 export declare function deleteWorkspace(client: SublayHttpClient, data: DeleteWorkspaceProps): Promise<DeleteWorkspaceResponse>;