netlify 13.1.9 → 13.1.11

package/lib/index.d.ts

@@ -1,11 +1,50 @@
-export class NetlifyAPI {
-    constructor(firstArg: any, secondArg: any);
-    set accessToken(arg: string | null);
+type APIOptions = {
+    /** @example 'netlify/js-client' */
+    userAgent?: string;
+    /** @example 'https' */
+    scheme?: string;
+    /** @example 'api.netlify.com' */
+    host?: string;
+    /** @example '/api/v1' */
+    pathPrefix?: string;
+    accessToken?: string;
+    /** @example 'HttpsProxyAgent' */
+    agent?: string;
+    /**
+     * parameters you want available for every request.
+     * Global params are only sent of the OpenAPI spec specifies the provided params.
+     */
+    globalParams?: Record<string, unknown>;
+};
+export declare class NetlifyAPI {
+    #private;
+    defaultHeaders: Record<string, string>;
+    /** The protocol is used like `https` */
+    scheme: string;
+    host: string;
+    pathPrefix: string;
+    agent?: string;
+    globalParams: Record<string, unknown>;
+    constructor(options?: APIOptions);
+    constructor(accessToken: string | undefined, options?: APIOptions);
+    /** Retrieves the access token */
     get accessToken(): string | null;
+    set accessToken(token: string | null);
     get basePath(): string;
     getAccessToken(ticket: any, { poll, timeout }?: {
         poll?: number | undefined;
         timeout?: number | undefined;
-    }): Promise<any>;
+    }): Promise<string>;
+    showTicket(_config: {
+        ticketId: string;
+    }): Promise<{
+        authorized: boolean;
+    }>;
+    exchangeTicket(_config: {
+        ticketId: string;
+    }): Promise<{
+        access_token: string;
+    }>;
 }
-export const methods: any[];
+export declare const methods: any[];
+export {};

package/lib/index.js

@@ -2,36 +2,55 @@ import pWaitFor from 'p-wait-for';
 import { getMethods } from './methods/index.js';
 import { openApiSpec } from './open_api.js';
 import { getOperations } from './operations.js';
+// 1 second
+const DEFAULT_TICKET_POLL = 1e3;
+// 1 hour
+const DEFAULT_TICKET_TIMEOUT = 3.6e6;
 export class NetlifyAPI {
+    #accessToken = null;
+    defaultHeaders = {
+        accept: 'application/json',
+    };
+    /** The protocol is used like `https` */
+    scheme;
+    host;
+    pathPrefix;
+    agent;
+    globalParams = {};
     constructor(firstArg, secondArg) {
         // variadic arguments
-        const [accessTokenInput, opts = {}] = typeof firstArg === 'object' ? [null, firstArg] : [firstArg, secondArg];
-        // default opts
-        const { userAgent = 'netlify/js-client', scheme = openApiSpec.schemes[0], host = openApiSpec.host, pathPrefix = openApiSpec.basePath, accessToken = accessTokenInput, globalParams = {}, agent, } = opts;
-        const defaultHeaders = {
-            'User-agent': userAgent,
-            accept: 'application/json',
-        };
-        const basePath = getBasePath({ scheme, host, pathPrefix });
-        const methods = getMethods({ basePath, defaultHeaders, agent, globalParams });
-        Object.assign(this, { ...methods, defaultHeaders, scheme, host, pathPrefix, globalParams, accessToken, agent });
+        const [accessTokenInput, options = {}] = typeof firstArg === 'object' ? [null, firstArg] : [firstArg, secondArg];
+        this.globalParams = options.globalParams || {};
+        this.agent = options.agent;
+        this.scheme = options.scheme || openApiSpec.schemes[0];
+        this.host = options.host || openApiSpec.host;
+        this.pathPrefix = options.pathPrefix || openApiSpec.basePath;
+        // use the setter to set the header as well
+        this.accessToken = options.accessToken || accessTokenInput || null;
+        this.defaultHeaders['User-agent'] = options.userAgent || 'netlify/js-client';
+        const methods = getMethods({
+            basePath: this.basePath,
+            defaultHeaders: this.defaultHeaders,
+            agent: this.agent,
+            globalParams: this.globalParams,
+        });
+        Object.assign(this, { ...methods });
     }
+    /** Retrieves the access token */
     get accessToken() {
-        const { defaultHeaders: { Authorization }, } = this;
-        if (typeof Authorization !== 'string' || !Authorization.startsWith('Bearer ')) {
-            return null;
-        }
-        return Authorization.replace('Bearer ', '');
+        return this.#accessToken;
     }
     set accessToken(token) {
         if (!token) {
             delete this.defaultHeaders.Authorization;
+            this.#accessToken = null;
             return;
         }
-        this.defaultHeaders.Authorization = `Bearer ${token}`;
+        this.#accessToken = token;
+        this.defaultHeaders.Authorization = `Bearer ${this.#accessToken}`;
     }
     get basePath() {
-        return getBasePath({ scheme: this.scheme, host: this.host, pathPrefix: this.pathPrefix });
+        return `${this.scheme}://${this.host}${this.pathPrefix}`;
     }
     async getAccessToken(ticket, { poll = DEFAULT_TICKET_POLL, timeout = DEFAULT_TICKET_TIMEOUT } = {}) {
         const { id } = ticket;
@@ -54,12 +73,15 @@ export class NetlifyAPI {
         this.accessToken = accessTokenResponse.access_token;
         return accessTokenResponse.access_token;
     }
+    // Those methods are getting implemented by the Object.assign(this, { ...methods }) in the constructor
+    // This is a way where we can still maintain proper types while not implementing them.
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    showTicket(_config) {
+        throw new Error('Will be overridden in constructor!');
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    exchangeTicket(_config) {
+        throw new Error('Will be overridden in constructor!');
+    }
 }
-const getBasePath = function ({ scheme, host, pathPrefix }) {
-    return `${scheme}://${host}${pathPrefix}`;
-};
-// 1 second
-const DEFAULT_TICKET_POLL = 1e3;
-// 1 hour
-const DEFAULT_TICKET_TIMEOUT = 3.6e6;
 export const methods = getOperations();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify",
   "description": "Netlify Node.js API client",
-  "version": "13.1.9",
+  "version": "13.1.11",
   "type": "module",
   "exports": "./lib/index.js",
   "main": "./lib/index.js",
@@ -41,7 +41,7 @@
     "node client"
   ],
   "dependencies": {
-    "@netlify/open-api": "^2.19.0",
+    "@netlify/open-api": "^2.26.0",
     "lodash-es": "^4.17.21",
     "micro-api-client": "^3.3.0",
     "node-fetch": "^3.0.0",
@@ -51,7 +51,7 @@
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.6",
-    "@types/node": "^18.14.2",
+    "@types/node": "^14.18.53",
     "ava": "^4.0.0",
     "c8": "^7.11.0",
     "from2-string": "^1.1.0",
@@ -63,5 +63,5 @@
   "engines": {
     "node": "^14.16.0 || >=16.0.0"
   },
-  "gitHead": "2f5a0d4c921ca8f8ae7e559410908f538ffb3d72"
+  "gitHead": "01ca6c705c4b568b7552a7d90a9801ebdc747594"
 }