@mathrunet/masamune 2.4.3 → 2.5.0

package/dist/lib/src/functions_base.d.ts

@@ -0,0 +1,195 @@
+import { MemoryOption } from "firebase-functions/v2";
+/**
+ * Define Function data for FirebaseFunctions.
+ *
+ * Write code to generate FirebaseFunctions at `build`.
+ *
+ * FirebaseFunctions用のFunctionのデータを定義を行うためのベースクラス。
+ *
+ * `build`にてFirebaseFunctionsを生成するためのコードを記述します。
+ */
+export declare abstract class FunctionsBase {
+    /**
+     * Define Function data for FirebaseFunctions.
+     *
+     * Write code to generate FirebaseFunctions at `build`.
+     *
+     * FirebaseFunctions用のFunctionのデータを定義を行うためのベースクラス。
+     *
+     * `build`にてFirebaseFunctionsを生成するためのコードを記述します。
+     */
+    constructor({ id, func, data, options, }: {
+        id?: string | undefined | null;
+        func?: ((region: string[], options: FunctionsOptions, data: {
+            [key: string]: string;
+        }) => Function) | undefined | null;
+        data?: {
+            [key: string]: string;
+        } | undefined | null;
+        options?: FunctionsOptions | undefined | null;
+    });
+    /**
+     * @param id
+     * Describe the method names used in Functions.
+     *
+     * Functionsで利用されるメソッド名を記述します。
+     */
+    readonly id: string;
+    /**
+     * @param func
+     * Specify the actual contents of the process.
+     *
+     * 実際の処理の中身を指定します。
+     */
+    readonly func: ((region: string[], options: FunctionsOptions, data: {
+        [key: string]: string;
+    }) => Function) | undefined | null;
+    /**
+     * Specify the data to be passed to the process.
+     *
+     * 処理に渡すデータを指定します。
+     */
+    readonly data: {
+        [key: string]: string;
+    };
+    /**
+     * Specify processing options.
+     *
+     * 処理のオプションを指定します。
+     */
+    readonly options: FunctionsOptions;
+    /**
+     * Write code to generate FirebaseFunctions.
+     *
+     * FirebaseFunctionsを生成するためのコードを記述します。
+     */
+    abstract build(region: string[]): Function;
+}
+/**
+ * Specifies the options for the process.
+ *
+ * 処理のオプションを指定します。
+ */
+export interface SchedulerFunctionsOptions extends FunctionsOptions {
+    /**
+     * Specifies the schedule.
+     * * Cron format and AppEngine format are available.
+     * * For Cron format, specify as `5 11 * * *`.
+     * * For AppEngine format, specify as `every 1 minutes`.
+     *
+     * スケジュールを指定します。
+     * * Cron形式とAppEngine形式で指定可能です。
+     * * Cron形式の場合は、`5 11 * * *`のように指定します。
+     * * AppEngine形式の場合は、`every 1 minutes`のように指定します。
+     */
+    schedule?: string | undefined | null;
+    /**
+     * Specifies an alternate region.
+     *
+     * 代替のリージョンを指定します。
+     */
+    region?: string | null;
+}
+/**
+ * Specifies the options for the process.
+ *
+ * 処理のオプションを指定します。
+ */
+export interface PathFunctionsOptions extends FunctionsOptions {
+    /**
+     * Specify the path to the target database.
+     *
+     * 対象のデータベースのパスを指定します。
+     */
+    path?: string | undefined | null;
+    /**
+     * Specifies an alternate region.
+     *
+     * 代替のリージョンを指定します。
+     */
+    region?: string | null;
+}
+/**
+ * Specifies the options for the process.
+ *
+ * 処理のオプションを指定します。
+ */
+export interface PubsubFunctionsOptions extends FunctionsOptions {
+    /**
+     * Specifies the topic.
+     * You can create a `purchasing` topic in GCP's pub/sub and set the principal to "google-play-developer-notifications@system.gserviceaccount.com" to receive notifications.
+     *
+     * トピックを指定します。
+     * GCPのpub/subに`purchasing`のトピックを作成しプリンシパルに「google-play-developer-notifications@system.gserviceaccount.com」を設定することで通知を受け取ることができるようになります。
+     */
+    topic?: string | undefined | null;
+    /**
+     * Specifies an alternate region.
+     *
+     * 代替のリージョンを指定します。
+     */
+    region?: string | null;
+}
+/**
+ * Specifies the options for the process.
+ *
+ * 処理のオプションを指定します。
+ */
+export interface HttpFunctionsOptions extends FunctionsOptions {
+    /**
+     * Specifies an alternate region.
+     *
+     * 代替のリージョンを指定します。
+     */
+    region?: string | string[] | null;
+}
+/**
+ * Specifies the options for the process.
+ *
+ * 処理のオプションを指定します。
+ */
+export interface StorageFunctionsOptions extends FunctionsOptions {
+    /**
+     * Specifies an alternate region.
+     *
+     * 代替のリージョンを指定します。
+     */
+    region?: string | null;
+}
+/**
+ * Specifies the options for the process.
+ *
+ * 処理のオプションを指定します。
+ */
+export interface FunctionsOptions {
+    /**
+     * Specifies the timeout period.
+     *
+     * タイムアウト時間を指定します。
+     */
+    timeoutSeconds?: number | undefined;
+    /**
+     * Specifies the memory.
+     *
+     * メモリを指定します。
+     */
+    memory?: MemoryOption | undefined;
+    /**
+     * Specifies the minInstances.
+     *
+     * minInstancesを指定します。
+     */
+    minInstances?: number | undefined;
+    /**
+     * Specifies the maxInstances.
+     *
+     * maxInstancesを指定します。
+     */
+    maxInstances?: number | undefined;
+    /**
+     * Specifies the concurrency.
+     *
+     * concurrencyを指定します。
+     */
+    concurrency?: number | undefined;
+}

