@functional-systems/lambdadb 0.4.2 → 0.5.0-rc.1

package/src/models/operations/createcollection.ts

@@ -13,30 +13,38 @@ export type CreateCollectionRequest = {
    * Collection name must be unique within a project and the supported maximum length is 52.
    */
   collectionName: string;
-  indexConfigs?: { [k: string]: models.IndexConfigsUnion } | undefined;
+  indexConfigs: { [k: string]: models.IndexConfigsUnion };
+  description?: string | undefined;
+  tags?: Record<string, string> | undefined;
   partitionConfig?: models.PartitionConfig | undefined;
-  sourceProjectName?: string | undefined;
-  sourceCollectionName?: string | undefined;
-  sourceDatetime?: string | undefined;
-  sourceProjectApiKey?: string | undefined;
+  snapshotRetentionInDays?: number | undefined;
+};
+
+export type CreatedCollection = {
+  collectionName: string;
+  description: string;
+  tags: Record<string, string>;
+  defaultBranchName: "main";
+  snapshotRetentionInDays: number;
+  /** Collection creation time as Unix epoch milliseconds. */
+  createdAt: number;
 };
 
 /**
  * Created collection
  */
 export type CreateCollectionResponse = {
-  collection: models.CollectionResponse;
+  collection: CreatedCollection;
 };
 
 /** @internal */
 export type CreateCollectionRequest$Outbound = {
   collectionName: string;
-  indexConfigs?: { [k: string]: models.IndexConfigsUnion$Outbound } | undefined;
+  indexConfigs: { [k: string]: models.IndexConfigsUnion$Outbound };
+  description?: string | undefined;
+  tags?: Record<string, string> | undefined;
   partitionConfig?: models.PartitionConfig$Outbound | undefined;
-  sourceProjectName?: string | undefined;
-  sourceCollectionName?: string | undefined;
-  sourceDatetime?: string | undefined;
-  sourceProjectApiKey?: string | undefined;
+  snapshotRetentionInDays?: number | undefined;
 };
 
 /** @internal */
