@flink-app/apn-plugin 0.11.11

package/.flink/generatedHandlers.ts

@@ -0,0 +1,5 @@
+// Generated Thu Feb 13 2025 14:49:54 GMT+0100 (Central European Standard Time)
+import { autoRegisteredHandlers, HttpMethod } from "@flink-app/flink";
+export const handlers = [];
+autoRegisteredHandlers.push(...handlers);
+    

package/.flink/generatedJobs.ts

@@ -0,0 +1,5 @@
+// Generated Thu Feb 13 2025 14:49:54 GMT+0100 (Central European Standard Time)
+import { autoRegisteredJobs } from "@flink-app/flink";
+export const jobs = [];
+autoRegisteredJobs.push(...jobs);
+    

package/.flink/generatedRepos.ts

@@ -0,0 +1,5 @@
+// Generated Thu Feb 13 2025 14:49:54 GMT+0100 (Central European Standard Time)
+  import { autoRegisteredRepos } from "@flink-app/flink";
+  export const repos = [];
+  autoRegisteredRepos.push(...repos);
+      

package/.flink/schemas/schemas.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/Schemas",
+  "definitions": {}
+}

package/.flink/schemas/schemas.ts

@@ -0,0 +1 @@
+// Generated Thu Feb 13 2025 14:49:54 GMT+0100 (Central European Standard Time)

package/.flink/start.ts

@@ -0,0 +1,5 @@
+// Generated Thu Feb 13 2025 14:49:54 GMT+0100 (Central European Standard Time)
+import "./generatedHandlers";
+import "./generatedRepos";
+import "./generatedJobs";
+import "../src/index";

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Frost Experience AB https://www.frost.se
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/dist/.flink/generatedHandlers.d.ts

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

package/dist/.flink/generatedHandlers.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handlers = void 0;
+// Generated Thu Feb 13 2025 14:49:54 GMT+0100 (Central European Standard Time)
+var flink_1 = require("@flink-app/flink");
+exports.handlers = [];
+flink_1.autoRegisteredHandlers.push.apply(flink_1.autoRegisteredHandlers, exports.handlers);

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 Thu Feb 13 2025 14:49:54 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.d.ts

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

package/dist/.flink/generatedRepos.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.repos = void 0;
+// Generated Thu Feb 13 2025 14:49:54 GMT+0100 (Central European Standard Time)
+var flink_1 = require("@flink-app/flink");
+exports.repos = [];
+flink_1.autoRegisteredRepos.push.apply(flink_1.autoRegisteredRepos, exports.repos);

package/dist/.flink/schemas/schemas.js

@@ -0,0 +1,2 @@
+"use strict";
+// Generated Thu Feb 13 2025 14:49:54 GMT+0100 (Central European Standard Time)

package/dist/.flink/schemas/schemas.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/Schemas",
+    "definitions": {}
+}

package/dist/.flink/start.d.ts

@@ -0,0 +1,4 @@
+import "./generatedHandlers";
+import "./generatedRepos";
+import "./generatedJobs";
+import "../src/index";

package/dist/.flink/start.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Generated Thu Feb 13 2025 14:49:54 GMT+0100 (Central European Standard Time)
+require("./generatedHandlers");
+require("./generatedRepos");
+require("./generatedJobs");
+require("../src/index");

package/dist/src/ApnPluginContext.d.ts

@@ -0,0 +1,6 @@
+import ApnMessage from "./schemas/ApnMessage";
+export interface ApnPluginContext {
+    apn: {
+        send: (message: ApnMessage) => void;
+    };
+}

package/dist/src/ApnPluginContext.js

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

package/dist/src/apnPlugin.d.ts

