ebay-api 8.4.1 → 8.5.1

package/lib/auth/authNAuth.d.ts

@@ -1,49 +1,49 @@
-import Base from '../api/base.js';
-import { IEBayApiRequest } from '../request.js';
-import { AppConfig } from '../types/index.js';
-export type AuthToken = {
-    eBayAuthToken: string;
-    Timestamp?: string;
-    HardExpirationTime?: string;
-};
-export default class AuthNAuth extends Base {
-    static readonly SIGNIN_ENDPOINT: {
-        sandbox: string;
-        production: string;
-    };
-    static readonly API_ENDPOINT: {
-        production: string;
-        sandbox: string;
-    };
-    static generateAuthUrl(sandbox: boolean, ruName: string, sessionId: string, prompt?: boolean): string;
-    private authToken;
-    constructor(config: AppConfig, req?: IEBayApiRequest);
-    get apiEndpoint(): string;
-    /**
-     * Generates URL for consent page landing.
-     *
-     * @param ruName RuName
-     */
-    getSessionIdAndAuthUrl(ruName?: string): Promise<{
-        sessionId: any;
-        url: string;
-    }>;
-    mintToken(sessionId: string): Promise<any>;
-    obtainToken(sessionId: string): Promise<any>;
-    setAuthToken(authToken: AuthToken | string | null): void;
-    getAuthToken(): AuthToken | null;
-    get eBayAuthToken(): string | null;
-    getRequestConfig(callName: string): {
-        useIaf: boolean;
-        xmlns: string;
-        endpoint: string;
-        headers: {
-            'X-EBAY-API-CALL-NAME': string;
-            'X-EBAY-API-CERT-NAME': string;
-            'X-EBAY-API-APP-NAME': string;
-            'X-EBAY-API-DEV-NAME': string | undefined;
-            'X-EBAY-API-SITEID': number;
-            'X-EBAY-API-COMPATIBILITY-LEVEL': number;
-        };
-    };
-}
+import Base from '../api/base.js';
+import { IEBayApiRequest } from '../request.js';
+import { AppConfig } from '../types/index.js';
+export type AuthToken = {
+    eBayAuthToken: string;
+    Timestamp?: string;
+    HardExpirationTime?: string;
+};
+export default class AuthNAuth extends Base {
+    static readonly SIGNIN_ENDPOINT: {
+        sandbox: string;
+        production: string;
+    };
+    static readonly API_ENDPOINT: {
+        production: string;
+        sandbox: string;
+    };
+    static generateAuthUrl(sandbox: boolean, ruName: string, sessionId: string, prompt?: boolean): string;
+    private authToken;
+    constructor(config: AppConfig, req?: IEBayApiRequest);
+    get apiEndpoint(): string;
+    /**
+     * Generates URL for consent page landing.
+     *
+     * @param ruName RuName
+     */
+    getSessionIdAndAuthUrl(ruName?: string): Promise<{
+        sessionId: any;
+        url: string;
+    }>;
+    mintToken(sessionId: string): Promise<any>;
+    obtainToken(sessionId: string): Promise<any>;
+    setAuthToken(authToken: AuthToken | string | null): void;
+    getAuthToken(): AuthToken | null;
+    get eBayAuthToken(): string | null;
+    getRequestConfig(callName: string): {
+        useIaf: boolean;
+        xmlns: string;
+        endpoint: string;
+        headers: {
+            'X-EBAY-API-CALL-NAME': string;
+            'X-EBAY-API-CERT-NAME': string;
+            'X-EBAY-API-APP-NAME': string;
+            'X-EBAY-API-DEV-NAME': string | undefined;
+            'X-EBAY-API-SITEID': import("../eBayApi.js").SiteId;
+            'X-EBAY-API-COMPATIBILITY-LEVEL': number;
+        };
+    };
+}

package/lib/auth/authNAuth.js

