cloudflare 4.4.1 → 5.0.0

package/src/resources/workers/scripts/content.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
-import * as WorkersAPI from '../workers';
 import * as ScriptsAPI from './scripts';
 import { type Response } from '../../../_shims/index';
 
@@ -85,10 +84,21 @@ export interface ContentUpdateParams {
   account_id: string;
 
   /**
-   * Body param: JSON encoded metadata about the uploaded parts and Worker
+   * Body param: JSON-encoded metadata about the uploaded parts and Worker
    * configuration.
    */
-  metadata: WorkersAPI.WorkerMetadataParam;
+  metadata: ContentUpdateParams.Metadata;
+
+  /**
+   * Body param: An array of modules (often JavaScript files) comprising a Worker
+   * script. At least one module must be present and referenced in the metadata as
+   * `main_module` or `body_part` by filename.<br/>Possible Content-Type(s) are:
+   * `application/javascript+module`, `text/javascript+module`,
+   * `application/javascript`, `text/javascript`, `text/x-python`,
+   * `text/x-python-requirement`, `application/wasm`, `text/plain`,
+   * `application/octet-stream`, `application/source-map`.
+   */
+  files?: Array<Core.Uploadable>;
 
   /**
    * Header param: The multipart name of a script upload part containing script
@@ -101,8 +111,25 @@ export interface ContentUpdateParams {
    * content in es module format. Alternative to including in a metadata part.
    */
   'CF-WORKER-MAIN-MODULE-PART'?: string;
+}
 