@@ -0,0 +1,29 @@
+import { FlinkPlugin } from "@flink-app/flink";
+export declare type ApnPluginOptions = {
+    certificate: {
+        /**
+         * Base64 encoded string for your APNs certificate (in PEM format).
+         */
+        cert: string;
+        /**
+         * Base64 encoded string for your APNs private key (in PEM format).
+         */
+        key: string;
+        /**
+         * Optional passphrase for the private key, if needed.
+         */
+        passphrase?: string;
+    };
+    production: boolean;
+    /**
+     * Default topic for your APNs notifications.
+     * For VoIP pushes this is typically your app's bundle id with a `.voip` suffix,
+     * e.g. "com.example.myapp.voip".
+     */
+    topic: string;
+    /**
+     * Default priority for your APNs notifications.
+     */
+    defaultPriority?: number;
+};
+export declare const apnPlugin: (options: ApnPluginOptions) => FlinkPlugin;

package/dist/src/apnPlugin.js

@@ -0,0 +1,114 @@
+"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 (_) 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 };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apnPlugin = void 0;
+var node_apn_1 = __importDefault(require("@parse/node-apn"));
+var apnPlugin = function (options) {
+    // Decode the base64 encoded certificate and key.
+    var decodedCert = Buffer.from(options.certificate.cert, "base64").toString("utf8");
+    var decodedKey = Buffer.from(options.certificate.key, "base64").toString("utf8");
+    // Initialize the APNs provider using certificate-based authentication.
+    var provider = new node_apn_1.default.Provider({
+        cert: decodedCert,
+        key: decodedKey,
+        passphrase: options.certificate.passphrase,
+        production: options.production,
+    });
+    return {
+        id: "apn",
+        ctx: {
+            /**
+             * Sends a VoIP push notification.
+             * @param message - The message to be sent. Expected to include:
+             *  - `to`: an array of device tokens,
+             *  - `alert`: (optional) text to display,
+             *  - `payload`: (optional) any extra data,
+             *  - `topic`: (optional) override the default APNs topic.
+             */
+            send: function (message) { return __awaiter(void 0, void 0, void 0, function () {
+                var notification, result, err_1;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            if (!message.to || message.to.length === 0) {
+                                throw new Error("No device tokens provided in message.to");
+                            }
+                            notification = new node_apn_1.default.Notification();
+                            notification.pushType = message.pushType || "alert";
+                            // Set the priority to the default or the provided value.
+                            notification.priority = message.priority || options.defaultPriority || 10;
+                            // Use the topic provided in the message or fall back to the plugin's default.
+                            notification.topic = message.topic || options.topic;
+                            if (!notification.topic) {
+                                throw new Error("APNs topic must be provided either in the message or in plugin options");
+                            }
+                            // Set any provided alert and payload properties.
+                            if (message.alert) {
+                                notification.alert = message.alert;
+                            }
+                            if (message.payload) {
+                                notification.payload = message.payload;
+                            }
+                            _a.label = 1;
+                        case 1:
+                            _a.trys.push([1, 3, , 4]);
+                            return [4 /*yield*/, provider.send(notification, message.to)];
+                        case 2:
+                            result = _a.sent();
+                            console.log("APNs push result:", result);
+                            return [2 /*return*/, result];
+                        case 3:
+                            err_1 = _a.sent();
+                            console.error("Error sending APNs push:", err_1);
+                            throw err_1;
+                        case 4: return [2 /*return*/];
+                    }
+                });
+            }); },
+        },
+        init: function (app) { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/];
+            });
+        }); },
+    };
+};
+exports.apnPlugin = apnPlugin;

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./apnPlugin";
+export * from "./ApnPluginContext";

package/dist/src/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./apnPlugin"), exports);
+__exportStar(require("./ApnPluginContext"), exports);

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

@@ -0,0 +1,14 @@
+import { NotificationPushType } from "@parse/node-apn";
+export default interface ApnMessage {
+    /**
+     * Devices to send to
+     */
+    to: string[];
+    alert?: string;
+    payload: {
+        [x: string]: string;
+    };
+    topic?: string;
+    pushType?: NotificationPushType;
+    priority?: number;
+}

