Merge pull request #13 from celestifyhq/dx

Dx

Author: parasdaryanani

.github/workflows/npm-publish.yml

@@ -27,6 +27,9 @@ jobs:
       - name: Build
         run: npm run build
 
+      - name: Run Tests
+        run: npm test
+
       - name: Create Release Pull Request or Publish
         id: changesets
         uses: changesets/action@v1

.gitignore

@@ -1,5 +1,4 @@
 dist/*
-test/*
 .vscode/
 node_modules/
 .dev.vars

RELEASING.md

@@ -0,0 +1,59 @@
+# Releasing a New Version
+
+This project uses [Changesets](https://github.com/changesets/changesets) to manage versioning and publishing to npm. The process is automated using GitHub Actions.
+
+## Steps to Release
+
+1.  **Make your code changes**: Implement your features, bug fixes, etc., on a feature branch (e.g., `issue/your-issue-number` or `feat/short-description`).
+
+2.  **Create a Changeset**:
+    Before committing your changes, or after your main changes are staged, run the following command:
+    ```bash
+    npx changeset
+    ```
+    *   You will be prompted to select the package(s) to version (select `fcm-cloudflare-workers`).
+    *   Choose the type of change according to [SemVer](https://semver.org/) (patch, minor, or major).
+        *   `patch`: For bug fixes or very small changes (e.g., 2.0.0 -> 2.0.1)
+        *   `minor`: For new features that are backward-compatible (e.g., 2.0.0 -> 2.1.0)
+        *   `major`: For breaking changes (e.g., 2.0.0 -> 3.0.0)
+    *   Enter a clear and concise summary of the changes. This summary will be used in the `CHANGELOG.md`.
+
+3.  **Commit the Changeset and Your Code**:
+    Add the generated changeset file (located in the `.changeset/` directory) and your code changes to git and commit them:
+    ```bash
+    git add .
+    git commit -m "feat: your descriptive commit message (includes changeset)"
+    ```
+    Or, if you prefer separate commits:
+    ```bash
+    git add .changeset/your-changeset-name.md
+    git commit -m "chore: add changeset for upcoming release"
+    # then commit your code changes
+    git add src/ # or other changed files
+    git commit -m "feat: implemented new feature X"
+    ```
+
+4.  **Push Your Branch**:
+    Push your feature branch to GitHub:
+    ```bash
+    git push origin your-branch-name
+    ```
+
+5.  **Create a Pull Request**:
+    Go to the GitHub repository and create a Pull Request (PR) from your feature branch to the `main` branch.
+
+6.  **Merge the Pull Request**:
+    Once the PR is reviewed and approved, merge it into the `main` branch.
+
+7.  **Automatic Versioning and Publishing**:
+    *   Upon merging to `main`, the `Publish to npm` GitHub Action (defined in `.github/workflows/npm-publish.yml`) will trigger.
+    *   This action uses the changeset to:
+        *   Bump the version in `package.json`.
+        *   Update `CHANGELOG.md`.
+        *   Publish the new version to npm.
+        *   Create a new PR titled "chore: version packages" (or similar) which contains the version bump and changelog updates.
+
+8.  **Merge the Versioning Pull Request**:
+    Review and merge the "chore: version packages" PR created by the Changesets action. This finalizes the release process by updating the `package.json` and `CHANGELOG.md` on the `main` branch.
+
+Your package is now published with the new version! 

fixtures/fcm.middleware.ts

@@ -1,33 +1,50 @@
 import type { Context, MiddlewareHandler } from "hono";
 import { FCM, FcmOptions } from 'fcm-cloudflare-workers';
+import { KVNamespace } from "@cloudflare/workers-types";
 
-import { env } from "hono/adapter";
-
-type FirebaseEnv = {
+export type FcmMiddlewareBindings = {
   FIREBASE_SERVICE_ACCOUNT_JSON: string;
   MY_WORKER_CACHE: KVNamespace;
 };
 
+export type FcmMiddlewareVariables = {
+  fcm: FCM;
+};
+
 /**
  * An abstracted middleware that creates an instance of an FCM client
  *
  * @param c
  * @param next
  */
