@cranberry-money/shared-types 4.22.0 → 4.24.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 (7) hide show
  1. package/dist/index.d.ts +2 -2
  2. package/dist/index.d.ts.map +1 -1
  3. package/dist/query-params.d.ts +48 -0
  4. package/dist/query-params.d.ts.map +1 -1
  5. package/dist/trade.d.ts +69 -0
  6. package/dist/trade.d.ts.map +1 -1
  7. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -12,8 +12,8 @@ export type { LiquidationProgress } from './withdrawal';
12
12
  export type { UserProfile, UserProfilePayload, UserProfileCompletionPayload } from './user';
13
13
  export type { Account, AccountPayload } from './account';
14
14
  export type { InvestmentPreference, InvestmentPreferencePayload } from './investment';
15
- export type { InstrumentsQueryParams } from './query-params';
15
+ export type { InstrumentsQueryParams, TargetTradeQueryParams, TargetTradeSheetQueryParams, TradeSheetQueryParams, TradeQueryParams, } from './query-params';
16
16
  export type { Portfolio, PortfolioPayload, RebalancingTradesGenerationResponse, AssetAllocation, AssetAllocationPayload, } from './portfolio';
17
17
  export type { AssetHolding, AssetHoldingSnapshot, AssetHoldingFilters, AssetHoldingSnapshotFilters } from './holdings';
18
- export type { TradeAction, SimpleTradeStatus, SimpleTargetTradeStatus } from './trade';
18
+ export type { TradeAction, SimpleTradeStatus, SimpleTargetTradeStatus, Trade, TargetTrade, TargetTradePayload, TradeSheet, TargetTradeSheet, TargetTradeSheetPayload, TargetTradeSheetApprovalResponse, TargetTradeSheetCleanResponse, } from './trade';
19
19
  //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAG7F,YAAY,EACV,aAAa,EACb,aAAa,EACb,wBAAwB,EACxB,SAAS,EACT,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,QAAQ,CAAC;AAGhB,YAAY,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAGhH,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAGlG,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAG1G,YAAY,EACV,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,UAAU,EACV,UAAU,EACV,kBAAkB,GACnB,MAAM,eAAe,CAAC;AAGvB,YAAY,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAGxD,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,4BAA4B,EAAE,MAAM,QAAQ,CAAC;AAG5F,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAGzD,YAAY,EAAE,oBAAoB,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAGtF,YAAY,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAG7D,YAAY,EACV,SAAS,EACT,gBAAgB,EAChB,mCAAmC,EACnC,eAAe,EACf,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAGrB,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAGvH,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAG7F,YAAY,EACV,aAAa,EACb,aAAa,EACb,wBAAwB,EACxB,SAAS,EACT,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,QAAQ,CAAC;AAGhB,YAAY,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAGhH,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAGlG,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAG1G,YAAY,EACV,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,UAAU,EACV,UAAU,EACV,kBAAkB,GACnB,MAAM,eAAe,CAAC;AAGvB,YAAY,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAGxD,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,4BAA4B,EAAE,MAAM,QAAQ,CAAC;AAG5F,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAGzD,YAAY,EAAE,oBAAoB,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAGtF,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,2BAA2B,EAC3B,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAGxB,YAAY,EACV,SAAS,EACT,gBAAgB,EAChB,mCAAmC,EACnC,eAAe,EACf,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAGrB,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAGvH,YAAY,EACV,WAAW,EACX,iBAAiB,EACjB,uBAAuB,EACvB,KAAK,EACL,WAAW,EACX,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,uBAAuB,EACvB,gCAAgC,EAChC,6BAA6B,GAC9B,MAAM,SAAS,CAAC"}
package/dist/query-params.d.ts CHANGED
@@ -3,6 +3,7 @@
3
3
  * Shared across the MyPortfolio platform
4
4
  */
5
5
  import type { PaginationParams, OrderingParams } from './api';
6
+ import type { TradeAction, SimpleTradeStatus } from './trade';
6
7
  /**
7
8
  * Query parameters for filtering instruments
8
9
  */
@@ -22,4 +23,51 @@ export interface InstrumentsQueryParams extends PaginationParams, OrderingParams
22
23
  max_price?: number;
23
24
  search?: string;
24
25
  }
