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

package/README.md

@@ -0,0 +1,65 @@
+## Shared Coding Guidelines for OCP DAML Packages
+
+This repository contains multiple DAML packages (e.g., `OpenCapTable-v24`, `OpenCapTableReports-v01`, `OpenCapTableProofOfOwnership-v01`, `OpenCapTableShared-v01`). This document defines coding guidelines that apply to all packages.
+
+For package-specific details about each implementation, see the README.md file in the respective package directory (e.g., `open-captable-protocol-daml/OpenCapTable-v24/README.md`).
+
+### Global exceptions
+
+- We use DAML `Time` instead of schema `Date` (schema excludes time) as a workaround for a JavaScript parsing issue.
+
+### Implementation guidance
+ 
+- **Non-empty Text values**:
+  - Never allow empty `Text` strings. For `Optional Text`, if provided (`Some t`), ensure `t /= ""`.
+  - For arrays of `Text`, validate each element is non-empty.
+- **Arrays are non-optional**: Do not omit array fields. When there are no items, emit an empty array (`[]`) instead of leaving the field out.
+- **Avoid trivial type aliases**: Do not create semantic aliases for native types (e.g., `type OcfMd5 = Text`). Prefer native types with validators. Example:
+
+```daml
+-- MD5
+-- OCF: https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/types/Md5.schema.json
+validateOcfMd5 : Text -> Bool
+validateOcfMd5 md5 =
+  let n = Text.length md5 in
+  n == 32 && CryptoText.isHex md5
+```
+- **Shared types and organization**:
+  - Define any type used by more than one template in `Types.daml` (with its validator) and import where needed.
+  - Keep template files focused; if a type is only used by a single template, define it in that template file.
+  - Do not import a template module solely to access a type; move that type to `Types.daml` instead.
+  - Within each record, maintain field ordering for readability:
+    1) `id` first
+    2) Required scalar fields (alphabetical)
+    3) Arrays (alphabetical)
+    4) Optional fields (alphabetical)
+  - This ordering applies to all types/records (not only top-level transaction objects). If a record does not have an `id`, skip step 1 and still follow required → arrays → optional with alphabetical ordering within each group.
+  - Required refers to types which are not `Optional` or an array. Keep the groups strict and correct.
+  - Use short section headers and separators to denote these groups exactly as:
+    - `-- Required fields (alphabetical)`
+    - `-- ---------------------------------`
+    - `-- Arrays (alphabetical)`
+    - `-- ---------------------------------`
+    - `-- Optional fields (alphabetical)`
+    - `-- ---------------------------------`
+ - **Declaration order in template files**: Place declarations in this order within each template file: 1) `template` block first, 2) top-level `data` (the main object record), 3) subtype `data` (helper or nested records specific to the template). Keep the two data definitions adjacent.
+- **Validator placement**: Define the validator immediately after the corresponding `data` type it validates, in the same file. Example:
+
+```daml
+data OcfThing = OcfThing with field: Text deriving (Eq, Show)
+
+validateOcfThing : OcfThing -> Bool
+validateOcfThing t = t.field /= ""
+```
+- **Test helpers**: Place test helpers only in the `Test` package, never in main packages.
+
+- **Choice ordering in templates**: When there is no clear logical lifecycle ordering, sort choice declarations alphabetically by choice name. As a convention, place create-style choices before archive-style choices (e.g., put `ArchiveByIssuer` last).
+
+### Package-specific guidance
+
+Each package may include additional constraints and domain guidance. Refer to:
+
+- `open-captable-protocol-daml/OpenCapTable-v24/README.md` for Open Cap Table specifics (e.g., Issuer management patterns).
+- Other package READMEs as applicable.
+
+

package/generated/ocp-factory-contract-id.json

