ebay-api 1.13.4 → 6.0.0

package/lib/auth/oAuth2.js

@@ -0,0 +1,258 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const debug_1 = __importDefault(require("debug"));
+const base_1 = __importDefault(require("../api/base"));
+const log = (0, debug_1.default)('ebay:oauth2');
+/**
+ * https://developer.ebay.com/api-docs/static/oauth-tokens.html
+ *
+ * Client credentials grant flow mints a new Application access token that you can use to access the resources owned by the application.
+ * Authorization code grant flow mints a new User access token that you can use to access the resources owned by the user.
+ */
+class OAuth2 extends base_1.default {
+    constructor() {
+        super(...arguments);
+        this.scope = this.config.scope || OAuth2.defaultScopes;
+    }
+    static generateAuthUrl(sandbox, appId, ruName, scope, state = '') {
+        return [
+            sandbox ? OAuth2.AUTHORIZE_ENDPOINT.sandbox : OAuth2.AUTHORIZE_ENDPOINT.production,
+            '?client_id=', encodeURIComponent(appId),
+            '&redirect_uri=', encodeURIComponent(ruName),
+            '&response_type=code',
+            '&state=', encodeURIComponent(state),
+            '&scope=', encodeURIComponent(scope.join(' '))
+        ].join('');
+    }
+    get identityEndpoint() {
+        return this.config.sandbox ? OAuth2.IDENTITY_ENDPOINT.sandbox : OAuth2.IDENTITY_ENDPOINT.production;
+    }
+    /**
+     * Return the access token.
+     * First return user access token, if not set Application Access Token.
+     */
+    async getAccessToken() {
+        return this.getUserAccessToken() || this.getApplicationAccessToken();
+    }
+    getUserAccessToken() {
+        return this._authToken?.access_token ?? null;
+    }
+    async getApplicationAccessToken() {
+        if (this._clientToken) {
+            log('Return existing application access token: ', this._clientToken);
+            return this._clientToken.access_token;
+        }
+        try {
+            const token = await this.obtainApplicationAccessToken();
+            return token.access_token;
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    setClientToken(clientToken) {
+        this._clientToken = clientToken;
+    }
+    setScope(scope) {
+        this.scope = scope;
+    }
+    getScope() {
+        return [...this.scope];
+    }
+    /**
+     * Client credentials grant flow.
+     */
+    async mintApplicationAccessToken() {
+        if (!this.config.appId) {
+            throw new Error('Missing App ID (Client Id)');
+        }
+        if (!this.config.certId) {
+            throw new Error('Missing Cert Id (Client Secret)');
+        }
+        try {
+            return await this.req.postForm(this.identityEndpoint, {
+                scope: this.scope.join(' '),
+                grant_type: 'client_credentials'
+            }, {
+                auth: {
+                    username: this.config.appId,
+                    password: this.config.certId
+                }
+            });
+        }
+        catch (error) {
+            log('Failed to mint application token', error);
+            throw error;
+        }
+    }
+    /**
+     * Client credentials grant flow.
+     */
+    async obtainApplicationAccessToken() {
+        log('Obtain a new application access token with scope: ', this.scope.join(','));
+        try {
+            const token = await this.mintApplicationAccessToken();
+            log('Obtained a new application access token:', token);
+            this.setClientToken(token);
+            this.emit('refreshClientToken', token);
+            return token;
+        }
+        catch (error) {
+            log('Failed to obtain application token', error);
+            throw error;
+        }
+    }
+    /**
+     * Generates URL for consent page landing.
+     *
+     * @param ruName RuName
+     * @param scope the scopes
+     * @param state state parameter returned in the redirect URL
+     */
+    generateAuthUrl(ruName, scope = this.scope, state = '') {
+        ruName = ruName || this.config.ruName;
+        if (!ruName) {
+            throw new Error('RuName is required.');
+        }
+        return OAuth2.generateAuthUrl(this.config.sandbox, this.config.appId, ruName, scope, state);
+    }
+    /**
+     * Authorization code grant flow.
+     *
+     * Mint the user access token for the given code.
+     *
+     * @param code the code
+     * @param ruName the redirectUri
+     */
+    async mintUserAccessToken(code, ruName = this.config.ruName) {
+        try {
+            const token = await this.req.postForm(this.identityEndpoint, {
+                grant_type: 'authorization_code',
+                code,
+                redirect_uri: ruName
+            }, {
+                auth: {
+                    username: this.config.appId,
+                    password: this.config.certId
+                }
+            });
+            log('User Access Token', token);
+            return token;
+        }
+        catch (error) {
+            log('Failed to get the token', error);
+            throw error;
+        }
+    }
+    /**
+     * Authorization code grant flow.
+     *
+     * Mint the access token for the given code.
+     *
+     * @param code the code
+     * @param ruName the redirectUri
+     */
+    async getToken(code, ruName = this.config.ruName) {
+        return await this.mintUserAccessToken(code, ruName);
+    }
+    /**
+     * Authorization code grant flow.
+     */
+    async refreshUserAccessToken() {
+        if (!this._authToken || !this._authToken.refresh_token) {
+            log('Tried to refresh user access token before it was set.');
+            throw new Error('Failed to refresh the user access token. Token or refresh_token is not set.');
+        }
+        try {
+            const token = await this.req.postForm(this.identityEndpoint, {
+                grant_type: 'refresh_token',
+                refresh_token: this._authToken.refresh_token,
+                scope: this.scope.join(' ')
+            }, {
+                auth: {
+                    username: this.config.appId,
+                    password: this.config.certId
+                }
+            });
+            log('Successfully refreshed token', token);
+            const refreshedToken = {
+                ...this._authToken,
+                ...token
+            };
+            this.setCredentials(refreshedToken);
+            this.emit('refreshAuthToken', refreshedToken);
+            return refreshedToken;
+        }
+        catch (error) {
+            log('Failed to refresh the token', error);
+            throw error;
+        }
+    }
+    /**
+     * Gets and sets the user access token for the given code.
+     *
+     * Authorization code grant flow.
+     *
+     * @param code the code
+     */
+    async obtainToken(code) {
+        const token = await this.getToken(code);
+        log('Obtain user access token', token);
+        this.setCredentials(token);
+        return token;
+    }
+    getCredentials() {
+        if (this._authToken) {
+            return {
+                ...this._authToken
+            };
+        }
+        else if (this._clientToken) {
+            return {
+                ...this._clientToken
+            };
+        }
+        return null;
+    }
+    setCredentials(authToken) {
+        if (typeof authToken === 'string') {
+            this._authToken = {
+                refresh_token: '',
+                expires_in: 7200,
+                refresh_token_expires_in: 47304000,
+                token_type: 'User Access Token',
+                access_token: authToken
+            };
+        }
+        else {
+            this._authToken = authToken;
+        }
+    }
+    /**
+     * Refresh the user access token if set or application access token
+     */
+    async refreshToken() {
+        if (this._authToken) {
+            return await this.refreshUserAccessToken();
+        }
+        else if (this._clientToken) {
+            return await this.obtainApplicationAccessToken();
+        }
+        throw new Error('Missing credentials. To refresh a token an application access token or user access token must be already set.');
+    }
+}
+exports.default = OAuth2;
+// If all the calls in our application require just an Application access token we can use this endpoint
+OAuth2.IDENTITY_ENDPOINT = {
+    production: 'https://api.ebay.com/identity/v1/oauth2/token',
+    sandbox: 'https://api.sandbox.ebay.com/identity/v1/oauth2/token'
+};
+OAuth2.AUTHORIZE_ENDPOINT = {
+    production: 'https://auth.ebay.com/oauth2/authorize',
+    sandbox: 'https://auth.sandbox.ebay.com/oauth2/authorize'
+};
+OAuth2.defaultScopes = ['https://api.ebay.com/oauth/api_scope'];
+//# sourceMappingURL=oAuth2.js.map

package/lib/auth/oAuth2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oAuth2.js","sourceRoot":"","sources":["../../src/auth/oAuth2.ts"],"names":[],"mappings":";;;;;AAAA,kDAA0B;AAC1B,uDAA+B;AAG/B,MAAM,GAAG,GAAG,IAAA,eAAK,EAAC,aAAa,CAAC,CAAC;AAejC;;;;;GAKG;AACH,MAAqB,MAAO,SAAQ,cAAI;IAAxC;;QA+BU,UAAK,GAAU,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,aAAa,CAAC;IAsPnE,CAAC;IAvQQ,MAAM,CAAC,eAAe,CAC3B,OAAgB,EAChB,KAAa,EACb,MAAc,EACd,KAAe,EACf,KAAK,GAAG,EAAE;QAEV,OAAO;YACL,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,UAAU;YAClF,aAAa,EAAE,kBAAkB,CAAC,KAAK,CAAC;YACxC,gBAAgB,EAAE,kBAAkB,CAAC,MAAM,CAAC;YAC5C,qBAAqB;YACrB,SAAS,EAAE,kBAAkB,CAAC,KAAK,CAAC;YACpC,SAAS,EAAE,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC/C,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACb,CAAC;IAMD,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,UAAU,CAAA;IACrG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc;QACzB,OAAO,IAAI,CAAC,kBAAkB,EAAE,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;IACvE,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,UAAU,EAAE,YAAY,IAAI,IAAI,CAAA;IAC9C,CAAC;IAEM,KAAK,CAAC,yBAAyB;QACpC,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,GAAG,CAAC,4CAA4C,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YACrE,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;SACvC;QAED,IAAI;YACF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACxD,OAAO,KAAK,CAAC,YAAY,CAAC;SAC3B;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAEM,cAAc,CAAC,WAAmB;QACvC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAEM,QAAQ,CAAC,KAAY;QAC1B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEM,QAAQ;QACb,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,0BAA0B;QACrC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACpD;QAED,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBACpD,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;gBAC3B,UAAU,EAAE,oBAAoB;aACjC,EAAE;gBACD,IAAI,EAAE;oBACJ,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;oBAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;iBAC7B;aACF,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;YAC/C,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,4BAA4B;QACvC,GAAG,CAAC,oDAAoD,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAEhF,IAAI;YACF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;YAEtD,GAAG,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC;YAEvD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;YAEvC,OAAO,KAAK,CAAC;SACd;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;YACjD,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAED;;;;;;OAMG;IACI,eAAe,CAAC,MAAe,EAAE,QAAkB,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,EAAE;QAC9E,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;QAEtC,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SACxC;QAED,OAAO,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,mBAAmB,CAAC,IAAY,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM;QACxE,IAAI;YACF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBAC3D,UAAU,EAAE,oBAAoB;gBAChC,IAAI;gBACJ,YAAY,EAAE,MAAM;aACrB,EAAE;gBACD,IAAI,EAAE;oBACJ,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;oBAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;iBAC7B;aACF,CAAC,CAAC;YAEH,GAAG,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YAChC,OAAO,KAAK,CAAC;SACd;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;YACtC,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM;QAC7D,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,sBAAsB;QACjC,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE;YACtD,GAAG,CAAC,uDAAuD,CAAC,CAAC;YAC7D,MAAM,IAAI,KAAK,CAAC,6EAA6E,CAAC,CAAC;SAChG;QAED,IAAI;YACF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBAC3D,UAAU,EAAE,eAAe;gBAC3B,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa;gBAC5C,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;aAC5B,EAAE;gBACD,IAAI,EAAE;oBACJ,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;oBAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;iBAC7B;aACF,CAAC,CAAC;YAEH,GAAG,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;YAE3C,MAAM,cAAc,GAAG;gBACrB,GAAG,IAAI,CAAC,UAAU;gBAClB,GAAG,KAAK;aACT,CAAC;YAEF,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC;YAE9C,OAAO,cAAc,CAAC;SACvB;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;YAC1C,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CAAC,IAAY;QACnC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACxC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QAE1B,OAAO,KAAK,CAAA;IACd,CAAC;IAEM,cAAc;QACnB,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO;gBACL,GAAG,IAAI,CAAC,UAAU;aACnB,CAAC;SACH;aAAM,IAAI,IAAI,CAAC,YAAY,EAAE;YAC5B,OAAO;gBACL,GAAG,IAAI,CAAC,YAAY;aACrB,CAAA;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,cAAc,CAAC,SAA6B;QACjD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,IAAI,CAAC,UAAU,GAAG;gBAChB,aAAa,EAAE,EAAE;gBACjB,UAAU,EAAE,IAAI;gBAChB,wBAAwB,EAAE,QAAQ;gBAClC,UAAU,EAAE,mBAAmB;gBAC/B,YAAY,EAAE,SAAS;aACxB,CAAC;SACH;aAAM;YACL,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;SAC7B;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY;QACvB,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;SAC5C;aAAM,IAAI,IAAI,CAAC,YAAY,EAAE;YAC5B,OAAO,MAAM,IAAI,CAAC,4BAA4B,EAAE,CAAC;SAClD;QAED,MAAM,IAAI,KAAK,CAAC,+GAA+G,CAAC,CAAC;IACnI,CAAC;;AApRH,yBAqRC;AApRC,wGAAwG;AACjF,wBAAiB,GAA2B;IACjE,UAAU,EAAE,+CAA+C;IAC3D,OAAO,EAAE,uDAAuD;CACjE,CAAC;AAEqB,yBAAkB,GAA2B;IAClE,UAAU,EAAE,wCAAwC;IACpD,OAAO,EAAE,gDAAgD;CAC1D,CAAC;AAEqB,oBAAa,GAAU,CAAC,sCAAsC,CAAC,CAAC"}