@getvouch/sdk 0.1.0 → 0.1.1

package/README.md

@@ -1,16 +1,18 @@
-# Vouch SDK
+# vouch SDK
 
-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.
+[![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.
 
 ## Installation
 
-To install the Vouch SDK, you can use npm or other package managers.
+To install the vouch SDK, you can use npm or other package managers.
 
 ```bash
-npm install @vouch/vouch-sdk
-yarn add @vouch/vouch-sdk
-pnpm add @vouch/vouch-sdk
-bun add @vouch/vouch-sdk
+npm install @getvouch/sdk
+yarn add @getvouch/sdk
+pnpm add @getvouch/sdk
+bun add @getvouch/sdk
 ```
 
 ## Usage
@@ -18,14 +20,14 @@ bun add @vouch/vouch-sdk
 Create vouch instance:
 
 ```typescript
-import { Vouch } from "@vouch/vouch-sdk";
+import { Vouch } from "@getvouch/sdk";
 const vouch = new Vouch();
 ```
 
 You may provide a configuration object with a set of optional parameters:
 
 ```typescript
-import { Vouch } from "@vouch/vouch-sdk";
+import { Vouch } from "@getvouch/sdk";
 const vouch = new Vouch({
   vouchHost: "https://app.getvouch.io", // The base URL for the Vouch API. Can be a string or an URL object. Defaults to "https://app.getvouch.io".
 });
@@ -33,7 +35,7 @@ const vouch = new Vouch({
 
 ### Get vouch start URL
 
-[Generate a link to start the Vouch flow](https://docs.getvouch.io/getting-started/first-steps#redirect-user-to-vouch).
+[Generate a link to start the vouch flow](https://docs.getvouch.io/getting-started/first-steps#redirect-user-to-vouch).
 
 ```typescript
 const url = vouch.getStartUrl({
@@ -44,3 +46,31 @@ const url = vouch.getStartUrl({
   webhookUrl: `https://docs.getvouch.io/api/web-proof/${requestId}`, // (Optional) Proof delivery endpoint.
 });
 ```
+
+### Adding inputs
+
+[Learn more about inputs](https://docs.getvouch.io/getting-started/handling-inputs).
+
+Suppose, you want to use a datasource with the following inputs schema:
+
+```typescript
+{
+  name: string;
+  minFollowersCount: number;
+}
+```
+
+You'd then need to provide the inputs when generating the start URL:
+
+```typescript
+const url = vouch.getStartUrl({
+  /// ...similar to the previous example
+  inputs: {
+    name: "John Doe",
+    minFollowersCount: 1337,
+  },
+});
+```
+
+The inputs will be encoded to base64, so you'd see something like this inside the URL:
+`inputs=eyJuYW1lIjoiSm9obiBEb2UiLCJtaW5Gb2xsb3dlcnNDb3VudCI6MTMzN30`

package/dist/lib/vouch.d.ts

@@ -6,7 +6,7 @@ export interface VouchUrlParams {
     redirectBackUrl: string;
     customerId?: string;
     requestId?: string;
-    inputs?: string;
+    inputs?: Record<string, unknown>;
     webhookUrl?: string;
 }
 export declare class Vouch {

package/dist/lib/vouch.js

@@ -1,5 +1,6 @@
 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";
 export class Vouch {
@@ -18,7 +19,7 @@ export class Vouch {
             redirectBackUrl,
         });
         if (inputs) {
-            params.set("inputs", inputs);
+            params.set("inputs", encodeInputs(inputs));
         }
         if (webhookUrl) {
             params.set("webhookUrl", webhookUrl);

package/dist/lib/vouch.test.js

@@ -27,10 +27,10 @@ describe("Vouch SDK", () => {
                 datasourceId: crypto.randomUUID(),
                 customerId: crypto.randomUUID(),
                 redirectBackUrl: "https://example.com/redirect",
-                inputs: "eyJrZXkiOiAidmFsdWUifQ",
+                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=${params.inputs}`);
+            expect(url.toString()).toBe(`https://app.getvouch.io/start?requestId=${params.requestId}&customerId=${params.customerId}&datasourceId=${params.datasourceId}&redirectBackUrl=${encodeURIComponent(params.redirectBackUrl)}&inputs=eyJrZXkiOiJ2YWx1ZSJ9`);
         });
         it("adds webhookUrl", () => {
             const params = {

package/dist/utils/encode-inputs.d.ts

@@ -0,0 +1,3 @@
+export declare function toBase64InBrowser(encodedText: string): string;
+export declare function toBase64(encodedText: string): string;
+export declare function encodeInputs(inputs?: Record<string, unknown>): string;

package/dist/utils/encode-inputs.js

@@ -0,0 +1,25 @@
+export function toBase64InBrowser(encodedText) {
+    const bytes = new TextEncoder().encode(encodedText);
+    return btoa(String.fromCharCode(...bytes))
+        .replace(/=/g, "")
+        .replace(/\+/g, "-")
+        .replace(/\//g, "_");
+}
+export function toBase64(encodedText) {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(encodedText, "utf-8").toString("base64url");
+    }
+    return toBase64InBrowser(encodedText);
+}
+export function encodeInputs(inputs) {
+    if (!inputs) {
+        return toBase64("{}");
+    }
+    try {
+        const jsonString = JSON.stringify(inputs);
+        return toBase64(jsonString);
+    }
+    catch (error) {
+        throw new Error(`Failed to encode inputs: ${String(error)}`);
+    }
+}

package/dist/utils/encode-inputs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/encode-inputs.test.js

@@ -0,0 +1,40 @@
+import { encodeInputs, toBase64, toBase64InBrowser } from "./encode-inputs";
+import { fromBase64 } from "common";
+import { expect } from "vitest";
+describe("Encode inputs", () => {
+    describe("toBase64", () => {
+        it("should convert toBase64", () => {
+            const result = toBase64("Hello, World!");
+            expect(result).toBe("SGVsbG8sIFdvcmxkIQ");
+        });
+        it("is url safe", () => {
+            const result = toBase64("ûïÿÿÿ");
+            expect(result).toBe("w7vDr8O_w7_Dvw");
+            expect(fromBase64(result)).toBe("ûïÿÿÿ");
+        });
+    });
+    describe("toBase64InBrowser", () => {
+        it("should convert toBase64", () => {
+            const result = toBase64InBrowser("Hello, World!");
+            expect(result).toBe("SGVsbG8sIFdvcmxkIQ");
+        });
+        it("is url safe", () => {
+            const result = toBase64InBrowser("ûïÿÿÿ");
+            expect(result).toBe("w7vDr8O_w7_Dvw");
+            expect(fromBase64(result)).toBe("ûïÿÿÿ");
+        });
+    });
+    describe("input encoding", () => {
+        it("encodes empty JSON object when no inputs were provided", () => {
+            const result = toBase64("{}");
+            expect(encodeInputs()).toBe(result);
+            expect(encodeInputs({})).toBe(result);
+        });
+        it("stringifies object and encodes it to base64", () => {
+            const inputs = { name: "John Doe", age: 30, city: "New York" };
+            expect(encodeInputs(inputs)).toBe(
+            // toBase64({"name":"John Doe","age":30,"city":"New York"})
+            "eyJuYW1lIjoiSm9obiBEb2UiLCJhZ2UiOjMwLCJjaXR5IjoiTmV3IFlvcmsifQ");
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getvouch/sdk",
-  "author": "Vouch",
+  "author": "vouch",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {
@@ -8,8 +8,8 @@
     "url": "git+https://github.com/vlayer-xyz/vouch.git#main"
   },
   "private": false,
-  "version": "0.1.0",
-  "description": "Vouch SDK",
+  "version": "0.1.1",
+  "description": "vouch SDK",
   "keywords": [
     "webproof",
     "sdk",
@@ -24,6 +24,7 @@
     "format:fix": "prettier --write ."
   },
   "devDependencies": {
+    "common": "workspace:*",
     "eslint": "^9.24.0",
     "eslint-config-prettier": "^10.1.1",
     "eslint-plugin-prettier": "^5.2.6",

package/tsconfig.json

@@ -4,7 +4,7 @@
     "target": "ES2017",
     "types": ["vitest/globals"],
     "moduleDetection": "force",
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "declaration": true,
     "outDir": "./dist",
     "rootDir": "./src",