@functional-systems/lambdadb 0.2.0 → 0.3.0-dev

package/src/client.ts

@@ -0,0 +1,272 @@
+/**
+ * Collection-scoped facade for LambdaDB API.
+ * Use this client for a better DX: no need to pass collectionName on every call.
+ *
+ * @example
+ * const client = new LambdaDBClient({ projectApiKey: "..." });
+ * const collection = client.collection("my-collection");
+ * await collection.get();
+ * await collection.docs.list({ size: 20 });
+ * await collection.docs.upsert({ docs: [{ id: "1", text: "hello" }] });
+ */
+
+import { LambdaDBCore } from "./core.js";
+import { collectionsCreate } from "./funcs/collectionsCreate.js";
+import { collectionsDelete } from "./funcs/collectionsDelete.js";
+import { collectionsGet } from "./funcs/collectionsGet.js";
+import { collectionsList } from "./funcs/collectionsList.js";
+import { collectionsQuery } from "./funcs/collectionsQuery.js";
+import { collectionsUpdate } from "./funcs/collectionsUpdate.js";
+import { collectionsDocsBulkUpsert } from "./funcs/collectionsDocsBulkUpsert.js";
+import { collectionsDocsDelete } from "./funcs/collectionsDocsDelete.js";
+import { collectionsDocsFetch } from "./funcs/collectionsDocsFetch.js";
+import { collectionsDocsGetBulkUpsert } from "./funcs/collectionsDocsGetBulkUpsert.js";
+import { collectionsDocsListDocs } from "./funcs/collectionsDocsListDocs.js";
+import { collectionsDocsUpdate } from "./funcs/collectionsDocsUpdate.js";
+import { collectionsDocsUpsert } from "./funcs/collectionsDocsUpsert.js";
+import type { RequestOptions } from "./lib/sdks.js";
+import type * as operations from "./models/operations/index.js";
+import type * as models from "./models/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export type { RequestOptions };
+
+// Re-export common types for facade users
+export type { operations, models };
+
+/**
+ * Client with collection-scoped API. Prefer this over the legacy
+ * `LambdaDB` when you want to avoid passing collectionName on every call.
+ */
+export class LambdaDBClient extends LambdaDBCore {
+  /**
+   * Get a handle for a specific collection. All methods on the handle
+   * use this collection name; you do not pass it again.
+   */
+  collection(collectionName: string): CollectionHandle {
+    return new CollectionHandle(this, collectionName);
+  }
+
+  /**
+   * List all collections in the project.
+   */
+  async listCollections(options?: RequestOptions) {
+    return unwrapAsync(collectionsList(this, options));
+  }
+
+  /**
+   * Create a new collection.
+   */
+  async createCollection(
+    request: operations.CreateCollectionRequest,
+    options?: RequestOptions,
+  ) {
+    return unwrapAsync(collectionsCreate(this, request, options));
+  }
+}
+
+/**
+ * Handle for a single collection. All methods operate on this collection.
+ */
+export class CollectionHandle {
+  constructor(
+    private readonly client: LambdaDBCore,
+    readonly collectionName: string,
+  ) {}
+
+  /**
+   * Get metadata of this collection.
+   */
+  async get(options?: RequestOptions) {
+    return unwrapAsync(
+      collectionsGet(this.client, { collectionName: this.collectionName }, options),
+    );
+  }
+
+  /**
+   * Configure (update) this collection.
+   */
+  async update(
+    requestBody: operations.UpdateCollectionRequestBody,
+    options?: RequestOptions,
+  ) {
+    return unwrapAsync(
+      collectionsUpdate(
+        this.client,
+        {
+          collectionName: this.collectionName,
+          requestBody,
+        },
+        options,
+      ),
+    );
+  }
+
+  /**
+   * Delete this collection.
+   */
+  async delete(options?: RequestOptions) {
+    return unwrapAsync(
+      collectionsDelete(
+        this.client,
+        { collectionName: this.collectionName },
+        options,
+      ),
+    );
+  }
+
+  /**
+   * Search this collection with a query.
+   */
+  async query(
+    requestBody: operations.QueryCollectionRequestBody,
+    options?: RequestOptions,
+  ) {
+    return unwrapAsync(
+      collectionsQuery(
+        this.client,
+        {
+          collectionName: this.collectionName,
+          requestBody,
+        },
+        options,
+      ),
+    );
+  }
+
+  readonly docs: CollectionDocs = new CollectionDocs(this.client, this.collectionName);
+}
+
+/**
+ * Document operations scoped to a collection.
+ */
+class CollectionDocs {
+  constructor(
+    private readonly client: LambdaDBCore,
+    private readonly collectionName: string,
+  ) {}
+
+  /**
+   * List documents in the collection.
+   */
+  async list(
+    params?: { size?: number; pageToken?: string },
+    options?: RequestOptions,
+  ) {
+    return unwrapAsync(
+      collectionsDocsListDocs(
+        this.client,
+        { collectionName: this.collectionName, ...params },
+        options,
+      ),
+    );
+  }
+
+  /**
+   * Upsert documents. Max payload 6MB.
+   */
+  async upsert(
+    body: { docs: Array<Record<string, unknown>> },
+    options?: RequestOptions,
+  ): Promise<models.MessageResponse> {
+    return unwrapAsync(
+      collectionsDocsUpsert(
+        this.client,
+        {
+          collectionName: this.collectionName,
+          requestBody: body,
+        },
+        options,
+      ),
+    );
+  }
+
+  /**
+   * Update documents (each doc must have id). Max payload 6MB.
+   */
+  async update(
+    body: { docs: Array<Record<string, unknown>> },
+    options?: RequestOptions,
+  ): Promise<models.MessageResponse> {
+    return unwrapAsync(
+      collectionsDocsUpdate(
+        this.client,
+        {
+          collectionName: this.collectionName,
+          requestBody: body,
+        },
+        options,
+      ),
+    );
+  }
+
+  /**
+   * Delete documents by ids and/or filter.
+   */
+  async delete(
+    body: operations.DeleteDocsRequestBody,
+    options?: RequestOptions,
+  ): Promise<models.MessageResponse> {
+    return unwrapAsync(
+      collectionsDocsDelete(
+        this.client,
+        {
+          collectionName: this.collectionName,
+          requestBody: body,
+        },
+        options,
+      ),
+    );
+  }
+
+  /**
+   * Fetch documents by IDs (max 100).
+   */
+  async fetch(
+    body: operations.FetchDocsRequestBody,
+    options?: RequestOptions,
+  ) {
+    return unwrapAsync(
+      collectionsDocsFetch(
+        this.client,
+        {
+          collectionName: this.collectionName,
+          requestBody: body,
+        },
+        options,
+      ),
+    );
+  }
+
+  /**
+   * Get presigned URL and metadata for bulk upload (up to 200MB).
+   */
+  async getBulkUpsert(options?: RequestOptions) {
+    return unwrapAsync(
+      collectionsDocsGetBulkUpsert(
+        this.client,
+        { collectionName: this.collectionName },
+        options,
+      ),
+    );
+  }
+
+  /**
+   * Trigger bulk upsert with an object key from getBulkUpsert().
+   */
+  async bulkUpsert(
+    body: { objectKey: string },
+    options?: RequestOptions,
+  ): Promise<models.MessageResponse> {
+    return unwrapAsync(
+      collectionsDocsBulkUpsert(
+        this.client,
+        {
+          collectionName: this.collectionName,
+          requestBody: body,
+        },
+        options,
+      ),
+    );
+  }
+}

