@explorins/pers-sdk 2.0.10 → 2.1.1

package/README.md

@@ -107,37 +107,54 @@ npm install @explorins/pers-shared ethers@^6.15.0
 
 ### Direct Dependencies
 
-The SDK has **zero** direct runtime dependencies. All peer dependencies are optional:
+The SDK bundles essential dependencies for seamless installation:
 
 | Package | Type | Purpose |
 |---------|------|---------|
-| `@explorins/pers-shared` | Peer (required) | Shared types, interfaces, and DTOs |
-| `@explorins/web3-ts` | Peer (optional) | Web3/blockchain utilities (only needed for `sdk.web3.*` methods) |
-| `ethers` | Peer (optional) | Blockchain operations (only needed for `sdk.web3.*` methods) |
+| `@explorins/pers-shared` | Dependency (bundled) | Shared types, interfaces, and DTOs |
+| `@explorins/web3-ts` | Dependency (bundled) | Web3/blockchain utilities - automatically tree-shaken when not used |
+| `ethers` | Dependency (bundled) | Blockchain operations - automatically tree-shaken when not used |
+
+> **Tree-Shaking Magic**: Web3 features (~500KB install size) are only included in your final bundle if you actually use them. The SDK uses subpath exports (`@explorins/pers-sdk/web3`) that modern bundlers (Vite, Webpack 5+, Angular) automatically tree-shake when unused.
+> 
+> **Note**: `npm install` downloads ~500KB of web3 dependencies, but your production bundle will be **~3KB** if you don't import web3 features. This design prioritizes developer experience (no peer dependency hassles) while maintaining optimal production bundle sizes through automatic tree-shaking.
 
 ---
 
 ## Installation
 
 ```bash
-# Core SDK (lightweight - ~200KB)
+# Single command installs everything - no peer dependency hassle
 npm install @explorins/pers-sdk
 
-# Required peer dependency
-npm install @explorins/pers-shared
-
-# Optional: Only if using Web3/blockchain features (sdk.web3.*)
-npm install @explorins/web3-ts ethers@^6.15.0
-
 # Optional: For Angular applications only
 npm install rxjs
 ```
 
-**Package Size:**
-- Installed: ~1.9 MB (node_modules - both ESM/CJS + types + maps)
-- Your bundle: ~450 KB (bundler includes only ESM or CJS, not both)
-- With Web3: +1.5 MB (optional peer dependencies)
-- For smaller bundles: Import from `@explorins/pers-sdk/campaign` etc.
+**Bundle Sizes (After Tree-Shaking):**
+
+| Usage Pattern | Install Size | Runtime Bundle Size | Notes |
+|--------------|--------------|---------------------|-------|
+| **Core SDK only** (no web3) | ~500 KB | **~3 KB (ESM)** | Campaigns, users, tokens, auth |
+| **With Web3 features** | ~500 KB | **~26 KB (ESM)** | Includes blockchain operations |
+| **Development (node_modules)** | ~500 KB | N/A | All features available for development |
+
+> **Key Insight**: The install downloads 500KB, but your production app only includes what you import. If you never `import { Web3Manager }`, those 500KB are automatically excluded from your bundle by the bundler.
+
+**How Tree-Shaking Works:**
+```typescript
+// ✅ This code = ~3 KB production bundle (web3 dependencies NOT included)
+import { createPersSDK } from '@explorins/pers-sdk';
+const sdk = createPersSDK({...});
+await sdk.campaign.list();
+
+// ✅ This code = ~26 KB production bundle (web3 loaded only when imported)  
+import { Web3Manager } from '@explorins/pers-sdk/web3';
+const web3 = new Web3Manager(sdk.api());
+await web3.getTokenBalance({...});
+```
+
+Modern bundlers (Vite, Webpack 5+, Angular, Rollup) detect when web3 code is never imported and completely remove it from your production bundle through dead code elimination.
 
 ---
 
