@mathrunet/masamune_cloudflare 3.1.0

package/dist/lib/model_field_value/model_field_value_converter.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Base class for converting [ModelFieldValue] for use in Firestore.
+ *
+ * Firestoreで利用するための[ModelFieldValue]の変換を行うベースクラス。
+ */
+export declare abstract class ModelFieldValueConverter {
+    /**
+     * Base class for converting [ModelFieldValue] for use in Firestore.
+     *
+     * Firestoreで利用するための[ModelFieldValue]の変換を行うベースクラス。
+     */
+    constructor();
+    /**
+     * The type of [ModelFieldValue] that can be converted.
+     *
+     * 変換可能な[ModelFieldValue]の型。
+     */
+    abstract type: string;
+    /**
+     * Convert from Firestore manageable type to [ModelFieldValue].
+     *
+     * Firestoreで管理可能な型から[ModelFieldValue]に変換します。
+     *
+     * @param key
+     * @param value
+     * @param original
+     * @returns
+     */
+    abstract convertFrom(key: string, value: any, original: {
+        [field: string]: any;
+    }): {
+        [field: string]: any;
+    } | null;
+    /**
+     * Convert from [ModelFieldValue] to Firestore manageable type.
+     *
+     * [ModelFieldValue]からFirestoreで管理可能な型に変換します。
+     *
+     * @param key
+     * @param value
+     * @param original
+     * @returns
+     */
+    abstract convertTo(key: string, value: any, original: {
+        [field: string]: any;
+    }): {
+        [field: string]: any;
+    } | null;
+}
+/**
+ * Base class for converting [ModelFieldValue] for use in Firestore.
+ *
+ * Firestoreで利用するための[ModelFieldValue]の変換を行うベースクラス。
+ */
+export declare abstract class FirestoreModelFieldValueConverter {
+    /**
+     * Base class for converting [ModelFieldValue] for use in Firestore.
+     *
+     * Firestoreで利用するための[ModelFieldValue]の変換を行うベースクラス。
+     */
+    constructor();
+    /**
+     * The type of [ModelFieldValue] that can be converted.
+     *
+     * 変換可能な[ModelFieldValue]の型。
+     */
+    abstract type: string;
+    /**
+     * Convert from Firestore manageable type to [ModelFieldValue].
+     *
+     * Generate and return a [DynamicMap] value from [key] and [value]. [original] is passed the [DynamicMap] before conversion.
+     *
+     * Return [Null] if there are no changes.
+     *
+     * Firestoreで管理可能な型から[ModelFieldValue]に変換します。
+     *
+     * [key]と[value]から[DynamicMap]の値を生成して返してください。[original]は変換前の[DynamicMap]を渡します。
+     *
+     * 変更がない場合は[Null]を返してください。
+     */
+    abstract convertFrom(key: string, value: any, original: {
+        [field: string]: any;
+    }, firestoreInstance: FirebaseFirestore.Firestore): {
+        [field: string]: any;
+    } | null;
+    /**
+     * Convert from [ModelFieldValue] to Firestore manageable type.
+     *
+     * Generate and return a [DynamicMap] value from [key] and [value]. [original] is passed the [DynamicMap] before conversion.
+     *
+     * Return [Null] if there are no changes.
+     *
+     * [ModelFieldValue]からFirestoreで管理可能な型に変換します。
+     *
+     * [key]と[value]から[DynamicMap]の値を生成して返してください。[original]は変換前の[DynamicMap]を渡します。
+     *
+     * 変更がない場合は[Null]を返してください。
+     */
+    abstract convertTo(key: string, value: any, original: {
+        [field: string]: any;
+    }, firestoreInstance: FirebaseFirestore.Firestore): {
+        [field: string]: any;
+    } | null;
+    /**
+     * Generate a header for ModelFieldValue.
+     *
+     * ModelFieldValue用のヘッダーを生成します。
+     *
+     * @returns { { [field: string]: any } }
+     * Header for ModelFieldValue.
+     *
+     * ModelFieldValue用のヘッダー。
+     */
+    header(): {
+        [field: string]: any;
+    };
+}

