@open-captable-protocol/canton 0.2.188 → 0.2.190

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 (172) hide show
  1. package/dist/OcpClient.d.ts +17 -17
  2. package/dist/OcpClient.d.ts.map +1 -1
  3. package/dist/OcpClient.js +16 -16
  4. package/dist/OcpClient.js.map +1 -1
  5. package/dist/functions/OpenCapTable/capTable/ocfToDaml.d.ts +7 -2
  6. package/dist/functions/OpenCapTable/capTable/ocfToDaml.d.ts.map +1 -1
  7. package/dist/functions/OpenCapTable/capTable/ocfToDaml.js +72 -56
  8. package/dist/functions/OpenCapTable/capTable/ocfToDaml.js.map +1 -1
  9. package/dist/functions/OpenCapTable/convertibleCancellation/{getConvertibleCancellationEventAsOcf.d.ts → getConvertibleCancellationAsOcf.d.ts} +4 -4
  10. package/dist/functions/OpenCapTable/convertibleCancellation/getConvertibleCancellationAsOcf.d.ts.map +1 -0
  11. package/dist/functions/OpenCapTable/convertibleCancellation/{getConvertibleCancellationEventAsOcf.js → getConvertibleCancellationAsOcf.js} +3 -3
  12. package/dist/functions/OpenCapTable/convertibleCancellation/getConvertibleCancellationAsOcf.js.map +1 -0
  13. package/dist/functions/OpenCapTable/convertibleCancellation/index.d.ts +1 -1
  14. package/dist/functions/OpenCapTable/convertibleCancellation/index.d.ts.map +1 -1
  15. package/dist/functions/OpenCapTable/convertibleCancellation/index.js +1 -1
  16. package/dist/functions/OpenCapTable/convertibleCancellation/index.js.map +1 -1
  17. package/dist/functions/OpenCapTable/convertibleConversion/{getConvertibleConversionEventAsOcf.d.ts → getConvertibleConversionAsOcf.d.ts} +4 -4
  18. package/dist/functions/OpenCapTable/convertibleConversion/getConvertibleConversionAsOcf.d.ts.map +1 -0
  19. package/dist/functions/OpenCapTable/convertibleConversion/{getConvertibleConversionEventAsOcf.js → getConvertibleConversionAsOcf.js} +3 -3
  20. package/dist/functions/OpenCapTable/convertibleConversion/getConvertibleConversionAsOcf.js.map +1 -0
  21. package/dist/functions/OpenCapTable/convertibleConversion/index.d.ts +1 -1
  22. package/dist/functions/OpenCapTable/convertibleConversion/index.d.ts.map +1 -1
  23. package/dist/functions/OpenCapTable/convertibleConversion/index.js +1 -1
  24. package/dist/functions/OpenCapTable/convertibleConversion/index.js.map +1 -1
  25. package/dist/functions/OpenCapTable/equityCompensationCancellation/{getEquityCompensationCancellationEventAsOcf.d.ts → getEquityCompensationCancellationAsOcf.d.ts} +4 -4
  26. package/dist/functions/OpenCapTable/equityCompensationCancellation/getEquityCompensationCancellationAsOcf.d.ts.map +1 -0
  27. package/dist/functions/OpenCapTable/equityCompensationCancellation/{getEquityCompensationCancellationEventAsOcf.js → getEquityCompensationCancellationAsOcf.js} +3 -3
  28. package/dist/functions/OpenCapTable/equityCompensationCancellation/getEquityCompensationCancellationAsOcf.js.map +1 -0
  29. package/dist/functions/OpenCapTable/equityCompensationCancellation/index.d.ts +1 -1
  30. package/dist/functions/OpenCapTable/equityCompensationCancellation/index.d.ts.map +1 -1
  31. package/dist/functions/OpenCapTable/equityCompensationCancellation/index.js +1 -1
  32. package/dist/functions/OpenCapTable/equityCompensationCancellation/index.js.map +1 -1
  33. package/dist/functions/OpenCapTable/equityCompensationExercise/{getEquityCompensationExerciseEventAsOcf.d.ts → getEquityCompensationExerciseAsOcf.d.ts} +4 -4
  34. package/dist/functions/OpenCapTable/equityCompensationExercise/getEquityCompensationExerciseAsOcf.d.ts.map +1 -0
  35. package/dist/functions/OpenCapTable/equityCompensationExercise/{getEquityCompensationExerciseEventAsOcf.js → getEquityCompensationExerciseAsOcf.js} +3 -3
  36. package/dist/functions/OpenCapTable/equityCompensationExercise/getEquityCompensationExerciseAsOcf.js.map +1 -0
  37. package/dist/functions/OpenCapTable/equityCompensationExercise/index.d.ts +1 -1
  38. package/dist/functions/OpenCapTable/equityCompensationExercise/index.d.ts.map +1 -1
  39. package/dist/functions/OpenCapTable/equityCompensationExercise/index.js +1 -1
  40. package/dist/functions/OpenCapTable/equityCompensationExercise/index.js.map +1 -1
  41. package/dist/functions/OpenCapTable/equityCompensationIssuance/{getEquityCompensationIssuanceEventAsOcf.d.ts → getEquityCompensationIssuanceAsOcf.d.ts} +4 -4
  42. package/dist/functions/OpenCapTable/equityCompensationIssuance/getEquityCompensationIssuanceAsOcf.d.ts.map +1 -0
  43. package/dist/functions/OpenCapTable/equityCompensationIssuance/{getEquityCompensationIssuanceEventAsOcf.js → getEquityCompensationIssuanceAsOcf.js} +3 -3
  44. package/dist/functions/OpenCapTable/equityCompensationIssuance/getEquityCompensationIssuanceAsOcf.js.map +1 -0
  45. package/dist/functions/OpenCapTable/equityCompensationIssuance/index.d.ts +1 -1
  46. package/dist/functions/OpenCapTable/equityCompensationIssuance/index.d.ts.map +1 -1
  47. package/dist/functions/OpenCapTable/equityCompensationIssuance/index.js +1 -1
  48. package/dist/functions/OpenCapTable/equityCompensationIssuance/index.js.map +1 -1
  49. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/{getIssuerAuthorizedSharesAdjustmentEventAsOcf.d.ts → getIssuerAuthorizedSharesAdjustmentAsOcf.d.ts} +4 -4
  50. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentAsOcf.d.ts.map +1 -0
  51. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/{getIssuerAuthorizedSharesAdjustmentEventAsOcf.js → getIssuerAuthorizedSharesAdjustmentAsOcf.js} +3 -3
  52. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentAsOcf.js.map +1 -0
  53. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/index.d.ts +1 -1
  54. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/index.d.ts.map +1 -1
  55. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/index.js +1 -1
  56. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/index.js.map +1 -1
  57. package/dist/functions/OpenCapTable/stockCancellation/{getStockCancellationEventAsOcf.d.ts → getStockCancellationAsOcf.d.ts} +4 -4
  58. package/dist/functions/OpenCapTable/stockCancellation/getStockCancellationAsOcf.d.ts.map +1 -0
  59. package/dist/functions/OpenCapTable/stockCancellation/{getStockCancellationEventAsOcf.js → getStockCancellationAsOcf.js} +3 -3
  60. package/dist/functions/OpenCapTable/{equityCompensationCancellation/getEquityCompensationCancellationEventAsOcf.js.map → stockCancellation/getStockCancellationAsOcf.js.map} +1 -1
  61. package/dist/functions/OpenCapTable/stockCancellation/index.d.ts +1 -1
  62. package/dist/functions/OpenCapTable/stockCancellation/index.d.ts.map +1 -1
  63. package/dist/functions/OpenCapTable/stockCancellation/index.js +1 -1
  64. package/dist/functions/OpenCapTable/stockCancellation/index.js.map +1 -1
  65. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/{getStockClassAuthorizedSharesAdjustmentEventAsOcf.d.ts → getStockClassAuthorizedSharesAdjustmentAsOcf.d.ts} +4 -4
  66. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentAsOcf.d.ts.map +1 -0
  67. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/{getStockClassAuthorizedSharesAdjustmentEventAsOcf.js → getStockClassAuthorizedSharesAdjustmentAsOcf.js} +3 -3
  68. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentAsOcf.js.map +1 -0
  69. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/index.d.ts +1 -1
  70. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/index.d.ts.map +1 -1
  71. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/index.js +1 -1
  72. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/index.js.map +1 -1
  73. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/{getStockClassConversionRatioAdjustmentEventAsOcf.d.ts → getStockClassConversionRatioAdjustmentAsOcf.d.ts} +4 -4
  74. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/getStockClassConversionRatioAdjustmentAsOcf.d.ts.map +1 -0
  75. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/{getStockClassConversionRatioAdjustmentEventAsOcf.js → getStockClassConversionRatioAdjustmentAsOcf.js} +3 -3
  76. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/getStockClassConversionRatioAdjustmentAsOcf.js.map +1 -0
  77. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/index.d.ts +1 -1
  78. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/index.d.ts.map +1 -1
  79. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/index.js +1 -1
  80. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/index.js.map +1 -1
  81. package/dist/functions/OpenCapTable/stockClassSplit/{getStockClassSplitEventAsOcf.d.ts → getStockClassSplitAsOcf.d.ts} +4 -4
  82. package/dist/functions/OpenCapTable/stockClassSplit/getStockClassSplitAsOcf.d.ts.map +1 -0
  83. package/dist/functions/OpenCapTable/stockClassSplit/{getStockClassSplitEventAsOcf.js → getStockClassSplitAsOcf.js} +3 -3
  84. package/dist/functions/OpenCapTable/stockClassSplit/getStockClassSplitAsOcf.js.map +1 -0
  85. package/dist/functions/OpenCapTable/stockClassSplit/index.d.ts +1 -1
  86. package/dist/functions/OpenCapTable/stockClassSplit/index.d.ts.map +1 -1
  87. package/dist/functions/OpenCapTable/stockClassSplit/index.js +1 -1
  88. package/dist/functions/OpenCapTable/stockClassSplit/index.js.map +1 -1
  89. package/dist/functions/OpenCapTable/stockConsolidation/{getStockConsolidationEventAsOcf.d.ts → getStockConsolidationAsOcf.d.ts} +4 -4
  90. package/dist/functions/OpenCapTable/stockConsolidation/getStockConsolidationAsOcf.d.ts.map +1 -0
  91. package/dist/functions/OpenCapTable/stockConsolidation/{getStockConsolidationEventAsOcf.js → getStockConsolidationAsOcf.js} +3 -3
  92. package/dist/functions/OpenCapTable/stockConsolidation/getStockConsolidationAsOcf.js.map +1 -0
  93. package/dist/functions/OpenCapTable/stockConsolidation/index.d.ts +1 -1
  94. package/dist/functions/OpenCapTable/stockConsolidation/index.d.ts.map +1 -1
  95. package/dist/functions/OpenCapTable/stockConsolidation/index.js +1 -1
  96. package/dist/functions/OpenCapTable/stockConsolidation/index.js.map +1 -1
  97. package/dist/functions/OpenCapTable/stockConversion/{getStockConversionEventAsOcf.d.ts → getStockConversionAsOcf.d.ts} +4 -4
  98. package/dist/functions/OpenCapTable/stockConversion/getStockConversionAsOcf.d.ts.map +1 -0
  99. package/dist/functions/OpenCapTable/stockConversion/{getStockConversionEventAsOcf.js → getStockConversionAsOcf.js} +3 -3
  100. package/dist/functions/OpenCapTable/stockConversion/getStockConversionAsOcf.js.map +1 -0
  101. package/dist/functions/OpenCapTable/stockConversion/index.d.ts +1 -1
  102. package/dist/functions/OpenCapTable/stockConversion/index.d.ts.map +1 -1
  103. package/dist/functions/OpenCapTable/stockConversion/index.js +1 -1
  104. package/dist/functions/OpenCapTable/stockConversion/index.js.map +1 -1
  105. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/{getStockPlanPoolAdjustmentEventAsOcf.d.ts → getStockPlanPoolAdjustmentAsOcf.d.ts} +4 -4
  106. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentAsOcf.d.ts.map +1 -0
  107. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/{getStockPlanPoolAdjustmentEventAsOcf.js → getStockPlanPoolAdjustmentAsOcf.js} +3 -3
  108. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentAsOcf.js.map +1 -0
  109. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/index.d.ts +1 -1
  110. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/index.d.ts.map +1 -1
  111. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/index.js +1 -1
  112. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/index.js.map +1 -1
  113. package/dist/functions/OpenCapTable/stockReissuance/{getStockReissuanceEventAsOcf.d.ts → getStockReissuanceAsOcf.d.ts} +4 -4
  114. package/dist/functions/OpenCapTable/stockReissuance/getStockReissuanceAsOcf.d.ts.map +1 -0
  115. package/dist/functions/OpenCapTable/stockReissuance/{getStockReissuanceEventAsOcf.js → getStockReissuanceAsOcf.js} +3 -3
  116. package/dist/functions/OpenCapTable/stockReissuance/getStockReissuanceAsOcf.js.map +1 -0
  117. package/dist/functions/OpenCapTable/stockReissuance/index.d.ts +1 -1
  118. package/dist/functions/OpenCapTable/stockReissuance/index.d.ts.map +1 -1
  119. package/dist/functions/OpenCapTable/stockReissuance/index.js +1 -1
  120. package/dist/functions/OpenCapTable/stockReissuance/index.js.map +1 -1
  121. package/dist/functions/OpenCapTable/warrantCancellation/{getWarrantCancellationEventAsOcf.d.ts → getWarrantCancellationAsOcf.d.ts} +4 -4
  122. package/dist/functions/OpenCapTable/warrantCancellation/getWarrantCancellationAsOcf.d.ts.map +1 -0
  123. package/dist/functions/OpenCapTable/warrantCancellation/{getWarrantCancellationEventAsOcf.js → getWarrantCancellationAsOcf.js} +3 -3
  124. package/dist/functions/OpenCapTable/warrantCancellation/getWarrantCancellationAsOcf.js.map +1 -0
  125. package/dist/functions/OpenCapTable/warrantCancellation/index.d.ts +1 -1
  126. package/dist/functions/OpenCapTable/warrantCancellation/index.d.ts.map +1 -1
  127. package/dist/functions/OpenCapTable/warrantCancellation/index.js +1 -1
  128. package/dist/functions/OpenCapTable/warrantCancellation/index.js.map +1 -1
  129. package/dist/functions/OpenCapTable/warrantExercise/{getWarrantExerciseEventAsOcf.d.ts → getWarrantExerciseAsOcf.d.ts} +4 -4
  130. package/dist/functions/OpenCapTable/warrantExercise/getWarrantExerciseAsOcf.d.ts.map +1 -0
  131. package/dist/functions/OpenCapTable/warrantExercise/{getWarrantExerciseEventAsOcf.js → getWarrantExerciseAsOcf.js} +3 -3
  132. package/dist/functions/OpenCapTable/warrantExercise/getWarrantExerciseAsOcf.js.map +1 -0
  133. package/dist/functions/OpenCapTable/warrantExercise/index.d.ts +1 -1
  134. package/dist/functions/OpenCapTable/warrantExercise/index.d.ts.map +1 -1
  135. package/dist/functions/OpenCapTable/warrantExercise/index.js +1 -1
  136. package/dist/functions/OpenCapTable/warrantExercise/index.js.map +1 -1
  137. package/dist/utils/deprecatedFieldNormalization.d.ts +395 -0
  138. package/dist/utils/deprecatedFieldNormalization.d.ts.map +1 -1
  139. package/dist/utils/deprecatedFieldNormalization.js +583 -0
  140. package/dist/utils/deprecatedFieldNormalization.js.map +1 -1
  141. package/package.json +1 -1
  142. package/dist/functions/OpenCapTable/convertibleCancellation/getConvertibleCancellationEventAsOcf.d.ts.map +0 -1
  143. package/dist/functions/OpenCapTable/convertibleCancellation/getConvertibleCancellationEventAsOcf.js.map +0 -1
  144. package/dist/functions/OpenCapTable/convertibleConversion/getConvertibleConversionEventAsOcf.d.ts.map +0 -1
  145. package/dist/functions/OpenCapTable/convertibleConversion/getConvertibleConversionEventAsOcf.js.map +0 -1
  146. package/dist/functions/OpenCapTable/equityCompensationCancellation/getEquityCompensationCancellationEventAsOcf.d.ts.map +0 -1
  147. package/dist/functions/OpenCapTable/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.d.ts.map +0 -1
  148. package/dist/functions/OpenCapTable/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.js.map +0 -1
  149. package/dist/functions/OpenCapTable/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.d.ts.map +0 -1
  150. package/dist/functions/OpenCapTable/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.js.map +0 -1
  151. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.d.ts.map +0 -1
  152. package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.js.map +0 -1
  153. package/dist/functions/OpenCapTable/stockCancellation/getStockCancellationEventAsOcf.d.ts.map +0 -1
  154. package/dist/functions/OpenCapTable/stockCancellation/getStockCancellationEventAsOcf.js.map +0 -1
  155. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.d.ts.map +0 -1
  156. package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.js.map +0 -1
  157. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/getStockClassConversionRatioAdjustmentEventAsOcf.d.ts.map +0 -1
  158. package/dist/functions/OpenCapTable/stockClassConversionRatioAdjustment/getStockClassConversionRatioAdjustmentEventAsOcf.js.map +0 -1
  159. package/dist/functions/OpenCapTable/stockClassSplit/getStockClassSplitEventAsOcf.d.ts.map +0 -1
  160. package/dist/functions/OpenCapTable/stockClassSplit/getStockClassSplitEventAsOcf.js.map +0 -1
  161. package/dist/functions/OpenCapTable/stockConsolidation/getStockConsolidationEventAsOcf.d.ts.map +0 -1
  162. package/dist/functions/OpenCapTable/stockConsolidation/getStockConsolidationEventAsOcf.js.map +0 -1
  163. package/dist/functions/OpenCapTable/stockConversion/getStockConversionEventAsOcf.d.ts.map +0 -1
  164. package/dist/functions/OpenCapTable/stockConversion/getStockConversionEventAsOcf.js.map +0 -1
  165. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.d.ts.map +0 -1
  166. package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.js.map +0 -1
  167. package/dist/functions/OpenCapTable/stockReissuance/getStockReissuanceEventAsOcf.d.ts.map +0 -1
  168. package/dist/functions/OpenCapTable/stockReissuance/getStockReissuanceEventAsOcf.js.map +0 -1
  169. package/dist/functions/OpenCapTable/warrantCancellation/getWarrantCancellationEventAsOcf.d.ts.map +0 -1
  170. package/dist/functions/OpenCapTable/warrantCancellation/getWarrantCancellationEventAsOcf.js.map +0 -1
  171. package/dist/functions/OpenCapTable/warrantExercise/getWarrantExerciseEventAsOcf.d.ts.map +0 -1
  172. package/dist/functions/OpenCapTable/warrantExercise/getWarrantExerciseEventAsOcf.js.map +0 -1
