@glideidentity/web-client-sdk 4.4.9 → 5.0.0

package/README.md

@@ -29,6 +29,7 @@ The official web SDK for integrating Glide's carrier-grade phone verification in
 ## Table of Contents
 
 - [Installation](#installation)
+- [Development](#development)
 - [Quick Start](#quick-start)
 - [Extended Mode - Advanced Control](#extended-mode---advanced-control)
 - [Authentication Strategies](#authentication-strategies)
@@ -36,6 +37,7 @@ The official web SDK for integrating Glide's carrier-grade phone verification in
 - [Error Handling](#error-handling)
 - [Browser Support](#browser-support)
 - [API Reference](#api-reference)
+- [Documentation](#documentation)
 
 ## Installation
 
@@ -43,6 +45,34 @@ The official web SDK for integrating Glide's carrier-grade phone verification in
 npm install @glideidentity/web-client-sdk
 ```
 
+## Development
+
+### Using Docker (Recommended)
+
+```bash
+# Build the SDK
+docker compose run --rm build
+
+# Run tests
+docker compose run --rm test
+
+# Interactive development shell
+docker compose run --rm dev
+```
+
+### Without Docker
+
+```bash
+# Install dependencies
+npm install
+
+# Build the SDK
+npm run build
+
+# Run tests
+npm test
+```
+
 ## Quick Start
 
 ### React Example
@@ -69,7 +99,7 @@ function PhoneVerification() {
       const credential = await phoneAuth.invokeSecurePrompt(prepareResult);
       
       // Process the credential
-      const result = await phoneAuth.getPhoneNumberCredential(
+      const result = await phoneAuth.getPhoneNumber(
         credential, 
         prepareResult.session
       );
@@ -92,7 +122,7 @@ function PhoneVerification() {
       const credential = await phoneAuth.invokeSecurePrompt(prepareResult);
       
       // Verify the number
-      const result = await phoneAuth.verifyPhoneNumberCredential(
+      const result = await phoneAuth.verifyPhoneNumber(
         credential,
         prepareResult.session
       );
@@ -307,7 +337,7 @@ if (isExtendedResponse(result)) {
   }
 } else {
   // Standard mode - got credential directly
-  const verified = await phoneAuth.verifyPhoneNumberCredential(result, session);
+  const verified = await phoneAuth.verifyPhoneNumber(result, session);
 }
 ```
 
@@ -348,7 +378,7 @@ async function verifyPhone() {
     });
     
     const credential = await phoneAuth.invokeSecurePrompt(prepared);
-    result.value = await phoneAuth.verifyPhoneNumberCredential(
+    result.value = await phoneAuth.verifyPhoneNumber(
       credential,
       prepared.session
     );
@@ -397,7 +427,7 @@ export class PhoneVerifyComponent {
       });
       
       const credential = await this.phoneAuth.invokeSecurePrompt(prepared);
-      this.result = await this.phoneAuth.verifyPhoneNumberCredential(
+      this.result = await this.phoneAuth.verifyPhoneNumber(
         credential,
         prepared.session
       );
@@ -430,7 +460,7 @@ async function getPhoneNumber() {
     
     const credential = await client.invokeSecurePrompt(prepareResult);
     
-    const result = await client.getPhoneNumberCredential(
+    const result = await client.getPhoneNumber(
       credential,
       prepareResult.session
     );
@@ -567,19 +597,18 @@ interface InvokeOptions {
 ### Methods
 
 ```typescript
-// Core methods
+// Core methods (granular control)
 preparePhoneRequest(options: PrepareRequest): Promise<PrepareResponse>
 invokeSecurePrompt(response: PrepareResponse, options?: InvokeOptions): Promise<any>
-getPhoneNumberCredential(credential: any, session: SessionInfo): Promise<GetPhoneNumberResponse>
-verifyPhoneNumberCredential(credential: any, session: SessionInfo): Promise<VerifyPhoneNumberResponse>
+getPhoneNumber(credential: any, session: SessionInfo): Promise<GetPhoneNumberResponse>
+verifyPhoneNumber(credential: any, session: SessionInfo): Promise<VerifyPhoneNumberResponse>
 
-// High-level convenience methods
+// High-level convenience methods (full flow)
 getPhoneNumberComplete(): Promise<GetPhoneNumberResponse>
 verifyPhoneNumberComplete(phoneNumber: string): Promise<VerifyPhoneNumberResponse>
 
 // Utility methods
 isSupported(): boolean
-cancelCurrentRequest(): void
 ```
 
 ### Response Types
@@ -609,6 +638,25 @@ interface VerifyPhoneNumberResponse {
 }
 ```
 
+## Documentation
+
+For detailed documentation, see the [docs](./docs) folder:
+
+| Document | Description |
+|----------|-------------|
+| [Architecture](./docs/architecture.md) | SDK architecture and design principles |
+| [Phone Authentication](./docs/phone-auth.md) | Complete phone auth usage guide |
+| [Desktop Authentication](./docs/desktop-auth.md) | QR code authentication flow |
+| [Dual Platform QR](./docs/dual-platform-qr.md) | iOS/Android specific QR codes |
+| [Error Handling](./docs/error-handling.md) | Error codes and handling strategies |
+| [Trigger Pattern](./docs/trigger-pattern.md) | Consistent trigger API across strategies |
+| [Implementation Notes](./docs/implementation-notes.md) | Technical implementation details |
+| [Local Development](./docs/local-development.md) | Testing the SDK locally |
+| [TS43 Data Flow](./docs/TS43_DATA_FLOW.md) | Digital Credentials API details |
+| [Type Hierarchy](./docs/TYPE_HIERARCHY.md) | TypeScript type system |
+| [Naming Conventions](./docs/NAMING_CONVENTIONS.md) | API naming standards |
+| [Security Checklist](./docs/security-checklist.md) | NPM publishing security |
+
 ## Support
 
 - [Documentation](https://docs.glideidentity.com)

package/dist/adapters/react/index.d.ts

@@ -4,6 +4,6 @@ export type { UsePhoneAuthOptions } from './usePhoneAuth';
 export type { ClientConfig, ClientResponse, RequestOptions } from '../../core/types';
 export type { AuthConfig as PhoneAuthConfig, PhoneAuthOptions, PhoneAuthResult, AuthError, AuthStep } from '../../core/phone-auth';
 export { PhoneAuthErrorCode, isPhoneAuthError, isUserError, getUserMessage, isErrorCode, getRetryDelay, isRetryableError, serializeError, createErrorBreadcrumb } from '../../core/phone-auth';
-export type { PhoneAuthCallbacks, PLMN, SessionInfo, PrepareRequest, PrepareResponse, GetPhoneNumberRequest, GetPhoneNumberResponse, VerifyPhoneNumberRequest, VerifyPhoneNumberResponse, SecureCredentialRequest, SecureCredentialResponse, DigitalCredential, TS43Data, LinkData, ClientInfo, ConsentData, BrowserErrorType, BrowserErrorCodeType, BrowserNameType } from '../../core/phone-auth/types';
+export type { PhoneAuthCallbacks, PLMN, SessionInfo, PrepareRequest, PrepareResponse, GetPhoneNumberRequest, GetPhoneNumberResponse, VerifyPhoneNumberRequest, VerifyPhoneNumberResponse, SecureCredentialRequest, SecureCredentialResponse, DigitalCredential, TS43Data, LinkData, ClientInfo, BrowserErrorType, BrowserErrorCodeType, BrowserNameType } from '../../core/phone-auth/types';
 export { USE_CASE as UseCase, AUTHENTICATION_STRATEGY as AuthenticationStrategy, BrowserError, BrowserErrorCode, BrowserName } from '../../core/phone-auth/types';
 export { PhoneAuthClient } from '../../core/phone-auth';

package/dist/adapters/vue/index.d.ts

@@ -5,6 +5,6 @@ export { PhoneAuthClient } from '../../core/phone-auth';
 export type { ClientConfig, ClientResponse, RequestOptions } from '../../core/types';
 export type { AuthConfig as PhoneAuthConfig, PhoneAuthOptions, PhoneAuthResult, AuthError, AuthStep } from '../../core/phone-auth';
 export { PhoneAuthErrorCode, isPhoneAuthError, isUserError, getUserMessage, isErrorCode, getRetryDelay, isRetryableError, serializeError, createErrorBreadcrumb } from '../../core/phone-auth';
-export type { PhoneAuthCallbacks, PLMN, SessionInfo, PrepareRequest, PrepareResponse, GetPhoneNumberRequest, GetPhoneNumberResponse, VerifyPhoneNumberRequest, VerifyPhoneNumberResponse, SecureCredentialRequest, SecureCredentialResponse, DigitalCredential, TS43Data, LinkData, ClientInfo, ConsentData, BrowserErrorType, BrowserErrorCodeType, BrowserNameType } from '../../core/phone-auth/types';
+export type { PhoneAuthCallbacks, PLMN, SessionInfo, PrepareRequest, PrepareResponse, GetPhoneNumberRequest, GetPhoneNumberResponse, VerifyPhoneNumberRequest, VerifyPhoneNumberResponse, SecureCredentialRequest, SecureCredentialResponse, DigitalCredential, TS43Data, LinkData, ClientInfo, BrowserErrorType, BrowserErrorCodeType, BrowserNameType } from '../../core/phone-auth/types';
 export { USE_CASE as UseCase, AUTHENTICATION_STRATEGY as AuthenticationStrategy, BrowserError, BrowserErrorCode, BrowserName } from '../../core/phone-auth/types';
 export { USE_CASE, ERROR_CODE, ERROR_MESSAGES, ERROR_STATUS_CODES } from '../../core/phone-auth/api-types';