release: 3.2.0

.github/workflows/ci.yml

@@ -28,7 +28,23 @@ jobs:
       - name: Check types
         run: |
           yarn build
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Bootstrap
+        run: ./scripts/bootstrap
 
+      - name: Run tests
+        run: ./scripts/test
   examples:
     name: examples
     runs-on: ubuntu-latest

.github/workflows/publish-npm.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Node
         uses: actions/setup-node@v3

.github/workflows/release-doctor.yml

@@ -10,7 +10,7 @@ jobs:
     if: github.repository == 'cloudflare/cloudflare-typescript' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Check release environment
         run: |

.gitignore

@@ -1,6 +1,7 @@
 node_modules
 yarn-error.log
 codegen.log
+Brewfile.lock.json
 dist
 /deno
 /*.tgz

.release-please-manifest.json

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

.stats.yml

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

Brewfile

@@ -0,0 +1 @@
+brew "node"

jest.config.ts

@@ -17,6 +17,7 @@ const config: JestConfigWithTsJest = {
     '<rootDir>/deno/',
     '<rootDir>/deno_tests/',
   ],
+  testPathIgnorePatterns: ['scripts'],
 };
 
 export default config;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudflare",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "The official TypeScript library for the Cloudflare API",
   "author": "Cloudflare <[email protected]>",
   "types": "dist/index.d.ts",
@@ -14,14 +14,14 @@
   ],
   "private": false,
   "scripts": {
-    "test": "bin/check-test-server && yarn jest",
-    "build": "bash ./build",
+    "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/check-is-in-git-install.sh; then npm run build; fi",
+    "prepare": "if ./scripts/utils/check-is-in-git-install.sh; then ./scripts/build; fi",
     "tsn": "ts-node -r tsconfig-paths/register",
-    "lint": "eslint --ext ts,js .",
+    "lint": "./scripts/lint",
     "fix": "eslint --fix --ext ts,js ."
   },
   "dependencies": {

scripts/bootstrap

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ]; then
+  brew bundle check >/dev/null 2>&1 || {
+    echo "==> Installing Homebrew dependencies…"
+    brew bundle
+  }
+fi
+
+echo "==> Installing Node dependencies…"
+
+PACKAGE_MANAGER=$(command -v yarn >/dev/null 2>&1 && echo "yarn" || echo "npm")
+
+$PACKAGE_MANAGER install

build → scripts/build

@@ -1,7 +1,10 @@
 #!/usr/bin/env bash
+
 set -exuo pipefail
 
-node scripts/check-version.cjs
+cd "$(dirname "$0")/.."
+
+node scripts/utils/check-version.cjs
 
 # Build into dist and will publish the package from there,
 # so that src/resources/foo.ts becomes <package root>/resources/foo.js
@@ -22,7 +25,7 @@ if [ -e "bin/cli" ]; then
 fi
 # this converts the export map paths for the dist directory
 # and does a few other minor things
-node scripts/make-dist-package-json.cjs > dist/package.json
+node scripts/utils/make-dist-package-json.cjs > dist/package.json
 
 # build to .js/.mjs/.d.ts files
 npm exec tsc-multi
@@ -32,22 +35,22 @@ cp src/_shims/auto/*.{d.ts,js,mjs} dist/_shims/auto
 # we need to add exports = module.exports = Cloudflare Node to index.js;
 # No way to get that from index.ts because it would cause compile errors
 # when building .mjs
-node scripts/fix-index-exports.cjs
+node scripts/utils/fix-index-exports.cjs
 # with "moduleResolution": "nodenext", if ESM resolves to index.d.ts,
 # it'll have TS errors on the default import.  But if it resolves to
 # index.d.mts the default import will work (even though both files have
 # the same export default statement)
 cp dist/index.d.ts dist/index.d.mts
 cp tsconfig.dist-src.json dist/src/tsconfig.json
 
-node scripts/postprocess-files.cjs
+node scripts/utils/postprocess-files.cjs
 
 # make sure that nothing crashes when we require the output CJS or
 # import the output ESM
 (cd dist && node -e 'require("cloudflare")')
 (cd dist && node -e 'import("cloudflare")' --input-type=module)
 
-if command -v deno &> /dev/null && [ -e ./build-deno ]
+if command -v deno &> /dev/null && [ -e ./scripts/build-deno ]
 then
-  ./build-deno
+  ./scripts/build-deno
 fi

scripts/lint

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+./node_modules/.bin/eslint --ext ts,js .

scripts/mock

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+if [[ -n "$1" && "$1" != '--'* ]]; then
+  URL="$1"
+  shift
+else
+  URL="$(grep 'openapi_spec_url' .stats.yml | cut -d' ' -f2)"
+fi
+
+# Check if the URL is empty
+if [ -z "$URL" ]; then
+  echo "Error: No OpenAPI spec path/url provided or found in .stats.yml"
+  exit 1
+fi
+
+echo "==> Starting mock server with URL ${URL}"
+
+# Run prism mock on the given spec
+if [ "$1" == "--daemon" ]; then
+  npm exec --package=@stoplight/prism-cli@~5.8 -- prism mock "$URL" &> .prism.log &
+
+  # Wait for server to come online
+  echo -n "Waiting for server"
+  while ! grep -q "✖  fatal\|Prism is listening" ".prism.log" ; do
+    echo -n "."
+    sleep 0.1
+  done
+
+  if grep -q "✖  fatal" ".prism.log"; then
+    cat .prism.log
+    exit 1
+  fi
+
+  echo
+else
+  npm exec  --package=@stoplight/prism-cli@~5.8 -- prism mock "$URL"
+fi

scripts/test

@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[0;33m'
+NC='\033[0m' # No Color
+
+function prism_is_running() {
+  curl --silent "http://localhost:4010" >/dev/null 2>&1
+}
+
+kill_server_on_port() {
+  pids=$(lsof -t -i tcp:"$1" || echo "")
+  if [ "$pids" != "" ]; then
+    kill "$pids"
+    echo "Stopped $pids."
+  fi
+}
+
+function is_overriding_api_base_url() {
+  [ -n "$TEST_API_BASE_URL" ]
+}
+
+if ! is_overriding_api_base_url && ! prism_is_running ; then
+  # When we exit this script, make sure to kill the background mock server process
+  trap 'kill_server_on_port 4010' EXIT
+
+  # Start the dev server
+  ./scripts/mock --daemon
+fi
+
+if is_overriding_api_base_url ; then
+  echo -e "${GREEN}✔ Running tests against ${TEST_API_BASE_URL}${NC}"
+  echo
+elif ! prism_is_running ; then
+  echo -e "${RED}ERROR:${NC} The test suite will not run without a mock Prism server"
+  echo -e "running against your OpenAPI spec."
+  echo
+  echo -e "To run the server, pass in the path or url of your OpenAPI"
+  echo -e "spec to the prism command:"
+  echo
+  echo -e "  \$ ${YELLOW}npm exec --package=@stoplight/prism-cli@~5.3.2 -- prism mock path/to/your.openapi.yml${NC}"
+  echo
+
+  exit 1
+else
+  echo -e "${GREEN}✔ Mock prism server is running with your OpenAPI spec${NC}"
+  echo
+fi
+
+# Run tests
+echo "==> Running tests"
+./node_modules/.bin/jest "$@"

scripts/check-version.cjs → scripts/utils/check-version.cjs

@@ -2,14 +2,14 @@ const fs = require('fs');
 const path = require('path');
 
 const main = () => {
-  const pkg = require('../package.json');
+  const pkg = require('../../package.json');
   const version = pkg['version'];
   if (!version) throw 'The version property is not set in the package.json file';
   if (typeof version !== 'string') {
     throw `Unexpected type for the package.json version field; got ${typeof version}, expected string`;
   }
 
-  const versionFile = path.resolve(__dirname, '..', 'src', 'version.ts');
+  const versionFile = path.resolve(__dirname, '..', '..', 'src', 'version.ts');
   const contents = fs.readFileSync(versionFile, 'utf8');
   const output = contents.replace(/(export const VERSION = ')(.*)(')/g, `$1${version}$3`);
   fs.writeFileSync(versionFile, output);

scripts/fix-index-exports.cjs → scripts/utils/fix-index-exports.cjs

@@ -4,7 +4,7 @@ const path = require('path');
 const indexJs =
   process.env['DIST_PATH'] ?
     path.resolve(process.env['DIST_PATH'], 'index.js')
-  : path.resolve(__dirname, '..', 'dist', 'index.js');
+  : path.resolve(__dirname, '..', '..', 'dist', 'index.js');
 
 let before = fs.readFileSync(indexJs, 'utf8');
 let after = before.replace(

scripts/make-dist-package-json.cjs → scripts/utils/make-dist-package-json.cjs

@@ -1,4 +1,4 @@
-const pkgJson = require(process.env['PKG_JSON_PATH'] || '../package.json');
+const pkgJson = require(process.env['PKG_JSON_PATH'] || '../../package.json');
 
 function processExportMap(m) {
   for (const key in m) {

scripts/postprocess-files.cjs → scripts/utils/postprocess-files.cjs

@@ -2,12 +2,12 @@ const fs = require('fs');
 const path = require('path');
 const { parse } = require('@typescript-eslint/parser');
 
-const pkgImportPath = process.env['PKG_IMPORT_PATH'] ?? 'cloudflare/'
+const pkgImportPath = process.env['PKG_IMPORT_PATH'] ?? 'cloudflare/';
 
 const distDir =
   process.env['DIST_PATH'] ?
     path.resolve(process.env['DIST_PATH'])
-  : path.resolve(__dirname, '..', 'dist');
+  : path.resolve(__dirname, '..', '..', 'dist');
 const distSrcDir = path.join(distDir, 'src');
 
 /**
@@ -103,7 +103,7 @@ async function* walk(dir) {
 }
 
 async function postprocess() {
-  for await (const file of walk(path.resolve(__dirname, '..', 'dist'))) {
+  for await (const file of walk(path.resolve(__dirname, '..', '..', 'dist'))) {
     if (!/\.([cm]?js|(\.d)?[cm]?ts)$/.test(file)) continue;
 
     const code = await fs.promises.readFile(file, 'utf8');