@openmdm/push-fcm 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present OpenMDM Contributors
+
+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/index.d.ts

@@ -0,0 +1,77 @@
+import * as admin from 'firebase-admin';
+import { DatabaseAdapter, PushAdapter } from '@openmdm/core';
+
+/**
+ * OpenMDM FCM Push Adapter
+ *
+ * Firebase Cloud Messaging adapter for sending push notifications to Android devices.
+ *
+ * @example
+ * ```typescript
+ * import { createMDM } from '@openmdm/core';
+ * import { fcmPushAdapter } from '@openmdm/push-fcm';
+ *
+ * const mdm = createMDM({
+ *   database: drizzleAdapter(db),
+ *   push: fcmPushAdapter({
+ *     credential: admin.credential.cert(serviceAccount),
+ *     // or: credentialPath: './service-account.json',
+ *   }),
+ * });
+ * ```
+ */
+
+interface FCMAdapterOptions {
+    /**
+     * Firebase Admin credential object
+     * Use admin.credential.cert(serviceAccount) or admin.credential.applicationDefault()
+     */
+    credential?: admin.credential.Credential;
+    /**
+     * Path to service account JSON file
+     * Alternative to providing credential directly
+     */
+    credentialPath?: string;
+    /**
+     * Firebase project ID (optional, usually inferred from credential)
+     */
+    projectId?: string;
+    /**
+     * Database adapter for storing/retrieving push tokens
+     */
+    database?: DatabaseAdapter;
+    /**
+     * Whether to use data-only messages (default: true)
+     * Data-only messages wake the app even when in background
+     */
+    dataOnly?: boolean;
+    /**
+     * Default TTL for messages in seconds (default: 3600 = 1 hour)
+     */
+    defaultTtl?: number;
+    /**
+     * Android-specific notification options
+     */
+    android?: {
+        priority?: 'high' | 'normal';
+        restrictedPackageName?: string;
+        directBootOk?: boolean;
+    };
+}
+/**
+ * Create an FCM push adapter for OpenMDM
+ */
+declare function fcmPushAdapter(options: FCMAdapterOptions): PushAdapter;
+/**
+ * Create FCM adapter from environment variables
+ *
+ * Expects GOOGLE_APPLICATION_CREDENTIALS environment variable
+ * or FIREBASE_PROJECT_ID for application default credentials
+ */
+declare function fcmPushAdapterFromEnv(options?: Partial<FCMAdapterOptions>): PushAdapter;
+/**
+ * Create FCM adapter from service account JSON
+ */
+declare function fcmPushAdapterFromServiceAccount(serviceAccount: admin.ServiceAccount | string, options?: Partial<FCMAdapterOptions>): PushAdapter;
+
+export { type FCMAdapterOptions, fcmPushAdapter, fcmPushAdapterFromEnv, fcmPushAdapterFromServiceAccount };

package/dist/index.js

