@sublay/js 7.3.0 → 7.4.1

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>`.
      */
@@ -517,7 +555,21 @@ interface PaginatedResponse<T> {
     pagination: PaginationMetadata;
 }
 
-interface FetchFollowersByUserIdProps extends SpaceReputationUserParams {
+/**
+ * Shared optional params for text-searching a list of users
+ * (followers / following / connections).
+ *
+ * - `query` — free-text search term. When omitted, no filtering is applied.
+ * - `searchFields` — narrows which user field the term matches against. When
+ *   omitted, the term matches either `username` OR `name` (case-insensitive
+ *   substring). `"username"` / `"name"` restrict the match to that one field.
+ */
+interface UserSearchParams {
+    query?: string;
+    searchFields?: "username" | "name";
+}
+
+interface FetchFollowersByUserIdProps extends SpaceReputationUserParams, UserSearchParams {
     userId: string;
     page?: number;
     limit?: number;
@@ -532,7 +584,7 @@ interface FollowersCountResponse$1 {
 }
 declare function fetchFollowersCountByUserId(client: SublayHttpClient, data: FetchFollowersCountByUserIdProps): Promise<FollowersCountResponse$1>;
 
-interface FetchFollowingByUserIdProps extends SpaceReputationUserParams {
+interface FetchFollowingByUserIdProps extends SpaceReputationUserParams, UserSearchParams {
     userId: string;
     page?: number;
     limit?: number;
@@ -606,7 +658,7 @@ interface ConnectionStatusDeclined {
 }
 type ConnectionStatusResponse = ConnectionStatusNone | ConnectionStatusPending | ConnectionStatusConnected | ConnectionStatusDeclined;
 
-interface FetchConnectionsByUserIdProps extends SpaceReputationUserParams {
+interface FetchConnectionsByUserIdProps extends SpaceReputationUserParams, UserSearchParams {
     userId: string;
     page?: number;
     limit?: number;
@@ -2110,13 +2162,13 @@ declare namespace Collections {
   export { Collections_addEntityToCollection as addEntityToCollection, Collections_createNewCollection as createNewCollection, Collections_deleteCollection as deleteCollection, Collections_fetchCollectionEntities as fetchCollectionEntities, Collections_fetchRootCollection as fetchRootCollection, Collections_fetchSubCollections as fetchSubCollections, Collections_removeEntityFromCollection as removeEntityFromCollection, Collections_updateCollection as updateCollection };
 }
 
-interface FetchFollowingProps {
+interface FetchFollowingProps extends UserSearchParams {
     page?: number;
     limit?: number;
 }
 declare function fetchFollowing(client: SublayHttpClient, data: FetchFollowingProps): Promise<PaginatedResponse<FollowListItem>>;
 
-interface FetchFollowersProps {
+interface FetchFollowersProps extends UserSearchParams {
     page?: number;
     limit?: number;
 }
@@ -2146,7 +2198,7 @@ declare namespace Follows {
   export { Follows_deleteFollow as deleteFollow, Follows_fetchFollowers as fetchFollowers, Follows_fetchFollowersCount as fetchFollowersCount, Follows_fetchFollowing as fetchFollowing, Follows_fetchFollowingCount as fetchFollowingCount };
 }
 
-interface FetchConnectionsProps {
+interface FetchConnectionsProps extends UserSearchParams {
     page?: number;
     limit?: number;
 }
@@ -2530,6 +2582,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 +2622,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 +2674,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 {
@@ -3172,4 +3272,4 @@ declare class SublayClient {
     clearTokens(): void;
 }
 
-export { type AuthTokens, type BulkDeleteProps, type BulkDeleteResult, type ClientConfig, type DbFilter, type DbFilterOperator, type DeleteResult, type PaginatedResponse, type PaginationMetadata, type SpaceReputationContextParams, type SpaceReputationUserParams, SublayClient, type TableAccessor, type TableQuery, type TableRow };
+export { type AuthTokens, type BulkDeleteProps, type BulkDeleteResult, type ClientConfig, type DbFilter, type DbFilterOperator, type DeleteResult, type PaginatedResponse, type PaginationMetadata, type SpaceReputationContextParams, type SpaceReputationUserParams, SublayClient, type TableAccessor, type TableQuery, type TableRow, type UserSearchParams };

package/dist/index.d.ts

@@ -51,4 +51,5 @@ export declare class SublayClient {
 export type { ClientConfig, AuthTokens } from "./core/client";
 export type { PaginatedResponse, PaginationMetadata, } from "./interfaces/IPaginatedResponse";
 export type { SpaceReputationContextParams, SpaceReputationUserParams, } from "./interfaces/SpaceReputation";
+export type { UserSearchParams } from "./interfaces/UserSearch";
 export type { TableAccessor, TableRow, TableQuery, DbFilter, DbFilterOperator, BulkDeleteProps, DeleteResult, BulkDeleteResult, } from "./interfaces/Table";