@fairmint/open-captable-protocol-daml-js 0.2.96 → 0.2.97

package/README.md

@@ -5,21 +5,27 @@
 - **Start here**: `llms.txt`
 - **Docs folder**: `docs/README.md` (optional; keep minimal)
 
-This repository contains multiple DAML packages (e.g., `OpenCapTable-v26`, `OpenCapTableReports-v01`, `OpenCapTableProofOfOwnership-v01`, `Shared`, `CantonPayments`). This document defines coding guidelines that apply to all packages.
+This repository contains multiple DAML packages (e.g., `OpenCapTable-v26`,
+`OpenCapTableReports-v01`, `OpenCapTableProofOfOwnership-v01`, `Shared`, `CantonPayments`). 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-v26/README.md`).
+For package-specific details about each implementation, see the README.md file in the respective
+package directory (e.g., `open-captable-protocol-daml/OpenCapTable-v26/README.md`).
 
 ### Global exceptions
 
-- We use DAML `Time` instead of schema `Date` (schema excludes time) as a workaround for a JavaScript parsing issue.
+- 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:
+- **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
@@ -29,17 +35,23 @@ 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.
+  - 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.
+    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)`
     - `-- ---------------------------------`
@@ -47,8 +59,11 @@ validateOcfMd5 md5 =
     - `-- ---------------------------------`
     - `-- 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:
+- **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)
@@ -56,24 +71,30 @@ 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).
+- **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-v26/README.md` for Open Cap Table specifics (e.g., Issuer management patterns).
+- `open-captable-protocol-daml/OpenCapTable-v26/README.md` for Open Cap Table specifics (e.g.,
+  Issuer management patterns).
 - Other package READMEs as applicable.
 
 ## Adding Support for New Packages
 
-When adding a new DAML package to this repository (e.g., `NewPackage-v01`), follow these steps to ensure full integration with the build, deployment, and publishing pipeline:
+When adding a new DAML package to this repository (e.g., `NewPackage-v01`), follow these steps to
+ensure full integration with the build, deployment, and publishing pipeline:
 
 ### 1. Create the Package Directory
 
-Create a new directory at the root level with your package name and version (e.g., `NewPackage-v01/`).
+Create a new directory at the root level with your package name and version (e.g.,
+`NewPackage-v01/`).
 
 ### 2. Set Up Package Structure
 
