@contractspec/module.notifications 0.0.0-canary-20260113162409

package/dist/templates/index.js

@@ -0,0 +1,202 @@
+//#region src/templates/index.ts
+/**
+* Define a notification template.
+*/
+function defineTemplate(def) {
+	return def;
+}
+/**
+* Render a template with variables.
+*/
+function renderTemplate(content, variables) {
+	return content.replace(/\{\{(\w+)\}\}/g, (match, key) => {
+		const value = variables[key];
+		if (value === void 0 || value === null) return match;
+		return String(value);
+	});
+}
+/**
+* Render a notification template for a specific channel.
+*/
+function renderNotificationTemplate(template, channel, variables) {
+	const channelContent = template.channels[channel];
+	if (!channelContent) return null;
+	const title = channelContent.title ? renderTemplate(channelContent.title, variables) : template.name;
+	const body = renderTemplate(channelContent.body, variables);
+	const result = {
+		title,
+		body,
+		actionUrl: channelContent.actionUrl ? renderTemplate(channelContent.actionUrl, variables) : void 0
+	};
+	if (channel === "email" && channelContent.subject) result.email = {
+		subject: renderTemplate(channelContent.subject, variables),
+		html: body,
+		text: stripHtml(body)
+	};
+	return result;
+}
+/**
+* Strip HTML tags from content (for plain text).
+*/
+function stripHtml(html) {
+	return html.replace(/<[^>]*>/g, "").replace(/\s+/g, " ").trim();
+}
+/**
+* Template registry for managing templates.
+*/
+var TemplateRegistry = class {
+	templates = /* @__PURE__ */ new Map();
+	register(template) {
+		this.templates.set(template.id, template);
+	}
+	get(templateId) {
+		return this.templates.get(templateId);
+	}
+	getAll() {
+		return Array.from(this.templates.values());
+	}
+	getByCategory(category) {
+		return this.getAll().filter((t) => t.category === category);
+	}
+};
+/**
+* Create a template registry.
+*/
+function createTemplateRegistry() {
+	return new TemplateRegistry();
+}
+/**
+* Welcome email template.
+*/
+const WelcomeTemplate = defineTemplate({
+	id: "welcome",
+	name: "Welcome",
+	description: "Sent when a user signs up.",
+	category: "onboarding",
+	variables: [
+		{
+			name: "name",
+			type: "string",
+			required: true
+		},
+		{
+			name: "appName",
+			type: "string",
+			default: "ContractSpec"
+		},
+		{
+			name: "actionUrl",
+			type: "url"
+		}
+	],
+	defaultChannels: ["EMAIL", "IN_APP"],
+	channels: {
+		email: {
+			subject: "Welcome to {{appName}}, {{name}}!",
+			body: `
+        <h1>Welcome, {{name}}!</h1>
+        <p>Thanks for joining {{appName}}. We're excited to have you on board.</p>
+        <p><a href="{{actionUrl}}">Get started now</a></p>
+      `
+		},
+		inApp: {
+			title: "Welcome to {{appName}}!",
+			body: "Thanks for joining. Click to complete your profile.",
+			actionUrl: "{{actionUrl}}"
+		}
+	}
+});
+/**
+* Organization invite template.
+*/
+const OrgInviteTemplate = defineTemplate({
+	id: "org-invite",
+	name: "Organization Invitation",
+	description: "Sent when a user is invited to an organization.",
+	category: "organization",
+	variables: [
+		{
+			name: "inviterName",
+			type: "string",
+			required: true
+		},
+		{
+			name: "orgName",
+			type: "string",
+			required: true
+		},
+		{
+			name: "role",
+			type: "string",
+			default: "member"
+		},
+		{
+			name: "actionUrl",
+			type: "url",
+			required: true
+		}
+	],
+	defaultChannels: ["EMAIL"],
+	channels: {
+		email: {
+			subject: "{{inviterName}} invited you to join {{orgName}}",
+			body: `
+        <h1>You've been invited!</h1>
+        <p>{{inviterName}} has invited you to join <strong>{{orgName}}</strong> as a {{role}}.</p>
+        <p><a href="{{actionUrl}}">Accept invitation</a></p>
+      `
+		},
+		inApp: {
+			title: "Invitation to {{orgName}}",
+			body: "{{inviterName}} invited you to join as {{role}}.",
+			actionUrl: "{{actionUrl}}",
+			actionText: "Accept"
+		}
+	}
+});
+/**
+* Mention template.
+*/
+const MentionTemplate = defineTemplate({
+	id: "mention",
+	name: "Mention",
+	description: "Sent when a user is mentioned.",
+	category: "social",
+	variables: [
+		{
+			name: "mentionerName",
+			type: "string",
+			required: true
+		},
+		{
+			name: "context",
+			type: "string",
+			required: true
+		},
+		{
+			name: "preview",
+			type: "string"
+		},
+		{
+			name: "actionUrl",
+			type: "url",
+			required: true
+		}
+	],
+	defaultChannels: ["IN_APP", "PUSH"],
+	channels: {
+		inApp: {
+			title: "{{mentionerName}} mentioned you",
+			body: "In {{context}}: \"{{preview}}\"",
+			actionUrl: "{{actionUrl}}"
+		},
+		push: {
+			title: "{{mentionerName}} mentioned you",
+			body: "{{preview}}"
+		}
+	}
+});
+
+//#endregion
+export { MentionTemplate, OrgInviteTemplate, TemplateRegistry, WelcomeTemplate, createTemplateRegistry, defineTemplate, renderNotificationTemplate, renderTemplate };
+//# sourceMappingURL=index.js.map

