bringid-sdk 0.0.18 → 0.0.19-rc.0

package/README.md

@@ -1,201 +1,4 @@
-# BringID SDK (`bringid-sdk`)
-
-The **BringID SDK** enables communication between your web application and the **BringID Chrome Extension** using an iframe-based Connect Dialog and secure `postMessage` messaging.
-
-It provides utilities for:
-
-- Detecting extension installation & connection status
-- Displaying the BringID Connect authentication dialog
-- Requesting proofs & points
-- Handling login & logout events
-
----
-
-## Installation
-
-```bash
-npm install bringid-sdk
-# or
-yarn add bringid-sdk
-```
-
----
-
-## Quick Start (React Example)
-
-```tsx
-import { BringIDRequestsSDK, ConnectDialog } from "bringid-sdk";
-import { useState } from "react";
-
-export default function App() {
-  const sdk = new BringIDRequestsSDK();
-
-  const [iFrameVisible, setIFrameVisible] = useState(false);
-  const [iFrameReady, setIFrameReady] = useState(false);
-
-  return (
-    <div>
-      <button onClick={() => setIFrameVisible(true)}>Connect BringID</button>
-
-      <ConnectDialog
-        visible={iFrameVisible}
-        setVisible={setIFrameVisible}
-        connectUrl="https://dev.connect.bringid.org"
-        iframeOnLoad={() => {
-          sdk.markDialogReady();
-          setIFrameReady(true);
-        }}
-        onLogin={() => {
-          console.log("LOGIN DONE");
-          setIFrameVisible(false);
-        }}
-        onLogout={() => {
-          console.log("LOGOUT");
-        }}
-      />
-    </div>
-  );
-}
-```
-
----
-
-## `<ConnectDialog />` Component
-
-The dialog embeds BringID Connect in an iframe and manages communication with the BringID Extension.
-
-### Props
-
-| Prop           | Type                | Description                                                         |
-| -------------- | ------------------- | ------------------------------------------------------------------- |
-| `visible`      | `boolean`           | Whether the dialog is visible                                       |
-| `setVisible`   | `(boolean) => void` | Update visibility                                                   |
-| `connectUrl`   | `string`            | BringID Connect URL (default: `https://connect.bringid.org`)        |
-| `iframeOnLoad` | `() => void`        | Fired when iframe is loaded — **must call `sdk.markDialogReady()`** |
-| `onLogin`      | `() => void`        | Called after successful login                                       |
-| `onLogout`     | `() => void`        | Called when user logs out via extension                             |
-
----
-
-## BringIDRequestsSDK API
-
-### Creating the SDK
-
-```ts
-const sdk = new BringIDRequestsSDK();
-```
-
----
-
-## Checking Extension Status
-
-```ts
-const { status } = await sdk.checkExtensionStatus();
-
-if (status === "EXTENSION_IS_INSTALLED_AND_CONNECTED") {
-  console.log("Extension installed and connected");
-} else if (status === "EXTENSION_IS_INSTALLED_AND_NOT_CONNECTED") {
-  console.log("Extension installed but not connected");
-} else if (status === "EXTENSION_IS_NOT_INSTALLED") {
-  console.log("Extension not installed");
-}
-```
-
-Statuses:
-
-- `EXTENSION_IS_INSTALLED_AND_CONNECTED`
-- `EXTENSION_IS_INSTALLED_AND_NOT_CONNECTED`
-- `EXTENSION_IS_NOT_INSTALLED`
-
----
-
-## Requesting Proofs
-
-```ts
-const { proofs, points } = await sdk.requestProofs({
-  drop: "0x...",
-  address: "0x...",
-  pointsRequired: 10,
-});
-
-console.log(proofs, points);
-```
-
-### Parameters
-
-| Name             | Type     | Description             |
-| ---------------- | -------- | ----------------------- |
-| `drop`           | `string` | Drop address            |
-| `address`        | `string` | User address            |
-| `pointsRequired` | `number` | Minimum required points |
-
-### Returns
-
-```ts
-
-type TProof = {
-  credential_group_id: string,
-  semaphore_proof: {
-    merkle_tree_depth: number,
-    merkle_tree_root: string,
-    nullifier: string,
-    message: string,
-    scope: string,
-    points: string[]
-  }
-}
-
-{
-  proofs: TProof[],
-  points: number
-}
-```
-
----
-
-## markDialogReady()
-
-Called when the iframe is fully ready:
-
-```ts
-iframeOnLoad={() => {
-  sdk.markDialogReady()
-}}
-```
-
-This initializes `postMessage` communication.
-
----
-
-## Login / Logout Flow
-
-1. User opens Connect Dialog
-2. Iframe loads
-3. Developer calls `sdk.markDialogReady()`
-4. Extension sends login/logout events
-5. App receives:
-   - `onLogin()`
-   - `onLogout()`
-
----
-
-## How It Works
-
-- The SDK mounts an iframe (`ConnectDialog`)
-- Communicates via `window.postMessage`
-- BringID Extension responds with:
-  - login status
-  - logout events
-  - extension status
-  - proofs
-
-## Notes
-
-- Browser only — not available in Node.js
-- `sdk.markDialogReady()` must be triggered **after iframe load**
-- Optimized for Chrome
-
-# BringID Modal SDK 0.0.14 – Next.js Integration Guide
+# BringID Modal SDK 0.0.18 – Next.js Integration Guide
 
 This guide explains how to integrate **bringid-sdk** into a **Next.js App Router** application, including modal setup and requesting proofs.
 
