@cygnus-wealth/data-models 1.1.2 → 1.4.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.
Files changed (91) hide show
  1. package/dist/cjs/enums/ChainFamily.js +54 -0
  2. package/dist/cjs/enums/DeFiDiscoverySource.js +37 -0
  3. package/dist/cjs/enums/DeFiPositionType.js +39 -0
  4. package/dist/cjs/enums/DeFiProtocol.js +46 -0
  5. package/dist/cjs/enums/IntegrationSource.js +8 -0
  6. package/dist/cjs/enums/VaultStrategyType.js +34 -0
  7. package/dist/cjs/index.js +11 -1
  8. package/dist/cjs/interfaces/AccountAssetEntry.js +2 -0
  9. package/dist/cjs/interfaces/AccountBalanceList.js +2 -0
  10. package/dist/cjs/interfaces/AccountGroup.js +2 -0
  11. package/dist/cjs/interfaces/AccountMetadata.js +2 -0
  12. package/dist/cjs/interfaces/AccountPortfolio.js +2 -0
  13. package/dist/cjs/interfaces/AccountSummary.js +2 -0
  14. package/dist/cjs/interfaces/AddressRequest.js +2 -0
  15. package/dist/cjs/interfaces/AssetDistribution.js +2 -0
  16. package/dist/cjs/interfaces/ConnectedAccount.js +2 -0
  17. package/dist/cjs/interfaces/DeFiPosition.js +2 -0
  18. package/dist/cjs/interfaces/GroupPortfolio.js +2 -0
  19. package/dist/cjs/interfaces/TrackedAddress.js +2 -0
  20. package/dist/cjs/interfaces/VaultPosition.js +2 -0
  21. package/dist/cjs/interfaces/WalletConnection.js +2 -0
  22. package/dist/cjs/interfaces/WalletPortfolio.js +2 -0
  23. package/dist/cjs/interfaces/WatchAddress.js +2 -0
  24. package/dist/cjs/types/AccountId.js +2 -0
  25. package/dist/cjs/types/Caip2ChainId.js +2 -0
  26. package/dist/cjs/types/WalletConnectionId.js +2 -0
  27. package/dist/cjs/types/WalletProviderId.js +2 -0
  28. package/dist/enums/ChainFamily.d.ts +50 -0
  29. package/dist/enums/ChainFamily.js +51 -0
  30. package/dist/enums/DeFiDiscoverySource.d.ts +33 -0
  31. package/dist/enums/DeFiDiscoverySource.js +34 -0
  32. package/dist/enums/DeFiPositionType.d.ts +35 -0
  33. package/dist/enums/DeFiPositionType.js +36 -0
  34. package/dist/enums/DeFiProtocol.d.ts +42 -0
  35. package/dist/enums/DeFiProtocol.js +43 -0
  36. package/dist/enums/IntegrationSource.d.ts +8 -0
  37. package/dist/enums/IntegrationSource.js +8 -0
  38. package/dist/enums/VaultStrategyType.d.ts +30 -0
  39. package/dist/enums/VaultStrategyType.js +31 -0
  40. package/dist/index.d.ts +25 -0
  41. package/dist/index.js +5 -0
  42. package/dist/interfaces/Account.d.ts +3 -0
  43. package/dist/interfaces/AccountAssetEntry.d.ts +42 -0
  44. package/dist/interfaces/AccountAssetEntry.js +1 -0
  45. package/dist/interfaces/AccountBalanceList.d.ts +85 -0
  46. package/dist/interfaces/AccountBalanceList.js +1 -0
  47. package/dist/interfaces/AccountGroup.d.ts +37 -0
  48. package/dist/interfaces/AccountGroup.js +1 -0
  49. package/dist/interfaces/AccountMetadata.d.ts +54 -0
  50. package/dist/interfaces/AccountMetadata.js +1 -0
  51. package/dist/interfaces/AccountPortfolio.d.ts +47 -0
  52. package/dist/interfaces/AccountPortfolio.js +1 -0
  53. package/dist/interfaces/AccountSummary.d.ts +49 -0
  54. package/dist/interfaces/AccountSummary.js +1 -0
  55. package/dist/interfaces/AddressRequest.d.ts +36 -0
  56. package/dist/interfaces/AddressRequest.js +1 -0
  57. package/dist/interfaces/Asset.d.ts +6 -0
  58. package/dist/interfaces/AssetDistribution.d.ts +45 -0
  59. package/dist/interfaces/AssetDistribution.js +1 -0
  60. package/dist/interfaces/ConnectedAccount.d.ts +52 -0
  61. package/dist/interfaces/ConnectedAccount.js +1 -0
  62. package/dist/interfaces/DeFiPosition.d.ts +79 -0
  63. package/dist/interfaces/DeFiPosition.js +1 -0
  64. package/dist/interfaces/FilterOptions.d.ts +8 -0
  65. package/dist/interfaces/GroupPortfolio.d.ts +39 -0
  66. package/dist/interfaces/GroupPortfolio.js +1 -0
  67. package/dist/interfaces/IntegrationCredentials.d.ts +3 -0
  68. package/dist/interfaces/LendingPosition.d.ts +3 -0
  69. package/dist/interfaces/LiquidityPosition.d.ts +3 -0
  70. package/dist/interfaces/Portfolio.d.ts +8 -0
  71. package/dist/interfaces/StakedPosition.d.ts +3 -0
  72. package/dist/interfaces/TrackedAddress.d.ts +50 -0
  73. package/dist/interfaces/TrackedAddress.js +1 -0
  74. package/dist/interfaces/Transaction.d.ts +3 -0
  75. package/dist/interfaces/VaultPosition.d.ts +113 -0
  76. package/dist/interfaces/VaultPosition.js +1 -0
  77. package/dist/interfaces/WalletConnection.d.ts +67 -0
  78. package/dist/interfaces/WalletConnection.js +1 -0
  79. package/dist/interfaces/WalletPortfolio.d.ts +40 -0
  80. package/dist/interfaces/WalletPortfolio.js +1 -0
  81. package/dist/interfaces/WatchAddress.d.ts +42 -0
  82. package/dist/interfaces/WatchAddress.js +1 -0
  83. package/dist/types/AccountId.d.ts +27 -0
  84. package/dist/types/AccountId.js +1 -0
  85. package/dist/types/Caip2ChainId.d.ts +27 -0
  86. package/dist/types/Caip2ChainId.js +1 -0
  87. package/dist/types/WalletConnectionId.d.ts +19 -0
  88. package/dist/types/WalletConnectionId.js +1 -0
  89. package/dist/types/WalletProviderId.d.ts +17 -0
  90. package/dist/types/WalletProviderId.js +1 -0
  91. package/package.json +26 -1
