Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions apps/docs/content/docs/cli/files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,27 @@ sim files mkdir <path>

API request and response schemas: [createFileFolder](/api-reference/files/createFilesFolder).

## Other commands

### Copy file items

OAuth login or personal API key required.

```bash
sim files copy [options]
```

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--source <json\|@file>` | Yes | Source owner and selected fileIds or folderIds (JSON, or @path / @- to read a file or stdin). |
| `--destination <json\|@file>` | Yes | Destination owner and optional folderId (JSON, or @path / @- to read a file or stdin). |

</CommandTable>

## Related docs

- [Files](/files)
Expand Down
19 changes: 19 additions & 0 deletions apps/docs/content/docs/cli/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,25 @@ sim files batch-delete [options]

API request and response schemas: [bulkDeleteFiles](/api-reference/files/bulkDeleteFiles).

### sim files copy

Copy file items (OAuth login or personal API key required)

```bash
sim files copy [options]
```

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--source <json\|@file>` | Yes | Source owner and selected fileIds or folderIds (JSON, or @path / @- to read a file or stdin). |
| `--destination <json\|@file>` | Yes | Destination owner and optional folderId (JSON, or @path / @- to read a file or stdin). |

</CommandTable>

### sim files create

Create file
Expand Down
21 changes: 21 additions & 0 deletions apps/sim/app/api/files/copy/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { copyFileItemsContract } from '@/lib/api/contracts/file-copy'
import {
defineInternalJsonRoute,
internalOrchestrationErrorPolicy,
internalRateLimits,
internalSessionAuth,
} from '@/lib/api/server/routes'
import { presentCopiedFileItems } from '@/lib/workspace-files/api/copy-presenter'
import { copyFileItems } from '@/lib/workspace-files/application/copy-file-items'
import { fileCopyOperation } from '@/lib/workspace-files/application/copy-operation'

export const POST = defineInternalJsonRoute({
contract: copyFileItemsContract,
auth: internalSessionAuth,
operation: fileCopyOperation,
rateLimit: internalRateLimits.user({ bucketName: 'files.copy' }),
errorPolicy: internalOrchestrationErrorPolicy,
mapInput: ({ body }) => body,
useCase: copyFileItems,
present: presentCopiedFileItems,
})
24 changes: 24 additions & 0 deletions apps/sim/app/api/projects/[id]/files/[fileId]/export/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import {
exportProjectFileSnapshotContract,
MAX_PROJECT_FILE_SNAPSHOT_BODY_BYTES,
} from '@/lib/api/contracts/project-file-downloads'
import {
defineInternalBinaryRoute,
internalOrchestrationErrorPolicy,
internalRateLimits,
internalSessionAuth,
} from '@/lib/api/server/routes'
import { presentProjectFileDownload } from '@/lib/projects/files/api/download-presenter'
import { exportProjectFileSnapshot } from '@/lib/projects/files/application'

export const POST = defineInternalBinaryRoute({
contract: exportProjectFileSnapshotContract,
parseOptions: { maxBodyBytes: MAX_PROJECT_FILE_SNAPSHOT_BODY_BYTES },
auth: internalSessionAuth,
operation: exportProjectFileSnapshot.operation,
rateLimit: internalRateLimits.none({ reason: 'Authenticated bounded Markdown snapshot export' }),
errorPolicy: internalOrchestrationErrorPolicy,
mapInput: ({ params, body }) => ({ projectId: params.id, fileId: params.fileId, ...body }),
useCase: exportProjectFileSnapshot,
present: presentProjectFileDownload,
})
21 changes: 21 additions & 0 deletions apps/sim/app/api/projects/[id]/files/[fileId]/extract/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { extractProjectFileContract } from '@/lib/api/contracts/project-file-extraction'
import {
defineInternalJsonRoute,
internalRateLimits,
internalSessionAuth,
} from '@/lib/api/server/routes'
import { extractProjectFile } from '@/lib/projects/files/application'
import { internalFileErrorPolicies } from '@/lib/workspace-files/api'

export const maxDuration = 300

export const POST = defineInternalJsonRoute({
contract: extractProjectFileContract,
auth: internalSessionAuth,
operation: extractProjectFile.operation,
rateLimit: internalRateLimits.user({ bucketName: 'project-files.write' }),
errorPolicy: internalFileErrorPolicies.extractArchive,
mapInput: ({ params }) => ({ projectId: params.id, fileId: params.fileId }),
useCase: extractProjectFile,
present: (result) => ({ success: true, ...result }),
})
21 changes: 21 additions & 0 deletions apps/sim/app/api/projects/[id]/files/download/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { downloadProjectFileItemsContract } from '@/lib/api/contracts/project-file-downloads'
import {
defineInternalBinaryRoute,
internalOrchestrationErrorPolicy,
internalRateLimits,
internalSessionAuth,
} from '@/lib/api/server/routes'
import { presentProjectFileDownload } from '@/lib/projects/files/api/download-presenter'
import { downloadProjectFileItems } from '@/lib/projects/files/application'