@@ -1,10 +1,10 @@
 {
   "mainnet": {
-    "ocpFactoryContractId": "0049b0d54d7d9516792f3aa6cd0f96c0e9342d9c8a4edb2d1cbc8664231b5bc7c7ca111220b30ad4ecba78d290e8798daaa50cb49c5c409ce5736c3c0f85f4968216fb227a",
-    "templateId": "c3614dff0d0574cbb00d6141ef5a71909a44a16e19667adb3abdb572ee7f0b4d:Fairmint.OpenCapTable.OcpFactory:OcpFactory"
+    "ocpFactoryContractId": "00066a89eb52640119ecf1bb38fc8805dae7bf91c51a3a04cf255473da83ef9411ca111220f742c1b52e188f6527968ed4b1d619723b2a5c77cbbf951d69451865a286dd2a",
+    "templateId": "2a4643064cabdaa1562186b34da3c4de4e3a0b03c82a66d634e8fc4bd974aaa5:Fairmint.OpenCapTable.OcpFactory:OcpFactory"
   },
   "devnet": {
-    "ocpFactoryContractId": "000c4d824effb8508b216fedb99308c48dba78809990895893465070b2790b42aaca111220f92024a0095b41e816ccfe40bde304c50b1e87e09ab384e2e47d748efa0318ad",
-    "templateId": "c3614dff0d0574cbb00d6141ef5a71909a44a16e19667adb3abdb572ee7f0b4d:Fairmint.OpenCapTable.OcpFactory:OcpFactory"
+    "ocpFactoryContractId": "0008445a5f27c41693da6015a9653091fcc04f1128838c579f8baf2b7347e8b247ca111220db07a840f5ad0d253ea16d9143d44680be2eb4276073c08a04b22bac037c3905",
+    "templateId": "2a4643064cabdaa1562186b34da3c4de4e3a0b03c82a66d634e8fc4bd974aaa5:Fairmint.OpenCapTable.OcpFactory:OcpFactory"
   }
 }

package/lib/Fairmint/OpenCapTable/ConvertibleIssuance/module.d.ts

@@ -9,9 +9,48 @@ import * as damlLedger from '@daml/ledger';
 
 import * as pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69 from '../../../DA/Internal/Template';
 
-import * as Fairmint_OpenCapTable_StockClass from '../../../Fairmint/OpenCapTable/StockClass/module';
 import * as Fairmint_OpenCapTable_Types from '../../../Fairmint/OpenCapTable/Types/module';
 
+export declare type OcfConvertibleConversionTrigger = {
+  conversion_right: Fairmint_OpenCapTable_Types.OcfConvertibleConversionRight;
+  trigger_id: string;
+  type_: Fairmint_OpenCapTable_Types.OcfConversionTriggerType;
+  nickname: damlTypes.Optional<string>;
+  trigger_condition: damlTypes.Optional<string>;
+  trigger_date: damlTypes.Optional<damlTypes.Time>;
+  trigger_description: damlTypes.Optional<string>;
+};
+
+export declare const OcfConvertibleConversionTrigger:
+  damlTypes.Serializable<OcfConvertibleConversionTrigger> & {
+  }
+;
+
+
+export declare type OcfConvertibleIssuanceTxData = {
+  id: string;
+  convertible_type: Fairmint_OpenCapTable_Types.OcfConvertibleType;
+  custom_id: string;
+  date: damlTypes.Time;
+  investment_amount: Fairmint_OpenCapTable_Types.OcfMonetary;
+  security_id: string;
+  seniority: damlTypes.Int;
+  stakeholder_id: string;
+  comments: string[];
+  conversion_triggers: OcfConvertibleConversionTrigger[];
+  security_law_exemptions: Fairmint_OpenCapTable_Types.OcfSecurityExemption[];
+  board_approval_date: damlTypes.Optional<damlTypes.Time>;
+  consideration_text: damlTypes.Optional<string>;
+  pro_rata: damlTypes.Optional<damlTypes.Numeric>;
+  stockholder_approval_date: damlTypes.Optional<damlTypes.Time>;
+};
+
+export declare const OcfConvertibleIssuanceTxData:
+  damlTypes.Serializable<OcfConvertibleIssuanceTxData> & {
+  }
+;
+
+
 export declare type ArchiveByIssuer = {
 };
 
@@ -31,7 +70,7 @@ export declare interface ConvertibleIssuanceInterface {
   ArchiveByIssuer: damlTypes.Choice<ConvertibleIssuance, ArchiveByIssuer, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<ConvertibleIssuance, undefined>>;
 }
 export declare const ConvertibleIssuance:
-  damlTypes.Template<ConvertibleIssuance, undefined, '#OpenCapTable-v22:Fairmint.OpenCapTable.ConvertibleIssuance:ConvertibleIssuance'> &
+  damlTypes.Template<ConvertibleIssuance, undefined, '#OpenCapTable-v24:Fairmint.OpenCapTable.ConvertibleIssuance:ConvertibleIssuance'> &
   damlTypes.ToInterface<ConvertibleIssuance, never> &
   ConvertibleIssuanceInterface;
 
@@ -43,27 +82,3 @@ export declare namespace ConvertibleIssuance {
 }
 
 