-export const fcmMiddleware: MiddlewareHandler = async (
-  c: Context,
-  next: any,
+export const fcmMiddleware: MiddlewareHandler<{ Bindings: FcmMiddlewareBindings, Variables: FcmMiddlewareVariables }> = async (
+  c: Context<{ Bindings: FcmMiddlewareBindings, Variables: FcmMiddlewareVariables }>,
+  next: () => Promise<void>,
 ) => {
-  const firebaseEnv = env<FirebaseEnv>(c);
-
-  const fcmOptions = new FcmOptions({
-    serviceAccount: JSON.parse(firebaseEnv.FIREBASE_SERVICE_ACCOUNT_JSON),
-    kvStore: firebaseEnv.MY_WORKER_CACHE,
-    kvCacheKey: "fcm-token-cache",
-  });
+  const serviceAccountJson = c.env.FIREBASE_SERVICE_ACCOUNT_JSON;
+  const kvCache = c.env.MY_WORKER_CACHE;
 
-  const fcmClient = new FCM(fcmOptions);
+  if (!serviceAccountJson) {
+    console.error("FIREBASE_SERVICE_ACCOUNT_JSON not found in c.env");
+    throw new Error("FIREBASE_SERVICE_ACCOUNT_JSON not found in environment bindings.");
+  }
+  if (!kvCache) {
+    console.error("MY_WORKER_CACHE not found in c.env");
+    throw new Error("MY_WORKER_CACHE not found in environment bindings.");
+  }
 
-  c.set("fcm", fcmClient);
+  try {
+    const fcmOptions = new FcmOptions({
+      serviceAccount: JSON.parse(serviceAccountJson),
+      kvStore: kvCache,
+      kvCacheKey: "fcm-token-cache",
+    });
+    const fcmClient = new FCM(fcmOptions);
+    c.set("fcm", fcmClient);
+  } catch (e) {
+    console.error("Error initializing FCM client in middleware:", e);
+    throw e;
+  }
+  
   await next();
 };

fixtures/index.ts

@@ -1,32 +1,38 @@
 import { Hono } from "hono";
-import { fcmMiddleware } from "./fcm.middleware";
+import { fcmMiddleware, FcmMiddlewareBindings, FcmMiddlewareVariables } from "./fcm.middleware";
 import { z } from "zod";
 import { zValidator } from "@hono/zod-validator";
 import { StatusCode } from "hono/utils/http-status";
 import { FCM, FcmMessage, EnhancedFcmMessage } from "fcm-cloudflare-workers";
-import { KVNamespace } from "@cloudflare/workers-types";
 
-type Bindings = {
-  FIREBASE_PROJECT_ID: string; // Firebase project ID
-  FIREBASE_SERVICE_ACCOUNT_JSON: string; // Firebase service account JSON
-  MY_WORKER_CACHE: KVNamespace; // Worker KV namespace
+type AppBindings = FcmMiddlewareBindings & {
+  // ANOTHER_KV: KVNamespace;
 };
 
-type Variables = {
+type AppVariables = FcmMiddlewareVariables & {
   error: {
     response: (
-      StatusCode: StatusCode,
+      statusCode: number,
       message: string,
       description: string
-    ) => void;
+    ) => Response;
   };
-  fcm: FCM,
 };
 
-const app = new Hono<{ Bindings: Bindings; Variables: Variables }>().basePath(
+const app = new Hono<{ Bindings: AppBindings; Variables: AppVariables }>().basePath(
   "/api"
 );
 
+app.use(async (c, next) => {
+  c.set("error", {
+    response: (statusCode, message, description) => {
+      console.error(`Error: ${message} - ${description}`);
+      return c.json({ error: message, description }, statusCode as any);
+    },
+  });
+  await next();
+});
+
 app.use(fcmMiddleware);
 
 // Schema for legacy single push
@@ -92,7 +98,7 @@ app.post("/push-single", zValidator("json", sendSinglePushSchema), async (c) =>
     }
   } catch (error) {
     console.log(error);
-    return c.var.error.response(400, "Sending Failed", error.message);
+    return c.var.error.response(400, "Sending Failed", (error as Error).message);
   }
 
   return c.json({ success: true });
@@ -119,7 +125,7 @@ app.post("/push-multi", zValidator("json", sendMultiPushSchema), async (c) => {
     }
   } catch (error) {
     console.log(error);
-    return c.var.error.response(400, "Sending Failed", error.message);
+    return c.var.error.response(400, "Sending Failed", (error as Error).message);
   }
 
   return c.json({ success: true });
@@ -136,7 +142,7 @@ app.post("/v2/push-token", zValidator("json", z.object({
     return c.json({ success: true });
   } catch (error) {
     console.log(error);
-    return c.var.error.response(400, "Sending Failed", error.message);
+    return c.var.error.response(400, "Sending Failed", (error as Error).message);
   }
 });
 
@@ -154,7 +160,7 @@ app.post("/v2/push-tokens", zValidator("json", z.object({
     });
   } catch (error) {
     console.log(error);
-    return c.var.error.response(400, "Sending Failed", error.message);
+    return c.var.error.response(400, "Sending Failed", (error as Error).message);
   }
 });
 
@@ -169,7 +175,7 @@ app.post("/v2/push-topic", zValidator("json", z.object({
     return c.json({ success: true });
   } catch (error) {
     console.log(error);
-    return c.var.error.response(400, "Sending Failed", error.message);
+    return c.var.error.response(400, "Sending Failed", (error as Error).message);
   }
 });
 
@@ -184,7 +190,7 @@ app.post("/v2/push-condition", zValidator("json", z.object({
     return c.json({ success: true });
   } catch (error) {
     console.log(error);
-    return c.var.error.response(400, "Sending Failed", error.message);
+    return c.var.error.response(400, "Sending Failed", (error as Error).message);
   }
 });
 

jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/__tests__/**/*.ts?(x)', '**/?(*.)+(spec|test).ts?(x)'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+};