@motionpicture/coa-service 9.7.0-alpha.2 → 9.7.0-alpha.3

package/README.md

@@ -2,7 +2,6 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/@motionpicture/coa-service.svg)](https://www.npmjs.com/package/@motionpicture/coa-service)
 [![CircleCI](https://circleci.com/gh/motionpicture/coa-service.svg?style=shield)](https://circleci.com/gh/motionpicture/coa-service)
-[![Coverage Status](https://coveralls.io/repos/github/motionpicture/coa-service/badge.svg?branch=master)](https://coveralls.io/github/motionpicture/coa-service?branch=master)
 [![Known Vulnerabilities](https://snyk.io/test/github/motionpicture/coa-service/badge.svg)](https://snyk.io/test/github/motionpicture/coa-service)
 [![npm](https://img.shields.io/npm/dm/@motionpicture/coa-service.svg)](https://nodei.co/npm/@motionpicture/coa-service/)
 

package/lib/auth/refreshTokenClient.js

@@ -1,26 +1,26 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RefreshTokenClient = void 0;
-const createDebug = require("debug");
-const http_status_1 = require("http-status");
+const debug_1 = __importDefault(require("debug"));
 // import { default as fetch } from 'node-fetch';
+const httpStatus_1 = require("../httpStatus");
 const transporters_1 = require("../transporters");
-const debug = createDebug('coa-service:auth:refreshTokenClient');
+const debug = (0, debug_1.default)('coa-service:auth:refreshTokenClient');
 const TIMEOUT = 10000;
 const MAX_NUM_TRY_REQUEST = 1;
 /**
  * リフレッシュトークン認証クライアント
  */
 class RefreshTokenClient {
+    /**
+     * アクセストークンの有効期限までの猶予時間初期値
+     */
+    static DEFAULT_SPARE_TIME_IN_MILLISECONDS = 60000;
+    credentials;
+    options;
     constructor(options) {
         this.options = options;
         this.credentials = {};
@@ -28,80 +28,73 @@ class RefreshTokenClient {
     /**
      * トークンエンドポイントからアクセストークンを取得します。
      */
-    getTokenWithFetch() {
-        return __awaiter(this, void 0, void 0, function* () {
-            debug('requesting an access token...');
+    async getTokenWithFetch() {
+        debug('requesting an access token...');
+        try {
+            const params = new URLSearchParams({ refresh_token: String(this.options.refreshToken) });
+            const res = await fetch(`${this.options.endpoint}/token/access_token`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/x-www-form-urlencoded'
+                },
+                body: params,
+                signal: AbortSignal.timeout(TIMEOUT)
+            });
+            let body;
             try {
-                const params = new URLSearchParams({ refresh_token: String(this.options.refreshToken) });
-                const res = yield fetch(`${this.options.endpoint}/token/access_token`, {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/x-www-form-urlencoded'
-                    },
-                    body: params,
-                    signal: AbortSignal.timeout(TIMEOUT)
-                });
-                let body;
-                try {
-                    body = yield res.json();
-                }
-                catch (error) {
-                    // no op
-                }
-                debug('res.status:', res.status, 'body:', body);
-                switch (res.status) {
-                    case http_status_1.OK:
-                        this.credentials = body;
-                        break;
-                    default:
-                        let err = new Error('Unexpected error occurred.');
-                        if (body !== undefined && body !== null) {
-                            if (typeof body === 'string') {
-                                err = new Error(body);
-                            }
-                            else if (typeof body.message === 'string' && body.message.length > 0) {
-                                // エラーレスポンスにメッセージがあった場合
-                                err = new Error(body.message);
-                            }
-                            else if (body.status !== undefined && body.status !== 0) {
-                                // エラーレスポンスにステータスがあった場合
-                                err = new Error(body.status);
-                            }
-                        }
-                        throw err;
-                }
+                body = await res.json();
             }
-            catch (err) {
-                // tslint:disable-next-line:no-single-line-block-comment
-                /* istanbul ignore next */
-                if (err.name === 'TimeoutError') {
-                    // tslint:disable-next-line:no-console
-                    console.error('getTokenWithFetch: Timeout: It took more than 5 seconds to get the result!', err);
-                }
-                else if (err.name === 'AbortError') {
-                    // tslint:disable-next-line:no-console
-                    console.error('getTokenWithFetch: Fetch aborted by user action (browser stop button, closing tab, etc.', err);
-                }
-                else if (err.name === 'TypeError') {
-                    // tslint:disable-next-line:no-console
-                    console.error('getTokenWithFetch: AbortSignal.timeout() method is not supported', err);
-                }
-                else {
-                    // A network error, or some other problem.
-                    // tslint:disable-next-line:no-console
-                    console.error(`getTokenWithFetch: Error: type: ${err.name}, message: ${err.message}`, err);
+            catch (_error) {
+                // no op
+            }
+            debug('res.status:', res.status, 'body:', body);
+            switch (res.status) {
+                case httpStatus_1.status.OK:
+                    this.credentials = body;
+                    break;
+                default: {
+                    let err = new Error('Unexpected error occurred.');
+                    if (body !== undefined && body !== null) {
+                        if (typeof body === 'string') {
+                            err = new Error(body);
+                        }
+                        else if (typeof body.message === 'string' && body.message.length > 0) {
+                            // エラーレスポンスにメッセージがあった場合
+                            err = new Error(body.message);
+                        }
+                        else if (body.status !== undefined && body.status !== 0) {
+                            // エラーレスポンスにステータスがあった場合
+                            err = new Error(body.status);
+                        }
+                    }
+                    throw err;
                 }
-                throw err;
             }
-            // save in remote
-            // tslint:disable-next-line:no-single-line-block-comment
+        }
+        catch (err) {
             /* istanbul ignore next */
-            if (this.options.credentialsRepo !== undefined) {
-                debug('saving in repo...', this.credentials);
-                yield this.options.credentialsRepo.save(this.credentials);
+            if (err.name === 'TimeoutError') {
+                console.error('getTokenWithFetch: Timeout: It took more than 5 seconds to get the result!', err);
+            }
+            else if (err.name === 'AbortError') {
+                console.error('getTokenWithFetch: Fetch aborted by user action (browser stop button, closing tab, etc.', err);
             }
-            return this.credentials;
-        });
+            else if (err.name === 'TypeError') {
+                console.error('getTokenWithFetch: AbortSignal.timeout() method is not supported', err);
+            }
+            else {
+                // A network error, or some other problem.
+                console.error(`getTokenWithFetch: Error: type: ${err.name}, message: ${err.message}`, err);
+            }
+            throw err;
+        }
+        // save in remote
+        /* istanbul ignore next */
+        if (this.options.credentialsRepo !== undefined) {
+            debug('saving in repo...', this.credentials);
+            await this.options.credentialsRepo.save(this.credentials);
+        }
+        return this.credentials;
     }
     /**
      * 認証情報を手動でセットする
@@ -112,126 +105,108 @@ class RefreshTokenClient {
     /**
      * アクセストークンを更新する
      */
-    refreshAccessToken() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.options.refreshToken === undefined) {
-                throw new Error('No refresh token is set.');
-            }
-            return this.refreshToken(this.options.refreshToken);
-        });
+    async refreshAccessToken() {
+        if (this.options.refreshToken === undefined) {
+            throw new Error('No refresh token is set.');
+        }
+        return this.refreshToken(this.options.refreshToken);
     }
     /**
      * 期限の切れていないアクセストークンを取得します。
      * 必要であれば更新してから取得します。
      */
-    getAccessToken() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // find from remote
-            // localに存在せず、remoteに存在すれば採用
-            // tslint:disable-next-line:no-single-line-block-comment
-            /* istanbul ignore next */
-            if (typeof this.credentials.access_token !== 'string') {
-                if (this.options.credentialsRepo !== undefined) {
-                    const credentialsFromRepo = yield this.options.credentialsRepo.find();
-                    debug('credentials in repo found,', credentialsFromRepo);
-                    if (typeof (credentialsFromRepo === null || credentialsFromRepo === void 0 ? void 0 : credentialsFromRepo.access_token) === 'string') {
-                        this.credentials = credentialsFromRepo;
-                    }
-                }
-            }
-            const expiredAt = this.credentials.expired_at;
-            const spareTimeInMilliseconds = RefreshTokenClient.DEFAULT_SPARE_TIME_IN_MILLISECONDS;
-            let isTokenExpired = true;
-            if (expiredAt !== undefined) {
-                // 認証情報があれば期限をチェック
-                debug('validating existing credentials...', this.credentials, spareTimeInMilliseconds);
-                const dateExpiredAtOfCredentials = new Date(expiredAt);
-                const dateExpiredAtActually = new Date();
-                dateExpiredAtActually.setMilliseconds(dateExpiredAtActually.getMilliseconds() + spareTimeInMilliseconds);
-                if (dateExpiredAtOfCredentials.getTime() > dateExpiredAtActually.getTime()) {
-                    isTokenExpired = false;
+    async getAccessToken() {
+        // find from remote
+        // localに存在せず、remoteに存在すれば採用
+        /* istanbul ignore next */
+        if (typeof this.credentials.access_token !== 'string') {
+            if (this.options.credentialsRepo !== undefined) {
+                const credentialsFromRepo = await this.options.credentialsRepo.find();
+                debug('credentials in repo found,', credentialsFromRepo);
+                if (typeof credentialsFromRepo?.access_token === 'string') {
+                    this.credentials = credentialsFromRepo;
                 }
             }
-            if (this.credentials.access_token === undefined && this.options.refreshToken === undefined) {
-                throw new Error('No access or refresh token is set.');
+        }
+        const expiredAt = this.credentials.expired_at;
+        const spareTimeInMilliseconds = RefreshTokenClient.DEFAULT_SPARE_TIME_IN_MILLISECONDS;
+        let isTokenExpired = true;
+        if (expiredAt !== undefined) {
+            // 認証情報があれば期限をチェック
+            debug('validating existing credentials...', this.credentials, spareTimeInMilliseconds);
+            const dateExpiredAtOfCredentials = new Date(expiredAt);
+            const dateExpiredAtActually = new Date();
+            dateExpiredAtActually.setMilliseconds(dateExpiredAtActually.getMilliseconds() + spareTimeInMilliseconds);
+            if (dateExpiredAtOfCredentials.getTime() > dateExpiredAtActually.getTime()) {
+                isTokenExpired = false;
             }
-            const shouldRefresh = (this.credentials.access_token === undefined) || isTokenExpired;
-            if (shouldRefresh && this.options.refreshToken !== undefined) {
-                yield this.refreshAccessToken();
-            }
-            return this.credentials.access_token;
-        });
+        }
+        if (this.credentials.access_token === undefined && this.options.refreshToken === undefined) {
+            throw new Error('No access or refresh token is set.');
+        }
+        const shouldRefresh = (this.credentials.access_token === undefined) || isTokenExpired;
+        if (shouldRefresh && this.options.refreshToken !== undefined) {
+            await this.refreshAccessToken();
+        }
+        return this.credentials.access_token;
     }
     /**
      * APIリクエストを投げる
      * 認証エラー(401,403)であれば自動的に一度だけアクセストークンをリフレッシュします。
      */
-    request(options, expectedStatusCodes) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let retry = true;
-            let result;
-            let numberOfTry = 0;
-            while (result === undefined) {
-                try {
-                    numberOfTry += 1;
-                    if (numberOfTry > MAX_NUM_TRY_REQUEST) {
-                        retry = false;
-                    }
-                    options.auth = { bearer: yield this.getAccessToken() };
-                    result = yield this.makeRequest(options, expectedStatusCodes);
-                    break;
+    async request(options, expectedStatusCodes) {
+        let retry = true;
+        let result;
+        let numberOfTry = 0;
+        while (result === undefined) {
+            try {
+                numberOfTry += 1;
+                if (numberOfTry > MAX_NUM_TRY_REQUEST) {
+                    retry = false;
                 }
-                catch (error) {
-                    // tslint:disable-next-line:no-single-line-block-comment
+                options.auth = { bearer: await this.getAccessToken() };
+                result = await this.makeRequest(options, expectedStatusCodes);
+                break;
+            }
+            catch (error) {
+                /* istanbul ignore else */
+                if (error instanceof Error) {
+                    const statusCode = error.code;
                     /* istanbul ignore else */
-                    if (error instanceof Error) {
-                        const statusCode = error.code;
-                        // tslint:disable-next-line:no-single-line-block-comment
-                        /* istanbul ignore else */
-                        if (statusCode === http_status_1.UNAUTHORIZED || statusCode === http_status_1.FORBIDDEN) {
-                            if (retry) {
-                                // 多くの場合、認証エラーは、トークンの期限が原因なので、一度だけリフレッシュするのは有効なはず。
-                                // リフレッシュしても同様に認証エラーの場合は、それ以外の原因で起きているのであきらめる。
-                                yield this.refreshAccessToken();
-                                continue;
-                            }
-                            else {
-                                // リトライしても認証エラーが出る状況は不可解なので、エラー出力
-                                // tslint:disable-next-line:no-console
-                                console.error('[COA service]Retried request threw an error.', error, 'credentials:', this.credentials, 'request options:', options, 'now:', new Date());
-                            }
+                    if (statusCode === httpStatus_1.status.UNAUTHORIZED || statusCode === httpStatus_1.status.FORBIDDEN) {
+                        if (retry) {
+                            // 多くの場合、認証エラーは、トークンの期限が原因なので、一度だけリフレッシュするのは有効なはず。
+                            // リフレッシュしても同様に認証エラーの場合は、それ以外の原因で起きているのであきらめる。
+                            await this.refreshAccessToken();
+                            continue;
+                        }
+                        else {
+                            // リトライしても認証エラーが出る状況は不可解なので、エラー出力
+                            console.error('[COA service]Retried request threw an error.', error, 'credentials:', this.credentials, 'request options:', options, 'now:', new Date());
                         }
                     }
-                    throw error;
                 }
+                throw error;
             }
-            return result;
-        });
+        }
+        return result;
     }
     /**
      * 認証情報が適切である前提でAPIリクエストを投げる
      */
-    makeRequest(options, expectedStatusCodes) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const transporter = (this.options.useFetch === true)
-                ? new transporters_1.FetchTransporter(expectedStatusCodes)
-                : new transporters_1.FetchTransporter(expectedStatusCodes);
-            return transporter.request(options);
-        });
+    async makeRequest(options, expectedStatusCodes) {
+        const transporter = (this.options.useFetch === true)
+            ? new transporters_1.FetchTransporter(expectedStatusCodes)
+            : new transporters_1.FetchTransporter(expectedStatusCodes);
+        return transporter.request(options);
     }
     /**
      * 認証情報を更新する
      */
-    refreshToken(__) {
-        return __awaiter(this, void 0, void 0, function* () {
-            debug('refreshing an access token...');
-            // return this.getTokenWithRequest();
-            return this.getTokenWithFetch();
-        });
+    async refreshToken(__) {
+        debug('refreshing an access token...');
+        // return this.getTokenWithRequest();
+        return this.getTokenWithFetch();
     }
 }
-/**
- * アクセストークンの有効期限までの猶予時間初期値
- */
-RefreshTokenClient.DEFAULT_SPARE_TIME_IN_MILLISECONDS = 60000;
 exports.RefreshTokenClient = RefreshTokenClient;

package/lib/httpStatus.d.ts

@@ -0,0 +1,23 @@
+declare const status: {
+    readonly CONTINUE: 100;
+    readonly OK: 200;
+    readonly CREATED: 201;
+    readonly ACCEPTED: 202;
+    readonly NO_CONTENT: 204;
+    readonly BAD_REQUEST: 400;
+    readonly UNAUTHORIZED: 401;
+    readonly FORBIDDEN: 403;
+    readonly NOT_FOUND: 404;
+    readonly METHOD_NOT_ALLOWED: 405;
+    readonly NOT_ACCEPTABLE: 406;
+    readonly PROXY_AUTHENTICATION_REQUIRED: 407;
+    readonly CONFLICT: 409;
+    readonly GONE: 410;
+    readonly TOO_MANY_REQUESTS: 429;
+    readonly INTERNAL_SERVER_ERROR: 500;
+    readonly NOT_IMPLEMENTED: 501;
+    readonly BAD_GATEWAY: 502;
+    readonly SERVICE_UNAVAILABLE: 503;
+    readonly GATEWAY_TIMEOUT: 504;
+};
+export { status };

package/lib/httpStatus.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.status = void 0;
+const status = {
+    CONTINUE: 100,
+    OK: 200,
+    CREATED: 201,
+    ACCEPTED: 202,
+    NO_CONTENT: 204,
+    BAD_REQUEST: 400,
+    UNAUTHORIZED: 401,
+    FORBIDDEN: 403,
+    NOT_FOUND: 404,
+    METHOD_NOT_ALLOWED: 405,
+    NOT_ACCEPTABLE: 406,
+    PROXY_AUTHENTICATION_REQUIRED: 407,
+    CONFLICT: 409,
+    GONE: 410,
+    TOO_MANY_REQUESTS: 429,
+    INTERNAL_SERVER_ERROR: 500,
+    NOT_IMPLEMENTED: 501,
+    BAD_GATEWAY: 502,
+    SERVICE_UNAVAILABLE: 503,
+    GATEWAY_TIMEOUT: 504
+};
+exports.status = status;

package/lib/index.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.service = exports.auth = exports.factory = exports.COAServiceError = void 0;
 /**
@@ -7,7 +30,7 @@ exports.service = exports.auth = exports.factory = exports.COAServiceError = voi
 const factory_1 = require("@coasystems/factory");
 Object.defineProperty(exports, "factory", { enumerable: true, get: function () { return factory_1.COAFactory; } });
 const refreshTokenClient_1 = require("./auth/refreshTokenClient");
-const CredentialsRepo = require("./auth/repo/credentials");
+const CredentialsRepo = __importStar(require("./auth/repo/credentials"));
 const master_1 = require("./service/master");
 const reserve_1 = require("./service/reserve");
 const coaServiceError_1 = require("./transporter/coaServiceError");
@@ -24,7 +47,7 @@ var auth;
     (function (repo) {
         repo.credentials = CredentialsRepo;
     })(repo = auth.repo || (auth.repo = {}));
-})(auth = exports.auth || (exports.auth = {}));
+})(auth || (exports.auth = auth = {}));
 var service;
 (function (service) {
     /**
@@ -39,4 +62,4 @@ var service;
     class Reserve extends reserve_1.ReserveService {
     }
     service.Reserve = Reserve;
-})(service = exports.service || (exports.service = {}));
+})(service || (exports.service = service = {}));