-
-export declare type OcfConvertibleIssuanceTxData = {
-  ocf_id: string;
-  date: damlTypes.Time;
-  security_id: string;
-  custom_id: string;
-  stakeholder_id: string;
-  board_approval_date: damlTypes.Optional<damlTypes.Time>;
-  stockholder_approval_date: damlTypes.Optional<damlTypes.Time>;
-  consideration_text: damlTypes.Optional<string>;
-  security_law_exemptions: Fairmint_OpenCapTable_Types.OcfSecurityExemption[];
-  investment_amount: Fairmint_OpenCapTable_Types.OcfMonetary;
-  convertible_type: Fairmint_OpenCapTable_StockClass.OcfConvertibleType;
-  conversion_triggers: Fairmint_OpenCapTable_StockClass.OcfConversionTrigger[];
-  pro_rata: damlTypes.Optional<damlTypes.Numeric>;
-  seniority: damlTypes.Int;
-  comments: string[];
-};
-
-export declare const OcfConvertibleIssuanceTxData:
-  damlTypes.Serializable<OcfConvertibleIssuanceTxData> & {
-  }
-;
-

package/lib/Fairmint/OpenCapTable/ConvertibleIssuance/module.js

@@ -14,10 +14,53 @@ var damlLedger = require('@daml/ledger');
 
 var pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69 = require('../../../DA/Internal/Template');
 
-var Fairmint_OpenCapTable_StockClass = require('../../../Fairmint/OpenCapTable/StockClass/module');
 var Fairmint_OpenCapTable_Types = require('../../../Fairmint/OpenCapTable/Types/module');
 
 
