@happyvertical/smrt-comments 0.0.0-stage → 0.55.10

package/dist/manifest.json

@@ -0,0 +1,474 @@
+{
+  "version": "1.0.0",
+  "timestamp": 0,
+  "packageName": "@happyvertical/smrt-comments",
+  "packageVersion": "0.55.10",
+  "objects": {
+    "@happyvertical/smrt-comments:CommentCollection": {
+      "name": "commentcollection",
+      "className": "CommentCollection",
+      "qualifiedName": "@happyvertical/smrt-comments:CommentCollection",
+      "collection": "comments",
+      "filePath": "/home/runner/work/smrt/smrt/packages/comments/src/collections/CommentCollection.ts",
+      "packageName": "@happyvertical/smrt-comments",
+      "fields": {},
+      "methods": {
+        "listForRecord": {
+          "name": "listForRecord",
+          "async": true,
+          "parameters": [
+            {
+              "name": "recordType",
+              "type": "string",
+              "optional": false
+            },
+            {
+              "name": "recordId",
+              "type": "string",
+              "optional": false
+            }
+          ],
+          "returnType": "Promise<Comment[]>",
+          "isStatic": false,
+          "isPublic": true
+        }
+      },
+      "decoratorConfig": {
+        "tableName": "record_comments",
+        "api": false,
+        "mcp": false,
+        "cli": false
+      },
+      "extends": "SmrtCollection",
+      "extendsTypeArg": "Comment",
+      "exportName": "CommentCollection",
+      "collectionExportName": "CommentCollectionCollection",
+      "schema": {
+        "tableName": "record_comments",
+        "ddl": "CREATE TABLE IF NOT EXISTS \"record_comments\" (\n  \"id\" UUID PRIMARY KEY NOT NULL,\n  \"slug\" TEXT NOT NULL,\n  \"context\" TEXT NOT NULL DEFAULT '',\n  \"created_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"updated_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"meta_type\" TEXT NOT NULL,\n  \"meta_id\" TEXT NOT NULL,\n  \"role\" TEXT NOT NULL,\n  \"sort_order\" INTEGER DEFAULT 0,\n  \"tenant_id\" UUID NOT NULL,\n  \"author_user_id\" UUID NOT NULL,\n  \"body\" TEXT NOT NULL,\n  \"mentions\" TEXT\n);",
+        "columns": {
+          "id": {
+            "type": "UUID",
+            "primaryKey": true,
+            "referenceKind": "id",
+            "notNull": true
+          },
+          "slug": {
+            "type": "TEXT",
+            "notNull": true
+          },
+          "context": {
+            "type": "TEXT",
+            "notNull": true,
+            "default": ""
+          },
+          "created_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "updated_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "meta_type": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "meta_id": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "role": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "sort_order": {
+            "type": "INTEGER",
+            "notNull": false,
+            "unique": false,
+            "default": 0
+          },
+          "tenant_id": {
+            "type": "UUID",
+            "referenceKind": "tenantId",
+            "notNull": true,
+            "unique": false
+          },
+          "author_user_id": {
+            "type": "UUID",
+            "referenceKind": "crossPackageRef",
+            "notNull": true,
+            "unique": false
+          },
+          "body": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "mentions": {
+            "type": "TEXT",
+            "notNull": false,
+            "unique": false
+          }
+        },
+        "indexes": [
+          {
+            "name": "record_comments_slug_context_idx",
+            "columns": [
+              "tenant_id",
+              "slug",
+              "context"
+            ],
+            "unique": true
+          },
+          {
+            "name": "record_comments_record_created_idx",
+            "columns": [
+              "tenant_id",
+              "meta_type",
+              "meta_id",
+              "created_at"
+            ]
+          },
+          {
+            "name": "record_comments_tenant_id_created_at_idx",
+            "columns": [
+              "tenant_id",
+              "created_at"
+            ]
+          },
+          {
+            "name": "record_comments_meta_type_meta_id_idx",
+            "columns": [
+              "meta_type",
+              "meta_id"
+            ]
+          },
+          {
+            "name": "record_comments_author_user_id_idx",
+            "columns": [
+              "author_user_id"
+            ]
+          }
+        ],
+        "version": "78644ad4"
+      },
+      "importPath": "@happyvertical/smrt-comments"
+    },
+    "@happyvertical/smrt-comments:Comment": {
+      "name": "comment",
+      "className": "Comment",
+      "qualifiedName": "@happyvertical/smrt-comments:Comment",
+      "collection": "comments",
+      "filePath": "/home/runner/work/smrt/smrt/packages/comments/src/models/Comment.ts",
+      "packageName": "@happyvertical/smrt-comments",
+      "fields": {
+        "metaType": {
+          "type": "text",
+          "required": true,
+          "_meta": {
+            "required": true
+          }
+        },
+        "metaId": {
+          "type": "text",
+          "required": true,
+          "_meta": {
+            "required": true
+          }
+        },
+        "role": {
+          "type": "text",
+          "required": true,
+          "_meta": {
+            "required": true
+          }
+        },
+        "sortOrder": {
+          "type": "integer",
+          "required": false,
+          "default": 0
+        },
+        "tenantId": {
+          "type": "text",
+          "required": true,
+          "_meta": {
+            "sqlType": "UUID",
+            "__tenancy": {
+              "isTenantIdField": true,
+              "autoFilter": true,
+              "required": true,
+              "autoPopulate": true,
+              "nullable": false,
+              "mode": "required",
+              "field": "tenantId",
+              "allowSuperAdminBypass": false
+            }
+          }
+        },
+        "authorUserId": {
+          "type": "crossPackageRef",
+          "required": true,
+          "related": "@happyvertical/smrt-users:User"
+        },
+        "body": {
+          "type": "text",
+          "required": true,
+          "_meta": {
+            "required": true
+          }
+        },
+        "mentions": {
+          "type": "text",
+          "required": false
+        }
+      },
+      "methods": {
+        "hydrate": {
+          "name": "hydrate",
+          "async": true,
+          "parameters": [],
+          "returnType": "Promise<T | null>",
+          "isStatic": false,
+          "isPublic": true
+        }
+      },
+      "decoratorConfig": {
+        "tableName": "record_comments",
+        "api": false,
+        "mcp": false,
+        "cli": false,
+        "indexes": [
+          {
+            "name": "record_comments_record_created_idx",
+            "columns": [
+              "tenantId",
+              "metaType",
+              "metaId",
+              "createdAt"
+            ]
+          }
+        ],
+        "tenantScoped": {
+          "mode": "required"
+        },
+        "conflictColumns": [
+          "tenant_id",
+          "slug",
+          "context"
+        ]
+      },
+      "extends": "SmrtPolymorphicAssociation",
+      "exportName": "Comment",
+      "collectionExportName": "CommentCollection",
+      "validationRules": [
+        {
+          "field": "metaType",
+          "rule": "required",
+          "fieldType": "text"
+        },
+        {
+          "field": "metaId",
+          "rule": "required",
+          "fieldType": "text"
+        },
+        {
+          "field": "role",
+          "rule": "required",
+          "fieldType": "text"
+        },
+        {
+          "field": "authorUserId",
+          "rule": "required",
+          "fieldType": "crossPackageRef"
+        },
+        {
+          "field": "body",
+          "rule": "required",
+          "fieldType": "text"
+        }
+      ],
+      "schema": {
+        "tableName": "record_comments",
+        "ddl": "CREATE TABLE IF NOT EXISTS \"record_comments\" (\n  \"id\" UUID PRIMARY KEY NOT NULL,\n  \"slug\" TEXT NOT NULL,\n  \"context\" TEXT NOT NULL DEFAULT '',\n  \"created_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"updated_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"meta_type\" TEXT NOT NULL,\n  \"meta_id\" TEXT NOT NULL,\n  \"role\" TEXT NOT NULL,\n  \"sort_order\" INTEGER DEFAULT 0,\n  \"tenant_id\" UUID NOT NULL,\n  \"author_user_id\" UUID NOT NULL,\n  \"body\" TEXT NOT NULL,\n  \"mentions\" TEXT\n);",
+        "columns": {
+          "id": {
+            "type": "UUID",
+            "primaryKey": true,
+            "referenceKind": "id",
+            "notNull": true
+          },
+          "slug": {
+            "type": "TEXT",
+            "notNull": true
+          },
+          "context": {
+            "type": "TEXT",
+            "notNull": true,
+            "default": ""
+          },
+          "created_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "updated_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "meta_type": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "meta_id": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "role": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "sort_order": {
+            "type": "INTEGER",
+            "notNull": false,
+            "unique": false,
+            "default": 0
+          },
+          "tenant_id": {
+            "type": "UUID",
+            "referenceKind": "tenantId",
+            "notNull": true,
+            "unique": false
+          },
+          "author_user_id": {
+            "type": "UUID",
+            "referenceKind": "crossPackageRef",
+            "notNull": true,
+            "unique": false
+          },
+          "body": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "mentions": {
+            "type": "TEXT",
+            "notNull": false,
+            "unique": false
+          }
+        },
+        "indexes": [
+          {
+            "name": "record_comments_slug_context_idx",
+            "columns": [
+              "tenant_id",
+              "slug",
+              "context"
+            ],
+            "unique": true
+          },
+          {
+            "name": "record_comments_record_created_idx",
+            "columns": [
+              "tenant_id",
+              "meta_type",
+              "meta_id",
+              "created_at"
+            ]
+          },
+          {
+            "name": "record_comments_tenant_id_created_at_idx",
+            "columns": [
+              "tenant_id",
+              "created_at"
+            ]
+          },
+          {
+            "name": "record_comments_meta_type_meta_id_idx",
+            "columns": [
+              "meta_type",
+              "meta_id"
+            ]
+          },
+          {
+            "name": "record_comments_author_user_id_idx",
+            "columns": [
+              "author_user_id"
+            ]
+          }
+        ],
+        "version": "78644ad4"
+      },
+      "importPath": "@happyvertical/smrt-comments"
+    }
+  },
+  "moduleType": "smrt",
+  "recipes": [
+    {
+      "id": "comments.records",
+      "className": "RecordCommentsRecipe",
+      "label": "Record comments",
+      "summary": "Discuss work directly on the records it concerns.",
+      "synonyms": [
+        "comments",
+        "mentions",
+        "discussion"
+      ],
+      "models": [
+        "@happyvertical/smrt-comments:Comment"
+      ],
+      "nav": [],
+      "requires": [],
+      "group": {
+        "id": "comments",
+        "label": "Comments",
+        "summary": "Keep discussions alongside the records your team works on."
+      },
+      "help": {
+        "markdown": "## Overview\n\nRecord comments keep a discussion next to the work it concerns. Open a record\nyou can access to read its discussion or add a comment. Comments are part of\nthe record page, rather than a separate list of every discussion.\n\n## Tasks\n\n### Add a comment\n\nOpen the record, find Comments, write your message and choose Post comment.\nYour app controls who can read the record and who can contribute to its discussion.\n\n### Mention someone\n\nIf your app provides mention selection, choose a teammate who can access the\nrecord. When mention notifications are connected, that person receives a\nnotification. Typing a name alone does not select a recipient.\n\n### Check a failed post\n\nIf posting reports an error, refresh the discussion before trying again. A\ncomment may have been saved even when its mention notification could not be\ndelivered. If it appears in the discussion, do not post it a second time.\n",
+        "fieldRefs": []
+      },
+      "surfaces": [
+        {
+          "kind": "playground",
+          "export": "@happyvertical/smrt-comments/svelte#RecordCommentsPlayground",
+          "label": "Record discussion preview"
+        }
+      ],
+      "runtime": "both",
+      "demoSeed": {
+        "export": "@happyvertical/smrt-comments/svelte#recordCommentsDemo"
+      },
+      "demo": {
+        "mode": "server",
+        "reasons": [
+          "Needs a server because its package depends on @happyvertical/smrt-tenancy, which do not build for a browser (#3624)."
+        ]
+      }
+    }
+  ],
+  "smrtDependencies": [
+    "@happyvertical/smrt-core",
+    "@happyvertical/smrt-messages",
+    "@happyvertical/smrt-tenancy"
+  ],
+  "browser": {
+    "status": "server-only",
+    "issues": [
+      "#3624"
+    ],
+    "via": [
+      "@happyvertical/smrt-tenancy"
+    ]
+  },
+  "stampsConstructors": true
+}