package/dist/lib/src/functions_base.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionsBase = void 0;
+/**
+ * Define Function data for FirebaseFunctions.
+ *
+ * Write code to generate FirebaseFunctions at `build`.
+ *
+ * FirebaseFunctions用のFunctionのデータを定義を行うためのベースクラス。
+ *
+ * `build`にてFirebaseFunctionsを生成するためのコードを記述します。
+ */
+class FunctionsBase {
+    /**
+     * Define Function data for FirebaseFunctions.
+     *
+     * Write code to generate FirebaseFunctions at `build`.
+     *
+     * FirebaseFunctions用のFunctionのデータを定義を行うためのベースクラス。
+     *
+     * `build`にてFirebaseFunctionsを生成するためのコードを記述します。
+     */
+    constructor({ id, func, data = {}, options, }) {
+        this.id = id !== null && id !== void 0 ? id : "";
+        this.func = func;
+        this.data = data !== null && data !== void 0 ? data : {};
+        this.options = options !== null && options !== void 0 ? options : {
+            timeoutSeconds: 60,
+            memory: "256MiB",
+            minInstances: 0,
+            concurrency: 80,
+            maxInstances: 100,
+        };
+    }
+}
+exports.FunctionsBase = FunctionsBase;
+//# sourceMappingURL=functions_base.js.map

package/dist/lib/src/functions_base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions_base.js","sourceRoot":"","sources":["../../../src/lib/src/functions_base.ts"],"names":[],"mappings":";;;AAGA;;;;;;;;GAQG;AACH,MAAsB,aAAa;IAC/B;;;;;;;;OAQG;IACH,YAAY,EACR,EAAE,EACF,IAAI,EACJ,IAAI,GAAG,EAAE,EACT,OAAO,GAUV;QACG,IAAI,CAAC,EAAE,GAAG,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI;YACtB,cAAc,EAAE,EAAE;YAClB,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,CAAC;YACf,WAAW,EAAE,EAAE;YACf,YAAY,EAAE,GAAG;SACpB,CAAC;IACN,CAAC;CA0CJ;AA7ED,sCA6EC"}