@@ -0,0 +1,27 @@
1
+ /**
2
+ * CAIP-2 chain identifier string type.
3
+ *
4
+ * Format: `{namespace}:{reference}` as defined by the Chain Agnostic
5
+ * Improvement Proposal 2. Used for WalletConnect v2 interoperability.
6
+ *
7
+ * Common namespace prefixes map to ChainFamily values:
8
+ * - `eip155` → ChainFamily.EVM (e.g., `eip155:1` for Ethereum mainnet)
9
+ * - `solana` → ChainFamily.SOLANA (e.g., `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`)
10
+ * - `bip122` → ChainFamily.BITCOIN
11
+ * - `cosmos` → ChainFamily.COSMOS
12
+ *
13
+ * @example
14
+ * ```typescript
15
+ * import { Caip2ChainId } from '@cygnus-wealth/data-models';
16
+ *
17
+ * const ethereumMainnet: Caip2ChainId = 'eip155:1';
18
+ * const polygon: Caip2ChainId = 'eip155:137';
19
+ * const solanaMainnet: Caip2ChainId = 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp';
20
+ * ```
21
+ *
22
+ * @since 1.5.0
23
+ * @stability extended
24
+ *
25
+ * @see {@link ChainFamily} for chain family classification
26
+ */
27
+ export type Caip2ChainId = string;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Unique identifier for a specific wallet connection session.
3
+ *
4
+ * Format: `{providerId}:{randomId}` (e.g., `metamask:a1b2c3d4`).
5
+ * The randomId component ensures uniqueness when the same provider
6
+ * is connected multiple times (e.g., two WalletConnect sessions).
7
+ *
8
+ * @example
9
+ * ```typescript
10
+ * import { WalletConnectionId } from '@cygnus-wealth/data-models';
11
+ *
12
+ * const connectionId: WalletConnectionId = 'metamask:a1b2c3d4';
13
+ * const wcConnectionId: WalletConnectionId = 'walletconnect:x9y8z7w6';
14
+ * ```
15
+ *
16
+ * @since 1.3.0
17
+ * @stability extended
18
+ */
19
+ export type WalletConnectionId = string;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Canonical identifier for a wallet provider.
3
+ *
4
+ * String union type representing supported wallet providers. Extensible
5
+ * without breaking changes when new wallets are supported.
6
+ *
7
+ * @example
8
+ * ```typescript
9
+ * import { WalletProviderId } from '@cygnus-wealth/data-models';
10
+ *
11
+ * const provider: WalletProviderId = 'metamask';
12
+ * ```
13
+ *
14
+ * @since 1.3.0
15
+ * @stability extended
16
+ */
17
+ export type WalletProviderId = 'metamask' | 'rabby' | 'walletconnect' | 'coinbase-wallet' | 'trust-wallet' | 'frame' | 'crypto-com-onchain' | 'phantom' | 'solflare' | 'backpack' | 'exodus' | 'manual';
@@ -0,0 +1 @@
1
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cygnus-wealth/data-models",
3
- "version": "1.1.2",
3
+ "version": "1.4.0",
4
4
  "description": "Shared TypeScript data models for CygnusWealth project",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/index.js",
