Merge pull request #504 from thecodacus/bundle-artifact

feat(UI): added artifact bundling for custom long artifacts like uploading folder

Author: thecodacus

app/components/chat/Artifact.tsx

@@ -28,6 +28,7 @@ interface ArtifactProps {
 export const Artifact = memo(({ messageId }: ArtifactProps) => {
   const userToggledActions = useRef(false);
   const [showActions, setShowActions] = useState(false);
+  const [allActionFinished, setAllActionFinished] = useState(false);
 
   const artifacts = useStore(workbenchStore.artifacts);
   const artifact = artifacts[messageId];
@@ -47,6 +48,11 @@ export const Artifact = memo(({ messageId }: ArtifactProps) => {
     if (actions.length && !showActions && !userToggledActions.current) {
       setShowActions(true);
     }
+
+    if (actions.length !== 0) {
+      const finished = !actions.find((action) => action.status !== 'complete');
+      setAllActionFinished(finished);
+    }
   }, [actions]);
 
   return (
@@ -59,14 +65,26 @@ export const Artifact = memo(({ messageId }: ArtifactProps) => {
             workbenchStore.showWorkbench.set(!showWorkbench);
           }}
         >
+          {artifact.type == 'bundled' && (
+            <>
+              <div className="p-4">
+                {allActionFinished ? (
+                  <div className={'i-ph:files-light'} style={{ fontSize: '2rem' }}></div>
+                ) : (
+                  <div className={'i-svg-spinners:90-ring-with-bg'} style={{ fontSize: '2rem' }}></div>
+                )}
+              </div>
+              <div className="bg-bolt-elements-artifacts-borderColor w-[1px]" />
+            </>
+          )}
           <div className="px-5 p-3.5 w-full text-left">
             <div className="w-full text-bolt-elements-textPrimary font-medium leading-5 text-sm">{artifact?.title}</div>
             <div className="w-full w-full text-bolt-elements-textSecondary text-xs mt-0.5">Click to open Workbench</div>
           </div>
         </button>
         <div className="bg-bolt-elements-artifacts-borderColor w-[1px]" />
         <AnimatePresence>
-          {actions.length && (
+          {actions.length && artifact.type !== 'bundled' && (
             <motion.button
               initial={{ width: 0 }}
               animate={{ width: 'auto' }}
@@ -83,7 +101,7 @@ export const Artifact = memo(({ messageId }: ArtifactProps) => {
         </AnimatePresence>
       </div>
       <AnimatePresence>
-        {showActions && actions.length > 0 && (
+        {artifact.type !== 'bundled' && showActions && actions.length > 0 && (
           <motion.div
             className="actions"
             initial={{ height: 0 }}
@@ -92,6 +110,7 @@ export const Artifact = memo(({ messageId }: ArtifactProps) => {
             transition={{ duration: 0.15 }}
           >
             <div className="bg-bolt-elements-artifacts-borderColor h-[1px]" />
+
             <div className="p-5 text-left bg-bolt-elements-actions-background">
               <ActionList actions={actions} />
             </div>

app/components/chat/ImportFolderButton.tsx

@@ -79,7 +79,7 @@ ${content}
       role: 'assistant',
       content: `I'll help you set up these files.${binaryFilesMessage}
 
-<boltArtifact id="imported-files" title="Imported Files">
+<boltArtifact id="imported-files" title="Imported Files" type="bundled">
 ${fileArtifacts.join('\n\n')}
 </boltArtifact>`,
       id: generateId(),

app/lib/runtime/__snapshots__/message-parser.spec.ts.snap

@@ -29,6 +29,7 @@ exports[`StreamingMessageParser > valid artifacts with actions > should correctl
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -37,6 +38,7 @@ exports[`StreamingMessageParser > valid artifacts with actions > should correctl
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -96,6 +98,7 @@ exports[`StreamingMessageParser > valid artifacts with actions > should correctl
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -104,6 +107,7 @@ exports[`StreamingMessageParser > valid artifacts with actions > should correctl
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -112,6 +116,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -120,6 +125,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -128,6 +134,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": "bundled",
 }
 `;
 
@@ -136,6 +143,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": "bundled",
 }
 `;
 
@@ -144,6 +152,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -152,6 +161,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -160,6 +170,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -168,6 +179,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -176,6 +188,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -184,6 +197,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -192,6 +206,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -200,6 +215,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -208,6 +224,7 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;
 
@@ -216,5 +233,6 @@ exports[`StreamingMessageParser > valid artifacts without actions > should corre
   "id": "artifact_1",
   "messageId": "message_1",
   "title": "Some title",
+  "type": undefined,
 }
 `;

app/lib/runtime/message-parser.spec.ts

@@ -59,7 +59,11 @@ describe('StreamingMessageParser', () => {
         },
       ],
       [
-        ['Some text before <boltArti', 'fact', ' title="Some title" id="artifact_1">foo</boltArtifact> Some more text'],
+        [
+          'Some text before <boltArti',
+          'fact',
+          ' title="Some title" id="artifact_1" type="bundled" >foo</boltArtifact> Some more text',
+        ],
         {
           output: 'Some text before  Some more text',
           callbacks: { onArtifactOpen: 1, onArtifactClose: 1, onActionOpen: 0, onActionClose: 0 },

app/lib/runtime/message-parser.ts

@@ -192,6 +192,7 @@ export class StreamingMessageParser {
               const artifactTag = input.slice(i, openTagEnd + 1);
 
               const artifactTitle = this.#extractAttribute(artifactTag, 'title') as string;
+              const type = this.#extractAttribute(artifactTag, 'type') as string;
               const artifactId = this.#extractAttribute(artifactTag, 'id') as string;
 
               if (!artifactTitle) {
@@ -207,6 +208,7 @@ export class StreamingMessageParser {
               const currentArtifact = {
                 id: artifactId,
                 title: artifactTitle,
+                type,
               } satisfies BoltArtifactData;
 
               state.currentArtifact = currentArtifact;

app/lib/stores/workbench.ts

@@ -19,6 +19,7 @@ import { description } from '~/lib/persistence';
 export interface ArtifactState {
   id: string;
   title: string;
+  type?: string;
   closed: boolean;
   runner: ActionRunner;
 }
@@ -230,7 +231,7 @@ export class WorkbenchStore {
     // TODO: what do we wanna do and how do we wanna recover from this?
   }
 
-  addArtifact({ messageId, title, id }: ArtifactCallbackData) {
+  addArtifact({ messageId, title, id, type }: ArtifactCallbackData) {
     const artifact = this.#getArtifact(messageId);
 
     if (artifact) {
@@ -245,6 +246,7 @@ export class WorkbenchStore {
       id,
       title,
       closed: false,
+      type,
       runner: new ActionRunner(webcontainer, () => this.boltTerminal),
     });
   }

app/types/artifact.ts

@@ -1,4 +1,5 @@
 export interface BoltArtifactData {
   id: string;
   title: string;
+  type?: string | undefined;
 }