@flink-app/firebase-messaging-plugin 0.2.0-beta.15 → 0.2.0-beta.17

package/.flink/generatedHandlers.ts

@@ -1,4 +1,4 @@
-// Generated Thu Oct 28 2021 13:03:35 GMT+0200 (Central European Summer Time)
+// Generated Fri Apr 11 2025 16:45:17 GMT+0200 (Central European Summer Time)
 import { autoRegisteredHandlers, HttpMethod } from "@flink-app/flink";
 import * as PostMessage_0 from "../src/handlers/PostMessage";
 

package/.flink/generatedRepos.ts

@@ -1,4 +1,4 @@
-// Generated Thu Oct 28 2021 13:03:35 GMT+0200 (Central European Summer Time)
+// Generated Fri Apr 11 2025 16:45:16 GMT+0200 (Central European Summer Time)
   import { autoRegisteredRepos } from "@flink-app/flink";
   export const repos = [];
   autoRegisteredRepos.push(...repos);

package/.flink/schemas/schemas.ts

@@ -1,7 +1,7 @@
 import Message from "../../src/schemas/Message";
 import SendResult from "../../src/schemas/SendResult";
 
-// Generated Thu Oct 28 2021 13:03:36 GMT+0200 (Central European Summer Time)
+// Generated Fri Apr 11 2025 16:45:17 GMT+0200 (Central European Summer Time)
 export interface PostMessage_17_ReqSchema extends Message {}
 
 export interface PostMessage_17_ResSchema extends SendResult {}

package/.flink/start.ts

@@ -1,4 +1,4 @@
-// Generated Thu Oct 28 2021 13:03:35 GMT+0200 (Central European Summer Time)
+// Generated Fri Apr 11 2025 16:45:17 GMT+0200 (Central European Summer Time)
 import "./generatedHandlers";
 import "./generatedRepos";
 import "../src/index";

package/dist/.flink/generatedHandlers.js

@@ -20,7 +20,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handlers = void 0;
-// Generated Thu Oct 28 2021 13:03:35 GMT+0200 (Central European Summer Time)
+// Generated Fri Apr 11 2025 16:45:17 GMT+0200 (Central European Summer Time)
 var flink_1 = require("@flink-app/flink");
 var PostMessage_0 = __importStar(require("../src/handlers/PostMessage"));
 exports.handlers = [{ handler: PostMessage_0, assumedHttpMethod: flink_1.HttpMethod.post }];

package/dist/.flink/generatedJobs.d.ts

@@ -0,0 +1 @@
+export declare const jobs: never[];

package/dist/.flink/generatedJobs.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jobs = void 0;
+// Generated Sat Mar 29 2025 08:03:21 GMT+0100 (Central European Standard Time)
+var flink_1 = require("@flink-app/flink");
+exports.jobs = [];
+flink_1.autoRegisteredJobs.push.apply(flink_1.autoRegisteredJobs, exports.jobs);

package/dist/.flink/generatedRepos.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.repos = void 0;
-// Generated Thu Oct 28 2021 13:03:35 GMT+0200 (Central European Summer Time)
+// Generated Fri Apr 11 2025 16:45:16 GMT+0200 (Central European Summer Time)
 var flink_1 = require("@flink-app/flink");
 exports.repos = [];
 flink_1.autoRegisteredRepos.push.apply(flink_1.autoRegisteredRepos, exports.repos);

package/dist/.flink/start.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// Generated Thu Oct 28 2021 13:03:35 GMT+0200 (Central European Summer Time)
+// Generated Fri Apr 11 2025 16:45:17 GMT+0200 (Central European Summer Time)
 require("./generatedHandlers");
 require("./generatedRepos");
 require("../src/index");

package/dist/src/ManagementModule.d.ts

@@ -0,0 +1,3 @@
+import { ManagementApiModule } from "@flink-app/management-api-plugin";
+import { GetManagementModuleConfig } from "./schemas/ManagementModule";
+export declare const GetManagementModule: (config: GetManagementModuleConfig) => ManagementApiModule;

package/dist/src/ManagementModule.js