package/dist/lib/src/functions_data.d.ts

@@ -0,0 +1,10 @@
+import { FunctionsBase } from "./functions_base";
+export { FunctionsOptions, SchedulerFunctionsOptions, PubsubFunctionsOptions, PathFunctionsOptions } from "./functions_base";
+/**
+ * Define Function data for FirebaseFunctions.
+ *
+ * FirebaseFunctions用のFunctionのデータを定義します。
+ */
+export declare class FunctionsData extends FunctionsBase {
+    build(region: string[]): Function;
+}

package/dist/lib/src/functions_data.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionsData = void 0;
+const functions_base_1 = require("./functions_base");
+/**
+ * Define Function data for FirebaseFunctions.
+ *
+ * FirebaseFunctions用のFunctionのデータを定義します。
+ */
+class FunctionsData extends functions_base_1.FunctionsBase {
+    build(region) {
+        if (!this.func) {
+            return () => { };
+        }
+        return this.func(region, this.options, this.data);
+    }
+}
+exports.FunctionsData = FunctionsData;
+//# sourceMappingURL=functions_data.js.map

package/dist/lib/src/functions_data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions_data.js","sourceRoot":"","sources":["../../../src/lib/src/functions_data.ts"],"names":[],"mappings":";;;AAAA,qDAAiD;AAGjD;;;;GAIG;AACH,MAAa,aAAc,SAAQ,8BAAa;IAC9C,KAAK,CAAC,MAAgB;QACpB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CACd,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,IAAI,CACV,CAAC;IACJ,CAAC;CACF;AAXD,sCAWC"}

package/dist/lib/src/request_process_function_base.d.ts

@@ -0,0 +1,39 @@
+import * as functions from "firebase-functions/v2";
+import { FunctionsBase, HttpFunctionsOptions } from "./functions_base";
+import * as express from "express";
+export { Request } from "firebase-functions/v2/https";
+export { Response } from "express";
+/**
+ * Base class for defining Function data for HTTP request execution.
+ *
+ * HTTPリクエスト実行用のFunctionのデータを定義するためのベースクラス。
+ */
+export declare abstract class RequestProcessFunctionBase extends FunctionsBase {
+    /**
+     * Base class for defining Function data for HTTP request execution.
+     *
+     * HTTPリクエスト実行用のFunctionのデータを定義するためのベースクラス。
+     */
+    constructor(options?: HttpFunctionsOptions);
+    /**
+     * Specify the actual contents of the process.
+     *
+     * 実際の処理の中身を指定します。
+     *
+     * @param reqest
+     * Request passed to Functions.
+     *
+     * Functionsに渡されたRequest。
+     *
+     * @param response
+     * Response passed to Functions.
+     *
+     * Functionsに渡されたResponse。
+     */
+    abstract process(reqest: functions.https.Request, response: express.Response<any>): Promise<void>;
+    abstract id: string;
+    data: {
+        [key: string]: string;
+    };
+    build(regions: string[]): Function;
+}

package/dist/lib/src/request_process_function_base.js

