@fairmint/open-captable-protocol-daml-js 0.2.9 → 0.2.11

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 (45) hide show
  1. package/README.md +65 -0
  2. package/generated/ocp-factory-contract-id.json +4 -4
  3. package/lib/Fairmint/OpenCapTable/ConvertibleIssuance/module.d.ts +41 -26
  4. package/lib/Fairmint/OpenCapTable/ConvertibleIssuance/module.js +46 -29
  5. package/lib/Fairmint/OpenCapTable/Document/module.d.ts +37 -37
  6. package/lib/Fairmint/OpenCapTable/Document/module.js +56 -56
  7. package/lib/Fairmint/OpenCapTable/EquityCompensationExercise/module.d.ts +17 -17
  8. package/lib/Fairmint/OpenCapTable/EquityCompensationExercise/module.js +20 -20
  9. package/lib/Fairmint/OpenCapTable/EquityCompensationIssuance/module.d.ts +31 -31
  10. package/lib/Fairmint/OpenCapTable/EquityCompensationIssuance/module.js +34 -34
  11. package/lib/Fairmint/OpenCapTable/Issuer/module.d.ts +116 -116
  12. package/lib/Fairmint/OpenCapTable/Issuer/module.js +173 -173
  13. package/lib/Fairmint/OpenCapTable/IssuerAuthorization/module.d.ts +1 -1
  14. package/lib/Fairmint/OpenCapTable/IssuerAuthorization/module.js +2 -2
  15. package/lib/Fairmint/OpenCapTable/IssuerAuthorizedSharesAdjustment/module.d.ts +18 -18
  16. package/lib/Fairmint/OpenCapTable/IssuerAuthorizedSharesAdjustment/module.js +22 -22
  17. package/lib/Fairmint/OpenCapTable/OcpFactory/module.d.ts +1 -1
  18. package/lib/Fairmint/OpenCapTable/OcpFactory/module.js +2 -2
  19. package/lib/Fairmint/OpenCapTable/Stakeholder/module.d.ts +38 -38
  20. package/lib/Fairmint/OpenCapTable/Stakeholder/module.js +56 -56
  21. package/lib/Fairmint/OpenCapTable/StockCancellation/module.d.ts +18 -18
  22. package/lib/Fairmint/OpenCapTable/StockCancellation/module.js +22 -22
  23. package/lib/Fairmint/OpenCapTable/StockClass/module.d.ts +25 -282
  24. package/lib/Fairmint/OpenCapTable/StockClass/module.js +28 -314
  25. package/lib/Fairmint/OpenCapTable/StockClassAuthorizedSharesAdjustment/module.d.ts +18 -18
  26. package/lib/Fairmint/OpenCapTable/StockClassAuthorizedSharesAdjustment/module.js +22 -22
  27. package/lib/Fairmint/OpenCapTable/StockIssuance/module.d.ts +42 -53
  28. package/lib/Fairmint/OpenCapTable/StockIssuance/module.js +43 -56
  29. package/lib/Fairmint/OpenCapTable/StockLegendTemplate/module.d.ts +14 -14
  30. package/lib/Fairmint/OpenCapTable/StockLegendTemplate/module.js +17 -17
  31. package/lib/Fairmint/OpenCapTable/StockPlan/module.d.ts +32 -32
  32. package/lib/Fairmint/OpenCapTable/StockPlan/module.js +33 -33
  33. package/lib/Fairmint/OpenCapTable/StockPlanPoolAdjustment/module.d.ts +18 -18
  34. package/lib/Fairmint/OpenCapTable/StockPlanPoolAdjustment/module.js +22 -22
  35. package/lib/Fairmint/OpenCapTable/Types/module.d.ts +409 -89
  36. package/lib/Fairmint/OpenCapTable/Types/module.js +449 -89
  37. package/lib/Fairmint/OpenCapTable/Valuation/module.d.ts +30 -30
  38. package/lib/Fairmint/OpenCapTable/Valuation/module.js +31 -31
  39. package/lib/Fairmint/OpenCapTable/VestingTerms/module.d.ts +78 -70
  40. package/lib/Fairmint/OpenCapTable/VestingTerms/module.js +102 -91
  41. package/lib/Fairmint/OpenCapTable/WarrantIssuance/module.d.ts +28 -29
  42. package/lib/Fairmint/OpenCapTable/WarrantIssuance/module.js +31 -32
  43. package/lib/Fairmint/OpenCapTableReports/CompanyValuationReport/module.js +1 -1
  44. package/lib/Fairmint/OpenCapTableReports/ReportsFactory/module.js +1 -1
  45. package/package.json +3 -3
