@explorins/pers-sdk 1.1.0-beta.0 → 1.1.3

package/dist/transaction/api/transaction-api.d.ts

@@ -0,0 +1,133 @@
+import { PersApiClient } from '../../core/pers-api-client';
+import { TransactionDTO, TransactionRequestDTO, ClientTransactionRequestDTO, ClientTransactionRequestResponseDto, AccountSelectorDTO } from '../../shared/interfaces/pers-shared-lib.interfaces';
+import { TransactionPaginationParams, TransactionPaginationResponse, UserBurnTokenRequestDTO } from '../models';
+/**
+ * Platform-Agnostic Transaction API Client (UPDATED FOR NEW RESTful ENDPOINTS)
+ *
+ * Handles transaction operations using the PERS backend.
+ * Uses @explorins/pers-shared DTOs for consistency with backend.
+ *
+ * MIGRATION NOTES:
+ * - All endpoints changed from /transaction to /transactions
+ * - Role-based paths removed (no more /auth, /admin, /business in URLs)
+ * - New RESTful resource-based structure
+ * - Added new client-side transaction flow methods
+ * - Enhanced admin query capabilities
+ */
+export declare class TransactionApi {
+    private apiClient;
+    constructor(apiClient: PersApiClient);
+    private readonly basePath;
+    /**
+     * Get transaction by ID (public endpoint)
+     *
+     * UPDATED: /transaction/{id} → /transactions/{id}
+     */
+    getTransactionById(transactionId: string): Promise<TransactionDTO>;
+    /**
+     * AUTH: Create authenticated user transaction
+     *
+     * UPDATED: /transaction/auth/transaction → /transactions/user
+     */
+    createAuthTransaction(request: TransactionRequestDTO): Promise<TransactionDTO>;
+    /**
+     * AUTH: Get user's sent transactions
+     *
+     * UPDATED: /transaction/auth/sender → /transactions/me/sent
+     */
+    getUserSentTransactions(): Promise<TransactionDTO[]>;
+    /**
+     * AUTH: Get user's received transactions
+     *
+     * UPDATED: /transaction/auth/recipient → /transactions/me/received
+     */
+    getUserReceivedTransactions(): Promise<TransactionDTO[]>;
+    /**
+     * AUTH: Get user transaction history by type (backwards compatibility)
+     *
+     * UPDATED: Maps to appropriate /transactions/me/* endpoints
+     */
+    getUserTransactionHistory(type: string): Promise<TransactionDTO[]>;
+    /**
+     * AUTH: Prepare client signed transaction
+     *
+     * UPDATED: /transaction/auth/prepare-signing → /transactions/prepare
+     */
+    prepareClientSignedTransaction(request: ClientTransactionRequestDTO): Promise<ClientTransactionRequestResponseDto>;
+    /**
+     * AUTH: Prepare existing transaction for client-side signing
+     *
+     * NEW ENDPOINT: GET /transactions/{id}/prepare
+     */
+    prepareExistingTransaction(transactionId: string): Promise<ClientTransactionRequestResponseDto>;
+    /**
+     * AUTH: Submit client-side signed transaction
+     *
+     * NEW ENDPOINT: POST /transactions/{id}/submit
+     */
+    submitSignedTransaction(transactionId: string, signedData: any): Promise<TransactionDTO>;
+    /**
+     * AUTH: Burn user tokens
+     *
+     * UPDATED: Uses new user transaction endpoint with burn-specific parameters
+     * Note: This might need backend confirmation on burn functionality implementation
+     */
+    burnUserTokens(request: UserBurnTokenRequestDTO): Promise<TransactionDTO>;
+    /**
+     * BUSINESS: Create business transaction
+     *
+     * UPDATED: /transaction/business/transaction → /transactions/business
+     */
+    createBusinessTransaction(request: TransactionRequestDTO): Promise<TransactionDTO>;
+    /**
+     * ADMIN: Create admin transaction
+     *
+     * UPDATED: /transaction/admin/transaction → /transactions/admin
+     */
+    createAdminTransaction(request: TransactionRequestDTO): Promise<TransactionDTO>;
+    /**
+     * ADMIN: Get all tenant transactions
+     *
+     * UPDATED: /transaction/admin → /transactions
+     */
+    getTenantTransactions(): Promise<TransactionDTO[]>;
+    /**
+     * ADMIN: Get paginated transactions with filtering and sorting
+     *
+     * UPDATED: /transaction/admin → /transactions (same endpoint, better structure)
+     */
+    getPaginatedTransactions(params: TransactionPaginationParams): Promise<TransactionPaginationResponse>;
+    /**
+     * ADMIN: Export transactions to CSV
+     *
+     * UPDATED: /transaction/admin/export/csv → /transactions/export/csv
+     */
+    exportTransactionsCSV(): Promise<Blob>;
+    /**
+     * ADMIN: Query transactions by sender
+     *
+     * NEW ENDPOINT: POST /transactions/query-sender
+     */
+    queryTransactionsBySender(accountSelector: AccountSelectorDTO): Promise<TransactionDTO[]>;
+    /**
+     * ADMIN: Query transactions by recipient
+     *
+     * NEW ENDPOINT: POST /transactions/query-recipient
+     */
+    queryTransactionsByRecipient(accountSelector: AccountSelectorDTO): Promise<TransactionDTO[]>;
+    /**
+     * ADMIN: Get transaction analytics
+     *
+     * NEW ENDPOINT: POST /transactions/analytics
+     */
+    getTransactionAnalytics(analyticsRequest: any): Promise<any>;
+    /**
+     * Convenience method: Get user sent transactions (alias)
+     */
+    getUserSenderTransactions(): Promise<TransactionDTO[]>;
+    /**
+     * Convenience method: Get user received transactions (alias)
+     */
+    getUserRecipientTransactions(): Promise<TransactionDTO[]>;
+}
+//# sourceMappingURL=transaction-api.d.ts.map