package/dist/src/schemas/ApnMessage.js

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

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

@@ -0,0 +1,13 @@
+import { NotificationPushType } from "@parse/node-apn";
+export default interface Message {
+    /**
+     * Devices to send to
+     */
+    to: string[];
+    alert?: string;
+    payload: {
+        [x: string]: string;
+    };
+    topic?: string;
+    pushType?: NotificationPushType;
+}

package/dist/src/schemas/Message.js

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

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

@@ -0,0 +1,6 @@
+export default interface SendResult {
+    /**
+     * Devices to which delivery failed
+     */
+    failedDevices: string[];
+}

package/dist/src/schemas/SendResult.js

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

package/nodemon.json

@@ -0,0 +1,7 @@
+{
+  "watch": ["src", "spec"],
+  "ext": "ts,json",
+  "watchOptions": {
+    "followSymlinks": false
+  }
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@flink-app/apn-plugin",
+    "version": "0.11.11",
+    "description": "Flink plugin to send push notifications to APN",
+    "scripts": {
+        "test": "echo \"Error: no test specified\"",
+        "build": "flink build",
+        "prepublish": "npm run build",
+        "watch": "nodemon --exec \"flink build\""
+    },
+    "author": "joel@frost.se",
+    "license": "MIT",
+    "types": "dist/src/index.d.ts",
+    "main": "dist/src/index.js",
+    "publishConfig": {
+        "access": "public"
+    },
+    "dependencies": {
+        "@parse/node-apn": "6.4.3"
+    },
+    "devDependencies": {
+        "@flink-app/flink": "^0.11.9",
+        "@types/node": "^15.6.2",
+        "nodemon": "^2.0.7",
+        "ts-node": "^9.1.1",
+        "typescript": "4.2.3"
+    },
+    "gitHead": "0eb9b8d88342ba6c868ba70eed1dddb818d1f6dc"
+}

package/readme.md

@@ -0,0 +1,52 @@
+# APN Plugin
+
+A FLINK plugin used for sending push notifications using APN (Apple Push Notification) service.
+
+## Usage
+
+Install plugin to your flink app project:
+
+```
+npm i -S @flink-app/apn-plugin
+```
+
+Add and configure plugin in your app startup:
+
+```typescript
+import { apnPlugin } from "@flink-app/apn-plugin";
+
+function start() {
+    new FlinkApp<AppContext>({
+        name: "My app",
+        plugins: [
+            apnPlugin({
+                token: {
+                    key: "./path/to/AuthKey_XXXXXXXXXX.p8", // Absolute or relative path to your .p8 file
+                    keyId: "XXXXXXXXXX", // Your APNs Auth Key ID
+                    teamId: "YYYYYYYYYY", // Your Apple Developer Team ID
+                },
+                production: false, // Set to true if you want to use the production APNs server
+            }),
+        ],
+    }).start();
+}
+```
+
+Add it to your app context (normally `Ctx.ts` in the root folder of your project)
+
+```
+import { ApnPluginContext } from "@flink-app/apn-plugin";
+
+export interface Ctx extends FlinkContext<ApnPluginContext> {
+  // your context here
+}
+
+```
+
+## Configuration
+
+-   `token` - APNs Auth Key configuration
+    -   `key` - Absolute or relative path to your .p8 file
+    -   `keyId` - Your APNs Auth Key ID
+    -   `teamId` - Your Apple Developer Team ID
+-   `production` - Set to true if you want to use the production APNs server

package/src/ApnPluginContext.ts

@@ -0,0 +1,7 @@
+import ApnMessage from "./schemas/ApnMessage";
+
+export interface ApnPluginContext {
+    apn: {
+        send: (message: ApnMessage) => void;
+    };
+}

package/src/apnPlugin.ts