@@ -230,6 +247,8 @@ const sdk = createPersSDK(new BrowserFetchClientAdapter(), {
 const campaigns = await sdk.campaigns.getActiveCampaigns();
 ```
 
+> **⚠️ Browser Note:** Always use `BrowserFetchClientAdapter` for browser/React/Vue apps. Do not import `NodeHttpClientAdapter` in browser code - it contains Node.js-specific imports that will cause build errors.
+
 ### Angular
 
 **Requires `rxjs` peer dependency.**
@@ -744,8 +763,8 @@ const posRequest = buildPOSTransferRequest({
   amount: 100,
   contractAddress: '0x...',
   chainId: 137,
-  userAccountId: 'user-123',      // User sending tokens
-  businessAccountId: 'business-456' // Business receiving & authorized to submit
+  userId: 'user-123',      // User sending tokens
+  businessId: 'business-456' // Business receiving & authorized to submit
 });
 
 // This automatically sets:

package/dist/analytics/index.d.ts

@@ -7,6 +7,4 @@
 export { AnalyticsApi } from './api/analytics-api';
 export { AnalyticsService } from './services/analytics-service';
 export * from './models';
-export * from '../shared/interfaces/pers-shared-lib.interfaces';
-export * from './models';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/analytics/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAGhE,cAAc,UAAU,CAAC;AACzB,cAAc,iDAAiD,CAAC;AAMhE,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/analytics/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAGhE,cAAc,UAAU,CAAC"}

package/dist/analytics/models/index.d.ts

@@ -4,18 +4,9 @@
  * Re-exports from @explorins/pers-shared for consistency with backend
  * and to provide a single import source for analytics-related types.
  */
-import { AnalyticsGroupByType, AnalyticsMetricType, TransactionAnalyticsRequestDTO, TransactionAnalyticsResponseDTO, TransactionAnalyticsResultItem, GroupByExpressionDTO } from '@explorins/pers-shared/browser';
+import { AnalyticsGroupByType, AnalyticsMetricType, TransactionAnalyticsRequestDTO, TransactionAnalyticsResponseDTO, TransactionAnalyticsResultItem, GroupByExpressionDTO } from '@explorins/pers-shared';
 export { TransactionAnalyticsRequestDTO, TransactionAnalyticsResponseDTO, TransactionAnalyticsResultItem };
 export type TransactionAnalyticsGroupByExpression = GroupByExpressionDTO;
-export type TransactionAnalyticsFilters = {
-    status?: string;
-    tokenType?: string;
-    triggerProcessType?: string;
-    tenantId?: string;
-    chainId?: number;
-    type?: string;
-    [key: string]: any;
-};
 export type TransactionAnalyticsGroupBy = AnalyticsGroupByType;
 export type TransactionAnalyticsMetric = AnalyticsMetricType;
 //# sourceMappingURL=index.d.ts.map

package/dist/analytics/models/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/analytics/models/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,8BAA8B,EAC9B,+BAA+B,EAC/B,8BAA8B,EAC9B,oBAAoB,EACrB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EACL,8BAA8B,EAC9B,+BAA+B,EAC/B,8BAA8B,EAC/B,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,oBAAoB,CAAC;AAEzE,MAAM,MAAM,2BAA2B,GAAG;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAGF,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,CAAC;AAE/D,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/analytics/models/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,8BAA8B,EAC9B,+BAA+B,EAC/B,8BAA8B,EAC9B,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EACL,8BAA8B,EAC9B,+BAA+B,EAC/B,8BAA8B,EAC/B,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,oBAAoB,CAAC;AAMzE,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,CAAC;AAE/D,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC"}

package/dist/analytics.cjs

@@ -1,34 +1,49 @@
 'use strict';
 
-var analyticsService = require('./chunks/analytics-service-CitlimKJ.cjs');
-var persShared = require('@explorins/pers-shared');
+/**
+ * Platform-Agnostic Analytics API Client
+ *
+ * Handles analytics operations using the PERS backend.
+ * Uses @explorins/pers-shared DTOs for consistency with backend.
+ */
+class AnalyticsApi {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    // ==========================================
+    // ADMIN OPERATIONS
+    // ==========================================
+    /**
+     * ADMIN: Get transaction analytics with filtering and aggregation
+     */
+    async getTransactionAnalytics(request) {
+        return this.apiClient.post('/transactions/analytics', request);
+    }
+}
 
+/**
+ * Platform-Agnostic Analytics Service
+ *
+ * Contains analytics business logic and operations that work across platforms.
+ * No framework dependencies - pure TypeScript business logic.
+ *
+ * Focuses only on actual backend capabilities.
+ */
+class AnalyticsService {
+    constructor(analyticsApi) {
+        this.analyticsApi = analyticsApi;
+    }
+    // ==========================================
+    // ADMIN OPERATIONS
+    // ==========================================
+    /**
+     * ADMIN: Get transaction analytics with filtering and aggregation
+     */
+    async getTransactionAnalytics(request) {
+        return this.analyticsApi.getTransactionAnalytics(request);
+    }
+}
 
-
-exports.AnalyticsApi = analyticsService.AnalyticsApi;
-exports.AnalyticsService = analyticsService.AnalyticsService;
-Object.defineProperty(exports, "AccountOwnerType", {
-	enumerable: true,
-	get: function () { return persShared.AccountOwnerType; }
-});
-Object.defineProperty(exports, "ApiKeyType", {
-	enumerable: true,
-	get: function () { return persShared.ApiKeyType; }
-});
-Object.defineProperty(exports, "MEMBERSHIP_ROLE_HIERARCHY", {
-	enumerable: true,
-	get: function () { return persShared.MEMBERSHIP_ROLE_HIERARCHY; }
-});
-Object.defineProperty(exports, "MembershipRole", {
-	enumerable: true,
-	get: function () { return persShared.MembershipRole; }
-});
-Object.defineProperty(exports, "NativeTokenTypes", {
-	enumerable: true,
-	get: function () { return persShared.NativeTokenTypes; }
-});
-Object.defineProperty(exports, "hasMinimumRole", {
-	enumerable: true,
-	get: function () { return persShared.hasMinimumRole; }
-});
+exports.AnalyticsApi = AnalyticsApi;
+exports.AnalyticsService = AnalyticsService;
 //# sourceMappingURL=analytics.cjs.map

package/dist/analytics.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"analytics.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"analytics.cjs","sources":["../src/analytics/api/analytics-api.ts","../src/analytics/services/analytics-service.ts"],"sourcesContent":[null,null],"names":[],"mappings":";;AAIA;;;;;AAKG;MACU,YAAY,CAAA;AACvB,IAAA,WAAA,CAAoB,SAAwB,EAAA;QAAxB,IAAA,CAAA,SAAS,GAAT,SAAS;IAAkB;;;;AAM/C;;AAEG;IACH,MAAM,uBAAuB,CAAC,OAAuC,EAAA;QACnE,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAkC,yBAAyB,EAAE,OAAO,CAAC;IACjG;AACD;;ACjBD;;;;;;;AAOG;MACU,gBAAgB,CAAA;AAC3B,IAAA,WAAA,CAAoB,YAA0B,EAAA;QAA1B,IAAA,CAAA,YAAY,GAAZ,YAAY;IAAiB;;;;AAMjD;;AAEG;IACH,MAAM,uBAAuB,CAAC,OAAuC,EAAA;QACnE,OAAO,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAAC,OAAO,CAAC;IAC3D;AACD;;;;;"}

package/dist/analytics.js

@@ -1,3 +1,46 @@
-export { A as AnalyticsApi, a as AnalyticsService } from './chunks/analytics-service-CxyrOwel.js';
-export { AccountOwnerType, ApiKeyType, MEMBERSHIP_ROLE_HIERARCHY, MembershipRole, NativeTokenTypes, hasMinimumRole } from '@explorins/pers-shared';
+/**
+ * Platform-Agnostic Analytics API Client
+ *
+ * Handles analytics operations using the PERS backend.
+ * Uses @explorins/pers-shared DTOs for consistency with backend.
+ */
+class AnalyticsApi {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    // ==========================================
+    // ADMIN OPERATIONS
+    // ==========================================
+    /**
+     * ADMIN: Get transaction analytics with filtering and aggregation
+     */
+    async getTransactionAnalytics(request) {
+        return this.apiClient.post('/transactions/analytics', request);
+    }
+}
+
+/**
+ * Platform-Agnostic Analytics Service
+ *
+ * Contains analytics business logic and operations that work across platforms.
+ * No framework dependencies - pure TypeScript business logic.
+ *
+ * Focuses only on actual backend capabilities.
+ */
+class AnalyticsService {
+    constructor(analyticsApi) {
+        this.analyticsApi = analyticsApi;
+    }
+    // ==========================================
+    // ADMIN OPERATIONS
+    // ==========================================
+    /**
+     * ADMIN: Get transaction analytics with filtering and aggregation
+     */
+    async getTransactionAnalytics(request) {
+        return this.analyticsApi.getTransactionAnalytics(request);
+    }
+}
+
+export { AnalyticsApi, AnalyticsService };
 //# sourceMappingURL=analytics.js.map

package/dist/analytics.js.map

@@ -1 +1 @@
-{"version":3,"file":"analytics.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}
+{"version":3,"file":"analytics.js","sources":["../src/analytics/api/analytics-api.ts","../src/analytics/services/analytics-service.ts"],"sourcesContent":[null,null],"names":[],"mappings":"AAIA;;;;;AAKG;MACU,YAAY,CAAA;AACvB,IAAA,WAAA,CAAoB,SAAwB,EAAA;QAAxB,IAAA,CAAA,SAAS,GAAT,SAAS;IAAkB;;;;AAM/C;;AAEG;IACH,MAAM,uBAAuB,CAAC,OAAuC,EAAA;QACnE,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAkC,yBAAyB,EAAE,OAAO,CAAC;IACjG;AACD;;ACjBD;;;;;;;AAOG;MACU,gBAAgB,CAAA;AAC3B,IAAA,WAAA,CAAoB,YAA0B,EAAA;QAA1B,IAAA,CAAA,YAAY,GAAZ,YAAY;IAAiB;;;;AAMjD;;AAEG;IACH,MAAM,uBAAuB,CAAC,OAAuC,EAAA;QACnE,OAAO,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAAC,OAAO,CAAC;IAC3D;AACD;;;;"}

package/dist/business/index.d.ts

@@ -8,5 +8,4 @@ export { BusinessApi } from './api/business-api';
 export { BusinessMembershipApi } from './api/business-membership-api';
 export { BusinessService } from './services/business-service';
 export { BusinessMembershipService } from './services/business-membership-service';
-export * from '../shared/interfaces/pers-shared-lib.interfaces';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/business/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAGtE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AAGnF,cAAc,iDAAiD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/business/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAGtE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC"}