@explorins/pers-sdk 1.0.0-alpha.1 → 1.1.2

package/config/domains.js

@@ -0,0 +1,22 @@
+// Domain configurations for the PERS SDK
+// This is the single source of truth for all domain configurations
+export const domains = [
+  { name: 'core', externals: ['jwt-decode'] },
+  { name: 'business', externals: ['@explorins/pers-shared'] },
+  { name: 'transaction', externals: ['@explorins/pers-shared'] },
+  { name: 'analytics', externals: ['@explorins/pers-shared'] },
+  { name: 'auth-admin', externals: ['@explorins/pers-shared'] },
+  { name: 'campaign', externals: ['@explorins/pers-shared'] },
+  { name: 'donation', externals: ['@explorins/pers-shared'] },
+  { name: 'payment', externals: ['@explorins/pers-shared'] },
+  { name: 'redemption', externals: ['@explorins/pers-shared'] },
+  { name: 'tenant', externals: ['@explorins/pers-shared'] },
+  { name: 'token', externals: ['@explorins/pers-shared'] },
+  { name: 'user', externals: ['@explorins/pers-shared'] },
+  { name: 'user-status', externals: ['@explorins/pers-shared'] },
+  { name: 'web3-chain', externals: ['@explorins/pers-shared', 'web3', '@explorins/web3-ts', 'ethers'] },
+  { name: 'web3', externals: ['@explorins/pers-shared', 'web3', '@explorins/web3-ts', 'ethers'] }
+];
+
+// Extract just the domain names for scripts that only need the names
+export const domainNames = domains.map(domain => domain.name);

package/package.json

@@ -1,52 +1,145 @@
 {
   "name": "@explorins/pers-sdk",
-  "version": "1.0.0-alpha.1",
-  "description": "Platform-agnostic SDK for PERS (Phygital Experience Rewards System)",
+  "version": "1.1.2",
+  "description": "Platform-agnostic SDK for PERS (Phygital Experience Rewards System) - Production Defaults",
   "type": "module",
+  "main": "./index.cjs",
+  "module": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.esm.js",
-      "require": "./dist/index.js"
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./index.cjs"
     },
-    "./core": {
-      "types": "./dist/core/core.d.ts",
-      "import": "./dist/core.esm.js",
-      "require": "./dist/core.js"
+    "./analytics": {
+      "types": "./analytics.d.ts",
+      "import": "./analytics.js",
+      "require": "./analytics.cjs"
+    },
+    "./auth-admin": {
+      "types": "./auth-admin.d.ts",
+      "import": "./auth-admin.js",
+      "require": "./auth-admin.cjs"
     },
     "./business": {
-      "types": "./dist/business/index.d.ts",
-      "import": "./dist/business.esm.js",
-      "require": "./dist/business.js"
+      "types": "./business.d.ts",
+      "import": "./business.js",
+      "require": "./business.cjs"
+    },
+    "./campaign": {
+      "types": "./campaign.d.ts",
+      "import": "./campaign.js",
+      "require": "./campaign.cjs"
+    },
+    "./core": {
+      "types": "./core.d.ts",
+      "import": "./core.js",
+      "require": "./core.cjs"
+    },
+    "./donation": {
+      "types": "./donation.d.ts",
+      "import": "./donation.js",
+      "require": "./donation.cjs"
+    },
+    "./payment": {
+      "types": "./payment.d.ts",
+      "import": "./payment.js",
+      "require": "./payment.cjs"
+    },
+    "./redemption": {
+      "types": "./redemption.d.ts",
+      "import": "./redemption.js",
+      "require": "./redemption.cjs"
+    },
+    "./tenant": {
+      "types": "./tenant.d.ts",
+      "import": "./tenant.js",
+      "require": "./tenant.cjs"
+    },
+    "./token": {
+      "types": "./token.d.ts",
+      "import": "./token.js",
+      "require": "./token.cjs"
+    },
+    "./transaction": {
+      "types": "./transaction.d.ts",
+      "import": "./transaction.js",
+      "require": "./transaction.cjs"
+    },
+    "./user": {
+      "types": "./user.d.ts",
+      "import": "./user.js",
+      "require": "./user.cjs"
+    },
+    "./user-status": {
+      "types": "./user-status.d.ts",
+      "import": "./user-status.js",
+      "require": "./user-status.cjs"
+    },
+    "./web3-chain": {
+      "types": "./web3-chain.d.ts",
+      "import": "./web3-chain.js",
+      "require": "./web3-chain.cjs"
+    },
+    "./web3": {
+      "types": "./web3.d.ts",
+      "import": "./web3.js",
+      "require": "./web3.cjs"
     }
   },