@@ -0,0 +1,254 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// src/index.ts
+import * as admin from "firebase-admin";
+function fcmPushAdapter(options) {
+  let app2;
+  try {
+    app2 = admin.app("[openmdm]");
+  } catch {
+    const initOptions = {};
+    if (options.credential) {
+      initOptions.credential = options.credential;
+    } else if (options.credentialPath) {
+      const serviceAccount = __require(options.credentialPath);
+      initOptions.credential = admin.credential.cert(serviceAccount);
+    } else {
+      initOptions.credential = admin.credential.applicationDefault();
+    }
+    if (options.projectId) {
+      initOptions.projectId = options.projectId;
+    }
+    app2 = admin.initializeApp(initOptions, "[openmdm]");
+  }
+  const messaging = app2.messaging();
+  const database = options.database;
+  const dataOnly = options.dataOnly ?? true;
+  const defaultTtl = options.defaultTtl ?? 3600;
+  const tokenCache = /* @__PURE__ */ new Map();
+  async function getToken(deviceId) {
+    if (tokenCache.has(deviceId)) {
+      return tokenCache.get(deviceId);
+    }
+    if (database) {
+      const pushToken = await database.findPushToken(deviceId, "fcm");
+      if (pushToken?.token) {
+        tokenCache.set(deviceId, pushToken.token);
+        return pushToken.token;
+      }
+    }
+    return null;
+  }
+  function buildMessage(token, message) {
+    const fcmMessage = {
+      token,
+      android: {
+        priority: message.priority === "high" ? "high" : "normal",
+        ttl: (message.ttl ?? defaultTtl) * 1e3,
+        // Convert to milliseconds
+        restrictedPackageName: options.android?.restrictedPackageName,
+        directBootOk: options.android?.directBootOk
+      }
+    };
+    if (dataOnly) {
+      fcmMessage.data = {
+        type: message.type,
+        payload: message.payload ? JSON.stringify(message.payload) : "{}",
+        timestamp: (/* @__PURE__ */ new Date()).toISOString()
+      };
+      if (message.collapseKey) {
+        fcmMessage.android.collapseKey = message.collapseKey;
+      }
+    } else {
+      fcmMessage.notification = {
+        title: "MDM Command",
+        body: message.type
+      };
+      fcmMessage.data = {
+        type: message.type,
+        payload: message.payload ? JSON.stringify(message.payload) : "{}"
+      };
+    }
+    return fcmMessage;
+  }
+  return {
+    async send(deviceId, message) {
+      try {
+        const token = await getToken(deviceId);
+        if (!token) {
+          console.warn(`[OpenMDM FCM] No token found for device ${deviceId}`);
+          return {
+            success: false,
+            error: "No FCM token registered for device"
+          };
+        }
+        const fcmMessage = buildMessage(token, message);
+        const messageId = await messaging.send(fcmMessage);
+        console.log(
+          `[OpenMDM FCM] Sent to ${deviceId}: ${message.type} (${messageId})`
+        );
+        return {
+          success: true,
+          messageId
+        };
+      } catch (error) {
+        console.error(`[OpenMDM FCM] Error sending to ${deviceId}:`, error);
+        if (error.code === "messaging/invalid-registration-token" || error.code === "messaging/registration-token-not-registered") {
+          tokenCache.delete(deviceId);
+          if (database) {
+            await database.deletePushToken(deviceId, "fcm");
+          }
+        }
+        return {
+          success: false,
+          error: error.message || "FCM send failed"
+        };
+      }
+    },
+    async sendBatch(deviceIds, message) {
+      const results = [];
+      let successCount = 0;
+      let failureCount = 0;
+      const tokensMap = /* @__PURE__ */ new Map();
+      for (const deviceId of deviceIds) {
+        const token = await getToken(deviceId);
+        if (token) {
+          tokensMap.set(deviceId, token);
+        } else {
+          results.push({
+            deviceId,
+            result: {
+              success: false,
+              error: "No FCM token registered"
+            }
+          });
+          failureCount++;
+        }
+      }
+      if (tokensMap.size === 0) {
+        return { successCount, failureCount, results };
+      }
+      const messages = [];
+      const deviceIdOrder = [];
+      for (const [deviceId, token] of tokensMap) {
+        messages.push(buildMessage(token, message));
+        deviceIdOrder.push(deviceId);
+      }
+      try {
+        const batchSize = 500;
+        for (let i = 0; i < messages.length; i += batchSize) {
+          const batch = messages.slice(i, i + batchSize);
+          const batchDeviceIds = deviceIdOrder.slice(i, i + batchSize);
+          const response = await messaging.sendEach(batch);
+          response.responses.forEach((resp, index) => {
+            const deviceId = batchDeviceIds[index];
+            if (resp.success) {
+              results.push({
+                deviceId,
+                result: {
+                  success: true,
+                  messageId: resp.messageId
+                }
+              });
+              successCount++;
+            } else {
+              const error = resp.error;
+              if (error?.code === "messaging/invalid-registration-token" || error?.code === "messaging/registration-token-not-registered") {
+                tokenCache.delete(deviceId);
+                if (database) {
+                  database.deletePushToken(deviceId, "fcm").catch(() => {
+                  });
+                }
+              }
+              results.push({
+                deviceId,
+                result: {
+                  success: false,
+                  error: error?.message || "FCM send failed"
+                }
+              });
+              failureCount++;
+            }
+          });
+        }
+        console.log(
+          `[OpenMDM FCM] Batch sent: ${successCount} success, ${failureCount} failed`
+        );
+      } catch (error) {
+        console.error("[OpenMDM FCM] Batch send error:", error);
+        for (const deviceId of deviceIdOrder) {
+          if (!results.find((r) => r.deviceId === deviceId)) {
+            results.push({
+              deviceId,
+              result: {
+                success: false,
+                error: error.message || "FCM batch send failed"
+              }
+            });
+            failureCount++;
+          }
+        }
+      }
+      return { successCount, failureCount, results };
+    },
+    async registerToken(deviceId, token) {
+      tokenCache.set(deviceId, token);
+      if (database) {
+        await database.upsertPushToken({
+          deviceId,
+          provider: "fcm",
+          token
+        });
+      }
+      console.log(`[OpenMDM FCM] Registered token for device ${deviceId}`);
+    },
+    async unregisterToken(deviceId) {
+      tokenCache.delete(deviceId);
+      if (database) {
+        await database.deletePushToken(deviceId, "fcm");
+      }
+      console.log(`[OpenMDM FCM] Unregistered token for device ${deviceId}`);
+    },
+    async subscribe(deviceId, topic) {
+      const token = await getToken(deviceId);
+      if (!token) {
+        throw new Error(`No FCM token for device ${deviceId}`);
+      }
+      await messaging.subscribeToTopic(token, topic);
+      console.log(`[OpenMDM FCM] Subscribed ${deviceId} to topic ${topic}`);
+    },
+    async unsubscribe(deviceId, topic) {
+      const token = await getToken(deviceId);
+      if (!token) {
+        return;
+      }
+      await messaging.unsubscribeFromTopic(token, topic);
+      console.log(`[OpenMDM FCM] Unsubscribed ${deviceId} from topic ${topic}`);
+    }
+  };
+}
+function fcmPushAdapterFromEnv(options) {
+  return fcmPushAdapter({
+    ...options,
+    credential: admin.credential.applicationDefault(),
+    projectId: process.env.FIREBASE_PROJECT_ID
+  });
+}
+function fcmPushAdapterFromServiceAccount(serviceAccount, options) {
+  const credential2 = typeof serviceAccount === "string" ? admin.credential.cert(JSON.parse(serviceAccount)) : admin.credential.cert(serviceAccount);
+  return fcmPushAdapter({
+    ...options,
+    credential: credential2
+  });
+}
+export {
+  fcmPushAdapter,
+  fcmPushAdapterFromEnv,
+  fcmPushAdapterFromServiceAccount
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * OpenMDM FCM Push Adapter\n *\n * Firebase Cloud Messaging adapter for sending push notifications to Android devices.\n *\n * @example\n * ```typescript\n * import { createMDM } from '@openmdm/core';\n * import { fcmPushAdapter } from '@openmdm/push-fcm';\n *\n * const mdm = createMDM({\n *   database: drizzleAdapter(db),\n *   push: fcmPushAdapter({\n *     credential: admin.credential.cert(serviceAccount),\n *     // or: credentialPath: './service-account.json',\n *   }),\n * });\n * ```\n */\n\nimport * as admin from 'firebase-admin';\nimport type {\n  PushAdapter,\n  PushMessage,\n  PushResult,\n  PushBatchResult,\n  DatabaseAdapter,\n} from '@openmdm/core';\n\nexport interface FCMAdapterOptions {\n  /**\n   * Firebase Admin credential object\n   * Use admin.credential.cert(serviceAccount) or admin.credential.applicationDefault()\n   */\n  credential?: admin.credential.Credential;\n\n  /**\n   * Path to service account JSON file\n   * Alternative to providing credential directly\n   */\n  credentialPath?: string;\n\n  /**\n   * Firebase project ID (optional, usually inferred from credential)\n   */\n  projectId?: string;\n\n  /**\n   * Database adapter for storing/retrieving push tokens\n   */\n  database?: DatabaseAdapter;\n\n  /**\n   * Whether to use data-only messages (default: true)\n   * Data-only messages wake the app even when in background\n   */\n  dataOnly?: boolean;\n\n  /**\n   * Default TTL for messages in seconds (default: 3600 = 1 hour)\n   */\n  defaultTtl?: number;\n\n  /**\n   * Android-specific notification options\n   */\n  android?: {\n    priority?: 'high' | 'normal';\n    restrictedPackageName?: string;\n    directBootOk?: boolean;\n  };\n}\n\n/**\n * Create an FCM push adapter for OpenMDM\n */\nexport function fcmPushAdapter(options: FCMAdapterOptions): PushAdapter {\n  // Initialize Firebase Admin if not already initialized\n  let app: admin.app.App;\n\n  try {\n    app = admin.app('[openmdm]');\n  } catch {\n    // App doesn't exist, create it\n    const initOptions: admin.AppOptions = {};\n\n    if (options.credential) {\n      initOptions.credential = options.credential;\n    } else if (options.credentialPath) {\n      // eslint-disable-next-line @typescript-eslint/no-require-imports\n      const serviceAccount = require(options.credentialPath);\n      initOptions.credential = admin.credential.cert(serviceAccount);\n    } else {\n      // Use application default credentials\n      initOptions.credential = admin.credential.applicationDefault();\n    }\n\n    if (options.projectId) {\n      initOptions.projectId = options.projectId;\n    }\n\n    app = admin.initializeApp(initOptions, '[openmdm]');\n  }\n\n  const messaging = app.messaging();\n  const database = options.database;\n  const dataOnly = options.dataOnly ?? true;\n  const defaultTtl = options.defaultTtl ?? 3600;\n\n  // Token cache: deviceId -> FCM token\n  const tokenCache = new Map<string, string>();\n\n  /**\n   * Get FCM token for a device\n   */\n  async function getToken(deviceId: string): Promise<string | null> {\n    // Check cache first\n    if (tokenCache.has(deviceId)) {\n      return tokenCache.get(deviceId)!;\n    }\n\n    // Get from database if available\n    if (database) {\n      const pushToken = await database.findPushToken(deviceId, 'fcm');\n      if (pushToken?.token) {\n        tokenCache.set(deviceId, pushToken.token);\n        return pushToken.token;\n      }\n    }\n\n    return null;\n  }\n\n  /**\n   * Build FCM message from OpenMDM push message\n   */\n  function buildMessage(\n    token: string,\n    message: PushMessage\n  ): admin.messaging.Message {\n    const fcmMessage: admin.messaging.Message = {\n      token,\n      android: {\n        priority: message.priority === 'high' ? 'high' : 'normal',\n        ttl: (message.ttl ?? defaultTtl) * 1000, // Convert to milliseconds\n        restrictedPackageName: options.android?.restrictedPackageName,\n        directBootOk: options.android?.directBootOk,\n      },\n    };\n\n    if (dataOnly) {\n      // Data-only message - always wakes the app\n      fcmMessage.data = {\n        type: message.type,\n        payload: message.payload ? JSON.stringify(message.payload) : '{}',\n        timestamp: new Date().toISOString(),\n      };\n\n      if (message.collapseKey) {\n        fcmMessage.android!.collapseKey = message.collapseKey;\n      }\n    } else {\n      // Notification + data message\n      fcmMessage.notification = {\n        title: 'MDM Command',\n        body: message.type,\n      };\n      fcmMessage.data = {\n        type: message.type,\n        payload: message.payload ? JSON.stringify(message.payload) : '{}',\n      };\n    }\n\n    return fcmMessage;\n  }\n\n  return {\n    async send(deviceId: string, message: PushMessage): Promise<PushResult> {\n      try {\n        const token = await getToken(deviceId);\n        if (!token) {\n          console.warn(`[OpenMDM FCM] No token found for device ${deviceId}`);\n          return {\n            success: false,\n            error: 'No FCM token registered for device',\n          };\n        }\n\n        const fcmMessage = buildMessage(token, message);\n        const messageId = await messaging.send(fcmMessage);\n\n        console.log(\n          `[OpenMDM FCM] Sent to ${deviceId}: ${message.type} (${messageId})`\n        );\n\n        return {\n          success: true,\n          messageId,\n        };\n      } catch (error: any) {\n        console.error(`[OpenMDM FCM] Error sending to ${deviceId}:`, error);\n\n        // Handle invalid token\n        if (\n          error.code === 'messaging/invalid-registration-token' ||\n          error.code === 'messaging/registration-token-not-registered'\n        ) {\n          // Remove invalid token from cache and database\n          tokenCache.delete(deviceId);\n          if (database) {\n            await database.deletePushToken(deviceId, 'fcm');\n          }\n        }\n\n        return {\n          success: false,\n          error: error.message || 'FCM send failed',\n        };\n      }\n    },\n\n    async sendBatch(\n      deviceIds: string[],\n      message: PushMessage\n    ): Promise<PushBatchResult> {\n      const results: Array<{ deviceId: string; result: PushResult }> = [];\n      let successCount = 0;\n      let failureCount = 0;\n\n      // Get tokens for all devices\n      const tokensMap = new Map<string, string>();\n      for (const deviceId of deviceIds) {\n        const token = await getToken(deviceId);\n        if (token) {\n          tokensMap.set(deviceId, token);\n        } else {\n          results.push({\n            deviceId,\n            result: {\n              success: false,\n              error: 'No FCM token registered',\n            },\n          });\n          failureCount++;\n        }\n      }\n\n      if (tokensMap.size === 0) {\n        return { successCount, failureCount, results };\n      }\n\n      // Build messages for batch send\n      const messages: admin.messaging.Message[] = [];\n      const deviceIdOrder: string[] = [];\n\n      for (const [deviceId, token] of tokensMap) {\n        messages.push(buildMessage(token, message));\n        deviceIdOrder.push(deviceId);\n      }\n\n      try {\n        // Send batch (max 500 messages per call)\n        const batchSize = 500;\n        for (let i = 0; i < messages.length; i += batchSize) {\n          const batch = messages.slice(i, i + batchSize);\n          const batchDeviceIds = deviceIdOrder.slice(i, i + batchSize);\n\n          const response = await messaging.sendEach(batch);\n\n          response.responses.forEach((resp, index) => {\n            const deviceId = batchDeviceIds[index];\n\n            if (resp.success) {\n              results.push({\n                deviceId,\n                result: {\n                  success: true,\n                  messageId: resp.messageId,\n                },\n              });\n              successCount++;\n            } else {\n              const error = resp.error;\n\n              // Handle invalid token\n              if (\n                error?.code === 'messaging/invalid-registration-token' ||\n                error?.code === 'messaging/registration-token-not-registered'\n              ) {\n                tokenCache.delete(deviceId);\n                if (database) {\n                  database.deletePushToken(deviceId, 'fcm').catch(() => {});\n                }\n              }\n\n              results.push({\n                deviceId,\n                result: {\n                  success: false,\n                  error: error?.message || 'FCM send failed',\n                },\n              });\n              failureCount++;\n            }\n          });\n        }\n\n        console.log(\n          `[OpenMDM FCM] Batch sent: ${successCount} success, ${failureCount} failed`\n        );\n      } catch (error: any) {\n        console.error('[OpenMDM FCM] Batch send error:', error);\n\n        // Mark all remaining as failed\n        for (const deviceId of deviceIdOrder) {\n          if (!results.find((r) => r.deviceId === deviceId)) {\n            results.push({\n              deviceId,\n              result: {\n                success: false,\n                error: error.message || 'FCM batch send failed',\n              },\n            });\n            failureCount++;\n          }\n        }\n      }\n\n      return { successCount, failureCount, results };\n    },\n\n    async registerToken(deviceId: string, token: string): Promise<void> {\n      // Update cache\n      tokenCache.set(deviceId, token);\n\n      // Store in database if available\n      if (database) {\n        await database.upsertPushToken({\n          deviceId,\n          provider: 'fcm',\n          token,\n        });\n      }\n\n      console.log(`[OpenMDM FCM] Registered token for device ${deviceId}`);\n    },\n\n    async unregisterToken(deviceId: string): Promise<void> {\n      // Remove from cache\n      tokenCache.delete(deviceId);\n\n      // Remove from database if available\n      if (database) {\n        await database.deletePushToken(deviceId, 'fcm');\n      }\n\n      console.log(`[OpenMDM FCM] Unregistered token for device ${deviceId}`);\n    },\n\n    async subscribe(deviceId: string, topic: string): Promise<void> {\n      const token = await getToken(deviceId);\n      if (!token) {\n        throw new Error(`No FCM token for device ${deviceId}`);\n      }\n\n      await messaging.subscribeToTopic(token, topic);\n      console.log(`[OpenMDM FCM] Subscribed ${deviceId} to topic ${topic}`);\n    },\n\n    async unsubscribe(deviceId: string, topic: string): Promise<void> {\n      const token = await getToken(deviceId);\n      if (!token) {\n        return; // Nothing to unsubscribe\n      }\n\n      await messaging.unsubscribeFromTopic(token, topic);\n      console.log(`[OpenMDM FCM] Unsubscribed ${deviceId} from topic ${topic}`);\n    },\n  };\n}\n\n/**\n * Create FCM adapter from environment variables\n *\n * Expects GOOGLE_APPLICATION_CREDENTIALS environment variable\n * or FIREBASE_PROJECT_ID for application default credentials\n */\nexport function fcmPushAdapterFromEnv(\n  options?: Partial<FCMAdapterOptions>\n): PushAdapter {\n  return fcmPushAdapter({\n    ...options,\n    credential: admin.credential.applicationDefault(),\n    projectId: process.env.FIREBASE_PROJECT_ID,\n  });\n}\n\n/**\n * Create FCM adapter from service account JSON\n */\nexport function fcmPushAdapterFromServiceAccount(\n  serviceAccount: admin.ServiceAccount | string,\n  options?: Partial<FCMAdapterOptions>\n): PushAdapter {\n  const credential =\n    typeof serviceAccount === 'string'\n      ? admin.credential.cert(JSON.parse(serviceAccount))\n      : admin.credential.cert(serviceAccount);\n\n  return fcmPushAdapter({\n    ...options,\n    credential,\n  });\n}\n"],"mappings":";;;;;;;;AAoBA,YAAY,WAAW;AAwDhB,SAAS,eAAe,SAAyC;AAEtE,MAAIA;AAEJ,MAAI;AACF,IAAAA,OAAY,UAAI,WAAW;AAAA,EAC7B,QAAQ;AAEN,UAAM,cAAgC,CAAC;AAEvC,QAAI,QAAQ,YAAY;AACtB,kBAAY,aAAa,QAAQ;AAAA,IACnC,WAAW,QAAQ,gBAAgB;AAEjC,YAAM,iBAAiB,UAAQ,QAAQ,cAAc;AACrD,kBAAY,aAAmB,iBAAW,KAAK,cAAc;AAAA,IAC/D,OAAO;AAEL,kBAAY,aAAmB,iBAAW,mBAAmB;AAAA,IAC/D;AAEA,QAAI,QAAQ,WAAW;AACrB,kBAAY,YAAY,QAAQ;AAAA,IAClC;AAEA,IAAAA,OAAY,oBAAc,aAAa,WAAW;AAAA,EACpD;AAEA,QAAM,YAAYA,KAAI,UAAU;AAChC,QAAM,WAAW,QAAQ;AACzB,QAAM,WAAW,QAAQ,YAAY;AACrC,QAAM,aAAa,QAAQ,cAAc;AAGzC,QAAM,aAAa,oBAAI,IAAoB;AAK3C,iBAAe,SAAS,UAA0C;AAEhE,QAAI,WAAW,IAAI,QAAQ,GAAG;AAC5B,aAAO,WAAW,IAAI,QAAQ;AAAA,IAChC;AAGA,QAAI,UAAU;AACZ,YAAM,YAAY,MAAM,SAAS,cAAc,UAAU,KAAK;AAC9D,UAAI,WAAW,OAAO;AACpB,mBAAW,IAAI,UAAU,UAAU,KAAK;AACxC,eAAO,UAAU;AAAA,MACnB;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAKA,WAAS,aACP,OACA,SACyB;AACzB,UAAM,aAAsC;AAAA,MAC1C;AAAA,MACA,SAAS;AAAA,QACP,UAAU,QAAQ,aAAa,SAAS,SAAS;AAAA,QACjD,MAAM,QAAQ,OAAO,cAAc;AAAA;AAAA,QACnC,uBAAuB,QAAQ,SAAS;AAAA,QACxC,cAAc,QAAQ,SAAS;AAAA,MACjC;AAAA,IACF;AAEA,QAAI,UAAU;AAEZ,iBAAW,OAAO;AAAA,QAChB,MAAM,QAAQ;AAAA,QACd,SAAS,QAAQ,UAAU,KAAK,UAAU,QAAQ,OAAO,IAAI;AAAA,QAC7D,YAAW,oBAAI,KAAK,GAAE,YAAY;AAAA,MACpC;AAEA,UAAI,QAAQ,aAAa;AACvB,mBAAW,QAAS,cAAc,QAAQ;AAAA,MAC5C;AAAA,IACF,OAAO;AAEL,iBAAW,eAAe;AAAA,QACxB,OAAO;AAAA,QACP,MAAM,QAAQ;AAAA,MAChB;AACA,iBAAW,OAAO;AAAA,QAChB,MAAM,QAAQ;AAAA,QACd,SAAS,QAAQ,UAAU,KAAK,UAAU,QAAQ,OAAO,IAAI;AAAA,MAC/D;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL,MAAM,KAAK,UAAkB,SAA2C;AACtE,UAAI;AACF,cAAM,QAAQ,MAAM,SAAS,QAAQ;AACrC,YAAI,CAAC,OAAO;AACV,kBAAQ,KAAK,2CAA2C,QAAQ,EAAE;AAClE,iBAAO;AAAA,YACL,SAAS;AAAA,YACT,OAAO;AAAA,UACT;AAAA,QACF;AAEA,cAAM,aAAa,aAAa,OAAO,OAAO;AAC9C,cAAM,YAAY,MAAM,UAAU,KAAK,UAAU;AAEjD,gBAAQ;AAAA,UACN,yBAAyB,QAAQ,KAAK,QAAQ,IAAI,KAAK,SAAS;AAAA,QAClE;AAEA,eAAO;AAAA,UACL,SAAS;AAAA,UACT;AAAA,QACF;AAAA,MACF,SAAS,OAAY;AACnB,gBAAQ,MAAM,kCAAkC,QAAQ,KAAK,KAAK;AAGlE,YACE,MAAM,SAAS,0CACf,MAAM,SAAS,+CACf;AAEA,qBAAW,OAAO,QAAQ;AAC1B,cAAI,UAAU;AACZ,kBAAM,SAAS,gBAAgB,UAAU,KAAK;AAAA,UAChD;AAAA,QACF;AAEA,eAAO;AAAA,UACL,SAAS;AAAA,UACT,OAAO,MAAM,WAAW;AAAA,QAC1B;AAAA,MACF;AAAA,IACF;AAAA,IAEA,MAAM,UACJ,WACA,SAC0B;AAC1B,YAAM,UAA2D,CAAC;AAClE,UAAI,eAAe;AACnB,UAAI,eAAe;AAGnB,YAAM,YAAY,oBAAI,IAAoB;AAC1C,iBAAW,YAAY,WAAW;AAChC,cAAM,QAAQ,MAAM,SAAS,QAAQ;AACrC,YAAI,OAAO;AACT,oBAAU,IAAI,UAAU,KAAK;AAAA,QAC/B,OAAO;AACL,kBAAQ,KAAK;AAAA,YACX;AAAA,YACA,QAAQ;AAAA,cACN,SAAS;AAAA,cACT,OAAO;AAAA,YACT;AAAA,UACF,CAAC;AACD;AAAA,QACF;AAAA,MACF;AAEA,UAAI,UAAU,SAAS,GAAG;AACxB,eAAO,EAAE,cAAc,cAAc,QAAQ;AAAA,MAC/C;AAGA,YAAM,WAAsC,CAAC;AAC7C,YAAM,gBAA0B,CAAC;AAEjC,iBAAW,CAAC,UAAU,KAAK,KAAK,WAAW;AACzC,iBAAS,KAAK,aAAa,OAAO,OAAO,CAAC;AAC1C,sBAAc,KAAK,QAAQ;AAAA,MAC7B;AAEA,UAAI;AAEF,cAAM,YAAY;AAClB,iBAAS,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK,WAAW;AACnD,gBAAM,QAAQ,SAAS,MAAM,GAAG,IAAI,SAAS;AAC7C,gBAAM,iBAAiB,cAAc,MAAM,GAAG,IAAI,SAAS;AAE3D,gBAAM,WAAW,MAAM,UAAU,SAAS,KAAK;AAE/C,mBAAS,UAAU,QAAQ,CAAC,MAAM,UAAU;AAC1C,kBAAM,WAAW,eAAe,KAAK;AAErC,gBAAI,KAAK,SAAS;AAChB,sBAAQ,KAAK;AAAA,gBACX;AAAA,gBACA,QAAQ;AAAA,kBACN,SAAS;AAAA,kBACT,WAAW,KAAK;AAAA,gBAClB;AAAA,cACF,CAAC;AACD;AAAA,YACF,OAAO;AACL,oBAAM,QAAQ,KAAK;AAGnB,kBACE,OAAO,SAAS,0CAChB,OAAO,SAAS,+CAChB;AACA,2BAAW,OAAO,QAAQ;AAC1B,oBAAI,UAAU;AACZ,2BAAS,gBAAgB,UAAU,KAAK,EAAE,MAAM,MAAM;AAAA,kBAAC,CAAC;AAAA,gBAC1D;AAAA,cACF;AAEA,sBAAQ,KAAK;AAAA,gBACX;AAAA,gBACA,QAAQ;AAAA,kBACN,SAAS;AAAA,kBACT,OAAO,OAAO,WAAW;AAAA,gBAC3B;AAAA,cACF,CAAC;AACD;AAAA,YACF;AAAA,UACF,CAAC;AAAA,QACH;AAEA,gBAAQ;AAAA,UACN,6BAA6B,YAAY,aAAa,YAAY;AAAA,QACpE;AAAA,MACF,SAAS,OAAY;AACnB,gBAAQ,MAAM,mCAAmC,KAAK;AAGtD,mBAAW,YAAY,eAAe;AACpC,cAAI,CAAC,QAAQ,KAAK,CAAC,MAAM,EAAE,aAAa,QAAQ,GAAG;AACjD,oBAAQ,KAAK;AAAA,cACX;AAAA,cACA,QAAQ;AAAA,gBACN,SAAS;AAAA,gBACT,OAAO,MAAM,WAAW;AAAA,cAC1B;AAAA,YACF,CAAC;AACD;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,aAAO,EAAE,cAAc,cAAc,QAAQ;AAAA,IAC/C;AAAA,IAEA,MAAM,cAAc,UAAkB,OAA8B;AAElE,iBAAW,IAAI,UAAU,KAAK;AAG9B,UAAI,UAAU;AACZ,cAAM,SAAS,gBAAgB;AAAA,UAC7B;AAAA,UACA,UAAU;AAAA,UACV;AAAA,QACF,CAAC;AAAA,MACH;AAEA,cAAQ,IAAI,6CAA6C,QAAQ,EAAE;AAAA,IACrE;AAAA,IAEA,MAAM,gBAAgB,UAAiC;AAErD,iBAAW,OAAO,QAAQ;AAG1B,UAAI,UAAU;AACZ,cAAM,SAAS,gBAAgB,UAAU,KAAK;AAAA,MAChD;AAEA,cAAQ,IAAI,+CAA+C,QAAQ,EAAE;AAAA,IACvE;AAAA,IAEA,MAAM,UAAU,UAAkB,OAA8B;AAC9D,YAAM,QAAQ,MAAM,SAAS,QAAQ;AACrC,UAAI,CAAC,OAAO;AACV,cAAM,IAAI,MAAM,2BAA2B,QAAQ,EAAE;AAAA,MACvD;AAEA,YAAM,UAAU,iBAAiB,OAAO,KAAK;AAC7C,cAAQ,IAAI,4BAA4B,QAAQ,aAAa,KAAK,EAAE;AAAA,IACtE;AAAA,IAEA,MAAM,YAAY,UAAkB,OAA8B;AAChE,YAAM,QAAQ,MAAM,SAAS,QAAQ;AACrC,UAAI,CAAC,OAAO;AACV;AAAA,MACF;AAEA,YAAM,UAAU,qBAAqB,OAAO,KAAK;AACjD,cAAQ,IAAI,8BAA8B,QAAQ,eAAe,KAAK,EAAE;AAAA,IAC1E;AAAA,EACF;AACF;AAQO,SAAS,sBACd,SACa;AACb,SAAO,eAAe;AAAA,IACpB,GAAG;AAAA,IACH,YAAkB,iBAAW,mBAAmB;AAAA,IAChD,WAAW,QAAQ,IAAI;AAAA,EACzB,CAAC;AACH;AAKO,SAAS,iCACd,gBACA,SACa;AACb,QAAMC,cACJ,OAAO,mBAAmB,WAChB,iBAAW,KAAK,KAAK,MAAM,cAAc,CAAC,IAC1C,iBAAW,KAAK,cAAc;AAE1C,SAAO,eAAe;AAAA,IACpB,GAAG;AAAA,IACH,YAAAA;AAAA,EACF,CAAC;AACH;","names":["app","credential"]}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@openmdm/push-fcm",
+  "version": "0.2.0",
+  "description": "Firebase Cloud Messaging push adapter for OpenMDM",
+  "author": "OpenMDM Contributors",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "firebase-admin": "^13.0.0",
+    "@openmdm/core": "0.2.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.5.0"
+  },
+  "peerDependencies": {
+    "firebase-admin": ">=12.0.0"
+  },
+  "keywords": [
+    "openmdm",
+    "fcm",
+    "firebase",
+    "push",
+    "notifications"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/azoila/openmdm.git",
+    "directory": "packages/push/fcm"
+  },
+  "homepage": "https://openmdm.dev",
+  "bugs": {
+    "url": "https://github.com/azoila/openmdm/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  }
+}

package/src/index.ts

@@ -0,0 +1,414 @@
+/**
+ * OpenMDM FCM Push Adapter
+ *
+ * Firebase Cloud Messaging adapter for sending push notifications to Android devices.
+ *
+ * @example
+ * ```typescript
+ * import { createMDM } from '@openmdm/core';
+ * import { fcmPushAdapter } from '@openmdm/push-fcm';
+ *
+ * const mdm = createMDM({
+ *   database: drizzleAdapter(db),
+ *   push: fcmPushAdapter({
+ *     credential: admin.credential.cert(serviceAccount),
+ *     // or: credentialPath: './service-account.json',
+ *   }),
+ * });
+ * ```
+ */
+
+import * as admin from 'firebase-admin';
+import type {
+  PushAdapter,
+  PushMessage,
+  PushResult,
+  PushBatchResult,
+  DatabaseAdapter,
+} from '@openmdm/core';
+
+export interface FCMAdapterOptions {
+  /**
+   * Firebase Admin credential object
+   * Use admin.credential.cert(serviceAccount) or admin.credential.applicationDefault()
+   */
+  credential?: admin.credential.Credential;
+
+  /**
+   * Path to service account JSON file
+   * Alternative to providing credential directly
+   */
+  credentialPath?: string;
+
+  /**
+   * Firebase project ID (optional, usually inferred from credential)
+   */
+  projectId?: string;
+
+  /**
+   * Database adapter for storing/retrieving push tokens
+   */
+  database?: DatabaseAdapter;
+
+  /**
+   * Whether to use data-only messages (default: true)
+   * Data-only messages wake the app even when in background
+   */
+  dataOnly?: boolean;
+
+  /**
+   * Default TTL for messages in seconds (default: 3600 = 1 hour)
+   */
+  defaultTtl?: number;
+
+  /**
+   * Android-specific notification options
+   */
+  android?: {
+    priority?: 'high' | 'normal';
+    restrictedPackageName?: string;
+    directBootOk?: boolean;
+  };
+}
+
+/**
+ * Create an FCM push adapter for OpenMDM
+ */
+export function fcmPushAdapter(options: FCMAdapterOptions): PushAdapter {
+  // Initialize Firebase Admin if not already initialized
+  let app: admin.app.App;
+
+  try {
+    app = admin.app('[openmdm]');
+  } catch {
+    // App doesn't exist, create it
+    const initOptions: admin.AppOptions = {};
+
+    if (options.credential) {
+      initOptions.credential = options.credential;
+    } else if (options.credentialPath) {
+      // eslint-disable-next-line @typescript-eslint/no-require-imports
+      const serviceAccount = require(options.credentialPath);
+      initOptions.credential = admin.credential.cert(serviceAccount);
+    } else {
+      // Use application default credentials
+      initOptions.credential = admin.credential.applicationDefault();
+    }
+
+    if (options.projectId) {
+      initOptions.projectId = options.projectId;
+    }
+
+    app = admin.initializeApp(initOptions, '[openmdm]');
+  }
+
+  const messaging = app.messaging();
+  const database = options.database;
+  const dataOnly = options.dataOnly ?? true;
+  const defaultTtl = options.defaultTtl ?? 3600;
+
+  // Token cache: deviceId -> FCM token
+  const tokenCache = new Map<string, string>();
+
+  /**
+   * Get FCM token for a device
+   */
+  async function getToken(deviceId: string): Promise<string | null> {
+    // Check cache first
+    if (tokenCache.has(deviceId)) {
+      return tokenCache.get(deviceId)!;
+    }
+
+    // Get from database if available
+    if (database) {
+      const pushToken = await database.findPushToken(deviceId, 'fcm');
+      if (pushToken?.token) {
+        tokenCache.set(deviceId, pushToken.token);
+        return pushToken.token;
+      }
+    }
+
+    return null;
+  }
+
+  /**
+   * Build FCM message from OpenMDM push message
+   */
+  function buildMessage(
+    token: string,
+    message: PushMessage
+  ): admin.messaging.Message {
+    const fcmMessage: admin.messaging.Message = {
+      token,
+      android: {
+        priority: message.priority === 'high' ? 'high' : 'normal',
+        ttl: (message.ttl ?? defaultTtl) * 1000, // Convert to milliseconds
+        restrictedPackageName: options.android?.restrictedPackageName,
+        directBootOk: options.android?.directBootOk,
+      },
+    };
+
+    if (dataOnly) {
+      // Data-only message - always wakes the app
+      fcmMessage.data = {
+        type: message.type,
+        payload: message.payload ? JSON.stringify(message.payload) : '{}',
+        timestamp: new Date().toISOString(),
+      };
+
+      if (message.collapseKey) {
+        fcmMessage.android!.collapseKey = message.collapseKey;
+      }
+    } else {
+      // Notification + data message
+      fcmMessage.notification = {
+        title: 'MDM Command',
+        body: message.type,
+      };
+      fcmMessage.data = {
+        type: message.type,
+        payload: message.payload ? JSON.stringify(message.payload) : '{}',
+      };
+    }
+
+    return fcmMessage;
+  }
+
+  return {
+    async send(deviceId: string, message: PushMessage): Promise<PushResult> {
+      try {
+        const token = await getToken(deviceId);
+        if (!token) {
+          console.warn(`[OpenMDM FCM] No token found for device ${deviceId}`);
+          return {
+            success: false,
+            error: 'No FCM token registered for device',
+          };
+        }
+
+        const fcmMessage = buildMessage(token, message);
+        const messageId = await messaging.send(fcmMessage);
+
+        console.log(
+          `[OpenMDM FCM] Sent to ${deviceId}: ${message.type} (${messageId})`
+        );
+
+        return {
+          success: true,
+          messageId,
+        };
+      } catch (error: any) {
+        console.error(`[OpenMDM FCM] Error sending to ${deviceId}:`, error);
+
+        // Handle invalid token
+        if (
+          error.code === 'messaging/invalid-registration-token' ||
+          error.code === 'messaging/registration-token-not-registered'
+        ) {
+          // Remove invalid token from cache and database
+          tokenCache.delete(deviceId);
+          if (database) {
+            await database.deletePushToken(deviceId, 'fcm');
+          }
+        }
+
+        return {
+          success: false,
+          error: error.message || 'FCM send failed',
+        };
+      }
+    },
+
+    async sendBatch(
+      deviceIds: string[],
+      message: PushMessage
+    ): Promise<PushBatchResult> {
+      const results: Array<{ deviceId: string; result: PushResult }> = [];
+      let successCount = 0;
+      let failureCount = 0;
+
+      // Get tokens for all devices
+      const tokensMap = new Map<string, string>();
+      for (const deviceId of deviceIds) {
+        const token = await getToken(deviceId);
+        if (token) {
+          tokensMap.set(deviceId, token);
+        } else {
+          results.push({
+            deviceId,
+            result: {
+              success: false,
+              error: 'No FCM token registered',
+            },
+          });
+          failureCount++;
+        }
+      }
+
+      if (tokensMap.size === 0) {
+        return { successCount, failureCount, results };
+      }
+
+      // Build messages for batch send
+      const messages: admin.messaging.Message[] = [];
+      const deviceIdOrder: string[] = [];
+
+      for (const [deviceId, token] of tokensMap) {
+        messages.push(buildMessage(token, message));
+        deviceIdOrder.push(deviceId);
+      }
+
+      try {
+        // Send batch (max 500 messages per call)
+        const batchSize = 500;
+        for (let i = 0; i < messages.length; i += batchSize) {
+          const batch = messages.slice(i, i + batchSize);
+          const batchDeviceIds = deviceIdOrder.slice(i, i + batchSize);
+
+          const response = await messaging.sendEach(batch);
+
+          response.responses.forEach((resp, index) => {
+            const deviceId = batchDeviceIds[index];
+
+            if (resp.success) {
+              results.push({
+                deviceId,
+                result: {
+                  success: true,
+                  messageId: resp.messageId,
+                },
+              });
+              successCount++;
+            } else {
+              const error = resp.error;
+
+              // Handle invalid token
+              if (
+                error?.code === 'messaging/invalid-registration-token' ||
+                error?.code === 'messaging/registration-token-not-registered'
+              ) {
+                tokenCache.delete(deviceId);
+                if (database) {
+                  database.deletePushToken(deviceId, 'fcm').catch(() => {});
+                }
+              }
+
+              results.push({
+                deviceId,
+                result: {
+                  success: false,
+                  error: error?.message || 'FCM send failed',
+                },
+              });
+              failureCount++;
+            }
+          });
+        }
+
+        console.log(
+          `[OpenMDM FCM] Batch sent: ${successCount} success, ${failureCount} failed`
+        );
+      } catch (error: any) {
+        console.error('[OpenMDM FCM] Batch send error:', error);
+
+        // Mark all remaining as failed
+        for (const deviceId of deviceIdOrder) {
+          if (!results.find((r) => r.deviceId === deviceId)) {
+            results.push({
+              deviceId,
+              result: {
+                success: false,
+                error: error.message || 'FCM batch send failed',
+              },
+            });
+            failureCount++;
+          }
+        }
+      }
+
+      return { successCount, failureCount, results };
+    },
+
+    async registerToken(deviceId: string, token: string): Promise<void> {
+      // Update cache
+      tokenCache.set(deviceId, token);
+
+      // Store in database if available
+      if (database) {
+        await database.upsertPushToken({
+          deviceId,
+          provider: 'fcm',
+          token,
+        });
+      }
+
+      console.log(`[OpenMDM FCM] Registered token for device ${deviceId}`);
+    },
+
+    async unregisterToken(deviceId: string): Promise<void> {
+      // Remove from cache
+      tokenCache.delete(deviceId);
+
+      // Remove from database if available
+      if (database) {
+        await database.deletePushToken(deviceId, 'fcm');
+      }
+
+      console.log(`[OpenMDM FCM] Unregistered token for device ${deviceId}`);
+    },
+
+    async subscribe(deviceId: string, topic: string): Promise<void> {
+      const token = await getToken(deviceId);
+      if (!token) {
+        throw new Error(`No FCM token for device ${deviceId}`);
+      }
+
+      await messaging.subscribeToTopic(token, topic);
+      console.log(`[OpenMDM FCM] Subscribed ${deviceId} to topic ${topic}`);
+    },
+
+    async unsubscribe(deviceId: string, topic: string): Promise<void> {
+      const token = await getToken(deviceId);
+      if (!token) {
+        return; // Nothing to unsubscribe
+      }
+
+      await messaging.unsubscribeFromTopic(token, topic);
+      console.log(`[OpenMDM FCM] Unsubscribed ${deviceId} from topic ${topic}`);
+    },
+  };
+}
+
+/**
+ * Create FCM adapter from environment variables
+ *
+ * Expects GOOGLE_APPLICATION_CREDENTIALS environment variable
+ * or FIREBASE_PROJECT_ID for application default credentials
+ */
+export function fcmPushAdapterFromEnv(
+  options?: Partial<FCMAdapterOptions>
+): PushAdapter {
+  return fcmPushAdapter({
+    ...options,
+    credential: admin.credential.applicationDefault(),
+    projectId: process.env.FIREBASE_PROJECT_ID,
+  });
+}
+
+/**
+ * Create FCM adapter from service account JSON
+ */
+export function fcmPushAdapterFromServiceAccount(
+  serviceAccount: admin.ServiceAccount | string,
+  options?: Partial<FCMAdapterOptions>
+): PushAdapter {
+  const credential =
+    typeof serviceAccount === 'string'
+      ? admin.credential.cert(JSON.parse(serviceAccount))
+      : admin.credential.cert(serviceAccount);
+
+  return fcmPushAdapter({
+    ...options,
+    credential,
+  });
+}