@@ -45,13 +53,19 @@ export const CreateCollectionRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateCollectionRequest
 > = z.object({
-  collectionName: z.string(),
-  indexConfigs: z.record(models.IndexConfigsUnion$outboundSchema).optional(),
+  collectionName: z.string().regex(/^[a-zA-Z0-9_-]{3,52}$/),
+  indexConfigs: z.record(models.IndexConfigsUnion$outboundSchema),
+  description: z.string().max(255).optional(),
+  tags: z.record(
+    z.string().min(1).max(127).regex(/^[^:#,]+$/),
+  ).refine((value) => Object.keys(value).length <= 5, {
+    message: "Collection tags support at most five entries",
+  }).refine(
+    (value) => Object.keys(value).every((key) => /^[A-Za-z0-9_.-]{1,63}$/.test(key)),
+    { message: "Invalid collection tag key" },
+  ).optional(),
   partitionConfig: models.PartitionConfig$outboundSchema.optional(),
-  sourceProjectName: z.string().optional(),
-  sourceCollectionName: z.string().optional(),
-  sourceDatetime: z.string().optional(),
-  sourceProjectApiKey: z.string().optional(),
+  snapshotRetentionInDays: z.number().int().min(1).max(31).optional(),
 });
 
 export function createCollectionRequestToJSON(
@@ -68,7 +82,14 @@ export const CreateCollectionResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  collection: models.CollectionResponse$inboundSchema,
+  collection: z.object({
+    collectionName: z.string(),
+    description: z.string(),
+    tags: z.record(z.string()),
+    defaultBranchName: z.literal("main"),
+    snapshotRetentionInDays: z.number().int().min(1).max(31),
+    createdAt: z.number().int(),
+  }),
 });
 
 export function createCollectionResponseFromJSON(

package/src/models/operations/deletedocs.ts

@@ -16,6 +16,8 @@ export type DeleteDocsRequestBody = {
    */
   filter?: { [k: string]: any } | undefined;
   partitionFilter?: models.PartitionFilter | undefined;
+  /** Write target Branch. Omitting it writes to main. */
+  branch?: string | undefined;
 };
 
 export type DeleteDocsRequest = {
@@ -31,6 +33,7 @@ export type DeleteDocsRequestBody$Outbound = {
   ids?: Array<string> | undefined;
   filter?: { [k: string]: any } | undefined;
   partitionFilter?: models.PartitionFilter$Outbound | undefined;
+  branch?: string | undefined;
 };
 
 /** @internal */
@@ -42,6 +45,7 @@ export const DeleteDocsRequestBody$outboundSchema: z.ZodType<
   ids: z.array(z.string()).optional(),
   filter: z.record(z.any()).optional(),
   partitionFilter: models.PartitionFilter$outboundSchema.optional(),
+  branch: z.string().regex(/^[a-zA-Z0-9_-]{3,52}$/).optional(),
 });
 
 export function deleteDocsRequestBodyToJSON(

package/src/models/operations/fetchdocs.ts

@@ -27,6 +27,8 @@ export type FetchDocsRequestBody = {
    */
   fields?: models.FieldsSelectorUnion | undefined;
   partitionFilter?: models.PartitionFilter | undefined;
+  /** Read target. Omitting it reads from main. */
+  ref?: models.ReadRef | undefined;
 };
 
 export type FetchDocsRequest = {
@@ -72,6 +74,7 @@ export type FetchDocsRequestBody$Outbound = {
   includeVectors: boolean;
   fields?: models.FieldsSelectorUnion$Outbound | undefined;
   partitionFilter?: models.PartitionFilter$Outbound | undefined;
+  ref?: models.ReadRef | undefined;
 };
 
 /** @internal */
@@ -85,6 +88,15 @@ export const FetchDocsRequestBody$outboundSchema: z.ZodType<
   includeVectors: z.boolean().default(false),
   fields: models.FieldsSelectorUnion$outboundSchema.optional(),
   partitionFilter: models.PartitionFilter$outboundSchema.optional(),
+  ref: models.ReadRef$schema.optional(),
+}).superRefine((value, context) => {
+  if (value.consistentRead && value.ref != null && value.ref.kind !== "branch") {
+    context.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "consistentRead is supported only for direct Branch reads",
+      path: ["consistentRead"],
+    });
+  }
 });
 
 export function fetchDocsRequestBodyToJSON(

package/src/models/operations/getbulkupsertdocs.ts

@@ -3,7 +3,7 @@
  */
 
 import * as z from "zod/v3";
-import { nullToUndefined, safeParse } from "../../lib/schemas.js";
+import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -13,6 +13,8 @@ export type GetBulkUpsertDocsRequest = {
    * Collection name.
    */
   collectionName: string;
+  /** Write target Branch. Omitting it writes to main. */
+  branch?: string | undefined;
 };
 
 /**
@@ -61,11 +63,14 @@ export type GetBulkUpsertDocsResponse = {
    * Object size limit in bytes.
    */
   sizeLimitBytes: number;
+  /** Signed headers to forward unchanged to the presigned upload URL. */
+  headers: Record<string, string>;
 };
 
 /** @internal */
 export type GetBulkUpsertDocsRequest$Outbound = {
   collectionName: string;
+  branch?: string | undefined;
 };
 
 /** @internal */