package/dist/lib/model_field_value/model_field_value_converter.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FirestoreModelFieldValueConverter = exports.ModelFieldValueConverter = void 0;
+/**
+ * Base class for converting [ModelFieldValue] for use in Firestore.
+ *
+ * Firestoreで利用するための[ModelFieldValue]の変換を行うベースクラス。
+ */
+class ModelFieldValueConverter {
+    /**
+     * Base class for converting [ModelFieldValue] for use in Firestore.
+     *
+     * Firestoreで利用するための[ModelFieldValue]の変換を行うベースクラス。
+     */
+    constructor() { }
+}
+exports.ModelFieldValueConverter = ModelFieldValueConverter;
+/**
+ * Base class for converting [ModelFieldValue] for use in Firestore.
+ *
+ * Firestoreで利用するための[ModelFieldValue]の変換を行うベースクラス。
+ */
+class FirestoreModelFieldValueConverter {
+    /**
+     * Base class for converting [ModelFieldValue] for use in Firestore.
+     *
+     * Firestoreで利用するための[ModelFieldValue]の変換を行うベースクラス。
+     */
+    constructor() { }
+    /**
+     * Generate a header for ModelFieldValue.
+     *
+     * ModelFieldValue用のヘッダーを生成します。
+     *
+     * @returns { { [field: string]: any } }
+     * Header for ModelFieldValue.
+     *
+     * ModelFieldValue用のヘッダー。
+     */
+    header() {
+        return {
+            "@source": "server",
+            "@type": this.type,
+        };
+    }
+    ;
+}
+exports.FirestoreModelFieldValueConverter = FirestoreModelFieldValueConverter;
+//# sourceMappingURL=model_field_value_converter.js.map

package/dist/lib/model_field_value/model_field_value_converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model_field_value_converter.js","sourceRoot":"","sources":["../../../src/lib/model_field_value/model_field_value_converter.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACH,MAAsB,wBAAwB;IAC1C;;;;OAIG;IACH,gBAAgB,CAAC;CAqCpB;AA3CD,4DA2CC;AAED;;;;GAIG;AACH,MAAsB,iCAAiC;IACnD;;;;OAIG;IACH,gBAAgB,CAAC;IA+CjB;;;;;;;;;OASG;IACH,MAAM;QACF,OAAO;YACH,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,IAAI,CAAC,IAAI;SACrB,CAAC;IACN,CAAC;IAAA,CAAC;CACL;AArED,8EAqEC"}

package/dist/lib/regions.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Define the Region.
+ *
+ * Regionの定義を行います。
+ */
+export type Regions = ("us-central1" | "us-east1" | "us-east4" | "europe-west1" | "europe-west2" | "europe-west3" | "asia-east2" | "asia-northeast1")[];

package/dist/lib/regions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=regions.js.map

