Include share status in file metadata

Author: TheodoreSpeaks

apps/sim/app/api/v2/files/[fileId]/metadata/route.test.ts

@@ -54,6 +54,17 @@ const auth = {
   rateLimitSubscription: null,
   keyType: 'workspace' as const,
 }
+const SHARE = {
+  id: 'share-1',
+  token: 'share-token',
+  url: 'https://example.com/f/share-token',
+  isActive: true,
+  resourceType: 'file',
+  resourceId: FILE_ID,
+  authType: 'public',
+  hasPassword: false,
+  allowedEmails: [],
+}
 
 function buildRecord() {
   return {
@@ -89,7 +100,7 @@ describe('GET /api/v2/files/[fileId]/metadata', () => {
       remaining: 99,
       resetAt: new Date('2024-01-01T01:00:00Z'),
     })
-    mocks.readMetadata.mockResolvedValue({ file: buildRecord() })
+    mocks.readMetadata.mockResolvedValue({ file: buildRecord(), share: SHARE })
     mocks.getUserEmailsByIds.mockResolvedValue(new Map([['user-1', 'ada@example.com']]))
   })
 
@@ -128,6 +139,7 @@ describe('GET /api/v2/files/[fileId]/metadata', () => {
         uploadedByEmail: 'ada@example.com',
         uploadedAt: '2024-01-01T00:00:00.000Z',
         updatedAt: '2024-01-02T00:00:00.000Z',
+        share: SHARE,
       },
     })
     expect(mocks.readMetadata).toHaveBeenCalledWith({
@@ -136,4 +148,13 @@ describe('GET /api/v2/files/[fileId]/metadata', () => {
       request: expect.anything(),
     })
   })
+
+  it('returns a null share when the file has no share configuration', async () => {
+    mocks.readMetadata.mockResolvedValueOnce({ file: buildRecord(), share: null })
+
+    const response = await callGet(`workspaceId=${WORKSPACE_ID}`)
+
+    expect(response.status).toBe(200)
+    expect((await response.json()).data.share).toBeNull()
+  })
 })

apps/sim/app/api/v2/files/[fileId]/metadata/route.ts

@@ -20,5 +20,5 @@ export const GET = defineV2JsonRoute({
     assertedWorkspaceId: query.workspaceId,
   }),
   useCase: readWorkspaceFileMetadata,
-  present: async ({ file }) => ({ data: await toV2File(file) }),
+  present: async ({ file, share }) => ({ data: { ...(await toV2File(file)), share } }),
 })

apps/sim/lib/api/contracts/v2/files.ts