@@ -0,0 +1,69 @@
+"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;
+};
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestProcessFunctionBase = void 0;
+const functions = __importStar(require("firebase-functions/v2"));
+const functions_base_1 = require("./functions_base");
+/**
+ * Base class for defining Function data for HTTP request execution.
+ *
+ * HTTPリクエスト実行用のFunctionのデータを定義するためのベースクラス。
+ */
+class RequestProcessFunctionBase extends functions_base_1.FunctionsBase {
+    /**
+     * Base class for defining Function data for HTTP request execution.
+     *
+     * HTTPリクエスト実行用のFunctionのデータを定義するためのベースクラス。
+     */
+    constructor(options = {}) {
+        super({ options: options });
+        this.data = {};
+    }
+    build(regions) {
+        var _a;
+        const options = this.options;
+        return functions.https.onRequest({
+            region: (_a = options === null || options === void 0 ? void 0 : options.region) !== null && _a !== void 0 ? _a : regions,
+            timeoutSeconds: options === null || options === void 0 ? void 0 : options.timeoutSeconds,
+            memory: options === null || options === void 0 ? void 0 : options.memory,
+            minInstances: options === null || options === void 0 ? void 0 : options.minInstances,
+            concurrency: options === null || options === void 0 ? void 0 : options.concurrency,
+            maxInstances: options === null || options === void 0 ? void 0 : options.maxInstances,
+        }, (req, res) => __awaiter(this, void 0, void 0, function* () {
+            return this.process(req, res);
+        }));
+    }
+}
+exports.RequestProcessFunctionBase = RequestProcessFunctionBase;
+//# sourceMappingURL=request_process_function_base.js.map

package/dist/lib/src/request_process_function_base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request_process_function_base.js","sourceRoot":"","sources":["../../../src/lib/src/request_process_function_base.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AACnD,qDAAuE;AAKvE;;;;GAIG;AACH,MAAsB,0BAA2B,SAAQ,8BAAa;IAClE;;;;OAIG;IACH,YAAY,UAAgC,EAAE;QAC1C,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAqBhC,SAAI,GAA8B,EAAE,CAAC;IApBrC,CAAC;IAqBD,KAAK,CAAC,OAAiB;;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAkD,CAAC;QACxE,OAAO,SAAS,CAAC,KAAK,CAAC,SAAS,CAC5B;YACI,MAAM,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,OAAO;YAClC,cAAc,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc;YACvC,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;YACvB,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;YACnC,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;YACjC,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;SACtC,EACD,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;YACf,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAClC,CAAC,CAAA,CACJ,CAAC;IACN,CAAC;CACJ;AA7CD,gEA6CC"}

package/dist/lib/src/schedule_process_function_base.d.ts

@@ -0,0 +1,33 @@
+import { FunctionsBase, SchedulerFunctionsOptions } from "./functions_base";
+/**
+ * Base class for defining the data of Functions for periodic scheduled execution.
+ *
+ * 定期スケジュール実行用のFunctionのデータを定義するためのベースクラス。
+ */
+export declare abstract class ScheduleProcessFunctionBase extends FunctionsBase {
+    /**
+     * Base class for defining the data of Functions for periodic scheduled execution.
+     *
+     * 定期スケジュール実行用のFunctionのデータを定義するためのベースクラス。
+     */
+    constructor(options?: SchedulerFunctionsOptions);
+    /**
+     * Specify the schedule to execute the process in cron format.
+     *
+     * 処理を実行するスケジュールをcron形式で指定します。
+     *
+     * https://firebase.google.com/docs/functions/schedule-functions
+     */
+    abstract schedule: string;
+    /**
+     * Specify the actual contents of the process.
+     *
+     * 実際の処理の中身を指定します。
+     */
+    abstract process(): Promise<void>;
+    abstract id: string;
+    data: {
+        [key: string]: string;
+    };
+    build(regions: string[]): Function;
+}

package/dist/lib/src/schedule_process_function_base.js