package/dist/transaction/api/transaction-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-api.d.ts","sourceRoot":"","sources":["../../../src/transaction/api/transaction-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EACL,cAAc,EACd,qBAAqB,EACrB,2BAA2B,EAC3B,mCAAmC,EACnC,kBAAkB,EACnB,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EAAE,2BAA2B,EAAE,6BAA6B,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AAEhH;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACb,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAE5C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAE5C;;;;OAIG;IACG,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAQxE;;;;OAIG;IACG,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IAIpF;;;;OAIG;IACG,uBAAuB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAQ1D;;;;OAIG;IACG,2BAA2B,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAQ9D;;;;OAIG;IACG,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAmBxE;;;;OAIG;IACG,8BAA8B,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,mCAAmC,CAAC;IAIxH;;;;OAIG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,mCAAmC,CAAC;IAIrG;;;;OAIG;IACG,uBAAuB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9F;;;;;OAKG;IACG,cAAc,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,cAAc,CAAC;IAc/E;;;;OAIG;IACG,yBAAyB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IAQxF;;;;OAIG;IACG,sBAAsB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IAIrF;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAUxD;;;;OAIG;IACG,wBAAwB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAiD3G;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ5C;;;;OAIG;IACG,yBAAyB,CAAC,eAAe,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAI/F;;;;OAIG;IACG,4BAA4B,CAAC,eAAe,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIlG;;;;OAIG;IACG,uBAAuB,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAQlE;;OAEG;IACG,yBAAyB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAI5D;;OAEG;IACG,4BAA4B,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;CAGhE"}

