@zkproofport-app/sdk 0.2.4 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -124,13 +124,13 @@ const relay = await sdk.createRelayRequest('coinbase_country_attestation', {
124
124
 
125
125
  ### `oidc_domain_attestation`
126
126
 
127
- Prove email domain affiliation via Google Sign-In. The mobile app handles authentication and proof generation entirely on-device — the user's email is never revealed.
127
+ Prove email domain affiliation via OIDC Sign-In. The mobile app handles authentication and proof generation entirely on-device — the user's email is never revealed.
128
128
 
129
129
  | Field | Type | Required | Description |
130
130
  |-------|------|----------|-------------|
131
131
  | `domain` | `string` | Yes | Target email domain to prove (e.g., `'google.com'`, `'company.com'`) |
132
132
  | `scope` | `string` | Yes | dApp scope identifier for proof uniqueness |
133
- | `provider` | `string` | No | OIDC workspace provider for organization membership verification. Currently supported: `'google'`. |
133
+ | `provider` | `'google' \| 'microsoft'` | No | OIDC workspace provider for organization membership verification. Supported: `'google'` (Google Workspace), `'microsoft'` (Microsoft 365). |
134
134
 
135
135
  **Email domain verification (default):**
136
136
 
@@ -151,7 +151,17 @@ const relay = await sdk.createRelayRequest('oidc_domain_attestation', {
151
151
  });
152
152
  ```
153
153
 
154
- > When `provider` is set, the mobile app verifies the user's account is managed by the specified workspace provider (e.g., Google Workspace `hd` claim). Without `provider`, only the email domain is verified.
154
+ **Organization membership verification (Microsoft 365):**
155
+
156
+ ```typescript
157
+ const relay = await sdk.createRelayRequest('oidc_domain_attestation', {
158
+ domain: 'company.com',
159
+ scope: 'myapp.com',
160
+ provider: 'microsoft',
161
+ });
162
+ ```
163
+
164
+ > When `provider` is set, the mobile app verifies the user's account is managed by the specified workspace provider (e.g., Google Workspace `hd` claim, Microsoft 365 `tid` claim). Without `provider`, only the email domain is verified.
155
165
 
156
166
  ## Integration Guide
157
167
 
@@ -246,9 +256,20 @@ const relay = await sdk.createRelayRequest('oidc_domain_attestation', {
246
256
  dappIcon: 'https://myapp.com/icon.png',
247
257
  message: 'Verify your organization membership',
248
258
  });
259
+
260
+ // Organization membership verification (Microsoft 365)
261
+ const relay = await sdk.createRelayRequest('oidc_domain_attestation', {
262
+ domain: 'company.com',
263
+ scope: 'myapp.com',
264
+ provider: 'microsoft',
265
+ }, {
266
+ dappName: 'My DApp',
267
+ dappIcon: 'https://myapp.com/icon.png',
268
+ message: 'Verify your organization membership',
269
+ });
249
270
  ```
250
271
 
251
- The mobile app prompts Google Sign-In and generates the proof locally. When `provider` is set, the app additionally verifies organization membership (e.g., Google Workspace `hd` claim).
272
+ The mobile app prompts OIDC Sign-In (Google or Microsoft) and generates the proof locally. When `provider` is set, the app additionally verifies organization membership (e.g., Google Workspace `hd` claim, Microsoft 365 `tid` claim).
252
273
 
253
274
  ### Step 4: Display QR Code
254
275
 
@@ -497,9 +518,9 @@ The `OidcDomainInputs` interface:
497
518
 
498
519
  ```typescript
499
520
  interface OidcDomainInputs {
500
- domain: string; // Target email domain (e.g., 'google.com')
501
- scope: string; // dApp scope identifier
502
- provider?: string; // Workspace provider for org membership (currently: 'google')
521
+ domain: string; // Target email domain (e.g., 'company.com')
522
+ scope: string; // dApp scope identifier
523
+ provider?: 'google' | 'microsoft'; // Workspace provider for org membership
503
524
  }
504
525
  ```
505
526
 
package/dist/types.d.ts CHANGED
@@ -75,21 +75,21 @@ export interface CoinbaseCountryInputs {
75
75
  /**
76
76
  * Input parameters for OIDC Domain attestation circuit.
77
77
  *
78
- * This circuit proves a user's email domain affiliation via Google Sign-In
78
+ * This circuit proves a user's email domain affiliation via OIDC Sign-In
79
79
  * without revealing the full email address. The mobile app handles
80
80
  * authentication and proof generation entirely on-device.
81
81
  *
82
82
  * @property domain - Email domain to prove (e.g., "google.com", "company.com")
83
83
  * @property scope - Application-specific identifier for proof uniqueness (e.g., dapp domain)
84
84
  * @property provider - OIDC workspace provider name for organization membership verification.
85
- * When set, the mobile app verifies the user's account is managed by the specified provider
86
- * (e.g., Google Workspace `hd` claim). Currently supported: `'google'`.
85
+ * When set, the mobile app verifies the user's account is managed by the specified provider.
86
+ * Supported: `'google'` (Google Workspace `hd` claim), `'microsoft'` (Microsoft 365 `tid` claim).
87
87
  * Omit for general email domain verification without organization membership check.
88
88
  */
89
89
  export interface OidcDomainInputs {
90
90
  domain: string;
91
91
  scope: string;
92
- provider?: string;
92
+ provider?: 'google' | 'microsoft';
93
93
  }
94
94
  /**
95
95
  * Empty input type for circuits that retrieve all data from the mobile app.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zkproofport-app/sdk",
3
- "version": "0.2.4",
3
+ "version": "0.2.5",
4
4
  "description": "ZKProofport SDK for requesting zero-knowledge proofs from the ZKProofport mobile app and verifying them on-chain",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.esm.js",