@getvouch/sdk 0.1.3 → 0.1.4

package/README.md

@@ -2,7 +2,7 @@
 
 [![Static Badge](https://img.shields.io/badge/vouch-read_docs-green?style=for-the-badge)](https://docs.getvouch.io/introduction)
 
-This is the vouch SDK, a TypeScript library for interacting with vouch. Currently, it allows you to generate a link to start the web proof flow.
+This is the vouch SDK, a TypeScript library for interacting with vouch. Currently, it allows you to generate links to start the web proof flow or direct users to a widget page.
 
 ## Installation
 
@@ -47,7 +47,7 @@ const url = vouch.getStartUrl({
 });
 ```
 
-### Adding inputs
+#### Adding inputs
 
 [Learn more about inputs](https://docs.getvouch.io/getting-started/handling-inputs).
 
@@ -74,3 +74,17 @@ const url = vouch.getStartUrl({
 
 The inputs will be encoded to base64, so you'd see something like this inside the URL:
 `inputs=eyJuYW1lIjoiSm9obiBEb2UiLCJtaW5Gb2xsb3dlcnNDb3VudCI6MTMzN30`
+
+### Get widget URL
+
+Generate a link to a widget page where users can choose from available data sources.
+
+```typescript
+const url = vouch.getWidgetUrl({
+  widgetId: "41b9a0c3-1234-5678-9abc-def012345678", // Your widget ID. Must be a UUIDv4.
+  redirectBackUrl: "https://example.com/callback", // Return destination after proof completion.
+  requestId, // (Optional) If not provided, a new request ID will be generated.
+  customerId: "1be03be8-5014-413c-835a-feddf4020da2", // (Optional) Your unique customer ID. Defaults to demo customer ID.
+  webhookUrl: "https://example.com/webhook", // (Optional) Proof delivery endpoint.
+});
+```

package/dist/lib/vouch.d.ts

@@ -9,8 +9,16 @@ export interface VouchUrlParams {
     inputs?: Record<string, unknown>;
     webhookUrl?: string;
 }
+export interface WidgetUrlParams {
+    widgetId: string;
+    redirectBackUrl: string;
+    customerId?: string;
+    requestId?: string;
+    webhookUrl?: string;
+}
 export declare class Vouch {
     host: URL;
     constructor({ vouchHost }?: Config);
     getStartUrl({ customerId, datasourceId, requestId, redirectBackUrl, inputs, webhookUrl, }: VouchUrlParams): URL;
+    getWidgetUrl({ widgetId, redirectBackUrl, customerId, requestId, webhookUrl, }: WidgetUrlParams): URL;
 }

package/dist/lib/vouch.js

@@ -2,7 +2,7 @@ import { validatedHost } from "../utils/validated-host";
 import { validatedUuidV4 } from "../utils/validated-uuid";
 import { encodeInputs } from "../utils/encode-inputs";
 const DEFAULT_VOUCH_HOST = "https://app.getvouch.io";
-const DEFAULT_CUSTOMER_ID = "1be03be8-5014-413c-835a-feddf4020da2";
+const DEMO_CUSTOMER_ID = "1be03be8-5014-413c-835a-feddf4020da2";
 export class Vouch {
     constructor({ vouchHost = DEFAULT_VOUCH_HOST } = {}) {
         this.host = validatedHost(vouchHost);
@@ -14,7 +14,7 @@ export class Vouch {
                 : crypto.randomUUID(),
             customerId: customerId
                 ? validatedUuidV4(customerId, "customerId")
-                : DEFAULT_CUSTOMER_ID,
+                : DEMO_CUSTOMER_ID,
             datasourceId: validatedUuidV4(datasourceId, "datasourceId"),
             redirectBackUrl,
         });
@@ -24,6 +24,22 @@ export class Vouch {
         if (webhookUrl) {
             params.set("webhookUrl", webhookUrl);
         }
-        return new URL(`/start?${params.toString()}`, this.host);
+        return new URL(`/prove?${params.toString()}`, this.host);
+    }
+    getWidgetUrl({ widgetId, redirectBackUrl, customerId, requestId, webhookUrl, }) {
+        const params = new URLSearchParams({
+            requestId: requestId
+                ? validatedUuidV4(requestId, "requestId")
+                : crypto.randomUUID(),
+            customerId: customerId
+                ? validatedUuidV4(customerId, "customerId")
+                : DEMO_CUSTOMER_ID,
+            redirectBackUrl,
+        });
+        if (webhookUrl) {
+            params.set("webhookUrl", webhookUrl);
+        }
+        const path = `/widget/${validatedUuidV4(widgetId, "widgetId")}`;
+        return new URL(`${path}?${params.toString()}`, this.host);
     }
 }

package/dist/lib/vouch.test.js

@@ -19,7 +19,7 @@ describe("Vouch SDK", () => {
                 redirectBackUrl: "https://example.com/redirect",
             };
             const url = vouch.getStartUrl(params);
-            expect(url.toString()).toBe(`https://app.getvouch.io/start?requestId=${params.requestId}&customerId=${params.customerId}&datasourceId=${params.datasourceId}&redirectBackUrl=${encodeURIComponent(params.redirectBackUrl)}`);
+            expect(url.toString()).toBe(`https://app.getvouch.io/prove?requestId=${params.requestId}&customerId=${params.customerId}&datasourceId=${params.datasourceId}&redirectBackUrl=${encodeURIComponent(params.redirectBackUrl)}`);
         });
         it("adds inputs", () => {
             const params = {
@@ -30,7 +30,7 @@ describe("Vouch SDK", () => {
                 inputs: { key: "value" },
             };
             const url = vouch.getStartUrl(params);
-            expect(url.toString()).toBe(`https://app.getvouch.io/start?requestId=${params.requestId}&customerId=${params.customerId}&datasourceId=${params.datasourceId}&redirectBackUrl=${encodeURIComponent(params.redirectBackUrl)}&inputs=eyJrZXkiOiJ2YWx1ZSJ9`);
+            expect(url.toString()).toBe(`https://app.getvouch.io/prove?requestId=${params.requestId}&customerId=${params.customerId}&datasourceId=${params.datasourceId}&redirectBackUrl=${encodeURIComponent(params.redirectBackUrl)}&inputs=eyJrZXkiOiJ2YWx1ZSJ9`);
         });
         it("adds webhookUrl", () => {
             const params = {
@@ -41,7 +41,7 @@ describe("Vouch SDK", () => {
                 webhookUrl: "https://example.com/webhook",
             };
             const url = vouch.getStartUrl(params);
-            expect(url.toString()).toBe(`https://app.getvouch.io/start?requestId=${params.requestId}&customerId=${params.customerId}&datasourceId=${params.datasourceId}&redirectBackUrl=${encodeURIComponent(params.redirectBackUrl)}&webhookUrl=${encodeURIComponent(params.webhookUrl)}`);
+            expect(url.toString()).toBe(`https://app.getvouch.io/prove?requestId=${params.requestId}&customerId=${params.customerId}&datasourceId=${params.datasourceId}&redirectBackUrl=${encodeURIComponent(params.redirectBackUrl)}&webhookUrl=${encodeURIComponent(params.webhookUrl)}`);
         });
         it("generates requestId", () => {
             var _a;
@@ -76,4 +76,61 @@ describe("Vouch SDK", () => {
             });
         });
     });
+    describe("getWidgetUrl", () => {
+        let vouch;
+        beforeEach(() => {
+            vouch = new Vouch();
+        });
+        it("constructs correct URL", () => {
+            const params = {
+                widgetId: crypto.randomUUID(),
+                requestId: crypto.randomUUID(),
+                customerId: crypto.randomUUID(),
+                redirectBackUrl: "https://example.com/redirect",
+                webhookUrl: "https://example.com/webhook",
+            };
+            const url = vouch.getWidgetUrl(params);
+            expect(url.toString()).toBe(`https://app.getvouch.io/widget/${params.widgetId}?requestId=${params.requestId}&customerId=${params.customerId}&redirectBackUrl=${encodeURIComponent(params.redirectBackUrl)}&webhookUrl=${encodeURIComponent(params.webhookUrl)}`);
+        });
+        it("generates requestId", () => {
+            const params = {
+                widgetId: crypto.randomUUID(),
+                redirectBackUrl: "https://example.com/redirect",
+            };
+            const url = vouch.getWidgetUrl(params);
+            const generatedRequestId = url.searchParams.get("requestId");
+            expect(generatedRequestId).not.toBeNull();
+            expect(() => validatedUuidV4(generatedRequestId !== null && generatedRequestId !== void 0 ? generatedRequestId : "")).not.toThrow();
+        });
+        it("sets default customerId", () => {
+            const params = {
+                widgetId: crypto.randomUUID(),
+                redirectBackUrl: "https://example.com/redirect",
+            };
+            const url = vouch.getWidgetUrl(params);
+            expect(url.searchParams.get("customerId")).toBe("1be03be8-5014-413c-835a-feddf4020da2");
+        });
+        it("validates UUIDs", () => {
+            const params = {
+                widgetId: crypto.randomUUID(),
+                requestId: crypto.randomUUID(),
+                customerId: crypto.randomUUID(),
+                redirectBackUrl: "https://example.com/redirect",
+            };
+            expect(() => vouch.getWidgetUrl(Object.assign(Object.assign({}, params), { widgetId: "invalid-uuid" }))).toThrow("Invalid UUIDv4 for widgetId: invalid-uuid");
+            expect(() => vouch.getWidgetUrl(Object.assign(Object.assign({}, params), { requestId: "invalid-uuid" }))).toThrow("Invalid UUIDv4 for requestId: invalid-uuid");
+            expect(() => vouch.getWidgetUrl(Object.assign(Object.assign({}, params), { customerId: "invalid-uuid" }))).toThrow("Invalid UUIDv4 for customerId: invalid-uuid");
+        });
+        it("handles custom host", () => {
+            const customVouch = new Vouch({ vouchHost: "https://example.com" });
+            const params = {
+                widgetId: crypto.randomUUID(),
+                requestId: crypto.randomUUID(),
+                customerId: crypto.randomUUID(),
+                redirectBackUrl: "https://example.com/redirect",
+            };
+            const url = customVouch.getWidgetUrl(params);
+            expect(url.toString()).toBe(`https://example.com/widget/${params.widgetId}?requestId=${params.requestId}&customerId=${params.customerId}&redirectBackUrl=${encodeURIComponent(params.redirectBackUrl)}`);
+        });
+    });
 });

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@getvouch/sdk",
   "author": "vouch",
+  "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {
@@ -8,7 +9,7 @@
     "url": "git+https://github.com/vlayer-xyz/vouch.git#main"
   },
   "private": false,
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "vouch SDK",
   "keywords": [
     "webproof",