@molecule/api-resource-comment 1.1.2 → 1.1.4

package/README.md

@@ -3,20 +3,25 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
 Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
 Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
 To change this document, edit the module-level JSDoc in src/index.ts.
-Generated: 2026-10-16T00:32:13.746Z
+Generated: 2026-10-17T20:52:27.537Z
 -->
 
 # @molecule/api-resource-comment
 
-> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
-> It is written to be read by coding agents as much as by people, and is generated from this
-> package's source — edit `src/index.ts` JSDoc, not this file.
-
 Threaded comments resource for molecule.dev.
 
 Polymorphic comments that attach to any resource type. Supports threaded
 replies, pagination, and ownership-based authorization.
 
+**Tables this package owns: `comments` and `comment_numbers`.** A comment row is found by its
+`comments.id` (a UUID); `comment_numbers` gives it the sequential integer many clients address it
+by, and the join between the two is `comment_numbers.commentId` = `comments.id` (declared FK,
+`ON DELETE CASCADE`) — one row per numbered comment, never a mapping table of your own.
+
+> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
+> It is written to be read by coding agents as much as by people, and is generated from this
+> package's source — edit `src/index.ts` JSDoc, not this file.
+
 ## Quick Start
 
 ```typescript
@@ -493,9 +498,12 @@ Peer dependencies:
   from `@molecule/app-http` normalizes this envelope (pass it the whole HttpResponse), so
   the rows come back; reading the response as a bare array — or `res.data` alone (which is
   the envelope) — yields an EMPTY list.
-- **Migration required.** `src/__setup__/comments.sql` ships with this package
-  and must exist in the target database before use (scaffolded apps apply it
-  automatically; existing apps must apply it first).
+- **A scaffold that lists this package already has these tables** — its `__setup__` SQL is
+  copied into the app at create time and replayed on every boot, so do not copy it into
+  `api/migrations/` yourself; only a package added after the scaffold needs that.
+  `src/__setup__/comments.sql` ships with this package and must exist in the target
+  database before use (scaffolded apps apply it automatically; existing apps must apply it
+  first).
 - **Integer comment ids (RealWorld's `comment.id`, most public API specs):** keep the
   UUID and give each comment a sequential number — `createNumberedComment()` creates both
   in one transaction, `getCommentByNumber(n)` finds it, `commentNumbers(ids)` maps a list.

package/dist/index.d.ts

@@ -4,6 +4,11 @@
  * Polymorphic comments that attach to any resource type. Supports threaded
  * replies, pagination, and ownership-based authorization.
  *
+ * **Tables this package owns: `comments` and `comment_numbers`.** A comment row is found by its
+ * `comments.id` (a UUID); `comment_numbers` gives it the sequential integer many clients address it
+ * by, and the join between the two is `comment_numbers.commentId` = `comments.id` (declared FK,
+ * `ON DELETE CASCADE`) — one row per numbered comment, never a mapping table of your own.
+ *
  * @module
  * @example
  * ```typescript
@@ -25,9 +30,12 @@
  *   from `@molecule/app-http` normalizes this envelope (pass it the whole HttpResponse), so
  *   the rows come back; reading the response as a bare array — or `res.data` alone (which is
  *   the envelope) — yields an EMPTY list.
- * - **Migration required.** `src/__setup__/comments.sql` ships with this package
- *   and must exist in the target database before use (scaffolded apps apply it
- *   automatically; existing apps must apply it first).
+ * - **A scaffold that lists this package already has these tables** — its `__setup__` SQL is
+ *   copied into the app at create time and replayed on every boot, so do not copy it into
+ *   `api/migrations/` yourself; only a package added after the scaffold needs that.
+ *   `src/__setup__/comments.sql` ships with this package and must exist in the target
+ *   database before use (scaffolded apps apply it automatically; existing apps must apply it
+ *   first).
  * - **Integer comment ids (RealWorld's `comment.id`, most public API specs):** keep the
  *   UUID and give each comment a sequential number — `createNumberedComment()` creates both
  *   in one transaction, `getCommentByNumber(n)` finds it, `commentNumbers(ids)` maps a list.

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AAEH,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,cAAc,CAAA;AAC5B,cAAc,wBAAwB,CAAA;AACtC,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsEG;AAEH,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,cAAc,CAAA;AAC5B,cAAc,wBAAwB,CAAA;AACtC,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA"}

package/dist/index.js

@@ -4,6 +4,11 @@
  * Polymorphic comments that attach to any resource type. Supports threaded
  * replies, pagination, and ownership-based authorization.
  *
+ * **Tables this package owns: `comments` and `comment_numbers`.** A comment row is found by its
+ * `comments.id` (a UUID); `comment_numbers` gives it the sequential integer many clients address it
+ * by, and the join between the two is `comment_numbers.commentId` = `comments.id` (declared FK,
+ * `ON DELETE CASCADE`) — one row per numbered comment, never a mapping table of your own.
+ *
  * @module
  * @example
  * ```typescript
@@ -25,9 +30,12 @@
  *   from `@molecule/app-http` normalizes this envelope (pass it the whole HttpResponse), so
  *   the rows come back; reading the response as a bare array — or `res.data` alone (which is
  *   the envelope) — yields an EMPTY list.
- * - **Migration required.** `src/__setup__/comments.sql` ships with this package
- *   and must exist in the target database before use (scaffolded apps apply it
- *   automatically; existing apps must apply it first).
+ * - **A scaffold that lists this package already has these tables** — its `__setup__` SQL is
+ *   copied into the app at create time and replayed on every boot, so do not copy it into
+ *   `api/migrations/` yourself; only a package added after the scaffold needs that.
+ *   `src/__setup__/comments.sql` ships with this package and must exist in the target
+ *   database before use (scaffolded apps apply it automatically; existing apps must apply it
+ *   first).
  * - **Integer comment ids (RealWorld's `comment.id`, most public API specs):** keep the
  *   UUID and give each comment a sequential number — `createNumberedComment()` creates both
  *   in one transaction, `getCommentByNumber(n)` finds it, `commentNumbers(ids)` maps a list.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@molecule/api-resource-comment",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Threaded comments on any resource with polymorphic attachment and pagination",
   "type": "module",
   "main": "dist/index.js",
@@ -29,8 +29,8 @@
   ],
   "license": "Apache-2.0",
   "devDependencies": {
-    "@molecule/api-database": "1.1.1",
-    "@molecule/api-database-sqlite": "1.2.2",
+    "@molecule/api-database": "1.1.3",
+    "@molecule/api-database-sqlite": "1.2.6",
     "@types/node": "26.1.2",
     "typescript": "6.0.3",
     "vitest": "4.1.11",