@palantir/pack.sdkgen.pack-versioned-template 0.0.1

package/template/README.md.ejs

@@ -0,0 +1,76 @@
+# <%= projectName %>
+
+<%= answers.description || 'Generated versioned SDK from IR' %>
+
+## Usage
+
+```typescript
+import {
+  DocumentModel,
+  asVersioned,
+  matchVersion,
+  type VersionedDocRef,
+} from "<%= projectName %>";
+```
+
+## Generated Source
+
+This SDK was generated from a versioned IR JSON file (produced by
+`type-gen schema ir` from a TypeScript schema module that uses
+`@palantir/pack.schema` builders). The output covers every supported schema
+version:
+
+- Per-version read types: `types_v1.ts`, `types_v2.ts`, ...
+- Per-version write types: `writeTypes_v1.ts`, `writeTypes_v2.ts`, ...
+- Per-version Zod schemas: `schema_v1.ts`, `schema_v2.ts`, ...
+- Internal upgrade machinery: `_internal/types.ts`, `_internal/upgrades.ts`, `_internal/schema.ts`
+- `versions.ts` — `SupportedVersions`, `LatestVersion`, `MinSupportedVersion`
+- `versionedDocRef.ts` — `VersionedDocRef`, `asVersioned`, `matchVersion`
+- `models.ts` — runtime model constants and `DocumentModel`
+- `types.ts` / `schema.ts` — re-exports under unversioned names
+- `index.ts` — barrel
+
+It should be depended on as a package in your project, but not modified
+directly so it can be regenerated cleanly.
+
+## Development
+
+### Build
+
+```bash
+pnpm build
+```
+
+### Type Check
+
+```bash
+pnpm typecheck
+```
+
+## Regenerating
+
+First emit the IR from your schema package:
+
+```bash
+type-gen schema ir -i ./path/to/schema.mjs -o build/ir.json
+```
+
+Then regenerate this SDK from the IR:
+
+```bash
+pnpm exec sdkgen create "./this-package" \
+  --template @palantir/pack.sdkgen.pack-versioned-template \
+  --schema ./path/to/build/ir.json \
+  --config pack-config.json \
+  --overwrite
+```
+
+<% if (answers.author) { %>
+## Author
+
+<%= answers.author %>
+<% } %>
+
+## License
+
+UNLICENSED

package/template/_gitignore

@@ -0,0 +1,7 @@
+node_modules/
+build/
+dist/
+*.tgz
+*.log
+.DS_Store
+tsconfig.tsbuildinfo

package/template/package.json.ejs

@@ -0,0 +1,33 @@
+{
+  "name": "<%= answers.packageName || projectName %>",
+  "private": true,
+  "version": "0.0.1",
+  "description": "<%= answers.description || 'Generated versioned SDK from IR' %>",
+  <% if (answers.author) { %>"author": "<%= answers.author %>",<% } %>
+  "license": "UNLICENSED",
+  "exports": {
+    ".": {
+      "types": "./build/types/index.d.ts",
+      "default": "./build/esm/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf build dist *.tgz tsconfig.tsbuildinfo",
+    "transpileTypes": "tsc --emitDeclarationOnly",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@palantir/pack.document-schema.model-types": "latest"
+  },
+  "peerDependencies": {
+    "zod": "^4.1.7"
+  },
+  "devDependencies": {
+    "@types/node": "^22.12.0",
+    "typescript": "^5.9.2"
+  },
+  "main": "./build/esm/index.js",
+  "types": "./build/types/index.d.ts",
+  "type": "module"
+}

package/template/src/index.ts

@@ -0,0 +1,2 @@
+// This file will be overwritten by the versioned SDK generator.
+export {};

package/template/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "nodenext",
+    "lib": ["ES2022"],
+    "moduleResolution": "nodenext",
+    "rootDir": "./src",
+    "outDir": "./build/esm",
+    "declarationDir": "./build/types",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["./src/**/*"],
+  "exclude": ["node_modules", "build", "dist"]
+}

package/template.config.js

@@ -0,0 +1 @@
+export { config as default } from "./build/esm/config.js";