@motionpicture/coa-service 9.3.0-alpha.2 → 9.3.0-alpha.4

package/README.md

@@ -17,7 +17,6 @@ COA SDK for Node.js
     - [Environment variables](#environment-variables)
     - [劇場情報を取得する](#劇場情報を取得する)
   - [Code Samples](#code-samples)
-  - [Documentation](#documentation)
 
 ## Specification
 
@@ -73,7 +72,3 @@ masterService.theater({
 ## Code Samples
 
 Code sample are [here](https://github.com/motionpicture/coa-service/tree/master/example).
-
-## Documentation
-
-`npm run doc` emits typedoc to ./docs.

package/example/delReserve.js

@@ -14,25 +14,26 @@ const service = new COA.service.Reserve(
 );
 
 service.delReserve({
-    reserveNum: '985',
-    theaterCode: '118',
-    dateJouei: '20170403',
-    titleCode: '16344',
-    titleBranchNum: '0',
-    timeBegin: '1000',
-    telNum: '09012345678',
+    reserveNum: '45701',
+    theaterCode: '120',
+    "dateJouei": "20240125",
+    "titleCode": "99100",
+    "titleBranchNum": "0",
+    "timeBegin": "1720",
+    telNum: '09096793896',
     listSeat: [
         {
             seatSection: '0',
-            seatNum: 'Ｂ－４'
+            "seatNum": "ｂ－１８",
         },
         {
             seatSection: '0',
-            seatNum: 'Ｂ－５'
+            "seatNum": "ｂ－１９",
         }
     ]
 }).then((result) => {
     console.log(result);
 }).catch((err) => {
     console.error(err);
+    console.log('err instanceof COA.COAServiceError?:', err instanceof COA.COAServiceError);
 });

package/example/findFilms.js

@@ -10,7 +10,8 @@ const service = new COA.service.Master(
         endpoint: process.env.COA_ENDPOINT,
         auth: new COA.auth.RefreshToken({
             endpoint: process.env.COA_ENDPOINT,
-            refreshToken: process.env.COA_REFRESH_TOKEN
+            refreshToken: process.env.COA_REFRESH_TOKEN,
+            useFetch: true
         })
     },
     { timeout: 1000 }

package/example/stateReserve.js

@@ -14,9 +14,9 @@ const service = new COA.service.Reserve({
 });
 
 service.stateReserve({
-    theaterCode: '112',
-    reserveNum: '588456',
-    telNum: '0362778824'
+    theaterCode: '120',
+    reserveNum: '45699',
+    telNum: '0312345678'
 }).then((result) => {
     fs.writeFileSync(`${__dirname}/output/stateReserve.json`, JSON.stringify(result, null, '    '));
     console.log(result);

package/lib/auth/refreshTokenClient.d.ts

@@ -42,11 +42,11 @@ export declare class RefreshTokenClient {
      * APIリクエストを投げる
      * 認証エラー(401,403)であれば自動的に一度だけアクセストークンをリフレッシュします。
      */
-    request(options: IRequestOptions, expectedStatusCodes: number[]): Promise<any>;
+    request(options: IRequestOptions, expectedStatusCodes: number[]): Promise<import("../transporters").IResponseBodyAsJson>;
     /**
      * 認証情報が適切である前提でAPIリクエストを投げる
      */
-    protected makeRequest(options: IRequestOptions, expectedStatusCodes: number[]): Promise<any>;
+    protected makeRequest(options: IRequestOptions, expectedStatusCodes: number[]): Promise<import("../transporters").IResponseBodyAsJson>;
     /**
      * 認証情報を更新する
      */

package/lib/auth/refreshTokenClient.js

@@ -12,10 +12,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RefreshTokenClient = void 0;
 const createDebug = require("debug");
 const http_status_1 = require("http-status");
+const node_fetch_1 = require("node-fetch");
 const request = require("request");
 const transporters_1 = require("../transporters");
 const debug = createDebug('coa-service:auth:refreshTokenClient');
 const TIMEOUT = 10000;
+const MAX_NUM_TRY_REQUEST = 1;
 /**
  * リフレッシュトークン認証クライアント
  */
@@ -74,7 +76,7 @@ class RefreshTokenClient {
             debug('requesting an access token...');
             try {
                 const params = new URLSearchParams({ refresh_token: String(this.options.refreshToken) });
-                const res = yield fetch(`${this.options.endpoint}/token/access_token`, {
+                const res = yield (0, node_fetch_1.default)(`${this.options.endpoint}/token/access_token`, {
                     method: 'POST',
                     headers: {
                         'Content-Type': 'application/x-www-form-urlencoded'
@@ -192,11 +194,10 @@ class RefreshTokenClient {
             let retry = true;
             let result;
             let numberOfTry = 0;
-            // tslint:disable-next-line:no-magic-numbers
-            while (numberOfTry >= 0) {
+            while (result === undefined) {
                 try {
                     numberOfTry += 1;
-                    if (numberOfTry > 1) {
+                    if (numberOfTry > MAX_NUM_TRY_REQUEST) {
                         retry = false;
                     }
                     options.auth = { bearer: yield this.getAccessToken() };
@@ -224,9 +225,6 @@ class RefreshTokenClient {
                             }
                         }
                     }
-                    else {
-                        // no operation
-                    }
                     throw error;
                 }
             }

package/lib/index.d.ts

@@ -2,10 +2,11 @@
  * coa-service
  */
 import * as factory from './factory';
+import { RefreshTokenClient } from './auth/refreshTokenClient';
 import { MasterService } from './service/master';
 import { ReserveService } from './service/reserve';
-import { RefreshTokenClient } from './auth/refreshTokenClient';
-export import factory = factory;
+import { COAServiceError } from './transporter/coaServiceError';
+export { COAServiceError, factory };
 export declare namespace auth {
     /**
      * リフレッシュトークン認証クライアント
@@ -13,9 +14,6 @@ export declare namespace auth {
     class RefreshToken extends RefreshTokenClient {
     }
 }
-/**
- * recommended
- */
 export declare namespace service {
     /**
      * マスターサービス

package/lib/index.js

@@ -1,14 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.service = exports.auth = exports.factory = void 0;
+exports.service = exports.auth = exports.factory = exports.COAServiceError = void 0;
 /**
  * coa-service
  */
 const factory = require("./factory");
+exports.factory = factory;
+const refreshTokenClient_1 = require("./auth/refreshTokenClient");
 const master_1 = require("./service/master");
 const reserve_1 = require("./service/reserve");
-const refreshTokenClient_1 = require("./auth/refreshTokenClient");
-exports.factory = factory;
+const coaServiceError_1 = require("./transporter/coaServiceError");
+Object.defineProperty(exports, "COAServiceError", { enumerable: true, get: function () { return coaServiceError_1.COAServiceError; } });
 var auth;
 (function (auth) {
     /**
@@ -18,9 +20,6 @@ var auth;
     }
     auth.RefreshToken = RefreshToken;
 })(auth = exports.auth || (exports.auth = {}));
-/**
- * recommended
- */
 var service;
 (function (service) {
     /**

package/lib/service.d.ts

@@ -13,10 +13,10 @@ export type ICustomRequestOption = Pick<request.CoreOptions, 'timeout'>;
  */
 export declare class Service {
     options: IOptions;
-    requestOptions: request.CoreOptions;
+    requestOptions: ICustomRequestOption;
     constructor(options: IOptions, requestOptions?: ICustomRequestOption);
     /**
      * Create and send request to API
      */
-    request(options: IRequestOptions, expectedStatusCodes: number[]): Promise<any>;
+    request(options: IRequestOptions, expectedStatusCodes: number[]): Promise<import("./transporters").IResponseBodyAsJson>;
 }

package/lib/service.js

@@ -16,27 +16,16 @@ exports.Service = void 0;
 class Service {
     constructor(options, requestOptions) {
         this.options = options;
-        this.requestOptions = {};
-        // tslint:disable-next-line:no-single-line-block-comment
-        /* istanbul ignore else */
-        if (requestOptions !== undefined) {
-            this.requestOptions = Object.assign(Object.assign({}, this.requestOptions), requestOptions);
-        }
+        this.requestOptions = Object.assign({}, requestOptions);
     }
     /**
      * Create and send request to API
      */
     request(options, expectedStatusCodes) {
         return __awaiter(this, void 0, void 0, function* () {
-            const defaultOptions = {
-                baseUrl: this.options.endpoint,
-                // simple: false,
-                // resolveWithFullResponse: true,
-                json: true,
-                method: 'GET',
-                useQuerystring: true
-            };
-            const requestOptions = Object.assign(Object.assign(Object.assign({}, defaultOptions), this.requestOptions), options);
+            const requestOptions = Object.assign(Object.assign({ baseUrl: this.options.endpoint, 
+                // json: true,
+                method: 'GET' }, this.requestOptions), options);
             return this.options.auth.request(requestOptions, expectedStatusCodes);
         });
     }

package/lib/transporter/coaServiceError.d.ts

@@ -0,0 +1,10 @@
+import { IRequestOptions } from './requestOption';
+/**
+ * COAServiceError
+ */
+export declare class COAServiceError extends Error {
+    code: number;
+    status: string;
+    requestOptions: IRequestOptions | undefined;
+    constructor(code: number, status: string, message?: string, requestOptions?: IRequestOptions);
+}

package/lib/transporter/coaServiceError.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.COAServiceError = void 0;
+/**
+ * COAServiceError
+ */
+class COAServiceError extends Error {
+    constructor(code, status, message, requestOptions) {
+        super(message);
+        this.name = 'COAServiceError';
+        this.code = code;
+        this.status = status;
+        this.requestOptions = requestOptions;
+    }
+}
+exports.COAServiceError = COAServiceError;

package/lib/transporter/requestOption.d.ts

@@ -0,0 +1,16 @@
+interface IHeaders {
+    [key: string]: any;
+}
+type IQS = Record<string, string | number | any[]>;
+export interface IRequestOptions {
+    baseUrl?: string;
+    auth?: {
+        bearer?: string;
+    };
+    qs?: IQS;
+    method?: string;
+    headers?: IHeaders;
+    timeout?: number;
+    uri: string;
+}
+export {};

package/lib/transporter/requestOption.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/transporters.d.ts

@@ -1,26 +1,30 @@
 import * as request from 'request';
+import { COAServiceError } from './transporter/coaServiceError';
+import { IRequestOptions } from './transporter/requestOption';
 /**
  * リクエスト成功の場合のレスポンス本文のstatus属性の値
  * 失敗の場合はstring型だが、成功の場合のみnumber型が返却されるので注意すること。
  */
 export declare const RESPONSE_BODY_STAUS_SUCCESS = 0;
-export type IRequestOptions = Pick<request.OptionsWithUri, 'uri' | 'method' | 'qs' | 'auth' | 'headers' | 'baseUrl' | 'timeout'>;
+export { COAServiceError, IRequestOptions };
+export type IResponseBodyAsJson = {
+    /**
+     * COAの提示するステータス
+     * 0でなければBadRequest
+     */
+    status?: string | number;
+    /**
+     * COAの提示するメッセージ
+     */
+    message?: string;
+} & Record<string, any>;
+export type IResponseBody = IResponseBodyAsJson;
 /**
  * transporter abstract class
  * トランスポーター抽象クラス
  */
 export declare abstract class Transporter {
-    abstract request(options: IRequestOptions): Promise<any>;
-}
-export type IBodyResponseCallback = Promise<any>;
-/**
- * COAServiceError
- */
-export declare class COAServiceError extends Error {
-    code: number;
-    status: string;
-    requestOptions: IRequestOptions | undefined;
-    constructor(code: number, status: string, message?: string, requestOptions?: IRequestOptions);
+    abstract request(options: IRequestOptions): Promise<IResponseBody>;
 }
 /**
  * DefaultTransporter
@@ -35,11 +39,11 @@ export declare class DefaultTransporter implements Transporter {
     /**
      * Configures request options before making a request.
      */
-    static CONFIGURE(options: IRequestOptions): IRequestOptions;
+    static CONFIGURE(options: IRequestOptions): IRequestOptions & Pick<request.OptionsWithUri, 'json' | 'useQuerystring'>;
     /**
      * Makes a request with given options and invokes callback.
      */
-    request(options: IRequestOptions): Promise<any>;
+    request(options: IRequestOptions): Promise<IResponseBody>;
     /**
      * Wraps the response callback.
      */
@@ -62,7 +66,7 @@ export declare class FetchTransporter implements Transporter {
     /**
      * Makes a request with given options and invokes callback.
      */
-    request(options: IRequestOptions): Promise<any>;
+    request(options: IRequestOptions): Promise<IResponseBody>;
     /**
      * Wraps the response callback.
      */

package/lib/transporters.js

@@ -9,15 +9,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FetchTransporter = exports.DefaultTransporter = exports.COAServiceError = exports.Transporter = exports.RESPONSE_BODY_STAUS_SUCCESS = void 0;
+exports.FetchTransporter = exports.DefaultTransporter = exports.Transporter = exports.COAServiceError = exports.RESPONSE_BODY_STAUS_SUCCESS = void 0;
 // tslint:disable:max-classes-per-file
 /**
  * transporters
  */
 const createDebug = require("debug");
 const http_status_1 = require("http-status");
+const node_fetch_1 = require("node-fetch");
 const querystring = require("querystring");
 const request = require("request");
+const coaServiceError_1 = require("./transporter/coaServiceError");
+Object.defineProperty(exports, "COAServiceError", { enumerable: true, get: function () { return coaServiceError_1.COAServiceError; } });
 const debug = createDebug('coa-service:transporters');
 // tslint:disable-next-line
 const pkg = require('../package.json');
@@ -33,19 +36,7 @@ exports.RESPONSE_BODY_STAUS_SUCCESS = 0;
 class Transporter {
 }
 exports.Transporter = Transporter;
-/**
- * COAServiceError
- */
-class COAServiceError extends Error {
-    constructor(code, status, message, requestOptions) {
-        super(message);
-        this.name = 'COAServiceError';
-        this.code = code;
-        this.status = status;
-        this.requestOptions = requestOptions;
-    }
-}
-exports.COAServiceError = COAServiceError;
+// export type IBodyResponseCallback = Promise<any>;
 /**
  * DefaultTransporter
  */
@@ -70,7 +61,7 @@ class DefaultTransporter {
         else {
             // no operation
         }
-        return options;
+        return Object.assign(Object.assign({}, options), { json: true, useQuerystring: true });
     }
     /**
      * Makes a request with given options and invokes callback.
@@ -96,25 +87,26 @@ class DefaultTransporter {
      */
     wrapCallback(error, response, body, options) {
         const requestOptions = { uri: options.uri };
-        let err = new COAServiceError(http_status_1.INTERNAL_SERVER_ERROR, '', 'An unexpected error occurred.', requestOptions);
+        let err = new coaServiceError_1.COAServiceError(http_status_1.INTERNAL_SERVER_ERROR, '', 'An unexpected error occurred.', requestOptions);
         if (error instanceof Error) {
-            throw new COAServiceError(http_status_1.INTERNAL_SERVER_ERROR, '', error.message, requestOptions);
+            throw new coaServiceError_1.COAServiceError(http_status_1.INTERNAL_SERVER_ERROR, '', error.message, requestOptions);
         }
-        debug('request processed', error, body);
+        debug('request processed', error, body, response.statusCode);
+        const statusFromBody = body === null || body === void 0 ? void 0 : body.status;
         // tslint:disable-next-line:no-single-line-block-comment
         /* istanbul ignore else */
         if (response.statusCode !== undefined) {
             if (this.expectedStatusCodes.indexOf(response.statusCode) < 0) {
                 if (typeof body === 'string') {
                     // Consider all 4xx and 5xx responses errors.
-                    err = new COAServiceError(response.statusCode, '', body, requestOptions);
+                    err = new coaServiceError_1.COAServiceError(response.statusCode, '', body, requestOptions);
                 }
                 else {
                     // エラーレスポンスにステータスがあった場合
                     // tslint:disable-next-line:no-single-line-block-comment
                     /* istanbul ignore else */
-                    if (body.status !== undefined) {
-                        err = new COAServiceError(response.statusCode, body.status, body.message, requestOptions);
+                    if (statusFromBody !== undefined) {
+                        err = new coaServiceError_1.COAServiceError(response.statusCode, statusFromBody, body.message, requestOptions);
                     }
                     else {
                         // no operation
@@ -123,18 +115,18 @@ class DefaultTransporter {
             }
             else {
                 // HTTPステータスコード2xxでも、レスポンス本文のステータスが0でなければBadRequest
-                if (body.status !== undefined && body.status !== exports.RESPONSE_BODY_STAUS_SUCCESS) {
-                    err = new COAServiceError(response.statusCode, body.status, body.message, requestOptions);
+                if (statusFromBody !== undefined && statusFromBody !== exports.RESPONSE_BODY_STAUS_SUCCESS) {
+                    err = new coaServiceError_1.COAServiceError(response.statusCode, statusFromBody, body.message, requestOptions);
                 }
                 else {
-                    if (response.statusCode === http_status_1.NO_CONTENT) {
-                        // consider 204
-                        return;
-                    }
-                    else {
-                        // consider 200,201
-                        return body;
-                    }
+                    // if (response.statusCode === NO_CONTENT) {
+                    //     // consider 204
+                    //     return;
+                    // } else {
+                    //     // consider 200,201
+                    //     return body;
+                    // }
+                    return body;
                 }
             }
         }
@@ -165,10 +157,10 @@ class FetchTransporter {
         // tslint:disable-next-line:no-single-line-block-comment
         /* istanbul ignore else */
         if (!options.headers['User-Agent']) {
-            options.headers['User-Agent'] = DefaultTransporter.USER_AGENT;
+            options.headers['User-Agent'] = FetchTransporter.USER_AGENT;
         }
-        else if (options.headers['User-Agent'].indexOf(DefaultTransporter.USER_AGENT) === -1) {
-            options.headers['User-Agent'] = `${options.headers['User-Agent']} ${DefaultTransporter.USER_AGENT}`;
+        else if (options.headers['User-Agent'].indexOf(FetchTransporter.USER_AGENT) === -1) {
+            options.headers['User-Agent'] = `${options.headers['User-Agent']} ${FetchTransporter.USER_AGENT}`;
         }
         else {
             // no operation
@@ -182,11 +174,10 @@ class FetchTransporter {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = FetchTransporter.CONFIGURE(options);
-            debug('requesting...', requestOptions);
             const input = `${requestOptions.baseUrl}${requestOptions.uri}?${querystring.stringify(requestOptions.qs)}`;
             const accessToken = (_a = requestOptions.auth) === null || _a === void 0 ? void 0 : _a.bearer;
-            debug('fetching...', input);
-            return fetch(input, Object.assign({ method: requestOptions.method, headers: Object.assign(Object.assign({}, requestOptions.headers), (typeof accessToken === 'string') ? { Authorization: `Bearer ${accessToken}` } /* istanbul ignore else */ : undefined) }, (typeof requestOptions.timeout === 'number') ? { signal: AbortSignal.timeout(requestOptions.timeout) } : undefined))
+            debug('fetching...', input, requestOptions);
+            return (0, node_fetch_1.default)(input, Object.assign({ method: requestOptions.method, headers: Object.assign(Object.assign({}, requestOptions.headers), (typeof accessToken === 'string') ? { Authorization: `Bearer ${accessToken}` } /* istanbul ignore else */ : undefined) }, (typeof requestOptions.timeout === 'number') ? { signal: AbortSignal.timeout(requestOptions.timeout) } : undefined))
                 .then((res) => __awaiter(this, void 0, void 0, function* () { return this.wrapCallback(res, requestOptions); }));
         });
     }
@@ -196,7 +187,7 @@ class FetchTransporter {
     wrapCallback(res, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = { uri: options.uri };
-            let err = new COAServiceError(http_status_1.INTERNAL_SERVER_ERROR, '', 'An unexpected error occurred.', requestOptions);
+            let err = new coaServiceError_1.COAServiceError(http_status_1.INTERNAL_SERVER_ERROR, '', 'An unexpected error occurred.', requestOptions);
             debug('fetch processed. res.status:', res.status, 'content-type:', res.headers.get('content-type'));
             let body = {};
             try {
@@ -206,50 +197,44 @@ class FetchTransporter {
                 else {
                     body = yield res.json();
                 }
+                debug('fetch processed. body:', body);
             }
             catch (error) {
                 // no op
             }
-            // tslint:disable-next-line:no-single-line-block-comment
-            /* istanbul ignore else */
-            if (res.status !== undefined) {
+            if (typeof body === 'string') {
+                // Consider all 4xx and 5xx responses errors.
+                err = new coaServiceError_1.COAServiceError(res.status, '', body, requestOptions);
+            }
+            else {
                 if (this.expectedStatusCodes.indexOf(res.status) < 0) {
-                    if (typeof body === 'string') {
-                        // Consider all 4xx and 5xx responses errors.
-                        err = new COAServiceError(res.status, '', body, requestOptions);
+                    // エラーレスポンスにステータスがあった場合
+                    // tslint:disable-next-line:no-single-line-block-comment
+                    /* istanbul ignore else */
+                    if (body.status !== undefined) {
+                        err = new coaServiceError_1.COAServiceError(res.status, String(body.status), body.message, requestOptions);
                     }
                     else {
-                        // エラーレスポンスにステータスがあった場合
-                        // tslint:disable-next-line:no-single-line-block-comment
-                        /* istanbul ignore else */
-                        if (body.status !== undefined) {
-                            err = new COAServiceError(res.status, body.status, body.message, requestOptions);
-                        }
-                        else {
-                            // no operation
-                        }
+                        // no operation
                     }
                 }
                 else {
                     // HTTPステータスコード2xxでも、レスポンス本文のステータスが0でなければBadRequest
                     if (body.status !== undefined && body.status !== exports.RESPONSE_BODY_STAUS_SUCCESS) {
-                        err = new COAServiceError(res.status, body.status, body.message, requestOptions);
+                        err = new coaServiceError_1.COAServiceError(res.status, String(body.status), body.message, requestOptions);
                     }
                     else {
-                        if (res.status === http_status_1.NO_CONTENT) {
-                            // consider 204
-                            return;
-                        }
-                        else {
-                            // consider 200,201
-                            return body;
-                        }
+                        // if (res.status === NO_CONTENT) {
+                        //     // consider 204
+                        //     return;
+                        // } else {
+                        //     // consider 200,201
+                        //     return body;
+                        // }
+                        return body;
                     }
                 }
             }
-            else {
-                // no operation
-            }
             throw err;
         });
     }

package/package.json

@@ -15,6 +15,7 @@
   "dependencies": {
     "debug": "^3.2.7",
     "http-status": "^1.5.2",
+    "node-fetch": "2.7.0",
     "request": "^2.88.2"
   },
   "description": "COA client library for Node.js",
@@ -24,6 +25,7 @@
     "@types/mocha": "^5.2.0",
     "@types/nock": "^9.1.3",
     "@types/node": "18.19.2",
+    "@types/node-fetch": "2.6.11",
     "@types/request": "^2.48.5",
     "@types/sinon": "^4.3.3",
     "coveralls": "^3.0.1",
@@ -78,5 +80,5 @@
     "postversion": "git push origin --tags",
     "prepublishOnly": "npm run clean && npm run build && npm test && npm run doc"
   },
-  "version": "9.3.0-alpha.2"
+  "version": "9.3.0-alpha.4"
 }