+exports.OcfConvertibleConversionTrigger = {
+  decoder: damlTypes.lazyMemo(function () { return jtv.object({conversion_right: Fairmint_OpenCapTable_Types.OcfConvertibleConversionRight.decoder, trigger_id: damlTypes.Text.decoder, type_: Fairmint_OpenCapTable_Types.OcfConversionTriggerType.decoder, nickname: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), trigger_condition: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), trigger_date: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Time).decoder), trigger_description: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), }); }),
+  encode: function (__typed__) {
+  return {
+    conversion_right: Fairmint_OpenCapTable_Types.OcfConvertibleConversionRight.encode(__typed__.conversion_right),
+    trigger_id: damlTypes.Text.encode(__typed__.trigger_id),
+    type_: Fairmint_OpenCapTable_Types.OcfConversionTriggerType.encode(__typed__.type_),
+    nickname: damlTypes.Optional(damlTypes.Text).encode(__typed__.nickname),
+    trigger_condition: damlTypes.Optional(damlTypes.Text).encode(__typed__.trigger_condition),
+    trigger_date: damlTypes.Optional(damlTypes.Time).encode(__typed__.trigger_date),
+    trigger_description: damlTypes.Optional(damlTypes.Text).encode(__typed__.trigger_description),
+  };
+}
+,
+};
+
+
+
+exports.OcfConvertibleIssuanceTxData = {
+  decoder: damlTypes.lazyMemo(function () { return jtv.object({id: damlTypes.Text.decoder, convertible_type: Fairmint_OpenCapTable_Types.OcfConvertibleType.decoder, custom_id: damlTypes.Text.decoder, date: damlTypes.Time.decoder, investment_amount: Fairmint_OpenCapTable_Types.OcfMonetary.decoder, security_id: damlTypes.Text.decoder, seniority: damlTypes.Int.decoder, stakeholder_id: damlTypes.Text.decoder, comments: damlTypes.List(damlTypes.Text).decoder, conversion_triggers: damlTypes.List(exports.OcfConvertibleConversionTrigger).decoder, security_law_exemptions: damlTypes.List(Fairmint_OpenCapTable_Types.OcfSecurityExemption).decoder, board_approval_date: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Time).decoder), consideration_text: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), pro_rata: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Numeric(10)).decoder), stockholder_approval_date: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Time).decoder), }); }),
+  encode: function (__typed__) {
+  return {
+    id: damlTypes.Text.encode(__typed__.id),
+    convertible_type: Fairmint_OpenCapTable_Types.OcfConvertibleType.encode(__typed__.convertible_type),
+    custom_id: damlTypes.Text.encode(__typed__.custom_id),
+    date: damlTypes.Time.encode(__typed__.date),
+    investment_amount: Fairmint_OpenCapTable_Types.OcfMonetary.encode(__typed__.investment_amount),
+    security_id: damlTypes.Text.encode(__typed__.security_id),
+    seniority: damlTypes.Int.encode(__typed__.seniority),
+    stakeholder_id: damlTypes.Text.encode(__typed__.stakeholder_id),
+    comments: damlTypes.List(damlTypes.Text).encode(__typed__.comments),
+    conversion_triggers: damlTypes.List(exports.OcfConvertibleConversionTrigger).encode(__typed__.conversion_triggers),
+    security_law_exemptions: damlTypes.List(Fairmint_OpenCapTable_Types.OcfSecurityExemption).encode(__typed__.security_law_exemptions),
+    board_approval_date: damlTypes.Optional(damlTypes.Time).encode(__typed__.board_approval_date),
+    consideration_text: damlTypes.Optional(damlTypes.Text).encode(__typed__.consideration_text),
+    pro_rata: damlTypes.Optional(damlTypes.Numeric(10)).encode(__typed__.pro_rata),
+    stockholder_approval_date: damlTypes.Optional(damlTypes.Time).encode(__typed__.stockholder_approval_date),
+  };
+}
+,
+};
+
+
+
 exports.ArchiveByIssuer = {
   decoder: damlTypes.lazyMemo(function () { return jtv.object({}); }),
   encode: function (__typed__) {
@@ -31,7 +74,7 @@ exports.ArchiveByIssuer = {
 
 exports.ConvertibleIssuance = damlTypes.assembleTemplate(
 {
-  templateId: '#OpenCapTable-v22:Fairmint.OpenCapTable.ConvertibleIssuance:ConvertibleIssuance',
+  templateId: '#OpenCapTable-v24:Fairmint.OpenCapTable.ConvertibleIssuance:ConvertibleIssuance',
   keyDecoder: damlTypes.lazyMemo(function () { return jtv.constant(undefined); }),
   keyEncode: function () { throw 'EncodeError'; },
   decoder: damlTypes.lazyMemo(function () { return jtv.object({context: Fairmint_OpenCapTable_Types.Context.decoder, issuance_data: exports.OcfConvertibleIssuanceTxData.decoder, }); }),
@@ -63,31 +106,5 @@ exports.ConvertibleIssuance = damlTypes.assembleTemplate(
 );
 
 
-damlTypes.registerTemplate(exports.ConvertibleIssuance, ['c3614dff0d0574cbb00d6141ef5a71909a44a16e19667adb3abdb572ee7f0b4d', '#OpenCapTable-v22']);
-
-
-
-exports.OcfConvertibleIssuanceTxData = {
-  decoder: damlTypes.lazyMemo(function () { return jtv.object({ocf_id: damlTypes.Text.decoder, date: damlTypes.Time.decoder, security_id: damlTypes.Text.decoder, custom_id: damlTypes.Text.decoder, stakeholder_id: damlTypes.Text.decoder, board_approval_date: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Time).decoder), stockholder_approval_date: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Time).decoder), consideration_text: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), security_law_exemptions: damlTypes.List(Fairmint_OpenCapTable_Types.OcfSecurityExemption).decoder, investment_amount: Fairmint_OpenCapTable_Types.OcfMonetary.decoder, convertible_type: Fairmint_OpenCapTable_StockClass.OcfConvertibleType.decoder, conversion_triggers: damlTypes.List(Fairmint_OpenCapTable_StockClass.OcfConversionTrigger).decoder, pro_rata: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Numeric(10)).decoder), seniority: damlTypes.Int.decoder, comments: damlTypes.List(damlTypes.Text).decoder, }); }),
-  encode: function (__typed__) {
-  return {
-    ocf_id: damlTypes.Text.encode(__typed__.ocf_id),
-    date: damlTypes.Time.encode(__typed__.date),
-    security_id: damlTypes.Text.encode(__typed__.security_id),
-    custom_id: damlTypes.Text.encode(__typed__.custom_id),
-    stakeholder_id: damlTypes.Text.encode(__typed__.stakeholder_id),
-    board_approval_date: damlTypes.Optional(damlTypes.Time).encode(__typed__.board_approval_date),
-    stockholder_approval_date: damlTypes.Optional(damlTypes.Time).encode(__typed__.stockholder_approval_date),
-    consideration_text: damlTypes.Optional(damlTypes.Text).encode(__typed__.consideration_text),
-    security_law_exemptions: damlTypes.List(Fairmint_OpenCapTable_Types.OcfSecurityExemption).encode(__typed__.security_law_exemptions),
-    investment_amount: Fairmint_OpenCapTable_Types.OcfMonetary.encode(__typed__.investment_amount),
-    convertible_type: Fairmint_OpenCapTable_StockClass.OcfConvertibleType.encode(__typed__.convertible_type),
-    conversion_triggers: damlTypes.List(Fairmint_OpenCapTable_StockClass.OcfConversionTrigger).encode(__typed__.conversion_triggers),
-    pro_rata: damlTypes.Optional(damlTypes.Numeric(10)).encode(__typed__.pro_rata),
-    seniority: damlTypes.Int.encode(__typed__.seniority),
-    comments: damlTypes.List(damlTypes.Text).encode(__typed__.comments),
-  };
-}
-,
-};
+damlTypes.registerTemplate(exports.ConvertibleIssuance, ['2a4643064cabdaa1562186b34da3c4de4e3a0b03c82a66d634e8fc4bd974aaa5', '#OpenCapTable-v24']);
 

