@quickscores/chat 0.1.0 → 0.1.1

package/README.md

@@ -1,158 +1,38 @@
-# QuickScores Chat Service
+# @quickscores/chat
 
-Supabase-backed chat for QuickScores. Consumers: React Native (Android/iOS) and web app.
+Shared TypeScript types and Zod schemas for the QuickScores chat API. Use from React Native or web apps that call the chat endpoints.
 
-## What’s in this repo
-
-- **Supabase**: config, migrations, and Edge Functions for chat (DB, RLS, Realtime).
-- **Shared types**: TypeScript types and Zod schemas in `src/types/` for use by RN and web clients.
-
-## Prerequisites
-
-- [Supabase CLI](https://supabase.com/docs/guides/cli) (`npm i -g supabase` or `npx supabase`)
-- Node.js 20+
-- A [Supabase project](https://supabase.com/dashboard) (for remote; optional for local-only)
-
-## Setup
+## Install
 
 ```bash
-npm install
+npm install @quickscores/chat
 ```
 
-### Local Supabase (optional)
-
-```bash
-npx supabase start
+## Usage
+
+```ts
+import {
+  threadSchema,
+  threadKindSchema,
+  threadListRowSchema,
+  messageSchema,
+  type Thread,
+  type ThreadKind,
+  type ThreadListRow,
+  type Message,
+  type CreateThreadBody,
+  type SendMessageBody,
+  type ThreadResponse,
+  type MessageResponse,
+  type ErrorResponse,
+} from "@quickscores/chat";
 ```
 
-Use the printed URLs for local API, Studio, and DB. Link to a remote project when ready:
-
-```bash
-npx supabase link --project-ref <your-project-ref>
-```
-
-### Migrations
-
-- Create: put SQL in `supabase/migrations/` with timestamped names (e.g. `20240202120000_create_chat_tables.sql`), or use `npm run db:diff` after changing schema locally.
-- Apply locally: `npx supabase db reset` (reset + seed) or run migrations manually.
-- Push to remote: `npm run db:migrate` (or `npx supabase db push`).
-
-### Deploy to Supabase
-
-1. **Create a project** at [supabase.com/dashboard](https://supabase.com/dashboard) if you don’t have one. Note the **Project ref** (in Settings → General).
-
-2. **Link** the repo to that project (one-time):
-   ```bash
-   npx supabase link --project-ref <your-project-ref>
-   ```
-   Use your database password when prompted (from Dashboard → Settings → Database).
-
-3. **Push migrations** (schema + RLS):
-   ```bash
-   npm run db:migrate
-   ```
-   or `npx supabase db push`.
-
-4. **Deploy Edge Functions** (chat REST API):
-   ```bash
-   npx supabase functions deploy
-   ```
-   This deploys all functions in `supabase/functions/` (e.g. `chat-thread`, `chat-send-message`, `chat-mark-read`). To deploy a single function: `npx supabase functions deploy chat-thread`.
-
-5. **Set secrets** (if your functions need them): in Dashboard → Edge Functions → Secrets, or:
-   ```bash
-   npx supabase secrets set SUPABASE_SERVICE_ROLE_KEY=<your-service-role-key>
-   ```
-   The hosted project already has `SUPABASE_URL` and `SUPABASE_SERVICE_ROLE_KEY` set by default for deployed functions; you only need to add custom secrets.
-
-Your API base URL will be `https://<project-ref>.supabase.co/functions/v1`. Use that in clients instead of `http://127.0.0.1:54321/functions/v1`.
-
-## Scripts
-
-| Script          | Description                          |
-|-----------------|--------------------------------------|
-| `npm run db:start`  | Start local Supabase stack           |
-| `npm run db:stop`   | Stop local Supabase                  |
-| `npm run db:reset`  | Reset DB and run migrations + seed   |
-| `npm run db:migrate`| Push migrations to linked project    |
-| `npm run db:diff`   | Generate migration from schema diff  |
-| `npm run build`       | Build types package to `dist/` (for publish) |
-| `npm run types:check` | TypeScript check (no emit)        |
-| `npm run lint`      | Prettier check                       |
-| `npm run lint:fix`  | Prettier fix                         |
-
-## Using shared types in the app
-
-From the React Native (or web) app:
-
-1. **Workspace / link** (if in a monorepo or same parent repo):
-   - Add in the app’s `package.json`: `"@quickscores/chat": "file:../chat"` (or your path).
-   - In this repo, run `npm run build` so `dist/` is present (the package entry point is the built output).
-   - Then: `import { threadSchema, type Thread, type Message, type ThreadListRow } from "@quickscores/chat";`
-   - REST request/response types: `CreateThreadBody`, `SendMessageBody`, `ThreadResponse`, `MessageResponse`, `ErrorResponse`, etc. (see `src/types/api.ts`).
-2. **From a registry**: Publish the types package (see below), then add `"@quickscores/chat": "^0.1.0"` and run `npm install`.
-
-Types are aligned with the Supabase schema and [docs/api-chat.md](docs/api-chat.md): `Thread` (chat_threads), `Message` (chat_messages), `ThreadListRow` (chat_thread_list view).
-
-### Publishing the types package to a registry
-
-The entire `src/` tree is built to `dist/` and only `dist/` is published (`"files": ["dist"]`). Supabase config, migrations, Edge Functions, scripts, and docs are not included in the tarball.
-
-1. **Build**: `npm run build` (or it runs automatically via `prepublishOnly` when you publish).
-2. **Allow publishing**: In `package.json`, set `"private": false` (or remove the `"private"` field).
-3. **Publish to npm** (see [Publishing to npm](#publishing-to-npm) below).
-
-Consumers then install with `"@quickscores/chat": "^0.1.0"` and import as before; they get types and Zod runtime from the published tarball only.
-
-#### Publishing to npm
-
-1. **Create the scope** (one-time): [npmjs.com/org/create](https://www.npmjs.com/org/create) and create the `quickscores` org (or use an existing org that will own the package).
-
-2. **Log in** (if you aren’t already):
-   ```bash
-   npm login
-   ```
-
-3. **Allow publishing**: In `package.json`, set `"private": false` (or remove the `"private"` field).
-
-4. **Publish** (build runs automatically via `prepublishOnly`):
-   ```bash
-   npm publish --access public
-   ```
-   Scoped packages (`@quickscores/chat`) are private by default; `--access public` makes them installable by anyone without a paid plan.
-
-After that, anyone can run `npm install @quickscores/chat` with no extra config or tokens.
-
-## Project layout
-
-```
-chat/
-├── supabase/
-│   ├── config.toml       # Local Supabase config
-│   ├── migrations/       # SQL migrations (chat tables, RLS)
-│   ├── functions/        # Edge Functions (chat REST API)
-│   └── seed.sql          # Optional seed data
-├── src/
-│   └── types/            # Shared TypeScript + Zod (Thread, Message, ThreadListRow, REST API types)
-├── docs/
-│   ├── prd/              # Product requirements
-│   └── api-chat.md       # Chat REST API reference
-├── package.json
-├── tsconfig.json
-└── README.md
-```
-
-## Chat REST API
-
-We do **not** use Postgres RPCs for chat. The API is implemented as **REST HTTP endpoints** using Supabase Edge Functions: each action (get/create thread, send message, mark read) is a separate Edge Function. Clients use normal HTTP (e.g. `fetch` or `axios`).
-
-- **Docs:** [docs/api-chat.md](docs/api-chat.md)
-- **Endpoints:** `POST /functions/v1/chat-thread` (get/create thread), `chat-league-room`, `chat-team-room`, `chat-send-message`, `chat-mark-read`
-- **Auth:** Not enforced yet; use header `X-User-Id` (or body `user_id`) to identify the caller. Add JWT auth later.
+- **Domain types:** `Thread`, `ThreadKind`, `ThreadListRow`, `Message` — use with the matching Zod schemas for validation.
+- **API types:** `CreateThreadBody`, `LeagueRoomBody`, `TeamRoomBody`, `SendMessageBody`, `MarkReadBody`, `ThreadResponse`, `MessageResponse`, `MarkReadResponse`, `ErrorResponse` — for request/response typing.
 
-Run locally: `npx supabase start` then `npx supabase functions serve`. See [docs/api-chat.md](docs/api-chat.md#testing) for how to test (curl examples and `npm run test:api`).
+Types and schemas stay in sync with the chat backend and [API docs](https://github.com/quickscores/App2.0-Chat/blob/main/docs/api-chat.md) in the source repo.
 
-## Next steps
+## Repository
 
-1. Add auth: validate JWT in Edge Functions and use `auth.uid()` instead of `X-User-Id`.
-2. In the RN/app, call the chat endpoints and use types from `@quickscores/chat` (see [docs/api-chat.md](docs/api-chat.md)).
+Source and backend docs: [github.com/quickscores/App2.0-Chat](https://github.com/quickscores/App2.0-Chat). If you’re developing this package or the chat service, see [DEVELOPING.md](https://github.com/quickscores/App2.0-Chat/blob/main/DEVELOPING.md) in the repo.

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@quickscores/chat",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": false,
   "description": "Shared chat types and Zod schemas for QuickScores (RN, web)",
   "main": "./dist/types/index.js",
   "types": "./dist/types/index.d.ts",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "prepublishOnly": "npm run build",