@@ -0,0 +1,70 @@
+"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;
+};
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduleProcessFunctionBase = void 0;
+const functions = __importStar(require("firebase-functions/v2"));
+const functions_base_1 = require("./functions_base");
+/**
+ * Base class for defining the data of Functions for periodic scheduled execution.
+ *
+ * 定期スケジュール実行用のFunctionのデータを定義するためのベースクラス。
+ */
+class ScheduleProcessFunctionBase extends functions_base_1.FunctionsBase {
+    /**
+     * Base class for defining the data of Functions for periodic scheduled execution.
+     *
+     * 定期スケジュール実行用のFunctionのデータを定義するためのベースクラス。
+     */
+    constructor(options = {}) {
+        super({ options: options });
+        this.data = {};
+    }
+    build(regions) {
+        var _a, _b;
+        const options = this.options;
+        return functions.scheduler.onSchedule({
+            schedule: (_a = options === null || options === void 0 ? void 0 : options.schedule) !== null && _a !== void 0 ? _a : this.schedule,
+            region: (_b = options === null || options === void 0 ? void 0 : options.region) !== null && _b !== void 0 ? _b : regions[0],
+            timeoutSeconds: options === null || options === void 0 ? void 0 : options.timeoutSeconds,
+            memory: options === null || options === void 0 ? void 0 : options.memory,
+            minInstances: options === null || options === void 0 ? void 0 : options.minInstances,
+            concurrency: options === null || options === void 0 ? void 0 : options.concurrency,
+            maxInstances: options === null || options === void 0 ? void 0 : options.maxInstances,
+        }, (event) => __awaiter(this, void 0, void 0, function* () {
+            return this.process();
+        }));
+    }
+}
+exports.ScheduleProcessFunctionBase = ScheduleProcessFunctionBase;
+//# sourceMappingURL=schedule_process_function_base.js.map

package/dist/lib/src/schedule_process_function_base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schedule_process_function_base.js","sourceRoot":"","sources":["../../../src/lib/src/schedule_process_function_base.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AACnD,qDAA4E;AAE5E;;;;GAIG;AACH,MAAsB,2BAA4B,SAAQ,8BAAa;IACnE;;;;OAIG;IACH,YAAY,UAAqC,EAAE;QAC/C,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAoBhC,SAAI,GAA8B,EAAE,CAAC;IAnBrC,CAAC;IAoBD,KAAK,CAAC,OAAiB;;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAuD,CAAC;QAC7E,OAAO,SAAS,CAAC,SAAS,CAAC,UAAU,CACjC;YACI,QAAQ,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,IAAI,CAAC,QAAQ;YAC5C,MAAM,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,OAAO,CAAC,CAAC,CAAC;YACrC,cAAc,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc;YACvC,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;YACvB,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;YACnC,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;YACjC,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;SACtC,EACD,CAAO,KAAK,EAAE,EAAE;YACZ,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAA,CACJ,CAAC;IACN,CAAC;CACJ;AA7CD,kEA6CC"}

package/dist/lib/src/sql_api_base.d.ts

