@welshare/react 0.0.1-alpha.2 → 0.2.0

package/README.md

@@ -81,6 +81,49 @@ export function QuestionnaireForm() {
 }
 ```
 
+### Binary file uploads (e.g. images)
+
+binary file uploads require a lot of back and forth with the wallet dialog that we wrapped into one convenient upload API. If you want to include binary uploads into your questionnaires, you would typically hook into your own form, upload the file using the `uploadFile` function exposed by the `useWelshare` hook and use the response information to in the respective questionnaire form answer item.
+
+Each download should contain a reference to the resource that initiated its upload. As Welshare right now is mostly about questionnaires, you should use a combination of the resource type (questionnaire), the questionnaire id and the answer item's id
+
+```ts
+const reference = `questionnaire/${questionnaireId}/${answerItemId}`;
+```
+
+Binary files are addressed as items of type `valueAttachment` in Fhir. See https://www.hl7.org/fhir/questionnaireresponse.html 
+
+Before uploading, welshare encrypts all files with a new random symmetric AES (GCM / 256 bits) key. Users request a presigned upload url and post the encrypted file to an S3 compatible API of ours. Finally, they encrypt the encryption key on a user controlled Nillion *owned* collection for binary data and grant respective access rights for the application. The application a user used to upload the file is by default able to download the file again (Technically, that application is always welshare right now. This will change to the "builder" address of the respective app and the hpmp enclave keys, which allow AI access to the files)
+
+Here's an example how to use it:   
+
+```ts
+  const { isConnected, openWallet, uploadFile, submitData } = useWelshare({
+    applicationId: process.env.NEXT_PUBLIC_WELSHARE_APP_ID || ""
+  })
+  //... let users select a file on their box
+
+  const { url: uploadedFileUrl, binaryFileUid } = await uploadFile(
+    userFile,
+    reference: `questionnaire/${questionnaireId}/<linkId>`
+  );
+
+  const responseItem = {
+    answer = [
+      {
+        valueAttachment: {
+          id: binaryFileUid,
+          contentType: userFile.type,
+          size: userFile.size,
+          title: userFile.name,
+          url: uploadedFileUrl,
+        },
+      },
+    ];
+  }
+  // insert the responseItem into your QuestionnaireResponse
+```
+
 ## API
 
 ### supported callbacks
@@ -94,6 +137,7 @@ those are configured in the `useWelshare` options parameter and called back duri
     onSessionReady?: (sessionPubKey: string) => void;
     onDialogClosing?: () => void;
     onDialogReady?: () => void;
+    onFileUploaded?: (insertedUid: string, url: string) => void
   }
 ```
 

package/dist/esm/hooks/use-welshare.d.ts

@@ -4,7 +4,12 @@ export declare const useWelshare: (props: WelshareConnectionOptions) => {
     storageKey: string | undefined;
     openWallet: () => void;
     isDialogOpen: boolean;
+    uploadFile: (file: File, reference: string) => Promise<{
+        url: string;
+        binaryFileUid: string;
+    }>;
     submitData: <T>(schemaId: SubmissionSchemaId, submission: SubmissionPayload<T>) => void;
+    uploadState: "preparing" | "uploading" | "anchoring" | "finished" | "error" | undefined;
     isSubmitting: boolean;
 };
 //# sourceMappingURL=use-welshare.d.ts.map

package/dist/esm/hooks/use-welshare.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-welshare.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-welshare.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,YAAY,CAAC;AAGpB,eAAO,MAAM,WAAW,UAAW,yBAAyB;;;;;iBAkFtC,CAAC,YACT,kBAAkB,cAChB,iBAAiB,CAAC,CAAC,CAAC;;CAuDnC,CAAC"}
+{"version":3,"file":"use-welshare.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-welshare.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,iBAAiB,EACjB,kBAAkB,EAElB,yBAAyB,EAC1B,MAAM,YAAY,CAAC;AAIpB,eAAO,MAAM,WAAW,UAAW,yBAAyB;;;;;uBAmLlD,IAAI,aACC,MAAM,KAChB,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC;iBA0C9B,CAAC,YACT,kBAAkB,cAChB,iBAAiB,CAAC,CAAC,CAAC;;;CAqEnC,CAAC"}