export const GET = defineInternalBinaryRoute({
contract: downloadProjectFileItemsContract,
auth: internalSessionAuth,
operation: downloadProjectFileItems.operation,
Comment thread
mzxchandra marked this conversation as resolved.
rateLimit: internalRateLimits.none({ reason: 'Authenticated bounded Project archive download' }),
errorPolicy: internalOrchestrationErrorPolicy,
headSafe: false,
mapInput: ({ params, query }) => ({ projectId: params.id, ...query }),
useCase: downloadProjectFileItems,
Comment thread
mzxchandra marked this conversation as resolved.
present: presentProjectFileDownload,
})
55 changes: 2 additions & 53 deletions apps/sim/app/api/v2/files/bulk-download/route.ts
Original file line number Diff line number Diff line change
@@ -1,33 +1,13 @@
import { Readable } from 'node:stream'
import { createLogger } from '@sim/logger'
import { ZipArchive } from 'archiver'
import { v2BulkDownloadFilesContract } from '@/lib/api/contracts/v2/files'
import { defineV2BinaryRoute, v2ApiKeyAuth, v2RateLimits } from '@/lib/api/server/routes'
import { nodeReadableToWebStream } from '@/lib/core/utils/node-stream'
import type { WorkspaceFileRecord } from '@/lib/uploads/contexts/workspace'
import { downloadFileStream } from '@/lib/uploads/core/storage-service'
import { buildZipEntryPaths } from '@/lib/uploads/zip-entry-path'
import { v2FileErrorPolicies } from '@/lib/workspace-files/api'
import { presentWorkspaceFileArchive, v2FileErrorPolicies } from '@/lib/workspace-files/api'
import { downloadWorkspaceFileItems } from '@/lib/workspace-files/application/download-workspace-file-items'
import { fileOperations } from '@/lib/workspace-files/application/operations'

const logger = createLogger('V2FilesBulkDownloadAPI')

export const dynamic = 'force-dynamic'
export const revalidate = 0

/** Opens each object only as the archiver reaches it, so peak memory stays flat. */
function lazyWorkspaceFileStream(file: WorkspaceFileRecord): Readable {
return Readable.from(
(async function* () {
yield* await downloadFileStream({
key: file.key,
context: file.storageContext ?? 'workspace',
})
})(),
{ objectMode: false }
)
}