@@ -21,6 +21,11 @@
21
21
  "import": "./dist/enums/Chain.js",
22
22
  "require": "./dist/cjs/enums/Chain.js"
23
23
  },
24
+ "./enums/ChainFamily": {
25
+ "types": "./dist/enums/ChainFamily.d.ts",
26
+ "import": "./dist/enums/ChainFamily.js",
27
+ "require": "./dist/cjs/enums/ChainFamily.js"
28
+ },
24
29
  "./enums/IntegrationSource": {
25
30
  "types": "./dist/enums/IntegrationSource.d.ts",
26
31
  "import": "./dist/enums/IntegrationSource.js",
@@ -41,6 +46,26 @@
41
46
  "import": "./dist/enums/LendingPositionType.js",
42
47
  "require": "./dist/cjs/enums/LendingPositionType.js"
43
48
  },
49
+ "./enums/VaultStrategyType": {
50
+ "types": "./dist/enums/VaultStrategyType.d.ts",
51
+ "import": "./dist/enums/VaultStrategyType.js",
52
+ "require": "./dist/cjs/enums/VaultStrategyType.js"
53
+ },
54
+ "./enums/DeFiPositionType": {
55
+ "types": "./dist/enums/DeFiPositionType.d.ts",
56
+ "import": "./dist/enums/DeFiPositionType.js",
57
+ "require": "./dist/cjs/enums/DeFiPositionType.js"
58
+ },
59
+ "./enums/DeFiProtocol": {
60
+ "types": "./dist/enums/DeFiProtocol.d.ts",
61
+ "import": "./dist/enums/DeFiProtocol.js",
62
+ "require": "./dist/cjs/enums/DeFiProtocol.js"
63
+ },
64
+ "./enums/DeFiDiscoverySource": {
65
+ "types": "./dist/enums/DeFiDiscoverySource.d.ts",
66
+ "import": "./dist/enums/DeFiDiscoverySource.js",
67
+ "require": "./dist/cjs/enums/DeFiDiscoverySource.js"
68
+ },
44
69
  "./interfaces/*": {
45
70
  "types": "./dist/interfaces/*.d.ts",
46
71
  "import": "./dist/interfaces/*.js",