@@ -1,122 +1,122 @@
-"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_js_1 = __importDefault(require("../api/base.js"));
-const XMLRequest_js_1 = __importDefault(require("../api/traditional/XMLRequest.js"));
-const log = (0, debug_1.default)('ebay:authNAuth');
-class AuthNAuth extends base_js_1.default {
-    static generateAuthUrl(sandbox, ruName, sessionId, prompt = false) {
-        return [
-            sandbox ? AuthNAuth.SIGNIN_ENDPOINT.sandbox : AuthNAuth.SIGNIN_ENDPOINT.production,
-            '?SignIn',
-            '&RuName=', encodeURIComponent(ruName),
-            '&SessID=', encodeURIComponent(sessionId),
-            prompt ? '&prompt=login' : ''
-        ].join('');
-    }
-    constructor(config, req) {
-        super(config, req);
-        this.authToken = null;
-        if (this.config.authToken) {
-            this.setAuthToken(this.config.authToken);
-        }
-    }
-    get apiEndpoint() {
-        return this.config.sandbox ? AuthNAuth.API_ENDPOINT.sandbox : AuthNAuth.API_ENDPOINT.production;
-    }
-    /**
-     * Generates URL for consent page landing.
-     *
-     * @param ruName RuName
-     */
-    async getSessionIdAndAuthUrl(ruName) {
-        if (!this.config.devId) {
-            throw new Error('DevId is required.');
-        }
-        ruName = ruName || this.config.ruName;
-        if (!ruName) {
-            throw new Error('RuName is required.');
-        }
-        const xmlApi = new XMLRequest_js_1.default('GetSessionID', {
-            RuName: ruName
-        }, this.getRequestConfig('GetSessionID'), this.req);
-        const data = await xmlApi.request();
-        log('GetSessionID data', data);
-        return {
-            sessionId: data.SessionID,
-            url: AuthNAuth.generateAuthUrl(this.config.sandbox, ruName, data.SessionID)
-        };
-    }
-    async mintToken(sessionId) {
-        if (!this.config.devId) {
-            throw new Error('DevId is required.');
-        }
-        const xmlApi = new XMLRequest_js_1.default('FetchToken', {
-            SessionID: sessionId
-        }, this.getRequestConfig('FetchToken'), this.req);
-        try {
-            return await xmlApi.request();
-        }
-        catch (error) {
-            log('Fetch auth token failed', error);
-            throw error;
-        }
-    }
-    async obtainToken(sessionId) {
-        const token = await this.mintToken(sessionId);
-        log('Obtain auth token', token);
-        this.setAuthToken(token);
-        return token;
-    }
-    setAuthToken(authToken) {
-        if (typeof authToken === 'string') {
-            this.authToken = {
-                eBayAuthToken: authToken
-            };
-        }
-        else {
-            this.authToken = authToken;
-        }
-    }
-    getAuthToken() {
-        if (!this.authToken) {
-            return null;
-        }
-        return {
-            ...this.authToken
-        };
-    }
-    get eBayAuthToken() {
-        return this.authToken?.eBayAuthToken ?? null;
-    }
-    getRequestConfig(callName) {
-        if (typeof this.config.siteId !== 'number') {
-            throw new Error('"siteId" is required for Auth\'n\'Auth.');
-        }
-        return {
-            useIaf: false,
-            xmlns: 'urn:ebay:apis:eBLBaseComponents',
-            endpoint: this.apiEndpoint,
-            headers: {
-                'X-EBAY-API-CALL-NAME': callName,
-                'X-EBAY-API-CERT-NAME': this.config.certId,
-                'X-EBAY-API-APP-NAME': this.config.appId,
-                'X-EBAY-API-DEV-NAME': this.config.devId,
-                'X-EBAY-API-SITEID': this.config.siteId,
-                'X-EBAY-API-COMPATIBILITY-LEVEL': 967
-            }
-        };
-    }
-}
-exports.default = AuthNAuth;
-AuthNAuth.SIGNIN_ENDPOINT = {
-    sandbox: 'https://signin.sandbox.ebay.com/ws/eBayISAPI.dll',
-    production: 'https://signin.ebay.com/ws/eBayISAPI.dll'
-};
-AuthNAuth.API_ENDPOINT = {
-    production: 'https://api.ebay.com/ws/api.dll',
-    sandbox: 'https://api.sandbox.ebay.com/ws/api.dll'
-};
+"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_js_1 = __importDefault(require("../api/base.js"));
+const XMLRequest_js_1 = __importDefault(require("../api/traditional/XMLRequest.js"));
+const log = (0, debug_1.default)('ebay:authNAuth');
+class AuthNAuth extends base_js_1.default {
+    static generateAuthUrl(sandbox, ruName, sessionId, prompt = false) {
+        return [
+            sandbox ? AuthNAuth.SIGNIN_ENDPOINT.sandbox : AuthNAuth.SIGNIN_ENDPOINT.production,
+            '?SignIn',
+            '&RuName=', encodeURIComponent(ruName),
+            '&SessID=', encodeURIComponent(sessionId),
+            prompt ? '&prompt=login' : ''
+        ].join('');
+    }
+    constructor(config, req) {
+        super(config, req);
+        this.authToken = null;
+        if (this.config.authToken) {
+            this.setAuthToken(this.config.authToken);
+        }
+    }
+    get apiEndpoint() {
+        return this.config.sandbox ? AuthNAuth.API_ENDPOINT.sandbox : AuthNAuth.API_ENDPOINT.production;
+    }
+    /**
+     * Generates URL for consent page landing.
+     *
+     * @param ruName RuName
+     */
+    async getSessionIdAndAuthUrl(ruName) {
+        if (!this.config.devId) {
+            throw new Error('DevId is required.');
+        }
+        ruName = ruName || this.config.ruName;
+        if (!ruName) {
+            throw new Error('RuName is required.');
+        }
+        const xmlApi = new XMLRequest_js_1.default('GetSessionID', {
+            RuName: ruName
+        }, this.getRequestConfig('GetSessionID'), this.req);
+        const data = await xmlApi.request();
+        log('GetSessionID data', data);
+        return {
+            sessionId: data.SessionID,
+            url: AuthNAuth.generateAuthUrl(this.config.sandbox, ruName, data.SessionID)
+        };
+    }
+    async mintToken(sessionId) {
+        if (!this.config.devId) {
+            throw new Error('DevId is required.');
+        }
+        const xmlApi = new XMLRequest_js_1.default('FetchToken', {
+            SessionID: sessionId
+        }, this.getRequestConfig('FetchToken'), this.req);
+        try {
+            return await xmlApi.request();
+        }
+        catch (error) {
+            log('Fetch auth token failed', error);
+            throw error;
+        }
+    }
+    async obtainToken(sessionId) {
+        const token = await this.mintToken(sessionId);
+        log('Obtain auth token', token);
+        this.setAuthToken(token);
+        return token;
+    }
+    setAuthToken(authToken) {
+        if (typeof authToken === 'string') {
+            this.authToken = {
+                eBayAuthToken: authToken
+            };
+        }
+        else {
+            this.authToken = authToken;
+        }
+    }
+    getAuthToken() {
+        if (!this.authToken) {
+            return null;
+        }
+        return {
+            ...this.authToken
+        };
+    }
+    get eBayAuthToken() {
+        return this.authToken?.eBayAuthToken ?? null;
+    }
+    getRequestConfig(callName) {
+        if (typeof this.config.siteId !== 'number') {
+            throw new Error('"siteId" is required for Auth\'n\'Auth.');
+        }
+        return {
+            useIaf: false,
+            xmlns: 'urn:ebay:apis:eBLBaseComponents',
+            endpoint: this.apiEndpoint,
+            headers: {
+                'X-EBAY-API-CALL-NAME': callName,
+                'X-EBAY-API-CERT-NAME': this.config.certId,
+                'X-EBAY-API-APP-NAME': this.config.appId,
+                'X-EBAY-API-DEV-NAME': this.config.devId,
+                'X-EBAY-API-SITEID': this.config.siteId,
+                'X-EBAY-API-COMPATIBILITY-LEVEL': 967
+            }
+        };
+    }
+}
+AuthNAuth.SIGNIN_ENDPOINT = {
+    sandbox: 'https://signin.sandbox.ebay.com/ws/eBayISAPI.dll',
+    production: 'https://signin.ebay.com/ws/eBayISAPI.dll'
+};
+AuthNAuth.API_ENDPOINT = {
+    production: 'https://api.ebay.com/ws/api.dll',
+    sandbox: 'https://api.sandbox.ebay.com/ws/api.dll'
+};
+exports.default = AuthNAuth;

