Skip to content

Commit ec6c875

Browse files
docs: update data model, architecture, and API for v1.15.0 (#66)
1 parent 8a4ca86 commit ec6c875

3 files changed

Lines changed: 7 additions & 2 deletions

File tree

docs/api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,12 @@ Response: { "clip": { "id", "status": "downloading", "contentType" } } (201 Cr
8383
Triggers the download pipeline via the active provider. Requires a download provider to be configured (see Settings). Returns immediately with status `downloading`.
8484

8585
### POST /api/clips/share
86-
Authenticated via `?token=` query parameter (iOS Shortcut token). Allows sharing clips without a session cookie.
86+
Authenticated via `?token=` query parameter (iOS Shortcut token) or session cookie (web view). Allows sharing clips without a session cookie.
8787
```
8888
Request: { "url": "https://tiktok.com/...", "phone": "+1234567890" }
8989
Response: { "ok": true, "clipId": "...", "status": "downloading" } (201 Created)
9090
```
91+
Also accepts `"phones": ["+1234567890"]` (array) for legacy Shortcut backward compatibility. Records legacy share timestamp for upgrade banner tracking.
9192

9293
### GET /api/clips/[id]
9394
Returns full clip detail with user context, interaction state, and metadata.

docs/architecture.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ scrolly/
116116
│ │ │ ├── InlineError.svelte
117117
│ │ │ ├── FilterBar.svelte # Feed filter tabs
118118
│ │ │ ├── ShortcutGuideSheet.svelte # iOS Shortcut setup guide
119+
│ │ │ ├── ShortcutUpgradeBanner.svelte # Legacy shortcut upgrade prompt
119120
│ │ │ └── settings/
120121
│ │ │ ├── GroupNameEdit.svelte
121122
│ │ │ ├── InviteLink.svelte
@@ -141,7 +142,8 @@ scrolly/
141142
│ │ │ ├── sheetOpen.ts # Global any-sheet-open state (blocks scroll/nav)
142143
│ │ │ ├── uiHidden.ts # Feed UI hidden state (synced from active reel)
143144
│ │ │ ├── homeTap.ts # Double-tap home to scroll to top
144-
│ │ │ └── shortcutNudge.ts # Share shortcut install nudge
145+
│ │ │ ├── shortcutNudge.ts # Share shortcut install nudge
146+
│ │ │ └── shortcutUpgrade.ts # Shortcut upgrade banner state
145147
│ │ ├── types.ts # Shared TypeScript types (Clip, etc.)
146148
│ │ ├── push.ts # Client-side push subscription helpers
147149
│ │ ├── feed.ts # Feed data loading

docs/data-model.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ SQLite database via Drizzle ORM. All IDs are UUIDs stored as text. Timestamps ar
3636
| muted_by_default | integer | Boolean (0/1). Default 1. |
3737
| feed_sort_order | text | `'oldest'` / `'round-robin'`. Default `'oldest'`. |
3838
| avatar_path | text | Nullable. Path to uploaded profile picture. |
39+
| last_legacy_share_at | integer | Nullable. Unix timestamp of last legacy shortcut share. Used for upgrade banner. |
40+
| used_new_share_flow | integer | Boolean (0/1). Default 0. Tracks if user has adopted new web view share flow. |
3941
| removed_at | integer | Nullable. Unix timestamp when removed from group. |
4042
| created_at | integer | Unix timestamp |
4143

0 commit comments

Comments
 (0)