Merge pull request #498 from cloudflare/release-please--branches--mai…

…n--changes--next--components--cloudflare

release: 3.3.0

.github/workflows/ci.yml

@@ -22,12 +22,10 @@ jobs:
           node-version: '18'
 
       - name: Install dependencies
-        run: |
-          yarn install
+        run: yarn install
 
       - name: Check types
-        run: |
-          yarn build
+        run: ./scripts/lint
   test:
     name: test
     runs-on: ubuntu-latest

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.2.0"
+  ".": "3.3.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 1274
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-07ec76fab00de3d6227209faf0af1ed586cde9e2f243c13d3db555da20f13d99.yml
+configured_endpoints: 1348
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-49d54760f87326f9200c777f867e4ea579c92a43f481207ae252db9748c9b07b.yml

README.md

@@ -1,6 +1,6 @@
 # Cloudflare Typescript API Library
 
-[![NPM version](https://img.shields.io/npm/v/cloudflare.svg)](https://npmjs.org/package/cloudflare)
+[![NPM version](https://img.shields.io/npm/v/cloudflare.svg)](https://npmjs.org/package/cloudflare) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/cloudflare)
 
 This library provides convenient access to the Cloudflare REST API from server-side TypeScript or JavaScript.
 

SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainlessapi.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at [email protected].
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Cloudflare please follow the respective company's security reporting guidelines.
+
+### Cloudflare Terms and Policies
+
+Please contact [email protected] for any questions or concerns regarding security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudflare",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "The official TypeScript library for the Cloudflare API",
   "author": "Cloudflare <[email protected]>",
   "types": "dist/index.d.ts",
@@ -16,7 +16,6 @@
   "scripts": {
     "test": "./scripts/test",
     "build": "./scripts/build",
-    "prepack": "echo 'to pack, run yarn build && (cd dist; yarn pack)' && exit 1",
     "prepublishOnly": "echo 'to publish, run yarn build && (cd dist; yarn publish)' && exit 1",
     "format": "prettier --write --cache --cache-strategy metadata . !dist",
     "prepare": "if ./scripts/utils/check-is-in-git-install.sh; then ./scripts/build; fi",

scripts/format

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+echo "==> Running eslint --fix"
+./node_modules/.bin/eslint --fix --ext ts,js .

scripts/lint

@@ -4,4 +4,5 @@ set -e
 
 cd "$(dirname "$0")/.."
 
+echo "==> Running eslint"
 ./node_modules/.bin/eslint --ext ts,js .

scripts/test

@@ -52,6 +52,5 @@ else
   echo
 fi
 
-# Run tests
 echo "==> Running tests"
 ./node_modules/.bin/jest "$@"

src/core.ts

@@ -18,7 +18,7 @@ import {
   type HeadersInit,
 } from './_shims/index';
 export { type Response };
-import { isMultipartBody } from './uploads';
+import { BlobLike, isBlobLike, isMultipartBody } from './uploads';
 export {
   maybeMultipartFormRequestOptions,
   multipartFormRequestOptions,
@@ -235,7 +235,17 @@ export abstract class APIClient {
     path: string,
     opts?: PromiseOrValue<RequestOptions<Req>>,
   ): APIPromise<Rsp> {
-    return this.request(Promise.resolve(opts).then((opts) => ({ method, path, ...opts })));
+    return this.request(
+      Promise.resolve(opts).then(async (opts) => {
+        const body =
+          opts && isBlobLike(opts?.body) ? new DataView(await opts.body.arrayBuffer())
+          : opts?.body instanceof DataView ? opts.body
+          : opts?.body instanceof ArrayBuffer ? new DataView(opts.body)
+          : opts && ArrayBuffer.isView(opts?.body) ? new DataView(opts.body.buffer)
+          : opts?.body;
+        return { method, path, ...opts, body };
+      }),
+    );
   }
 
   getAPIList<Item, PageClass extends AbstractPage<Item> = AbstractPage<Item>>(
@@ -257,6 +267,8 @@ export abstract class APIClient {
         const encoded = encoder.encode(body);
         return encoded.length.toString();
       }
+    } else if (ArrayBuffer.isView(body)) {
+      return body.byteLength.toString();
     }
 
     return null;
@@ -266,7 +278,9 @@ export abstract class APIClient {
     const { method, path, query, headers: headers = {} } = options;
 
     const body =
-      isMultipartBody(options.body) ? options.body.body
+      ArrayBuffer.isView(options.body) || (options.__binaryRequest && typeof options.body === 'string') ?
+        options.body
+      : isMultipartBody(options.body) ? options.body.body
       : options.body ? JSON.stringify(options.body, null, 2)
       : null;
     const contentLength = this.calculateContentLength(body);
@@ -721,7 +735,9 @@ export type Headers = Record<string, string | null | undefined>;
 export type DefaultQuery = Record<string, string | undefined>;
 export type KeysEnum<T> = { [P in keyof Required<T>]: true };
 
-export type RequestOptions<Req = unknown | Record<string, unknown> | Readable> = {
+export type RequestOptions<
+  Req = unknown | Record<string, unknown> | Readable | BlobLike | ArrayBufferView | ArrayBuffer,
+> = {
   method?: HTTPMethod;
   path?: string;
   query?: Req | undefined;
@@ -735,6 +751,7 @@ export type RequestOptions<Req = unknown | Record<string, unknown> | Readable> =
   signal?: AbortSignal | undefined | null;
   idempotencyKey?: string;
 
+  __binaryRequest?: boolean | undefined;
   __binaryResponse?: boolean | undefined;
 };
 
@@ -755,6 +772,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   signal: true,
   idempotencyKey: true,
 
+  __binaryRequest: true,
   __binaryResponse: true,
 };
 
@@ -767,10 +785,11 @@ export const isRequestOptions = (obj: unknown): obj is RequestOptions => {
   );
 };
 
-export type FinalRequestOptions<Req = unknown | Record<string, unknown> | Readable> = RequestOptions<Req> & {
-  method: HTTPMethod;
-  path: string;
-};
+export type FinalRequestOptions<Req = unknown | Record<string, unknown> | Readable | DataView> =
+  RequestOptions<Req> & {
+    method: HTTPMethod;
+    path: string;
+  };
 
 declare const Deno: any;
 declare const EdgeRuntime: any;

src/error.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { castToError, Headers } from './core';
-import * as Shared from 'cloudflare/resources/shared';
+import * as Shared from './resources/shared';
 
 export class CloudflareError extends Error {}
 

src/index.ts

@@ -5,8 +5,8 @@ import * as Errors from './error';
 import { type Agent } from './_shims/index';
 import * as Uploads from './uploads';
 import * as qs from 'qs';
-import * as Pagination from 'cloudflare/pagination';
-import * as API from 'cloudflare/resources/index';
+import * as Pagination from './pagination';
+import * as API from './resources/index';
 
 export interface ClientOptions {
   /**
@@ -180,6 +180,7 @@ export class Cloudflare extends Core.APIClient {
   kv: API.KV = new API.KV(this);
   durableObjects: API.DurableObjects = new API.DurableObjects(this);
   queues: API.Queues = new API.Queues(this);
+  apiGateway: API.APIGateway = new API.APIGateway(this);
   managedHeaders: API.ManagedHeaders = new API.ManagedHeaders(this);
   pageShield: API.PageShield = new API.PageShield(this);
   rulesets: API.Rulesets = new API.Rulesets(this);
@@ -224,6 +225,7 @@ export class Cloudflare extends Core.APIClient {
   cloudforceOne: API.CloudforceOne = new API.CloudforceOne(this);
   eventNotifications: API.EventNotifications = new API.EventNotifications(this);
   aiGateway: API.AIGateway = new API.AIGateway(this);
+  iam: API.IAM = new API.IAM(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
@@ -466,6 +468,8 @@ export namespace Cloudflare {
 
   export import Queues = API.Queues;
 
+  export import APIGateway = API.APIGateway;
+
   export import ManagedHeaders = API.ManagedHeaders;
 
   export import PageShield = API.PageShield;
@@ -554,6 +558,8 @@ export namespace Cloudflare {
 
   export import AIGateway = API.AIGateway;
 
+  export import IAM = API.IAM;
+
   export import ASN = API.ASN;
   export import AuditLog = API.AuditLog;
   export import CertificateCA = API.CertificateCA;

src/resources/accounts/accounts.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from 'cloudflare/core';
-import { APIResource } from 'cloudflare/resource';
-import { isRequestOptions } from 'cloudflare/core';
-import * as MembersAPI from 'cloudflare/resources/accounts/members';
-import * as RolesAPI from 'cloudflare/resources/accounts/roles';
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as MembersAPI from './members';
+import * as RolesAPI from './roles';
+import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
 
 export class Accounts extends APIResource {
   members: MembersAPI.Members = new MembersAPI.Members(this._client);
@@ -86,6 +86,11 @@ export namespace Account {
    * Account settings
    */
   export interface Settings {
+    /**
+     * Sets an abuse contact email to notify for abuse reports.
+     */
+    abuse_contact_email?: string;
+
     /**
      * Specifies the default nameservers to be used for new zones added to this
      * account.
@@ -116,11 +121,11 @@ export namespace Account {
   }
 }
 
-export type AccountUpdateResponse = unknown | string | null;
+export type AccountUpdateResponse = unknown;
 
 export type AccountListResponse = unknown;
 
-export type AccountGetResponse = unknown | string | null;
+export type AccountGetResponse = unknown;
 
 export interface AccountUpdateParams {
   /**
@@ -144,6 +149,11 @@ export namespace AccountUpdateParams {
    * Account settings
    */
   export interface Settings {
+    /**
+     * Sets an abuse contact email to notify for abuse reports.
+     */
+    abuse_contact_email?: string;
+
     /**
      * Specifies the default nameservers to be used for new zones added to this
      * account.
@@ -194,8 +204,11 @@ export namespace Accounts {
   export import Members = MembersAPI.Members;
   export import Status = MembersAPI.Status;
   export import UserWithInviteCode = MembersAPI.UserWithInviteCode;
+  export import MemberCreateResponse = MembersAPI.MemberCreateResponse;
+  export import MemberUpdateResponse = MembersAPI.MemberUpdateResponse;
   export import MemberListResponse = MembersAPI.MemberListResponse;
   export import MemberDeleteResponse = MembersAPI.MemberDeleteResponse;
+  export import MemberGetResponse = MembersAPI.MemberGetResponse;
   export import MemberListResponsesV4PagePaginationArray = MembersAPI.MemberListResponsesV4PagePaginationArray;
   export import MemberCreateParams = MembersAPI.MemberCreateParams;
   export import MemberUpdateParams = MembersAPI.MemberUpdateParams;

src/resources/accounts/index.ts

@@ -5,8 +5,11 @@ export { RoleGetResponse, RoleListParams, RoleGetParams, Roles } from './roles';
 export {
   Status,
   UserWithInviteCode,
+  MemberCreateResponse,
+  MemberUpdateResponse,
   MemberListResponse,
   MemberDeleteResponse,
+  MemberGetResponse,
   MemberCreateParams,
   MemberUpdateParams,
   MemberListParams,