@@ -0,0 +1,71 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetManagementModule = void 0;
+var flink_1 = require("@flink-app/flink");
+var management_api_plugin_1 = require("@flink-app/management-api-plugin");
+var getManagementPluginHandler = __importStar(require("./managementHandlers/Get"));
+var postMessageHandler = __importStar(require("./managementHandlers/PostMessage"));
+var GetManagementModule = function (config) {
+    var _a;
+    if (config.pluginId == null)
+        config.pluginId = "managementNotificationsApi";
+    var endpoints = [];
+    endpoints.push({
+        routeProps: {
+            path: "",
+            method: flink_1.HttpMethod.get,
+            origin: config.pluginId,
+        },
+        handler: getManagementPluginHandler,
+    });
+    endpoints.push({
+        routeProps: {
+            path: "/message",
+            method: flink_1.HttpMethod.post,
+            origin: config.pluginId,
+        },
+        handler: postMessageHandler,
+    });
+    var features = [];
+    var module = {
+        id: config.pluginId || "notifications",
+        uiSettings: {
+            title: ((_a = config.uiSettings) === null || _a === void 0 ? void 0 : _a.title) || "Notifications",
+            icon: "",
+            features: features,
+        },
+        ui: config.ui,
+        type: management_api_plugin_1.ManagementApiType.notification,
+        endpoints: endpoints,
+        data: {
+            segments: config.segments,
+            data: config.data,
+            callback: config.messageSentCallback,
+        },
+    };
+    return module;
+};
+exports.GetManagementModule = GetManagementModule;

package/dist/src/managementHandlers/Get.d.ts

@@ -0,0 +1,4 @@
+import { FlinkContext, Handler } from "@flink-app/flink";
+import { ManagementGetRequest, ManagementGetResponse } from "../schemas/ManagementGet";
+declare const getManagementPluginHandler: Handler<FlinkContext, ManagementGetRequest, ManagementGetResponse>;
+export default getManagementPluginHandler;

package/dist/src/managementHandlers/Get.js

@@ -0,0 +1,64 @@
+"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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var getManagementPluginHandler = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+    var modules, module, segments, messageingData, data;
+    var _c, _d;
+    var ctx = _b.ctx, req = _b.req, origin = _b.origin;
+    return __generator(this, function (_e) {
+        modules = ctx.plugins.managementApi.moduleList.modules;
+        module = modules.find(function (p) { return p.id == origin; });
+        segments = (_c = module.data) === null || _c === void 0 ? void 0 : _c.segments;
+        messageingData = ((_d = module.data) === null || _d === void 0 ? void 0 : _d.data) || [];
+        data = {
+            segments: segments.map(function (s) {
+                var sv = {
+                    id: s.id,
+                    description: s.description,
+                };
+                return sv;
+            }),
+            data: messageingData,
+        };
+        return [2 /*return*/, {
+                data: data,
+                status: 200,
+            }];
+    });
+}); };
+exports.default = getManagementPluginHandler;

package/dist/src/managementHandlers/PostMessage.d.ts

@@ -0,0 +1,4 @@
+import { FlinkContext, Handler } from "@flink-app/flink";
+import { ManagementPostMessageRequest, ManagementPostMessageResponse } from "../schemas/ManagementPostMessage";
+declare const postMessageHandler: Handler<FlinkContext, ManagementPostMessageRequest, ManagementPostMessageResponse>;
+export default postMessageHandler;

package/dist/src/managementHandlers/PostMessage.js

@@ -0,0 +1,81 @@
+"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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var postMessageHandler = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+    var modules, module, segment, targets, tokens, message, callback;
+    var _c, _d, _e;
+    var ctx = _b.ctx, req = _b.req, origin = _b.origin;
+    return __generator(this, function (_f) {
+        switch (_f.label) {
+            case 0:
+                modules = ctx.plugins.managementApi.moduleList.modules;
+                module = modules.find(function (p) { return p.id == origin; });
+                segment = (_d = (_c = module === null || module === void 0 ? void 0 : module.data) === null || _c === void 0 ? void 0 : _c.segments) === null || _d === void 0 ? void 0 : _d.find(function (p) { return p.id === req.body.segment; });
+                if (!segment) {
+                    return [2 /*return*/, {
+                            data: { message: "Segment not found" },
+                            status: 500,
+                        }];
+                }
+                return [4 /*yield*/, segment.handler(ctx)];
+            case 1:
+                targets = _f.sent();
+                tokens = targets.map(function (t) { return t.pushToken; }).flat();
+                message = {
+                    to: tokens,
+                    notification: {
+                        title: req.body.subject,
+                        body: req.body.body,
+                    },
+                    data: req.body.data,
+                };
+                return [4 /*yield*/, ctx.plugins["firebaseMessaging"].send(message)];
+            case 2:
+                _f.sent();
+                callback = (_e = module === null || module === void 0 ? void 0 : module.data) === null || _e === void 0 ? void 0 : _e.callback;
+                if (callback) {
+                    callback(ctx, targets, message);
+                }
+                return [2 /*return*/, {
+                        data: {},
+                        status: 200,
+                    }];
+        }
+    });
+}); };
+exports.default = postMessageHandler;

