@transloadit/convex 0.0.5 → 0.0.6

package/README.md

@@ -80,7 +80,7 @@ assemblies 1 ──── * results
 ```
 
 - `assemblies`: one row per Transloadit Assembly (status/ok, notify URL, uploads, raw payload, etc).
-- `results`: one row per output file, keyed by `assemblyId` + `stepName`, plus normalized fields (name/size/mime/url) and the raw Transloadit output object.
+- `results`: one row per output file, grouped by `assemblyId` + `stepName` (a step can yield multiple rows). Each row includes normalized fields (name/size/mime/url), optional `resultId`, and the raw Transloadit output object.
 
 Lifecycle:
 1. `createAssembly` inserts the initial `assemblies` row.
@@ -151,200 +151,10 @@ For advanced/legacy helpers (raw parsing, low-level tus uploads, polling utiliti
 
 ## Example app (Next.js + Uppy wedding gallery)
 
-The `example/` app is a wedding gallery where guests upload photos + short videos. It uses Uppy on the client and Convex Auth (anonymous sign-in) to create assemblies securely. If you do not set `NEXT_PUBLIC_CONVEX_URL`, the example falls back to the in-process Convex test harness.
-Uploads are stored via Transloadit directly into Cloudflare R2.
-The client wiring uses the `useTransloaditUppy` hook from `@transloadit/convex/react` to keep Uppy + polling in sync.
+The `example/` app is a wedding gallery where guests upload photos + short videos. It uses Uppy on
+the client and Convex Auth (anonymous sign-in) to create assemblies securely. Uploads are stored via
+Transloadit directly into Cloudflare R2.
 
-Live demo:
+Live demo: `https://convex-demo.transload.it`
 
