Skip to content

Commit 4a022d1

Browse files
feat(files): add workflow-backed HTML dashboards
1 parent 93fdd13 commit 4a022d1

79 files changed

Lines changed: 32624 additions & 185 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎apps/docs/content/docs/cli/files.mdx‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ sim files create [options]
3838

3939
| Option | Required | Description |
4040
| --- | --- | --- |
41+
| `--workflow-ids <json\|@file>` | No | Deployed workflows in this workspace that the HTML document may call. (JSON, or @path / @- to read a file or stdin). |
4142
| `--name <value>` | Yes | File name, including its extension. Path separators and dot segments are rejected. |
4243
| `--content-type <value>` | No | MIME type. When omitted, it is inferred from the file extension. |
4344
| `--folder <value>` | No | Folder path as shown in the app; the leading / is optional. |
@@ -502,6 +503,40 @@ sim files read <fileId> [options]
502503

503504
</CommandTable>
504505

506+
## Get file workflow result
507+
508+
```bash
509+
sim files workflows get <fileId> <workflowId>
510+
```
511+
512+
**Arguments**
513+
514+
<CommandTable>
515+
516+
| Argument | Required | Description |
517+
| --- | --- | --- |
518+
| `fileId` | Yes | HTML file identifier. |
519+
| `workflowId` | Yes | Workflow ID configured in the file metadata. |
520+
521+
</CommandTable>
522+
523+
## Run file workflow
524+
525+
```bash
526+
sim files workflows create <fileId> <workflowId>
527+
```
528+
529+
**Arguments**
530+
531+
<CommandTable>
532+
533+
| Argument | Required | Description |
534+
| --- | --- | --- |
535+
| `fileId` | Yes | HTML file identifier. |
536+
| `workflowId` | Yes | Workflow ID configured in the file metadata. |
537+
538+
</CommandTable>
539+
505540
## Rename a file
506541

507542
```bash
@@ -619,6 +654,32 @@ sim files set-content <fileId> [options]
619654

620655
</CommandTable>
621656

657+
## Update file metadata
658+
659+
```bash
660+
sim files metadata update <fileId> [options]
661+
```
662+
663+
**Arguments**
664+
665+
<CommandTable>
666+
667+
| Argument | Required | Description |
668+
| --- | --- | --- |
669+
| `fileId` | Yes | HTML file identifier. |
670+
671+
</CommandTable>
672+
673+
**Options**
674+
675+
<CommandTable>
676+
677+
| Option | Required | Description |
678+
| --- | --- | --- |
679+
| `--workflow-ids <json\|@file>` | Yes | Replace the workflows this HTML file may call. Send an empty array to remove all dependencies. Sharing exposes these calls to the file audience. (JSON, or @path / @- to read a file or stdin). |
680+
681+
</CommandTable>
682+
622683
## Upload a file to the workspace
623684

624685
```bash

‎apps/docs/content/docs/cli/reference.mdx‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -761,6 +761,7 @@ sim files create [options]
761761

762762
| Option | Required | Description |
763763
| --- | --- | --- |
764+
| `--workflow-ids <json\|@file>` | No | Deployed workflows in this workspace that the HTML document may call. (JSON, or @path / @- to read a file or stdin). |
764765
| `--name <value>` | Yes | File name, including its extension. Path separators and dot segments are rejected. |
765766
| `--content-type <value>` | No | MIME type. When omitted, it is inferred from the file extension. |
766767
| `--folder <value>` | No | Folder path as shown in the app; the leading / is optional. |
@@ -1261,6 +1262,44 @@ sim files read <fileId> [options]
12611262

12621263
</CommandTable>
12631264

1265+
### sim files workflows get
1266+
1267+
Get File Workflow Result
1268+
1269+
```bash
1270+
sim files workflows get <fileId> <workflowId>
1271+
```
1272+
1273+
**Arguments**
1274+
1275+
<CommandTable>
1276+
1277+
| Argument | Required | Description |
1278+
| --- | --- | --- |
1279+
| `fileId` | Yes | HTML file identifier. |
1280+
| `workflowId` | Yes | Workflow ID configured in the file metadata. |
1281+
1282+
</CommandTable>
1283+
1284+
### sim files workflows create
1285+
1286+
Run File Workflow
1287+
1288+
```bash
1289+
sim files workflows create <fileId> <workflowId>
1290+
```
1291+
1292+
**Arguments**
1293+
1294+
<CommandTable>
1295+
1296+
| Argument | Required | Description |
1297+
| --- | --- | --- |
1298+
| `fileId` | Yes | HTML file identifier. |
1299+
| `workflowId` | Yes | Workflow ID configured in the file metadata. |
1300+
1301+
</CommandTable>
1302+
12641303
### sim files rename
12651304

12661305
Rename a file
@@ -1388,6 +1427,34 @@ sim files set-content <fileId> [options]
13881427

13891428
</CommandTable>
13901429

1430+
### sim files metadata update
1431+
1432+
Update File Metadata
1433+
1434+
```bash
1435+
sim files metadata update <fileId> [options]
1436+
```
1437+
1438+
**Arguments**
1439+
1440+
<CommandTable>
1441+
1442+
| Argument | Required | Description |
1443+
| --- | --- | --- |
1444+
| `fileId` | Yes | HTML file identifier. |
1445+
1446+
</CommandTable>
1447+
1448+
**Options**
1449+
1450+
<CommandTable>
1451+
1452+
| Option | Required | Description |
1453+
| --- | --- | --- |
1454+
| `--workflow-ids <json\|@file>` | Yes | Replace the workflows this HTML file may call. Send an empty array to remove all dependencies. Sharing exposes these calls to the file audience. (JSON, or @path / @- to read a file or stdin). |
1455+
1456+
</CommandTable>
1457+
13911458
### sim files upload
13921459

13931460
Upload a file to the workspace

0 commit comments

Comments
 (0)