package/dist/templates/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/templates/index.ts"],"sourcesContent":["/**\n * Template variable definition.\n */\nexport interface TemplateVariable {\n  name: string;\n  type: 'string' | 'number' | 'boolean' | 'date' | 'url';\n  required?: boolean;\n  default?: string | number | boolean;\n  description?: string;\n}\n\n/**\n * Channel-specific template content.\n */\nexport interface ChannelTemplateContent {\n  title?: string;\n  subject?: string;\n  body: string;\n  actionUrl?: string;\n  actionText?: string;\n}\n\n/**\n * Notification template definition.\n */\nexport interface NotificationTemplateDefinition {\n  id: string;\n  name: string;\n  description?: string;\n  category?: string;\n  variables?: TemplateVariable[];\n  defaultChannels?: string[];\n  channels: {\n    email?: ChannelTemplateContent;\n    inApp?: ChannelTemplateContent;\n    push?: ChannelTemplateContent;\n    webhook?: ChannelTemplateContent;\n  };\n}\n\n/**\n * Rendered notification content.\n */\nexport interface RenderedNotification {\n  title: string;\n  body: string;\n  actionUrl?: string;\n  email?: {\n    subject: string;\n    html: string;\n    text: string;\n  };\n}\n\n/**\n * Define a notification template.\n */\nexport function defineTemplate(\n  def: NotificationTemplateDefinition\n): NotificationTemplateDefinition {\n  return def;\n}\n\n/**\n * Render a template with variables.\n */\nexport function renderTemplate(\n  content: string,\n  variables: Record<string, unknown>\n): string {\n  return content.replace(/\\{\\{(\\w+)\\}\\}/g, (match, key) => {\n    const value = variables[key];\n    if (value === undefined || value === null) {\n      return match; // Keep placeholder if no value\n    }\n    return String(value);\n  });\n}\n\n/**\n * Render a notification template for a specific channel.\n */\nexport function renderNotificationTemplate(\n  template: NotificationTemplateDefinition,\n  channel: keyof NotificationTemplateDefinition['channels'],\n  variables: Record<string, unknown>\n): RenderedNotification | null {\n  const channelContent = template.channels[channel];\n  if (!channelContent) {\n    return null;\n  }\n\n  const title = channelContent.title\n    ? renderTemplate(channelContent.title, variables)\n    : template.name;\n\n  const body = renderTemplate(channelContent.body, variables);\n\n  const actionUrl = channelContent.actionUrl\n    ? renderTemplate(channelContent.actionUrl, variables)\n    : undefined;\n\n  const result: RenderedNotification = {\n    title,\n    body,\n    actionUrl,\n  };\n\n  // Add email-specific rendering\n  if (channel === 'email' && channelContent.subject) {\n    result.email = {\n      subject: renderTemplate(channelContent.subject, variables),\n      html: body,\n      text: stripHtml(body),\n    };\n  }\n\n  return result;\n}\n\n/**\n * Strip HTML tags from content (for plain text).\n */\nfunction stripHtml(html: string): string {\n  return html\n    .replace(/<[^>]*>/g, '')\n    .replace(/\\s+/g, ' ')\n    .trim();\n}\n\n/**\n * Template registry for managing templates.\n */\nexport class TemplateRegistry {\n  private templates = new Map<string, NotificationTemplateDefinition>();\n\n  register(template: NotificationTemplateDefinition): void {\n    this.templates.set(template.id, template);\n  }\n\n  get(templateId: string): NotificationTemplateDefinition | undefined {\n    return this.templates.get(templateId);\n  }\n\n  getAll(): NotificationTemplateDefinition[] {\n    return Array.from(this.templates.values());\n  }\n\n  getByCategory(category: string): NotificationTemplateDefinition[] {\n    return this.getAll().filter((t) => t.category === category);\n  }\n}\n\n/**\n * Create a template registry.\n */\nexport function createTemplateRegistry(): TemplateRegistry {\n  return new TemplateRegistry();\n}\n\n// ============ Standard Templates ============\n\n/**\n * Welcome email template.\n */\nexport const WelcomeTemplate = defineTemplate({\n  id: 'welcome',\n  name: 'Welcome',\n  description: 'Sent when a user signs up.',\n  category: 'onboarding',\n  variables: [\n    { name: 'name', type: 'string', required: true },\n    { name: 'appName', type: 'string', default: 'ContractSpec' },\n    { name: 'actionUrl', type: 'url' },\n  ],\n  defaultChannels: ['EMAIL', 'IN_APP'],\n  channels: {\n    email: {\n      subject: 'Welcome to {{appName}}, {{name}}!',\n      body: `\n        <h1>Welcome, {{name}}!</h1>\n        <p>Thanks for joining {{appName}}. We're excited to have you on board.</p>\n        <p><a href=\"{{actionUrl}}\">Get started now</a></p>\n      `,\n    },\n    inApp: {\n      title: 'Welcome to {{appName}}!',\n      body: 'Thanks for joining. Click to complete your profile.',\n      actionUrl: '{{actionUrl}}',\n    },\n  },\n});\n\n/**\n * Organization invite template.\n */\nexport const OrgInviteTemplate = defineTemplate({\n  id: 'org-invite',\n  name: 'Organization Invitation',\n  description: 'Sent when a user is invited to an organization.',\n  category: 'organization',\n  variables: [\n    { name: 'inviterName', type: 'string', required: true },\n    { name: 'orgName', type: 'string', required: true },\n    { name: 'role', type: 'string', default: 'member' },\n    { name: 'actionUrl', type: 'url', required: true },\n  ],\n  defaultChannels: ['EMAIL'],\n  channels: {\n    email: {\n      subject: '{{inviterName}} invited you to join {{orgName}}',\n      body: `\n        <h1>You've been invited!</h1>\n        <p>{{inviterName}} has invited you to join <strong>{{orgName}}</strong> as a {{role}}.</p>\n        <p><a href=\"{{actionUrl}}\">Accept invitation</a></p>\n      `,\n    },\n    inApp: {\n      title: 'Invitation to {{orgName}}',\n      body: '{{inviterName}} invited you to join as {{role}}.',\n      actionUrl: '{{actionUrl}}',\n      actionText: 'Accept',\n    },\n  },\n});\n\n/**\n * Mention template.\n */\nexport const MentionTemplate = defineTemplate({\n  id: 'mention',\n  name: 'Mention',\n  description: 'Sent when a user is mentioned.',\n  category: 'social',\n  variables: [\n    { name: 'mentionerName', type: 'string', required: true },\n    { name: 'context', type: 'string', required: true },\n    { name: 'preview', type: 'string' },\n    { name: 'actionUrl', type: 'url', required: true },\n  ],\n  defaultChannels: ['IN_APP', 'PUSH'],\n  channels: {\n    inApp: {\n      title: '{{mentionerName}} mentioned you',\n      body: 'In {{context}}: \"{{preview}}\"',\n      actionUrl: '{{actionUrl}}',\n    },\n    push: {\n      title: '{{mentionerName}} mentioned you',\n      body: '{{preview}}',\n    },\n  },\n});\n"],"mappings":";;;;AAyDA,SAAgB,eACd,KACgC;AAChC,QAAO;;;;;AAMT,SAAgB,eACd,SACA,WACQ;AACR,QAAO,QAAQ,QAAQ,mBAAmB,OAAO,QAAQ;EACvD,MAAM,QAAQ,UAAU;AACxB,MAAI,UAAU,UAAa,UAAU,KACnC,QAAO;AAET,SAAO,OAAO,MAAM;GACpB;;;;;AAMJ,SAAgB,2BACd,UACA,SACA,WAC6B;CAC7B,MAAM,iBAAiB,SAAS,SAAS;AACzC,KAAI,CAAC,eACH,QAAO;CAGT,MAAM,QAAQ,eAAe,QACzB,eAAe,eAAe,OAAO,UAAU,GAC/C,SAAS;CAEb,MAAM,OAAO,eAAe,eAAe,MAAM,UAAU;CAM3D,MAAM,SAA+B;EACnC;EACA;EACA,WAPgB,eAAe,YAC7B,eAAe,eAAe,WAAW,UAAU,GACnD;EAMH;AAGD,KAAI,YAAY,WAAW,eAAe,QACxC,QAAO,QAAQ;EACb,SAAS,eAAe,eAAe,SAAS,UAAU;EAC1D,MAAM;EACN,MAAM,UAAU,KAAK;EACtB;AAGH,QAAO;;;;;AAMT,SAAS,UAAU,MAAsB;AACvC,QAAO,KACJ,QAAQ,YAAY,GAAG,CACvB,QAAQ,QAAQ,IAAI,CACpB,MAAM;;;;;AAMX,IAAa,mBAAb,MAA8B;CAC5B,AAAQ,4BAAY,IAAI,KAA6C;CAErE,SAAS,UAAgD;AACvD,OAAK,UAAU,IAAI,SAAS,IAAI,SAAS;;CAG3C,IAAI,YAAgE;AAClE,SAAO,KAAK,UAAU,IAAI,WAAW;;CAGvC,SAA2C;AACzC,SAAO,MAAM,KAAK,KAAK,UAAU,QAAQ,CAAC;;CAG5C,cAAc,UAAoD;AAChE,SAAO,KAAK,QAAQ,CAAC,QAAQ,MAAM,EAAE,aAAa,SAAS;;;;;;AAO/D,SAAgB,yBAA2C;AACzD,QAAO,IAAI,kBAAkB;;;;;AAQ/B,MAAa,kBAAkB,eAAe;CAC5C,IAAI;CACJ,MAAM;CACN,aAAa;CACb,UAAU;CACV,WAAW;EACT;GAAE,MAAM;GAAQ,MAAM;GAAU,UAAU;GAAM;EAChD;GAAE,MAAM;GAAW,MAAM;GAAU,SAAS;GAAgB;EAC5D;GAAE,MAAM;GAAa,MAAM;GAAO;EACnC;CACD,iBAAiB,CAAC,SAAS,SAAS;CACpC,UAAU;EACR,OAAO;GACL,SAAS;GACT,MAAM;;;;;GAKP;EACD,OAAO;GACL,OAAO;GACP,MAAM;GACN,WAAW;GACZ;EACF;CACF,CAAC;;;;AAKF,MAAa,oBAAoB,eAAe;CAC9C,IAAI;CACJ,MAAM;CACN,aAAa;CACb,UAAU;CACV,WAAW;EACT;GAAE,MAAM;GAAe,MAAM;GAAU,UAAU;GAAM;EACvD;GAAE,MAAM;GAAW,MAAM;GAAU,UAAU;GAAM;EACnD;GAAE,MAAM;GAAQ,MAAM;GAAU,SAAS;GAAU;EACnD;GAAE,MAAM;GAAa,MAAM;GAAO,UAAU;GAAM;EACnD;CACD,iBAAiB,CAAC,QAAQ;CAC1B,UAAU;EACR,OAAO;GACL,SAAS;GACT,MAAM;;;;;GAKP;EACD,OAAO;GACL,OAAO;GACP,MAAM;GACN,WAAW;GACX,YAAY;GACb;EACF;CACF,CAAC;;;;AAKF,MAAa,kBAAkB,eAAe;CAC5C,IAAI;CACJ,MAAM;CACN,aAAa;CACb,UAAU;CACV,WAAW;EACT;GAAE,MAAM;GAAiB,MAAM;GAAU,UAAU;GAAM;EACzD;GAAE,MAAM;GAAW,MAAM;GAAU,UAAU;GAAM;EACnD;GAAE,MAAM;GAAW,MAAM;GAAU;EACnC;GAAE,MAAM;GAAa,MAAM;GAAO,UAAU;GAAM;EACnD;CACD,iBAAiB,CAAC,UAAU,OAAO;CACnC,UAAU;EACR,OAAO;GACL,OAAO;GACP,MAAM;GACN,WAAW;GACZ;EACD,MAAM;GACJ,OAAO;GACP,MAAM;GACP;EACF;CACF,CAAC"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@contractspec/module.notifications",
+  "version": "0.0.0-canary-20260113162409",
+  "description": "Notification center module for ContractSpec applications",
+  "keywords": [
+    "contractspec",
+    "notifications",
+    "messaging",
+    "channels",
+    "email",
+    "typescript"
+  ],
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "publish:pkg": "bun publish --tolerate-republish --ignore-scripts --verbose",
+    "publish:pkg:canary": "bun publish:pkg --tag canary",
+    "build": "bun build:types && bun build:bundle",
+    "build:bundle": "tsdown",
+    "build:types": "tsc --noEmit",
+    "dev": "bun build:bundle --watch",
+    "clean": "rimraf dist .turbo",
+    "lint": "bun lint:fix",
+    "lint:fix": "eslint src --fix",
+    "lint:check": "eslint src"
+  },
+  "dependencies": {
+    "@contractspec/lib.schema": "0.0.0-canary-20260113162409",
+    "@contractspec/lib.contracts": "0.0.0-canary-20260113162409",
+    "@contractspec/lib.bus": "0.0.0-canary-20260113162409",
+    "zod": "^4.3.5"
+  },
+  "devDependencies": {
+    "@contractspec/tool.typescript": "0.0.0-canary-20260113162409",
+    "@contractspec/tool.tsdown": "0.0.0-canary-20260113162409",
+    "typescript": "^5.9.3"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./channels": "./dist/channels/index.js",
+    "./contracts": "./dist/contracts/index.js",
+    "./entities": "./dist/entities/index.js",
+    "./notifications.capability": "./dist/notifications.capability.js",
+    "./notifications.feature": "./dist/notifications.feature.js",
+    "./templates": "./dist/templates/index.js",
+    "./*": "./*"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": "./dist/index.js",
+      "./channels": "./dist/channels/index.js",
+      "./contracts": "./dist/contracts/index.js",
+      "./entities": "./dist/entities/index.js",
+      "./notifications.feature": "./dist/notifications.feature.js",
+      "./templates": "./dist/templates/index.js",
+      "./*": "./*"
+    },
+    "registry": "https://registry.npmjs.org/"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lssm-tech/contractspec.git",
+    "directory": "packages/modules/notifications"
+  },
+  "homepage": "https://contractspec.io"
+}