package/lib/auth/index.d.ts

@@ -1,17 +1,17 @@
-import Base from '../api/base.js';
-import { IEBayApiRequest } from '../request.js';
-import { AppConfig } from '../types/index.js';
-import AuthNAuth from './authNAuth.js';
-import OAuth2 from './oAuth2.js';
-/**
- * Container with Auth'N'Auth and OAuth2.
- */
-export default class Auth extends Base {
-    readonly authNAuth: AuthNAuth;
-    readonly oAuth2: OAuth2;
-    readonly OAuth2: OAuth2;
-    constructor(config: AppConfig, req: IEBayApiRequest);
-    getHeaderAuthorization(useIaf: boolean): Promise<{
-        Authorization: string;
-    }>;
-}
+import Base from '../api/base.js';
+import { IEBayApiRequest } from '../request.js';
+import { AppConfig } from '../types/index.js';
+import AuthNAuth from './authNAuth.js';
+import OAuth2 from './oAuth2.js';
+/**
+ * Container with Auth'N'Auth and OAuth2.
+ */
+export default class Auth extends Base {
+    readonly authNAuth: AuthNAuth;
+    readonly oAuth2: OAuth2;
+    readonly OAuth2: OAuth2;
+    constructor(config: AppConfig, req: IEBayApiRequest);
+    getHeaderAuthorization(useIaf: boolean): Promise<{
+        Authorization: string;
+    }>;
+}