package/src/index.ts

@@ -7,3 +7,10 @@ export * as files from "./lib/files.js";
 export { HTTPClient } from "./lib/http.js";
 export type { Fetcher, HTTPClientOptions } from "./lib/http.js";
 export * from "./sdk/sdk.js";
+
+/** Collection-scoped client (recommended). See docs/REFACTORING_PROPOSAL.md */
+export {
+  LambdaDBClient,
+  CollectionHandle,
+  type RequestOptions as ClientRequestOptions,
+} from "./client.js";

package/src/lib/config.ts

@@ -71,8 +71,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.1.1",
-  sdkVersion: "0.2.0",
-  genVersion: "2.797.1",
+  sdkVersion: "0.2.1",
+  genVersion: "2.798.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.2.0 2.797.1 1.1.1 @functional-systems/lambdadb",
+    "speakeasy-sdk/typescript 0.2.1 2.798.0 1.1.1 @functional-systems/lambdadb",
 } as const;

package/src/models/operations/fetchdocs.ts

@@ -55,6 +55,14 @@ export type FetchDocsResponse = {
    */
   took: number;
   docs: Array<FetchDocsDoc>;
+  /**
+   * Whether the list of documents is included.
+   */
+  isDocsInline: boolean;
+  /**
+   * Download URL for the list of documents.
+   */
+  docsUrl?: string | undefined;
 };
 
 /** @internal */
@@ -144,6 +152,8 @@ export const FetchDocsResponse$inboundSchema: z.ZodType<
   total: z.number().int(),
   took: z.number().int(),
   docs: z.array(z.lazy(() => FetchDocsDoc$inboundSchema)),