package/dist/src/schemas/ManagementGet.d.ts

@@ -0,0 +1,7 @@
+import { MessagingData, MessagingSegmentView } from "./ManagementModule";
+export interface ManagementGetRequest {
+}
+export interface ManagementGetResponse {
+    segments: MessagingSegmentView[];
+    data: MessagingData[];
+}

package/dist/src/schemas/ManagementGet.js

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

package/dist/src/schemas/ManagementModule.d.ts

@@ -0,0 +1,28 @@
+import { FlinkContext } from "@flink-app/flink";
+import Message from "./Message";
+export interface MessagingSegment {
+    id: string;
+    description: string;
+    handler(ctx: FlinkContext<any>): Promise<MessagingTarget[]>;
+}
+export interface MessagingSegmentView extends Omit<MessagingSegment, "handler"> {
+}
+export interface MessagingTarget {
+    userId: string;
+    pushToken: string[];
+}
+export interface MessagingData {
+    id: string;
+    description: string;
+    options?: string[];
+}
+export interface GetManagementModuleConfig {
+    pluginId?: string;
+    ui: boolean;
+    uiSettings?: {
+        title: string;
+    };
+    segments: MessagingSegment[];
+    data?: MessagingData[];
+    messageSentCallback?: (ctx: any, target: MessagingTarget[], message: Message) => void;
+}

package/dist/src/schemas/ManagementModule.js

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

package/dist/src/schemas/ManagementPostMessage.d.ts

@@ -0,0 +1,10 @@
+export interface ManagementPostMessageRequest {
+    segment: string;
+    subject: string;
+    body: string;
+    data: {
+        [key: string]: string;
+    };
+}
+export interface ManagementPostMessageResponse {
+}

package/dist/src/schemas/ManagementPostMessage.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/firebase-messaging-plugin",
-  "version": "0.2.0-beta.15",
+  "version": "0.2.0-beta.17",
   "description": "Flink plugin to send Firebase cloud messages",
   "scripts": {
     "test": "echo \"Error: no test specified\"",
@@ -19,7 +19,7 @@
     "fcm-push": "^1.1.3"
   },
   "devDependencies": {
-    "@flink-app/flink": "^0.2.0-beta.15",
+    "@flink-app/flink": "^0.2.0-beta.17",
     "@types/express": "^4.17.12",
     "@types/node": "^15.6.2",
     "nodemon": "^2.0.7",
@@ -27,5 +27,5 @@
     "tsc-watch": "^4.2.9",
     "typescript": "^4.2.4"
   },
-  "gitHead": "798ef9a11c291c0b16ed937436dd46986942546c"
+  "gitHead": "76e4647bd059afadeb0070e9392c61e01a494de9"
 }

package/dist/.flink/schemas.json

@@ -1,57 +0,0 @@
-{
-    "Message": {
-        "type": "object",
-        "properties": {
-            "to": {
-                "description": "Devices to send to",
-                "type": "array",
-                "items": {
-                    "type": "string"
-                }
-            },
-            "notification": {
-                "description": "Use `notification` if sending a standard push notification\nhttps://firebase.google.com/docs/cloud-messaging/concept-options#notifications",
-                "type": "object",
-                "properties": {
-                    "title": {
-                        "description": "Optional push notification title",
-                        "type": "string"
-                    },
-                    "body": {
-                        "description": "Optional body",
-                        "type": "string"
-                    }
-                },
-                "additionalProperties": false
-            },
-            "data": {
-                "description": "Use `data` to send data messages.\nhttps://firebase.google.com/docs/cloud-messaging/concept-options#data_messages",
-                "type": "object",
-                "additionalProperties": {
-                    "type": "string"
-                }
-            }
-        },
-        "additionalProperties": false,
-        "required": [
-            "data",
-            "to"
-        ]
-    },
-    "SendResult": {
-        "type": "object",
-        "properties": {
-            "failedDevices": {
-                "description": "Devices to which delivery failed",
-                "type": "array",
-                "items": {
-                    "type": "string"
-                }
-            }
-        },
-        "additionalProperties": false,
-        "required": [
-            "failedDevices"
-        ]
-    }
-}