package/dist/esm/hooks/use-welshare.js

@@ -1,18 +1,21 @@
-import { useEffect, useState } from "react";
+import { useEffect, useRef, useState } from "react";
+import { encryptAndUploadFile } from "../lib/uploads.js";
 export const useWelshare = (props) => {
     const [storageKey, setStorageKey] = useState();
     const [isDialogOpen, setIsDialogOpen] = useState(false);
     const [dialogWindow, setDialogWindow] = useState(null);
     const [messageIdCounter, setMessageIdCounter] = useState(0);
     const [isSubmitting, setIsSubmitting] = useState(false);
+    const [uploadState, setUploadState] = useState();
+    // (claude opus) Use ref to control current upload in effect without triggering re-renders
+    const currentUploadRef = useRef(null);
     const options = {
-        environment: "development",
         apiBaseUrl: "https://wallet.welshare.app",
         ...props,
     };
     const WELSHARE_WALLET_URL = `${options.apiBaseUrl}/wallet-external`;
     useEffect(() => {
-        const handleMessage = (event) => {
+        const handleMessage = async (event) => {
             // Verify origin for security
             if (event.origin !== new URL(WELSHARE_WALLET_URL).origin) {
                 return;
@@ -24,6 +27,10 @@ export const useWelshare = (props) => {
                     errorMessage = message.payload.error || "An unknown error occurred";
                     console.error("Welshare Wallet sent an error:", errorMessage);
                     setIsSubmitting(false);
+                    // Reject the promise if there's an ongoing upload
+                    if (currentUploadRef.current?.uploadPromise) {
+                        currentUploadRef.current.uploadPromise.reject(new Error(errorMessage));
+                    }
                     options.callbacks.onError?.(errorMessage);
                     break;
                 case "DIALOG_READY":
@@ -46,6 +53,10 @@ export const useWelshare = (props) => {
                     console.debug("Welshare Wallet Dialog is closing");
                     setStorageKey(undefined);
                     setIsDialogOpen(false);
+                    // Reject any pending upload promises
+                    if (currentUploadRef.current?.uploadPromise) {
+                        currentUploadRef.current.uploadPromise.reject(new Error("Dialog closed before upload completed"));
+                    }
                     options.callbacks.onDialogClosing?.();
                     break;
                 case "DATA_UPLOADED":
@@ -53,6 +64,62 @@ export const useWelshare = (props) => {
                     setIsSubmitting(false);
                     options.callbacks.onUploaded?.(message.payload);
                     break;
+                //todo: make this work for batches, too
+                case "UPLOAD_CREDENTIALS_CREATED":
+                    const credentials = message.payload;
+                    console.debug("upload credentials created", credentials);
+                    if (!currentUploadRef.current) {
+                        throw new Error("No upload in progress");
+                    }
+                    if (!dialogWindow) {
+                        currentUploadRef.current.uploadPromise.reject(new Error("(UPLOAD_CREDENTIALS_CREATED) Dialog window not open"));
+                        return;
+                    }
+                    try {
+                        setUploadState("uploading");
+                        const encodedEncryptionKey = await encryptAndUploadFile(currentUploadRef.current.file, credentials.presignedUrl);
+                        setUploadState("anchoring");
+                        const binarySubmissionPayload = {
+                            timestamp: currentUploadRef.current.timestamp,
+                            applicationId: options.applicationId,
+                            reference: currentUploadRef.current.reference,
+                            fileName: currentUploadRef.current.fileName,
+                            fileType: currentUploadRef.current.fileType,
+                            encryptionKey: encodedEncryptionKey,
+                            fileSize: currentUploadRef.current.file.size,
+                            url: `welshare://${credentials.uploadKey}`,
+                        };
+                        //write to Nillion
+                        const message = {
+                            type: "SUBMIT_BINARY_DATA",
+                            id: String(messageIdCounter),
+                            payload: binarySubmissionPayload,
+                        };
+                        dialogWindow.postMessage(message, WELSHARE_WALLET_URL);
+                        setMessageIdCounter((prev) => prev + 1);
+                    }
+                    catch (error) {
+                        console.error("error uploading file", error);
+                        // Update status to error
+                        currentUploadRef.current.uploadPromise.reject(error);
+                        setUploadState("error");
+                        // Call error callback
+                        const errorMsg = error instanceof Error ? error.message : "Upload failed";
+                        options.callbacks.onError?.(errorMsg);
+                    }
+                    break;
+                //{insertetUid, errors}
+                case "BINARY_DATA_SUBMITTED":
+                    if (!currentUploadRef.current) {
+                        throw new Error("No upload in progress");
+                    }
+                    currentUploadRef.current.uploadPromise.resolve({
+                        url: message.payload.url,
+                        binaryFileUid: message.payload.insertedUid,
+                    });
+                    setUploadState("finished");
+                    options.callbacks.onFileUploaded?.(message.payload.insertedUid, message.payload.url);
+                    break;
                 default:
                     console.log("Received unexpected message from Welshare Wallet:", message);
             }
@@ -61,14 +128,53 @@ export const useWelshare = (props) => {
         return () => {
             window.removeEventListener("message", handleMessage);
         };
-    }, [WELSHARE_WALLET_URL, options.callbacks]);
+    }, [WELSHARE_WALLET_URL, dialogWindow, messageIdCounter, options.applicationId, options.callbacks]);
+    /**
+     * Starts a file upload and returns a promise that resolves with the uploaded file URL
+     * @param file The file to upload
+     * @param reference string A reference identifier for the upload
+     * @returns Promise<{ url: string; binaryFileUid: string }> url usually starts with welshare:// and resolves to an encrypted storage location
+     */
+    const uploadFile = (file, reference) => {
+        return new Promise((resolve, reject) => {
+            if (!dialogWindow) {
+                reject(new Error("(uploadFile) Dialog window not open"));
+                return;
+            }
+            const payload = {
+                timestamp: new Date(),
+                applicationId: options.applicationId,
+                reference: reference,
+                fileName: file.name,
+                fileType: file.type,
+            };
+            setUploadState("preparing");
+            // (claude opus) Store the upload with the file and promise handlers on a ref
+            currentUploadRef.current = {
+                ...payload,
+                file,
+                reference,
+                uploadPromise: { resolve, reject },
+            };
+            const message = {
+                type: "REQUEST_UPLOAD_CREDENTIALS",
+                id: String(messageIdCounter),
+                payload: {
+                    ...payload,
+                    applicationId: options.applicationId,
+                },
+            };
+            dialogWindow.postMessage(message, WELSHARE_WALLET_URL);
+            setMessageIdCounter((prev) => prev + 1);
+        });
+    };
     /**
      * @param schemaType a welshare schema type uid
      * @param submission your submission that validates against the schema type
      */
     const submitData = (schemaId, submission) => {
         if (!dialogWindow) {
-            throw new Error("Dialog window not open");
+            throw new Error("(submitData) Dialog window not open");
         }
         const submissionPayload = {
             applicationId: options.applicationId,
@@ -92,10 +198,20 @@ export const useWelshare = (props) => {
     };
     const openWallet = () => {
         const width = 800;
-        const height = 600;
+        const height = 700;
         const left = window.screenX + (window.outerWidth - width) / 2;
         const top = window.screenY + (window.outerHeight - height) / 2;
-        const newWindow = window.open(WELSHARE_WALLET_URL, "Welshare Wallet", `width=${width},height=${height},left=${left},top=${top}`);
+        let socialParams = "";
+        if (options.interpolateSocials) {
+            const socialEntries = Object.entries(options.interpolateSocials)
+                .filter(([_, value]) => value !== undefined && value !== null)
+                .map(([key, value]) => `social.${key}=${encodeURIComponent(String(value))}`);
+            if (socialEntries.length > 0) {
+                socialParams = `&${socialEntries.join('&')}`;
+            }
+        }
+        const walletUrl = `${WELSHARE_WALLET_URL}?applicationId=${options.applicationId}${socialParams}`;
+        const newWindow = window.open(walletUrl, "Welshare Wallet", `width=${width},height=${height},left=${left},top=${top}`);
         if (newWindow) {
             setDialogWindow(newWindow);
         }
@@ -105,7 +221,9 @@ export const useWelshare = (props) => {
         storageKey,
         openWallet,
         isDialogOpen,
+        uploadFile,
         submitData,
+        uploadState,
         isSubmitting,
     };
 };

package/dist/esm/index.d.ts

@@ -1,7 +1,10 @@
 export { ConnectWelshareButton } from "./components/connect-button.js";
 export { useWelshare } from "./hooks/use-welshare.js";
+export { decodeEncryptionKey, decrypt, encodeEncryptionKey, encryptFile, generateRandomAESKey, type EncryptionKey } from "./lib/encryption.js";
+export { encryptAndUploadFile } from "./lib/uploads.js";
 export declare const Schemas: {
     QuestionnaireResponse: string;
     ReflexSubmission: string;
+    BinaryFile: string;
 };
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAEvE,OAAO,EACL,WAAW,EACZ,MAAM,yBAAyB,CAAC;AAGjC,eAAO,MAAM,OAAO;;;CAGnB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EACL,mBAAmB,EACnB,OAAO,EACP,mBAAmB,EACnB,WAAW,EACX,oBAAoB,EACpB,KAAK,aAAa,EACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,eAAO,MAAM,OAAO;;;;CAInB,CAAC"}

package/dist/esm/index.js

@@ -3,8 +3,11 @@
 export { ConnectWelshareButton } from "./components/connect-button.js";
 // ---- hooks ----
 export { useWelshare } from "./hooks/use-welshare.js";
+export { decodeEncryptionKey, decrypt, encodeEncryptionKey, encryptFile, generateRandomAESKey } from "./lib/encryption.js";
+export { encryptAndUploadFile } from "./lib/uploads.js";
 //todo: import them from the SDK or a dedicated SDK constants export
 export const Schemas = {
     QuestionnaireResponse: "b14b538f-7de3-4767-ad77-464d755d78bd", //QuestionnaireResponseSchema.schemaUid,
-    ReflexSubmission: "f5cf2d8a-1f78-4f21-b4bd-082e983b830c" //ReflexSubmissionSchema.schemaUid,
+    ReflexSubmission: "f5cf2d8a-1f78-4f21-b4bd-082e983b830c", //ReflexSubmissionSchema.schemaUid,
+    BinaryFile: "9d696baf-483f-4cc0-b748-23a22c1705f5" //BinaryFilesSchema.schemaUid,
 };

package/dist/esm/lib/encryption.d.ts

@@ -0,0 +1,19 @@
+export declare const ALGORITHM = "AES-GCM";
+export type Algorithm = "AES-GCM";
+export declare const generateRandomAESKey: () => Promise<CryptoKey>;
+export declare const encryptFile: (file: File, key: CryptoKey) => Promise<{
+    encryptedData: ArrayBuffer;
+    iv: Uint8Array;
+}>;
+export type EncryptionKey = {
+    algorithm: Algorithm;
+    key: string;
+    iv: string;
+};
+export declare const encodeEncryptionKey: (key: CryptoKey, iv: Uint8Array) => Promise<EncryptionKey>;
+export declare const decodeEncryptionKey: (encryptionKey: EncryptionKey) => {
+    key: Uint8Array<ArrayBuffer>;
+    iv: Uint8Array<ArrayBuffer>;
+};
+export declare const decrypt: (encryptedData: ArrayBuffer, encryptionKey: EncryptionKey) => Promise<ArrayBuffer | null>;
+//# sourceMappingURL=encryption.d.ts.map

package/dist/esm/lib/encryption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption.d.ts","sourceRoot":"","sources":["../../../src/lib/encryption.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,YAAY,CAAC;AACnC,MAAM,MAAM,SAAS,GAAG,SAAS,CAAC;AAElC,eAAO,MAAM,oBAAoB,QAAa,OAAO,CAAC,SAAS,CAU9D,CAAC;AAIF,eAAO,MAAM,WAAW,SAChB,IAAI,OACL,SAAS,KACb,OAAO,CAAC;IAAE,aAAa,EAAE,WAAW,CAAC;IAAC,EAAE,EAAE,UAAU,CAAA;CAAE,CAgBxD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,eAAO,MAAM,mBAAmB,QACzB,SAAS,MACV,UAAU,KACb,OAAO,CAAC,aAAa,CAgBvB,CAAC;AAEF,eAAO,MAAM,mBAAmB,kBACf,aAAa,KAC3B;IAAE,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAAC,EAAE,EAAE,UAAU,CAAC,WAAW,CAAC,CAAA;CAU7D,CAAC;AAGF,eAAO,MAAM,OAAO,kBACH,WAAW,iBACX,aAAa,KAC3B,OAAO,CAAC,WAAW,GAAG,IAAI,CA0B5B,CAAC"}

package/dist/esm/lib/encryption.js

@@ -0,0 +1,61 @@
+export const ALGORITHM = "AES-GCM";
+export const generateRandomAESKey = async () => {
+    // Generate a 256-bit AES-GCM key for file encryption
+    return window.crypto.subtle.generateKey({
+        name: ALGORITHM,
+        length: 256, // 256-bit key
+    }, true, // Key is extractable (needed for storage/transmission)
+    ["encrypt", "decrypt"] // Key usage
+    );
+};
+/// also Generates random IV (12 bytes for AES-GCM)
+/// @return {arraybuffer ciphertext, uint8array iv}
+export const encryptFile = async (file, key) => {
+    // Read file as ArrayBuffer
+    const fileData = await file.arrayBuffer();
+    const iv = window.crypto.getRandomValues(new Uint8Array(12));
+    // Encrypt the file data
+    const encryptedData = await window.crypto.subtle.encrypt({
+        name: ALGORITHM,
+        iv: iv,
+    }, key, fileData);
+    return { encryptedData, iv };
+};
+export const encodeEncryptionKey = async (key, iv) => {
+    // Export the key as raw bytes
+    const exportedKey = await window.crypto.subtle.exportKey("raw", key);
+    const keyHex = Array.from(new Uint8Array(exportedKey))
+        .map((b) => b.toString(16).padStart(2, "0"))
+        .join("");
+    const ivHex = Array.from(iv)
+        .map((b) => b.toString(16).padStart(2, "0"))
+        .join("");
+    return {
+        algorithm: ALGORITHM,
+        key: keyHex,
+        iv: ivHex,
+    };
+};
+export const decodeEncryptionKey = (encryptionKey) => {
+    const keyBytes = new Uint8Array(encryptionKey.key
+        .match(/.{1,2}/g)
+        .map((byte) => parseInt(byte, 16)));
+    const ivBytes = new Uint8Array(encryptionKey.iv.match(/.{1,2}/g).map((byte) => parseInt(byte, 16)));
+    return { key: keyBytes, iv: ivBytes };
+};
+// Helper function to decrypt a file using encoded encryption key
+export const decrypt = async (encryptedData, encryptionKey) => {
+    try {
+        const { key: keyBytes, iv } = decodeEncryptionKey(encryptionKey);
+        const key = await window.crypto.subtle.importKey("raw", keyBytes, { name: ALGORITHM }, false, ["decrypt"]);
+        const decryptedData = await window.crypto.subtle.decrypt({
+            name: ALGORITHM,
+            iv,
+        }, key, encryptedData);
+        return decryptedData;
+    }
+    catch (error) {
+        console.error("Failed to decrypt file:", error);
+        return null;
+    }
+};

package/dist/esm/lib/uploads.d.ts

@@ -0,0 +1,3 @@
+import { EncryptionKey } from "./encryption.js";
+export declare const encryptAndUploadFile: (file: File, presignedUrl: string) => Promise<EncryptionKey>;
+//# sourceMappingURL=uploads.d.ts.map

package/dist/esm/lib/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["../../../src/lib/uploads.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EAEd,MAAM,iBAAiB,CAAC;AAEzB,eAAO,MAAM,oBAAoB,SACzB,IAAI,gBACI,MAAM,KACnB,OAAO,CAAC,aAAa,CAkBvB,CAAC"}

package/dist/esm/lib/uploads.js

@@ -0,0 +1,17 @@
+import { encodeEncryptionKey, encryptFile, generateRandomAESKey, } from "./encryption.js";
+export const encryptAndUploadFile = async (file, presignedUrl) => {
+    const encryptionKey = await generateRandomAESKey();
+    const { encryptedData, iv } = await encryptFile(file, encryptionKey);
+    // Upload encrypted file to S3
+    const uploadResponse = await fetch(presignedUrl, {
+        method: "PUT",
+        body: encryptedData,
+        headers: {
+            "Content-Type": file.type,
+        },
+    });
+    if (!uploadResponse.ok) {
+        throw new Error(`Failed to upload file ${uploadResponse.status}`);
+    }
+    return encodeEncryptionKey(encryptionKey, iv);
+};

package/dist/esm/types.d.ts

@@ -1,9 +1,9 @@
+import { EncryptionKey } from "./lib/encryption.js";
 export interface DialogMessage {
     type: string;
     payload?: any;
     id?: string;
 }
-export type WelshareEnvironment = "development" | "production";
 /**
  * a welshare schema type uid
  */
@@ -14,14 +14,46 @@ export interface SubmissionPayload<T> {
     schemaId: SubmissionSchemaId;
     submission: T;
 }
+export type UploadCredentials = {
+    presignedUrl: string;
+    uploadKey: string;
+};
+export interface RequestUploadCredentialsPayload {
+    timestamp?: Date;
+    applicationId: string;
+    reference: string;
+    fileName: string;
+    fileType: string;
+}
+export interface BinaryFileSubmissionPayload extends RequestUploadCredentialsPayload {
+    encryptionKey: EncryptionKey;
+    fileSize: number;
+    url: string;
+}
+export interface RunningFileUpload extends RequestUploadCredentialsPayload {
+    credentials?: UploadCredentials;
+    file: File;
+    reference: string;
+    uploadPromise: {
+        resolve: (result: {
+            url: string;
+            binaryFileUid: string;
+        }) => void;
+        reject: (error: Error) => void;
+    };
+}
 export interface DataSubmissionDialogMessage extends DialogMessage {
-    payload: SubmissionPayload<unknown>;
+    payload: SubmissionPayload<unknown> | BinaryFileSubmissionPayload | RequestUploadCredentialsPayload;
 }
 export interface WelshareConnectionOptions {
     applicationId: string;
+    interpolateSocials?: {
+        emailAddress?: string;
+        privy?: string;
+    };
     apiBaseUrl?: string;
-    environment?: WelshareEnvironment;
     callbacks: {
+        onFileUploaded?: (insertedUid: string, url: string) => void;
         onUploaded?: (payload: SubmissionPayload<unknown>) => void;
         onError?: (error: string) => void;
         onSessionReady?: (sessionPubKey: string) => void;

package/dist/esm/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG,YAAY,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAA;AAEvC,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,IAAI,CAAC;IAChB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,UAAU,EAAE,CAAC,CAAC;CACf;AAED,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,MAAM,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,SAAS,EAAE;QACT,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;QAC3D,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;QAClC,cAAc,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,IAAI,CAAC;QACjD,eAAe,CAAC,EAAE,MAAM,IAAI,CAAC;QAC7B,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;KAC5B,CAAC;CACH"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAA;AAEvC,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,IAAI,CAAC;IAChB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,UAAU,EAAE,CAAC,CAAC;CACf;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,MAAM,WAAW,+BAA+B;IAC9C,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,2BAA4B,SAAQ,+BAA+B;IAClF,aAAa,EAAE,aAAa,CAAC;IAE7B,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iBAAkB,SAAQ,+BAA+B;IACxE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE;QACb,OAAO,EAAE,CAAC,MAAM,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,aAAa,EAAE,MAAM,CAAA;SAAE,KAAK,IAAI,CAAC;QAClE,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;KAChC,CAAC;CACH;AAED,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE,OAAO,EACH,iBAAiB,CAAC,OAAO,CAAC,GAC1B,2BAA2B,GAC3B,+BAA+B,CAAC;CACrC;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAA;IAED,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE;QACT,cAAc,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;QAC5D,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;QAC3D,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;QAClC,cAAc,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,IAAI,CAAC;QACjD,eAAe,CAAC,EAAE,MAAM,IAAI,CAAC;QAC7B,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;KAC5B,CAAC;CACH"}

package/dist/node_modules/@welshare/react/README.md

@@ -81,6 +81,49 @@ export function QuestionnaireForm() {
 }
 ```
 
+### Binary file uploads (e.g. images)
+
+binary file uploads require a lot of back and forth with the wallet dialog that we wrapped into one convenient upload API. If you want to include binary uploads into your questionnaires, you would typically hook into your own form, upload the file using the `uploadFile` function exposed by the `useWelshare` hook and use the response information to in the respective questionnaire form answer item.
+
+Each download should contain a reference to the resource that initiated its upload. As Welshare right now is mostly about questionnaires, you should use a combination of the resource type (questionnaire), the questionnaire id and the answer item's id
+
+```ts
+const reference = `questionnaire/${questionnaireId}/${answerItemId}`;
+```
+
+Binary files are addressed as items of type `valueAttachment` in Fhir. See https://www.hl7.org/fhir/questionnaireresponse.html 
+
+Before uploading, welshare encrypts all files with a new random symmetric AES (GCM / 256 bits) key. Users request a presigned upload url and post the encrypted file to an S3 compatible API of ours. Finally, they encrypt the encryption key on a user controlled Nillion *owned* collection for binary data and grant respective access rights for the application. The application a user used to upload the file is by default able to download the file again (Technically, that application is always welshare right now. This will change to the "builder" address of the respective app and the hpmp enclave keys, which allow AI access to the files)
+
+Here's an example how to use it:   
+
+```ts
+  const { isConnected, openWallet, uploadFile, submitData } = useWelshare({
+    applicationId: process.env.NEXT_PUBLIC_WELSHARE_APP_ID || ""
+  })
+  //... let users select a file on their box
+
+  const { url: uploadedFileUrl, binaryFileUid } = await uploadFile(
+    userFile,
+    reference: `questionnaire/${questionnaireId}/<linkId>`
+  );
+
+  const responseItem = {
+    answer = [
+      {
+        valueAttachment: {
+          id: binaryFileUid,
+          contentType: userFile.type,
+          size: userFile.size,
+          title: userFile.name,
+          url: uploadedFileUrl,
+        },
+      },
+    ];
+  }
+  // insert the responseItem into your QuestionnaireResponse
+```
+
 ## API
 
 ### supported callbacks
@@ -94,6 +137,7 @@ those are configured in the `useWelshare` options parameter and called back duri
     onSessionReady?: (sessionPubKey: string) => void;
     onDialogClosing?: () => void;
     onDialogReady?: () => void;
+    onFileUploaded?: (insertedUid: string, url: string) => void
   }
 ```
 

package/dist/node_modules/@welshare/react/dist/esm/hooks/use-welshare.d.ts

@@ -4,7 +4,12 @@ export declare const useWelshare: (props: WelshareConnectionOptions) => {
     storageKey: string | undefined;
     openWallet: () => void;
     isDialogOpen: boolean;
+    uploadFile: (file: File, reference: string) => Promise<{
+        url: string;
+        binaryFileUid: string;
+    }>;
     submitData: <T>(schemaId: SubmissionSchemaId, submission: SubmissionPayload<T>) => void;
+    uploadState: "preparing" | "uploading" | "anchoring" | "finished" | "error" | undefined;
     isSubmitting: boolean;
 };
 //# sourceMappingURL=use-welshare.d.ts.map

package/dist/node_modules/@welshare/react/dist/esm/hooks/use-welshare.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-welshare.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-welshare.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,YAAY,CAAC;AAGpB,eAAO,MAAM,WAAW,UAAW,yBAAyB;;;;;iBAkFtC,CAAC,YACT,kBAAkB,cAChB,iBAAiB,CAAC,CAAC,CAAC;;CAuDnC,CAAC"}
+{"version":3,"file":"use-welshare.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-welshare.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,iBAAiB,EACjB,kBAAkB,EAElB,yBAAyB,EAC1B,MAAM,YAAY,CAAC;AAIpB,eAAO,MAAM,WAAW,UAAW,yBAAyB;;;;;uBAmLlD,IAAI,aACC,MAAM,KAChB,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC;iBA0C9B,CAAC,YACT,kBAAkB,cAChB,iBAAiB,CAAC,CAAC,CAAC;;;CAqEnC,CAAC"}