package/dist/models/Comment.d.ts

@@ -0,0 +1,13 @@
+import { SmrtPolymorphicAssociation } from '@happyvertical/smrt-core';
+import type { CommentOptions } from '../types.js';
+export declare class Comment extends SmrtPolymorphicAssociation {
+    tenantId: string;
+    authorUserId: string;
+    body: string;
+    /** JSON array of referenced User UUIDs; use mentionUserIds for validation. */
+    mentions: string;
+    constructor(options?: CommentOptions);
+    get mentionUserIds(): string[];
+    set mentionUserIds(value: readonly string[]);
+}
+//# sourceMappingURL=Comment.d.ts.map

package/dist/models/Comment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Comment.d.ts","sourceRoot":"","sources":["../../src/models/Comment.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,0BAA0B,EAE3B,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAKlD,qBAaa,OAAQ,SAAQ,0BAA0B;IAErD,QAAQ,SAAM;IAGd,YAAY,SAAM;IAGlB,IAAI,SAAM;IAEV,8EAA8E;IAC9E,QAAQ,SAAQ;gBAEJ,OAAO,GAAE,cAAmB;IAWxC,IAAI,cAAc,IAAI,MAAM,EAAE,CAU7B;IAED,IAAI,cAAc,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAQ1C;CACF"}