package/dist/lib/regions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"regions.js","sourceRoot":"","sources":["../../src/lib/regions.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,39 @@
+import * as functions from "firebase-functions/v2";
+import { FunctionsBase, HttpFunctionsOptions } from "./functions_base";
+export { CallableRequest } from "firebase-functions/v2/https";
+/**
+ * Base class for defining the data of Functions for executing the Call method of Functions.
+ *
+ * FunctionsのCallメソッド実行用のFunctionのデータを定義するためのベースクラス。
+ */
+export declare abstract class CallProcessFunctionBase extends FunctionsBase {
+    /**
+     * Base class for defining the data of Functions for executing the Call method of Functions.
+     *
+     * FunctionsのCallメソッド実行用のFunctionのデータを定義するためのベースクラス。
+     */
+    constructor(options?: HttpFunctionsOptions);
+    /**
+     * Specify the actual contents of the process.
+     *
+     * 実際の処理の中身を指定します。
+     *
+     * @param {any} query
+     * Query passed to Functions.
+     *
+     * Functionsに渡されたクエリ。
+     *
+     * @returns {{ [key: string]: any }}
+     * Return value of the process.
+     *
+     * 処理の戻り値。
+     */
+    abstract process(query: functions.https.CallableRequest<any>): Promise<{
+        [key: string]: any;
+    }>;
+    abstract id: string;
+    data: {
+        [key: string]: any;
+    };
+    build(regions: string[]): Function;
+}

package/dist/lib/src/call_process_function_base.js

@@ -0,0 +1,72 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallProcessFunctionBase = 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 executing the Call method of Functions.
+ *
+ * FunctionsのCallメソッド実行用のFunctionのデータを定義するためのベースクラス。
+ */
+class CallProcessFunctionBase extends functions_base_1.FunctionsBase {
+    /**
+     * Base class for defining the data of Functions for executing the Call method of Functions.
+     *
+     * FunctionsのCallメソッド実行用のFunctionのデータを定義するためのベースクラス。
+     */
+    constructor(options = {}) {
+        super({ options: options });
+    }
+    data = {};
+    build(regions) {
+        const options = this.options;
+        return functions.https.onCall({
+            region: options?.region ?? regions,
+            timeoutSeconds: options?.timeoutSeconds,
+            memory: options?.memory,
+            minInstances: options?.minInstances,
+            concurrency: options?.concurrency,
+            maxInstances: options?.maxInstances,
+            serviceAccount: options?.serviceAccount ?? undefined,
+            enforceAppCheck: options?.enforceAppCheck ?? undefined,
+            consumeAppCheckToken: options?.consumeAppCheckToken ?? undefined,
+        }, async (query) => {
+            return this.process(query);
+        });
+    }
+}
+exports.CallProcessFunctionBase = CallProcessFunctionBase;
+//# sourceMappingURL=call_process_function_base.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"call_process_function_base.js","sourceRoot":"","sources":["../../../src/lib/src/call_process_function_base.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AACnD,qDAAyF;AAIzF;;;;GAIG;AACH,MAAsB,uBAAwB,SAAQ,8BAAa;IAC/D;;;;OAIG;IACH,YAAY,UAAgC,EAAE;QAC1C,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAChC,CAAC;IAoBD,IAAI,GAA2B,EAAE,CAAC;IAClC,KAAK,CAAC,OAAiB;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAkD,CAAC;QACxE,OAAO,SAAS,CAAC,KAAK,CAAC,MAAM,CACzB;YACI,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,OAAO;YAClC,cAAc,EAAE,OAAO,EAAE,cAAc;YACvC,MAAM,EAAE,OAAO,EAAE,MAAM;YACvB,YAAY,EAAE,OAAO,EAAE,YAAY;YACnC,WAAW,EAAE,OAAO,EAAE,WAAW;YACjC,YAAY,EAAE,OAAO,EAAE,YAAY;YACnC,cAAc,EAAE,OAAO,EAAE,cAAc,IAAI,SAAS;YACpD,eAAe,EAAE,OAAO,EAAE,eAAe,IAAI,SAAS;YACtD,oBAAoB,EAAE,OAAO,EAAE,oBAAoB,IAAI,SAAS;SACnE,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,CACJ,CAAC;IACN,CAAC;CACJ;AAhDD,0DAgDC"}

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

@@ -0,0 +1,30 @@
+import * as firestore from "firebase-admin/firestore";
+import { Bucket } from '@google-cloud/storage';
+/**
+ * Loads the Firestore instance.
+ *
+ * Firestoreインスタンスを読み込みます。
+ *
+ * @param databaseId
+ * Firestore Database ID.
+ *
+ * FirestoreのデータベースID。
+ *
+ * @returns
+ * Firestore instance.
+ *
+ * Firestoreインスタンス。
+ */
+export declare function firestoreLoader(databaseId: string | null | undefined): firestore.Firestore;
+/**
+ * Loads the Storage instance.
+ *
+ * Storageインスタンスを読み込みます。
+ *
+ * @param bucketId
+ * StorageのバケットID。
+ *
+ * @returns
+ * Storageインスタンス。
+ */
+export declare function storageLoader(bucketId: string): Bucket;

package/dist/lib/src/firebase_loader.js

@@ -0,0 +1,96 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firestoreLoader = firestoreLoader;
+exports.storageLoader = storageLoader;
+const firestore = __importStar(require("firebase-admin/firestore"));
+const storage = __importStar(require("firebase-admin/storage"));
+const admin = __importStar(require("firebase-admin"));
+/**
+ * Loads the Firestore instance.
+ *
+ * Firestoreインスタンスを読み込みます。
+ *
+ * @param databaseId
+ * Firestore Database ID.
+ *
+ * FirestoreのデータベースID。
+ *
+ * @returns
+ * Firestore instance.
+ *
+ * Firestoreインスタンス。
+ */
+function firestoreLoader(databaseId) {
+    if (admin.apps.length === 0) {
+        admin.initializeApp();
+    }
+    if (!databaseId || databaseId == "" || databaseId == "(default)") {
+        const app = admin.apps[0];
+        if (!app) {
+            throw new Error("No app found");
+        }
+        return firestore.getFirestore(app);
+    }
+    else {
+        const app = admin.apps[0];
+        if (!app) {
+            throw new Error("No app found");
+        }
+        return firestore.getFirestore(app, databaseId);
+    }
+}
+/**
+ * Loads the Storage instance.
+ *
+ * Storageインスタンスを読み込みます。
+ *
+ * @param bucketId
+ * StorageのバケットID。
+ *
+ * @returns
+ * Storageインスタンス。
+ */
+function storageLoader(bucketId) {
+    if (admin.apps.length === 0) {
+        admin.initializeApp();
+    }
+    const app = admin.apps[0];
+    if (!app) {
+        throw new Error("No app found");
+    }
+    return storage.getStorage(app).bucket(bucketId);
+}
+//# sourceMappingURL=firebase_loader.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"firebase_loader.js","sourceRoot":"","sources":["../../../src/lib/src/firebase_loader.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoBA,0CAiBC;AAaD,sCASC;AA3DD,oEAAsD;AACtD,gEAAkD;AAElD,sDAAwC;AAExC;;;;;;;;;;;;;;GAcG;AACH,SAAgB,eAAe,CAAC,UAAqC;IACjE,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,aAAa,EAAE,CAAC;IAC1B,CAAC;IACD,IAAI,CAAC,UAAU,IAAI,UAAU,IAAI,EAAE,IAAI,UAAU,IAAI,WAAW,EAAE,CAAC;QAC/D,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1B,IAAG,CAAC,GAAG,EAAC,CAAC;YACL,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACJ,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1B,IAAG,CAAC,GAAG,EAAC,CAAC;YACL,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACnD,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,aAAa,CAAC,QAAgB;IAC1C,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,aAAa,EAAE,CAAC;IAC1B,CAAC;IACD,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1B,IAAG,CAAC,GAAG,EAAC,CAAC;QACL,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACpD,CAAC"}

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

@@ -0,0 +1,114 @@
+import * as admin from "firebase-admin";
+/**
+ * Create a filter for loading Firestore collections.
+ *
+ * Firestoreのコレクションをロードする際のフィルターを作成します。
+ *
+ * @param query
+ * Specifies a reference to a Firestore collection.
+ *
+ * Firestoreのコレクションのリファレンスを指定します。
+ *
+ * @param wheres
+ * Specifies the filter to be applied to the collection.
+ *
+ * コレクションに適用するフィルターを指定します。
+ *
+ * @returns
+ * Returns a Firestore query with the specified filter.
+ *
+ * 指定されたフィルターを持つFirestoreのクエリを返します。
+ */
+export declare function where({ query, wheres, }: {
+    query: admin.firestore.Query<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    wheres: {
+        [key: string]: any;
+    }[] | undefined;
+}): admin.firestore.Query<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+/**
+ * Judges whether all the conditions in [conditons] match the document data in [data].
+ *
+ * If a reference is included in [data], the document is retrieved recursively and the condition is determined.
+ *
+ * [data]のドキュメントデータに対して、[conditions]の条件が全て一致するかどうかを判定します。
+ *
+ * [data]の中にリファレンスが含まれている場合、再帰的にドキュメントを取得し条件を判定します。
+ *
+ * @param data
+ * Target document data.
+ *
+ * 対象となるドキュメントデータ。
+ *
+ * @param conditions
+ * Conditions to be matched.
+ *
+ * 一致させる条件。
+ *
+ * @returns
+ * Returns true if all conditions match, false otherwise.
+ *
+ * 全ての条件が一致する場合はtrue、それ以外はfalseを返します。
+ */
+export declare function hasMatch({ data, conditions, }: {
+    data: {
+        [key: string]: any;
+    };
+    conditions: {
+        [key: string]: any;
+    }[] | undefined;
+}): Promise<boolean>;
+/**
+ * Get the value of the specified field from the document data.
+ *
+ * ドキュメントデータから指定されたフィールドの値を取得します。
+ *
+ * @param data
+ * Target document data.
+ *
+ * 対象となるドキュメントデータ。
+ *
+ * @param field
+ * Specifies the field to be retrieved.
+ *
+ * 取得するフィールドを指定します。
+ *
+ * @returns
+ * Returns the value of the specified field.
+ *
+ * 指定されたフィールドの値を返します。
+ */
+export declare function get({ data, field, }: {
+    data: {
+        [key: string]: any;
+    };
+    field: {
+        [key: string]: any;
+    } | string;
+}): Promise<any>;
+/**
+ * Get [limit] documents from [cursor].
+ *
+ * [cursor]から[limit]個のドキュメントを取得します。
+ *
+ * @param query
+ * Specifies a reference to a Firestore collection.
+ *
+ * Firestoreのコレクションのリファレンスを指定します。
+ *
+ * @param limit
+ * Specifies the number of documents to be retrieved.
+ *
+ * 取得するドキュメントの数を指定します。
+ *
+ * @param cursor
+ * Specifies the document to start retrieving from.
+ *
+ * 取得を開始するドキュメントを指定します。
+ *
+ * @returns
+ */
+export declare function cursor({ query, limit, cursor, }: {
+    query: admin.firestore.Query<admin.firestore.DocumentData, admin.firestore.DocumentData>;
+    limit: number;
+    cursor: FirebaseFirestore.QueryDocumentSnapshot | undefined | null;
+}): admin.firestore.Query<admin.firestore.DocumentData, admin.firestore.DocumentData>;