@cloudflare/workers-types 4.20231025.0 → 4.20231218.0

package/2021-11-03/index.d.ts

@@ -375,7 +375,7 @@ declare interface DurableObject {
   ): void | Promise<void>;
   webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>;
 }
-declare interface DurableObjectStub extends Fetcher {
+declare interface DurableObjectStub extends WorkerRpc {
   readonly id: DurableObjectId;
   readonly name?: string;
 }
@@ -1433,6 +1433,7 @@ declare type R2Objects = {
       truncated: false;
     }
 );
+declare abstract class WorkerRpc extends Fetcher {}
 declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1704,6 +1705,11 @@ declare interface QueuingStrategyInit {
    */
   highWaterMark: number;
 }
+declare interface ScriptVersion {
+  id?: string;
+  tag?: string;
+  message?: string;
+}
 declare abstract class TailEvent extends ExtendableEvent {
   readonly events: TraceItem[];
   readonly traces: TraceItem[];
@@ -1725,6 +1731,7 @@ declare interface TraceItem {
   readonly exceptions: TraceException[];
   readonly diagnosticsChannelEvents: TraceDiagnosticChannelEvent[];
   readonly scriptName: string | null;
+  readonly scriptVersion?: ScriptVersion;
   readonly dispatchNamespace?: string;
   readonly scriptTags?: string[];
   readonly outcome: string;
@@ -2130,6 +2137,9 @@ declare interface gpuGPUCommandEncoder {
   beginComputePass(
     descriptor?: gpuGPUComputePassDescriptor
   ): gpuGPUComputePassEncoder;
+  beginRenderPass(
+    descriptor: gpuGPURenderPassDescriptor
+  ): gpuGPURenderPassEncoder;
   copyBufferToBuffer(
     source: gpuGPUBuffer,
     sourceOffset: number | bigint,
@@ -2138,6 +2148,26 @@ declare interface gpuGPUCommandEncoder {
     size: number | bigint
   ): void;
   finish(param0?: gpuGPUCommandBufferDescriptor): gpuGPUCommandBuffer;
+  copyTextureToBuffer(
+    source: gpuGPUImageCopyTexture,
+    destination: gpuGPUImageCopyBuffer,
+    copySize: Iterable<number> | gpuGPUExtent3DDict
+  ): void;
+  copyBufferToTexture(
+    source: gpuGPUImageCopyBuffer,
+    destination: gpuGPUImageCopyTexture,
+    copySize: Iterable<number> | gpuGPUExtent3DDict
+  ): void;
+  copyTextureToTexture(
+    source: gpuGPUImageCopyTexture,
+    destination: gpuGPUImageCopyTexture,
+    copySize: Iterable<number> | gpuGPUExtent3DDict
+  ): void;
+  clearBuffer(
+    buffer: gpuGPUBuffer,
+    offset?: number | bigint,
+    size?: number | bigint
+  ): void;
 }
 declare interface gpuGPUCommandEncoderDescriptor {
   label?: string;
@@ -2158,16 +2188,16 @@ declare interface gpuGPUComputePassEncoder {
 }
 declare interface gpuGPUComputePassDescriptor {
   label?: string;
-  timestampWrites?: gpuGPUComputePassTimestampWrite[];
+  timestampWrites?: gpuGPUComputePassTimestampWrites;
 }
 declare interface gpuGPUQuerySet {}
 declare interface gpuGPUQuerySetDescriptor {
   label?: string;
 }
-declare interface gpuGPUComputePassTimestampWrite {
+declare interface gpuGPUComputePassTimestampWrites {
   querySet: gpuGPUQuerySet;
-  queryIndex: number;
-  location: string;
+  beginningOfPassWriteIndex?: number;
+  endOfPassWriteIndex?: number;
 }
 declare interface gpuGPUCommandBufferDescriptor {
   label?: string;
@@ -2378,6 +2408,71 @@ declare interface gpuGPUBlendComponent {
   srcFactor?: string;
   dstFactor?: string;
 }
+declare interface gpuGPURenderPassEncoder {
+  setPipeline(pipeline: gpuGPURenderPipeline): void;
+  draw(
+    vertexCount: number,
+    instanceCount?: number,
+    firstVertex?: number,
+    firstInstance?: number
+  ): void;
+  end(): void;
+}
+declare interface gpuGPURenderPassDescriptor {
+  label?: string;
+  colorAttachments: gpuGPURenderPassColorAttachment[];
+  depthStencilAttachment?: gpuGPURenderPassDepthStencilAttachment;
+  occlusionQuerySet?: gpuGPUQuerySet;
+  timestampWrites?: gpuGPURenderPassTimestampWrites;
+  maxDrawCount?: number | bigint;
+}
+declare interface gpuGPURenderPassColorAttachment {
+  view: gpuGPUTextureView;
+  depthSlice?: number;
+  resolveTarget?: gpuGPUTextureView;
+  clearValue?: number[] | gpuGPUColorDict;
+  loadOp: string;
+  storeOp: string;
+}
+declare interface gpuGPUColorDict {
+  r: number;
+  g: number;
+  b: number;
+  a: number;
+}
+declare interface gpuGPURenderPassDepthStencilAttachment {
+  view: gpuGPUTextureView;
+  depthClearValue?: number;
+  depthLoadOp?: string;
+  depthStoreOp?: string;
+  depthReadOnly?: boolean;
+  stencilClearValue?: number;
+  stencilLoadOp?: string;
+  stencilStoreOp?: string;
+  stencilReadOnly?: boolean;
+}
+declare interface gpuGPURenderPassTimestampWrites {
+  querySet: gpuGPUQuerySet;
+  beginningOfPassWriteIndex?: number;
+  endOfPassWriteIndex?: number;
+}
+declare interface gpuGPUImageCopyTexture {
+  texture: gpuGPUTexture;
+  mipLevel?: number;
+  origin?: number[] | gpuGPUOrigin3DDict;
+  aspect?: string;
+}
+declare interface gpuGPUImageCopyBuffer {
+  buffer: gpuGPUBuffer;
+  offset?: number | bigint;
+  bytesPerRow?: number;
+  rowsPerImage?: number;
+}
+declare interface gpuGPUOrigin3DDict {
+  x?: number;
+  y?: number;
+  z?: number;
+}
 declare interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -3349,10 +3444,19 @@ declare type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
 declare type CfProperties<HostMetadata = unknown> =
   | IncomingRequestCfProperties<HostMetadata>
   | RequestInitCfProperties;
+declare interface D1Meta {
+  duration: number;
+  size_after: number;
+  rows_read: number;
+  rows_written: number;
+  last_row_id: number;
+  changed_db: boolean;
+  changes: number;
+}
 declare interface D1Result<T = unknown> {
   results: T[];
   success: true;
-  meta: any;
+  meta: D1Meta & Record<string, unknown>;
   error?: never;
 }
 declare interface D1ExecResult {
@@ -3575,19 +3679,44 @@ declare module "cloudflare:sockets" {
 // Licensed under the Apache 2.0 license found in the LICENSE file or at:
 //     https://opensource.org/licenses/Apache-2.0
 /**
- * Additional information to associate with a vector.
+ * Data types supported for holding vector metadata.
  */
-declare type VectorizeVectorMetadata =
+declare type VectorizeVectorMetadataValue =
   | string
   | number
   | boolean
-  | string[]
-  | Record<string, string | number | boolean | string[]>;
+  | string[];
+/**
+ * Additional information to associate with a vector.
+ */
+declare type VectorizeVectorMetadata =
+  | VectorizeVectorMetadataValue
+  | Record<string, VectorizeVectorMetadataValue>;
 declare type VectorFloatArray = Float32Array | Float64Array;
 declare interface VectorizeError {
   code?: number;
   error: string;
 }
+/**
+ * Comparison logic/operation to use for metadata filtering.
+ *
+ * This list is expected to grow as support for more operations are released.
+ */
+declare type VectorizeVectorMetadataFilterOp = "$eq" | "$ne";
+/**
+ * Filter criteria for vector metadata used to limit the retrieved query result set.
+ */
+declare type VectorizeVectorMetadataFilter = {
+  [field: string]:
+    | Exclude<VectorizeVectorMetadataValue, string[]>
+    | null
+    | {
+        [Op in VectorizeVectorMetadataFilterOp]?: Exclude<
+          VectorizeVectorMetadataValue,
+          string[]
+        > | null;
+      };
+};
 /**
  * Supported distance metrics for an index.
  * Distance metrics determine how other "similar" vectors are determined.
@@ -3596,7 +3725,9 @@ declare type VectorizeDistanceMetric = "euclidean" | "cosine" | "dot-product";
 declare interface VectorizeQueryOptions {
   topK?: number;
   namespace?: string;
-  returnVectors?: boolean;
+  returnValues?: boolean;
+  returnMetadata?: boolean;
+  filter?: VectorizeVectorMetadataFilter;
 }
 /**
  * Information about the configuration of an index.
@@ -3634,20 +3765,17 @@ declare interface VectorizeVector {
   values: VectorFloatArray | number[];
   /** The namespace this vector belongs to. */
   namespace?: string;
-  /** Metadata associated with the binding. Includes the values of the other fields and potentially additional details. */
+  /** Metadata associated with the vector. Includes the values of the other fields and potentially additional details. */
   metadata?: Record<string, VectorizeVectorMetadata>;
 }
 /**
  * Represents a matched vector for a query along with its score and (if specified) the matching vector information.
  */
-declare interface VectorizeMatch {
-  /** The ID for the vector. This can be user-defined, and must be unique. It should uniquely identify the object, and is best set based on the ID of what the vector represents. */
-  vectorId: string;
-  /** The score or rank for similarity, when returned as a result */
-  score: number;
-  /** Vector data for the match. Included only if the user specified they want it returned (via {@link VectorizeQueryOptions}). */
-  vector?: VectorizeVector;
-}
+declare type VectorizeMatch = Pick<Partial<VectorizeVector>, "values"> &
+  Omit<VectorizeVector, "values"> & {
+    /** The score or rank for similarity, when returned as a result */
+    score: number;
+  };
 /**
  * A set of vector {@link VectorizeMatch} for a particular query.
  */

package/2021-11-03/index.ts

@@ -377,7 +377,7 @@ export interface DurableObject {
   ): void | Promise<void>;
   webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>;
 }
-export interface DurableObjectStub extends Fetcher {
+export interface DurableObjectStub extends WorkerRpc {
   readonly id: DurableObjectId;
   readonly name?: string;
 }
@@ -1435,6 +1435,7 @@ export type R2Objects = {
       truncated: false;
     }
 );
+export declare abstract class WorkerRpc extends Fetcher {}
 export declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1709,6 +1710,11 @@ export interface QueuingStrategyInit {
    */
   highWaterMark: number;
 }
+export interface ScriptVersion {
+  id?: string;
+  tag?: string;
+  message?: string;
+}
 export declare abstract class TailEvent extends ExtendableEvent {
   readonly events: TraceItem[];
   readonly traces: TraceItem[];
@@ -1730,6 +1736,7 @@ export interface TraceItem {
   readonly exceptions: TraceException[];
   readonly diagnosticsChannelEvents: TraceDiagnosticChannelEvent[];
   readonly scriptName: string | null;
+  readonly scriptVersion?: ScriptVersion;
   readonly dispatchNamespace?: string;
   readonly scriptTags?: string[];
   readonly outcome: string;
@@ -2135,6 +2142,9 @@ export interface gpuGPUCommandEncoder {
   beginComputePass(
     descriptor?: gpuGPUComputePassDescriptor
   ): gpuGPUComputePassEncoder;
+  beginRenderPass(
+    descriptor: gpuGPURenderPassDescriptor
+  ): gpuGPURenderPassEncoder;
   copyBufferToBuffer(
     source: gpuGPUBuffer,
     sourceOffset: number | bigint,
@@ -2143,6 +2153,26 @@ export interface gpuGPUCommandEncoder {
     size: number | bigint
   ): void;
   finish(param0?: gpuGPUCommandBufferDescriptor): gpuGPUCommandBuffer;
+  copyTextureToBuffer(
+    source: gpuGPUImageCopyTexture,
+    destination: gpuGPUImageCopyBuffer,
+    copySize: Iterable<number> | gpuGPUExtent3DDict
+  ): void;
+  copyBufferToTexture(
+    source: gpuGPUImageCopyBuffer,
+    destination: gpuGPUImageCopyTexture,
+    copySize: Iterable<number> | gpuGPUExtent3DDict
+  ): void;
+  copyTextureToTexture(
+    source: gpuGPUImageCopyTexture,
+    destination: gpuGPUImageCopyTexture,
+    copySize: Iterable<number> | gpuGPUExtent3DDict
+  ): void;
+  clearBuffer(
+    buffer: gpuGPUBuffer,
+    offset?: number | bigint,
+    size?: number | bigint
+  ): void;
 }
 export interface gpuGPUCommandEncoderDescriptor {
   label?: string;
@@ -2163,16 +2193,16 @@ export interface gpuGPUComputePassEncoder {
 }
 export interface gpuGPUComputePassDescriptor {
   label?: string;
-  timestampWrites?: gpuGPUComputePassTimestampWrite[];
+  timestampWrites?: gpuGPUComputePassTimestampWrites;
 }
 export interface gpuGPUQuerySet {}
 export interface gpuGPUQuerySetDescriptor {
   label?: string;
 }
-export interface gpuGPUComputePassTimestampWrite {
+export interface gpuGPUComputePassTimestampWrites {
   querySet: gpuGPUQuerySet;
-  queryIndex: number;
-  location: string;
+  beginningOfPassWriteIndex?: number;
+  endOfPassWriteIndex?: number;
 }
 export interface gpuGPUCommandBufferDescriptor {
   label?: string;
@@ -2383,6 +2413,71 @@ export interface gpuGPUBlendComponent {
   srcFactor?: string;
   dstFactor?: string;
 }
+export interface gpuGPURenderPassEncoder {
+  setPipeline(pipeline: gpuGPURenderPipeline): void;
+  draw(
+    vertexCount: number,
+    instanceCount?: number,
+    firstVertex?: number,
+    firstInstance?: number
+  ): void;
+  end(): void;
+}
+export interface gpuGPURenderPassDescriptor {
+  label?: string;
+  colorAttachments: gpuGPURenderPassColorAttachment[];
+  depthStencilAttachment?: gpuGPURenderPassDepthStencilAttachment;
+  occlusionQuerySet?: gpuGPUQuerySet;
+  timestampWrites?: gpuGPURenderPassTimestampWrites;
+  maxDrawCount?: number | bigint;
+}
+export interface gpuGPURenderPassColorAttachment {
+  view: gpuGPUTextureView;
+  depthSlice?: number;
+  resolveTarget?: gpuGPUTextureView;
+  clearValue?: number[] | gpuGPUColorDict;
+  loadOp: string;
+  storeOp: string;
+}
+export interface gpuGPUColorDict {
+  r: number;
+  g: number;
+  b: number;
+  a: number;
+}
+export interface gpuGPURenderPassDepthStencilAttachment {
+  view: gpuGPUTextureView;
+  depthClearValue?: number;
+  depthLoadOp?: string;
+  depthStoreOp?: string;
+  depthReadOnly?: boolean;
+  stencilClearValue?: number;
+  stencilLoadOp?: string;
+  stencilStoreOp?: string;
+  stencilReadOnly?: boolean;
+}
+export interface gpuGPURenderPassTimestampWrites {
+  querySet: gpuGPUQuerySet;
+  beginningOfPassWriteIndex?: number;
+  endOfPassWriteIndex?: number;
+}
+export interface gpuGPUImageCopyTexture {
+  texture: gpuGPUTexture;
+  mipLevel?: number;
+  origin?: number[] | gpuGPUOrigin3DDict;
+  aspect?: string;
+}
+export interface gpuGPUImageCopyBuffer {
+  buffer: gpuGPUBuffer;
+  offset?: number | bigint;
+  bytesPerRow?: number;
+  rowsPerImage?: number;
+}
+export interface gpuGPUOrigin3DDict {
+  x?: number;
+  y?: number;
+  z?: number;
+}
 export interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -3354,10 +3449,19 @@ export type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
 export type CfProperties<HostMetadata = unknown> =
   | IncomingRequestCfProperties<HostMetadata>
   | RequestInitCfProperties;
+export interface D1Meta {
+  duration: number;
+  size_after: number;
+  rows_read: number;
+  rows_written: number;
+  last_row_id: number;
+  changed_db: boolean;
+  changes: number;
+}
 export interface D1Result<T = unknown> {
   results: T[];
   success: true;
-  meta: any;
+  meta: D1Meta & Record<string, unknown>;
   error?: never;
 }
 export interface D1ExecResult {
@@ -3562,20 +3666,41 @@ export interface JsonWebKeyWithKid extends JsonWebKey {
 // Copyright (c) 2022-2023 Cloudflare, Inc.
 // Licensed under the Apache 2.0 license found in the LICENSE file or at:
 //     https://opensource.org/licenses/Apache-2.0
+/**
+ * Data types supported for holding vector metadata.
+ */
+export type VectorizeVectorMetadataValue = string | number | boolean | string[];
 /**
  * Additional information to associate with a vector.
  */
 export type VectorizeVectorMetadata =
-  | string
-  | number
-  | boolean
-  | string[]
-  | Record<string, string | number | boolean | string[]>;
+  | VectorizeVectorMetadataValue
+  | Record<string, VectorizeVectorMetadataValue>;
 export type VectorFloatArray = Float32Array | Float64Array;
 export interface VectorizeError {
   code?: number;
   error: string;
 }
+/**
+ * Comparison logic/operation to use for metadata filtering.
+ *
+ * This list is expected to grow as support for more operations are released.
+ */
+export type VectorizeVectorMetadataFilterOp = "$eq" | "$ne";
+/**
+ * Filter criteria for vector metadata used to limit the retrieved query result set.
+ */
+export type VectorizeVectorMetadataFilter = {
+  [field: string]:
+    | Exclude<VectorizeVectorMetadataValue, string[]>
+    | null
+    | {
+        [Op in VectorizeVectorMetadataFilterOp]?: Exclude<
+          VectorizeVectorMetadataValue,
+          string[]
+        > | null;
+      };
+};
 /**
  * Supported distance metrics for an index.
  * Distance metrics determine how other "similar" vectors are determined.
@@ -3584,7 +3709,9 @@ export type VectorizeDistanceMetric = "euclidean" | "cosine" | "dot-product";
 export interface VectorizeQueryOptions {
   topK?: number;
   namespace?: string;
-  returnVectors?: boolean;
+  returnValues?: boolean;
+  returnMetadata?: boolean;
+  filter?: VectorizeVectorMetadataFilter;
 }
 /**
  * Information about the configuration of an index.
@@ -3622,20 +3749,17 @@ export interface VectorizeVector {
   values: VectorFloatArray | number[];
   /** The namespace this vector belongs to. */
   namespace?: string;
-  /** Metadata associated with the binding. Includes the values of the other fields and potentially additional details. */
+  /** Metadata associated with the vector. Includes the values of the other fields and potentially additional details. */
   metadata?: Record<string, VectorizeVectorMetadata>;
 }
 /**
  * Represents a matched vector for a query along with its score and (if specified) the matching vector information.
  */
-export interface VectorizeMatch {
-  /** The ID for the vector. This can be user-defined, and must be unique. It should uniquely identify the object, and is best set based on the ID of what the vector represents. */
-  vectorId: string;
-  /** The score or rank for similarity, when returned as a result */
-  score: number;
-  /** Vector data for the match. Included only if the user specified they want it returned (via {@link VectorizeQueryOptions}). */
-  vector?: VectorizeVector;
-}
+export type VectorizeMatch = Pick<Partial<VectorizeVector>, "values"> &
+  Omit<VectorizeVector, "values"> & {
+    /** The score or rank for similarity, when returned as a result */
+    score: number;
+  };
 /**
  * A set of vector {@link VectorizeMatch} for a particular query.
  */