package/dist/recipes.d.ts

@@ -0,0 +1,27 @@
+import { SmrtRecipe } from '@happyvertical/smrt-core';
+import { Comment } from './models/Comment.js';
+/** Discussion attached to any authorized business record. */
+export declare class RecordCommentsRecipe extends SmrtRecipe {
+    static id: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static group: {
+        id: string;
+        label: string;
+        summary: string;
+    };
+    static models: (typeof Comment)[];
+    static nav: never[];
+    static runtime: "both";
+    static surfaces: readonly [{
+        readonly kind: "playground";
+        readonly export: "@happyvertical/smrt-comments/svelte#RecordCommentsPlayground";
+        readonly label: "Record discussion preview";
+    }];
+    static demoSeed: {
+        readonly export: "@happyvertical/smrt-comments/svelte#recordCommentsDemo";
+    };
+    static help: string;
+}
+//# sourceMappingURL=recipes.d.ts.map

package/dist/recipes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../src/recipes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,6DAA6D;AAC7D,qBAAa,oBAAqB,SAAQ,UAAU;IAClD,MAAM,CAAC,EAAE,SAAsB;IAC/B,MAAM,CAAC,KAAK,SAAqB;IACjC,MAAM,CAAC,OAAO,SAAuD;IACrE,MAAM,CAAC,QAAQ,WAA0C;IACzD,MAAM,CAAC,KAAK;;;;MAIV;IACF,MAAM,CAAC,MAAM,qBAAa;IAE1B,MAAM,CAAC,GAAG,UAAM;IAChB,MAAM,CAAC,OAAO,EAAG,MAAM,CAAU;IACjC,MAAM,CAAC,QAAQ;;;;OAMJ;IACX,MAAM,CAAC,QAAQ;;MAEJ;IACX,MAAM,CAAC,IAAI,SAAkC;CAC9C"}