@@ -86,6 +107,7 @@ Create a new directory at the root level with your package name and version (e.g
 Update the following files to include your new package:
 
 #### `package.json`
+
 - **codegen script**: Add codegen step for your package in the `codegen` script
   ```
   cd NewPackage-v01 && daml codegen js && cd ..
@@ -122,7 +144,9 @@ Update the following files to include your new package:
   ```
 
 #### `scripts/bundle-dependencies.ts`
+
 Add your package directory to the `PACKAGE_DIRS` array:
+
 ```typescript
 const PACKAGE_DIRS = [
   path.join(__dirname, '../generated/js/OpenCapTable-v26-0.0.1'),
@@ -132,7 +156,9 @@ const PACKAGE_DIRS = [
 ```
 
 #### `scripts/create-package-index.ts`
+
 Add your package directory to the `packageDirs` array:
+
 ```typescript
 const packageDirs = [
   path.join(__dirname, '..', 'generated', 'js', 'OpenCapTable-v26-0.0.1'),
@@ -142,23 +168,30 @@ const packageDirs = [
 ```
 
 #### `scripts/create-root-index.ts`
+
 1. Add constants for your package directories:
+
    ```typescript
    const NEWPACKAGE_DIR = path.join(ROOT_DIR, 'generated', 'js', 'NewPackage-v01-0.0.1');
    const NEWPACKAGE_LIB = path.join(NEWPACKAGE_DIR, 'lib');
    ```
 
 2. Copy your package namespace in `buildCombinedLib()`:
+
    ```typescript
-   copyDir(path.join(NEWPACKAGE_LIB, 'Fairmint', 'NewPackage'), path.join(destFairmint, 'NewPackage'));
+   copyDir(
+     path.join(NEWPACKAGE_LIB, 'Fairmint', 'NewPackage'),
+     path.join(destFairmint, 'NewPackage')
+   );
    ```
 
 3. Update Fairmint index files to export your namespace:
+
    ```typescript
    // In index.js:
    var NewPackage = require('./NewPackage');
    exports.NewPackage = NewPackage;
-   
+
    // In index.d.ts:
    export * as NewPackage from './NewPackage';
    ```
@@ -177,17 +210,22 @@ const packageDirs = [
 Create two new scripts in the `scripts/` directory:
 
 #### `scripts/upload-dar-newpackage.ts`
-Upload the DAR file to both devnet and mainnet. Use existing scripts as templates (e.g., `upload-dar-reports.ts`).
+
+Upload the DAR file to both devnet and mainnet. Use existing scripts as templates (e.g.,
+`upload-dar-reports.ts`).
 
 Key elements:
+
 - Parse `--network` argument
 - Upload to both `intellect` and `5n` providers
 - Point to correct DAR file path: `NewPackage-v01/.daml/dist/NewPackage-v01-{version}.dar`
 
 #### `scripts/create-newpackage-factory.ts`
+
 Create factory contract on both networks. Use existing factory scripts as templates.
 
 Key elements:
+
 - Import generated DAML types from `../lib`
 - Create factory contract with appropriate arguments
 - Save contract ID to `generated/newpackage-factory-contract-id.json`
@@ -196,11 +234,13 @@ Key elements:
 ### 5. Test the Integration
 
 1. Build DAML packages:
+
    ```bash
    npm run build
    ```
 
 2. Generate JavaScript bindings:
+
    ```bash
    npm run codegen
    ```
@@ -217,5 +257,3 @@ Key elements:
 - Add package to the list in this README's introduction
 - Create package-specific README with domain guidance
 - Document any new contract templates and their usage
-
-

package/package.json

@@ -1,9 +1,20 @@
 {
   "name": "@fairmint/open-captable-protocol-daml-js",
-  "version": "0.2.96",
+  "version": "0.2.97",
   "description": "Open CapTable Protocol DAML smart contracts with generated JavaScript bindings.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "keywords": [
+    "daml",
+    "opencaptable",
+    "blockchain",
+    "smart-contracts",
+    "fairmint"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fairmint/open-captable-protocol-daml.git"
+  },
+  "license": "UNLICENSED",
+  "author": "Fairmint",
   "exports": {
     ".": {
       "types": "./lib/index.d.ts",
@@ -27,6 +38,21 @@
       "default": "./generated/paymentStreams-factory-contract-id.json"
     }
   },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "ocp-factory-contract-id.json": [
+        "generated/ocp-factory-contract-id.json.d.ts"
+      ],
+      "reports-factory-contract-id.json": [
+        "generated/reports-factory-contract-id.json.d.ts"
+      ],
+      "paymentStreams-factory-contract-id.json": [
+        "generated/paymentStreams-factory-contract-id.json.d.ts"
+      ]
+    }
+  },
   "files": [
     "lib/**",
     "generated/ocp-factory-contract-id.json",
@@ -38,25 +64,30 @@
     "OpenCapTable-v26/.daml/dist/OpenCapTable-v26-0.0.1.dar"
   ],
   "scripts": {
+    "backup-dar": "tsx scripts/backup-dar.ts",
     "build": "tsx scripts/codegen/generate-captable.ts && daml build --all",
     "build:ts": "tsc",
     "clean": "daml clean --all",
     "codegen": "npm run build && cd OpenCapTable-v26 && daml codegen js && cd .. && cd Shared && daml codegen js && cd .. && cd OpenCapTableReports-v01 && daml codegen js && cd .. && cd CantonPayments && daml codegen js && cd .. && tsx scripts/bundle-dependencies.ts && tsx scripts/create-package-index.ts && tsx scripts/create-root-index.ts && tsx scripts/fix-splice-refs.ts && npm run build:ts",
-    "test": "cd Test && daml test --show-coverage --color --coverage-ignore-choice splice-amulet:.*",
-    "test:imports": "tsx scripts/test-imports.ts",
-    "backup-dar": "tsx scripts/backup-dar.ts",
-    "verify-dars": "tsx scripts/verify-dars.ts",
-    "upload-dar": "tsx scripts/upload-dar.ts",
+    "create-couponMinter": "tsx scripts/create-couponMinter.ts",
     "create-factory:ocp": "npm run codegen && tsx scripts/create-ocp-factory.ts --network devnet && tsx scripts/create-ocp-factory.ts --network mainnet",
-    "create-factory:reports": "npm run codegen && tsx scripts/create-reports-factory.ts --network devnet && tsx scripts/create-reports-factory.ts --network mainnet",
     "create-factory:paymentStreams": "npm run codegen && tsx scripts/create-paymentStreams-factory.ts --network devnet && tsx scripts/create-paymentStreams-factory.ts --network mainnet",
-    "create-couponMinter": "tsx scripts/create-couponMinter.ts",
-    "update-version": "tsx scripts/update-generated-package.ts",
-    "prepare-release": "tsx scripts/prepare-release.ts",
-    "package:publish": "npm run package:manifest && npm publish",
+    "create-factory:reports": "npm run codegen && tsx scripts/create-reports-factory.ts --network devnet && tsx scripts/create-reports-factory.ts --network mainnet",
+    "fix": "npm run lint:fix && npm run format:fix",
+    "format": "prettier --check .",
+    "format:fix": "prettier --write .",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "package:manifest": "npm run package:prep && npm pack --dry-run --json --ignore-scripts > /tmp/npm-pack.json 2>/dev/null && jq -r '.[0].files[].path' /tmp/npm-pack.json | sort | tsx scripts/collapse-manifest.ts > generated/npm-manifest.txt",
     "package:prep": "npm run codegen && npm run update-version && tsx scripts/bundle-dependencies.ts && tsx scripts/create-package-index.ts && tsx scripts/create-root-index.ts && tsx scripts/fix-splice-refs.ts",
-    "upgrade-package": "tsx scripts/upgrade-package.ts"
+    "package:publish": "npm run package:manifest && npm publish",
+    "prepare-release": "tsx scripts/prepare-release.ts",
+    "test": "cd Test && daml test --show-coverage --color --coverage-ignore-choice splice-amulet:.*",
+    "test:imports": "tsx scripts/test-imports.ts",
+    "update-version": "tsx scripts/update-generated-package.ts",
+    "upgrade-package": "tsx scripts/upgrade-package.ts",
+    "upload-dar": "tsx scripts/upload-dar.ts",
+    "verify-dars": "tsx scripts/verify-dars.ts"
   },
   "dependencies": {
     "@daml/ledger": "2.10.3",
@@ -65,7 +96,18 @@
   },
   "devDependencies": {
     "@types/node": "25.0.6",
+    "@typescript-eslint/eslint-plugin": "8.53.0",
+    "@typescript-eslint/parser": "8.53.0",
+    "eslint": "9.39.2",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-import-resolver-typescript": "4.4.4",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-unused-imports": "4.3.0",
     "handlebars": "^4.7.8",
+    "prettier": "3.7.4",
+    "prettier-plugin-jsdoc": "1.8.0",
+    "prettier-plugin-organize-imports": "4.3.0",
+    "prettier-plugin-packagejson": "2.5.21",
     "ts-node": "10.9.2",
     "tsx": "4.21.0",
     "typescript": "5.9.3",
@@ -75,33 +117,7 @@
     "@daml/ledger": "2.10.3",
     "@daml/types": "3.4.10"
   },
-  "keywords": [
-    "daml",
-    "opencaptable",
-    "blockchain",
-    "smart-contracts",
-    "fairmint"
-  ],
-  "author": "Fairmint",
-  "license": "UNLICENSED",
   "publishConfig": {
     "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/fairmint/open-captable-protocol-daml.git"
-  },
-  "typesVersions": {
-    "*": {
-      "ocp-factory-contract-id.json": [
-        "generated/ocp-factory-contract-id.json.d.ts"
-      ],
-      "reports-factory-contract-id.json": [
-        "generated/reports-factory-contract-id.json.d.ts"
-      ],
-      "paymentStreams-factory-contract-id.json": [
-        "generated/paymentStreams-factory-contract-id.json.d.ts"
-      ]
-    }
   }
 }