payload-notifications 0.1.0

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import {\n  type DocumentID,\n  type DocumentReference,\n  documentIdSchema,\n  documentReferenceSchema,\n} from '@repo/common';\nimport type { PayloadRequest } from 'payload';\nimport { z } from 'zod';\nimport type { NotificationsPluginConfig } from '.';\nimport type { User } from './payload-types';\n\nexport type ResolvedPluginOptions<\n  K extends keyof NotificationsPluginConfig = keyof NotificationsPluginConfig,\n> = Pick<Required<NotificationsPluginConfig>, K>;\n\nexport interface ResolvedUser extends User {\n  displayName: string;\n}\n\n// ── Notification types ─────────────────────────────────────────────────\n\nexport interface NotificationEmailConfig {\n  generateSubject: (args: {\n    notification: MinimalNotification;\n    recipient: ResolvedUser;\n    links: NotificationEmailLinks;\n  }) => string | Promise<string>;\n  generateHTML: (args: {\n    notification: MinimalNotification;\n    recipient: ResolvedUser;\n    links: NotificationEmailLinks;\n  }) => string | Promise<string>;\n}\n\nexport type NotificationCallback = (args: {\n  req: PayloadRequest;\n  notification: MinimalNotification;\n  recipient: ResolvedUser;\n}) => void | Promise<void>;\n\nexport interface NotifyInput<Actor extends DocumentID | null> {\n  recipient: DocumentID;\n  event: string;\n  actor: Actor;\n  message: string | MessageFn<Actor> | LiveMessage;\n  url?: string;\n  meta?: Record<string, unknown>;\n  documentReference?: DocumentReference;\n}\n\nexport interface MinimalNotification {\n  message: string;\n  event: string;\n}\n\nexport interface NotificationData {\n  id: string | number;\n  event: string;\n  /** Pre-resolved message string for display. */\n  message: string;\n  readAt?: string | null;\n  documentReference: StoredDocumentReference;\n  createdAt: string;\n}\n\nexport interface NotificationEmailLinks {\n  /** Marks notification as read and redirects to its target. Requires login. */\n  openURL: string;\n  /** Unsubscribes the user from this notification source. No login required. */\n  unsubscribeURL: string | undefined;\n}\n\n// ── Message schemas & types ────────────────────────────────────────────\n\nconst staticMessageSchema = z.object({\n  type: z.literal('static'),\n  value: z.string(),\n});\n\nconst liveMessageTokenSchema = z.object({\n  type: z.enum(['actor', 'document', 'meta']),\n  field: z.string(),\n});\n\nconst liveMessageSchema = z.object({\n  type: z.literal('live'),\n  parts: z.array(z.union([z.string(), liveMessageTokenSchema])),\n});\n\nexport const messageSchema = z.discriminatedUnion('type', [\n  staticMessageSchema,\n  liveMessageSchema,\n]);\n\nexport type LiveMessageToken = z.infer<typeof liveMessageTokenSchema>;\n\nexport type LiveMessage = Readonly<z.infer<typeof liveMessageSchema>>;\n\n/** Resolved actor data available inside a {@link MessageFn}. */\nexport interface ResolvedActor {\n  id: string | number;\n  displayName: string;\n}\n\n/** Context passed to a `MessageFn` when resolving the notification message. */\nexport interface MessageContext<Actor extends DocumentID | null> {\n  actor: Actor extends DocumentID ? ResolvedActor : null;\n  document?: Record<string, unknown>;\n  meta?: Record<string, unknown>;\n}\n\n/** A function that receives context and returns a resolved message string. */\nexport type MessageFn<Actor extends DocumentID | null> = (\n  ctx: MessageContext<Actor>,\n) => string;\n\n// ── Endpoint schemas ───────────────────────────────────────────────────\n\nexport const markReadSchema = z.object({\n  id: documentIdSchema,\n});\n\n/** The flat shape stored in the Subscriptions group field. */\nexport interface StoredDocumentReference {\n  entity: 'collection' | 'global';\n  slug: string;\n  documentId?: string;\n}\n\nexport const subscriptionSchema = z.object({\n  documentReference: documentReferenceSchema,\n});\n"],"names":["documentIdSchema","documentReferenceSchema","z","staticMessageSchema","object","type","literal","value","string","liveMessageTokenSchema","enum","field","liveMessageSchema","parts","array","union","messageSchema","discriminatedUnion","markReadSchema","id","subscriptionSchema","documentReference"],"mappings":"AAAA,SAGEA,gBAAgB,EAChBC,uBAAuB,QAClB,eAAe;AAEtB,SAASC,CAAC,QAAQ,MAAM;AAiExB,0EAA0E;AAE1E,MAAMC,sBAAsBD,EAAEE,MAAM,CAAC;IACnCC,MAAMH,EAAEI,OAAO,CAAC;IAChBC,OAAOL,EAAEM,MAAM;AACjB;AAEA,MAAMC,yBAAyBP,EAAEE,MAAM,CAAC;IACtCC,MAAMH,EAAEQ,IAAI,CAAC;QAAC;QAAS;QAAY;KAAO;IAC1CC,OAAOT,EAAEM,MAAM;AACjB;AAEA,MAAMI,oBAAoBV,EAAEE,MAAM,CAAC;IACjCC,MAAMH,EAAEI,OAAO,CAAC;IAChBO,OAAOX,EAAEY,KAAK,CAACZ,EAAEa,KAAK,CAAC;QAACb,EAAEM,MAAM;QAAIC;KAAuB;AAC7D;AAEA,OAAO,MAAMO,gBAAgBd,EAAEe,kBAAkB,CAAC,QAAQ;IACxDd;IACAS;CACD,EAAE;AAwBH,0EAA0E;AAE1E,OAAO,MAAMM,iBAAiBhB,EAAEE,MAAM,CAAC;IACrCe,IAAInB;AACN,GAAG;AASH,OAAO,MAAMoB,qBAAqBlB,EAAEE,MAAM,CAAC;IACzCiB,mBAAmBpB;AACrB,GAAG"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "payload-notifications",
+  "version": "0.1.0",
+  "description": "Generic notification infrastructure for Payload CMS with email, in-app, and external callback channels.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/exports/client.d.ts",
+      "import": "./dist/exports/client.js",
+      "default": "./dist/exports/client.js"
+    },
+    "./rsc": {
+      "types": "./dist/exports/rsc.d.ts",
+      "import": "./dist/exports/rsc.js",
+      "default": "./dist/exports/rsc.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prebuild": "rm -f src/internals 2>/dev/null; pnpm check:types",
+    "build": "plugin-build",
+    "check:types": "tsc --noEmit",
+    "clean": "rm -rf dist && rm -rf node_modules",
+    "dev": "plugin-build --watch",
+    "generate:types": "generate-types",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@base-ui/react": "^1.1.0",
+    "@repo/common": "workspace:*",
+    "@tabler/icons-react": "^3.36.1",
+    "zod": "catalog:"
+  },
+  "devDependencies": {
+    "@payloadcms/ui": "catalog:payload-stack",
+    "@repo/common": "workspace:*",
+    "@types/json-schema": "^7.0.15",
+    "@types/node": "^22.5.4",
+    "@types/react": "catalog:payload-stack",
+    "@types/react-dom": "catalog:payload-stack",
+    "next": "catalog:payload-stack",
+    "payload": "catalog:payload-stack",
+    "react": "catalog:payload-stack",
+    "react-dom": "catalog:payload-stack",
+    "typescript": "catalog:payload-stack",
+    "vite": "catalog:vite",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.1.2"
+  },
+  "peerDependencies": {
+    "@payloadcms/next": ">=3.72.0",
+    "@payloadcms/ui": ">=3.72.0",
+    "next": ">=15.2.3",
+    "payload": ">=3.72.0"
+  },
+  "engines": {
+    "node": "^18.20.2 || >=20.9.0",
+    "pnpm": "^9 || ^10"
+  }
+}