add @lfdecentralizedtrust namespace to a few local packages (#2208)

stephencompall-DA · web-flow · commit 4aa118775e49 · 2025-09-11T16:04:24.000-04:00
- transfer-instruction-openapi
- canton-json-api-v2
- canton-json-api-v2-openapi
- openapi-ts-client

* update package-locks

* force all sbt openapi typescript builds to be namespace-prefixed

- we don't ever use different moduleName, projectName; remove these
  params
- push the scope addition into the utility function; it is and should
  always be used
- indirectly prove there are no more usages (at least for typescript
  gen) that don't add the namespace

* add token-standard to npm cache key

---------

Signed-off-by: Stephen Compall &lt;stephen.compall@digitalasset.com&gt;
diff --git a/.github/actions/cache/frontend_node_modules/restore/action.yml b/.github/actions/cache/frontend_node_modules/restore/action.yml
diff --git a/.github/actions/cache/frontend_node_modules/save/action.yml b/.github/actions/cache/frontend_node_modules/save/action.yml
diff --git a/apps/ans/frontend/package.json b/apps/ans/frontend/package.json
@@ -23,7 +23,7 @@
     "@mui/material": "^5.17.1",
     "@tanstack/react-query": "5.72.2",
     "oidc-client-ts": "2.2.1",
-    "openapi-ts-client": "file:../openapi-ts-client/dist",
+    "@lfdecentralizedtrust/openapi-ts-client": "file:../openapi-ts-client/dist",
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "react-helmet-async": "^2.0.5",
diff --git a/apps/package-lock.json b/apps/package-lock.json
diff --git a/build.sbt b/build.sbt
@@ -338,12 +338,8 @@ lazy val `splice-api-token-transfer-instruction-v1-daml` =
           val transferInstructionOpenApiFile =
             baseDirectory.value / "openapi/transfer-instruction-v1.yaml"
 
-          val npmName = "transfer-instruction-openapi"
-
           BuildCommon.TS.generateOpenApiClient(
-            npmName = npmName,
-            npmModuleName = npmName,
-            npmProjectName = npmName,
+            unscopedNpmName = "transfer-instruction-openapi",
             openApiSpec = "transfer-instruction-v1.yaml",
             cacheFileDependencies = Set(transferInstructionOpenApiFile),
             directory = "openapi-ts-client",
@@ -461,12 +457,8 @@ lazy val `canton-json-api-v2-openapi-ts-client` = project
       Def.taskDyn {
         val openApiFile = baseDirectory.value / "openapi.yaml"
 
-        val npmName = "canton-json-api-v2"
-
         BuildCommon.TS.generateOpenApiClient(
-          npmName = npmName,
-          npmModuleName = npmName,
-          npmProjectName = npmName,
+          unscopedNpmName = "canton-json-api-v2",
           openApiSpec = "openapi.yaml",
           cacheFileDependencies = Set(openApiFile),
           directory = "openapi-ts-client",
@@ -940,16 +932,16 @@ lazy val `apps-validator` =
       BuildCommon.sharedAppSettings,
       templateDirectory := (`openapi-typescript-template` / patchTemplate).value,
       BuildCommon.TS.openApiSettings(
-        npmName = "@lfdecentralizedtrust/validator-openapi",
+        unscopedNpmName = "validator-openapi",
         openApiSpec = "validator-internal.yaml",
       ),
       BuildCommon.TS.openApiSettings(
-        npmName = "@lfdecentralizedtrust/ans-external-openapi",
+        unscopedNpmName = "ans-external-openapi",
         openApiSpec = "ans-external.yaml",
         directory = "external-openapi-ts-client",
       ),
       BuildCommon.TS.openApiSettings(
-        npmName = "@lfdecentralizedtrust/scan-proxy-openapi",
+        unscopedNpmName = "scan-proxy-openapi",
         openApiSpec = "scan-proxy.yaml",
         directory = "scan-proxy-openapi-ts-client",
       ),
@@ -991,7 +983,7 @@ lazy val `apps-sv` =
       BuildCommon.sharedAppSettings,
       templateDirectory := (`openapi-typescript-template` / patchTemplate).value,
       BuildCommon.TS.openApiSettings(
-        npmName = "@lfdecentralizedtrust/sv-openapi",
+        unscopedNpmName = "sv-openapi",
         openApiSpec = "sv-internal.yaml",
       ),
       Compile / guardrailTasks :=
@@ -1017,7 +1009,7 @@ lazy val `apps-scan` =
       BuildCommon.sharedAppSettings,
       templateDirectory := (`openapi-typescript-template` / patchTemplate).value,
       BuildCommon.TS.openApiSettings(
-        npmName = "@lfdecentralizedtrust/scan-openapi",
+        unscopedNpmName = "scan-openapi",
         openApiSpec = "scan.yaml",
       ),
       Compile / guardrailTasks :=
@@ -1396,12 +1388,12 @@ lazy val `apps-wallet` =
       BuildCommon.sharedAppSettings,
       templateDirectory := (`openapi-typescript-template` / patchTemplate).value,
       BuildCommon.TS.openApiSettings(
-        npmName = "@lfdecentralizedtrust/wallet-external-openapi",
+        unscopedNpmName = "wallet-external-openapi",
         openApiSpec = "wallet-external.yaml",
         directory = "external-openapi-ts-client",
       ),
       BuildCommon.TS.openApiSettings(
-        npmName = "@lfdecentralizedtrust/wallet-openapi",
+        unscopedNpmName = "wallet-openapi",
         openApiSpec = "wallet-internal.yaml",
       ),
       Compile / guardrailTasks :=
@@ -1434,7 +1426,7 @@ lazy val `apps-splitwell` =
       libraryDependencies ++= Seq(scalapb_runtime_grpc, scalapb_runtime),
       templateDirectory := (`openapi-typescript-template` / patchTemplate).value,
       BuildCommon.TS.openApiSettings(
-        npmName = "@lfdecentralizedtrust/splitwell-openapi",
+        unscopedNpmName = "splitwell-openapi",
         openApiSpec = "splitwell-internal.yaml",
       ),
       BuildCommon.sharedAppSettings,
diff --git a/party-allocator/package-lock.json b/party-allocator/package-lock.json
diff --git a/party-allocator/package.json b/party-allocator/package.json
@@ -18,10 +18,10 @@
   "devDependencies": {
     "@types/node": "^24.3.1",
     "@typescript-eslint/eslint-plugin": "^7.7.1",
-    "canton-json-api-v2-openapi": "file:../token-standard/dependencies/canton-json-api-v2/openapi-ts-client",
+    "@lfdecentralizedtrust/canton-json-api-v2-openapi": "file:../token-standard/dependencies/canton-json-api-v2/openapi-ts-client",
     "eslint": "^8.57.1",
     "prettier": "^3.6.2",
-    "transfer-instruction-openapi": "file:../token-standard/splice-api-token-transfer-instruction-v1/openapi-ts-client",
+    "@lfdecentralizedtrust/transfer-instruction-openapi": "file:../token-standard/splice-api-token-transfer-instruction-v1/openapi-ts-client",
     "typescript": "^5.7.3",
     "zod": "^4.1.5"
   },
diff --git a/party-allocator/src/index.ts b/party-allocator/src/index.ts
@@ -2,7 +2,10 @@
 // SPDX-License-Identifier: Apache-2.0
 import { LedgerApiClient } from "./ledger-api-client.js";
 import * as crypto from "node:crypto";
-import { Command, DisclosedContract } from "canton-json-api-v2-openapi";
+import {
+  Command,
+  DisclosedContract,
+} from "@lfdecentralizedtrust/canton-json-api-v2-openapi";
 import { readdir, writeFile } from "node:fs/promises";
 import { config } from "./config.js";
 import fs from "fs";
diff --git a/party-allocator/src/ledger-api-client.ts b/party-allocator/src/ledger-api-client.ts
@@ -15,7 +15,7 @@ import {
   Signature,
   SignedTransaction,
   SigningPublicKey,
-} from "canton-json-api-v2-openapi";
+} from "@lfdecentralizedtrust/canton-json-api-v2-openapi";
 import { AsyncLocalStorage } from "node:async_hooks";
 import * as crypto from "node:crypto";
 
diff --git a/project/BuildCommon.scala b/project/BuildCommon.scala
@@ -1672,7 +1672,7 @@ object BuildCommon {
       Some(workingDir),
     )
     def openApiSettings(
-        npmName: String,
+        unscopedNpmName: String,
         openApiSpec: String,
         directory: String = "openapi-ts-client",
     ): Seq[Setting[_]] = Seq(
@@ -1684,9 +1684,7 @@ object BuildCommon {
             baseDirectory.value / ".." / "common/src/main/openapi/common-external.yaml"
 
           generateOpenApiClient(
-            npmName = npmName,
-            npmModuleName = npmName,
-            npmProjectName = npmName,
+            unscopedNpmName = unscopedNpmName,
             openApiSpec = openApiSpec,
             cacheFileDependencies = Set(commonInternalOpenApiFile, commonExternalOpenApiFile),
             directory = directory,
@@ -1697,9 +1695,7 @@ object BuildCommon {
     )
 
     def generateOpenApiClient(
-        npmName: String,
-        npmModuleName: String,
-        npmProjectName: String,
+        unscopedNpmName: String,
         openApiSpec: String,
         cacheFileDependencies: Set[File] = Set.empty[File],
         directory: String,
@@ -1709,6 +1705,7 @@ object BuildCommon {
       val log = streams.value.log
       val cacheDir = streams.value.cacheDirectory / directory
 
+      val npmName = s"@lfdecentralizedtrust/$unscopedNpmName"
       val openApiSpecFile = baseDirectory.value / subPath / openApiSpec
       val template = templateDirectory.value
       val outputDir = outputPrefix.fold(baseDirectory.value)(new java.io.File(_)) / directory
@@ -1724,9 +1721,9 @@ object BuildCommon {
             "-p",
             s"npmName=$npmName",
             "-p",
-            s"moduleName=$npmModuleName",
+            s"moduleName=$npmName",
             "-p",
-            s"projectName=$npmProjectName",
+            s"projectName=$npmName",
             "-p",
             "enumPropertyNaming=original",
             "-p",
diff --git a/token-standard/cli/package.json b/token-standard/cli/package.json
@@ -21,10 +21,10 @@
   "description": "",
   "dependencies": {
     "bignumber.js": "^9.2.1",
-    "canton-json-api-v2-openapi": "file:../dependencies/canton-json-api-v2/openapi-ts-client",
+    "@lfdecentralizedtrust/canton-json-api-v2-openapi": "file:../dependencies/canton-json-api-v2/openapi-ts-client",
     "commander": "^13.1.0",
     "dayjs": "^1.11.13",
-    "transfer-instruction-openapi": "file:../splice-api-token-transfer-instruction-v1/openapi-ts-client"
+    "@lfdecentralizedtrust/transfer-instruction-openapi": "file:../splice-api-token-transfer-instruction-v1/openapi-ts-client"
   },
   "devDependencies": {
     "@types/node": "^22.13.5",
diff --git a/token-standard/cli/src/apis/ledger-api-utils.ts b/token-standard/cli/src/apis/ledger-api-utils.ts
@@ -21,8 +21,8 @@ import {
   PartySignatures,
   ServerConfiguration,
   TransactionFilter,
-} from "canton-json-api-v2-openapi";
-import { DisclosedContract } from "transfer-instruction-openapi";
+} from "@lfdecentralizedtrust/canton-json-api-v2-openapi";
+import { DisclosedContract } from "@lfdecentralizedtrust/transfer-instruction-openapi";
 import { randomUUID } from "node:crypto";
 import { readFileSync } from "node:fs";
 import crypto from "crypto";
diff --git a/token-standard/cli/src/commands/acceptTransferInstruction.ts b/token-standard/cli/src/commands/acceptTransferInstruction.ts
@@ -6,12 +6,12 @@ import {
 } from "../apis/ledger-api-utils";
 import { TransferInstructionInterface } from "../constants";
 import { CommandOptions } from "../token-standard-cli";
-import { ExerciseCommand } from "canton-json-api-v2-openapi";
+import { ExerciseCommand } from "@lfdecentralizedtrust/canton-json-api-v2-openapi";
 import {
   createConfiguration,
   DefaultApi as TransferFactoryAPI,
   ServerConfiguration,
-} from "transfer-instruction-openapi";
+} from "@lfdecentralizedtrust/transfer-instruction-openapi";
 
 interface AcceptTransferInstructionCommandOptions {
   // paths to keys
diff --git a/token-standard/cli/src/commands/listContractsByInterface.ts b/token-standard/cli/src/commands/listContractsByInterface.ts
@@ -7,7 +7,7 @@ import {
 } from "../apis/ledger-api-utils";
 import { InterfaceId } from "../constants";
 import { CommandOptions } from "../token-standard-cli";
-import { JsGetActiveContractsResponse } from "canton-json-api-v2-openapi";
+import { JsGetActiveContractsResponse } from "@lfdecentralizedtrust/canton-json-api-v2-openapi";
 
 export async function listContractsByInterface(
   interfaceId: InterfaceId,
diff --git a/token-standard/cli/src/commands/listHoldingTransactions.ts b/token-standard/cli/src/commands/listHoldingTransactions.ts
@@ -12,7 +12,7 @@ import { renderTransaction, Transaction } from "../txparse/types";
 import {
   DefaultApi as LedgerJsonApi,
   JsGetUpdatesResponse,
-} from "canton-json-api-v2-openapi";
+} from "@lfdecentralizedtrust/canton-json-api-v2-openapi";
 import fs from "fs";
 
 export async function listHoldingTransactions(
diff --git a/token-standard/cli/src/commands/transfer.ts b/token-standard/cli/src/commands/transfer.ts
@@ -1,12 +1,12 @@
 // Copyright (c) 2024 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { ExerciseCommand } from "canton-json-api-v2-openapi";
+import { ExerciseCommand } from "@lfdecentralizedtrust/canton-json-api-v2-openapi";
 import dayjs from "dayjs";
 import {
   createConfiguration,
   ServerConfiguration,
   DefaultApi as TransferFactoryAPI,
-} from "transfer-instruction-openapi";
+} from "@lfdecentralizedtrust/transfer-instruction-openapi";
 import {
   createLedgerApiClient,
   filtersByParty,
diff --git a/token-standard/cli/src/txparse/parser.ts b/token-standard/cli/src/txparse/parser.ts
@@ -39,7 +39,7 @@ import {
   ExercisedEvent as LedgerApiExercisedEvent,
   JsGetEventsByContractIdResponse,
   JsTransaction,
-} from "canton-json-api-v2-openapi";
+} from "@lfdecentralizedtrust/canton-json-api-v2-openapi";
 
 export class TransactionParser {
   private readonly ledgerClient: LedgerJsonApi;
diff --git a/token-standard/package-lock.json b/token-standard/package-lock.json