-```
-https://convex-demo.transload.it
-```
-
-Quick start (local):
-
-```bash
-# In repo root
-export TRANSLOADIT_KEY=...
-export TRANSLOADIT_SECRET=...
-export TRANSLOADIT_R2_CREDENTIALS=...
-
-# Get a public webhook URL (cloudflared is auto-downloaded if needed)
-yarn tunnel --once
-# Set TRANSLOADIT_NOTIFY_URL to the printed notifyUrl
-export TRANSLOADIT_NOTIFY_URL=...
-
-yarn example:dev
-```
-
-If you want the API routes to talk to an existing Convex deployment (bypassing Convex Auth), set:
-
-```bash
-export CONVEX_URL=...
-export CONVEX_ADMIN_KEY=...
-```
-
-The example exposes `POST /transloadit/webhook` and forwards webhooks into Convex via `queueWebhook`.
-Realtime “new upload” toasts use a Convex subscription on recent assemblies.
-The demo also applies a simple per-user upload limit in the Convex backend (see `example/convex/wedding.ts`).
-
-### Storage (required R2 persistence)
-
-The example uses the `/cloudflare/store` robot to write processed files into Cloudflare R2. Configure one of these:
-
-```bash
-# Option A: Transloadit template credentials (recommended)
-export TRANSLOADIT_R2_CREDENTIALS=...
-
-# Option B: supply R2 details directly
-export R2_BUCKET=...
-export R2_ACCESS_KEY_ID=...
-export R2_SECRET_ACCESS_KEY=...
-export R2_ACCOUNT_ID=...   # or R2_HOST
-export R2_PUBLIC_URL=...   # optional public URL prefix
-```
-
-The UI hides older items based on `NEXT_PUBLIC_GALLERY_RETENTION_HOURS` (default: 24) to discourage spam/abuse.
-The demo bucket auto-expires objects after 1 day via an R2 lifecycle rule (reapply with `yarn r2:lifecycle` or override with `R2_RETENTION_DAYS`).
-Preview deployments reset data on each deploy. The demo is built with
-[`@transloadit/convex`](https://github.com/transloadit/convex) and
-[Transloadit](https://transloadit.com/).
-If you set `WEDDING_UPLOAD_CODE` on the Convex deployment, guests must enter the passcode before uploads can start.
-
-### Deploy the example (Vercel + stable Convex)
-
-For a public demo, deploy the `example/` app and point it at a stable Convex deployment.
-
-1. Deploy a Convex app that includes this component (stable/prod deployment).
-2. Set Vercel environment variables for the project:
-   - `NEXT_PUBLIC_CONVEX_URL` (point to the stable Convex deployment)
-   - `NEXT_PUBLIC_GALLERY_RETENTION_HOURS` (optional)
-3. Set Convex environment variables on the deployment:
-   - `TRANSLOADIT_KEY` and `TRANSLOADIT_SECRET`
-   - `TRANSLOADIT_NOTIFY_URL` (set to `https://<deployment>.convex.site/transloadit/webhook`)
-   - R2 credentials (see above)
-   - `WEDDING_UPLOAD_CODE` (optional passcode for uploads)
-4. Trigger the Vercel deploy hook (or deploy manually).
-
-To deploy a stable Convex backend for the demo (once per environment), run:
-
-```bash
-export CONVEX_DEPLOY_KEY=...
-export TRANSLOADIT_KEY=...
-export TRANSLOADIT_SECRET=...
-
-yarn deploy:cloud
-```
-
-Once deployed, use the Vercel URL as `E2E_REMOTE_APP_URL` for `yarn verify:cloud`.
-CI expects a stable Vercel production URL in the `E2E_REMOTE_APP_URL` secret on `main`.
-
-### Demo cleanup (Convex + R2)
-
-To remove demo uploads from Convex and Cloudflare R2, run:
-
-```bash
-yarn demo:cleanup
-```
-
-This requires:
-
-- `CONVEX_URL`
-- `CONVEX_ADMIN_KEY`
-- `R2_BUCKET`
-- `R2_ACCESS_KEY_ID`
-- `R2_SECRET_ACCESS_KEY`
-- `R2_ACCOUNT_ID` or `R2_HOST`
-
-Optional:
-
-- `DEMO_ALBUM` (defaults to `wedding-gallery`)
-- `--dry-run` (prints the counts without deleting)
-
-Note: the demo bucket is configured to auto-expire objects after 1 day via `yarn r2:lifecycle`.
-
-## Verification and QA
-
-Fast checks:
-
-```bash
-yarn check
-```
-
-This runs format, lint, typecheck, and unit tests. For a full verification run:
-
-```bash
-yarn verify
-```
-
-Additional commands:
-
-- `yarn lint` (Biome)
-- `yarn format` (Biome write)
-- `yarn typecheck` (tsc)
-- `yarn test` (Vitest unit tests)
-- `yarn verify:local` (runs the Next.js wedding example + uploads an image + video)
-- `yarn verify:cloud` (runs the browser flow against a deployed Next.js app)
-- `yarn deploy:cloud` (deploys a stable Convex backend for the demo app)
-- `yarn build` (tsc build + emit package json)
-
-Notes:
-- `yarn tunnel` is a support tool, not verification.
-- CI should run non-mutating checks; local `yarn check` may format/fix.
-- `yarn verify:local` needs `TRANSLOADIT_KEY`, `TRANSLOADIT_SECRET`, `TRANSLOADIT_NOTIFY_URL`, and R2 credentials.
-- `yarn verify:cloud` needs `E2E_REMOTE_APP_URL`.
-- Set `TRANSLOADIT_DEBUG=1` to enable verbose verify logs.
-
-## Component test helpers
-
-For `convex-test`, you can use the built-in helper:
-
-```ts
-import { createTransloaditTest } from "@transloadit/convex/test";
-
-const t = createTransloaditTest();
-```
-
-## Generated files
-
-`src/component/_generated` is Convex codegen output. It is checked in so tests and component consumers have stable API references. If you change component functions or schemas, regenerate with Convex codegen (for example via `npx convex dev` or `npx convex codegen`) and commit the updated files.
-
-## Release process
-
-Releases are automated via Changesets + GitHub Actions and published to npm using OIDC (Trusted Publisher).
-
-1. Ensure CI is green on `main`.
-2. Run local checks:
-
-```bash
-yarn check
-```
-
-3. Add a changeset describing the release:
-
-```bash
-yarn changeset
-```
-
-4. Apply the version bump + changelog updates:
-
-```bash
-yarn changeset:version
-git add package.json CHANGELOG.md
-git commit -m "Release vX.Y.Z"
-git push
-```
-
-5. Tag and push the release:
-
-```bash
-git tag vX.Y.Z
-git push origin vX.Y.Z
-```
-
-6. The publish workflow will:
-   - build and pack a `.tgz` artifact,
-   - create a draft GitHub release,
-   - publish the tarball to npm with provenance.
-
-Note: This package is 0.x, so breaking changes are allowed. Use changesets to document them clearly.
+For setup, deployment, and verification details, see `CONTRIBUTING.md`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@transloadit/convex",
   "description": "Transloadit component for Convex",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "type": "module",
   "packageManager": "yarn@4.5.0",
   "repository": {
@@ -35,6 +35,7 @@
     "verify:convex": "yarn verify:cloud",
     "deploy:cloud": "node scripts/deploy-cloud.ts",
     "demo:cleanup": "node scripts/cleanup-demo.ts",
+    "demo:media": "node scripts/generate-demo-media.ts",
     "example:dev": "yarn build && node ./node_modules/next/dist/bin/next dev example",
     "example:build": "yarn build && node ./node_modules/next/dist/bin/next build example",
     "example:start": "yarn build && node ./node_modules/next/dist/bin/next start example",
@@ -102,6 +103,7 @@
     "@changesets/cli": "^2.29.8",
     "@convex-dev/auth": "^0.0.90",
     "@edge-runtime/vm": "^5.0.0",
+    "@fal-ai/client": "^1.8.4",
     "@playwright/test": "^1.57.0",
     "@testing-library/dom": "^10.4.1",
     "@testing-library/react": "^16.3.0",