netlify 13.3.0 → 13.3.1

package/lib/index.d.ts

@@ -17,6 +17,17 @@ type APIOptions = {
      */
     globalParams?: Record<string, unknown>;
 };
+/**
+ * The Netlify API client.
+ * @see {@link https://open-api.netlify.com | Open API Reference}
+ * @see {@link https://docs.netlify.com/api/get-started | Online Documentation}
+ *
+ * @example
+ * ```ts
+ * const client = new NetlifyAPI('YOUR_ACCESS_TOKEN')
+ * const sites = await client.listSites()
+ * ```
+ */
 export interface NetlifyAPI extends DynamicMethods {
 }
 export declare class NetlifyAPI {

package/lib/types.d.ts

@@ -1,4 +1,16 @@
+import type { ReadStream } from 'node:fs';
 import type { operations } from '@netlify/open-api';
+import type { RequestInit } from 'node-fetch';
+/**
+ * Determines whether all keys in T are optional.
+ */
+type AreAllOptional<T> = keyof T extends never ? true : T extends Record<string, any> ? {
+    [K in keyof T]-?: undefined extends T[K] ? never : K;
+}[keyof T] extends never ? true : false : false;
+/**
+ * Determines whether `path` and `query` are both optional.
+ */
+type IsPathAndQueryOptional<K extends keyof operations> = 'parameters' extends keyof operations[K] ? AreAllOptional<'path' extends keyof operations[K]['parameters'] ? operations[K]['parameters']['path'] : object> extends true ? AreAllOptional<'query' extends keyof operations[K]['parameters'] ? operations[K]['parameters']['query'] : object> extends true ? true : false : false : true;
 /**
  * Converts snake_case to camelCase for TypeScript types.
  */
@@ -10,19 +22,108 @@ type SnakeToCamel<T> = {
     [K in keyof T as CamelCase<K & string>]: T[K];
 };
 /**
- * Combines snake_case and camelCase parameters.
+ * Combines snake_case and camelCase parameters into one Params type.
+ */
+type Params<T> = SnakeToCamel<T> | T;
+type HasRequestBody<K extends keyof operations> = 'requestBody' extends keyof operations[K] ? operations[K]['requestBody'] extends {
+    content: any;
+} ? 'application/json' extends keyof operations[K]['requestBody']['content'] ? true : 'application/octet-stream' extends keyof operations[K]['requestBody']['content'] ? true : false : false : false;
+/**
+ * Extracts the request body type from the operation.
+ */
+type RequestBody<K extends keyof operations> = 'requestBody' extends keyof operations[K] ? operations[K]['requestBody'] extends {
+    content: any;
+} ? 'application/json' extends keyof operations[K]['requestBody']['content'] ? operations[K]['requestBody']['content']['application/json'] : 'application/octet-stream' extends keyof operations[K]['requestBody']['content'] ? ReadStream | (() => ReadStream) : never : never : never;
+type IsRequestBodyJson<K extends keyof operations> = 'requestBody' extends keyof operations[K] ? operations[K]['requestBody'] extends {
+    content: any;
+} ? 'application/json' extends keyof operations[K]['requestBody']['content'] ? true : false : false : false;
+type IsRequestBodyOctetStream<K extends keyof operations> = 'requestBody' extends keyof operations[K] ? operations[K]['requestBody'] extends {
+    content: any;
+} ? 'application/octet-stream' extends keyof operations[K]['requestBody']['content'] ? true : false : false : false;
+type RequestBodyParam<K extends keyof operations> = HasRequestBody<K> extends true ? IsRequestBodyOptional<K> extends true ? DetailedRequestBodyOptional<K> : DetailedRequestBody<K> : never;
+type DetailedRequestBody<K extends keyof operations> = IsRequestBodyJson<K> extends true ? {
+    /**
+     * The request body for `application/json`.
+     * Automatically serialized to JSON based on the operation.
+     * Can be a JSON object or a function returning one.
+     */
+    body: RequestBody<K> | (() => RequestBody<K>);
+} : IsRequestBodyOctetStream<K> extends true ? {
+    /**
+     * The request body for `application/octet-stream`.
+     * Can be a Node.js readable stream or a function returning one
+     * @example
+     * fs.createReadStream('./file')
+     * @example
+     * () => fs.createReadStream('./file')
+     */
+    body: ReadStream | (() => ReadStream);
+} : never;
+type DetailedRequestBodyOptional<K extends keyof operations> = IsRequestBodyJson<K> extends true ? {
+    /**
+     * The request body for `application/json`.
+     * Automatically serialized to JSON based on the operation.
+     * Can be a JSON object or a function returning one.
+     */
+    body?: RequestBody<K> | (() => RequestBody<K>);
+} : IsRequestBodyOctetStream<K> extends true ? {
+    /**
+     * The request body for `application/octet-stream`.
+     * Can be a Node.js readable stream or a function returning one
+     * @example
+     * fs.createReadStream('./file')
+     * @example
+     * () => fs.createReadStream('./file')
+     */
+    body?: ReadStream | (() => ReadStream);
+} : never;
+/**
+ * Determines whether all properties in the request body are optional.
+ */
+type IsRequestBodyOptional<K extends keyof operations> = HasRequestBody<K> extends true ? (AreAllOptional<RequestBody<K>> extends true ? true : false) : true;
+/**
+ * Determines whether any parameters or request body are required.
+ */
+type IsParamsOrRequestBodyRequired<K extends keyof operations> = 'parameters' extends keyof operations[K] ? IsPathAndQueryOptional<K> extends true ? IsRequestBodyOptional<K> extends true ? false : true : true : false;
+/**
+ * Extracts and combines `path` and `query` parameters into a single type.
  */
-type CombinedCaseParams<T> = SnakeToCamel<T> | T;
+type ExtractPathAndQueryParameters<K extends keyof operations> = 'parameters' extends keyof operations[K] ? 'path' extends keyof operations[K]['parameters'] ? 'query' extends keyof operations[K]['parameters'] ? Params<Omit<operations[K]['parameters']['path'], keyof operations[K]['parameters']['query']> & operations[K]['parameters']['query']> : Params<operations[K]['parameters']['path']> : 'query' extends keyof operations[K]['parameters'] ? Params<operations[K]['parameters']['query']> : undefined : undefined;
 /**
- * Combines `path` and `query` parameters into a single type.
+ * Combines path, query, and request body parameters into a single type.
  */
-type OperationParams<K extends keyof operations> = 'parameters' extends keyof operations[K] ? 'path' extends keyof operations[K]['parameters'] ? 'query' extends keyof operations[K]['parameters'] ? CombinedCaseParams<Omit<operations[K]['parameters']['path'], keyof operations[K]['parameters']['query']> & operations[K]['parameters']['query']> : CombinedCaseParams<operations[K]['parameters']['path']> : 'query' extends keyof operations[K]['parameters'] ? CombinedCaseParams<operations[K]['parameters']['query']> : undefined : undefined;
+type CombinedParamsAndRequestBody<K extends keyof operations> = HasRequestBody<K> extends true ? ExtractPathAndQueryParameters<K> & RequestBodyParam<K> : ExtractPathAndQueryParameters<K>;
+type OperationParams<K extends keyof operations> = IsParamsOrRequestBodyRequired<K> extends false ? CombinedParamsAndRequestBody<K> | void | undefined : CombinedParamsAndRequestBody<K>;
 type SuccessHttpStatusCodes = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226;
 /**
  * Extracts the response type from the operation.
  */
 type OperationResponse<K extends keyof operations> = 'responses' extends keyof operations[K] ? SuccessHttpStatusCodes extends infer StatusKeys ? StatusKeys extends keyof operations[K]['responses'] ? 'content' extends keyof operations[K]['responses'][StatusKeys] ? 'application/json' extends keyof operations[K]['responses'][StatusKeys]['content'] ? operations[K]['responses'][StatusKeys]['content']['application/json'] : never : never : never : never : never;
 export type DynamicMethods = {
-    [K in keyof operations]: (params: OperationParams<K>) => Promise<OperationResponse<K>>;
+    [K in keyof operations]: (params: OperationParams<K>, 
+    /**
+     * Any properties you want passed to `node-fetch`.
+     *
+     * The `headers` property is merged with some `defaultHeaders`:
+     * ```ts
+     * {
+     *  'User-agent': 'netlify-js-client',
+     *  'accept': 'application/json',
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * const site = await client.getSite(
+     *  { site_id: 'YOUR_SITE_ID' },
+     *  {
+     *    headers: {
+     *      'X-Example-Header': 'Example Value',
+     *    },
+     *  },
+     * )
+     * ```
+     */
+    opts?: RequestInit | void | undefined) => Promise<OperationResponse<K>>;
 };
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify",
   "description": "Netlify Node.js API client",
-  "version": "13.3.0",
+  "version": "13.3.1",
   "type": "module",
   "exports": "./lib/index.js",
   "main": "./lib/index.js",
@@ -63,5 +63,5 @@
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "0a66a5592b80f8b2e2538ebc385d3eea8777c7b7"
+  "gitHead": "bba5964d53efc4efe7ff7f1f5ff139d81c8c840b"
 }