diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-11-08 15:22:14 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-11-08 15:22:14 +0000 |
| commit | 31960fcd11daa2dfaf8ae409c80b572c9b22940f (patch) | |
| tree | 17bd227dac336ccabd2b6ffc6558920c68e053d0 /packages | |
| parent | 99413db0e79a156a1b87eacd3c6a7b83e9df946e (diff) | |
| download | karakeep-31960fcd11daa2dfaf8ae409c80b572c9b22940f.tar.zst | |
feat: Add support for user uploaded files (#2100)
* feat: add user file upload support for bookmarks
Add a new "user-uploaded" asset type that allows users to upload and
attach their own files to bookmarks from the attachment box in the
bookmark preview page.
Changes:
- Add USER_UPLOADED asset type to database schema
- Add userUploaded to zAssetTypesSchema for type safety
- Update attachment permissions to allow attaching/detaching user files
- Add fileName field to asset schema for displaying custom filenames
- Add "Upload File" button in AttachmentBox component
- Display actual filename for user-uploaded files
- Allow any file type for user uploads (respects existing upload limits)
- Add Upload icon for user-uploaded files
Fixes #1863 related asset attachment improvements
* fix: ensure fileName is returned and remove edit button for user uploads
- Fix attachAsset mutation to fetch and return complete asset with fileName
instead of just returning the input (which lacks fileName)
- Remove replace/edit button for user-uploaded files - users can only
delete and re-upload instead
- This ensures the filename displays correctly in the UI immediately
after upload
Fixes fileName propagation issue for user-uploaded assets
* fix asset file name
* remove filename from attach asset api
---------
Co-authored-by: Claude <noreply@anthropic.com>
Diffstat (limited to 'packages')
| -rw-r--r-- | packages/db/schema.ts | 2 | ||||
| -rw-r--r-- | packages/open-api/karakeep-openapi-spec.json | 11 | ||||
| -rw-r--r-- | packages/open-api/lib/bookmarks.ts | 6 | ||||
| -rw-r--r-- | packages/shared/types/bookmarks.ts | 2 | ||||
| -rw-r--r-- | packages/trpc/lib/attachments.ts | 5 | ||||
| -rw-r--r-- | packages/trpc/models/bookmarks.ts | 1 | ||||
| -rw-r--r-- | packages/trpc/routers/assets.ts | 17 | ||||
| -rw-r--r-- | packages/trpc/routers/bookmarks.ts | 1 |
8 files changed, 40 insertions, 5 deletions
diff --git a/packages/db/schema.ts b/packages/db/schema.ts index c0433d6a..5f523d21 100644 --- a/packages/db/schema.ts +++ b/packages/db/schema.ts @@ -228,6 +228,7 @@ export const enum AssetTypes { LINK_VIDEO = "linkVideo", LINK_HTML_CONTENT = "linkHtmlContent", BOOKMARK_ASSET = "bookmarkAsset", + USER_UPLOADED = "userUploaded", UNKNOWN = "unknown", } @@ -246,6 +247,7 @@ export const assets = sqliteTable( AssetTypes.LINK_VIDEO, AssetTypes.LINK_HTML_CONTENT, AssetTypes.BOOKMARK_ASSET, + AssetTypes.USER_UPLOADED, AssetTypes.UNKNOWN, ], }).notNull(), diff --git a/packages/open-api/karakeep-openapi-spec.json b/packages/open-api/karakeep-openapi-spec.json index 0b520b00..2e791fbf 100644 --- a/packages/open-api/karakeep-openapi-spec.json +++ b/packages/open-api/karakeep-openapi-spec.json @@ -317,8 +317,13 @@ "video", "bookmarkAsset", "precrawledArchive", + "userUploaded", "unknown" ] + }, + "fileName": { + "type": "string", + "nullable": true } }, "required": [ @@ -1703,6 +1708,7 @@ "video", "bookmarkAsset", "precrawledArchive", + "userUploaded", "unknown" ] } @@ -1737,8 +1743,13 @@ "video", "bookmarkAsset", "precrawledArchive", + "userUploaded", "unknown" ] + }, + "fileName": { + "type": "string", + "nullable": true } }, "required": [ diff --git a/packages/open-api/lib/bookmarks.ts b/packages/open-api/lib/bookmarks.ts index d49a20ff..0a3806b9 100644 --- a/packages/open-api/lib/bookmarks.ts +++ b/packages/open-api/lib/bookmarks.ts @@ -6,6 +6,7 @@ import { z } from "zod"; import { zAssetSchema, + zAssetTypesSchema, zBareBookmarkSchema, zManipulatedTagSchema, zNewBookmarkRequestSchema, @@ -418,7 +419,10 @@ registry.registerPath({ description: "The asset to attach", content: { "application/json": { - schema: zAssetSchema, + schema: z.object({ + id: z.string(), + assetType: zAssetTypesSchema, + }), }, }, }, diff --git a/packages/shared/types/bookmarks.ts b/packages/shared/types/bookmarks.ts index f108d006..d72525d1 100644 --- a/packages/shared/types/bookmarks.ts +++ b/packages/shared/types/bookmarks.ts @@ -24,6 +24,7 @@ export const zAssetTypesSchema = z.enum([ "video", "bookmarkAsset", "precrawledArchive", + "userUploaded", "unknown", ]); export type ZAssetType = z.infer<typeof zAssetTypesSchema>; @@ -31,6 +32,7 @@ export type ZAssetType = z.infer<typeof zAssetTypesSchema>; export const zAssetSchema = z.object({ id: z.string(), assetType: zAssetTypesSchema, + fileName: z.string().nullish(), }); export const zBookmarkedLinkSchema = z.object({ diff --git a/packages/trpc/lib/attachments.ts b/packages/trpc/lib/attachments.ts index af484462..7a4e2668 100644 --- a/packages/trpc/lib/attachments.ts +++ b/packages/trpc/lib/attachments.ts @@ -16,6 +16,7 @@ export function mapDBAssetTypeToUserType(assetType: AssetTypes): ZAssetType { [AssetTypes.LINK_VIDEO]: "video", [AssetTypes.LINK_HTML_CONTENT]: "linkHtmlContent", [AssetTypes.BOOKMARK_ASSET]: "bookmarkAsset", + [AssetTypes.USER_UPLOADED]: "userUploaded", [AssetTypes.UNKNOWN]: "bannerImage", }; return map[assetType]; @@ -33,6 +34,7 @@ export function mapSchemaAssetTypeToDB( video: AssetTypes.LINK_VIDEO, bookmarkAsset: AssetTypes.BOOKMARK_ASSET, linkHtmlContent: AssetTypes.LINK_HTML_CONTENT, + userUploaded: AssetTypes.USER_UPLOADED, unknown: AssetTypes.UNKNOWN, }; return map[assetType]; @@ -48,6 +50,7 @@ export function humanFriendlyNameForAssertType(type: ZAssetType) { video: "Video", bookmarkAsset: "Bookmark Asset", linkHtmlContent: "HTML Content", + userUploaded: "User Uploaded File", unknown: "Unknown", }; return map[type]; @@ -63,6 +66,7 @@ export function isAllowedToAttachAsset(type: ZAssetType) { video: true, bookmarkAsset: false, linkHtmlContent: false, + userUploaded: true, unknown: false, }; return map[type]; @@ -78,6 +82,7 @@ export function isAllowedToDetachAsset(type: ZAssetType) { video: true, bookmarkAsset: false, linkHtmlContent: false, + userUploaded: true, unknown: false, }; return map[type]; diff --git a/packages/trpc/models/bookmarks.ts b/packages/trpc/models/bookmarks.ts index e0864ec1..c689f64d 100644 --- a/packages/trpc/models/bookmarks.ts +++ b/packages/trpc/models/bookmarks.ts @@ -295,6 +295,7 @@ export class Bookmark implements PrivacyAware { acc[bookmarkId].assets.push({ id: row.assets.id, assetType: mapDBAssetTypeToUserType(row.assets.assetType), + fileName: row.assets.fileName, }); } diff --git a/packages/trpc/routers/assets.ts b/packages/trpc/routers/assets.ts index af508a4e..7be85446 100644 --- a/packages/trpc/routers/assets.ts +++ b/packages/trpc/routers/assets.ts @@ -99,7 +99,10 @@ export const assetsAppRouter = router({ .input( z.object({ bookmarkId: z.string(), - asset: zAssetSchema, + asset: z.object({ + id: z.string(), + assetType: zAssetTypesSchema, + }), }), ) .output(zAssetSchema) @@ -112,7 +115,7 @@ export const assetsAppRouter = router({ message: "You can't attach this type of asset", }); } - await ctx.db + const [updatedAsset] = await ctx.db .update(assets) .set({ assetType: mapSchemaAssetTypeToDB(input.asset.assetType), @@ -120,8 +123,14 @@ export const assetsAppRouter = router({ }) .where( and(eq(assets.id, input.asset.id), eq(assets.userId, ctx.user.id)), - ); - return input.asset; + ) + .returning(); + + return { + id: updatedAsset.id, + assetType: mapDBAssetTypeToUserType(updatedAsset.assetType), + fileName: updatedAsset.fileName, + }; }), replaceAsset: authedProcedure .input( diff --git a/packages/trpc/routers/bookmarks.ts b/packages/trpc/routers/bookmarks.ts index 5a2fc1eb..72c6c1d1 100644 --- a/packages/trpc/routers/bookmarks.ts +++ b/packages/trpc/routers/bookmarks.ts @@ -253,6 +253,7 @@ async function toZodSchema( assets: assets.map((a) => ({ id: a.id, assetType: mapDBAssetTypeToUserType(a.assetType), + fileName: a.fileName, })), ...rest, }; |
