@smart-pay-chain/otp 2.0.3 โ 2.1.0
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 +13 -0
- package/dist/http-client.d.ts.map +1 -1
- package/dist/http-client.js +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/types.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -20,6 +20,14 @@
|
|
|
20
20
|
|
|
21
21
|
Send and verify one-time passwords via SMS, WhatsApp, and Voice with ease.
|
|
22
22
|
|
|
23
|
+
## What's New in v2.1
|
|
24
|
+
|
|
25
|
+
๐ **Phone Authentication** - Complete passwordless auth with JWT tokens
|
|
26
|
+
๐ **Admin Role Support** - RBAC with USER/ADMIN roles
|
|
27
|
+
๐ **Brand Management** - Two-stage brand approval workflow
|
|
28
|
+
๐ **API Key Handling** - Secure key generation and one-time secret reveal
|
|
29
|
+
๐ **Backend Integration** - Full guide for sms-service integration
|
|
30
|
+
|
|
23
31
|
## What's New in v2.0
|
|
24
32
|
|
|
25
33
|
๐ **Test Mode** - Development-friendly testing with fixed OTP codes and test phone numbers
|
|
@@ -38,6 +46,9 @@ Send and verify one-time passwords via SMS, WhatsApp, and Voice with ease.
|
|
|
38
46
|
๐ฏ **Type-Safe** - Full TypeScript support with comprehensive type definitions
|
|
39
47
|
๐ **Retry Logic** - Automatic retries for transient failures
|
|
40
48
|
๐ฑ **Mobile Ready** - React Native example and mobile integration guide
|
|
49
|
+
๐ **Phone Authentication** - Complete passwordless auth with JWT tokens
|
|
50
|
+
๐ฅ **Admin Support** - Role-based access control (RBAC)
|
|
51
|
+
๐ข **Brand Management** - Two-stage approval workflow
|
|
41
52
|
๐งช **Test Mode** - Development testing with fixed codes
|
|
42
53
|
๐ฆ **Lightweight** - Minimal dependencies
|
|
43
54
|
๐งช **Well-Tested** - Comprehensive test coverage
|
|
@@ -489,9 +500,11 @@ The SDK includes comprehensive examples:
|
|
|
489
500
|
- **[Advanced Usage](./examples/advanced-usage.ts)** - Error handling, metadata, retries
|
|
490
501
|
- **[Test Mode](./examples/test-mode-example.ts)** ๐ - Testing with fixed OTP codes
|
|
491
502
|
- **[Express Integration](./examples/express-integration.ts)** - Backend API with Express.js
|
|
503
|
+
- **[Phone Authentication](./examples/phone-authentication.ts)** ๐ - Complete passwordless auth with JWT
|
|
492
504
|
- **[React Integration](./examples/react-example.tsx)** - Frontend form with React
|
|
493
505
|
- **[React Native](./examples/react-native-example.tsx)** ๐ - Mobile app integration
|
|
494
506
|
- **[Mobile Apps Guide](./examples/MOBILE_APPS.md)** ๐ - Flutter, iOS, Android examples
|
|
507
|
+
- **[Backend Integration Guide](./BACKEND_INTEGRATION_GUIDE.md)** ๐ - Full sms-service integration
|
|
495
508
|
|
|
496
509
|
See the [examples directory](./examples/) for more details.
|
|
497
510
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"http-client.d.ts","sourceRoot":"","sources":["../src/http-client.ts"],"names":[],"mappings":"AAAA,OAAc,EAA6B,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAC7E,OAAO,
|
|
1
|
+
{"version":3,"file":"http-client.d.ts","sourceRoot":"","sources":["../src/http-client.ts"],"names":[],"mappings":"AAAA,OAAc,EAA6B,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAC7E,OAAO,EACL,eAAe,EAKhB,MAAM,SAAS,CAAC;AAmDjB;;GAEG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,QAAQ,CAAc;gBAElB,MAAM,EAAE,eAAe;IA+BnC;;OAEG;IACG,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKnE;;OAEG;IACG,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IA0BhF;;OAEG;IACG,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAK/E;;OAEG;IACG,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKtE;;OAEG;IACH,OAAO,CAAC,KAAK;CAGd"}
|
package/dist/http-client.js
CHANGED
|
@@ -60,7 +60,7 @@ class HttpClient {
|
|
|
60
60
|
this.platform = config.platform || detectPlatform();
|
|
61
61
|
this.language = config.language || detectLanguage();
|
|
62
62
|
this.client = axios_1.default.create({
|
|
63
|
-
baseURL: config.baseUrl || 'https://otp.
|
|
63
|
+
baseURL: config.baseUrl || 'https://otp-service-production-ge.up.railway.app:3000',
|
|
64
64
|
timeout: config.timeout || 30000,
|
|
65
65
|
headers: {
|
|
66
66
|
'Content-Type': 'application/json',
|
package/dist/types.d.ts
CHANGED
|
@@ -49,7 +49,7 @@ export type SdkLanguage = 'typescript' | 'javascript';
|
|
|
49
49
|
export interface OtpClientConfig {
|
|
50
50
|
/** Your API key for authentication */
|
|
51
51
|
apiKey: string;
|
|
52
|
-
/** Base URL of the OTP service (default: https://otp.
|
|
52
|
+
/** Base URL of the OTP service (default: https://otp-service-production-ge.up.railway.app:3000) */
|
|
53
53
|
baseUrl?: string;
|
|
54
54
|
/** Request timeout in milliseconds (default: 30000) */
|
|
55
55
|
timeout?: number;
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,SAAS;IAEnB,qBAAqB,0BAA0B;IAC/C,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IAGnC,oBAAoB,yBAAyB;IAC7C,oBAAoB,yBAAyB;IAG7C,WAAW,gBAAgB;IAC3B,gBAAgB,qBAAqB;IACrC,gBAAgB,qBAAqB;IACrC,aAAa,kBAAkB;IAC/B,oBAAoB,yBAAyB;IAG7C,mBAAmB,wBAAwB;IAG3C,oBAAoB,yBAAyB;IAC7C,gBAAgB,qBAAqB;IAGrC,mBAAmB,wBAAwB;IAC3C,oBAAoB,yBAAyB;IAC7C,sBAAsB,2BAA2B;IACjD,qBAAqB,0BAA0B;IAG/C,eAAe,oBAAoB;IACnC,oBAAoB,yBAAyB;IAG7C,gBAAgB,qBAAqB;IACrC,sBAAsB,2BAA2B;IAGjD,qBAAqB,0BAA0B;IAC/C,mBAAmB,wBAAwB;IAG3C,wBAAwB,6BAA6B;CACtD;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IAEf,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,SAAS;IAEnB,qBAAqB,0BAA0B;IAC/C,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IAGnC,oBAAoB,yBAAyB;IAC7C,oBAAoB,yBAAyB;IAG7C,WAAW,gBAAgB;IAC3B,gBAAgB,qBAAqB;IACrC,gBAAgB,qBAAqB;IACrC,aAAa,kBAAkB;IAC/B,oBAAoB,yBAAyB;IAG7C,mBAAmB,wBAAwB;IAG3C,oBAAoB,yBAAyB;IAC7C,gBAAgB,qBAAqB;IAGrC,mBAAmB,wBAAwB;IAC3C,oBAAoB,yBAAyB;IAC7C,sBAAsB,2BAA2B;IACjD,qBAAqB,0BAA0B;IAG/C,eAAe,oBAAoB;IACnC,oBAAoB,yBAAyB;IAG7C,gBAAgB,qBAAqB;IACrC,sBAAsB,2BAA2B;IAGjD,qBAAqB,0BAA0B;IAC/C,mBAAmB,wBAAwB;IAG3C,wBAAwB,6BAA6B;CACtD;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IAEf,mGAAmG;IACnG,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,wEAAwE;IACxE,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,mDAAmD;IACnD,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IAEpB,sCAAsC;IACtC,OAAO,CAAC,EAAE,UAAU,CAAC;IAErB,qDAAqD;IACrD,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAElB,+BAA+B;IAC/B,SAAS,EAAE,IAAI,CAAC;IAEhB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAElB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,0CAA0C;IAC1C,OAAO,EAAE,OAAO,CAAC;IAEjB,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE;QACL,IAAI,EAAE,SAAS,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,OAAO,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC/B,CAAC;IACF,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,CAAC,CAAC;IACR,IAAI,CAAC,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE;YACV,KAAK,EAAE,MAAM,CAAC;YACd,SAAS,EAAE,MAAM,CAAC;YAClB,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IAEX,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IAEpB,uBAAuB;IACvB,OAAO,EAAE,UAAU,CAAC;IAEpB,qBAAqB;IACrB,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;IAE/D,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IAEjB,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;IAEpB,2BAA2B;IAC3B,SAAS,EAAE,IAAI,CAAC;IAEhB,8CAA8C;IAC9C,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IAExB,+BAA+B;IAC/B,SAAS,EAAE,IAAI,CAAC;IAEhB,iCAAiC;IACjC,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAEhB,wBAAwB;IACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,mCAAmC;IACnC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kBAAkB;IAClB,OAAO,EAAE,MAAM,CAAC;IAEhB,wBAAwB;IACxB,SAAS,EAAE;QACT,yBAAyB;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,6BAA6B;QAC7B,GAAG,EAAE,MAAM,CAAC;QACZ,oCAAoC;QACpC,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IAEF,kBAAkB;IAClB,UAAU,EAAE;QACV,QAAQ,EAAE;YACR,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,UAAU,EAAE;YACV,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,KAAK,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;KACH,CAAC;IAEF,0BAA0B;IAC1B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAE7B,0BAA0B;IAC1B,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF,yBAAyB;IACzB,QAAQ,EAAE;QACR,gBAAgB,EAAE,OAAO,CAAC;QAC1B,cAAc,EAAE,OAAO,CAAC;QACxB,QAAQ,EAAE,OAAO,CAAC;QAClB,WAAW,EAAE,OAAO,CAAC;QACrB,QAAQ,EAAE,OAAO,CAAC;QAClB,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;IAEF,oBAAoB;IACpB,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,yCAAyC;IACzC,QAAQ,CAAC,EAAE;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC3B,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAC7B,sBAAsB;;IAEtB,uCAAuC;;IAEvC,4CAA4C;;IAE5C,6CAA6C;;IAE7C,6CAA6C;;EAE7C,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,aAAa,WAAW,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@smart-pay-chain/otp",
|
|
3
|
-
"version": "2.0
|
|
4
|
-
"description": "Official TypeScript SDK for Smart Pay Chain OTP Verification Service - Now with
|
|
3
|
+
"version": "2.1.0",
|
|
4
|
+
"description": "Official TypeScript SDK for Smart Pay Chain OTP Verification Service - Now with phone authentication, JWT tokens, admin support, and brand management",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"files": [
|