netlify 9.0.0 → 10.0.0

package/README.md

@@ -8,39 +8,32 @@ A Netlify [OpenAPI](https://github.com/netlify/open-api) client that works in th
 ## Usage
 
 ```js
-const NetlifyAPI = require('netlify')
+import { NetlifyAPI } from 'netlify'
 
-const listNetlifySites = async function () {
-  const client = new NetlifyAPI('1234myAccessToken')
-  const sites = await client.listSites()
-  return sites
-}
+const client = new NetlifyAPI('1234myAccessToken')
+const sites = await client.listSites()
 ```
 
 ## Using OpenAPI operations
 
 ```js
-const NetlifyAPI = require('netlify')
+import { NetlifyAPI } from 'netlify'
 
 const client = new NetlifyAPI('1234myAccessToken')
 
-const listCreateAndDeleteSite = async function () {
-  // Fetch sites
-  const sites = await client.listSites()
+// Fetch sites
+const sites = await client.listSites()
 
-  // Create a site. Notice `body` here for sending OpenAPI body
-  const site = await client.createSite({
-    body: {
-      name: `my-awesome-site`,
-      // ... https://open-api.netlify.com/#/default/createSite
-    },
-  })
+// Create a site. Notice `body` here for sending OpenAPI body
+const site = await client.createSite({
+  body: {
+    name: `my-awesome-site`,
+    // ... https://open-api.netlify.com/#/default/createSite
+  },
+})
 
-  // Delete site. Notice `site_id` is a path parameter https://open-api.netlify.com/#/default/deleteSite
-  await client.deleteSite({
-    site_id: siteId,
-  })
-}
+// Delete site. Notice `site_id` is a path parameter https://open-api.netlify.com/#/default/deleteSite
+await client.deleteSite({ site_id: siteId })
 ```
 
 ## API
@@ -124,16 +117,14 @@ const opts = {
 All operations are conveniently consumed with async/await:
 
 ```js
-const getSomeData = async () => {
+try {
+  const siteDeploy = await client.getSiteDeploy({
+    siteId: '1234abcd',
+    deploy_id: '4567',
+  })
   // Calls may fail!
-  try {
-    return await client.getSiteDeploy({
-      siteId: '1234abcd',
-      deploy_id: '4567',
-    })
-  } catch (error) {
-    // handle error
-  }
+} catch (error) {
+  // handle error
 }
 ```
 
@@ -162,19 +153,15 @@ const opts = {
 See the [authenticating](https://www.netlify.com/docs/api/#authenticating) docs for more context.
 
 ```js
-// example:
-const open = require('open') // installed with 'npm i open'
+import open from 'open'
 
-const login = async () => {
-  const ticket = await client.createTicket({
-    clientId: CLIENT_ID,
-  })
-  // Open browser for authentication
-  await open(`https://app.netlify.com/authorize?response_type=ticket&ticket=${ticket.id}`)
-  const accessToken = await client.getAccessToken(ticket)
-  // API is also set up to use the returned access token as a side effect
-  return accessToken // Save this for later so you can quickly set up an authenticated client
-}
+const ticket = await client.createTicket({ clientId: CLIENT_ID })
+// Open browser for authentication
+await open(`https://app.netlify.com/authorize?response_type=ticket&ticket=${ticket.id}`)
+
+// API is also set up to use the returned access token as a side effect
+// Save this for later so you can quickly set up an authenticated client
+const accessToken = await client.getAccessToken(ticket)
 ```
 
 ## Proxy support
@@ -183,7 +170,7 @@ const login = async () => {
 `http.Agent` that can handle your situation as `agent` option:
 
 ```js
-const HttpsProxyAgent = require('https-proxy-agent')
+import HttpsProxyAgent from 'https-proxy-agent'
 
 const proxyUri = 'http(s)://[user:password@]proxyhost:port'
 const agent = new HttpsProxyAgent(proxyUri)
@@ -195,11 +182,6 @@ const client = new NetlifyAPI('1234myAccessToken', { agent })
 Support for site deployment has been removed from this package in version 7.0.0. You should consider using the
 [`deploy` command](https://cli.netlify.com/commands/deploy/) of Netlify CLI.
 
-## UMD Builds
-
-A UMD build is provided for your convenience, however browser support is still experimental. Contributions to improve
-browser support are welcome.
-
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for more info on how to make contributions to this project.

package/package.json

@@ -1,19 +1,17 @@
 {
   "name": "netlify",
   "description": "Netlify Node.js API client",
-  "version": "9.0.0",
+  "version": "10.0.0",
+  "type": "module",
   "files": [
     "src/**/*.js",
-    "!src/**/*.test.js",
-    "dist/main.js",
-    "dist/main.js.map"
+    "!src/**/*.test.js"
   ],
+  "exports": "./src/index.js",
   "main": "./src/index.js",
-  "unpkg": "./dist/main.js",
-  "umd:main": "./dist/main.js",
   "scripts": {
-    "prepublishOnly": "npm ci && run-s test build",
-    "test": "npm run format && npm run test:dev",
+    "prepublishOnly": "npm ci && npm test",
+    "test": "run-s format test:dev",
     "format": "run-s format:check-fix:*",
     "format:lint": "eslint --ignore-path .gitignore --fix --cache --format=codeframe --max-warnings=0 \"src/**/*.js\"",
     "format:prettier": "prettier --ignore-path .gitignore --write --loglevel warn \"src/**/*.js\" \"*.{js,md,yml,json}\" \"!package-lock.json\"",
@@ -26,12 +24,11 @@
     "format:fix:prettier": "cross-env-shell prettier --write $npm_package_config_prettier",
     "test:dev": "ava",
     "test:ci": "nyc -r lcovonly -r text -r json ava",
-    "update-snapshots": "ava -u",
-    "build": "webpack"
+    "update-snapshots": "ava -u"
   },
   "config": {
-    "eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,tests,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
-    "prettier": "--ignore-path .gitignore --loglevel=warn \"{src,tests,.github}/**/*.{js,md,yml,json,html}\" \"*.{js,yml,json,html}\" \".*.{js,yml,json,html}\" \"!package-lock.json\" \"!CHANGELOG.md\""
+    "eslint": "--ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,tests,.github}/**/*.{cjs,mjs,js,md,html}\" \"*.{cjs,mjs,js,md,html}\" \".*.{cjs,mjs,js,md,html}\"",
+    "prettier": "--ignore-path .gitignore --loglevel=warn \"{src,tests,.github}/**/*.{cjs,mjs,js,md,yml,json,html}\" \"*.{cjs,mjs,js,yml,json,html}\" \".*.{cjs,mjs,js,yml,json,html}\" \"!package-lock.json\" \"!CHANGELOG.md\""
   },
   "husky": {
     "hooks": {
@@ -71,21 +68,14 @@
     "qs": "^6.9.6"
   },
   "devDependencies": {
-    "@babel/core": "^7.12.17",
-    "@babel/plugin-transform-runtime": "^7.12.17",
-    "@babel/preset-env": "^7.12.17",
-    "@babel/runtime": "^7.12.18",
-    "@netlify/eslint-config-node": "^3.3.8",
-    "ava": "^2.4.0",
-    "babel-loader": "^8.2.2",
+    "@netlify/eslint-config-node": "^3.3.10",
+    "ava": "^3.0.0",
     "from2-string": "^1.1.0",
     "husky": "^4.3.8",
     "nock": "^13.0.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
-    "uuid": "^8.3.2",
-    "webpack": "^4.46.0",
-    "webpack-cli": "^4.5.0"
+    "uuid": "^8.3.2"
   },
   "engines": {
     "node": "^12.20.0 || ^14.14.0 || >=16.0.0"
@@ -94,8 +84,6 @@
     "files": [
       "src/**/*.test.js"
     ],
-    "compileEnhancements": false,
-    "babel": false,
     "verbose": true
   }
 }

package/src/index.js

@@ -1,10 +1,10 @@
-const dfn = require('@netlify/open-api')
-const pWaitFor = require('p-wait-for')
+import pWaitFor from 'p-wait-for'
 
-const { getMethods } = require('./methods')
-const { getOperations } = require('./operations')
+import { getMethods } from './methods/index.js'
+import { openApiSpec } from './open_api.js'
+import { getOperations } from './operations.js'
 
-class NetlifyAPI {
+export class NetlifyAPI {
   constructor(firstArg, secondArg) {
     // variadic arguments
     const [accessTokenInput, opts = {}] = typeof firstArg === 'object' ? [null, firstArg] : [firstArg, secondArg]
@@ -12,9 +12,9 @@ class NetlifyAPI {
     // default opts
     const {
       userAgent = 'netlify/js-client',
-      scheme = dfn.schemes[0],
-      host = dfn.host,
-      pathPrefix = dfn.basePath,
+      scheme = openApiSpec.schemes[0],
+      host = openApiSpec.host,
+      pathPrefix = openApiSpec.basePath,
       accessToken = accessTokenInput,
       globalParams = {},
       agent,
@@ -89,6 +89,4 @@ const DEFAULT_TICKET_POLL = 1e3
 // 1 hour
 const DEFAULT_TICKET_TIMEOUT = 3.6e6
 
-module.exports = NetlifyAPI
-
-module.exports.methods = getOperations()
+export const methods = getOperations()

package/src/methods/body.js

@@ -1,5 +1,5 @@
 // Handle request body
-const addBody = function (body, parameters, opts) {
+export const addBody = function (body, parameters, opts) {
   if (!body) {
     return opts
   }
@@ -28,5 +28,3 @@ const isBinaryBody = function (parameters) {
 const isBodyParam = function ({ schema }) {
   return schema && schema.format === 'binary'
 }
-
-module.exports = { addBody }

package/src/methods/index.js

@@ -1,17 +1,15 @@
-const nodeFetch = require('node-fetch')
-// Webpack will sometimes export default exports in different places
-const fetch = nodeFetch.default || nodeFetch
+import fetch from 'node-fetch'
 
-const { getOperations } = require('../operations')
+import { getOperations } from '../operations.js'
 
-const { addBody } = require('./body')
-const { parseResponse, getFetchError } = require('./response')
-const { shouldRetry, waitForRetry, MAX_RETRY } = require('./retry')
-const { getUrl } = require('./url')
+import { addBody } from './body.js'
+import { parseResponse, getFetchError } from './response.js'
+import { shouldRetry, waitForRetry, MAX_RETRY } from './retry.js'
+import { getUrl } from './url.js'
 
 // For each OpenAPI operation, add a corresponding method.
 // The `operationId` is the method name.
-const getMethods = function ({ basePath, defaultHeaders, agent, globalParams }) {
+export const getMethods = function ({ basePath, defaultHeaders, agent, globalParams }) {
   const operations = getOperations()
   const methods = operations.map((method) => getMethod({ method, basePath, defaultHeaders, agent, globalParams }))
   return Object.assign({}, ...methods)
@@ -90,5 +88,3 @@ const makeRequest = async function (url, opts) {
     return { error: errorA }
   }
 }
-
-module.exports = { getMethods }

package/src/methods/response.js

@@ -1,8 +1,8 @@
-const { JSONHTTPError, TextHTTPError } = require('micro-api-client')
-const omit = require('omit.js').default
+import { JSONHTTPError, TextHTTPError } from 'micro-api-client'
+import omit from 'omit.js'
 
 // Read and parse the HTTP response
-const parseResponse = async function (response) {
+export const parseResponse = async function (response) {
   const responseType = getResponseType(response)
   const textResponse = await response.text()
 
@@ -38,12 +38,10 @@ const parseJsonResponse = function (response, textResponse, responseType) {
   }
 }
 
-const getFetchError = function (error, url, opts) {
-  const data = omit(opts, ['Authorization'])
+export const getFetchError = function (error, url, opts) {
+  const data = omit.default(opts, ['Authorization'])
   error.name = 'FetchError'
   error.url = url
   error.data = data
   return error
 }
-
-module.exports = { parseResponse, getFetchError }

package/src/methods/retry.js

@@ -1,7 +1,7 @@
 // We retry:
 //  - when receiving a rate limiting response
 //  - on network failures due to timeouts
-const shouldRetry = function ({ response = {}, error = {} }) {
+export const shouldRetry = function ({ response = {}, error = {} }) {
   return isRetryStatus(response) || RETRY_ERROR_CODES.has(error.code)
 }
 
@@ -9,7 +9,7 @@ const isRetryStatus = function ({ status }) {
   return typeof status === 'number' && (status === RATE_LIMIT_STATUS || String(status).startsWith('5'))
 }
 
-const waitForRetry = async function (response) {
+export const waitForRetry = async function (response) {
   const delay = getDelay(response)
   await sleep(delay)
 }
@@ -37,9 +37,7 @@ const sleep = function (ms) {
 const DEFAULT_RETRY_DELAY = 5e3
 const MIN_RETRY_DELAY = 1e3
 const SECS_TO_MSECS = 1e3
-const MAX_RETRY = 5
+export const MAX_RETRY = 5
 const RATE_LIMIT_STATUS = 429
 const RATE_LIMIT_HEADER = 'X-RateLimit-Reset'
 const RETRY_ERROR_CODES = new Set(['ETIMEDOUT', 'ECONNRESET'])
-
-module.exports = { shouldRetry, waitForRetry, MAX_RETRY }

package/src/methods/url.js

@@ -1,9 +1,9 @@
-const camelCase = require('lodash.camelcase')
-const queryString = require('qs')
+import camelCase from 'lodash.camelcase'
+import queryString from 'qs'
 
 // Replace path parameters and query parameters in the URI, using the OpenAPI
 // definition
-const getUrl = function ({ path, parameters }, basePath, requestParams) {
+export const getUrl = function ({ path, parameters }, basePath, requestParams) {
   const url = `${basePath}${path}`
   const urlA = addPathParams(url, parameters, requestParams)
   const urlB = addQueryParams(urlA, parameters, requestParams)
@@ -45,5 +45,3 @@ const getRequestParam = function (param, requestParams, name) {
     throw new Error(`Missing required ${name} '${param.name}'`)
   }
 }
-
-module.exports = { getUrl }

package/src/open_api.js

@@ -0,0 +1,7 @@
+import { createRequire } from 'module'
+
+// TODO: remove once Node.js supports JSON imports with pure ES modules without
+// any experimental flags
+const require = createRequire(import.meta.url)
+
+export const openApiSpec = require('@netlify/open-api')

package/src/operations.js

@@ -1,10 +1,11 @@
-const { paths } = require('@netlify/open-api')
-const omit = require('omit.js').default
+import omit from 'omit.js'
+
+import { openApiSpec } from './open_api.js'
 
 // Retrieve all OpenAPI operations
-const getOperations = function () {
-  return Object.entries(paths).flatMap(([path, pathItem]) => {
-    const operations = omit(pathItem, ['parameters'])
+export const getOperations = function () {
+  return Object.entries(openApiSpec.paths).flatMap(([path, pathItem]) => {
+    const operations = omit.default(pathItem, ['parameters'])
     return Object.entries(operations).map(([method, operation]) => {
       const parameters = getParameters(pathItem.parameters, operation.parameters)
       return { ...operation, verb: method, path, parameters }
@@ -20,5 +21,3 @@ const getParameters = function (pathParameters = [], operationParameters = []) {
 const addParameter = function (parameters, param) {
   return { ...parameters, [param.in]: { ...parameters[param.in], [param.name]: param } }
 }
-
-module.exports = { getOperations }