26
+ /**
27
+ * Query parameters for filtering target trades
28
+ */
29
+ export interface TargetTradeQueryParams {
30
+ portfolio?: string;
31
+ instrument?: string;
32
+ action?: TradeAction;
33
+ status?: string;
34
+ start_date?: string;
35
+ end_date?: string;
36
+ min_price?: number;
37
+ max_price?: number;
38
+ }
39
+ /**
40
+ * Query parameters for filtering target trade sheets
41
+ */
42
+ export interface TargetTradeSheetQueryParams {
43
+ portfolio?: string;
44
+ startDate?: string;
45
+ endDate?: string;
46
+ }
47
+ /**
48
+ * Query parameters for filtering trade sheets
49
+ */
50
+ export interface TradeSheetQueryParams {
51
+ portfolio?: string;
52
+ start_date?: string;
53
+ end_date?: string;
54
+ }
55
+ /**
56
+ * Query parameters for filtering trades
57
+ */
58
+ export interface TradeQueryParams {
59
+ portfolio?: string;
60
+ instrument?: string;
61
+ action?: TradeAction;
62
+ status?: SimpleTradeStatus;
63
+ currency?: string;
64
+ start_date?: string;
65
+ end_date?: string;
66
+ settlement_start_date?: string;
67
+ settlement_end_date?: string;
68
+ min_price?: number;
69
+ max_price?: number;
70
+ tradesheet?: string;
71
+ target_trade?: string;
72
+ }
25
73
  //# sourceMappingURL=query-params.d.ts.map
package/dist/query-params.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../src/query-params.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB,EAAE,cAAc;IAC9E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
1
+ {"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../src/query-params.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB,EAAE,cAAc;IAC9E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}
package/dist/trade.d.ts CHANGED
@@ -1,4 +1,73 @@
1
1
  export type TradeAction = 'BUY' | 'SELL';
2
2
  export type SimpleTradeStatus = 'EXECUTED' | 'SETTLED' | 'CANCELLED' | 'FAILED';
3
3
  export type SimpleTargetTradeStatus = 'PENDING' | 'APPROVED' | 'SUBMITTED' | 'CANCELLED' | 'EXPIRED';
4
+ export interface TargetTrade {
5
+ uuid: string;
6
+ targetTradesheet: string;
7
+ instrument: string;
8
+ instrumentSymbol: string;
9
+ instrumentName: string;
10
+ quantity: number;
11
+ action: TradeAction;
12
+ targetPrice: string;
13
+ status: string;
14
+ expiresAt: string | null;
15
+ createdAt: string;
16
+ updatedAt: string;
17
+ }
18
+ export interface TargetTradeSheet {
19
+ uuid: string;
20
+ portfolio: string;
21
+ status: string;
22
+ submittedAt: string | null;
23
+ createdAt: string;
24
+ updatedAt: string;
25
+ }
26
+ export interface TradeSheet {
27
+ uuid: string;
28
+ portfolio: string;
29
+ target_sheet: string;
30
+ created_at: string;
31
+ updated_at: string;
32
+ }
33
+ export interface Trade {
34
+ uuid: string;
35
+ tradesheet: string;
36
+ targetTrade: string | null;
37
+ instrument: string;
38
+ instrumentSymbol: string;
39
+ instrumentName: string;
40
+ quantity: number;
41
+ action: TradeAction;
42
+ executedPrice: string;
43
+ executedDate: string;
44
+ status: string;
45
+ settlementDate: string | null;
46
+ currency: string | null;
47
+ createdAt: string;
48
+ updatedAt: string;
49
+ }
50
+ export interface TargetTradePayload {
51
+ targetTradesheet: string;
52
+ instrument: string;
53
+ quantity: number;
54
+ action: TradeAction;
55
+ targetPrice: string | number;
56
+ }
57
+ export interface TargetTradeSheetPayload {
58
+ portfolio: string;
59
+ }
60
+ export interface TargetTradeSheetApprovalResponse {
61
+ uuid: string;
62
+ status: string;
63
+ approvedAt: string;
64
+ approvedTradesCount: number;
65
+ message?: string;
66
+ }
67
+ export interface TargetTradeSheetCleanResponse {
68
+ uuid: string;
69
+ status: string;
70
+ deletedTradesCount: number;
71
+ message?: string;
72
+ }
4
73
  //# sourceMappingURL=trade.d.ts.map
package/dist/trade.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"trade.d.ts","sourceRoot":"","sources":["../src/trade.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,MAAM,CAAC;AAGzC,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;AAGhF,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,CAAC"}
1
+ {"version":3,"file":"trade.d.ts","sourceRoot":"","sources":["../src/trade.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,MAAM,CAAC;AAGzC,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;AAGhF,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,CAAC;AAGrG,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAGD,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9B;AAGD,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,gCAAgC;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cranberry-money/shared-types",
3
- "version": "4.22.0",
3
+ "version": "4.24.0",
4
4
  "description": "Shared TypeScript type definitions for MyPortfolio platform",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",