- "scripts": {
-    "build": "rollup -c",
+  "typesVersions": {
+    "*": {
+      "analytics": ["./analytics.d.ts"],
+      "auth-admin": ["./auth-admin.d.ts"],
+      "business": ["./business.d.ts"],
+      "campaign": ["./campaign.d.ts"],
+      "core": ["./core.d.ts"],
+      "donation": ["./donation.d.ts"],
+      "payment": ["./payment.d.ts"],
+      "redemption": ["./redemption.d.ts"],
+      "tenant": ["./tenant.d.ts"],
+      "token": ["./token.d.ts"],
+      "transaction": ["./transaction.d.ts"],
+      "user": ["./user.d.ts"],
+      "user-status": ["./user-status.d.ts"],
+      "web3-chain": ["./web3-chain.d.ts"],
+      "web3": ["./web3.d.ts"]
+    }
+  },
+  "scripts": {
+    "build": "rollup -c && node scripts/copy-declarations.js",
     "build:watch": "rollup -c --watch",
     "clean": "rimraf dist",
     "test": "jest",
     "test:watch": "jest --watch",
-    "lint": "eslint src/**/*.ts"
-  },
-  "dependencies": {
-    "@explorins/pers-shared": "*"
+    "lint": "eslint src/**/*.ts",
+    "prepublishOnly": "npm run clean && npm run build",
+    "publish": "npm publish"
   },
   "devDependencies": {
-    "typescript": "^5.4.5",
+    "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.12",
     "jest": "^29.7.0",
-    "@rollup/plugin-typescript": "^11.1.6",
+    "rimraf": "^5.0.5",
     "rollup": "^4.50.0",
-    "rimraf": "^5.0.5"
+    "rollup-plugin-copy": "^3.5.0",
+    "typescript": "^5.4.5"
   },
   "peerDependencies": {
-    "@explorins/pers-shared": "*"
+    "@explorins/pers-shared": "*",
+    "jwt-decode": "^3.0.0 || ^4.0.0"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "keywords": ["pers", "business", "sdk", "platform-agnostic"],
+  "keywords": [
+    "pers",
+    "business",
+    "sdk",
+    "platform-agnostic"
+  ],
   "author": "Explorins",
   "license": "MIT"
 }

package/rollup.config.js

@@ -1,67 +1,56 @@
 import typescript from '@rollup/plugin-typescript';
+import copy from 'rollup-plugin-copy';
+import { domains } from './config/domains.js';
 
-export default [
-  // Core entry point
-  {
-    input: 'src/core/core.ts',
-    output: [
-      {
-        file: 'dist/core.js',
-        format: 'cjs',
-        sourcemap: true
-      },
-      {
-        file: 'dist/core.esm.js',
-        format: 'esm',
-        sourcemap: true
-      }
-    ],
-    plugins: [
-      typescript({
-        tsconfig: './tsconfig.json',
-        declaration: true,
-        declarationDir: './dist'
-      })
-    ],
-    external: ['rxjs', 'rxjs/operators']
-  },
-  
-  // Business domain entry point
-  {
-    input: 'src/business/index.ts',
-    output: [
-      {
-        file: 'dist/business.js',
-        format: 'cjs',
-        sourcemap: true
-      },
-      {
-        file: 'dist/business.esm.js',
-        format: 'esm',
-        sourcemap: true
+// Generate domain configurations
+const domainConfigs = domains.map(domain => ({
+  input: `src/${domain.name}/index.ts`,
+  output: [
+    {
+      file: `dist/${domain.name}.cjs`,
+      format: 'cjs',
+      sourcemap: true,
+      exports: 'named'
+    },
+    {
+      file: `dist/${domain.name}.js`,
+      format: 'esm',
+      sourcemap: true
+    }
+  ],
+  plugins: [
+    typescript({
+      tsconfig: './tsconfig.json',
+      declaration: true,
+      declarationMap: true,
+      outDir: './dist/temp',
+      declarationDir: './dist/temp',
+      compilerOptions: {
+        rootDir: './src',
+        outDir: './dist/temp',
+        declarationDir: './dist/temp'
       }
-    ],
-    plugins: [
-      typescript({
-        tsconfig: './tsconfig.json',
-        declaration: true,
-        declarationDir: './dist'
-      })
-    ],
-    external: ['@explorins/pers-shared', 'rxjs', 'rxjs/operators']
-  },
+    })
+  ],
+  external: domain.externals
+}));
+
+export default [
+  // All domain configurations
+  ...domainConfigs,
   
   // Main entry point (everything)
   {
     input: 'src/index.ts',
     output: [
       {
-        file: 'dist/index.js',
+        file: 'dist/index.cjs',
         format: 'cjs',
-        sourcemap: true
+        sourcemap: true,
+        exports: 'named'
       },
       {
-        file: 'dist/index.esm.js',
+        file: 'dist/index.js',
         format: 'esm',
         sourcemap: true
       }
@@ -70,9 +59,16 @@ export default [
       typescript({
         tsconfig: './tsconfig.json',
         declaration: true,
-        declarationDir: './dist'
+        declarationMap: true,
+        declarationDir: './dist',
+        outDir: './dist'
+      }),
+      copy({
+        targets: [
+          { src: 'package.json', dest: 'dist' }
+        ]
       })
     ],
-    external: ['@explorins/pers-shared', 'rxjs', 'rxjs/operators']
+    external: ['@explorins/pers-shared', 'web3', 'jwt-decode', '@explorins/web3-ts', 'ethers'] // All dependencies
   }
 ];

package/scripts/copy-declarations.js

@@ -0,0 +1,147 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+// Import domain names from shared configuration
+import { domainNames } from '../config/domains.js';
+
+// Get __dirname equivalent for ES modules
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const distPath = path.join(__dirname, '..', 'dist');
+const tempPath = path.join(distPath, 'temp');
+
+console.log('Copying domain declaration files...');
+
+// Ensure dist directory exists
+if (!fs.existsSync(distPath)) {
+  fs.mkdirSync(distPath, { recursive: true });
+}
+
+let copiedCount = 0;
+let errors = [];
+
+for (const domain of domainNames) {
+  const sourcePath = path.join(tempPath, domain, 'index.d.ts');
+  const targetPath = path.join(distPath, `${domain}.d.ts`);
+  
+  try {
+    if (fs.existsSync(sourcePath)) {
+      let content = fs.readFileSync(sourcePath, 'utf8');
+      
+      // Fix relative imports for the root-level declaration files
+      // Convert './api/something' to './domain/api/something'
+      // Convert './models' to './domain/models'
+      // Convert './services/something' to './domain/services/something'
+      content = content.replace(
+        /from ['"]\.\/(api|models|services)([^'"]*)['"]/g,
+        `from './${domain}/$1$2'`
+      );
+      
+      // Also fix export statements
+      content = content.replace(
+        /export \{ ([^}]+) \} from ['"]\.\/(api|models|services)([^'"]*)['"]/g,
+        `export { $1 } from './${domain}/$2$3'`
+      );
+      
+      // Fix export * statements
+      content = content.replace(
+        /export \* from ['"]\.\/(api|models|services)([^'"]*)['"]/g,
+        `export * from './${domain}/$1$2'`
+      );
+      
+      // Fix problematic import paths that reference @explorins/pers-shared directly
+      // Replace specific import patterns with the re-exported types
+      content = content.replace(
+        /import\("@explorins\/pers-shared\/[^"]+"\)\.(\w+)/g,
+        '$1'
+      );
+      
+      // Fix centralized interface imports - convert relative paths to correct dist structure
+      content = content.replace(
+        /from ['"]\.\.\/(shared\/interfaces\/pers-shared-lib\.interfaces)['"]/g,
+        `from './$1'`
+      );
+      
+      // Fix centralized interface exports
+      content = content.replace(
+        /export \* from ['"]\.\.\/(shared\/interfaces\/pers-shared-lib\.interfaces)['"]/g,
+        `export * from './$1'`
+      );
+      
+      // Fix core imports - convert ../core/ to ./core/
+      content = content.replace(
+        /from ['"]\.\.\/(core\/[^'"]*)['"]/g,
+        `from './$1'`
+      );
+      
+      // Fix pers-sdk imports - convert ../pers-sdk to ./pers-sdk
+      content = content.replace(
+        /from ['"]\.\.\/(pers-sdk)['"]/g,
+        `from './$1'`
+      );
+      
+      // Fix cross-domain imports - convert ../domain-name/ to ./domain-name/
+      content = content.replace(
+        /from ['"]\.\.\/(web3-chain|core|business|payment|user|transaction|campaign|analytics|auth-admin|donation|redemption|tenant|token|user-status|web3)\/([^'"]*)['"]/g,
+        `from './$1/$2'`
+      );
+      
+      // Fix relative imports within domain files - they need to reference the domain subfolder
+      // But skip paths that already reference shared, core, or business subdirectories correctly
+      if (!content.includes('./shared/interfaces/') && !content.includes('./core/')) {
+        content = content.replace(
+          /from ['"]\.\/([^'"]+)['"]/g,
+          (match, path) => {
+            // Don't transform if it's already correctly prefixed
+            if (path.startsWith(`${domain}/`) || path.startsWith('shared/') || path.startsWith('core/')) {
+              return match;
+            }
+            return `from './${domain}/${path}'`;
+          }
+        );
+        
+        content = content.replace(
+          /export \* from ['"]\.\/([^'"]+)['"]/g,
+          (match, path) => {
+            if (path.startsWith(`${domain}/`) || path.startsWith('shared/') || path.startsWith('core/')) {
+              return match;
+            }
+            return `export * from './${domain}/${path}'`;
+          }
+        );
+      }
+      
+      fs.writeFileSync(targetPath, content);
+      console.log(`✓ Copied ${domain}.d.ts`);
+      copiedCount++;
+    } else {
+      errors.push(`Source file not found: ${sourcePath}`);
+    }
+  } catch (error) {
+    errors.push(`Error copying ${domain}.d.ts: ${error.message}`);
+  }
+}
+
+// Clean up temp directory
+try {
+  if (fs.existsSync(tempPath)) {
+    fs.rmSync(tempPath, { recursive: true, force: true });
+    console.log('✓ Cleaned up temp directory');
+  }
+} catch (error) {
+  console.warn(`Warning: Could not clean up temp directory: ${error.message}`);
+}
+
+console.log(`\nSummary: ${copiedCount}/${domainNames.length} declaration files copied successfully`);
+
+if (errors.length > 0) {
+  console.error('\nErrors encountered:');
+  errors.forEach(error => console.error(`  - ${error}`));
+  process.exit(1);
+}
+
+console.log('✓ All declaration files copied successfully!');

package/src/analytics/api/analytics-api.ts

@@ -0,0 +1,24 @@
+import { PersApiClient } from '../../core/pers-api-client';
+import { TransactionAnalyticsRequestDTO, TransactionAnalyticsResponseDTO } from '../models';
+
+
+/**
+ * Platform-Agnostic Analytics API Client
+ * 
+ * Handles analytics operations using the PERS backend.
+ * Uses @explorins/pers-shared DTOs for consistency with backend.
+ */
+export class AnalyticsApi {
+  constructor(private apiClient: PersApiClient) {}
+
+  // ==========================================
+  // ADMIN OPERATIONS
+  // ==========================================
+
+  /**
+   * ADMIN: Get transaction analytics with filtering and aggregation
+   */
+  async getTransactionAnalytics(request: TransactionAnalyticsRequestDTO): Promise<TransactionAnalyticsResponseDTO> {
+    return this.apiClient.post<TransactionAnalyticsResponseDTO>('/transactions/analytics', request);
+  }
+}

package/src/analytics/index.ts

@@ -0,0 +1,52 @@
+/**
+ * @explorins/pers-sdk-analytics
+ * 
+ * Platform-agnostic Analytics Domain SDK for PERS ecosystem
+ * Handles analytics operations and data aggregation
+ */
+
+// API Layer
+export { AnalyticsApi } from './api/analytics-api';
+
+// Service Layer  
+export { AnalyticsService } from './services/analytics-service';
+
+// Models & Types
+export * from './models';
+export * from '../shared/interfaces/pers-shared-lib.interfaces';
+
+// Base Service (for inheritance pattern)
+// Note: BaseAnalyticsService not yet implemented - using factory pattern for now
+
+// Models & Types
+export * from './models';
+
+// Factory function for creating analytics SDK instance
+import { PersApiClient } from '../core/pers-api-client';
+import { AnalyticsApi } from './api/analytics-api';
+import { TransactionAnalyticsRequestDTO } from './models';
+import { AnalyticsService } from './services/analytics-service';
+
+/**
+ * Create a complete Analytics SDK instance
+ * 
+ * @param apiClient - Configured PERS API client
+ * @returns Analytics SDK with flattened structure for better DX
+ */
+export function createAnalyticsSDK(apiClient: PersApiClient) {
+  const analyticsApi = new AnalyticsApi(apiClient);
+  const analyticsService = new AnalyticsService(analyticsApi);
+  
+  return {
+    // Direct access to service methods (primary interface)
+    
+    // Admin methods
+    getTransactionAnalytics: (request: TransactionAnalyticsRequestDTO) => analyticsService.getTransactionAnalytics(request),
+    
+    // Advanced access for edge cases
+    api: analyticsApi,
+    service: analyticsService
+  };
+}
+
+export type AnalyticsSDK = ReturnType<typeof createAnalyticsSDK>;

package/src/analytics/models/index.ts

@@ -0,0 +1,74 @@
+/**
+ * Analytics Domain Models
+ * 
+ * Re-exports from @explorins/pers-shared for consistency with backend
+ * and to provide a single import source for analytics-related types.
+ */
+
+// Core analytics entities
+
+
+export interface TransactionAnalyticsGroupByExpression {
+  expression: string;
+  alias: string;
+}
+
+export interface TransactionAnalyticsRequestDTO {
+  filters?: TransactionAnalyticsFilters;
+  groupBy?: TransactionAnalyticsGroupBy[];
+  groupByExpressions?: TransactionAnalyticsGroupByExpression[];
+  metrics?: TransactionAnalyticsMetric[];
+  orderBy?: string;
+  orderDirection?: 'ASC' | 'DESC';
+  limit?: number;
+  startDate?: string;
+  endDate?: string;
+}
+
+export type TransactionAnalyticsFilters = {
+  status?: string;
+  tokenType?: string;
+  triggerProcessType?: string;
+  tenantId?: string;
+  chainId?: number;
+  type?: string;
+  [key: string]: any;
+};
+
+export type TransactionAnalyticsGroupBy = 
+  | 'month' | 'week' | 'day' | 'year' | 'quarter'
+  | 'tokenType' | 'status' | 'chainId' | 'triggerProcessType' | 'type'
+  | 'senderAddress' | 'recipientAddress' | 'senderId' | 'recipientId' | 'senderOwnerType' | 'recipientOwnerType' | 'createdAt';
+
+export type TransactionAnalyticsMetric = 
+  | 'count' | 'sum' | 'avg' | 'min' | 'max';
+
+export interface TransactionAnalyticsResultItem {
+  [key: string]: string | number | Date | undefined;
+  count?: string;
+  sum?: number;
+  avg?: number;
+  min?: number;
+  max?: number;
+  tokentype?: string;
+  tokenType?: string;
+  year?: string;
+  month?: string;
+  type?: string;
+  senderaddress?: string;
+  senderAddress?: string;
+  recipientaddress?: string;
+  recipientAddress?: string;
+  triggerprocesstype?: string;
+  triggerProcessType?: string;
+  userid?: string;
+  userId?: string;
+}
+
+export interface TransactionAnalyticsResponseDTO {
+  results: TransactionAnalyticsResultItem[];
+  totalGroups: number;
+  metadata: {
+    executionTime: string;
+  };
+}

package/src/analytics/services/analytics-service.ts

@@ -0,0 +1,28 @@
+import { AnalyticsApi } from '../api/analytics-api';
+import { 
+  TransactionAnalyticsRequestDTO,
+  TransactionAnalyticsResponseDTO
+} from '../models';
+
+/**
+ * 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.
+ */
+export class AnalyticsService {
+  constructor(private analyticsApi: AnalyticsApi) {}
+
+  // ==========================================
+  // ADMIN OPERATIONS
+  // ==========================================
+
+  /**
+   * ADMIN: Get transaction analytics with filtering and aggregation
+   */
+  async getTransactionAnalytics(request: TransactionAnalyticsRequestDTO): Promise<TransactionAnalyticsResponseDTO> {
+    return this.analyticsApi.getTransactionAnalytics(request);
+  }
+}