@@ -0,0 +1,103 @@
+import { FlinkPlugin } from "@flink-app/flink";
+import apn from "@parse/node-apn";
+
+import ApnMessage from "./schemas/ApnMessage";
+
+export type ApnPluginOptions = {
+    certificate: {
+        /**
+         * Base64 encoded string for your APNs certificate (in PEM format).
+         */
+        cert: string;
+        /**
+         * Base64 encoded string for your APNs private key (in PEM format).
+         */
+        key: string;
+        /**
+         * Optional passphrase for the private key, if needed.
+         */
+        passphrase?: string;
+    };
+    production: boolean;
+    /**
+     * Default topic for your APNs notifications.
+     * For VoIP pushes this is typically your app's bundle id with a `.voip` suffix,
+     * e.g. "com.example.myapp.voip".
+     */
+    topic: string;
+    /**
+     * Default priority for your APNs notifications.
+     */
+    defaultPriority?: number;
+};
+
+export const apnPlugin = (options: ApnPluginOptions): FlinkPlugin => {
+    // Decode the base64 encoded certificate and key.
+    const decodedCert = Buffer.from(options.certificate.cert, "base64").toString("utf8");
+    const decodedKey = Buffer.from(options.certificate.key, "base64").toString("utf8");
+
+    // Initialize the APNs provider using certificate-based authentication.
+    const provider = new apn.Provider({
+        cert: decodedCert,
+        key: decodedKey,
+        passphrase: options.certificate.passphrase,
+        production: options.production,
+    });
+
+    return {
+        id: "apn",
+        ctx: {
+            /**
+             * Sends a VoIP push notification.
+             * @param message - The message to be sent. Expected to include:
+             *  - `to`: an array of device tokens,
+             *  - `alert`: (optional) text to display,
+             *  - `payload`: (optional) any extra data,
+             *  - `topic`: (optional) override the default APNs topic.
+             */
+            send: async (message: ApnMessage) => {
+                if (!message.to || message.to.length === 0) {
+                    throw new Error("No device tokens provided in message.to");
+                }
+
+                const notification = new apn.Notification();
+
+                notification.pushType = message.pushType || "alert";
+
+                // Set the priority to the default or the provided value.
+                notification.priority = message.priority || options.defaultPriority || 10;
+
+                // Use the topic provided in the message or fall back to the plugin's default.
+                notification.topic = message.topic || options.topic;
+                if (!notification.topic) {
+                    throw new Error("APNs topic must be provided either in the message or in plugin options");
+                }
+
+                // Set any provided alert and payload properties.
+                if (message.alert) {
+                    notification.alert = message.alert;
+                }
+                if (message.payload) {
+                    notification.payload = message.payload;
+                }
+
+                try {
+                    const result = await provider.send(notification, message.to);
+                    console.log("APNs push result:", result);
+                    return result;
+                } catch (err) {
+                    console.error("Error sending APNs push:", err);
+                    throw err;
+                }
+            },
+        },
+        init: async (app) => {
+            // Optionally, add a message handler to your framework.
+            // Adjust permissions or handler names as required by your app.
+            // Example:
+            // app.addHandler("PostMessage", {
+            //   permissions: [options.permissions?.send || "apn:send"],
+            // });
+        },
+    };
+};

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./apnPlugin";
+export * from "./ApnPluginContext";

package/src/schemas/ApnMessage.ts

@@ -0,0 +1,18 @@
+import { NotificationPushType } from "@parse/node-apn";
+
+export default interface ApnMessage {
+    /**
+     * Devices to send to
+     */
+    to: string[];
+
+    alert?: string;
+
+    payload: { [x: string]: string };
+
+    topic?: string;
+
+    pushType?: NotificationPushType;
+
+    priority?: number;
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["esnext", "es2016"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false,
+    "declaration": true,
+    "experimentalDecorators": true,
+    "checkJs": true,
+    "outDir": "dist"
+  },
+  "include": ["./src/**/*.ts", "./.flink/**/*"],
+  "exclude": ["./node_modules/*"]
+}