@mathrunet/masamune 1.6.5 → 1.7.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# [1.7.0](https://github.com/mathrunet/node_masamune/compare/v1.6.4...v1.7.0) (2023-11-03)
+
+
+### feat
+
+* Add SqlApiBase. ([ff6c5b2](https://github.com/mathrunet/node_masamune/commit/ff6c5b28905402f326904eb4052e86db82be4778))
+
+### fix
+
+* ver.1.6.5. ([33bb2ec](https://github.com/mathrunet/node_masamune/commit/33bb2ec9f27c208926b093699d65d1c74ad854e7))
+
+
+
 ## [1.6.4](https://github.com/mathrunet/node_masamune/compare/v1.6.3...v1.6.4) (2023-11-02)
 
 

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import * as base from "./lib/functions_base";
 import * as regions from "./lib/regions";
 export * from "./functions";
 export * from "./lib/api";
+export * from "./lib/sql_api_base";
 export * from "./lib/schedule_process_function_base";
 export * from "./lib/request_process_function_base";
 export * from "./lib/call_process_function_base";

package/dist/index.js

@@ -30,6 +30,7 @@ exports.deploy = exports.notification = exports.sendGrid = exports.gmail = void
 const admin = __importStar(require("firebase-admin"));
 __exportStar(require("./functions"), exports);
 __exportStar(require("./lib/api"), exports);
+__exportStar(require("./lib/sql_api_base"), exports);
 __exportStar(require("./lib/schedule_process_function_base"), exports);
 __exportStar(require("./lib/request_process_function_base"), exports);
 __exportStar(require("./lib/call_process_function_base"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,sDAAwC;AAExC,8CAA4B;AAC5B,4CAA0B;AAC1B,uEAAqD;AACrD,sEAAoD;AACpD,mEAAiD;AACjD,0DAAwC;AACxC,8CAA4B;AAC5B,gEAA8C;AAC9C,qDAAqC;AACrC,4DAA4C;AAC5C,wEAAwD;AAExD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,MAAM,CAAC,OAAY,EAAE,MAAuB,EAAE,eAAqC;IAC/F,KAAK,CAAC,aAAa,EAAE,CAAC;IACtB,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE;QAChC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,IAAI,CAAC,EAAE,EAAE;YACrE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;SACpD;KACJ;AACL,CAAC;AAPD,wBAOC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,sDAAwC;AAExC,8CAA4B;AAC5B,4CAA0B;AAC1B,qDAAmC;AACnC,uEAAqD;AACrD,sEAAoD;AACpD,mEAAiD;AACjD,0DAAwC;AACxC,8CAA4B;AAC5B,gEAA8C;AAC9C,qDAAqC;AACrC,4DAA4C;AAC5C,wEAAwD;AAExD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,MAAM,CAAC,OAAY,EAAE,MAAuB,EAAE,eAAqC;IAC/F,KAAK,CAAC,aAAa,EAAE,CAAC;IACtB,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE;QAChC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,IAAI,CAAC,EAAE,EAAE;YACrE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;SACpD;KACJ;AACL,CAAC;AAPD,wBAOC"}

package/dist/lib/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>;
+}

package/dist/lib/sql_api_base.js

@@ -0,0 +1,94 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SqlApiBase = exports.SqlApiModelBase = void 0;
+/**
+ * Base class for the API's model.
+ *
+ * Inherit this to create a model for the API.
+ *
+ * APIのモデルの基底クラス。
+ *
+ * これを継承してAPIのモデルを作成します。
+ */
+class SqlApiModelBase {
+}
+exports.SqlApiModelBase = SqlApiModelBase;
+/**
+ * Base class for the API.
+ *
+ * Inherit this to create an API.
+ *
+ * APIの基底クラス。
+ *
+ * これを継承してAPIを作成します。
+ */
+class SqlApiBase {
+    /**
+     *
+     * @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, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (table !== this.table) {
+                return null;
+            }
+            switch (method) {
+                case "GET": {
+                    return (yield this.get(where !== null && where !== void 0 ? where : [])).map((e) => { return e.toJson(); });
+                }
+                case "COUNT": {
+                    yield this.count(where !== null && where !== void 0 ? where : []);
+                    return [];
+                }
+                case "POST": {
+                    return [(yield this.post(value !== null && value !== void 0 ? value : {}, where !== null && where !== void 0 ? where : [])).toJson()];
+                }
+                case "PUT": {
+                    return [(yield this.put(value !== null && value !== void 0 ? value : {}, where !== null && where !== void 0 ? where : [])).toJson()];
+                }
+                case "DELETE": {
+                    yield this.delete(where !== null && where !== void 0 ? where : []);
+                    return [];
+                }
+            }
+        });
+    }
+}
+exports.SqlApiBase = SqlApiBase;
+//# sourceMappingURL=sql_api_base.js.map

package/dist/lib/sql_api_base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql_api_base.js","sourceRoot":"","sources":["../../src/lib/sql_api_base.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA;;;;;;;;GAQG;AACH,MAAsB,eAAe;CAYpC;AAZD,0CAYC;AAED;;;;;;;;GAQG;AACH,MAAsB,UAAU;IAoG5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,OAAO,CAAC,EACV,KAAK,EACL,MAAM,EACN,KAAK,EACL,KAAK,GAMJ;;YACD,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE;gBACtB,OAAO,IAAI,CAAC;aACf;YACD,QAAQ,MAAM,EAAE;gBACZ,KAAK,KAAK,CAAC,CAAC;oBACR,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,MAAM,EAAE,CAAA,CAAC,CAAC,CAAC,CAAC;iBAC1E;gBACD,KAAK,OAAO,CAAC,CAAC;oBACV,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC;oBAC9B,OAAO,EAAE,CAAC;iBACb;gBACD,KAAK,MAAM,CAAC,CAAC;oBACT,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;iBACjE;gBACD,KAAK,KAAK,CAAC,CAAC;oBACR,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;iBAChE;gBACD,KAAK,QAAQ,CAAC,CAAC;oBACX,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC;oBAC/B,OAAO,EAAE,CAAC;iBACb;aACJ;QACL,CAAC;KAAA;CACJ;AArKD,gCAqKC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mathrunet/masamune",
-  "version": "1.6.5",
+  "version": "1.7.0",
   "description": "Manages packages for the server portion (NodeJS) of the Masamune framework.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",