@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./getWarrantCancellationEventAsOcf"), exports);
17
+ __exportStar(require("./getWarrantCancellationAsOcf"), exports);
18
18
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/warrantCancellation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qEAAmD"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/warrantCancellation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C"}
@@ -9,10 +9,10 @@ export interface OcfWarrantExerciseEvent extends Omit<OcfWarrantExercise, 'quant
9
9
  /** Quantity as string for OCF JSON serialization */
10
10
  quantity: string;
11
11
  }
12
- export interface GetWarrantExerciseEventAsOcfParams {
12
+ export interface GetWarrantExerciseAsOcfParams {
13
13
  contractId: string;
14
14
  }
15
- export interface GetWarrantExerciseEventAsOcfResult {
15
+ export interface GetWarrantExerciseAsOcfResult {
16
16
  event: OcfWarrantExerciseEvent;
17
17
  contractId: string;
18
18
  }
@@ -20,5 +20,5 @@ export interface GetWarrantExerciseEventAsOcfResult {
20
20
  * Read a WarrantExercise contract and return a generic OCF WarrantExercise object. Schema:
21
21
  * https://schema.opencaptablecoalition.com/v/1.2.0/objects/transactions/exercise/WarrantExercise.schema.json
22
22
  */
23
- export declare function getWarrantExerciseEventAsOcf(client: LedgerJsonApiClient, params: GetWarrantExerciseEventAsOcfParams): Promise<GetWarrantExerciseEventAsOcfResult>;
24
- //# sourceMappingURL=getWarrantExerciseEventAsOcf.d.ts.map
23
+ export declare function getWarrantExerciseAsOcf(client: LedgerJsonApiClient, params: GetWarrantExerciseAsOcfParams): Promise<GetWarrantExerciseAsOcfResult>;
24
+ //# sourceMappingURL=getWarrantExerciseAsOcf.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getWarrantExerciseAsOcf.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/warrantExercise/getWarrantExerciseAsOcf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAErE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAGhE;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,IAAI,CAAC,kBAAkB,EAAE,UAAU,CAAC;IACnF,WAAW,EAAE,qBAAqB,CAAC;IACnC,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C,KAAK,EAAE,uBAAuB,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,6BAA6B,GACpC,OAAO,CAAC,6BAA6B,CAAC,CAiDxC"}
@@ -1,13 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getWarrantExerciseEventAsOcf = getWarrantExerciseEventAsOcf;
3
+ exports.getWarrantExerciseAsOcf = getWarrantExerciseAsOcf;
4
4
  const errors_1 = require("../../../errors");
5
5
  const typeConversions_1 = require("../../../utils/typeConversions");
6
6
  /**
7
7
  * Read a WarrantExercise contract and return a generic OCF WarrantExercise object. Schema:
8
8
  * https://schema.opencaptablecoalition.com/v/1.2.0/objects/transactions/exercise/WarrantExercise.schema.json
9
9
  */
10
- async function getWarrantExerciseEventAsOcf(client, params) {
10
+ async function getWarrantExerciseAsOcf(client, params) {
11
11
  const eventsResponse = await client.getEventsByContractId({ contractId: params.contractId });
12
12
  if (!eventsResponse.created?.createdEvent.createArgument) {
13
13
  throw new errors_1.OcpContractError('Invalid contract events response: missing created event or create argument', {
@@ -51,4 +51,4 @@ async function getWarrantExerciseEventAsOcf(client, params) {
51
51
  };
52
52
  return { event, contractId: params.contractId };
53
53
  }
54
- //# sourceMappingURL=getWarrantExerciseEventAsOcf.js.map
54
+ //# sourceMappingURL=getWarrantExerciseAsOcf.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getWarrantExerciseAsOcf.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/warrantExercise/getWarrantExerciseAsOcf.ts"],"names":[],"mappings":";;AA4BA,0DAoDC;AA/ED,4CAAsF;AAEtF,oEAAwE;AAqBxE;;;GAGG;AACI,KAAK,UAAU,uBAAuB,CAC3C,MAA2B,EAC3B,MAAqC;IAErC,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,qBAAqB,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC7F,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,cAAc,EAAE,CAAC;QACzD,MAAM,IAAI,yBAAgB,CAAC,4EAA4E,EAAE;YACvG,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,IAAI,EAAE,sBAAa,CAAC,gBAAgB;SACrC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,cAAyC,CAAC;IAErG,+DAA+D;IAC/D,MAAM,CAAC,GACJ,cAAc,CAAC,aAAqD,IAAI,cAAc,CAAC;IAE1F,oBAAoB;IACpB,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QACpD,MAAM,IAAI,2BAAkB,CAAC,0BAA0B,EAAE,2BAA2B,EAAE;YACpF,IAAI,EAAE,sBAAa,CAAC,sBAAsB;SAC3C,CAAC,CAAC;IACL,CAAC;IACD,IAAI,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACrE,MAAM,IAAI,2BAAkB,CAAC,0BAA0B,EAAE,iCAAiC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC7G,IAAI,EAAE,sBAAa,CAAC,YAAY;YAChC,YAAY,EAAE,iBAAiB;YAC/B,aAAa,EAAE,CAAC,CAAC,QAAQ;SAC1B,CAAC,CAAC;IACL,CAAC;IAED,kCAAkC;IAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,sBAAsB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtF,MAAM,IAAI,2BAAkB,CAAC,wCAAwC,EAAE,0CAA0C,EAAE;YACjH,IAAI,EAAE,sBAAa,CAAC,sBAAsB;YAC1C,aAAa,EAAE,CAAC,CAAC,sBAAsB;SACxC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAA4B;QACrC,WAAW,EAAE,qBAAqB;QAClC,EAAE,EAAE,CAAC,CAAC,EAAY;QAClB,IAAI,EAAG,CAAC,CAAC,IAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACtC,WAAW,EAAE,CAAC,CAAC,WAAqB;QACpC,QAAQ,EAAE,IAAA,wCAAsB,EAAC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACrG,sBAAsB,EAAE,CAAC,CAAC,sBAAkC;QAC5D,GAAG,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC,mBAA6B,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1F,GAAG,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC,kBAA4B,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvF,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAoB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChG,CAAC;IAEF,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC;AAClD,CAAC"}
@@ -1,2 +1,2 @@
1
- export * from './getWarrantExerciseEventAsOcf';
1
+ export * from './getWarrantExerciseAsOcf';
2
2
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/warrantExercise/index.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/warrantExercise/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}
@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./getWarrantExerciseEventAsOcf"), exports);
17
+ __exportStar(require("./getWarrantExerciseAsOcf"), exports);
18
18
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/warrantExercise/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iEAA+C"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/warrantExercise/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C"}
@@ -216,4 +216,399 @@ export declare function getFieldDeprecation(objectType: string, fieldName: strin
216
216
  * ```
217
217
  */
218
218
  export declare function checkDeprecatedFields(objectType: string, data: Record<string, unknown>): DeprecatedFieldUsageResult;
219
+ /**
220
+ * Item with an identifier for tracking in batch operations.
221
+ */
222
+ export interface IdentifiableItem {
223
+ /** Unique identifier for the item */
224
+ id?: string;
225
+ /** Index in the original array (for items without id) */
226
+ index?: number;
227
+ }
228
+ /**
229
+ * Result of checking a single object in a batch operation.
230
+ */
231
+ export interface BatchItemResult extends DeprecatedFieldUsageResult {
232
+ /** Identifier for the item (id or index-based) */
233
+ itemId: string;
234
+ /** The object type that was checked */
235
+ objectType: string;
236
+ }
237
+ /**
238
+ * Aggregated result of checking multiple objects for deprecated field usage.
239
+ */
240
+ export interface BatchDeprecatedFieldsResult {
241
+ /** Total number of objects checked */
242
+ totalChecked: number;
243
+ /** Number of objects with deprecated fields */
244
+ objectsWithDeprecatedFields: number;
245
+ /** Number of objects without deprecated fields */
246
+ objectsWithoutDeprecatedFields: number;
247
+ /** Whether any deprecated fields were found */
248
+ hasDeprecatedFields: boolean;
249
+ /** Per-item results for objects that have deprecated fields */
250
+ itemsWithDeprecatedFields: BatchItemResult[];
251
+ /** Summary of deprecated field usage by field name */
252
+ deprecatedFieldSummary: Record<string, number>;
253
+ /** Summary of deprecated field usage by object type */
254
+ objectTypeSummary: Record<string, {
255
+ total: number;
256
+ withDeprecated: number;
257
+ }>;
258
+ }
259
+ /**
260
+ * Input item for batch verification.
261
+ */
262
+ export interface BatchVerificationItem {
263
+ /** The OCF object type (e.g., 'StockPlan') */
264
+ objectType: string;
265
+ /** The data to check */
266
+ data: Record<string, unknown>;
267
+ /** Optional identifier for the item */
268
+ id?: string;
269
+ }
270
+ /**
271
+ * Check multiple objects for deprecated field usage in a single batch operation.
272
+ *
273
+ * @param items - Array of items to check, each with objectType and data
274
+ * @returns Aggregated result with summary statistics and per-item details
275
+ *
276
+ * @example
277
+ * ```typescript
278
+ * const result = checkDeprecatedFieldsBatch([
279
+ * { objectType: 'StockPlan', data: { stock_class_id: 'sc-1', plan_name: 'Plan A' }, id: 'plan-1' },
280
+ * { objectType: 'StockPlan', data: { stock_class_ids: ['sc-2'], plan_name: 'Plan B' }, id: 'plan-2' },
281
+ * ]);
282
+ * // result.objectsWithDeprecatedFields === 1
283
+ * // result.deprecatedFieldSummary === { stock_class_id: 1 }
284
+ * ```
285
+ */
286
+ export declare function checkDeprecatedFieldsBatch(items: BatchVerificationItem[]): BatchDeprecatedFieldsResult;
287
+ /**
288
+ * Check an array of objects of the same type for deprecated field usage.
289
+ *
290
+ * @param objectType - The OCF object type for all items
291
+ * @param items - Array of data objects to check
292
+ * @returns Aggregated result with summary statistics
293
+ *
294
+ * @example
295
+ * ```typescript
296
+ * const stockPlans = [
297
+ * { id: 'plan-1', stock_class_id: 'sc-1', plan_name: 'Plan A' },
298
+ * { id: 'plan-2', stock_class_ids: ['sc-2'], plan_name: 'Plan B' },
299
+ * ];
300
+ * const result = checkDeprecatedFieldsForType('StockPlan', stockPlans);
301
+ * ```
302
+ */
303
+ export declare function checkDeprecatedFieldsForType(objectType: string, items: Array<Record<string, unknown>>): BatchDeprecatedFieldsResult;
304
+ /**
305
+ * Result of migrating deprecated fields in an object.
306
+ */
307
+ export interface MigrationResult<T> {
308
+ /** The migrated data with deprecated fields converted to current format */
309
+ data: T;
310
+ /** Whether any migrations were performed */
311
+ migrated: boolean;
312
+ /** List of fields that were migrated */
313
+ migratedFields: string[];
314
+ /** List of warnings (e.g., both deprecated and current fields present) */
315
+ warnings: string[];
316
+ }
317
+ /**
318
+ * Migrate deprecated stock plan fields to their current equivalents.
319
+ *
320
+ * This function creates a new object with deprecated fields converted to current format.
321
+ * The original object is not modified.
322
+ *
323
+ * @param data - Stock plan data that may contain deprecated fields
324
+ * @returns Migration result with normalized data and migration details
325
+ *
326
+ * @example
327
+ * ```typescript
328
+ * const result = migrateStockPlanFields({
329
+ * id: 'plan-1',
330
+ * stock_class_id: 'sc-1', // deprecated
331
+ * plan_name: 'Equity Plan',
332
+ * });
333
+ * // result.data.stock_class_ids === ['sc-1']
334
+ * // result.migrated === true
335
+ * // result.migratedFields === ['stock_class_id']
336
+ * ```
337
+ */
338
+ export declare function migrateStockPlanFields<T extends StockPlanDataWithDeprecatedField>(data: T): MigrationResult<Omit<T, 'stock_class_id'> & {
339
+ stock_class_ids: string[];
340
+ }>;
341
+ /**
342
+ * Batch result for migrating multiple objects.
343
+ */
344
+ export interface BatchMigrationResult<T> {
345
+ /** Migrated items */
346
+ items: Array<MigrationResult<T>>;
347
+ /** Total number of items processed */
348
+ totalProcessed: number;
349
+ /** Number of items that required migration */
350
+ itemsMigrated: number;
351
+ /** Number of items with warnings */
352
+ itemsWithWarnings: number;
353
+ /** Summary of migrated fields */
354
+ migratedFieldsSummary: Record<string, number>;
355
+ }
356
+ /**
357
+ * Migrate deprecated fields in multiple stock plan objects.
358
+ *
359
+ * @param items - Array of stock plan data objects
360
+ * @returns Batch migration result with all migrated items
361
+ *
362
+ * @example
363
+ * ```typescript
364
+ * const plans = [
365
+ * { id: 'plan-1', stock_class_id: 'sc-1' },
366
+ * { id: 'plan-2', stock_class_ids: ['sc-2'] },
367
+ * ];
368
+ * const result = migrateStockPlanFieldsBatch(plans);
369
+ * // result.itemsMigrated === 1
370
+ * ```
371
+ */
372
+ export declare function migrateStockPlanFieldsBatch<T extends StockPlanDataWithDeprecatedField>(items: T[]): BatchMigrationResult<Omit<T, 'stock_class_id'> & {
373
+ stock_class_ids: string[];
374
+ }>;
375
+ /**
376
+ * Detailed deprecation report for analysis and documentation.
377
+ */
378
+ export interface DeprecationReport {
379
+ /** Timestamp when the report was generated */
380
+ generatedAt: string;
381
+ /** Summary statistics */
382
+ summary: {
383
+ /** Total objects analyzed */
384
+ totalObjects: number;
385
+ /** Objects with deprecated fields */
386
+ objectsWithDeprecatedFields: number;
387
+ /** Percentage of objects with deprecated fields */
388
+ deprecationPercentage: number;
389
+ /** Total deprecated field usages */
390
+ totalDeprecatedFieldUsages: number;
391
+ };
392
+ /** Breakdown by object type */
393
+ byObjectType: Record<string, {
394
+ total: number;
395
+ withDeprecatedFields: number;
396
+ deprecationPercentage: number;
397
+ fieldsUsed: Record<string, number>;
398
+ }>;
399
+ /** Breakdown by deprecated field */
400
+ byField: Record<string, {
401
+ totalUsages: number;
402
+ objectTypesAffected: string[];
403
+ replacementField: string;
404
+ deprecationType: string;
405
+ }>;
406
+ /** List of all affected items (optional, for detailed reports) */
407
+ affectedItems?: Array<{
408
+ itemId: string;
409
+ objectType: string;
410
+ deprecatedFieldsUsed: string[];
411
+ }>;
412
+ }
413
+ /**
414
+ * Options for generating a deprecation report.
415
+ */
416
+ export interface DeprecationReportOptions {
417
+ /** Whether to include detailed list of affected items (default: false for large datasets) */
418
+ includeAffectedItems?: boolean;
419
+ /** Maximum number of affected items to include (default: 100) */
420
+ maxAffectedItems?: number;
421
+ }
422
+ /**
423
+ * Generate a detailed deprecation report from batch verification results.
424
+ *
425
+ * @param batchResult - Result from checkDeprecatedFieldsBatch or checkDeprecatedFieldsForType
426
+ * @param options - Options for report generation
427
+ * @returns Detailed deprecation report
428
+ *
429
+ * @example
430
+ * ```typescript
431
+ * const items = [
432
+ * { objectType: 'StockPlan', data: { stock_class_id: 'sc-1' }, id: 'plan-1' },
433
+ * ];
434
+ * const batchResult = checkDeprecatedFieldsBatch(items);
435
+ * const report = generateDeprecationReport(batchResult);
436
+ * console.log(`${report.summary.deprecationPercentage}% of objects use deprecated fields`);
437
+ * ```
438
+ */
439
+ export declare function generateDeprecationReport(batchResult: BatchDeprecatedFieldsResult, options?: DeprecationReportOptions): DeprecationReport;
440
+ /**
441
+ * Result of validating deprecated field usage.
442
+ */
443
+ export interface DeprecationValidationResult {
444
+ /** Whether validation passed (no deprecated fields, or within acceptable limits) */
445
+ valid: boolean;
446
+ /** Validation errors (if any) */
447
+ errors: string[];
448
+ /** Validation warnings (if any) */
449
+ warnings: string[];
450
+ /** The underlying check result */
451
+ checkResult: DeprecatedFieldUsageResult;
452
+ }
453
+ /**
454
+ * Options for deprecation validation.
455
+ */
456
+ export interface DeprecationValidationOptions {
457
+ /** Whether to treat deprecated field usage as an error (default: false, treated as warning) */
458
+ treatAsError?: boolean;
459
+ /** Specific deprecated fields to ignore in validation */
460
+ ignoreFields?: string[];
461
+ /** Custom error message prefix */
462
+ errorMessagePrefix?: string;
463
+ }
464
+ /**
465
+ * Validate an object for deprecated field usage.
466
+ *
467
+ * This is useful for validation pipelines where you want to:
468
+ * - Warn users about deprecated field usage
469
+ * - Optionally fail validation on deprecated fields
470
+ * - Generate clear validation messages
471
+ *
472
+ * @param objectType - The OCF object type
473
+ * @param data - The data to validate
474
+ * @param options - Validation options
475
+ * @returns Validation result
476
+ *
477
+ * @example
478
+ * ```typescript
479
+ * const result = validateDeprecatedFields('StockPlan', {
480
+ * stock_class_id: 'sc-1',
481
+ * }, { treatAsError: false });
482
+ *
483
+ * if (!result.valid) {
484
+ * console.error(result.errors.join('\n'));
485
+ * } else if (result.warnings.length > 0) {
486
+ * console.warn(result.warnings.join('\n'));
487
+ * }
488
+ * ```
489
+ */
490
+ export declare function validateDeprecatedFields(objectType: string, data: Record<string, unknown>, options?: DeprecationValidationOptions): DeprecationValidationResult;
491
+ /**
492
+ * Create a validator function for use in validation pipelines.
493
+ *
494
+ * @param objectType - The OCF object type to validate
495
+ * @param options - Validation options
496
+ * @returns A validator function that returns DeprecationValidationResult
497
+ *
498
+ * @example
499
+ * ```typescript
500
+ * const validateStockPlan = createDeprecatedFieldsValidator('StockPlan', {
501
+ * treatAsError: false,
502
+ * });
503
+ *
504
+ * // Use in a validation pipeline
505
+ * const result = validateStockPlan(stockPlanData);
506
+ * ```
507
+ */
508
+ export declare function createDeprecatedFieldsValidator(objectType: string, options?: DeprecationValidationOptions): (data: Record<string, unknown>) => DeprecationValidationResult;
509
+ /**
510
+ * Assert that an object does not use deprecated fields.
511
+ * Throws an error if deprecated fields are detected.
512
+ *
513
+ * @param objectType - The OCF object type
514
+ * @param data - The data to check
515
+ * @param options - Validation options (ignoreFields only)
516
+ * @throws Error if deprecated fields are detected
517
+ *
518
+ * @example
519
+ * ```typescript
520
+ * try {
521
+ * assertNoDeprecatedFields('StockPlan', stockPlanData);
522
+ * // Proceed with operation
523
+ * } catch (error) {
524
+ * // Handle deprecated field usage
525
+ * }
526
+ * ```
527
+ */
528
+ export declare function assertNoDeprecatedFields(objectType: string, data: Record<string, unknown>, options?: Pick<DeprecationValidationOptions, 'ignoreFields'>): void;
529
+ /**
530
+ * Register a new deprecated field mapping.
531
+ *
532
+ * This is useful for extending the built-in deprecation registry with
533
+ * custom or newly discovered deprecations.
534
+ *
535
+ * @param objectType - The OCF object type
536
+ * @param mapping - The deprecation mapping to register
537
+ *
538
+ * @example
539
+ * ```typescript
540
+ * // Register a new deprecation
541
+ * registerDeprecatedFieldMapping('SomeOcfType', {
542
+ * deprecatedField: 'old_field',
543
+ * replacementField: 'new_fields',
544
+ * deprecationType: 'singular_to_array',
545
+ * });
546
+ * ```
547
+ */
548
+ export declare function registerDeprecatedFieldMapping(objectType: string, mapping: DeprecatedFieldMapping): void;
549
+ /**
550
+ * Get all registered object types that have deprecated field mappings.
551
+ *
552
+ * @returns Array of object type names
553
+ */
554
+ export declare function getRegisteredObjectTypes(): string[];
555
+ /**
556
+ * Get all registered deprecated field mappings.
557
+ *
558
+ * @returns Copy of the deprecated fields registry
559
+ */
560
+ export declare function getAllDeprecatedFieldMappings(): Record<string, DeprecatedFieldMapping[]>;
561
+ /**
562
+ * Result of automatic OCF data normalization.
563
+ */
564
+ export interface NormalizedOcfDataResult<T> {
565
+ /** The normalized data with deprecated fields converted */
566
+ data: T;
567
+ /** Whether any normalization was performed */
568
+ normalized: boolean;
569
+ /** List of deprecated fields that were normalized */
570
+ normalizedFields: string[];
571
+ /** Warnings generated during normalization */
572
+ warnings: string[];
573
+ }
574
+ /**
575
+ * Automatically normalize deprecated fields in OCF data based on entity type.
576
+ *
577
+ * This function is designed to be called by the SDK internally when processing
578
+ * OCF data, making deprecated field handling transparent to end-users.
579
+ *
580
+ * @param entityType - The OCF entity type (e.g., 'stockPlan')
581
+ * @param data - The OCF data that may contain deprecated fields
582
+ * @param options - Optional configuration
583
+ * @returns The normalized data with deprecated fields converted to current format
584
+ *
585
+ * @example
586
+ * ```typescript
587
+ * // SDK automatically normalizes deprecated fields
588
+ * const result = normalizeDeprecatedOcfFields('stockPlan', {
589
+ * id: 'plan-1',
590
+ * stock_class_id: 'sc-1', // deprecated, automatically converted
591
+ * plan_name: 'Equity Plan',
592
+ * });
593
+ * // result.data.stock_class_ids === ['sc-1']
594
+ * ```
595
+ */
596
+ export declare function normalizeDeprecatedOcfFields<T extends Record<string, unknown>>(entityType: string, data: T, options?: {
597
+ emitWarnings?: boolean;
598
+ context?: string;
599
+ }): NormalizedOcfDataResult<T>;
600
+ /**
601
+ * Check if an entity type has registered deprecations.
602
+ *
603
+ * @param entityType - The OCF entity type (e.g., 'stockPlan')
604
+ * @returns true if the entity type has deprecation mappings
605
+ */
606
+ export declare function hasDeprecationsForEntityType(entityType: string): boolean;
607
+ /**
608
+ * Register a mapping from entity type to object type for automatic normalization.
609
+ *
610
+ * @param entityType - The OcfEntityType used in batch API (e.g., 'stockPlan')
611
+ * @param objectType - The object type name used in deprecation registry (e.g., 'StockPlan')
612
+ */
613
+ export declare function registerEntityTypeMapping(entityType: string, objectType: string): void;
219
614
  //# sourceMappingURL=deprecatedFieldNormalization.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"deprecatedFieldNormalization.d.ts","sourceRoot":"","sources":["../../src/utils/deprecatedFieldNormalization.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAIH;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,iGAAiG;IACjG,OAAO,EAAE,OAAO,CAAC;IACjB,qDAAqD;IACrD,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,KAAK,IAAI,CAAC;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mCAAmC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,eAAe,EAAE,OAAO,CAAC;IACzB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,wBAGtC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAexE;AAID;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,uDAAuD;IACvD,aAAa,EAAE,CAAC,GAAG,SAAS,CAAC;IAC7B,0DAA0D;IAC1D,UAAU,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC;IAC5B,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mDAAmD;IACnD,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EAAE,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAwBjF;AAID;;;;;GAKG;AACH,MAAM,WAAW,gCAAgC;IAC/C,2DAA2D;IAC3D,eAAe,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAClC,yFAAyF;IACzF,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0CAA0C;IAC1C,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,0CAA0C;IAC1C,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,kCAAkC,CAChD,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,MAAM,GACf,yBAAyB,CAyB3B;AAID;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,kDAAkD;IAClD,mBAAmB,EAAE,OAAO,CAAC;IAC7B,+CAA+C;IAC/C,oBAAoB,EAAE,MAAM,EAAE,CAAC;CAChC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,gCAAgC,GAAG,0BAA0B,CAYrH;AAID;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gCAAgC;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,iCAAiC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,iEAAiE;IACjE,eAAe,EAAE,mBAAmB,GAAG,SAAS,GAAG,SAAS,CAAC;CAC9D;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,CAQ1E,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAEvF;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAG7G;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,0BAA0B,CAgBnH"}
1
+ {"version":3,"file":"deprecatedFieldNormalization.d.ts","sourceRoot":"","sources":["../../src/utils/deprecatedFieldNormalization.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAIH;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,iGAAiG;IACjG,OAAO,EAAE,OAAO,CAAC;IACjB,qDAAqD;IACrD,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,KAAK,IAAI,CAAC;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mCAAmC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,eAAe,EAAE,OAAO,CAAC;IACzB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,wBAGtC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAexE;AAID;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,uDAAuD;IACvD,aAAa,EAAE,CAAC,GAAG,SAAS,CAAC;IAC7B,0DAA0D;IAC1D,UAAU,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC;IAC5B,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mDAAmD;IACnD,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EAAE,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAwBjF;AAID;;;;;GAKG;AACH,MAAM,WAAW,gCAAgC;IAC/C,2DAA2D;IAC3D,eAAe,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAClC,yFAAyF;IACzF,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0CAA0C;IAC1C,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,0CAA0C;IAC1C,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,kCAAkC,CAChD,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,MAAM,GACf,yBAAyB,CAyB3B;AAID;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,kDAAkD;IAClD,mBAAmB,EAAE,OAAO,CAAC;IAC7B,+CAA+C;IAC/C,oBAAoB,EAAE,MAAM,EAAE,CAAC;CAChC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,gCAAgC,GAAG,0BAA0B,CAYrH;AAID;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gCAAgC;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,iCAAiC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,iEAAiE;IACjE,eAAe,EAAE,mBAAmB,GAAG,SAAS,GAAG,SAAS,CAAC;CAC9D;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,CAQ1E,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAEvF;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAG7G;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,0BAA0B,CAgBnH;AAID;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qCAAqC;IACrC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,0BAA0B;IACjE,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,sCAAsC;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,2BAA2B,EAAE,MAAM,CAAC;IACpC,kDAAkD;IAClD,8BAA8B,EAAE,MAAM,CAAC;IACvC,+CAA+C;IAC/C,mBAAmB,EAAE,OAAO,CAAC;IAC7B,+DAA+D;IAC/D,yBAAyB,EAAE,eAAe,EAAE,CAAC;IAC7C,sDAAsD;IACtD,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/C,uDAAuD;IACvD,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC9E;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,uCAAuC;IACvC,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,2BAA2B,CAsCtG;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GACpC,2BAA2B,CAQ7B;AAID;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,2EAA2E;IAC3E,IAAI,EAAE,CAAC,CAAC;IACR,4CAA4C;IAC5C,QAAQ,EAAE,OAAO,CAAC;IAClB,wCAAwC;IACxC,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,gCAAgC,EAC/E,IAAI,EAAE,CAAC,GACN,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG;IAAE,eAAe,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAkC5E;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC;IACrC,qBAAqB;IACrB,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IACjC,sCAAsC;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iCAAiC;IACjC,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/C;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,2BAA2B,CAAC,CAAC,SAAS,gCAAgC,EACpF,KAAK,EAAE,CAAC,EAAE,GACT,oBAAoB,CAAC,IAAI,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG;IAAE,eAAe,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CA6BjF;AAID;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,8CAA8C;IAC9C,WAAW,EAAE,MAAM,CAAC;IACpB,yBAAyB;IACzB,OAAO,EAAE;QACP,6BAA6B;QAC7B,YAAY,EAAE,MAAM,CAAC;QACrB,qCAAqC;QACrC,2BAA2B,EAAE,MAAM,CAAC;QACpC,mDAAmD;QACnD,qBAAqB,EAAE,MAAM,CAAC;QAC9B,oCAAoC;QACpC,0BAA0B,EAAE,MAAM,CAAC;KACpC,CAAC;IACF,+BAA+B;IAC/B,YAAY,EAAE,MAAM,CAClB,MAAM,EACN;QACE,KAAK,EAAE,MAAM,CAAC;QACd,oBAAoB,EAAE,MAAM,CAAC;QAC7B,qBAAqB,EAAE,MAAM,CAAC;QAC9B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACpC,CACF,CAAC;IACF,oCAAoC;IACpC,OAAO,EAAE,MAAM,CACb,MAAM,EACN;QACE,WAAW,EAAE,MAAM,CAAC;QACpB,mBAAmB,EAAE,MAAM,EAAE,CAAC;QAC9B,gBAAgB,EAAE,MAAM,CAAC;QACzB,eAAe,EAAE,MAAM,CAAC;KACzB,CACF,CAAC;IACF,kEAAkE;IAClE,aAAa,CAAC,EAAE,KAAK,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,oBAAoB,EAAE,MAAM,EAAE,CAAC;KAChC,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,6FAA6F;IAC7F,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,iEAAiE;IACjE,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,yBAAyB,CACvC,WAAW,EAAE,2BAA2B,EACxC,OAAO,GAAE,wBAA6B,GACrC,iBAAiB,CA0FnB;AAID;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,oFAAoF;IACpF,KAAK,EAAE,OAAO,CAAC;IACf,iCAAiC;IACjC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mCAAmC;IACnC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,kCAAkC;IAClC,WAAW,EAAE,0BAA0B,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,+FAA+F;IAC/F,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,yDAAyD;IACzD,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,kCAAkC;IAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,GAAE,4BAAiC,GACzC,2BAA2B,CAkC7B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,4BAAiC,GACzC,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,2BAA2B,CAEhE;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,GAAE,IAAI,CAAC,4BAA4B,EAAE,cAAc,CAAM,GAC/D,IAAI,CASN;AAID;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,8BAA8B,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,GAAG,IAAI,CASxG;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,EAAE,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,IAAI,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,CAAC,CAOxF;AAaD;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,2DAA2D;IAC3D,IAAI,EAAE,CAAC,CAAC;IACR,8CAA8C;IAC9C,UAAU,EAAE,OAAO,CAAC;IACpB,qDAAqD;IACrD,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5E,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,CAAC,EACP,OAAO,GAAE;IAAE,YAAY,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAO,GACzD,uBAAuB,CAAC,CAAC,CAAC,CA8H5B;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAMxE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAEtF"}