@sublay/js 7.3.0 → 7.4.0

package/dist/core/spaceReputationParams.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Input accepted by {@link buildSpaceReputationParams}: either the new
+ * `spaceReputation` object or the deprecated flat props.
+ *
+ * The flat inputs accept `null` (in addition to `undefined`) so the helper's
+ * contract matches `@sublay/core` and `@sublay/node` exactly; `null` is treated
+ * as unset. js-sdk never persists these params, so the `null` tolerance is not
+ * strictly required here, but matching the sibling helpers is harmless and
+ * consistent.
+ */
+export interface BuildSpaceReputationParamsInput {
+    spaceReputation?: {
+        spaceId: string | "none" | "context";
+        includeDescendants?: boolean;
+    };
+    /**
+     * @deprecated Pass `spaceReputation` instead. Accepted for back-compat.
+     */
+    spaceReputationId?: string | null;
+    /**
+     * @deprecated Pass `spaceReputation` instead. Accepted for back-compat.
+     */
+    spaceReputationDescendants?: boolean | null;
+}
+/**
+ * Flat output handed to the query-string serializer (axios `params` or the
+ * `askContent` `URLSearchParams`). Both keys are omitted when unset — never
+ * bracketed, never nested.
+ */
+export interface SpaceReputationFlatParams {
+    spaceReputationId?: string;
+    spaceReputationDescendants?: boolean;
+}
+/**
+ * Normalize the `spaceReputation` object or the deprecated flat props down to
+ * the flat query params the server understands
+ * (`spaceReputationId` / `spaceReputationDescendants`).
+ *
+ * **Critical:** this is the only thing that prevents the nested
+ * `spaceReputation` object from reaching a query-string serializer. Axios would
+ * bracket-encode it (`spaceReputation[spaceId]=…`) and the `askContent`
+ * `URLSearchParams` path would stringify it to `[object Object]`; the server
+ * ignores both — silently no-opping the new (primary) form. Every
+ * reputation-consuming module must route the object through here and merge only
+ * the flat output.
+ *
+ * Rules (mirrors the `@sublay/core` / `@sublay/node` helper contract):
+ * - **Object wins when present.** "Present" means the `spaceReputation` key was
+ *   supplied at all (`spaceReputation !== undefined`) — even `{}` or a partial
+ *   object suppresses the flat props.
+ * - When **both** the object and a flat prop are supplied, the object wins and a
+ *   one-time dev-only `console.warn` fires (never throws).
+ * - The flat inputs tolerate `null` (treated as unset → param omitted).
+ * - Output keys are omitted when unset; the result is always the two flat keys,
+ *   never a bracketed/nested object.
+ */
+export declare function buildSpaceReputationParams(input: BuildSpaceReputationParamsInput): SpaceReputationFlatParams;

package/dist/index.d.mts

@@ -322,18 +322,37 @@ declare namespace Auth {
  */
 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"`).
@@ -345,18 +364,37 @@ interface SpaceReputationContextParams {
  */
 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>`.
      */
@@ -2530,6 +2568,12 @@ 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;
 }
@@ -2564,6 +2608,12 @@ 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). */
@@ -2610,12 +2660,48 @@ type AskContentEvent = {
  */
 declare function askContent(client: SublayHttpClient, data: AskContentProps): AsyncGenerator<AskContentEvent, void, unknown>;
 
+interface MatchUsersProps {
+    mode: "passive" | "directed";
+    query?: string;
+    limit?: number;
+    spaceId?: string;
+    includeChildSpaces?: boolean;
+    includeSampleContent?: boolean;
+    excludeSelf?: boolean;
+}
+interface MatchFacetRef {
+    id: string;
+    hotness: number;
+}
+interface SampleContent {
+    sourceType: "entity" | "comment" | "message";
+    recordId: string;
+    content: string;
+    similarity: number;
+}
+interface MatchedFacet {
+    similarity: number;
+    askerFacet?: MatchFacetRef;
+    candidateFacet: MatchFacetRef;
+    sampleContent?: SampleContent[];
+}
+interface UserMatchResult {
+    user: User;
+    score: number;
+    matchedFacets: MatchedFacet[];
+}
+interface MatchUsersResponse {
+    results: UserMatchResult[];
+}
+declare function matchUsers(client: SublayHttpClient, data: MatchUsersProps): Promise<MatchUsersResponse>;
+
 declare const Search_askContent: typeof askContent;
+declare const Search_matchUsers: typeof matchUsers;
 declare const Search_searchContent: typeof searchContent;
 declare const Search_searchSpaces: typeof searchSpaces;
 declare const Search_searchUsers: typeof searchUsers;
 declare namespace Search {
-  export { Search_askContent as askContent, Search_searchContent as searchContent, Search_searchSpaces as searchSpaces, Search_searchUsers as searchUsers };
+  export { Search_askContent as askContent, Search_matchUsers as matchUsers, Search_searchContent as searchContent, Search_searchSpaces as searchSpaces, Search_searchUsers as searchUsers };
 }
 
 interface UploadedImageVariant {