@@ -11,6 +11,30 @@ import * as pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69
11
11
 
12
12
  import * as Fairmint_OpenCapTable_Types from '../../../Fairmint/OpenCapTable/Types/module';
13
13
 
14
+ export declare type OcfStockClassData = {
15
+ id: string;
16
+ class_type: Fairmint_OpenCapTable_Types.OcfStockClassType;
17
+ default_id_prefix: string;
18
+ initial_shares_authorized: damlTypes.Numeric;
19
+ name: string;
20
+ seniority: damlTypes.Numeric;
21
+ votes_per_share: damlTypes.Numeric;
22
+ comments: string[];
23
+ conversion_rights: Fairmint_OpenCapTable_Types.OcfStockClassConversionRight[];
24
+ board_approval_date: damlTypes.Optional<damlTypes.Time>;
25
+ liquidation_preference_multiple: damlTypes.Optional<damlTypes.Numeric>;
26
+ par_value: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
27
+ participation_cap_multiple: damlTypes.Optional<damlTypes.Numeric>;
28
+ price_per_share: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
29
+ stockholder_approval_date: damlTypes.Optional<damlTypes.Time>;
30
+ };
31
+
32
+ export declare const OcfStockClassData:
33
+ damlTypes.Serializable<OcfStockClassData> & {
34
+ }
35
+ ;
36
+
37
+
14
38
  export declare type ArchiveByIssuer = {
15
39
  };
16
40
 
@@ -30,7 +54,7 @@ export declare interface StockClassInterface {
30
54
  ArchiveByIssuer: damlTypes.Choice<StockClass, ArchiveByIssuer, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<StockClass, undefined>>;
31
55
  }
32
56
  export declare const StockClass:
33
- damlTypes.Template<StockClass, undefined, '#OpenCapTable-v22:Fairmint.OpenCapTable.StockClass:StockClass'> &
57
+ damlTypes.Template<StockClass, undefined, '#OpenCapTable-v24:Fairmint.OpenCapTable.StockClass:StockClass'> &
34
58
  damlTypes.ToInterface<StockClass, never> &
35
59
  StockClassInterface;
36
60
 
@@ -42,284 +66,3 @@ export declare namespace StockClass {
42
66
  }
43
67
 
44
68
 
