@mathrunet/masamune 0.0.7 → 0.1.0

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+# [0.1.0](https://github.com/mathrunet/node_masamune/compare/v0.0.8...v0.1.0) (2023-02-08)
+
+
+### chore
+
+* Edit .gitignore. ([de837ef](https://github.com/mathrunet/node_masamune/commit/de837ef8e831c6fba55e8fa94c0e33fa6cf8b7ff))
+
+### feat
+
+* Allow region to be specified externally. ([782d805](https://github.com/mathrunet/node_masamune/commit/782d805ac88c3991eabb3017f78cca083dd42f33))
+
+
+
+## [0.0.8](https://github.com/mathrunet/node_masamune/compare/v0.0.7...v0.0.8) (2023-01-17)
+
+
+### docs
+
+* ReadMe creation. ([6f91ba9](https://github.com/mathrunet/node_masamune/commit/6f91ba97d8c8e3f7d41a6299d95e51a69b90fe1c))
+
+### fix
+
+* Changed the function name of notification. ([c1a152c](https://github.com/mathrunet/node_masamune/commit/c1a152cd3398325a7149bf4a852fe368088e4f16))
+
+
+
 ## [0.0.7](https://github.com/mathrunet/node_masamune/compare/v0.0.6...v0.0.7) (2023-01-11)
 
 

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020, mathru (https://mathru.net)
+Copyright (c) 2023, mathru (https://mathru.net)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/README.md

@@ -19,4 +19,37 @@
 
 [[YouTube]](https://www.youtube.com/c/mathrunetchannel) | [[Packages]](https://pub.dev/publishers/mathru.net/packages) | [[Twitter]](https://twitter.com/mathru) | [[LinkedIn]](https://www.linkedin.com/in/mathrunet/)
 
----
+---
+
+Just load the package in index.ts and pass the predefined data to the methods to implement the server side.
+
+Also, [katana_functions_firebase](https://pub.dev/packages/katana_functions_firebase/score) can be used to execute server-side functions from methods defined on the client side, allowing for safe implementation.
+
+# Installation
+
+Install the following packages
+
+```bash
+npm install @mathrunet/masamune
+```
+
+# Implementation
+
+Import the package as follows and pass the value of `exports` and the list of functions you wish to define to the `deploy` function.
+
+```dart
+import * as m from "@mathrunet/masamune";
+
+// Define [m.Functions.xxxx] for the functions to be added to Functions.
+// 
+// Functionsに追加する機能を[m.Functions.xxxx]を定義してください。
+m.deploy(
+    exports,
+    [
+        // Function for PUSH Notification.
+        m.Functions.notification,
+    ],
+);
+```
+
+Functions passed to deploy are deployed to Cloud Functions for Firebase.

package/dist/functions/send_notification.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/functions/send_notification.js

@@ -0,0 +1,111 @@
+"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 });
+const functions = __importStar(require("firebase-functions"));
+const admin = __importStar(require("firebase-admin"));
+/**
+ * Define the process for PUSH notification.
+ *
+ * PUSH通知を行うための処理を定義します。
+ *
+ * @param title
+ * The title of the notice should be listed.
+ *
+ * 通知タイトルを記載します。
+ *
+ * @param body
+ * The contents of the notice will be described.
+ *
+ * 通知内容を記載します。
+ *
+ * @param channel_id
+ * Describe ChannelId for Android.
+ *
+ * Android向けのChannelIdを記載します。
+ *
+ * @param data
+ * Specify the data to be placed on the notification.
+ *
+ * 通知に乗せるデータを指定します。
+ *
+ * @param token
+ * Specifies the FCM token.
+ *
+ * FCMトークンを指定します。
+ *
+ * @param topic
+ * Specifies the topic of the FCM.
+ *
+ * FCMのトピックを指定します。
+ */
+module.exports = (region) => functions.region(region).https.onCall((query) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const title = query.title;
+        const body = query.body;
+        const channelId = query.channel_id;
+        const data = query.data;
+        const token = query.token;
+        const topic = query.topic;
+        if (token === undefined || topic === undefined) {
+            throw new functions.https.HttpsError("invalid-argument", "Either [token] or [topic] must be specified.");
+        }
+        const res = yield admin.messaging().send({
+            notification: {
+                title: title,
+                body: body,
+            },
+            android: {
+                priority: "high",
+                notification: {
+                    title: title,
+                    body: body,
+                    clickAction: "FLUTTER_NOTIFICATION_CLICK",
+                    channelId: channelId,
+                },
+            },
+            data: data,
+            token: token,
+            topic: topic,
+        });
+        return {
+            success: true,
+            message_id: res,
+        };
+    }
+    catch (err) {
+        console.log(err);
+        throw err;
+    }
+}));
+//# sourceMappingURL=send_notification.js.map

package/dist/functions/send_notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send_notification.js","sourceRoot":"","sources":["../../src/functions/send_notification.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8DAAgD;AAChD,sDAAwC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,OAAO,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CACtE,CAAO,KAAK,EAAE,EAAE;IACZ,IAAI;QACA,MAAM,KAAK,GAAG,KAAK,CAAC,KAAe,CAAC;QACpC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAc,CAAC;QAClC,MAAM,SAAS,GAAG,KAAK,CAAC,UAAgC,CAAC;QACzD,MAAM,IAAI,GAAG,KAAK,CAAC,IAA6C,CAAC;QACjE,MAAM,KAAK,GAAG,KAAK,CAAC,KAA2B,CAAC;QAChD,MAAM,KAAK,GAAG,KAAK,CAAC,KAA2B,CAAC;QAChD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE;YAC5C,MAAM,IAAI,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,kBAAkB,EAAE,8CAA8C,CAAC,CAAC;SAC5G;QACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE,CAAC,IAAI,CACpC;YACI,YAAY,EAAE;gBACV,KAAK,EAAE,KAAK;gBACZ,IAAI,EAAE,IAAI;aACb;YACD,OAAO,EAAE;gBACL,QAAQ,EAAE,MAAM;gBAChB,YAAY,EAAE;oBACV,KAAK,EAAE,KAAK;oBACZ,IAAI,EAAE,IAAI;oBACV,WAAW,EAAE,4BAA4B;oBACzC,SAAS,EAAE,SAAS;iBACvB;aACJ;YACD,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,KAAK;SACf,CACJ,CAAC;QACF,OAAO;YACH,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,GAAG;SAClB,CAAC;KACL;IAAC,OAAO,GAAG,EAAE;QACV,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjB,MAAM,GAAG,CAAC;KACb;AACL,CAAC,CAAA,CACJ,CAAC"}

package/dist/functions.d.ts

@@ -10,5 +10,5 @@ export declare const Functions: {
      *
      * PUSH通知を送信するためのFunction。
      */
-    readonly notification: data.FunctionsData;
+    readonly sendNotification: data.FunctionsData;
 };

package/dist/functions.js

@@ -36,6 +36,6 @@ exports.Functions = {
      *
      * PUSH通知を送信するためのFunction。
      */
-    notification: new data.FunctionsData("notification", require("./functions/notification")),
+    sendNotification: new data.FunctionsData("send_notification", require("./functions/send_notification")),
 };
 //# sourceMappingURL=functions.js.map

package/dist/functions.js.map

@@ -1 +1 @@
-{"version":3,"file":"functions.js","sourceRoot":"","sources":["../src/functions.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAA6C;AAE7C;;;;GAIG;AACU,QAAA,SAAS,GAAG;IACvB;;;;OAIG;IACH,YAAY,EAAE,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;CACjF,CAAC"}
+{"version":3,"file":"functions.js","sourceRoot":"","sources":["../src/functions.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAA6C;AAE7C;;;;GAIG;AACU,QAAA,SAAS,GAAG;IACvB;;;;OAIG;IACH,gBAAgB,EAAE,IAAI,IAAI,CAAC,aAAa,CAAC,mBAAmB,EAAE,OAAO,CAAC,+BAA+B,CAAC,CAAC;CAC/F,CAAC"}

package/dist/index.d.ts

@@ -11,9 +11,14 @@ export * from "./lib/functions_data";
  *
  * `exports`をそのまま渡します。
  *
+ * @param region
+ * Specify a region such as `asia-northeast1`.
+ *
+ * `asia-northeast1`などのリージョンを指定します。
+ *
  * @param deployFunctions
  * The elements defined in [Functions] are passed as an array. The passed method is deployed.
  *
  * [Functions]で定義された要素を配列として渡します。渡されたメソッドがデプロイされます。
  */
-export declare function deploy(exports: any, deployFunctions: data.FunctionsData[]): void;
+export declare function deploy(exports: any, region: string, deployFunctions: data.FunctionsData[]): void;

package/dist/index.js

@@ -40,16 +40,21 @@ __exportStar(require("./lib/functions_data"), exports);
  *
  * `exports`をそのまま渡します。
  *
+ * @param region
+ * Specify a region such as `asia-northeast1`.
+ *
+ * `asia-northeast1`などのリージョンを指定します。
+ *
  * @param deployFunctions
  * The elements defined in [Functions] are passed as an array. The passed method is deployed.
  *
  * [Functions]で定義された要素を配列として渡します。渡されたメソッドがデプロイされます。
  */
-function deploy(exports, deployFunctions) {
+function deploy(exports, region, deployFunctions) {
     admin.initializeApp();
     for (const data of deployFunctions) {
         if (!process.env.FUNCTION_NAME || process.env.FUNCTION_NAME === data.id) {
-            exports[data.id] = data.func;
+            exports[data.id] = data.func(region);
         }
     }
 }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,sDAAwC;AACxC,8CAA4B;AAC5B,uDAAqC;AAErC;;;;;;;;;;;;;;GAcG;AACH,SAAgB,MAAM,CAAC,OAAY,EAAE,eAAqC;IACtE,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,IAAI,CAAC;SAChC;KACJ;AACL,CAAC;AAPD,wBAOC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,sDAAwC;AACxC,8CAA4B;AAC5B,uDAAqC;AAErC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,MAAM,CAAC,OAAY,EAAE,MAAc,EAAE,eAAqC;IACtF,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,IAAI,CAAC,MAAM,CAAC,CAAC;SACxC;KACJ;AACL,CAAC;AAPD,wBAOC"}

package/dist/lib/functions_data.d.ts

@@ -5,7 +5,7 @@
  */
 export declare class FunctionsData {
     readonly id: string;
-    readonly func: Function;
+    readonly func: (region: string) => Function;
     /**
      * Define Function data for FirebaseFunctions.
      *
@@ -21,5 +21,5 @@ export declare class FunctionsData {
      *
      * 実際の処理の中身を指定します。
      */
-    constructor(id: string, func: Function);
+    constructor(id: string, func: (region: string) => Function);
 }

package/dist/lib/functions_data.js.map

@@ -1 +1 @@
-{"version":3,"file":"functions_data.js","sourceRoot":"","sources":["../../src/lib/functions_data.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;IACH,YAAqB,EAAU,EAAW,IAAc;QAAnC,OAAE,GAAF,EAAE,CAAQ;QAAW,SAAI,GAAJ,IAAI,CAAU;IAAG,CAAC;CAC7D;AAjBD,sCAiBC"}
+{"version":3,"file":"functions_data.js","sourceRoot":"","sources":["../../src/lib/functions_data.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;IACH,YAAqB,EAAU,EAAW,IAAkC;QAAvD,OAAE,GAAF,EAAE,CAAQ;QAAW,SAAI,GAAJ,IAAI,CAA8B;IAAG,CAAC;CACjF;AAjBD,sCAiBC"}

package/package.json

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