/**
* GET /api/v2/files/bulk-download — stream a selection of files as one zip.
Expand All @@ -54,36 +34,5 @@ export const GET = defineV2BinaryRoute({
folderPaths: query.folderPaths,
}),
useCase: downloadWorkspaceFileItems,
present: ({ filesToZip, folderPaths, renderedDocuments, excludedFileIds }) => {
const report = excludedFileIds.length > 0 ? { partial: true, excludedFileIds } : undefined
const entryPaths = buildZipEntryPaths([
...filesToZip.map((file) => ({
name: file.name,
folderPath: file.folderId ? folderPaths.get(file.folderId) : null,
contentType: file.type,
})),
...(report ? [{ name: 'sim-download-report.json', contentType: 'application/json' }] : []),
])
const archive = new ZipArchive({ store: true })
archive.on('warning', (error: Error) => {
logger.warn('Archive warning while streaming workspace files', { error })
})
filesToZip.forEach((file, index) => {
archive.append(renderedDocuments.get(file.id) ?? lazyWorkspaceFileStream(file), {
name: entryPaths[index],
})
})
if (report) {
archive.append(JSON.stringify(report, null, 2), { name: entryPaths[filesToZip.length] })
}
archive.finalize().catch((error) => {
logger.error('Failed to finalize workspace file archive', { error })
})

return {
body: nodeReadableToWebStream(archive),
contentType: 'application/zip',
contentDisposition: 'attachment; filename="workspace-files.zip"',
}
},
present: presentWorkspaceFileArchive,
})
21 changes: 21 additions & 0 deletions apps/sim/app/api/v2/files/copy/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { v2CopyFileItemsContract } from '@/lib/api/contracts/v2/file-copy'
import {
defineV2JsonRoute,
v2ApiKeyAuth,
v2OrchestrationErrorPolicy,
v2RateLimits,
} from '@/lib/api/server/routes'
import { presentCopiedFileItems } from '@/lib/workspace-files/api/copy-presenter'
import { copyFileItems } from '@/lib/workspace-files/application/copy-file-items'
import { fileCopyOperations } from '@/lib/workspace-files/application/operations'

export const POST = defineV2JsonRoute({
contract: v2CopyFileItemsContract,
auth: v2ApiKeyAuth,
operation: fileCopyOperations.copy,
rateLimit: v2RateLimits.publicApi,
errorPolicy: v2OrchestrationErrorPolicy,
mapInput: ({ body }) => body,
useCase: copyFileItems,
present: (result) => ({ data: presentCopiedFileItems(result) }),
})
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { MAX_PROJECT_FILE_SNAPSHOT_BODY_BYTES } from '@/lib/api/contracts/project-file-downloads'
import { v2ExportProjectFileSnapshotContract } from '@/lib/api/contracts/v2/project-file-downloads'
import {
defineV2BinaryRoute,
v2ApiKeyAuth,
v2OrchestrationErrorPolicy,
v2RateLimits,
} from '@/lib/api/server/routes'
import { presentProjectFileDownload } from '@/lib/projects/files/api/download-presenter'
import { exportProjectFileSnapshot } from '@/lib/projects/files/application'
import { projectFileOperations } from '@/lib/projects/files/application/operations'

export const POST = defineV2BinaryRoute({
contract: v2ExportProjectFileSnapshotContract,
parseOptions: { maxBodyBytes: MAX_PROJECT_FILE_SNAPSHOT_BODY_BYTES },
Comment thread
mzxchandra marked this conversation as resolved.
auth: v2ApiKeyAuth,
operation: projectFileOperations.exportSnapshot,
rateLimit: v2RateLimits.publicApi,
errorPolicy: v2OrchestrationErrorPolicy,
mapInput: ({ params, body }) => ({ ...params, content: body.content }),
useCase: exportProjectFileSnapshot,
present: presentProjectFileDownload,
})
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { v2UnzipProjectFileContract } from '@/lib/api/contracts/v2/project-file-extraction'
import { defineV2JsonRoute, v2ApiKeyAuth, v2RateLimits } from '@/lib/api/server/routes'
import { buildFolderPath } from '@/lib/folders/paths'
import { extractProjectFile } from '@/lib/projects/files/application'
import { projectFileOperations } from '@/lib/projects/files/application/operations'
import { v2FileErrorPolicies } from '@/lib/workspace-files/api'
import { parseWorkspaceFileFolderDisplayPath } from '@/lib/workspace-files/folder-display-path'

export const maxDuration = 300

export const POST = defineV2JsonRoute({
contract: v2UnzipProjectFileContract,
auth: v2ApiKeyAuth,
operation: projectFileOperations.extractArchive,
rateLimit: v2RateLimits.publicApi,
errorPolicy: v2FileErrorPolicies.concealExtractionAuthorization,
mapInput: ({ params }) => ({ projectId: params.projectId, fileId: params.fileId }),
useCase: extractProjectFile,
present: (result) => ({
data: {
folderPath: buildFolderPath(parseWorkspaceFileFolderDisplayPath(result.folderDisplayPath)),
extractedFileCount: result.extractedCount,
skippedFileCount: result.skippedCount,
},
}),
})
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { v2DownloadProjectFileItemsContract } from '@/lib/api/contracts/v2/project-file-downloads'
import {
defineV2BinaryRoute,
v2ApiKeyAuth,
v2OrchestrationErrorPolicy,
v2RateLimits,
} from '@/lib/api/server/routes'
import { presentProjectFileDownload } from '@/lib/projects/files/api/download-presenter'
import { downloadProjectFileItems } from '@/lib/projects/files/application'
import { projectFileOperations } from '@/lib/projects/files/application/operations'

export const GET = defineV2BinaryRoute({
contract: v2DownloadProjectFileItemsContract,
auth: v2ApiKeyAuth,
operation: projectFileOperations.downloadItems,
rateLimit: v2RateLimits.publicApi,
errorPolicy: v2OrchestrationErrorPolicy,
headSafe: false,
Comment thread
mzxchandra marked this conversation as resolved.
mapInput: ({ params, query }) => ({ projectId: params.projectId, ...query }),
useCase: downloadProjectFileItems,
present: presentProjectFileDownload,
})
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { createMockRequest } from '@sim/testing'
import { createRouteContext } from '@sim/testing/helpers/http'
import { auditMock } from '@sim/testing/mocks/audit.mock'
import { authMockFns } from '@sim/testing/mocks/auth.mock'
import { fileReadReceiptMock } from '@sim/testing/mocks/file-read-receipt.mock'
import { posthogServerMock } from '@sim/testing/mocks/posthog-server.mock'
import { storageServiceMock, storageServiceMockFns } from '@sim/testing/mocks/storage-service.mock'
import { workspaceAuthzMock, workspaceAuthzMockFns } from '@sim/testing/mocks/workspace-authz.mock'
Expand All @@ -29,6 +30,7 @@ const run = promisify(execFile)
vi.mock('@sim/platform-authz/workspace', () => workspaceAuthzMock)
vi.mock('@/lib/uploads/contexts/workspace', () => workspaceUploadsMock)
vi.mock('@/lib/uploads/core/storage-service', () => storageServiceMock)
vi.mock('@/lib/workspace-files/read-receipt', () => fileReadReceiptMock)
vi.mock('@sim/audit', () => auditMock)
vi.mock('@/lib/posthog/server', () => posthogServerMock)

Expand Down
Loading
Loading