45
-
46
- export declare type OcfWarrantIssuanceData = {
47
- quantity: damlTypes.Numeric;
48
- exercise_price: Fairmint_OpenCapTable_Types.OcfMonetary;
49
- purchase_price: Fairmint_OpenCapTable_Types.OcfMonetary;
50
- exercise_triggers: OcfConversionTrigger[];
51
- warrant_expiration_date: damlTypes.Optional<damlTypes.Time>;
52
- vesting_terms_id: damlTypes.Optional<string>;
53
- comments: string[];
54
- };
55
-
56
- export declare const OcfWarrantIssuanceData:
57
- damlTypes.Serializable<OcfWarrantIssuanceData> & {
58
- }
59
- ;
60
-
61
-
62
- export declare type OcfRatio = {
63
- numerator: damlTypes.Numeric;
64
- denominator: damlTypes.Numeric;
65
- };
66
-
67
- export declare const OcfRatio:
68
- damlTypes.Serializable<OcfRatio> & {
69
- }
70
- ;
71
-
72
-
73
- export declare type OcfConvertibleType =
74
- | 'OcfConvertibleNote'
75
- | 'OcfConvertibleSafe'
76
- | 'OcfConvertibleSecurity'
77
- ;
78
-
79
- export declare const OcfConvertibleType:
80
- damlTypes.Serializable<OcfConvertibleType> & {
81
- }
82
- & { readonly keys: OcfConvertibleType[] } & { readonly [e in OcfConvertibleType]: e }
83
- ;
84
-
85
-
86
- export declare type OcfConvertibleIssuanceData = {
87
- investment_amount: Fairmint_OpenCapTable_Types.OcfMonetary;
88
- convertible_type: OcfConvertibleType;
89
- conversion_triggers: OcfConvertibleConversionTrigger[];
90
- seniority: damlTypes.Int;
91
- pro_rata: damlTypes.Optional<damlTypes.Numeric>;
92
- comments: string[];
93
- };
94
-
95
- export declare const OcfConvertibleIssuanceData:
96
- damlTypes.Serializable<OcfConvertibleIssuanceData> & {
97
- }
98
- ;
99
-
100
-
101
- export declare type OcfConvertibleConversionTrigger = {
102
- type_: OcfConversionTriggerType;
103
- trigger_id: string;
104
- nickname: damlTypes.Optional<string>;
105
- trigger_description: damlTypes.Optional<string>;
106
- conversion_right: OcfConvertibleConversionRight;
107
- trigger_date: damlTypes.Optional<damlTypes.Time>;
108
- trigger_condition: damlTypes.Optional<string>;
109
- };
110
-
111
- export declare const OcfConvertibleConversionTrigger:
112
- damlTypes.Serializable<OcfConvertibleConversionTrigger> & {
113
- }
114
- ;
115
-
116
-
117
- export declare type OcfConversionTrigger = {
118
- type_: OcfConversionTriggerType;
119
- trigger_id: string;
120
- nickname: damlTypes.Optional<string>;
121
- trigger_description: damlTypes.Optional<string>;
122
- conversion_right: OcfAnyConversionRight;
123
- trigger_date: damlTypes.Optional<damlTypes.Time>;
124
- trigger_condition: damlTypes.Optional<string>;
125
- };
126
-
127
- export declare const OcfConversionTrigger:
128
- damlTypes.Serializable<OcfConversionTrigger> & {
129
- }
130
- ;
131
-
132
-
133
- export declare type OcfAnyConversionRight =
134
- | { tag: 'OcfRightConvertible'; value: OcfConvertibleConversionRight }
135
- | { tag: 'OcfRightWarrant'; value: OcfWarrantConversionRight }
136
- | { tag: 'OcfRightStockClass'; value: OcfStockClassConversionRight }
137
- ;
138
-
139
- export declare const OcfAnyConversionRight:
140
- damlTypes.Serializable<OcfAnyConversionRight> & {
141
- }
142
- ;
143
-
144
-
145
- export declare type OcfWarrantConversionRight = {
146
- type_: string;
147
- conversion_mechanism: OcfWarrantConversionMechanism;
148
- converts_to_future_round: damlTypes.Optional<boolean>;
149
- converts_to_stock_class_id: damlTypes.Optional<string>;
150
- };
151
-
152
- export declare const OcfWarrantConversionRight:
153
- damlTypes.Serializable<OcfWarrantConversionRight> & {
154
- }
155
- ;
156
-
157
-
158
- export declare type OcfWarrantConversionMechanism =
159
- | { tag: 'OcfWarrantMechanismCustom'; value: OcfWarrantConversionMechanism.OcfWarrantMechanismCustom }
160
- | { tag: 'OcfWarrantMechanismPercentCapitalization'; value: OcfWarrantConversionMechanism.OcfWarrantMechanismPercentCapitalization }
161
- | { tag: 'OcfWarrantMechanismFixedAmount'; value: OcfWarrantConversionMechanism.OcfWarrantMechanismFixedAmount }
162
- | { tag: 'OcfWarrantMechanismValuationBased'; value: OcfWarrantConversionMechanism.OcfWarrantMechanismValuationBased }
163
- | { tag: 'OcfWarrantMechanismSharePriceBased'; value: OcfWarrantConversionMechanism.OcfWarrantMechanismSharePriceBased }
164
- ;
165
-
166
- export declare const OcfWarrantConversionMechanism:
167
- damlTypes.Serializable<OcfWarrantConversionMechanism> & {
168
- OcfWarrantMechanismCustom: damlTypes.Serializable<OcfWarrantConversionMechanism.OcfWarrantMechanismCustom>;
169
- OcfWarrantMechanismPercentCapitalization: damlTypes.Serializable<OcfWarrantConversionMechanism.OcfWarrantMechanismPercentCapitalization>;
170
- OcfWarrantMechanismFixedAmount: damlTypes.Serializable<OcfWarrantConversionMechanism.OcfWarrantMechanismFixedAmount>;
171
- OcfWarrantMechanismValuationBased: damlTypes.Serializable<OcfWarrantConversionMechanism.OcfWarrantMechanismValuationBased>;
172
- OcfWarrantMechanismSharePriceBased: damlTypes.Serializable<OcfWarrantConversionMechanism.OcfWarrantMechanismSharePriceBased>;
173
- }
174
- ;
175
-
176
-
177
- export namespace OcfWarrantConversionMechanism {
178
- type OcfWarrantMechanismCustom = {
179
- custom_conversion_description: string;
180
- };
181
- } //namespace OcfWarrantConversionMechanism
182
-
183
-
184
- export namespace OcfWarrantConversionMechanism {
185
- type OcfWarrantMechanismPercentCapitalization = {
186
- converts_to_percent: damlTypes.Numeric;
187
- capitalization_definition: damlTypes.Optional<string>;
188
- capitalization_definition_rules: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfCapitalizationDefinitionRules>;
189
- };
190
- } //namespace OcfWarrantConversionMechanism
191
-
192
-
193
- export namespace OcfWarrantConversionMechanism {
194
- type OcfWarrantMechanismFixedAmount = {
195
- converts_to_quantity: damlTypes.Numeric;
196
- };
197
- } //namespace OcfWarrantConversionMechanism
198
-
199
-
200
- export namespace OcfWarrantConversionMechanism {
201
- type OcfWarrantMechanismValuationBased = {
202
- valuation_type: string;
203
- valuation_amount: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
204
- capitalization_definition: damlTypes.Optional<string>;
205
- capitalization_definition_rules: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfCapitalizationDefinitionRules>;
206
- };
207
- } //namespace OcfWarrantConversionMechanism
208
-
209
-
210
- export namespace OcfWarrantConversionMechanism {
211
- type OcfWarrantMechanismSharePriceBased = {
212
- description: string;
213
- discount: boolean;
214
- discount_percentage: damlTypes.Optional<damlTypes.Numeric>;
215
- discount_amount: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
216
- };
217
- } //namespace OcfWarrantConversionMechanism
218
-
219
-
220
- export declare type OcfConvertibleConversionRight = {
221
- type_: string;
222
- conversion_mechanism: OcfConversionMechanism;
223
- converts_to_future_round: damlTypes.Optional<boolean>;
224
- converts_to_stock_class_id: damlTypes.Optional<string>;
225
- };
226
-
227
- export declare const OcfConvertibleConversionRight:
228
- damlTypes.Serializable<OcfConvertibleConversionRight> & {
229
- }
230
- ;
231
-
232
-
233
- export declare type OcfConversionTriggerType =
234
- | 'OcfTriggerTypeTypeAutomaticOnCondition'
235
- | 'OcfTriggerTypeTypeAutomaticOnDate'
236
- | 'OcfTriggerTypeTypeElectiveInRange'
237
- | 'OcfTriggerTypeTypeElectiveOnCondition'
238
- | 'OcfTriggerTypeTypeElectiveAtWill'
239
- | 'OcfTriggerTypeTypeUnspecified'
240
- ;
241
-
242
- export declare const OcfConversionTriggerType:
243
- damlTypes.Serializable<OcfConversionTriggerType> & {
244
- }
245
- & { readonly keys: OcfConversionTriggerType[] } & { readonly [e in OcfConversionTriggerType]: e }
246
- ;
247
-
248
-
249
- export declare type OcfConversionMechanism =
250
- | 'OcfConversionMechanismRatioConversion'
251
- | 'OcfConversionMechanismPercentCapitalizationConversion'
252
- | 'OcfConversionMechanismFixedAmountConversion'
253
- | 'OcfConversionMechanismValuationBasedConversion'
254
- | 'OcfConversionMechanismSharePriceBasedConversion'
255
- | 'OcfConversionMechanismSAFEConversion'
256
- | 'OcfConversionMechanismNoteConversion'
257
- | 'OcfConversionMechanismCustomConversion'
258
- ;
259
-
260
- export declare const OcfConversionMechanism:
261
- damlTypes.Serializable<OcfConversionMechanism> & {
262
- }
263
- & { readonly keys: OcfConversionMechanism[] } & { readonly [e in OcfConversionMechanism]: e }
264
- ;
265
-
266
-
267
- export declare type OcfStockClassConversionRight = {
268
- type_: string;
269
- conversion_mechanism: OcfConversionMechanism;
270
- conversion_trigger: OcfConversionTrigger;
271
- converts_to_stock_class_id: string;
272
- ratio: damlTypes.Optional<OcfRatio>;
273
- percent_of_capitalization: damlTypes.Optional<damlTypes.Numeric>;
274
- conversion_price: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
275
- reference_share_price: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
276
- reference_valuation_price_per_share: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
277
- discount_rate: damlTypes.Optional<damlTypes.Numeric>;
278
- valuation_cap: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
279
- floor_price_per_share: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
280
- ceiling_price_per_share: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
281
- custom_description: damlTypes.Optional<string>;
282
- expires_at: damlTypes.Optional<damlTypes.Time>;
283
- };
284
-
285
- export declare const OcfStockClassConversionRight:
286
- damlTypes.Serializable<OcfStockClassConversionRight> & {
287
- }
288
- ;
289
-
290
-
291
- export declare type OcfStockClassType =
292
- | 'OcfStockClassTypeCommon'
293
- | 'OcfStockClassTypePreferred'
294
- ;
295
-
296
- export declare const OcfStockClassType:
297
- damlTypes.Serializable<OcfStockClassType> & {
298
- }
299
- & { readonly keys: OcfStockClassType[] } & { readonly [e in OcfStockClassType]: e }
300
- ;
301
-
302
-
303
- export declare type OcfStockClassData = {
304
- ocf_id: string;
305
- name: string;
306
- class_type: OcfStockClassType;
307
- default_id_prefix: string;
308
- initial_shares_authorized: damlTypes.Numeric;
309
- votes_per_share: damlTypes.Numeric;
310
- seniority: damlTypes.Numeric;
311
- board_approval_date: damlTypes.Optional<damlTypes.Time>;
312
- stockholder_approval_date: damlTypes.Optional<damlTypes.Time>;
313
- par_value: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
314
- price_per_share: damlTypes.Optional<Fairmint_OpenCapTable_Types.OcfMonetary>;
315
- liquidation_preference_multiple: damlTypes.Optional<damlTypes.Numeric>;
316
- participation_cap_multiple: damlTypes.Optional<damlTypes.Numeric>;
317
- conversion_rights: OcfStockClassConversionRight[];
318
- comments: string[];
319
- };
320
-
321
- export declare const OcfStockClassData:
322
- damlTypes.Serializable<OcfStockClassData> & {
323
- }
324
- ;
325
-