@molecule/api-resource-meeting 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,348 @@
+<!--
+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-08-04T01:49:15.618Z
+-->
+
+# @molecule/api-resource-meeting
+
+> **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.
+
+`@molecule/api-resource-meeting` — meeting CRUD + action items.
+
+Tracks scheduled/in_progress/completed/cancelled meetings with
+attendees, optional recording URL, transcript, and AI-friendly
+summary slot. Action items nest under meetings and track
+completion + assignee + due date + source excerpt.
+
+Extracted from the ai-meeting-notes flagship.
+
+## Quick Start
+
+```ts
+import { createMeetingRouter } from '@molecule/api-resource-meeting'
+app.use('/meetings', createMeetingRouter())
+// GET|POST / · GET|PUT|DELETE /:id
+// GET|POST /:id/action-items · PUT|DELETE /:id/action-items/:itemId
+```
+
+```ts
+import { createActionItem, createMeetingForOwner } from '@molecule/api-resource-meeting'
+
+const meeting = await createMeetingForOwner(userId, {
+  title: 'Sprint planning',
+  scheduled_at: '2026-08-01T10:00:00Z',
+})
+await createActionItem(meeting.id, userId, { description: 'Send recap' })
+```
+
+## Type
+
+`resource`
+
+## Installation
+
+```bash
+npm install @molecule/api-resource-meeting @molecule/api-bonds-default-express @molecule/api-database @molecule/api-i18n @molecule/api-middleware-validation express zod
+npm install -D @types/express
+```
+
+## API
+
+### Interfaces
+
+#### `ActionItemRow`
+
+Raw database row shape for an action item linked to a meeting.
+
+```typescript
+interface ActionItemRow {
+  id: string
+  meeting_id: string
+  description: string
+  assignee: string | null
+  due_date: string | Date | null
+  is_completed: boolean
+  source_excerpt: string | null
+  created_at: string | Date
+  updated_at: string | Date
+}
+```
+
+#### `MeetingRow`
+
+Raw database row shape for a meeting record.
+
+```typescript
+interface MeetingRow {
+  id: string
+  owner_id: string
+  title: string
+  description: string | null
+  status: MeetingStatus
+  scheduled_at: string | Date | null
+  started_at: string | Date | null
+  ended_at: string | Date | null
+  duration_seconds: number
+  recording_url: string | null
+  transcript: string | null
+  summary: string | null
+  attendees: Array<{ name: string; email?: string }>
+  created_at: string | Date
+  updated_at: string | Date
+}
+```
+
+### Types
+
+#### `MeetingStatus`
+
+Lifecycle states a meeting can occupy from creation through completion.
+
+```typescript
+type MeetingStatus = 'scheduled' | 'in_progress' | 'completed' | 'cancelled'
+```
+
+### Functions
+
+#### `createActionItem(meetingId, ownerId, data)`
+
+Creates a new action item under a meeting owned by the given owner; returns the inserted row or null if the meeting is not found/owned.
+
+```typescript
+function createActionItem(
+  meetingId: string,
+  ownerId: string,
+  data: {
+    description: string
+    assignee?: string | null
+    due_date?: string | null
+    source_excerpt?: string | null
+  },
+): Promise<ActionItemRow | null>
+```
+
+#### `createMeetingForOwner(ownerId, data)`
+
+Creates a new meeting record owned by the given owner and returns the inserted row.
+
+```typescript
+function createMeetingForOwner(
+  ownerId: string,
+  data: {
+    title: string
+    description?: string | null
+    scheduled_at?: string | null
+    attendees?: Array<{ name: string; email?: string }>
+  },
+): Promise<MeetingRow>
+```
+
+#### `createMeetingRouter()`
+
+Creates and returns an Express Router with all meeting and action-item CRUD routes.
+
+```typescript
+function createMeetingRouter(): Router
+```
+
+#### `deleteActionItem(itemId, meetingId, ownerId)`
+
+Deletes an action item by ID if its parent meeting belongs to the given owner; returns true on success, false if not found or not owned.
+
+```typescript
+function deleteActionItem(itemId: string, meetingId: string, ownerId: string): Promise<boolean>
+```
+
+#### `deleteMeetingForOwner(meetingId, ownerId)`
+
+Deletes a meeting by ID if it belongs to the given owner; returns true on success, false if not found or not owned.
+
+```typescript
+function deleteMeetingForOwner(meetingId: string, ownerId: string): Promise<boolean>
+```
+
+#### `getMeetingForOwner(meetingId, ownerId)`
+
+Fetches a single meeting by ID, returning null if it does not exist or does not belong to the owner.
+
+```typescript
+function getMeetingForOwner(meetingId: string, ownerId: string): Promise<MeetingRow | null>
+```
+
+#### `listActionItems(meetingId, ownerId)`
+
+Returns all action items for a meeting in creation order, or null if the meeting is not found/owned.
+
+```typescript
+function listActionItems(meetingId: string, ownerId: string): Promise<ActionItemRow[] | null>
+```
+
+#### `listMeetingsForOwner(ownerId, opts?)`
+
+Returns a paginated list of meetings belonging to the given owner, optionally filtered by status.
+
+```typescript
+function listMeetingsForOwner(
+  ownerId: string,
+  opts?: { status?: MeetingStatus; page?: number; limit?: number },
+): Promise<{ data: MeetingRow[]; total: number }>
+```
+
+#### `updateActionItem(itemId, meetingId, ownerId, patch)`
+
+Applies a partial patch to an action item; returns the updated row or null if the meeting or item is not found/owned.
+
+```typescript
+function updateActionItem(
+  itemId: string,
+  meetingId: string,
+  ownerId: string,
+  patch: Partial<ActionItemRow>,
+): Promise<ActionItemRow | null>
+```
+
+#### `updateMeetingForOwner(meetingId, ownerId, patch)`
+
+Applies a partial patch to a meeting, recomputing duration_seconds when both timestamps are present, and returns the updated row or null if not found/owned.
+
+```typescript
+function updateMeetingForOwner(
+  meetingId: string,
+  ownerId: string,
+  patch: Partial<MeetingRow>,
+): Promise<MeetingRow | null>
+```
+
+### Constants
+
+#### `actionItemCreateSchema`
+
+Zod schema for validating action item creation payloads.
+
+```typescript
+const actionItemCreateSchema: z.ZodObject<
+  {
+    description: z.ZodString
+    assignee: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    due_date: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    source_excerpt: z.ZodOptional<z.ZodNullable<z.ZodString>>
+  },
+  z.core.$strip
+>
+```
+
+#### `actionItemUpdateSchema`
+
+Zod schema for validating action item update payloads.
+
+```typescript
+const actionItemUpdateSchema: z.ZodObject<
+  {
+    description: z.ZodOptional<z.ZodString>
+    assignee: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>
+    due_date: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>
+    source_excerpt: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>
+    is_completed: z.ZodOptional<z.ZodBoolean>
+  },
+  z.core.$strip
+>
+```
+
+#### `MEETING_STATUSES`
+
+All valid status values a meeting can be in.
+
+```typescript
+const MEETING_STATUSES: readonly ['scheduled', 'in_progress', 'completed', 'cancelled']
+```
+
+#### `meetingCreateSchema`
+
+Zod schema for validating meeting creation payloads.
+
+```typescript
+const meetingCreateSchema: z.ZodObject<
+  {
+    title: z.ZodString
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    scheduled_at: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    attendees: z.ZodOptional<
+      z.ZodArray<
+        z.ZodObject<{ name: z.ZodString; email: z.ZodOptional<z.ZodString> }, z.core.$strip>
+      >
+    >
+  },
+  z.core.$strip
+>
+```
+
+#### `meetingUpdateSchema`
+
+Zod schema for validating meeting update payloads.
+
+```typescript
+const meetingUpdateSchema: z.ZodObject<
+  {
+    title: z.ZodOptional<z.ZodString>
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    status: z.ZodOptional<
+      z.ZodEnum<{
+        scheduled: 'scheduled'
+        in_progress: 'in_progress'
+        completed: 'completed'
+        cancelled: 'cancelled'
+      }>
+    >
+    scheduled_at: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    started_at: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    ended_at: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    recording_url: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    transcript: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    summary: z.ZodOptional<z.ZodNullable<z.ZodString>>
+    attendees: z.ZodOptional<
+      z.ZodArray<
+        z.ZodObject<{ name: z.ZodString; email: z.ZodOptional<z.ZodString> }, z.core.$strip>
+      >
+    >
+  },
+  z.core.$strip
+>
+```
+
+## Injection Notes
+
+### Requirements
+
+Peer dependencies:
+
+- `@molecule/api-bonds-default-express` ^1.0.1
+- `@molecule/api-database` ^1.0.1
+- `@molecule/api-i18n` ^1.0.1
+- `@molecule/api-middleware-validation` ^1.0.1
+- `express` ^5.0.0
+- `zod` ^4.0.0
+
+### Runtime Dependencies
+
+- `@molecule/api-bonds-default-express`
+- `@molecule/api-database`
+- `@molecule/api-i18n`
+- `@molecule/api-middleware-validation`
+- `express`
+- `zod`
+
+Tables: `src/__setup__/meetings.sql` creates `meetings` +
+`meeting_action_items`. An mlcl-scaffolded API replays `__setup__/*.sql`
+automatically on migrate; anywhere else run it once — nothing at runtime
+creates them.
+
+The router does not authenticate — it reads the caller from
+`res.locals.session` (populated by your global auth middleware) and 401s
+without a session. All service functions are owner-scoped
+(`…ForOwner(…, ownerId)` / `(meetingId, ownerId, …)`) and return `null`
+for rows the caller doesn't own — always pass the AUTHENTICATED user's id.

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@molecule/api-resource-meeting",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Meeting capture + transcription + action-item extraction",
+  "homepage": "https://www.molecule.dev/packages/api-resource-meeting",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,7 +18,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "keywords": [
     "molecule",
@@ -27,19 +29,24 @@
     "resource"
   ],
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/molecule-dev/molecule.git",
+    "directory": "packages/api/resources/meeting"
+  },
   "devDependencies": {
     "@types/express": "5.0.6",
     "@types/node": "26.1.2",
     "express": "5.2.1",
     "typescript": "6.0.3",
-    "vitest": "4.1.10",
+    "vitest": "4.1.11",
     "zod": "4.4.3"
   },
   "peerDependencies": {
-    "@molecule/api-bonds-default-express": "^1.0.0",
-    "@molecule/api-database": "^1.0.0",
-    "@molecule/api-i18n": "^1.0.0",
-    "@molecule/api-middleware-validation": "^1.0.0",
+    "@molecule/api-bonds-default-express": "^1.0.1",
+    "@molecule/api-database": "^1.0.1",
+    "@molecule/api-i18n": "^1.0.1",
+    "@molecule/api-middleware-validation": "^1.0.1",
     "express": "^5.0.0",
     "zod": "^4.0.0"
   }