You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add DeriveNpmPackage and DeriveTsImport to derive scoped npm package
names (@<org>/<domain>-<name>-<line>-proto) from API identity. Extend
all display, manifest, and unlink surfaces. Promote TypeScript from
Planned to Tier 2 in docs.
Java developers never interact with Go modules or `go.work`. The Maven coordinate system provides a complete, self-contained experience.
72
73
73
-
## TypeScript Workflow (Planned)
74
+
## TypeScript Workflow
74
75
75
-
TypeScript support will follow the same pattern: npm packages as the published artifact, local linking via `npm link` or workspace references, and identity derivation for npm scope/package names.
76
+
TypeScript uses npm packages as the published artifact with scoped package names:
77
+
78
+
1.**Producer** releases schema artifacts to an npm registry via APX's release pipeline. The npm package name is deterministically derived: `@<org>/<domain>-<name>-<line>-proto`.
79
+
2.**Consumer** installs the package using `npm install @<org>/<domain>-<name>-<line>-proto`.
80
+
3. For local development, `apx link typescript` (planned) links local schema artifacts via `npm link`, allowing resolution without a remote registry.
81
+
4.`apx unlink` removes the local link; `npm install @<org>/<pkg>` adds the released package. Import paths stay the same.
82
+
83
+
TypeScript developers import generated types directly from the npm package name:
Copy file name to clipboardExpand all lines: docs/dependencies/code-generation.md
+41-1Lines changed: 41 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ apx gen <lang> [path]
10
10
11
11
The `apx gen` command reads your schemas from `internal/apis/`, generates code using format-specific toolchains (e.g. Buf for protobuf), and writes the output to `internal/gen/<lang>/` with canonical module paths.
0 commit comments