@spacelr/sdk 0.1.7 → 0.1.8

package/dist/index.d.mts

@@ -544,6 +544,21 @@ interface DeleteResult {
 interface FindByIdOptions {
     populate?: PopulateOption[];
 }
+/**
+ * Options for a server-side substring search.
+ *
+ * Limits: `query` 1–200 chars, `fields` 1–10 entries (each matching
+ * `/^[a-zA-Z0-9_.]+$/`, max 64 chars), `limit` max 100.
+ */
+interface SearchOptions {
+    query: string;
+    fields: string[];
+    filter?: Record<string, unknown>;
+    sort?: Record<string, 1 | -1>;
+    limit?: number;
+    offset?: number;
+    select?: string[];
+}
 interface SubscribeHandlers<T = Record<string, unknown>> {
     where?: Record<string, string | number | boolean>;
     onInsert?: (doc: T & {
@@ -586,6 +601,18 @@ declare class CollectionRef<T = Record<string, unknown>> {
         _id?: string;
     })[]): Promise<InsertResult>;
     find(filter?: Record<string, unknown>): QueryBuilder<T>;
+    /**
+     * Server-side substring search across the specified fields.
+     *
+     * The query is regex-escaped server-side and matched case-insensitively via
+     * MongoDB `$regex`. Performance note: unanchored case-insensitive regex
+     * cannot use a standard B-tree index — on very large collections consider
+     * narrowing with `filter` to scope the scan.
+     *
+     * Limits: `query` 1–200 chars, `fields` 1–10 entries (each matching
+     * `/^[a-zA-Z0-9_.]+$/`, max 64 chars), `limit` max 100.
+     */
+    search(opts: SearchOptions): Promise<FindResult<T>>;
     findById(id: string, options?: FindByIdOptions): Promise<T & {
         _id: string;
     }>;
@@ -741,4 +768,4 @@ interface SpacelrClient {
 }
 declare function createClient(config: SpacelrClientConfig): SpacelrClient;
 
-export { type ApiResponse, type AuthLostReason, type AuthorizationUrlParams, BrowserTokenStorage, CodeChallengeMethod, type ConnectionState, type DatabaseChangeEvent, type DownloadUrlResponse, type ExchangeCodeParams, type FileInfo, type FileListResponse, FileVisibility, type FunctionInvokeOptions, type FunctionInvokeResult, GrantType, type InitMultipartUploadParams, type InitMultipartUploadResponse, type JWK, type JWKSResponse, type ListFilesParams, type LoginParams, type LoginResponse, MemoryTokenStorage, type OpenIDConfiguration, type PKCEChallenge, type PartEtag, type PushSubscriptionInfo, type QuotaInfo, type RegisterParams, type RegisterResponse, type ShareFileParams, SharePermission, SpacelrAuthError, type SpacelrClient, type SpacelrClientConfig, SpacelrEmailVerificationRequiredError, SpacelrError, SpacelrNetworkError, SpacelrTimeoutError, SpacelrTwoFactorRequiredError, type StoredTokens, type SubscribeHandlers, type TokenResponse, type TokenStorage, type TwoFactorResponse, type TwoFactorVerifyParams, type UnshareFileParams, type UploadFileParams, type UploadLargeFileParams, type UploadProgress, type UserInfo, type UserProfile, type VapidKeyResponse, createClient, generatePKCEChallenge };
+export { type ApiResponse, type AuthLostReason, type AuthorizationUrlParams, BrowserTokenStorage, CodeChallengeMethod, type ConnectionState, type DatabaseChangeEvent, type DownloadUrlResponse, type ExchangeCodeParams, type FileInfo, type FileListResponse, FileVisibility, type FunctionInvokeOptions, type FunctionInvokeResult, GrantType, type InitMultipartUploadParams, type InitMultipartUploadResponse, type JWK, type JWKSResponse, type ListFilesParams, type LoginParams, type LoginResponse, MemoryTokenStorage, type OpenIDConfiguration, type PKCEChallenge, type PartEtag, type PushSubscriptionInfo, type QuotaInfo, type RegisterParams, type RegisterResponse, type SearchOptions, type ShareFileParams, SharePermission, SpacelrAuthError, type SpacelrClient, type SpacelrClientConfig, SpacelrEmailVerificationRequiredError, SpacelrError, SpacelrNetworkError, SpacelrTimeoutError, SpacelrTwoFactorRequiredError, type StoredTokens, type SubscribeHandlers, type TokenResponse, type TokenStorage, type TwoFactorResponse, type TwoFactorVerifyParams, type UnshareFileParams, type UploadFileParams, type UploadLargeFileParams, type UploadProgress, type UserInfo, type UserProfile, type VapidKeyResponse, createClient, generatePKCEChallenge };

package/dist/index.d.ts

@@ -544,6 +544,21 @@ interface DeleteResult {
 interface FindByIdOptions {
     populate?: PopulateOption[];
 }
+/**
+ * Options for a server-side substring search.
+ *
+ * Limits: `query` 1–200 chars, `fields` 1–10 entries (each matching
+ * `/^[a-zA-Z0-9_.]+$/`, max 64 chars), `limit` max 100.
+ */
+interface SearchOptions {
+    query: string;
+    fields: string[];
+    filter?: Record<string, unknown>;
+    sort?: Record<string, 1 | -1>;
+    limit?: number;
+    offset?: number;
+    select?: string[];
+}
 interface SubscribeHandlers<T = Record<string, unknown>> {
     where?: Record<string, string | number | boolean>;
     onInsert?: (doc: T & {
@@ -586,6 +601,18 @@ declare class CollectionRef<T = Record<string, unknown>> {
         _id?: string;
     })[]): Promise<InsertResult>;
     find(filter?: Record<string, unknown>): QueryBuilder<T>;
+    /**
+     * Server-side substring search across the specified fields.
+     *
+     * The query is regex-escaped server-side and matched case-insensitively via
+     * MongoDB `$regex`. Performance note: unanchored case-insensitive regex
+     * cannot use a standard B-tree index — on very large collections consider
+     * narrowing with `filter` to scope the scan.
+     *
+     * Limits: `query` 1–200 chars, `fields` 1–10 entries (each matching
+     * `/^[a-zA-Z0-9_.]+$/`, max 64 chars), `limit` max 100.
+     */
+    search(opts: SearchOptions): Promise<FindResult<T>>;
     findById(id: string, options?: FindByIdOptions): Promise<T & {
         _id: string;
     }>;
@@ -741,4 +768,4 @@ interface SpacelrClient {
 }
 declare function createClient(config: SpacelrClientConfig): SpacelrClient;
 
-export { type ApiResponse, type AuthLostReason, type AuthorizationUrlParams, BrowserTokenStorage, CodeChallengeMethod, type ConnectionState, type DatabaseChangeEvent, type DownloadUrlResponse, type ExchangeCodeParams, type FileInfo, type FileListResponse, FileVisibility, type FunctionInvokeOptions, type FunctionInvokeResult, GrantType, type InitMultipartUploadParams, type InitMultipartUploadResponse, type JWK, type JWKSResponse, type ListFilesParams, type LoginParams, type LoginResponse, MemoryTokenStorage, type OpenIDConfiguration, type PKCEChallenge, type PartEtag, type PushSubscriptionInfo, type QuotaInfo, type RegisterParams, type RegisterResponse, type ShareFileParams, SharePermission, SpacelrAuthError, type SpacelrClient, type SpacelrClientConfig, SpacelrEmailVerificationRequiredError, SpacelrError, SpacelrNetworkError, SpacelrTimeoutError, SpacelrTwoFactorRequiredError, type StoredTokens, type SubscribeHandlers, type TokenResponse, type TokenStorage, type TwoFactorResponse, type TwoFactorVerifyParams, type UnshareFileParams, type UploadFileParams, type UploadLargeFileParams, type UploadProgress, type UserInfo, type UserProfile, type VapidKeyResponse, createClient, generatePKCEChallenge };
+export { type ApiResponse, type AuthLostReason, type AuthorizationUrlParams, BrowserTokenStorage, CodeChallengeMethod, type ConnectionState, type DatabaseChangeEvent, type DownloadUrlResponse, type ExchangeCodeParams, type FileInfo, type FileListResponse, FileVisibility, type FunctionInvokeOptions, type FunctionInvokeResult, GrantType, type InitMultipartUploadParams, type InitMultipartUploadResponse, type JWK, type JWKSResponse, type ListFilesParams, type LoginParams, type LoginResponse, MemoryTokenStorage, type OpenIDConfiguration, type PKCEChallenge, type PartEtag, type PushSubscriptionInfo, type QuotaInfo, type RegisterParams, type RegisterResponse, type SearchOptions, type ShareFileParams, SharePermission, SpacelrAuthError, type SpacelrClient, type SpacelrClientConfig, SpacelrEmailVerificationRequiredError, SpacelrError, SpacelrNetworkError, SpacelrTimeoutError, SpacelrTwoFactorRequiredError, type StoredTokens, type SubscribeHandlers, type TokenResponse, type TokenStorage, type TwoFactorResponse, type TwoFactorVerifyParams, type UnshareFileParams, type UploadFileParams, type UploadLargeFileParams, type UploadProgress, type UserInfo, type UserProfile, type VapidKeyResponse, createClient, generatePKCEChallenge };

package/dist/index.js

@@ -1413,6 +1413,25 @@ var CollectionRef = class {
   find(filter) {
     return new QueryBuilder(this.http, this.basePath, filter);
   }
+  /**
+   * Server-side substring search across the specified fields.
+   *
+   * The query is regex-escaped server-side and matched case-insensitively via
+   * MongoDB `$regex`. Performance note: unanchored case-insensitive regex
+   * cannot use a standard B-tree index — on very large collections consider
+   * narrowing with `filter` to scope the scan.
+   *
+   * Limits: `query` 1–200 chars, `fields` 1–10 entries (each matching
+   * `/^[a-zA-Z0-9_.]+$/`, max 64 chars), `limit` max 100.
+   */
+  async search(opts) {
+    return this.http.request({
+      method: "POST",
+      path: `${this.basePath}/search`,
+      body: opts,
+      authenticated: true
+    });
+  }
   async findById(id, options) {
     const query = {};
     if (options?.populate?.length) {