package/lib/Fairmint/OpenCapTable/Document/module.d.ts

@@ -11,38 +11,6 @@ import * as pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69
 
 import * as Fairmint_OpenCapTable_Types from '../../../Fairmint/OpenCapTable/Types/module';
 
-export declare type ArchiveByIssuer = {
-};
-
-export declare const ArchiveByIssuer:
-  damlTypes.Serializable<ArchiveByIssuer> & {
-  }
-;
-
-
-export declare type Document = {
-  context: Fairmint_OpenCapTable_Types.Context;
-  document_data: OcfDocument;
-};
-
-export declare interface DocumentInterface {
-  Archive: damlTypes.Choice<Document, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<Document, undefined>>;
-  ArchiveByIssuer: damlTypes.Choice<Document, ArchiveByIssuer, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<Document, undefined>>;
-}
-export declare const Document:
-  damlTypes.Template<Document, undefined, '#OpenCapTable-v22:Fairmint.OpenCapTable.Document:Document'> &
-  damlTypes.ToInterface<Document, never> &
-  DocumentInterface;
-
-export declare namespace Document {
-  export type CreateEvent = damlLedger.CreateEvent<Document, undefined, typeof Document.templateId>
-  export type ArchiveEvent = damlLedger.ArchiveEvent<Document, typeof Document.templateId>
-  export type Event = damlLedger.Event<Document, undefined, typeof Document.templateId>
-  export type QueryResult = damlLedger.QueryResult<Document, undefined, typeof Document.templateId>
-}
-
-
-
 export declare type OcfObjectType =
   | 'OcfObjIssuer'
   | 'OcfObjStakeholder'
@@ -110,8 +78,8 @@ export declare const OcfObjectType:
 
 
 export declare type OcfObjectReference = {
-  object_type: OcfObjectType;
   object_id: string;
+  object_type: OcfObjectType;
 };
 
 export declare const OcfObjectReference:
@@ -121,12 +89,12 @@ export declare const OcfObjectReference:
 
 
 export declare type OcfDocument = {
-  ocf_id: string;
-  path: damlTypes.Optional<string>;
-  uri: damlTypes.Optional<string>;
+  id: string;
   md5: string;
-  related_objects: OcfObjectReference[];
   comments: string[];
+  related_objects: OcfObjectReference[];
+  path: damlTypes.Optional<string>;
+  uri: damlTypes.Optional<string>;
 };
 
 export declare const OcfDocument:
@@ -134,3 +102,35 @@ export declare const OcfDocument:
   }
 ;
 
+
+export declare type ArchiveByIssuer = {
+};
+
+export declare const ArchiveByIssuer:
+  damlTypes.Serializable<ArchiveByIssuer> & {
+  }
+;
+
+
+export declare type Document = {
+  context: Fairmint_OpenCapTable_Types.Context;
+  document_data: OcfDocument;
+};
+
+export declare interface DocumentInterface {
+  Archive: damlTypes.Choice<Document, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<Document, undefined>>;
+  ArchiveByIssuer: damlTypes.Choice<Document, ArchiveByIssuer, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<Document, undefined>>;
+}
+export declare const Document:
+  damlTypes.Template<Document, undefined, '#OpenCapTable-v24:Fairmint.OpenCapTable.Document:Document'> &
+  damlTypes.ToInterface<Document, never> &
+  DocumentInterface;
+
+export declare namespace Document {
+  export type CreateEvent = damlLedger.CreateEvent<Document, undefined, typeof Document.templateId>
+  export type ArchiveEvent = damlLedger.ArchiveEvent<Document, typeof Document.templateId>
+  export type Event = damlLedger.Event<Document, undefined, typeof Document.templateId>
+  export type QueryResult = damlLedger.QueryResult<Document, undefined, typeof Document.templateId>
+}
+
+

package/lib/Fairmint/OpenCapTable/Document/module.js

@@ -17,55 +17,6 @@ var pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69 = requir
 var Fairmint_OpenCapTable_Types = require('../../../Fairmint/OpenCapTable/Types/module');
 
 