@@ -225,7 +28,7 @@ yarn add bringid-sdk@^0.0.14
 The BringID SDK works by:
 
 1. Rendering a global verification modal
-2. Exposing SDK methods (`openModal`, `requestProofs`)
+2. Exposing SDK methods (`openModal`)
 3. Allowing interaction from client components
 
 To use it correctly, you must:
@@ -275,7 +78,6 @@ export default function ModalProvider({ children }: Props) {
 
 ### Notes
 
-- This component **must** be a Client Component
 - Render `VerificationsDialog` only once in the app
 - `address` and `signer` should come from your wallet provider
 
@@ -318,16 +120,19 @@ export default function RootLayout({
 
 ## 3. Using SDK Methods
 
-The SDK exposes the following client-side methods:
+The SDK exposes the following client-side method:
+
+`openModal ( proofsGeneratedCallback, scope )` – opens the verification modal
+
+- proofsGeneratedCallback - required. Should be presented as a callback with two arguments: proofs (array of semaphore proofs) points (amount of points for seleceted array of proofs)
 
-- `openModal()` – opens the verification modal
-- `requestProofs(address, chainId)` – requests verification proofs
+- scope - NOT required. Should be presented as a string if specific scope needed. By default the scope will be computed from registry address
 
-These methods must be called from **Client Components**.
+That method should be called from **Client Components**.
 
 ---
 
-## Example: Open Modal and Request Proofs
+## Example: Open Modal
 
 **`components/CreateID.tsx`**
 
@@ -346,31 +151,19 @@ const CreateID: FC<Props> = ({ setStage }) => {
 
   return (
     <div>
-      {proofs && (
-        <pre style={{ whiteSpace: "pre-wrap" }}>
-          {JSON.stringify(proofs, null, 2)}
-        </pre>
-      )}
 
       <button
         onClick={() => {
-          openModal();
+          openModal(
+            proofsGeneratedCallback: (proofs, points) => {
+              setProofs(proofs)
+            }
+          );
         }}
       >
         Open popup
       </button>
 
-      <button
-        onClick={async () => {
-          const result = await requestProofs(
-            "0xA5e1149A4AE284cd2651F6672Dfb174c788984bC",
-            10
-          );
-          setProofs(result);
-        }}
-      >
-        Ask proofs
-      </button>
     </div>
   );
 };
@@ -382,7 +175,6 @@ export default CreateID;
 
 ## Best Practices
 
-- Always call SDK methods from Client Components
 - Ensure wallet is connected before requesting proofs
 - Avoid rendering the modal multiple times
 - For large proof objects, consider collapsing or lazy rendering
@@ -396,12 +188,6 @@ export default CreateID;
 - Ensure `ModalProvider` is rendered in `layout.tsx`
 - Ensure `'use client'` is present
 
-### Proof request fails
-
-- Wallet must be connected
-- Address must match signer
-- Chain ID must be supported
-
 ---
 
 ## License

package/dist/components/close-button/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/close-button/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,OAAO,CAAA;AAG1B,OAAO,MAAM,MAAM,SAAS,CAAA;AAE5B,QAAA,MAAM,WAAW,EAAE,EAAE,CAAC,MAAM,CAO3B,CAAA;AAED,eAAe,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/close-button/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,OAAO,CAAA;AAE1B,OAAO,MAAM,MAAM,SAAS,CAAA;AAE5B,QAAA,MAAM,WAAW,EAAE,EAAE,CAAC,MAAM,CAO3B,CAAA;AAED,eAAe,WAAW,CAAA"}

package/dist/components/index.d.ts

@@ -1,22 +1,4 @@
-import Spinner from './spinner';
-import Button from './button';
-import Icons from './icons';
-import Title from './title';
-import Subtitle from './subtitle';
-import Link from './link';
-import Text from './text';
-import Note from './note';
-import Tag from './tag';
-import ProgressBar from './progress-bar';
-import TaskContainer from './task-container';
-import Task from './task';
-import Verification from './verification';
-import Message from './message';
-import LogoWrapper from './logo-wrapper';
-import Checkbox from './checkbox';
-import List from './list';
-import ExpandableContainer from './expandable-container';
 import Dialog from "./dialog";
 import CloseButton from "./close-button";
-export { Spinner, Button, Icons, Title, Subtitle, Link, Text, Note, Tag, ProgressBar, TaskContainer, Task, Message, Verification, LogoWrapper, Checkbox, List, ExpandableContainer, Dialog, CloseButton };
+export { Dialog, CloseButton };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.tsx"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,WAAW,MAAM,gBAAgB,CAAC;AACzC,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,WAAW,MAAM,gBAAgB,CAAC;AACzC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,mBAAmB,MAAM,wBAAwB,CAAC;AACzD,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,WAAW,MAAM,gBAAgB,CAAA;AAExC,OAAO,EACL,OAAO,EACP,MAAM,EACN,KAAK,EACL,KAAK,EACL,QAAQ,EACR,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,GAAG,EACH,WAAW,EACX,aAAa,EACb,IAAI,EACJ,OAAO,EACP,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,mBAAmB,EACnB,MAAM,EACN,WAAW,EACZ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.tsx"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,WAAW,MAAM,gBAAgB,CAAA;AAExC,OAAO,EACL,MAAM,EACN,WAAW,EACZ,CAAC"}

package/dist/hooks/use-message-proxy.d.ts

@@ -1,3 +1,4 @@
-declare function useMessageProxy(iframeRef: any, connectUrl: string, onLogin?: () => void, onLogout?: () => void): void;
+import { TGenerateSignature, TSemaphoreProof } from "@/types";
+declare function useMessageProxy(iframeRef: any, connectUrl: string, setVisible: (visible: boolean) => void, proofsGeneratedCallback: ((proofs: TSemaphoreProof[], points: number) => void) | null, generateSignature?: TGenerateSignature): void;
 export default useMessageProxy;
 //# sourceMappingURL=use-message-proxy.d.ts.map

package/dist/hooks/use-message-proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-message-proxy.d.ts","sourceRoot":"","sources":["../../src/hooks/use-message-proxy.tsx"],"names":[],"mappings":"AAEA,iBAAS,eAAe,CACtB,SAAS,KAAA,EACT,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,IAAI,EACpB,QAAQ,CAAC,EAAE,MAAM,IAAI,QA0CtB;AAED,eAAe,eAAe,CAAA"}
+{"version":3,"file":"use-message-proxy.d.ts","sourceRoot":"","sources":["../../src/hooks/use-message-proxy.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE7D,iBAAS,eAAe,CACtB,SAAS,KAAA,EACT,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,EACtC,uBAAuB,EAAE,CAAC,CACxB,MAAM,EAAE,eAAe,EAAE,EACzB,MAAM,EAAE,MAAM,KACX,IAAI,CAAC,GAAG,IAAI,EACjB,iBAAiB,CAAC,EAAE,kBAAkB,QAoFvC;AAED,eAAe,eAAe,CAAA"}

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import BringIDRequestsSDK from './modules/bring-id-requests-sdk';
-import ConnectDialog from './modules/connect-dialog';
 import BringIDExtensionSDK from './modules/bring-id-extension-sdk';
 import VerificationsDialog from './modules/verifications-dialog';
 import { openModal } from './modules/verifications-dialog/events/event-bus';
-export { BringIDRequestsSDK, ConnectDialog, BringIDExtensionSDK, VerificationsDialog, openModal };
+export { BringIDRequestsSDK, BringIDExtensionSDK, VerificationsDialog, openModal };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,iCAAiC,CAAA;AAChE,OAAO,aAAa,MAAM,0BAA0B,CAAA;AACpD,OAAO,mBAAmB,MAAM,kCAAkC,CAAA;AAClE,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,iDAAiD,CAAA;AAE3E,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,EACV,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,iCAAiC,CAAA;AAChE,OAAO,mBAAmB,MAAM,kCAAkC,CAAA;AAClE,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,iDAAiD,CAAA;AAE3E,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,EACV,CAAA"}