cilantro-sdk 0.0.36 → 0.0.39

package/README.md

@@ -18,6 +18,13 @@ A TypeScript/JavaScript SDK for interacting with the Cilantro Smart API - A Sola
   - [Transactions Module](#transactions-module-cilantro-sdktransactions)
   - [Delegated Keys Module](#delegated-keys-module-cilantro-sdkdelegated-keys)
   - [Webhooks Module](#webhooks-module-cilantro-sdkwebhooks)
+  - [Public Module](#public-module-cilantro-sdkpublic)
+  - [App Module](#app-module-cilantro-sdkapp)
+  - [Address Book Module](#address-book-module-cilantro-sdkaddress-book)
+  - [Analytics Module](#analytics-module-cilantro-sdkanalytics)
+  - [Health Module](#health-module-cilantro-sdkhealth)
+  - [Scheduled Transactions Module](#scheduled-transactions-module-cilantro-sdkscheduled-transactions)
+  - [Spending Limits Module](#spending-limits-module-cilantro-sdkspending-limits)
   - [Helpers Module](#helpers-module-cilantro-sdkhelpers)
   - [Utils Module](#utils-module-cilantro-sdkutils)
 - [Examples & Use Cases](#examples--use-cases)
@@ -2681,6 +2688,493 @@ import { remove } from 'cilantro-sdk/webhooks';
 await remove('webhook-id');
 ```
 
+### Public Module (`cilantro-sdk/public`)
+
+#### `getPublicPlans(): Promise<PublicControllerGetPublicPlansResult>`
+
+Get all available subscription plans for public display (e.g., landing page pricing).
+
+**Parameters:** None
+
+**Returns:** `Promise<PublicControllerGetPublicPlansResult>` - List of active subscription plans
+
+**Example:**
+```typescript
+import { getPublicPlans } from 'cilantro-sdk/public';
+
+const plans = await getPublicPlans();
+console.log('Available plans:', plans.data);
+```
+
+#### `getPublicStats(): Promise<PublicControllerGetPublicStatsResult>`
+
+Get lightweight aggregate counts for platforms, users, wallets, plans, and transactions to display on the landing page.
+
+**Parameters:** None
+
+**Returns:** `Promise<PublicControllerGetPublicStatsResult>` - Public statistics
+
+**Example:**
+```typescript
+import { getPublicStats } from 'cilantro-sdk/public';
+
+const stats = await getPublicStats();
+console.log('Total platforms:', stats.data.totals.platforms);
+console.log('Total users:', stats.data.totals.users);
+```
+
+### App Module (`cilantro-sdk/app`)
+
+#### `getHello(): Promise<AppControllerGetHelloResult>`
+
+Simple health check endpoint that returns a hello message.
+
+**Parameters:** None
+
+**Returns:** `Promise<AppControllerGetHelloResult>` - Hello message string
+
+**Example:**
+```typescript
+import { getHello } from 'cilantro-sdk/app';
+
+const message = await getHello();
+console.log(message);
+```
+
+### Address Book Module (`cilantro-sdk/address-book`)
+
+#### `create(data: CreateAddressBookDto): Promise<AddressBookControllerCreateResult>`
+
+Save a Solana address with a label and optional description/tags for quick access.
+
+**Parameters:**
+- `data` (`CreateAddressBookDto`): Address book entry data
+  - `address` (`string`): Solana address
+  - `label` (`string`): Address label/name
+  - `description?` (`string`): Optional description
+  - `tags?` (`string[]`): Optional tags for categorization
+
+**Returns:** `Promise<AddressBookControllerCreateResult>` - Created address book entry
+
+**Example:**
+```typescript
+import { create } from 'cilantro-sdk/address-book';
+
+const entry = await create({
+  address: 'DYw8jCTfwHNRJhhmFcbXvVDTqWMEVFBX6ZKUmG5CNSKK',
+  label: 'My Wallet',
+  description: 'Personal wallet',
+  tags: ['personal', 'main']
+});
+```
+
+#### `findAll(params?: AddressBookControllerFindAllParams): Promise<AddressBookControllerFindAllResult>`
+
+Retrieve paginated list of saved addresses with optional search and tag filtering.
+
+**Parameters:**
+- `params?` (`AddressBookControllerFindAllParams`): Optional query parameters
+  - `page?` (`number`): Page number
+  - `limit?` (`number`): Items per page
+  - `search?` (`string`): Search term
+  - `tags?` (`string[]`): Filter by tags
+
+**Returns:** `Promise<AddressBookControllerFindAllResult>` - Paginated list of address book entries
+
+**Example:**
+```typescript
+import { findAll } from 'cilantro-sdk/address-book';
+
+const entries = await findAll({
+  page: 1,
+  limit: 20,
+  search: 'wallet',
+  tags: ['personal']
+});
+```
+
+#### `findOne(id: string): Promise<AddressBookControllerFindOneResult>`
+
+Retrieve details of a specific address book entry.
+
+**Parameters:**
+- `id` (`string`): Address book entry ID
+
+**Returns:** `Promise<AddressBookControllerFindOneResult>` - Address book entry details
+
+**Example:**
+```typescript
+import { findOne } from 'cilantro-sdk/address-book';
+
+const entry = await findOne('entry-id');
+```
+
+#### `update(id: string, data: UpdateAddressBookDto): Promise<AddressBookControllerUpdateResult>`
+
+Update label, description, tags, or other metadata of an address book entry.
+
+**Parameters:**
+- `id` (`string`): Address book entry ID
+- `data` (`UpdateAddressBookDto`): Update data
+  - `label?` (`string`): New label
+  - `description?` (`string`): New description
+  - `tags?` (`string[]`): Updated tags
+
+**Returns:** `Promise<AddressBookControllerUpdateResult>` - Updated address book entry
+
+**Example:**
+```typescript
+import { update } from 'cilantro-sdk/address-book';
+
+await update('entry-id', {
+  label: 'Updated Label',
+  tags: ['updated', 'tag']
+});
+```
+
+#### `remove(id: string): Promise<AddressBookControllerRemoveResult>`
+
+Remove an address from the address book.
+
+**Parameters:**
+- `id` (`string`): Address book entry ID
+
+**Returns:** `Promise<AddressBookControllerRemoveResult>` - Deletion confirmation
+
+**Example:**
+```typescript
+import { remove } from 'cilantro-sdk/address-book';
+
+await remove('entry-id');
+```
+
+#### `verifyAddress(id: string): Promise<AddressBookControllerVerifyAddressResult>`
+
+Verify that the saved address is a valid Solana address by checking on-chain.
+
+**Parameters:**
+- `id` (`string`): Address book entry ID
+
+**Returns:** `Promise<AddressBookControllerVerifyAddressResult>` - Verified address book entry
+
+**Example:**
+```typescript
+import { verifyAddress } from 'cilantro-sdk/address-book';
+
+const verified = await verifyAddress('entry-id');
+console.log('Address is valid:', verified.data.isValid);
+```
+
+### Analytics Module (`cilantro-sdk/analytics`)
+
+#### `getWalletAnalytics(walletId: string, params?: WalletAnalyticsControllerGetWalletAnalyticsParams): Promise<WalletAnalyticsControllerGetWalletAnalyticsResult>`
+
+Get comprehensive analytics for a wallet including balance trends, transaction volumes, asset distribution, spending patterns, and monthly/weekly summaries.
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+- `params?` (`WalletAnalyticsControllerGetWalletAnalyticsParams`): Optional query parameters
+  - `startDate?` (`string`): Start date for analytics (ISO 8601)
+  - `endDate?` (`string`): End date for analytics (ISO 8601)
+  - `period?` (`'daily' | 'weekly' | 'monthly'`): Aggregation period
+
+**Returns:** `Promise<WalletAnalyticsControllerGetWalletAnalyticsResult>` - Wallet analytics data
+
+**Example:**
+```typescript
+import { getWalletAnalytics } from 'cilantro-sdk/analytics';
+
+const analytics = await getWalletAnalytics('wallet-id', {
+  startDate: '2024-01-01T00:00:00Z',
+  endDate: '2024-12-31T23:59:59Z',
+  period: 'monthly'
+});
+```
+
+### Health Module (`cilantro-sdk/health`)
+
+#### `getHello(): Promise<AppControllerGetHelloResult>`
+
+Simple health check message to verify the API is running.
+
+**Parameters:** None
+
+**Returns:** `Promise<AppControllerGetHelloResult>` - Hello message string
+
+**Example:**
+```typescript
+import { getHello } from 'cilantro-sdk/health';
+
+const message = await getHello();
+```
+
+#### `getHealth(): Promise<HealthControllerGetHealthResult>`
+
+Comprehensive health check endpoint that verifies database, Redis, and Solana RPC connectivity. Returns overall status (healthy/degraded/unhealthy) and individual service statuses.
+
+**Parameters:** None
+
+**Returns:** `Promise<HealthControllerGetHealthResult>` - Health status with service details
+
+**Example:**
+```typescript
+import { getHealth } from 'cilantro-sdk/health';
+
+const health = await getHealth();
+console.log('Overall status:', health.data.status);
+console.log('Database:', health.data.services.database);
+```
+
+#### `getLiveness(): Promise<HealthControllerLivenessResult>`
+
+Simple liveness check that always returns OK if the application is running. Used by Kubernetes/Docker for container health.
+
+**Parameters:** None
+
+**Returns:** `Promise<HealthControllerLivenessResult>` - Liveness status
+
+**Example:**
+```typescript
+import { getLiveness } from 'cilantro-sdk/health';
+
+const liveness = await getLiveness();
+console.log('Alive:', liveness.data.status === 'ok');
+```
+
+#### `getReadiness(): Promise<HealthControllerReadinessResult>`
+
+Readiness check that verifies if the application is ready to accept traffic. Returns OK only if critical services (database, Solana RPC) are available.
+
+**Parameters:** None
+
+**Returns:** `Promise<HealthControllerReadinessResult>` - Readiness status
+
+**Example:**
+```typescript
+import { getReadiness } from 'cilantro-sdk/health';
+
+const readiness = await getReadiness();
+console.log('Ready:', readiness.data.status === 'ok');
+```
+
+### Scheduled Transactions Module (`cilantro-sdk/scheduled-transactions`)
+
+#### `create(walletId: string, data: CreateScheduledTransactionDto): Promise<ScheduledTransactionControllerCreateResult>`
+
+Schedule a one-time or recurring transaction. Supports daily, weekly, and monthly recurrence.
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+- `data` (`CreateScheduledTransactionDto`): Scheduled transaction data
+  - `transactionType` (`'SEND_SOL' | 'SEND_SPL' | 'CUSTOM'`): Transaction type
+  - `recurrenceType` (`'ONE_TIME' | 'DAILY' | 'WEEKLY' | 'MONTHLY'`): Recurrence pattern
+  - `scheduledAt` (`string`): Scheduled execution time (ISO 8601)
+  - `toAddress?` (`string`): Recipient Solana address (required for SEND_SOL/SEND_SPL)
+  - `amount?` (`number`): Amount in lamports (required for SEND_SOL/SEND_SPL)
+  - `tokenMint?` (`string`): Token mint address (required for SEND_SPL)
+  - `instructionData?` (`string`): Base64 encoded instruction data (for CUSTOM transactions)
+  - `maxExecutions?` (`number`): Maximum number of executions (for recurring transactions, null = unlimited)
+  - `metadata?` (`object`): Additional metadata
+
+**Returns:** `Promise<ScheduledTransactionControllerCreateResult>` - Created scheduled transaction
+
+**Example:**
+```typescript
+import { create } from 'cilantro-sdk/scheduled-transactions';
+
+const scheduled = await create('wallet-id', {
+  transactionType: 'SEND_SOL',
+  recurrenceType: 'MONTHLY',
+  scheduledAt: '2024-12-25T10:00:00Z',
+  toAddress: 'DYw8jCTfwHNRJhhmFcbXvVDTqWMEVFBX6ZKUmG5CNSKK',
+  amount: 1000000000,
+  maxExecutions: 12
+});
+```
+
+#### `findAll(walletId: string): Promise<ScheduledTransactionControllerFindAllResult>`
+
+Retrieve all scheduled transactions (pending, queued, processing, completed, failed).
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+
+**Returns:** `Promise<ScheduledTransactionControllerFindAllResult>` - List of scheduled transactions
+
+**Example:**
+```typescript
+import { findAll } from 'cilantro-sdk/scheduled-transactions';
+
+const scheduled = await findAll('wallet-id');
+```
+
+#### `findOne(walletId: string, id: string): Promise<ScheduledTransactionControllerFindOneResult>`
+
+Retrieve details of a specific scheduled transaction.
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+- `id` (`string`): Scheduled transaction ID
+
+**Returns:** `Promise<ScheduledTransactionControllerFindOneResult>` - Scheduled transaction details
+
+**Example:**
+```typescript
+import { findOne } from 'cilantro-sdk/scheduled-transactions';
+
+const transaction = await findOne('wallet-id', 'scheduled-tx-id');
+```
+
+#### `update(walletId: string, id: string, data: Partial<CreateScheduledTransactionDto>): Promise<ScheduledTransactionControllerUpdateResult>`
+
+Update scheduled transaction details (schedule time, amount, etc.). Cannot update transactions that are being processed.
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+- `id` (`string`): Scheduled transaction ID
+- `data` (`Partial<CreateScheduledTransactionDto>`): Update data (all fields optional)
+  - `scheduledAt?` (`string`): New scheduled time
+  - `amount?` (`number`): New amount in lamports
+  - `toAddress?` (`string`): New recipient address
+  - `maxExecutions?` (`number`): New maximum executions
+
+**Returns:** `Promise<ScheduledTransactionControllerUpdateResult>` - Updated scheduled transaction
+
+**Example:**
+```typescript
+import { update } from 'cilantro-sdk/scheduled-transactions';
+
+await update('wallet-id', 'scheduled-tx-id', {
+  scheduledAt: '2024-12-26T10:00:00Z',
+  amount: 2000000000
+});
+```
+
+#### `cancel(walletId: string, id: string): Promise<ScheduledTransactionControllerCancelResult>`
+
+Cancel a pending scheduled transaction. Cannot cancel completed transactions.
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+- `id` (`string`): Scheduled transaction ID
+
+**Returns:** `Promise<ScheduledTransactionControllerCancelResult>` - Cancellation confirmation
+
+**Example:**
+```typescript
+import { cancel } from 'cilantro-sdk/scheduled-transactions';
+
+await cancel('wallet-id', 'scheduled-tx-id');
+```
+
+### Spending Limits Module (`cilantro-sdk/spending-limits`)
+
+#### `create(walletId: string, data: CreateSpendingLimitDto): Promise<SpendingLimitControllerCreateResult>`
+
+Set a spending limit for a wallet (daily, weekly, monthly, or per-transaction).
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+- `data` (`CreateSpendingLimitDto`): Spending limit data
+  - `period` (`'DAILY' | 'WEEKLY' | 'MONTHLY' | 'PER_TRANSACTION'`): Limit period
+  - `limitAmount` (`number`): Maximum amount in SOL (not lamports)
+  - `alertThreshold?` (`number`): Alert threshold percentage (0-100)
+  - `alertOnReach?` (`boolean`): Send alert when limit is reached
+  - `autoPause?` (`boolean`): Auto-pause wallet when limit is reached
+
+**Returns:** `Promise<SpendingLimitControllerCreateResult>` - Created spending limit
+
+**Example:**
+```typescript
+import { create } from 'cilantro-sdk/spending-limits';
+
+const limit = await create('wallet-id', {
+  period: 'DAILY',
+  limitAmount: 10, // 10 SOL
+  alertThreshold: 80,
+  alertOnReach: true,
+  autoPause: false
+});
+```
+
+#### `findAll(walletId: string): Promise<SpendingLimitControllerFindAllResult>`
+
+Retrieve all spending limits configured for a wallet.
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+
+**Returns:** `Promise<SpendingLimitControllerFindAllResult>` - List of spending limits
+
+**Example:**
+```typescript
+import { findAll } from 'cilantro-sdk/spending-limits';
+
+const limits = await findAll('wallet-id');
+```
+
+#### `getBudgetStatus(walletId: string): Promise<SpendingLimitControllerGetBudgetStatusResult>`
+
+Get current budget utilization and status for all active spending limits.
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+
+**Returns:** `Promise<SpendingLimitControllerGetBudgetStatusResult>` - Budget status for all limits
+
+**Example:**
+```typescript
+import { getBudgetStatus } from 'cilantro-sdk/spending-limits';
+
+const status = await getBudgetStatus('wallet-id');
+console.log('Daily limit used:', status.data.daily?.used);
+console.log('Daily limit remaining:', status.data.daily?.remaining);
+```
+
+#### `update(walletId: string, id: string, data: UpdateSpendingLimitDto): Promise<SpendingLimitControllerUpdateResult>`
+
+Update spending limit configuration (amount, alerts, auto-pause).
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+- `id` (`string`): Spending limit ID
+- `data` (`UpdateSpendingLimitDto`): Update data
+  - `period?` (`'DAILY' | 'WEEKLY' | 'MONTHLY' | 'PER_TRANSACTION'`): New limit period
+  - `limitAmount?` (`number`): New maximum amount in SOL
+  - `alertThreshold?` (`number`): New alert threshold percentage (0-100)
+  - `alertOnReach?` (`boolean`): Send alert when limit reached
+  - `autoPause?` (`boolean`): Auto-pause setting
+
+**Returns:** `Promise<SpendingLimitControllerUpdateResult>` - Updated spending limit
+
+**Example:**
+```typescript
+import { update } from 'cilantro-sdk/spending-limits';
+
+await update('wallet-id', 'limit-id', {
+  limitAmount: 20, // 20 SOL
+  alertThreshold: 90,
+  autoPause: true
+});
+```
+
+#### `remove(walletId: string, id: string): Promise<SpendingLimitControllerRemoveResult>`
+
+Remove a spending limit from a wallet.
+
+**Parameters:**
+- `walletId` (`string`): Wallet ID
+- `id` (`string`): Spending limit ID
+
+**Returns:** `Promise<SpendingLimitControllerRemoveResult>` - Deletion confirmation
+
+**Example:**
+```typescript
+import { remove } from 'cilantro-sdk/spending-limits';
+
+await remove('wallet-id', 'limit-id');
+```
+
 ### Helpers Module (`cilantro-sdk/helpers`)
 
 **Device Key Management:**

package/dist/address-book.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Address Book module - Simplified exports for address book API functions
+ */
+export declare const create: (createAddressBookDto: import("./models").CreateAddressBookDto, options?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("./models").AddressBookResponseDto>;
+export declare const findAll: (params?: import("./models").AddressBookControllerFindAllParams, options?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("./models").AddressBookListResponseDto>;
+export declare const findOne: (id: string, options?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("./models").AddressBookResponseDto>;
+export declare const update: (id: string, updateAddressBookDto: import("./models").UpdateAddressBookDto, options?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("./models").AddressBookResponseDto>;
+export declare const remove: (id: string, options?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<void>;
+export declare const verifyAddress: (id: string, options?: import("axios").AxiosRequestConfig<any> | undefined) => Promise<import("./models").AddressBookResponseDto>;
+export type { AddressBookControllerCreateResult, AddressBookControllerFindAllResult, AddressBookControllerFindOneResult, AddressBookControllerUpdateResult, AddressBookControllerRemoveResult, AddressBookControllerVerifyAddressResult, } from './api/address-book/address-book';
+export type { CreateAddressBookDto, UpdateAddressBookDto, AddressBookControllerFindAllParams, } from './models';
+//# sourceMappingURL=address-book.d.ts.map

package/dist/address-book.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address-book.d.ts","sourceRoot":"","sources":["../src/address-book.ts"],"names":[],"mappings":"AAAA;;GAEG;AAcH,eAAO,MAAM,MAAM,sLAA8B,CAAC;AAClD,eAAO,MAAM,OAAO,2LAA+B,CAAC;AACpD,eAAO,MAAM,OAAO,mIAA+B,CAAC;AACpD,eAAO,MAAM,MAAM,kMAA8B,CAAC;AAClD,eAAO,MAAM,MAAM,8FAA8B,CAAC;AAClD,eAAO,MAAM,aAAa,mIAAqC,CAAC;AAGhE,YAAY,EACV,iCAAiC,EACjC,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,iCAAiC,EACjC,wCAAwC,GACzC,MAAM,iCAAiC,CAAC;AAEzC,YAAY,EACV,oBAAoB,EACpB,oBAAoB,EACpB,kCAAkC,GACnC,MAAM,UAAU,CAAC"}

package/dist/admin.cjs

@@ -412,15 +412,15 @@ var findOneWallet = adminControllerFindOneWallet;
 var getOverviewAnalytics = adminControllerGetOverviewAnalytics;
 var getWalletAnalytics = adminControllerGetWalletAnalytics;
 var getRecentActivity = adminControllerGetRecentActivity;
-var regenerateApiKey = adminControllerRegenerateApiKey;
-var getPlatformsWithUsers = adminControllerGetPlatformsWithUsers;
-var getUsersWithWallets = adminControllerGetUsersWithWallets;
-var getWalletAssets = adminControllerGetWalletAssets;
 var getPlatformAnalytics = adminControllerGetPlatformAnalytics;
 var getPlatformUsageMetrics = adminControllerGetPlatformUsageMetrics;
 var getPlatformGrowthTrends = adminControllerGetPlatformGrowthTrends;
 var getTopPlatforms = adminControllerGetTopPlatforms;
 var getPlatformActivityTimeline = adminControllerGetPlatformActivityTimeline;
+var regenerateApiKey = adminControllerRegenerateApiKey;
+var getPlatformsWithUsers = adminControllerGetPlatformsWithUsers;
+var getUsersWithWallets = adminControllerGetUsersWithWallets;
+var getWalletAssets = adminControllerGetWalletAssets;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   create,