-exports.ArchiveByIssuer = {
-  decoder: damlTypes.lazyMemo(function () { return jtv.object({}); }),
-  encode: function (__typed__) {
-  return {
-  };
-}
-,
-};
-
-
-
-exports.Document = damlTypes.assembleTemplate(
-{
-  templateId: '#OpenCapTable-v22:Fairmint.OpenCapTable.Document:Document',
-  keyDecoder: damlTypes.lazyMemo(function () { return jtv.constant(undefined); }),
-  keyEncode: function () { throw 'EncodeError'; },
-  decoder: damlTypes.lazyMemo(function () { return jtv.object({context: Fairmint_OpenCapTable_Types.Context.decoder, document_data: exports.OcfDocument.decoder, }); }),
-  encode: function (__typed__) {
-  return {
-    context: Fairmint_OpenCapTable_Types.Context.encode(__typed__.context),
-    document_data: exports.OcfDocument.encode(__typed__.document_data),
-  };
-}
-,
-  Archive: {
-    template: function () { return exports.Document; },
-    choiceName: 'Archive',
-    argumentDecoder: damlTypes.lazyMemo(function () { return pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive.decoder; }),
-    argumentEncode: function (__typed__) { return pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive.encode(__typed__); },
-    resultDecoder: damlTypes.lazyMemo(function () { return damlTypes.Unit.decoder; }),
-    resultEncode: function (__typed__) { return damlTypes.Unit.encode(__typed__); },
-  },
-  ArchiveByIssuer: {
-    template: function () { return exports.Document; },
-    choiceName: 'ArchiveByIssuer',
-    argumentDecoder: damlTypes.lazyMemo(function () { return exports.ArchiveByIssuer.decoder; }),
-    argumentEncode: function (__typed__) { return exports.ArchiveByIssuer.encode(__typed__); },
-    resultDecoder: damlTypes.lazyMemo(function () { return damlTypes.Unit.decoder; }),
-    resultEncode: function (__typed__) { return damlTypes.Unit.encode(__typed__); },
-  },
-}
-
-);
-
-
-damlTypes.registerTemplate(exports.Document, ['c3614dff0d0574cbb00d6141ef5a71909a44a16e19667adb3abdb572ee7f0b4d', '#OpenCapTable-v22']);
-
-
-
 exports.OcfObjectType = {
   OcfObjIssuer: 'OcfObjIssuer',
   OcfObjStakeholder: 'OcfObjStakeholder',
@@ -131,11 +82,11 @@ exports.OcfObjectType = {
 
 
 exports.OcfObjectReference = {
-  decoder: damlTypes.lazyMemo(function () { return jtv.object({object_type: exports.OcfObjectType.decoder, object_id: damlTypes.Text.decoder, }); }),
+  decoder: damlTypes.lazyMemo(function () { return jtv.object({object_id: damlTypes.Text.decoder, object_type: exports.OcfObjectType.decoder, }); }),
   encode: function (__typed__) {
   return {
-    object_type: exports.OcfObjectType.encode(__typed__.object_type),
     object_id: damlTypes.Text.encode(__typed__.object_id),
+    object_type: exports.OcfObjectType.encode(__typed__.object_type),
   };
 }
 ,
@@ -144,17 +95,66 @@ exports.OcfObjectReference = {
 
 
 exports.OcfDocument = {
-  decoder: damlTypes.lazyMemo(function () { return jtv.object({ocf_id: damlTypes.Text.decoder, path: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), uri: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), md5: damlTypes.Text.decoder, related_objects: damlTypes.List(exports.OcfObjectReference).decoder, comments: damlTypes.List(damlTypes.Text).decoder, }); }),
+  decoder: damlTypes.lazyMemo(function () { return jtv.object({id: damlTypes.Text.decoder, md5: damlTypes.Text.decoder, comments: damlTypes.List(damlTypes.Text).decoder, related_objects: damlTypes.List(exports.OcfObjectReference).decoder, path: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), uri: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), }); }),
   encode: function (__typed__) {
   return {
-    ocf_id: damlTypes.Text.encode(__typed__.ocf_id),
-    path: damlTypes.Optional(damlTypes.Text).encode(__typed__.path),
-    uri: damlTypes.Optional(damlTypes.Text).encode(__typed__.uri),
+    id: damlTypes.Text.encode(__typed__.id),
     md5: damlTypes.Text.encode(__typed__.md5),
-    related_objects: damlTypes.List(exports.OcfObjectReference).encode(__typed__.related_objects),
     comments: damlTypes.List(damlTypes.Text).encode(__typed__.comments),
+    related_objects: damlTypes.List(exports.OcfObjectReference).encode(__typed__.related_objects),
+    path: damlTypes.Optional(damlTypes.Text).encode(__typed__.path),
+    uri: damlTypes.Optional(damlTypes.Text).encode(__typed__.uri),
+  };
+}
+,
+};
+
+
+
+exports.ArchiveByIssuer = {
+  decoder: damlTypes.lazyMemo(function () { return jtv.object({}); }),
+  encode: function (__typed__) {
+  return {
   };
 }
 ,
 };
 