package/dist/transaction/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @explorins/pers-sdk-transaction
+ *
+ * Platform-agnostic Transaction Domain SDK for PERS ecosystem
+ * Handles transaction operations across different authorization levels
+ */
+export { TransactionApi } from './api/transaction-api';
+export { TransactionService } from './services/transaction-service';
+export * from './models';
+export * from '../shared/interfaces/pers-shared-lib.interfaces';
+export * from './models';
+import { ClientTransactionRequestDTO, TransactionRequestDTO } from '../shared/interfaces/pers-shared-lib.interfaces';
+import { PersApiClient } from '../core/pers-api-client';
+import { TransactionApi } from './api/transaction-api';
+import { TransactionService } from './services/transaction-service';
+import { TransactionPaginationParams, UserBurnTokenRequestDTO } from './models';
+/**
+ * Create a complete Transaction SDK instance
+ *
+ * @param apiClient - Configured PERS API client
+ * @returns Transaction SDK with flattened structure for better DX
+ */
+export declare function createTransactionSDK(apiClient: PersApiClient): {
+    getTransactionById: (transactionId: string) => Promise<import("@explorins/pers-shared/dist/cjs/dto/transaction/transaction.dto").TransactionDTO>;
+    createAuthTransaction: (request: TransactionRequestDTO) => Promise<import("@explorins/pers-shared/dist/cjs/dto/transaction/transaction.dto").TransactionDTO>;
+    getUserTransactionHistory: (type: string) => Promise<import("@explorins/pers-shared/dist/cjs/dto/transaction/transaction.dto").TransactionDTO[]>;
+    prepareClientSignedTransaction: (request: ClientTransactionRequestDTO) => Promise<import("@explorins/pers-shared/dist/cjs/dto/transaction/transaction-client.request.dto").ClientTransactionRequestResponseDto>;
+    burnUserTokens: (request: UserBurnTokenRequestDTO) => Promise<import("@explorins/pers-shared/dist/cjs/dto/transaction/transaction.dto").TransactionDTO>;
+    createBusinessTransaction: (request: TransactionRequestDTO) => Promise<import("@explorins/pers-shared/dist/cjs/dto/transaction/transaction.dto").TransactionDTO>;
+    createAdminTransaction: (request: TransactionRequestDTO) => Promise<import("@explorins/pers-shared/dist/cjs/dto/transaction/transaction.dto").TransactionDTO>;
+    getTenantTransactions: () => Promise<import("@explorins/pers-shared/dist/cjs/dto/transaction/transaction.dto").TransactionDTO[]>;
+    getPaginatedTransactions: (params: TransactionPaginationParams) => Promise<import("./models").TransactionPaginationResponse>;
+    exportTransactionsCSV: () => Promise<Blob>;
+    api: TransactionApi;
+    service: TransactionService;
+};
+export type TransactionSDK = ReturnType<typeof createTransactionSDK>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transaction/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAGvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAGpE,cAAc,UAAU,CAAC;AACzB,cAAc,iDAAiD,CAAC;AAGhE,cAAc,UAAU,CAAC;AAEzB,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,iDAAiD,CAAC;AAErH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAEhF;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,aAAa;wCAQrB,MAAM;qCAGT,qBAAqB;sCACpB,MAAM;8CACE,2BAA2B;8BAC3C,uBAAuB;yCAGZ,qBAAqB;sCAGxB,qBAAqB;;uCAEpB,2BAA2B;;;;EAOjE;AAED,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

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

