@cloudflare/workers-types 4.20230904.0 → 4.20230922.0

package/index.ts

@@ -232,6 +232,14 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   FixedLengthStream: typeof FixedLengthStream;
   IdentityTransformStream: typeof IdentityTransformStream;
   HTMLRewriter: typeof HTMLRewriter;
+  GPUAdapter: typeof gpuGPUAdapter;
+  GPUOutOfMemoryError: typeof gpuGPUOutOfMemoryError;
+  GPUValidationError: typeof gpuGPUValidationError;
+  GPUInternalError: typeof gpuGPUInternalError;
+  GPUDeviceLostInfo: typeof gpuGPUDeviceLostInfo;
+  GPUBufferUsage: typeof gpuGPUBufferUsage;
+  GPUShaderStage: typeof gpuGPUShaderStage;
+  GPUMapMode: typeof gpuGPUMapMode;
 }
 export declare function addEventListener<
   Type extends keyof WorkerGlobalScopeEventMap
@@ -880,7 +888,7 @@ export declare class TextDecoder {
 }
 export declare class TextEncoder {
   constructor();
-  encode(input?: string): ArrayBuffer | ArrayBufferView;
+  encode(input?: string): Uint8Array;
   encodeInto(
     input: string,
     buffer: ArrayBuffer | ArrayBufferView
@@ -1934,6 +1942,296 @@ export interface SocketAddress {
 export interface TlsOptions {
   expectedServerHostname?: string;
 }
+export declare abstract class gpuGPUAdapter {
+  requestDevice(param1?: gpuGPUDeviceDescriptor): Promise<gpuGPUDevice>;
+  requestAdapterInfo(unmaskHints?: string[]): Promise<gpuGPUAdapterInfo>;
+  get features(): gpuGPUSupportedFeatures;
+  get limits(): gpuGPUSupportedLimits;
+}
+export interface gpuGPUDevice extends EventTarget {
+  createBuffer(param1: gpuGPUBufferDescriptor): gpuGPUBuffer;
+  createBindGroupLayout(
+    descriptor: gpuGPUBindGroupLayoutDescriptor
+  ): gpuGPUBindGroupLayout;
+  createBindGroup(descriptor: gpuGPUBindGroupDescriptor): gpuGPUBindGroup;
+  createSampler(descriptor: gpuGPUSamplerDescriptor): gpuGPUSampler;
+  createShaderModule(
+    descriptor: gpuGPUShaderModuleDescriptor
+  ): gpuGPUShaderModule;
+  createPipelineLayout(
+    descriptor: gpuGPUPipelineLayoutDescriptor
+  ): gpuGPUPipelineLayout;
+  createComputePipeline(
+    descriptor: gpuGPUComputePipelineDescriptor
+  ): gpuGPUComputePipeline;
+  createCommandEncoder(
+    descriptor?: gpuGPUCommandEncoderDescriptor
+  ): gpuGPUCommandEncoder;
+  destroy(): void;
+  createQuerySet(descriptor: gpuGPUQuerySetDescriptor): gpuGPUQuerySet;
+  pushErrorScope(filter: string): void;
+  popErrorScope(): Promise<gpuGPUError | null>;
+  get queue(): gpuGPUQueue;
+  get lost(): Promise<gpuGPUDeviceLostInfo>;
+  get features(): gpuGPUSupportedFeatures;
+  get limits(): gpuGPUSupportedLimits;
+}
+export interface gpuGPUDeviceDescriptor {
+  label?: string;
+  requiredFeatures?: string[];
+  requiredLimits?: Record<string, number | bigint>;
+  defaultQueue?: gpuGPUQueueDescriptor;
+}
+export interface gpuGPUBufferDescriptor {
+  label: string;
+  size: number | bigint;
+  usage: number;
+  mappedAtCreation: boolean;
+}
+export interface gpuGPUQueueDescriptor {
+  label?: string;
+}
+export declare abstract class gpuGPUBufferUsage {
+  static readonly MAP_READ: number;
+  static readonly MAP_WRITE: number;
+  static readonly COPY_SRC: number;
+  static readonly COPY_DST: number;
+  static readonly INDEX: number;
+  static readonly VERTEX: number;
+  static readonly UNIFORM: number;
+  static readonly STORAGE: number;
+  static readonly INDIRECT: number;
+  static readonly QUERY_RESOLVE: number;
+}
+export interface gpuGPUBuffer {
+  getMappedRange(size?: number | bigint, param2?: number | bigint): ArrayBuffer;
+  unmap(): void;
+  destroy(): void;
+  mapAsync(
+    mode: number,
+    offset?: number | bigint,
+    size?: number | bigint
+  ): Promise<void>;
+  get size(): number | bigint;
+  get usage(): number;
+  get mapState(): string;
+}
+export declare abstract class gpuGPUShaderStage {
+  static readonly VERTEX: number;
+  static readonly FRAGMENT: number;
+  static readonly COMPUTE: number;
+}
+export interface gpuGPUBindGroupLayoutDescriptor {
+  label?: string;
+  entries: gpuGPUBindGroupLayoutEntry[];
+}
+export interface gpuGPUBindGroupLayoutEntry {
+  binding: number;
+  visibility: number;
+  buffer?: gpuGPUBufferBindingLayout;
+  sampler?: gpuGPUSamplerBindingLayout;
+  texture?: gpuGPUTextureBindingLayout;
+  storageTexture?: gpuGPUStorageTextureBindingLayout;
+}
+export interface gpuGPUStorageTextureBindingLayout {
+  access?: string;
+  format: string;
+  viewDimension?: string;
+}
+export interface gpuGPUTextureBindingLayout {
+  sampleType?: string;
+  viewDimension?: string;
+  multisampled?: boolean;
+}
+export interface gpuGPUSamplerBindingLayout {
+  type?: string;
+}
+export interface gpuGPUBufferBindingLayout {
+  type?: string;
+  hasDynamicOffset?: boolean;
+  minBindingSize?: number | bigint;
+}
+export interface gpuGPUBindGroupLayout {}
+export interface gpuGPUBindGroup {}
+export interface gpuGPUBindGroupDescriptor {
+  label?: string;
+  layout: gpuGPUBindGroupLayout;
+  entries: gpuGPUBindGroupEntry[];
+}
+export interface gpuGPUBindGroupEntry {
+  binding: number;
+  resource: gpuGPUBufferBinding | gpuGPUSampler;
+}
+export interface gpuGPUBufferBinding {
+  buffer: gpuGPUBuffer;
+  offset?: number | bigint;
+  size?: number | bigint;
+}
+export interface gpuGPUSampler {}
+export interface gpuGPUSamplerDescriptor {
+  label?: string;
+  addressModeU?: string;
+  addressModeV?: string;
+  addressModeW?: string;
+  magFilter?: string;
+  minFilter?: string;
+  mipmapFilter?: string;
+  lodMinClamp?: number;
+  lodMaxClamp?: number;
+  compare: string;
+  maxAnisotropy?: number;
+}
+export interface gpuGPUShaderModule {
+  getCompilationInfo(): Promise<gpuGPUCompilationInfo>;
+}
+export interface gpuGPUShaderModuleDescriptor {
+  label?: string;
+  code: string;
+}
+export interface gpuGPUPipelineLayout {}
+export interface gpuGPUPipelineLayoutDescriptor {
+  label?: string;
+  bindGroupLayouts: gpuGPUBindGroupLayout[];
+}
+export interface gpuGPUComputePipeline {
+  getBindGroupLayout(index: number): gpuGPUBindGroupLayout;
+}
+export interface gpuGPUComputePipelineDescriptor {
+  label?: string;
+  compute: gpuGPUProgrammableStage;
+  layout: string | gpuGPUPipelineLayout;
+}
+export interface gpuGPUProgrammableStage {
+  module: gpuGPUShaderModule;
+  entryPoint: string;
+  constants?: Record<string, number>;
+}
+export interface gpuGPUCommandEncoder {
+  get label(): string;
+  beginComputePass(
+    descriptor?: gpuGPUComputePassDescriptor
+  ): gpuGPUComputePassEncoder;
+  copyBufferToBuffer(
+    source: gpuGPUBuffer,
+    sourceOffset: number | bigint,
+    destination: gpuGPUBuffer,
+    destinationOffset: number | bigint,
+    size: number | bigint
+  ): void;
+  finish(param0?: gpuGPUCommandBufferDescriptor): gpuGPUCommandBuffer;
+}
+export interface gpuGPUCommandEncoderDescriptor {
+  label?: string;
+}
+export interface gpuGPUComputePassEncoder {
+  setPipeline(pipeline: gpuGPUComputePipeline): void;
+  setBindGroup(
+    index: number,
+    bindGroup: gpuGPUBindGroup | null,
+    dynamicOffsets?: Iterable<number>
+  ): void;
+  dispatchWorkgroups(
+    workgroupCountX: number,
+    workgroupCountY?: number,
+    workgroupCountZ?: number
+  ): void;
+  end(): void;
+}
+export interface gpuGPUComputePassDescriptor {
+  label?: string;
+  timestampWrites?: gpuGPUComputePassTimestampWrite[];
+}
+export interface gpuGPUQuerySet {}
+export interface gpuGPUQuerySetDescriptor {
+  label?: string;
+}
+export interface gpuGPUComputePassTimestampWrite {
+  querySet: gpuGPUQuerySet;
+  queryIndex: number;
+  location: string;
+}
+export interface gpuGPUCommandBufferDescriptor {
+  label?: string;
+}
+export interface gpuGPUCommandBuffer {}
+export interface gpuGPUQueue {
+  submit(commandBuffers: gpuGPUCommandBuffer[]): void;
+  writeBuffer(
+    buffer: gpuGPUBuffer,
+    bufferOffset: number | bigint,
+    data: ArrayBuffer | ArrayBufferView,
+    dataOffset?: number | bigint,
+    size?: number | bigint
+  ): void;
+}
+export declare abstract class gpuGPUMapMode {
+  static readonly READ: number;
+  static readonly WRITE: number;
+}
+export interface gpuGPUAdapterInfo {
+  get vendor(): string;
+  get architecture(): string;
+  get device(): string;
+  get description(): string;
+}
+export interface gpuGPUSupportedFeatures {
+  has(name: string): boolean;
+  keys(): string[];
+}
+export interface gpuGPUSupportedLimits {
+  get maxTextureDimension1D(): number;
+  get maxTextureDimension2D(): number;
+  get maxTextureDimension3D(): number;
+  get maxTextureArrayLayers(): number;
+  get maxBindGroups(): number;
+  get maxBindingsPerBindGroup(): number;
+  get maxDynamicUniformBuffersPerPipelineLayout(): number;
+  get maxDynamicStorageBuffersPerPipelineLayout(): number;
+  get maxSampledTexturesPerShaderStage(): number;
+  get maxSamplersPerShaderStage(): number;
+  get maxStorageBuffersPerShaderStage(): number;
+  get maxStorageTexturesPerShaderStage(): number;
+  get maxUniformBuffersPerShaderStage(): number;
+  get maxUniformBufferBindingSize(): number | bigint;
+  get maxStorageBufferBindingSize(): number | bigint;
+  get minUniformBufferOffsetAlignment(): number;
+  get minStorageBufferOffsetAlignment(): number;
+  get maxVertexBuffers(): number;
+  get maxBufferSize(): number | bigint;
+  get maxVertexAttributes(): number;
+  get maxVertexBufferArrayStride(): number;
+  get maxInterStageShaderComponents(): number;
+  get maxInterStageShaderVariables(): number;
+  get maxColorAttachments(): number;
+  get maxColorAttachmentBytesPerSample(): number;
+  get maxComputeWorkgroupStorageSize(): number;
+  get maxComputeInvocationsPerWorkgroup(): number;
+  get maxComputeWorkgroupSizeX(): number;
+  get maxComputeWorkgroupSizeY(): number;
+  get maxComputeWorkgroupSizeZ(): number;
+  get maxComputeWorkgroupsPerDimension(): number;
+}
+export declare abstract class gpuGPUError {
+  get message(): string;
+}
+export declare abstract class gpuGPUOutOfMemoryError extends gpuGPUError {}
+export declare abstract class gpuGPUInternalError extends gpuGPUError {}
+export declare abstract class gpuGPUValidationError extends gpuGPUError {}
+export declare abstract class gpuGPUDeviceLostInfo {
+  get message(): string;
+  get reason(): string;
+}
+export interface gpuGPUCompilationMessage {
+  get message(): string;
+  get type(): string;
+  get lineNum(): number;
+  get linePos(): number;
+  get offset(): number;
+  get length(): number;
+}
+export interface gpuGPUCompilationInfo {
+  get messages(): gpuGPUCompilationMessage[];
+}
 export interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -2905,9 +3203,6 @@ export type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
 export type CfProperties<HostMetadata = unknown> =
   | IncomingRequestCfProperties<HostMetadata>
   | RequestInitCfProperties;
-// 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
 export interface D1Result<T = unknown> {
   results: T[];
   success: true;
@@ -2932,9 +3227,6 @@ export declare abstract class D1PreparedStatement {
   all<T = Record<string, unknown>>(): Promise<D1Result<T>>;
   raw<T = unknown[]>(): Promise<T[]>;
 }
-// Copyright (c) 2023 Cloudflare, Inc.
-// Licensed under the Apache 2.0 license found in the LICENSE file or at:
-//     https://opensource.org/licenses/Apache-2.0
 /**
  * An email message that can be sent from a Worker.
  */
@@ -2992,9 +3284,53 @@ export type EmailExportedHandler<Env = unknown> = (
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
-// 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
+export interface Hyperdrive {
+  /**
+   * Connect directly to Hyperdrive as if it's your database, returning a TCP socket.
+   *
+   * Calling this method returns an idential socket to if you call
+   * `connect("host:port")` using the `host` and `port` fields from this object.
+   * Pick whichever approach works better with your preferred DB client library.
+   *
+   * Note that this socket is not yet authenticated -- it's expected that your
+   * code (or preferably, the client library of your choice) will authenticate
+   * using the information in this class's readonly fields.
+   */
+  connect(): Socket;
+  /**
+   * A valid DB connection string that can be passed straight into the typical
+   * client library/driver/ORM. This will typically be the easiest way to use
+   * Hyperdrive.
+   */
+  readonly connectionString: string;
+  /*
+   * A randomly generated hostname that is only valid within the context of the
+   * currently running Worker which, when passed into `connect()` function from
+   * the "cloudflare:sockets" module, will connect to the Hyperdrive instance
+   * for your database.
+   */
+  readonly host: string;
+  /*
+   * The port that must be paired the the host field when connecting.
+   */
+  readonly port: string;
+  /*
+   * The username to use when authenticating to your database via Hyperdrive.
+   * Unlike the host and password, this will be the same every time
+   */
+  readonly user: string;
+  /*
+   * The randomly generated password to use when authenticating to your
+   * database via Hyperdrive. Like the host field, this password is only valid
+   * within the context of the currently running Worker instance from which
+   * it's read.
+   */
+  readonly password: string;
+  /*
+   * The name of the database to connect to.
+   */
+  readonly database: string;
+}
 export type Params<P extends string = any> = Record<P, string | string[]>;
 export type EventContext<Env, P extends string, Data> = {
   request: Request;
@@ -3038,13 +3374,10 @@ export type PagesPluginFunction<
 > = (
   context: EventPluginContext<Env, Params, Data, PluginArgs>
 ) => Response | Promise<Response>;
-// Copyright (c) 2023 Cloudflare, Inc.
-// Licensed under the Apache 2.0 license found in the LICENSE file or at:
-//     https://opensource.org/licenses/Apache-2.0
-// https://developers.cloudflare.com/pub-sub/
 // PubSubMessage represents an incoming PubSub message.
 // The message includes metadata about the broker, the client, and the payload
 // itself.
+// https://developers.cloudflare.com/pub-sub/
 export interface PubSubMessage {
   // Message ID
   readonly mid: number;
@@ -3075,10 +3408,141 @@ export interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
-// Copyright (c) 2023 Cloudflare, Inc.
+// 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
-// https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+/**
+ * Additional information to associate with a vector.
+ */
+export type VectorizeVectorMetadata =
+  | string
+  | number
+  | boolean
+  | string[]
+  | Record<string, string | number | boolean | string[]>;
+export type VectorFloatArray = Float32Array | Float64Array;
+export interface VectorizeError {
+  code?: number;
+  error: string;
+}
+/**
+ * Supported distance metrics for an index.
+ * Distance metrics determine how other "similar" vectors are determined.
+ */
+export type VectorizeDistanceMetric = "euclidean" | "cosine" | "dot-product";
+export interface VectorizeQueryOptions {
+  topK?: number;
+  namespace?: string;
+  returnVectors?: boolean;
+}
+/**
+ * Information about the configuration of an index.
+ */
+export type VectorizeIndexConfig =
+  | {
+      dimensions: number;
+      metric: VectorizeDistanceMetric;
+    }
+  | {
+      preset: string; // keep this generic, as we'll be adding more presets in the future and this is only in a read capacity
+    };
+/**
+ * Metadata about an existing index.
+ */
+export interface VectorizeIndexDetails {
+  /** The unique ID of the index */
+  readonly id: string;
+  /** The name of the index. */
+  name: string;
+  /** (optional) A human readable description for the index. */
+  description?: string;
+  /** The index configuration, including the dimension size and distance metric. */
+  config: VectorizeIndexConfig;
+  /** The number of records containing vectors within the index. */
+  vectorsCount: number;
+}
+/**
+ * Represents a single vector value set along with its associated metadata.
+ */
+export interface VectorizeVector {
+  /** 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. */
+  id: string;
+  /** The vector values */
+  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?: 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;
+}
+/**
+ * A set of vector {@link VectorizeMatch} for a particular query.
+ */
+export interface VectorizeMatches {
+  matches: VectorizeMatch[];
+  count: number;
+}
+/**
+ * Results of an operation that performed a mutation on a set of vectors.
+ * Here, `ids` is a list of vectors that were successfully processed.
+ */
+export interface VectorizeVectorMutation {
+  /* List of ids of vectors that were successfully processed. */
+  ids: string[];
+  /* Total count of the number of processed vectors. */
+  count: number;
+}
+export declare abstract class VectorizeIndex {
+  /**
+   * Get information about the currently bound index.
+   * @returns A promise that resolves with information about the current index.
+   */
+  public describe(): Promise<VectorizeIndexDetails>;
+  /**
+   * Use the provided vector to perform a similarity search across the index.
+   * @param vector Input vector that will be used to drive the similarity search.
+   * @param options Configuration options to massage the returned data.
+   * @returns A promise that resolves with matched and scored vectors.
+   */
+  public query(
+    vector: VectorFloatArray | number[],
+    options: VectorizeQueryOptions
+  ): Promise<VectorizeMatches>;
+  /**
+   * Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.
+   * @param vectors List of vectors that will be inserted.
+   * @returns A promise that resolves with the ids & count of records that were successfully processed.
+   */
+  public insert(vectors: VectorizeVector[]): Promise<VectorizeVectorMutation>;
+  /**
+   * Upsert a list of vectors into the index dataset. If a provided id exists, it will be replaced with the new values.
+   * @param vectors List of vectors that will be upserted.
+   * @returns A promise that resolves with the ids & count of records that were successfully processed.
+   */
+  public upsert(vectors: VectorizeVector[]): Promise<VectorizeVectorMutation>;
+  /**
+   * Delete a list of vectors with a matching id.
+   * @param ids List of vector ids that should be deleted.
+   * @returns A promise that resolves with the ids & count of records that were successfully processed (and thus deleted).
+   */
+  public deleteByIds(ids: string[]): Promise<VectorizeVectorMutation>;
+  /**
+   * Get a list of vectors with a matching id.
+   * @param ids List of vector ids that should be returned.
+   * @returns A promise that resolves with the raw unscored vectors matching the id set.
+   */
+  public getByIds(ids: string[]): Promise<VectorizeVector[]>;
+}
 export interface DynamicDispatchLimits {
   /**
    * Limit CPU time in milliseconds.