package/lib/auth/index.js

@@ -1,31 +1,31 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_js_1 = __importDefault(require("../api/base.js"));
-const authNAuth_js_1 = __importDefault(require("./authNAuth.js"));
-const oAuth2_js_1 = __importDefault(require("./oAuth2.js"));
-/**
- * Container with Auth'N'Auth and OAuth2.
- */
-class Auth extends base_js_1.default {
-    constructor(config, req) {
-        super(config, req);
-        this.authNAuth = new authNAuth_js_1.default(this.config, this.req);
-        this.OAuth2 = new oAuth2_js_1.default(this.config, this.req);
-        this.oAuth2 = this.OAuth2;
-    }
-    async getHeaderAuthorization(useIaf) {
-        if (this.authNAuth.eBayAuthToken) {
-            return {
-                Authorization: 'Token ' + this.authNAuth.eBayAuthToken
-            };
-        }
-        const accessToken = await this.OAuth2.getAccessToken();
-        return {
-            Authorization: (useIaf ? 'IAF ' : 'Bearer ') + accessToken
-        };
-    }
-}
-exports.default = Auth;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_js_1 = __importDefault(require("../api/base.js"));
+const authNAuth_js_1 = __importDefault(require("./authNAuth.js"));
+const oAuth2_js_1 = __importDefault(require("./oAuth2.js"));
+/**
+ * Container with Auth'N'Auth and OAuth2.
+ */
+class Auth extends base_js_1.default {
+    constructor(config, req) {
+        super(config, req);
+        this.authNAuth = new authNAuth_js_1.default(this.config, this.req);
+        this.OAuth2 = new oAuth2_js_1.default(this.config, this.req);
+        this.oAuth2 = this.OAuth2;
+    }
+    async getHeaderAuthorization(useIaf) {
+        if (this.authNAuth.eBayAuthToken) {
+            return {
+                Authorization: 'Token ' + this.authNAuth.eBayAuthToken
+            };
+        }
+        const accessToken = await this.OAuth2.getAccessToken();
+        return {
+            Authorization: (useIaf ? 'IAF ' : 'Bearer ') + accessToken
+        };
+    }
+}
+exports.default = Auth;

package/lib/auth/oAuth2.d.ts