-  [k: string]: Array<Core.Uploadable> | string | WorkersAPI.WorkerMetadataParam | undefined;
+export namespace ContentUpdateParams {
+  /**
+   * JSON-encoded metadata about the uploaded parts and Worker configuration.
+   */
+  export interface Metadata {
+    /**
+     * Name of the uploaded file that contains the Worker script (e.g. the file adding
+     * a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
+     */
+    body_part?: string;
+
+    /**
+     * Name of the uploaded file that contains the main module (e.g. the file exporting
+     * a `fetch` handler). Indicates a `module syntax` Worker.
+     */
+    main_module?: string;
+  }
 }
 
 export interface ContentGetParams {

package/src/resources/workers/scripts/deployments.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
-import * as DeploymentsAPI from './deployments';
 
 export class Deployments extends APIResource {
   /**
@@ -23,7 +22,7 @@ export class Deployments extends APIResource {
    *         {
    *           percentage: 100,
    *           version_id:
-   *             'bcf48806-b317-4351-9ee7-36e7d557d4de',
+   *             '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *         },
    *       ],
    *     },
@@ -34,14 +33,14 @@ export class Deployments extends APIResource {
     scriptName: string,
     params: DeploymentCreateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<DeploymentCreateResponse> {
+  ): Core.APIPromise<Deployment> {
     const { account_id, force, ...body } = params;
     return (
       this._client.post(`/accounts/${account_id}/workers/scripts/${scriptName}/deployments`, {
         query: { force },
         body,
         ...options,
-      }) as Core.APIPromise<{ result: DeploymentCreateResponse }>
+      }) as Core.APIPromise<{ result: Deployment }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -51,92 +50,164 @@ export class Deployments extends APIResource {
    *
    * @example
    * ```ts
-   * const deployment =
-   *   await client.workers.scripts.deployments.get(
+   * const deployments =
+   *   await client.workers.scripts.deployments.list(
    *     'this-is_my_script-01',
    *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
    */
-  get(
+  list(
     scriptName: string,
-    params: DeploymentGetParams,
+    params: DeploymentListParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<DeploymentGetResponse> {
+  ): Core.APIPromise<DeploymentListResponse> {
     const { account_id } = params;
     return (
       this._client.get(
         `/accounts/${account_id}/workers/scripts/${scriptName}/deployments`,
         options,
-      ) as Core.APIPromise<{ result: DeploymentGetResponse }>
+      ) as Core.APIPromise<{ result: DeploymentListResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
-}
 
-export interface Deployment {
   /**
-   * Human-readable message about the deployment. Truncated to 100 bytes.
+   * Delete a Worker Deployment. The latest deployment, which is actively serving
+   * traffic, cannot be deleted. All other deployments can be deleted.
+   *
+   * @example
+   * ```ts
+   * const deployment =
+   *   await client.workers.scripts.deployments.delete(
+   *     'this-is_my_script-01',
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
    */
-  'workers/message'?: string;
-}
+  delete(
+    scriptName: string,
+    deploymentId: string,
+    params: DeploymentDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DeploymentDeleteResponse> {
+    const { account_id } = params;
+    return this._client.delete(
+      `/accounts/${account_id}/workers/scripts/${scriptName}/deployments/${deploymentId}`,
+      options,
+    );
+  }
 
-export interface DeploymentParam {
   /**
-   * Human-readable message about the deployment. Truncated to 100 bytes.
+   * Get information about a Worker Deployment.
+   *
+   * @example
+   * ```ts
+   * const deployment =
+   *   await client.workers.scripts.deployments.get(
+   *     'this-is_my_script-01',
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
    */
-  'workers/message'?: string;
+  get(
+    scriptName: string,
+    deploymentId: string,
+    params: DeploymentGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Deployment> {
+    const { account_id } = params;
+    return (
+      this._client.get(
+        `/accounts/${account_id}/workers/scripts/${scriptName}/deployments/${deploymentId}`,
+        options,
+      ) as Core.APIPromise<{ result: Deployment }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 
-export interface DeploymentCreateResponse {
-  strategy: 'percentage';
+export interface Deployment {
+  id: string;
 
-  versions: Array<DeploymentCreateResponse.Version>;
+  created_on: string;
 
-  id?: string;
+  source: string;
 
-  annotations?: Deployment;
+  strategy: 'percentage';
 
-  author_email?: string;
+  versions: Array<Deployment.Version>;
 
-  created_on?: string;
+  annotations?: Deployment.Annotations;
 
-  source?: string;
+  author_email?: string;
 }
 
-export namespace DeploymentCreateResponse {
+export namespace Deployment {
   export interface Version {
     percentage: number;
 
     version_id: string;
   }
+
+  export interface Annotations {
+    /**
+     * Human-readable message about the deployment. Truncated to 100 bytes.
+     */
+    'workers/message'?: string;
+
+    /**
+     * Operation that triggered the creation of the deployment.
+     */
+    'workers/triggered_by'?: string;
+  }
 }
 
-export interface DeploymentGetResponse {
-  deployments?: Array<DeploymentGetResponse.Deployment>;
+export interface DeploymentListResponse {
+  deployments: Array<Deployment>;
 }
 
-export namespace DeploymentGetResponse {
-  export interface Deployment {
-    strategy: 'percentage';
+export interface DeploymentDeleteResponse {
+  errors: Array<DeploymentDeleteResponse.Error>;
 
-    versions: Array<Deployment.Version>;
+  messages: Array<DeploymentDeleteResponse.Message>;
 
-    id?: string;
+  /**
+   * Whether the API call was successful.
+   */
+  success: true;
+}
 
-    annotations?: DeploymentsAPI.Deployment;
+export namespace DeploymentDeleteResponse {
+  export interface Error {
+    code: number;
 
-    author_email?: string;
+    message: string;
 
-    created_on?: string;
+    documentation_url?: string;
 
-    source?: string;
+    source?: Error.Source;
   }
 
-  export namespace Deployment {
-    export interface Version {
-      percentage: number;
+  export namespace Error {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+
+  export interface Message {
+    code: number;
+
+    message: string;
 
-      version_id: string;
+    documentation_url?: string;
+
+    source?: Message.Source;
+  }
+
+  export namespace Message {
+    export interface Source {
+      pointer?: string;
     }
   }
 }
@@ -167,7 +238,7 @@ export interface DeploymentCreateParams {
   /**
    * Body param:
    */
-  annotations?: DeploymentParam;
+  annotations?: DeploymentCreateParams.Annotations;
 }
 
 export namespace DeploymentCreateParams {
@@ -176,6 +247,27 @@ export namespace DeploymentCreateParams {
 
     version_id: string;
   }
+
+  export interface Annotations {
+    /**
+     * Human-readable message about the deployment. Truncated to 100 bytes.
+     */
+    'workers/message'?: string;
+  }
+}
+
+export interface DeploymentListParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+export interface DeploymentDeleteParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
 }
 
 export interface DeploymentGetParams {
@@ -188,9 +280,11 @@ export interface DeploymentGetParams {
 export declare namespace Deployments {
   export {
     type Deployment as Deployment,
-    type DeploymentCreateResponse as DeploymentCreateResponse,
-    type DeploymentGetResponse as DeploymentGetResponse,
+    type DeploymentListResponse as DeploymentListResponse,
+    type DeploymentDeleteResponse as DeploymentDeleteResponse,
     type DeploymentCreateParams as DeploymentCreateParams,
+    type DeploymentListParams as DeploymentListParams,
+    type DeploymentDeleteParams as DeploymentDeleteParams,
     type DeploymentGetParams as DeploymentGetParams,
   };
 }

package/src/resources/workers/scripts/index.ts

@@ -5,9 +5,11 @@ export { Content, type ContentUpdateParams, type ContentGetParams } from './cont
 export {
   Deployments,
   type Deployment,
-  type DeploymentCreateResponse,
-  type DeploymentGetResponse,
+  type DeploymentListResponse,
+  type DeploymentDeleteResponse,
   type DeploymentCreateParams,
+  type DeploymentListParams,
+  type DeploymentDeleteParams,
   type DeploymentGetParams,
 } from './deployments';
 export {

package/src/resources/workers/scripts/script-and-version-settings.ts

@@ -114,13 +114,6 @@ export interface ScriptAndVersionSettingEditResponse {
    */
   logpush?: boolean;
 
-  /**
-   * Migrations to apply for Durable Objects associated with this Worker.
-   */
-  migrations?:
-    | WorkersAPI.SingleStepMigration
-    | ScriptAndVersionSettingEditResponse.WorkersMultipleStepMigrations;
-
   /**
    * Observability settings for the Worker.
    */
@@ -145,7 +138,7 @@ export interface ScriptAndVersionSettingEditResponse {
   /**
    * Usage model for the Worker invocations.
    */
-  usage_model?: 'standard';
+  usage_model?: 'standard' | 'bundled' | 'unbound';
 }
 
 export namespace ScriptAndVersionSettingEditResponse {
@@ -618,24 +611,6 @@ export namespace ScriptAndVersionSettingEditResponse {
     cpu_ms?: number;
   }
 
-  export interface WorkersMultipleStepMigrations {
-    /**
-     * Tag to set as the latest migration tag.
-     */
-    new_tag?: string;
-
-    /**
-     * Tag used to verify against the latest migration tag for this Worker. If they
-     * don't match, the upload is rejected.
-     */
-    old_tag?: string;
-
-    /**
-     * Migrations to apply in order.
-     */
-    steps?: Array<WorkersAPI.MigrationStep>;
-  }
-
   /**
    * Observability settings for the Worker.
    */
@@ -749,13 +724,6 @@ export interface ScriptAndVersionSettingGetResponse {
    */
   logpush?: boolean;
 
-  /**
-   * Migrations to apply for Durable Objects associated with this Worker.
-   */
-  migrations?:
-    | WorkersAPI.SingleStepMigration
-    | ScriptAndVersionSettingGetResponse.WorkersMultipleStepMigrations;
-
   /**
    * Observability settings for the Worker.
    */
@@ -780,7 +748,7 @@ export interface ScriptAndVersionSettingGetResponse {
   /**
    * Usage model for the Worker invocations.
    */
-  usage_model?: 'standard';
+  usage_model?: 'standard' | 'bundled' | 'unbound';
 }
 
 export namespace ScriptAndVersionSettingGetResponse {
@@ -1253,24 +1221,6 @@ export namespace ScriptAndVersionSettingGetResponse {
     cpu_ms?: number;
   }
 
-  export interface WorkersMultipleStepMigrations {
-    /**
-     * Tag to set as the latest migration tag.
-     */
-    new_tag?: string;
-
-    /**
-     * Tag used to verify against the latest migration tag for this Worker. If they
-     * don't match, the upload is rejected.
-     */
-    old_tag?: string;
-
-    /**
-     * Migrations to apply in order.
-     */
-    steps?: Array<WorkersAPI.MigrationStep>;
-  }
-
   /**
    * Observability settings for the Worker.
    */
@@ -1426,7 +1376,7 @@ export namespace ScriptAndVersionSettingEditParams {
     /**
      * Usage model for the Worker invocations.
      */
-    usage_model?: 'standard';
+    usage_model?: 'standard' | 'bundled' | 'unbound';
   }
 
   export namespace Settings {