@@ -61,6 +61,24 @@ export const v2FileSchema = z.object({
 
 export type V2File = z.output<typeof v2FileSchema>
 
+/**
+ * Public share state. Reuses the internal {@link shareRecordSchema}, which is
+ * already public-safe — `hasPassword` is a boolean and neither the ciphertext
+ * nor the storage key is carried — with `url` tightened to a real URL.
+ */
+export const v2FileShareSchema = shareRecordSchema.extend({
+  url: z.string().url(),
+})
+
+export type V2FileShare = z.output<typeof v2FileShareSchema>
+
+/** File metadata enriched with its current public-share configuration. */
+export const v2FileMetadataSchema = v2FileSchema.extend({
+  share: v2FileShareSchema.nullable(),
+})
+
+export type V2FileMetadata = z.output<typeof v2FileMetadataSchema>
+
 export const v2FileUploadParamsSchema = z.object({ uploadId: z.string().min(1) })
 export type V2FileUploadParams = z.output<typeof v2FileUploadParamsSchema>
 
@@ -259,17 +277,6 @@ export const v2DeleteFileFolderContract = defineRouteContract({
   response: { mode: 'json', schema: v2DataResponse(v2DeleteFileFolderDataSchema) },
 })
 
-/**
- * Public share state. Reuses the internal {@link shareRecordSchema}, which is
- * already public-safe — `hasPassword` is a boolean and neither the ciphertext
- * nor the storage key is carried — with `url` tightened to a real URL.
- */
-export const v2FileShareSchema = shareRecordSchema.extend({
-  url: z.string().url(),
-})
-
-export type V2FileShare = z.output<typeof v2FileShareSchema>
-
 export const v2GetFileShareResultSchema = z.object({
   share: v2FileShareSchema.nullable(),
 })
@@ -403,7 +410,7 @@ export const v2GetFileContract = defineRouteContract({
   query: v2FileWorkspaceQuerySchema,
   response: {
     mode: 'json',
-    schema: v2DataResponse(v2FileSchema),
+    schema: v2DataResponse(v2FileMetadataSchema),
   },
 })
 

apps/sim/lib/workspace-files/application/read-workspace-file-metadata.test.ts

@@ -6,6 +6,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest'
 const mocks = vi.hoisted(() => ({
   loadContext: vi.fn(),
   getWorkspaceFile: vi.fn(),
+  getShareForResource: vi.fn(),
   resolvePermission: vi.fn(),
 }))
 
@@ -19,6 +20,10 @@ vi.mock('@/lib/uploads/contexts/workspace/workspace-file-manager', () => ({
   loadActiveWorkspaceFileContext: mocks.loadContext,
 }))
 
+vi.mock('@/lib/public-shares/share-manager', () => ({
+  getShareForResource: mocks.getShareForResource,
+}))
+
 import { readWorkspaceFileMetadata } from '@/lib/workspace-files/application/read-workspace-file-metadata'
 
 const canonical = {
@@ -43,15 +48,28 @@ const file = {
   updatedAt: new Date('2026-01-02T00:00:00Z'),
 }
 
+const share = {
+  id: 'share-1',
+  token: 'share-token',
+  url: 'https://example.com/f/share-token',
+  isActive: true,
+  resourceType: 'file' as const,
+  resourceId: 'file-1',
+  authType: 'public' as const,
+  hasPassword: false,
+  allowedEmails: [],
+}
+
 describe('readWorkspaceFileMetadata', () => {
   beforeEach(() => {
     vi.clearAllMocks()
     mocks.loadContext.mockResolvedValue(canonical)
     mocks.getWorkspaceFile.mockResolvedValue(file)
+    mocks.getShareForResource.mockResolvedValue(share)
     mocks.resolvePermission.mockResolvedValue('admin')
   })
 
-  it('returns the canonical active file without side effects', async () => {
+  it('returns the canonical active file and its share status without side effects', async () => {
     const principal = { kind: 'session' as const, userId: 'user-1', sessionId: 'session-1' }
 
     await expect(
@@ -62,14 +80,15 @@ describe('readWorkspaceFileMetadata', () => {
           assertedWorkspaceId: 'workspace-1',
         },
       })
-    ).resolves.toEqual({ file })
+    ).resolves.toEqual({ file, share })
 
     expect(mocks.loadContext).toHaveBeenCalledWith('file-1', {
       includeDeleted: undefined,
     })
     expect(mocks.getWorkspaceFile).toHaveBeenCalledWith('workspace-1', 'file-1', {
       throwOnError: true,
     })
+    expect(mocks.getShareForResource).toHaveBeenCalledWith('file', 'file-1')
   })
 
   it('fails fast if the authorized file disappears before projection', async () => {

apps/sim/lib/workspace-files/application/read-workspace-file-metadata.ts

@@ -1,5 +1,7 @@
+import type { ShareRecord } from '@/lib/api/contracts/public-shares'
 import type { AuthorizedWorkspaceUseCaseContext } from '@/lib/core/application'
 import { OrchestrationError } from '@/lib/core/orchestration/types'
+import { getShareForResource } from '@/lib/public-shares/share-manager'
 import {
   type ActiveWorkspaceFileContext,
   getWorkspaceFile,
@@ -17,6 +19,7 @@ export interface ReadWorkspaceFileMetadataInput {
 
 export interface ReadWorkspaceFileMetadataResult {
   file: WorkspaceFileRecord
+  share: ShareRecord | null
 }
 
 async function executeReadWorkspaceFileMetadata({
@@ -27,12 +30,15 @@ async function executeReadWorkspaceFileMetadata({
   ReadWorkspaceFileMetadataInput,
   ActiveWorkspaceFileContext
 >): Promise<ReadWorkspaceFileMetadataResult> {
-  const file = await getWorkspaceFile(context.workspaceId, context.fileId, {
-    includeDeleted: input.includeDeleted,
-    throwOnError: true,
-  })
+  const [file, share] = await Promise.all([
+    getWorkspaceFile(context.workspaceId, context.fileId, {
+      includeDeleted: input.includeDeleted,
+      throwOnError: true,
+    }),
+    getShareForResource('file', context.fileId),
+  ])
   if (!file) throw new OrchestrationError('not_found', 'File not found')
-  return { file }
+  return { file, share }
 }
 
 export const readWorkspaceFileMetadata = defineAuthorizedWorkspaceFileUseCase({