@@ -0,0 +1,42 @@
+/**
+ * Transaction Domain Models
+ *
+ * Re-exports from @explorins/pers-shared for consistency with backend
+ * and to provide a single import source for transaction-related types.
+ */
+export type { TransactionDTO, TransactionRequestDTO, ClientTransactionRequestDTO, ClientTransactionRequestResponseDto, UserToBusinessTokenTransactionCreateRequestDTO } from '../../shared/interfaces/pers-shared-lib.interfaces';
+import { TransactionDTO } from '../../shared/interfaces/pers-shared-lib.interfaces';
+export interface TransactionPaginationParams {
+    page: number;
+    limit: number;
+    participantId?: string;
+    status?: string;
+    sortBy?: string;
+    sortOrder?: 'ASC' | 'DESC';
+    filters?: {
+        startDate?: string;
+        endDate?: string;
+        type?: string[];
+        tokenType?: string[];
+    };
+}
+export interface TransactionPaginationResponse {
+    data: TransactionDTO[];
+    pagination: {
+        page: string;
+        limit: string;
+        total: number;
+        pages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    };
+}
+export interface UserBurnTokenRequestDTO {
+    tokenAddress: string;
+    tokenMetadataIncrementalId: string;
+    chainId: number;
+    amount: number;
+}
+export declare enum TransactionAccountType {
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transaction/models/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,2BAA2B,EAC3B,mCAAmC,EACnC,8CAA8C,EAC/C,MAAM,oDAAoD,CAAC;AAG5D,OAAO,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAC;AAIpF,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC3B,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,0BAA0B,EAAE,MAAM,CAAC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAGD,oBAAY,sBAAsB;CAGjC"}

package/dist/transaction/services/transaction-service.d.ts

@@ -0,0 +1,56 @@
+import { TransactionDTO } from '../../shared/interfaces/pers-shared-lib.interfaces';
+import { TransactionApi } from '../api/transaction-api';
+import { TransactionRequestDTO, ClientTransactionRequestDTO, ClientTransactionRequestResponseDto, TransactionPaginationParams, TransactionPaginationResponse, UserBurnTokenRequestDTO } from '../models';
+/**
+ * Platform-Agnostic Transaction Service
+ *
+ * Contains transaction business logic and operations that work across platforms.
+ * No framework dependencies - pure TypeScript business logic.
+ *
+ * Focuses only on actual backend capabilities.
+ */
+export declare class TransactionService {
+    private transactionApi;
+    constructor(transactionApi: TransactionApi);
+    /**
+     * Get transaction by ID
+     */
+    getTransactionById(transactionId: string): Promise<TransactionDTO>;
+    /**
+     * AUTH: Create authenticated transaction
+     */
+    createAuthTransaction(request: TransactionRequestDTO): Promise<TransactionDTO>;
+    /**
+     * AUTH: Get user transaction history by type
+     */
+    getUserTransactionHistory(type: string): Promise<TransactionDTO[]>;
+    /**
+     * AUTH: Prepare client signed transaction
+     */
+    prepareClientSignedTransaction(request: ClientTransactionRequestDTO): Promise<ClientTransactionRequestResponseDto>;
+    /**
+     * AUTH: Burn user tokens
+     */
+    burnUserTokens(request: UserBurnTokenRequestDTO): Promise<TransactionDTO>;
+    /**
+     * BUSINESS: Create business transaction
+     */
+    createBusinessTransaction(request: TransactionRequestDTO): Promise<TransactionDTO>;
+    /**
+     * ADMIN: Create admin transaction
+     */
+    createAdminTransaction(request: TransactionRequestDTO): Promise<TransactionDTO>;
+    /**
+     * ADMIN: Get all tenant transactions
+     */
+    getTenantTransactions(): Promise<TransactionDTO[]>;
+    /**
+     * ADMIN: Get paginated transactions with filtering and sorting
+     */
+    getPaginatedTransactions(params: TransactionPaginationParams): Promise<TransactionPaginationResponse>;
+    /**
+     * ADMIN: Export transactions to CSV
+     */
+    exportTransactionsCSV(): Promise<Blob>;
+}
+//# sourceMappingURL=transaction-service.d.ts.map

package/dist/transaction/services/transaction-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-service.d.ts","sourceRoot":"","sources":["../../../src/transaction/services/transaction-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAC;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,mCAAmC,EACnC,2BAA2B,EAC3B,6BAA6B,EAC7B,uBAAuB,EACxB,MAAM,WAAW,CAAC;AAEnB;;;;;;;GAOG;AACH,qBAAa,kBAAkB;IACjB,OAAO,CAAC,cAAc;gBAAd,cAAc,EAAE,cAAc;IAElD;;OAEG;IACG,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAQxE;;OAEG;IACG,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IAIpF;;OAEG;IACG,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIxE;;OAEG;IACG,8BAA8B,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,mCAAmC,CAAC;IAIxH;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,cAAc,CAAC;IAQ/E;;OAEG;IACG,yBAAyB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IAQxF;;OAEG;IACG,sBAAsB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IAIrF;;OAEG;IACG,qBAAqB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAIxD;;OAEG;IACG,wBAAwB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAI3G;;OAEG;IACG,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7C"}