package/dist/services/CommentService.d.ts

@@ -0,0 +1,16 @@
+import type { SmrtClassOptions } from '@happyvertical/smrt-core';
+import { Comment } from '../models/Comment.js';
+import type { CommentActorContext, CommentMentionNotificationAdapter, CommentOptions, CommentRecordAccess } from '../types.js';
+export declare class CommentService {
+    private readonly options;
+    constructor(options: {
+        db: SmrtClassOptions['db'];
+        actor: CommentActorContext;
+        authorizeRecord: (access: CommentRecordAccess) => Promise<boolean>;
+        mentionNotifications?: CommentMentionNotificationAdapter;
+    });
+    private authorize;
+    listForRecord(recordType: string, recordId: string): Promise<Comment[]>;
+    create(commentOptions: CommentOptions): Promise<Comment>;
+}
+//# sourceMappingURL=CommentService.d.ts.map

package/dist/services/CommentService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommentService.d.ts","sourceRoot":"","sources":["../../src/services/CommentService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGjE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,KAAK,EACV,mBAAmB,EACnB,iCAAiC,EACjC,cAAc,EACd,mBAAmB,EACpB,MAAM,aAAa,CAAC;AAErB,qBAAa,cAAc;IAEvB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE;QACxB,EAAE,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC3B,KAAK,EAAE,mBAAmB,CAAC;QAC3B,eAAe,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QACnE,oBAAoB,CAAC,EAAE,iCAAiC,CAAC;KAC1D;YAGW,SAAS;IAsBjB,aAAa,CACjB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,EAAE,CAAC;IAUf,MAAM,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;CAgD/D"}

package/dist/services/mentionNotifications.d.ts

@@ -0,0 +1,18 @@
+import type { CommentMention, CommentMentionNotificationAdapter } from '../types.js';
+/** Structural subset implemented by smrt-messages UserNotificationService. */
+export interface CommentNotificationService {
+    notify(input: {
+        tenantId: string;
+        recipientUserId: string;
+        kind: string;
+        title: string;
+        body: string;
+        sourceRef: string;
+    }): Promise<unknown>;
+}
+/** Hosts must check recipient membership AND access to the referenced record. */
+export declare function createCommentMentionNotifications(options: {
+    notifications: CommentNotificationService;
+    canNotify: (mention: CommentMention) => Promise<boolean>;
+}): CommentMentionNotificationAdapter;
+//# sourceMappingURL=mentionNotifications.d.ts.map

package/dist/services/mentionNotifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mentionNotifications.d.ts","sourceRoot":"","sources":["../../src/services/mentionNotifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,iCAAiC,EAClC,MAAM,aAAa,CAAC;AAErB,8EAA8E;AAC9E,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,KAAK,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,EAAE,MAAM,CAAC;QACxB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACtB;AAED,iFAAiF;AACjF,wBAAgB,iCAAiC,CAAC,OAAO,EAAE;IACzD,aAAa,EAAE,0BAA0B,CAAC;IAC1C,SAAS,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1D,GAAG,iCAAiC,CAcpC"}