+
+
+exports.Document = damlTypes.assembleTemplate(
+{
+  templateId: '#OpenCapTable-v24:Fairmint.OpenCapTable.Document:Document',
+  keyDecoder: damlTypes.lazyMemo(function () { return jtv.constant(undefined); }),
+  keyEncode: function () { throw 'EncodeError'; },
+  decoder: damlTypes.lazyMemo(function () { return jtv.object({context: Fairmint_OpenCapTable_Types.Context.decoder, document_data: exports.OcfDocument.decoder, }); }),
+  encode: function (__typed__) {
+  return {
+    context: Fairmint_OpenCapTable_Types.Context.encode(__typed__.context),
+    document_data: exports.OcfDocument.encode(__typed__.document_data),
+  };
+}
+,
+  Archive: {
+    template: function () { return exports.Document; },
+    choiceName: 'Archive',
+    argumentDecoder: damlTypes.lazyMemo(function () { return pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive.decoder; }),
+    argumentEncode: function (__typed__) { return pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive.encode(__typed__); },
+    resultDecoder: damlTypes.lazyMemo(function () { return damlTypes.Unit.decoder; }),
+    resultEncode: function (__typed__) { return damlTypes.Unit.encode(__typed__); },
+  },
+  ArchiveByIssuer: {
+    template: function () { return exports.Document; },
+    choiceName: 'ArchiveByIssuer',
+    argumentDecoder: damlTypes.lazyMemo(function () { return exports.ArchiveByIssuer.decoder; }),
+    argumentEncode: function (__typed__) { return exports.ArchiveByIssuer.encode(__typed__); },
+    resultDecoder: damlTypes.lazyMemo(function () { return damlTypes.Unit.decoder; }),
+    resultEncode: function (__typed__) { return damlTypes.Unit.encode(__typed__); },
+  },
+}
+
+);
+
+
+damlTypes.registerTemplate(exports.Document, ['2a4643064cabdaa1562186b34da3c4de4e3a0b03c82a66d634e8fc4bd974aaa5', '#OpenCapTable-v24']);
+

package/lib/Fairmint/OpenCapTable/EquityCompensationExercise/module.d.ts

@@ -11,6 +11,22 @@ import * as pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69
 
 import * as Fairmint_OpenCapTable_Types from '../../../Fairmint/OpenCapTable/Types/module';
 
+export declare type OcfEquityCompensationExerciseData = {
+  id: string;
+  date: damlTypes.Time;
+  quantity: damlTypes.Numeric;
+  security_id: string;
+  comments: string[];
+  resulting_security_ids: string[];
+  consideration_text: damlTypes.Optional<string>;
+};
+
+export declare const OcfEquityCompensationExerciseData:
+  damlTypes.Serializable<OcfEquityCompensationExerciseData> & {
+  }
+;
+
+
 export declare type ArchiveByIssuer = {
 };
 
@@ -30,7 +46,7 @@ export declare interface EquityCompensationExerciseInterface {
   ArchiveByIssuer: damlTypes.Choice<EquityCompensationExercise, ArchiveByIssuer, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<EquityCompensationExercise, undefined>>;
 }
 export declare const EquityCompensationExercise:
-  damlTypes.Template<EquityCompensationExercise, undefined, '#OpenCapTable-v22:Fairmint.OpenCapTable.EquityCompensationExercise:EquityCompensationExercise'> &
+  damlTypes.Template<EquityCompensationExercise, undefined, '#OpenCapTable-v24:Fairmint.OpenCapTable.EquityCompensationExercise:EquityCompensationExercise'> &
   damlTypes.ToInterface<EquityCompensationExercise, never> &
   EquityCompensationExerciseInterface;
 
@@ -42,19 +58,3 @@ export declare namespace EquityCompensationExercise {
 }
 
 