@@ -0,0 +1,185 @@
+/**
+ * Base class for the API's model.
+ *
+ * Inherit this to create a model for the API.
+ *
+ * APIのモデルの基底クラス。
+ *
+ * これを継承してAPIのモデルを作成します。
+ */
+export declare abstract class SqlApiModelBase {
+    /**
+     * Convert [SqlApiModelBase] to a format that can be handled by Json.
+     *
+     * [SqlApiModelBase]をJsonで扱える形式に変換します。
+     *
+     * @returns {{ [key: string]: any }}
+     * Json format.
+     *
+     * Json形式。
+     */
+    abstract toJson(): {
+        [key: string]: any;
+    };
+}
+/**
+ * Base class for the API.
+ *
+ * Inherit this to create an API.
+ *
+ * APIの基底クラス。
+ *
+ * これを継承してAPIを作成します。
+ */
+export declare abstract class SqlApiBase<T extends SqlApiModelBase> {
+    /**
+     * Name of table to be used.
+     *
+     * 使用するテーブル名。
+     */
+    abstract table: string;
+    /**
+     * Get the data from the table.
+     *
+     * テーブルからデータを取得します。
+     *
+     * @param {{ [key: string]: any }[]} where
+     * Specify the conditions for retrieving data from Sql.
+     *
+     * Sqlからデータを取得するための条件を指定します。
+     *
+     * @returns {Promise<T[]>}
+     * Data from the table.
+     *
+     * テーブルからのデータ。
+     */
+    abstract get(where: {
+        [key: string]: any;
+    }[]): Promise<T[]>;
+    /**
+     * Get the number of records matching [where].
+     *
+     * [where]に一致するレコードの数を取得します。
+     *
+     * @param {{ [key: string]: any }[]} where
+     * Specify the conditions for retrieving data from Sql.
+     *
+     * Sqlからデータを取得するための条件を指定します。
+     *
+     * @returns {Promise<number>}
+     * Number of records matching [where].
+     *
+     * [where]に一致するレコードの数。
+     */
+    abstract count(where: {
+        [key: string]: any;
+    }[]): Promise<number>;
+    /**
+     * Add data to the table.
+     *
+     * テーブルにデータを追加します。
+     *
+     * @param {{ [key: string]: any }} value
+     * Data to be added to the table.
+     *
+     * テーブルに追加するデータ。
+     *
+     * @param {{ [key: string]: any }[]} where
+     * Specify the conditions for adding data from Sql.
+     *
+     * Sqlからデータを追加するための条件を指定します。
+     *
+     * @returns {Promise<T>}
+     * Data added to the table.
+     *
+     * テーブルに追加されたデータ。
+     */
+    abstract post(value: {
+        [key: string]: any;
+    }, where: {
+        [key: string]: any;
+    }[]): Promise<T>;
+    /**
+     * Update the data in the table.
+     *
+     * テーブルのデータを更新します。
+     *
+     * @param {{ [key: string]: any }} value
+     * Data to be updated in the table.
+     *
+     * テーブルの更新するデータ。
+     *
+     * @param {{ [key: string]: any }[]} where
+     * Specify the conditions for updating data from Sql.
+     *
+     * Sqlからデータを更新するための条件を指定します。
+     *
+     * @returns {Promise<T>}
+     * Updated data for the table.
+     *
+     * テーブルの更新されたデータ。
+     */
+    abstract put(value: {
+        [key: string]: any;
+    }, where: {
+        [key: string]: any;
+    }[]): Promise<T>;
+    /**
+     * Deletes data from the table.
+     *
+     * テーブルからデータを削除します。
+     *
+     * @param { [key: string]: any }[] where
+     * Specify the conditions for deleting data from Sql.
+     *
+     * Sqlからデータを削除するための条件を指定します。
+     *
+     * @returns {Promise<void>}
+     */
+    abstract delete(where: {
+        [key: string]: any;
+    }[]): Promise<void>;
+    /**
+     *
+     * @param {string} table
+     * Table Name.
+     *
+     * テーブル名。
+     *
+     * @param {"GET" | "POST" | "DELETE" | "PUT" | "COUNT"} method
+     * Specify the method to be used.
+     *
+     * 使用するメソッドを指定します。
+     *
+     * @param {{ [key: string]: any }[]} where
+     * Specify the conditions for retrieving data from Sql.
+     *
+     * Sqlからデータを取得するための条件を指定します。
+     *
+     * @param {{ [key: string]: any } | undefined} value
+     * Data to be added to the table.
+     *
+     * テーブルに追加するデータ。
+     *
+     * @returns {Promise<{ [key: string]: any }[] | number | null>}
+     * When [null] is returned, the condition is not met.
+     *
+     * Otherwise, it returns the retrieved data.
+     *
+     * [null]が返却されたときは条件に一致しないとき。
+     *
+     * その他の場合は取得されたデータを返します。
+     */
+    process({ table, method, where, value, }: {
+        table: string;
+        method: "GET" | "POST" | "DELETE" | "PUT" | "COUNT";
+        where?: {
+            [key: string]: any;
+        }[] | undefined;
+        value?: {
+            [key: string]: any;
+        } | undefined;
+    }): Promise<{
+        [key: string]: any;
+    }[] | number | null>;
+}