+  isDocsInline: z.boolean(),
+  docsUrl: z.string().optional(),
 });
 
 export function fetchDocsResponseFromJSON(

package/src/models/operations/querycollection.ts

@@ -77,6 +77,14 @@ export type QueryCollectionResponse = {
    * List of documents.
    */
   docs: Array<QueryCollectionDoc>;
+  /**
+   * Whether the list of documents is included.
+   */
+  isDocsInline: boolean;
+  /**
+   * Optional download URL for the list of documents.
+   */
+  docsUrl?: string | undefined;
 };
 
 /** @internal */
@@ -172,6 +180,8 @@ export const QueryCollectionResponse$inboundSchema: z.ZodType<
   maxScore: z.number().optional(),
   total: z.number().int(),
   docs: z.array(z.lazy(() => QueryCollectionDoc$inboundSchema)),
+  isDocsInline: z.boolean(),
+  docsUrl: z.string().optional(),
 });
 
 export function queryCollectionResponseFromJSON(

package/_speakeasy/.github/action-inputs-config.json

@@ -1,53 +0,0 @@
-[
-  {
-    "name": "mode",
-    "validation_regex": "/^(direct|pr)$/.source",
-    "validation_message": "Must be `direct` or `pr`"
-  },
-  {
-    "name": "speakeasy_version",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "openapi_doc_location",
-    "validation_regex": "/^((https?):\\/\\/([\\w\\-]+\\.)+\\w+(\\/.*)?|[\\w.\\-\\/]+)$/i.source",
-    "validation_message": "Must be a valid server URL or file path containing letters, numbers, or .-_/ only"
-  },
-  {
-    "name": "openapi_doc_auth_header",
-    "validation_regex": "/^[A-Za-z\\-]+$/.source",
-    "validation_message": "Letters or - only"
-  },
-  {
-    "name": "create_release"
-  },
-  {
-    "name": "publish_python",
-    "language": "python"
-  },
-  {
-    "name": "publish_typescript",
-    "language": "typescript"
-  },
-  {
-    "name": "publish_java",
-    "language": "java"
-  },
-  {
-    "name": "publish_php",
-    "language": "php"
-  },
-  {
-    "name": "publish_ruby",
-    "language": "ruby"
-  },
-  {
-    "name": "publish_csharp",
-    "language": "csharp"
-  },
-  {
-    "name": "publish_terraform",
-    "language": "terraform"
-  }
-]

package/_speakeasy/.github/action-security-config.json

@@ -1,88 +0,0 @@
-[
-  {
-    "name": "pypi_token",
-    "secret_name": "PYPI_TOKEN",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "python"
-  },
-  {
-    "name": "npm_token",
-    "secret_name": "NPM_TOKEN",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "typescript"
-  },
-  {
-    "name": "packagist_username",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "php"
-  },
-  {
-    "name": "packagist_token",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "php"
-  },
-  {
-    "name": "openapi_doc_auth_token",
-    "secret_name": "SPEC_TOKEN",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "speakeasy_api_key",
-    "secret_name": "SPEAKEASY_API_KEY",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "ossrh_username",
-    "secret_name": "MAVEN_USERNAME",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "java"
-  },
-  {
-    "name": "ossrh_password",
-    "secret_name": "MAVEN_PASSWORD",
-    "language": "java"
-  },
-  {
-    "name": "java_gpg_secret_key",
-    "validation_regex": "/^[\\w.\\-\\t \\r\\n]+$/.source",
-    "validation_message": "Letters, numbers, tabs, spaces, newlines, or .-_ only",
-    "language": "java"
-  },
-  {
-    "name": "java_gpg_passphrase",
-    "language": "java"
-  },
-  {
-    "name": "terraform_gpg_secret_key",
-    "secret_name": "TERRAFORM_GPG_SECRET_KEY",
-    "validation_regex": "/^[\\w.\\-\\t \\r\\n]+$/.source",
-    "validation_message": "Letters, numbers, tabs, spaces, newlines, or .-_ only",
-    "language": "terraform"
-  },
-  {
-    "name": "terraform_gpg_passphrase",
-    "secret_name": "TERRAFORM_GPG_PASSPHRASE",
-    "language": "terraform"
-  },
-  {
-    "name": "rubygems_auth_token",
-    "secret_name": "RUBYGEMS_AUTH_TOKEN",
-    "language": "ruby"
-  },
-  {
-    "name": "nuget_api_key",
-    "secret_name": "NUGET_API_KEY",
-    "language": "csharp"
-  },
-  {
-    "name": "slack_webhook_url",
-    "secret_name": "SLACK_WEBHOOK_URL"
-  }
-]