-
-export declare type OcfEquityCompensationExerciseData = {
-  ocf_id: string;
-  date: damlTypes.Time;
-  security_id: string;
-  quantity: damlTypes.Numeric;
-  consideration_text: damlTypes.Optional<string>;
-  resulting_security_ids: string[];
-  comments: string[];
-};
-
-export declare const OcfEquityCompensationExerciseData:
-  damlTypes.Serializable<OcfEquityCompensationExerciseData> & {
-  }
-;
-

package/lib/Fairmint/OpenCapTable/EquityCompensationExercise/module.js

@@ -17,6 +17,24 @@ var pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69 = requir
 var Fairmint_OpenCapTable_Types = require('../../../Fairmint/OpenCapTable/Types/module');
 
 
+exports.OcfEquityCompensationExerciseData = {
+  decoder: damlTypes.lazyMemo(function () { return jtv.object({id: damlTypes.Text.decoder, date: damlTypes.Time.decoder, quantity: damlTypes.Numeric(10).decoder, security_id: damlTypes.Text.decoder, comments: damlTypes.List(damlTypes.Text).decoder, resulting_security_ids: damlTypes.List(damlTypes.Text).decoder, consideration_text: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), }); }),
+  encode: function (__typed__) {
+  return {
+    id: damlTypes.Text.encode(__typed__.id),
+    date: damlTypes.Time.encode(__typed__.date),
+    quantity: damlTypes.Numeric(10).encode(__typed__.quantity),
+    security_id: damlTypes.Text.encode(__typed__.security_id),
+    comments: damlTypes.List(damlTypes.Text).encode(__typed__.comments),
+    resulting_security_ids: damlTypes.List(damlTypes.Text).encode(__typed__.resulting_security_ids),
+    consideration_text: damlTypes.Optional(damlTypes.Text).encode(__typed__.consideration_text),
+  };
+}
+,
+};
+
+
+
 exports.ArchiveByIssuer = {
   decoder: damlTypes.lazyMemo(function () { return jtv.object({}); }),
   encode: function (__typed__) {
@@ -30,7 +48,7 @@ exports.ArchiveByIssuer = {
 
 exports.EquityCompensationExercise = damlTypes.assembleTemplate(
 {
-  templateId: '#OpenCapTable-v22:Fairmint.OpenCapTable.EquityCompensationExercise:EquityCompensationExercise',
+  templateId: '#OpenCapTable-v24:Fairmint.OpenCapTable.EquityCompensationExercise:EquityCompensationExercise',
   keyDecoder: damlTypes.lazyMemo(function () { return jtv.constant(undefined); }),
   keyEncode: function () { throw 'EncodeError'; },
   decoder: damlTypes.lazyMemo(function () { return jtv.object({context: Fairmint_OpenCapTable_Types.Context.decoder, exercise_data: exports.OcfEquityCompensationExerciseData.decoder, }); }),
@@ -62,23 +80,5 @@ exports.EquityCompensationExercise = damlTypes.assembleTemplate(
 );
 
 
-damlTypes.registerTemplate(exports.EquityCompensationExercise, ['c3614dff0d0574cbb00d6141ef5a71909a44a16e19667adb3abdb572ee7f0b4d', '#OpenCapTable-v22']);
-
-
-
-exports.OcfEquityCompensationExerciseData = {
-  decoder: damlTypes.lazyMemo(function () { return jtv.object({ocf_id: damlTypes.Text.decoder, date: damlTypes.Time.decoder, security_id: damlTypes.Text.decoder, quantity: damlTypes.Numeric(10).decoder, consideration_text: jtv.Decoder.withDefault(null, damlTypes.Optional(damlTypes.Text).decoder), resulting_security_ids: damlTypes.List(damlTypes.Text).decoder, comments: damlTypes.List(damlTypes.Text).decoder, }); }),
-  encode: function (__typed__) {
-  return {
-    ocf_id: damlTypes.Text.encode(__typed__.ocf_id),
-    date: damlTypes.Time.encode(__typed__.date),
-    security_id: damlTypes.Text.encode(__typed__.security_id),
-    quantity: damlTypes.Numeric(10).encode(__typed__.quantity),
-    consideration_text: damlTypes.Optional(damlTypes.Text).encode(__typed__.consideration_text),
-    resulting_security_ids: damlTypes.List(damlTypes.Text).encode(__typed__.resulting_security_ids),
-    comments: damlTypes.List(damlTypes.Text).encode(__typed__.comments),
-  };
-}
-,
-};
+damlTypes.registerTemplate(exports.EquityCompensationExercise, ['2a4643064cabdaa1562186b34da3c4de4e3a0b03c82a66d634e8fc4bd974aaa5', '#OpenCapTable-v24']);