@@ -75,6 +80,7 @@ export const GetBulkUpsertDocsRequest$outboundSchema: z.ZodType<
   GetBulkUpsertDocsRequest
 > = z.object({
   collectionName: z.string(),
+  branch: z.string().regex(/^[a-zA-Z0-9_-]{3,52}$/).optional(),
 });
 
 export function getBulkUpsertDocsRequestToJSON(
@@ -101,10 +107,11 @@ export const GetBulkUpsertDocsResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   url: z.string(),
-  type: nullToUndefined(Type$inboundSchema.default("application/json")),
-  httpMethod: nullToUndefined(HttpMethod$inboundSchema.default("PUT")),
+  type: Type$inboundSchema,
+  httpMethod: HttpMethod$inboundSchema,
   objectKey: z.string(),
-  sizeLimitBytes: nullToUndefined(z.number().int().default(209715200)),
+  sizeLimitBytes: z.number().int(),
+  headers: z.record(z.string()),
 });
 
 export function getBulkUpsertDocsResponseFromJSON(

package/src/models/operations/listdocs.ts

@@ -3,9 +3,11 @@
  */
 
 import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
 import { nullToUndefined, safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
 
 export type ListDocsRequest = {
   /**
@@ -20,6 +22,14 @@ export type ListDocsRequest = {
    * Next page token.
    */
   pageToken?: string | undefined;
+  /**
+   * Set to true to include vector values in the response. Defaults to false.
+   */
+  includeVectors?: boolean | undefined;
+  /** Read ref kind. Must be supplied together with refName. */
+  refKind?: models.ReadRef["kind"] | undefined;
+  /** Read ref name. Must be supplied together with refKind. */
+  refName?: string | undefined;
 };
 
 export type ListDocsDoc = {
@@ -52,6 +62,9 @@ export type ListDocsRequest$Outbound = {
   collectionName: string;
   size?: number | undefined;
   pageToken?: string | undefined;
+  includeVectors: boolean;
+  refKind?: models.ReadRef["kind"] | undefined;
+  refName?: string | undefined;
 };
 
 /** @internal */
@@ -63,6 +76,17 @@ export const ListDocsRequest$outboundSchema: z.ZodType<
   collectionName: z.string(),
   size: z.number().int().optional(),
   pageToken: z.string().optional(),
+  includeVectors: z.boolean().default(false),
+  refKind: z.enum(["branch", "tag", "alias"]).optional(),
+  refName: z.string().regex(/^[a-zA-Z0-9_-]{3,52}$/).optional(),
+}).superRefine((value, context) => {
+  if ((value.refKind == null) !== (value.refName == null)) {
+    context.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "refKind and refName must be supplied together",
+      path: [value.refKind == null ? "refKind" : "refName"],
+    });
+  }
 });
 
 export function listDocsRequestToJSON(
@@ -71,6 +95,102 @@ export function listDocsRequestToJSON(
   return JSON.stringify(ListDocsRequest$outboundSchema.parse(listDocsRequest));
 }
 
+export type ListDocsExtendedRequestBody = {
+  /**
+   * Max number of documents to return at once.
+   */
+  size?: number | undefined;
+  /**
+   * Next page token.
+   */
+  pageToken?: string | undefined;
+  /**
+   * Filter applied before pagination.
+   */
+  filter?: { [k: string]: any } | undefined;
+  partitionFilter?: models.PartitionFilter | undefined;
+  /**
+   * An object to specify a list of field names to include and/or exclude in the result.
+   */
+  fields?: models.FieldsSelectorUnion | undefined;
+  /**
+   * Set to true to include vector values in the response. Defaults to false.
+   */
+  includeVectors?: boolean | undefined;
+  /** Read target. Omitting it reads from main. */
+  ref?: models.ReadRef | undefined;
+};
+
+export type ListDocsExtendedRequest = {
+  /**
+   * Collection name.
+   */
+  collectionName: string;
+  requestBody: ListDocsExtendedRequestBody;
+};
+
+/** @internal */
+export type ListDocsExtendedRequestBody$Outbound = {
+  size?: number | undefined;
+  pageToken?: string | undefined;
+  filter?: { [k: string]: any } | undefined;
+  partitionFilter?: models.PartitionFilter$Outbound | undefined;
+  fields?: models.FieldsSelectorUnion$Outbound | undefined;
+  includeVectors: boolean;
+  ref?: models.ReadRef | undefined;
+};
+
+/** @internal */
+export const ListDocsExtendedRequestBody$outboundSchema: z.ZodType<
+  ListDocsExtendedRequestBody$Outbound,
+  z.ZodTypeDef,
+  ListDocsExtendedRequestBody
+> = z.object({
+  size: z.number().int().optional(),
+  pageToken: z.string().optional(),
+  filter: z.record(z.any()).optional(),
+  partitionFilter: models.PartitionFilter$outboundSchema.optional(),
+  fields: models.FieldsSelectorUnion$outboundSchema.optional(),
+  includeVectors: z.boolean().default(false),
+  ref: models.ReadRef$schema.optional(),
+});
+
+export function listDocsExtendedRequestBodyToJSON(
+  listDocsExtendedRequestBody: ListDocsExtendedRequestBody,
+): string {
+  return JSON.stringify(
+    ListDocsExtendedRequestBody$outboundSchema.parse(listDocsExtendedRequestBody),
+  );
+}
+
+/** @internal */
+export type ListDocsExtendedRequest$Outbound = {
+  collectionName: string;
+  RequestBody: ListDocsExtendedRequestBody$Outbound;
+};
+
+/** @internal */
+export const ListDocsExtendedRequest$outboundSchema: z.ZodType<
+  ListDocsExtendedRequest$Outbound,
+  z.ZodTypeDef,
+  ListDocsExtendedRequest
+> = z.object({
+  collectionName: z.string(),
+  requestBody: z.lazy(() => ListDocsExtendedRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function listDocsExtendedRequestToJSON(
+  listDocsExtendedRequest: ListDocsExtendedRequest,
+): string {
+  return JSON.stringify(
+    ListDocsExtendedRequest$outboundSchema.parse(listDocsExtendedRequest),
+  );
+}
+
 /** @internal */
 export const ListDocsDoc$inboundSchema: z.ZodType<
   ListDocsDoc,

package/src/models/operations/querycollection.ts

@@ -35,6 +35,8 @@ export type QueryCollectionRequestBody = {
    */
   fields?: models.FieldsSelectorUnion | undefined;
   partitionFilter?: models.PartitionFilter | undefined;
+  /** Read target. Omitting it reads from main. */
+  ref?: models.ReadRef | undefined;
 };
 
 export type QueryCollectionRequest = {
@@ -96,6 +98,7 @@ export type QueryCollectionRequestBody$Outbound = {
   sort?: Array<{ [k: string]: any }> | undefined;
   fields?: models.FieldsSelectorUnion$Outbound | undefined;
   partitionFilter?: models.PartitionFilter$Outbound | undefined;
+  ref?: models.ReadRef | undefined;
 };
 
 /** @internal */
@@ -111,6 +114,15 @@ export const QueryCollectionRequestBody$outboundSchema: z.ZodType<
   sort: z.array(z.record(z.any())).optional(),
   fields: models.FieldsSelectorUnion$outboundSchema.optional(),
   partitionFilter: models.PartitionFilter$outboundSchema.optional(),
+  ref: models.ReadRef$schema.optional(),
+}).superRefine((value, context) => {
+  if (value.consistentRead && value.ref != null && value.ref.kind !== "branch") {
+    context.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "consistentRead is supported only for direct Branch reads",
+      path: ["consistentRead"],
+    });
+  }
 });
 
 export function queryCollectionRequestBodyToJSON(

package/src/models/operations/updatecollection.ts

@@ -10,7 +10,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as models from "../index.js";
 
 export type UpdateCollectionRequestBody = {
-  indexConfigs: { [k: string]: models.IndexConfigsUnion };
+  indexConfigs?: { [k: string]: models.IndexConfigsUnion } | undefined;
+  description?: string | undefined;
+  tags?: Record<string, string> | undefined;
+  snapshotRetentionInDays?: number | undefined;
 };
 
 export type UpdateCollectionRequest = {
@@ -30,7 +33,10 @@ export type UpdateCollectionResponse = {
 
 /** @internal */
 export type UpdateCollectionRequestBody$Outbound = {
-  indexConfigs: { [k: string]: models.IndexConfigsUnion$Outbound };
+  indexConfigs?: { [k: string]: models.IndexConfigsUnion$Outbound } | undefined;
+  description?: string | undefined;
+  tags?: Record<string, string> | undefined;
+  snapshotRetentionInDays?: number | undefined;
 };
 
 /** @internal */
@@ -39,7 +45,19 @@ export const UpdateCollectionRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateCollectionRequestBody
 > = z.object({
-  indexConfigs: z.record(models.IndexConfigsUnion$outboundSchema),
+  indexConfigs: z.record(models.IndexConfigsUnion$outboundSchema).optional(),
+  description: z.string().max(255).optional(),
+  tags: z.record(
+    z.string().min(1).max(127).regex(/^[^:#,]+$/),
+  ).refine((value) => Object.keys(value).length <= 5, {
+    message: "Collection tags support at most five entries",
+  }).refine(
+    (value) => Object.keys(value).every((key) => /^[A-Za-z0-9_.-]{1,63}$/.test(key)),
+    { message: "Invalid collection tag key" },
+  ).optional(),
+  snapshotRetentionInDays: z.number().int().min(1).max(31).optional(),
+}).refine((value) => Object.values(value).some((item) => item !== undefined), {
+  message: "At least one collection field must be provided",
 });
 
 export function updateCollectionRequestBodyToJSON(

package/src/models/operations/updatedocs.ts

@@ -10,6 +10,8 @@ export type UpdateDocsRequestBody = {
    * A list of documents to update. Each document must contain 'id' field to be updated. For managed embedding vector fields, omit the managed vector field and update only the configured source text field.
    */
   docs: Array<{ [k: string]: any }>;
+  /** Write target Branch. Omitting it writes to main. */
+  branch?: string | undefined;
 };
 
 export type UpdateDocsRequest = {
@@ -23,6 +25,7 @@ export type UpdateDocsRequest = {
 /** @internal */
 export type UpdateDocsRequestBody$Outbound = {
   docs: Array<{ [k: string]: any }>;
+  branch?: string | undefined;
 };
 
 /** @internal */
@@ -32,6 +35,7 @@ export const UpdateDocsRequestBody$outboundSchema: z.ZodType<
   UpdateDocsRequestBody
 > = z.object({
   docs: z.array(z.record(z.any())),
+  branch: z.string().regex(/^[a-zA-Z0-9_-]{3,52}$/).optional(),
 });
 
 export function updateDocsRequestBodyToJSON(

package/src/models/operations/upsertdocs.ts

@@ -10,6 +10,8 @@ export type UpsertDocsRequestBody = {
    * A list of documents to upsert. For managed embedding vector fields, omit the managed vector field and provide only the configured source text field.
    */
   docs: Array<{ [k: string]: any }>;
+  /** Write target Branch. Omitting it writes to main. */
+  branch?: string | undefined;
 };
 
 export type UpsertDocsRequest = {
@@ -23,6 +25,7 @@ export type UpsertDocsRequest = {
 /** @internal */
 export type UpsertDocsRequestBody$Outbound = {
   docs: Array<{ [k: string]: any }>;
+  branch?: string | undefined;
 };
 
 /** @internal */
@@ -32,6 +35,7 @@ export const UpsertDocsRequestBody$outboundSchema: z.ZodType<
   UpsertDocsRequestBody
 > = z.object({
   docs: z.array(z.record(z.any())),
+  branch: z.string().regex(/^[a-zA-Z0-9_-]{3,52}$/).optional(),
 });
 
 export function upsertDocsRequestBodyToJSON(

package/src/models/versioning.ts

@@ -0,0 +1,118 @@
+import * as z from "zod/v3";
+
+const refNameSchema = z.string().regex(/^[a-zA-Z0-9_-]{3,52}$/);
+
+export type BranchRef = {
+  kind: "branch";
+  name: string;
+};
+
+export type TagRef = {
+  kind: "tag";
+  name: string;
+};
+
+export type AliasRef = {
+  kind: "alias";
+  name: string;
+};
+
+/** A Branch, Tag, or Alias used to select document reads. */
+export type ReadRef = BranchRef | TagRef | AliasRef;
+
+export type BranchSource = BranchRef & {
+  /** Latest committed snapshot cutoff as Unix epoch milliseconds. */
+  asOf?: number | undefined;
+};
+
+export type TagSource = TagRef;
+
+/** A Branch or Tag used as the source of a new Branch or Tag. */
+export type RefSource = BranchSource | TagSource;
+
+/** A Branch or Tag used as the target of an Alias. */
+export type AliasTarget = BranchRef | TagRef;
+
+export type RefDetails = {
+  name: string;
+  snapshotId: string | null;
+  /** Ref creation time as Unix epoch milliseconds. */
+  createdAt: number;
+};
+
+export type AliasTargetKind = "BRANCH" | "TAG";
+
+export type AliasDetails = {
+  aliasId: string;
+  aliasName: string;
+  targetKind: AliasTargetKind;
+  targetName: string;
+  targetId: string;
+  aliasRevision: number;
+  dangling: boolean;
+  /** Alias creation time as Unix epoch milliseconds. */
+  createdAt: number;
+};
+
+/** @internal */
+export const BranchRef$schema = z.object({
+  kind: z.literal("branch"),
+  name: refNameSchema,
+}).strict();
+
+/** @internal */
+export const TagRef$schema = z.object({
+  kind: z.literal("tag"),
+  name: refNameSchema,
+}).strict();
+
+/** @internal */
+export const AliasRef$schema = z.object({
+  kind: z.literal("alias"),
+  name: refNameSchema,
+}).strict();
+
+/** @internal */
+export const ReadRef$schema: z.ZodType<ReadRef> = z.discriminatedUnion("kind", [
+  BranchRef$schema,
+  TagRef$schema,
+  AliasRef$schema,
+]);
+
+/** @internal */
+export const BranchSource$schema = z.object({
+  kind: z.literal("branch"),
+  name: refNameSchema,
+  asOf: z.number().int().optional(),
+}).strict();
+
+/** @internal */
+export const RefSource$schema: z.ZodType<RefSource> = z.union([
+  BranchSource$schema,
+  TagRef$schema,
+]);
+
+/** @internal */
+export const AliasTarget$schema: z.ZodType<AliasTarget> = z.union([
+  BranchRef$schema,
+  TagRef$schema,
+]);
+
+/** @internal */
+export const RefDetails$inboundSchema: z.ZodType<RefDetails> = z.object({
+  name: z.string(),
+  snapshotId: z.string().nullable(),
+  createdAt: z.number().int(),
+});
+
+/** @internal */
+export const AliasDetails$inboundSchema: z.ZodType<AliasDetails> = z.object({
+  aliasId: z.string(),
+  aliasName: z.string(),
+  targetKind: z.enum(["BRANCH", "TAG"]),
+  targetName: z.string(),
+  targetId: z.string(),
+  aliasRevision: z.number().int().nonnegative(),
+  dangling: z.boolean(),
+  createdAt: z.number().int(),
+});