@@ -1,95 +1,95 @@
-import { EventCallback } from '../nanoevents.js';
-import Base from '../api/base.js';
-import { IEBayApiRequest } from '../request.js';
-import { AppConfig, Scope } from '../types/index.js';
-export type Token = {
-    access_token: string;
-    expires_in: number;
-    token_type: string;
-};
-export type ClientToken = Token;
-export type AuthToken = Token & {
-    refresh_token: string;
-    refresh_token_expires_in: number;
-};
-/**
- * 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.
- */
-export default class OAuth2 extends Base {
-    static readonly IDENTITY_ENDPOINT: Record<string, string>;
-    static readonly AUTHORIZE_ENDPOINT: Record<string, string>;
-    static readonly defaultScopes: Scope;
-    private readonly emitter;
-    private scope;
-    private _clientToken?;
-    private _authToken?;
-    constructor(config: AppConfig, req: IEBayApiRequest);
-    on(event: string, callback: EventCallback): () => void;
-    static generateAuthUrl(sandbox: boolean, appId: string, ruName: string, scope: string[], state?: string): string;
-    get identityEndpoint(): string;
-    /**
-     * Return the access token.
-     * First return user access token, if not set Application Access Token.
-     */
-    getAccessToken(): Promise<string>;
-    getUserAccessToken(): string | null;
-    getApplicationAccessToken(): Promise<string>;
-    setClientToken(clientToken?: Token): void;
-    setScope(scope: Scope): void;
-    getScope(): string[];
-    /**
-     * Client credentials grant flow.
-     */
-    mintApplicationAccessToken(): Promise<ClientToken>;
-    /**
-     * Client credentials grant flow.
-     */
-    obtainApplicationAccessToken(): Promise<ClientToken>;
-    /**
-     * Generates URL for consent page landing.
-     *
-     * @param ruName RuName
-     * @param scope the scopes
-     * @param state state parameter returned in the redirect URL
-     */
-    generateAuthUrl(ruName?: string, scope?: string[], state?: string): string;
-    /**
-     * Authorization code grant flow.
-     *
-     * Mint the user access token for the given code.
-     *
-     * @param code the code
-     * @param ruName the redirectUri
-     */
-    mintUserAccessToken(code: string, ruName?: string | undefined): Promise<any>;
-    /**
-     * Authorization code grant flow.
-     *
-     * Mint the access token for the given code.
-     *
-     * @param code the code
-     * @param ruName the redirectUri
-     */
-    getToken(code: string, ruName?: string | undefined): Promise<any>;
-    /**
-     * Authorization code grant flow.
-     */
-    refreshUserAccessToken(): Promise<AuthToken>;
-    /**
-     * Gets and sets the user access token for the given code.
-     *
-     * Authorization code grant flow.
-     *
-     * @param code the code
-     */
-    obtainToken(code: string): Promise<AuthToken>;
-    getCredentials(): AuthToken | ClientToken | null;
-    setCredentials(authToken: AuthToken | string): void;
-    /**
-     * Refresh the user access token if set or application access token
-     */
-    refreshToken(): Promise<Token>;
-}
+import { EventCallback } from '../nanoevents.js';
+import Base from '../api/base.js';
+import { IEBayApiRequest } from '../request.js';
+import { AppConfig, Scope } from '../types/index.js';
+export type Token = {
+    access_token: string;
+    expires_in: number;
+    token_type: string;
+};
+export type ClientToken = Token;
+export type AuthToken = Token & {
+    refresh_token: string;
+    refresh_token_expires_in: number;
+};
+/**
+ * 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.
+ */
+export default class OAuth2 extends Base {
+    static readonly IDENTITY_ENDPOINT: Record<string, string>;
+    static readonly AUTHORIZE_ENDPOINT: Record<string, string>;
+    static readonly defaultScopes: Scope;
+    private readonly emitter;
+    private scope;
+    private _clientToken?;
+    private _authToken?;
+    constructor(config: AppConfig, req: IEBayApiRequest);
+    on(event: string, callback: EventCallback): () => void;
+    static generateAuthUrl(sandbox: boolean, appId: string, ruName: string, scope: string[], state?: string): string;
+    get identityEndpoint(): string;
+    /**
+     * Return the access token.
+     * First return user access token, if not set Application Access Token.
+     */
+    getAccessToken(): Promise<string>;
+    getUserAccessToken(): string | null;
+    getApplicationAccessToken(): Promise<string>;
+    setClientToken(clientToken?: Token): void;
+    setScope(scope: Scope): void;
+    getScope(): string[];
+    /**
+     * Client credentials grant flow.
+     */
+    mintApplicationAccessToken(): Promise<ClientToken>;
+    /**
+     * Client credentials grant flow.
+     */
+    obtainApplicationAccessToken(): Promise<ClientToken>;
+    /**
+     * Generates URL for consent page landing.
+     *
+     * @param ruName RuName
+     * @param scope the scopes
+     * @param state state parameter returned in the redirect URL
+     */
+    generateAuthUrl(ruName?: string, scope?: string[], state?: string): string;
+    /**
+     * Authorization code grant flow.
+     *
+     * Mint the user access token for the given code.
+     *
+     * @param code the code
+     * @param ruName the redirectUri
+     */
+    mintUserAccessToken(code: string, ruName?: string | undefined): Promise<any>;
+    /**
+     * Authorization code grant flow.
+     *
+     * Mint the access token for the given code.
+     *
+     * @param code the code
+     * @param ruName the redirectUri
+     */
+    getToken(code: string, ruName?: string | undefined): Promise<any>;
+    /**
+     * Authorization code grant flow.
+     */
+    refreshUserAccessToken(): Promise<AuthToken>;
+    /**
+     * Gets and sets the user access token for the given code.
+     *
+     * Authorization code grant flow.
+     *
+     * @param code the code
+     */
+    obtainToken(code: string): Promise<AuthToken>;
+    getCredentials(): AuthToken | ClientToken | null;
+    setCredentials(authToken: AuthToken | string): void;
+    /**
+     * Refresh the user access token if set or application access token
+     */
+    refreshToken(): Promise<Token>;
+}