@palantir/pack.document-schema.type-gen 0.11.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/build/esm/commands/asset/assetDeployHandler.js +1 -1
  2. package/build/esm/commands/asset/assetDeployHandler.js.map +1 -1
  3. package/build/esm/commands/asset/assetUpdateSchemaHandler.js +1 -1
  4. package/build/esm/commands/asset/assetUpdateSchemaHandler.js.map +1 -1
  5. package/build/esm/commands/ir/irGenAssetHandler.js +81 -12
  6. package/build/esm/commands/ir/irGenAssetHandler.js.map +1 -1
  7. package/build/esm/commands/ir/irGenTypesHandler.js +10 -8
  8. package/build/esm/commands/ir/irGenTypesHandler.js.map +1 -1
  9. package/build/esm/commands/ir/registerIrCommands.js +2 -2
  10. package/build/esm/commands/ir/registerIrCommands.js.map +1 -1
  11. package/build/esm/commands/schema/__tests__/readPackConfig.test.js +112 -0
  12. package/build/esm/commands/schema/__tests__/readPackConfig.test.js.map +1 -0
  13. package/build/esm/commands/schema/registerSchemaCommands.js +1 -1
  14. package/build/esm/commands/schema/registerSchemaCommands.js.map +1 -1
  15. package/build/esm/commands/schema/schemaIrHandler.js +77 -11
  16. package/build/esm/commands/schema/schemaIrHandler.js.map +1 -1
  17. package/build/esm/commands/types.js.map +1 -1
  18. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/custom-discriminant.js +1 -1
  19. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/custom-discriminant.js.map +1 -1
  20. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/external-refs.js +1 -1
  21. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/external-refs.js.map +1 -1
  22. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/simple-record.js +1 -1
  23. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/simple-record.js.map +1 -1
  24. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/union-types.js +1 -1
  25. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/union-types.js.map +1 -1
  26. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/array-and-map-types.js +1 -1
  27. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/array-and-map-types.js.map +1 -1
  28. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/boolean-fields.js +1 -1
  29. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/boolean-fields.js.map +1 -1
  30. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/custom-discriminant.js +1 -1
  31. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/custom-discriminant.js.map +1 -1
  32. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/datetime-fields.js +1 -1
  33. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/datetime-fields.js.map +1 -1
  34. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/simple-records.js +1 -1
  35. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/simple-records.js.map +1 -1
  36. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/union-before-records.js +1 -1
  37. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/union-before-records.js.map +1 -1
  38. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/union-types.js +1 -1
  39. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/union-types.js.map +1 -1
  40. package/build/esm/utils/schema/__tests__/__snapshots__/generateDocumentTypeFromSchema/with-name-and-description.js +9 -0
  41. package/build/esm/utils/schema/__tests__/__snapshots__/generateDocumentTypeFromSchema/with-name-and-description.js.map +1 -0
  42. package/build/esm/utils/schema/__tests__/__snapshots__/generateVersionsFromSchema/single-version.js.map +1 -1
  43. package/build/esm/utils/schema/__tests__/__snapshots__/generateVersionsFromSchema/three-version-chain.js.map +1 -1
  44. package/build/esm/utils/schema/__tests__/__snapshots__/generateVersionsFromSchema/two-version.js.map +1 -1
  45. package/build/esm/utils/schema/__tests__/generateDocumentTypeFromSchema.test.js +34 -0
  46. package/build/esm/utils/schema/__tests__/generateDocumentTypeFromSchema.test.js.map +1 -0
  47. package/build/esm/utils/schema/__tests__/provenanceScenarios.test.js +184 -0
  48. package/build/esm/utils/schema/__tests__/provenanceScenarios.test.js.map +1 -0
  49. package/build/esm/utils/schema/__tests__/resolveSchemaChain.test.js +122 -0
  50. package/build/esm/utils/schema/__tests__/resolveSchemaChain.test.js.map +1 -0
  51. package/build/esm/utils/schema/generateDocumentTypeFromSchema.js +39 -0
  52. package/build/esm/utils/schema/generateDocumentTypeFromSchema.js.map +1 -0
  53. package/build/esm/utils/schema/generateIndexFromSchema.js +3 -1
  54. package/build/esm/utils/schema/generateIndexFromSchema.js.map +1 -1
  55. package/build/esm/utils/schema/generateInternalFromSchema.js +1 -1
  56. package/build/esm/utils/schema/generateInternalFromSchema.js.map +1 -1
  57. package/build/esm/utils/schema/generateScopeFromSchema.js +2 -2
  58. package/build/esm/utils/schema/generateScopeFromSchema.js.map +1 -1
  59. package/build/esm/utils/schema/loadSchemaModule.js +2 -5
  60. package/build/esm/utils/schema/loadSchemaModule.js.map +1 -1
  61. package/build/esm/utils/schema/resolveSchemaChain.js +104 -17
  62. package/build/esm/utils/schema/resolveSchemaChain.js.map +1 -1
  63. package/build/esm/utils/schema/runtimeSchema.js +3 -0
  64. package/build/esm/utils/schema/runtimeSchema.js.map +1 -1
  65. package/build/esm/utils/schema/writeAllSdkFiles.js +8 -8
  66. package/build/esm/utils/schema/writeAllSdkFiles.js.map +1 -1
  67. package/build/esm/utils/steps/__tests__/__snapshots__/types/arrayFields.js.map +1 -1
  68. package/build/esm/utils/steps/__tests__/__snapshots__/types/customDiscriminant.js +1 -1
  69. package/build/esm/utils/steps/__tests__/__snapshots__/types/customDiscriminant.js.map +1 -1
  70. package/build/esm/utils/steps/__tests__/__snapshots__/types/generateTypeScriptInterfaces.js +1 -1
  71. package/build/esm/utils/steps/__tests__/__snapshots__/types/generateTypeScriptInterfaces.js.map +1 -1
  72. package/build/esm/utils/steps/__tests__/__snapshots__/types/refTypes.js.map +1 -1
  73. package/build/esm/utils/steps/__tests__/__snapshots__/types/simpleRecord.js.map +1 -1
  74. package/build/esm/utils/steps/__tests__/__snapshots__/types/simpleSteps.js +1 -1
  75. package/build/esm/utils/steps/__tests__/__snapshots__/types/simpleSteps.js.map +1 -1
  76. package/build/esm/utils/steps/convertStepsToIr.js +49 -24
  77. package/build/esm/utils/steps/convertStepsToIr.js.map +1 -1
  78. package/build/types/commands/ir/irGenAssetHandler.d.ts +16 -5
  79. package/build/types/commands/ir/irGenAssetHandler.d.ts.map +1 -1
  80. package/build/types/commands/ir/irGenTypesHandler.d.ts +0 -1
  81. package/build/types/commands/ir/irGenTypesHandler.d.ts.map +1 -1
  82. package/build/types/commands/ir/registerIrCommands.d.ts.map +1 -1
  83. package/build/types/commands/schema/__tests__/readPackConfig.test.d.ts +2 -0
  84. package/build/types/commands/schema/__tests__/readPackConfig.test.d.ts.map +1 -0
  85. package/build/types/commands/schema/registerSchemaCommands.d.ts.map +1 -1
  86. package/build/types/commands/schema/schemaIrHandler.d.ts +28 -6
  87. package/build/types/commands/schema/schemaIrHandler.d.ts.map +1 -1
  88. package/build/types/commands/types.d.ts +3 -1
  89. package/build/types/commands/types.d.ts.map +1 -1
  90. package/build/types/utils/schema/__tests__/generateDocumentTypeFromSchema.test.d.ts +2 -0
  91. package/build/types/utils/schema/__tests__/generateDocumentTypeFromSchema.test.d.ts.map +1 -0
  92. package/build/types/utils/schema/__tests__/provenanceScenarios.test.d.ts +2 -0
  93. package/build/types/utils/schema/__tests__/provenanceScenarios.test.d.ts.map +1 -0
  94. package/build/types/utils/schema/__tests__/resolveSchemaChain.test.d.ts +2 -0
  95. package/build/types/utils/schema/__tests__/resolveSchemaChain.test.d.ts.map +1 -0
  96. package/build/types/utils/schema/generateDocumentTypeFromSchema.d.ts +17 -0
  97. package/build/types/utils/schema/generateDocumentTypeFromSchema.d.ts.map +1 -0
  98. package/build/types/utils/schema/generateIndexFromSchema.d.ts +1 -0
  99. package/build/types/utils/schema/generateIndexFromSchema.d.ts.map +1 -1
  100. package/build/types/utils/schema/loadSchemaModule.d.ts.map +1 -1
  101. package/build/types/utils/schema/resolveSchemaChain.d.ts +26 -1
  102. package/build/types/utils/schema/resolveSchemaChain.d.ts.map +1 -1
  103. package/build/types/utils/schema/runtimeSchema.d.ts +2 -0
  104. package/build/types/utils/schema/runtimeSchema.d.ts.map +1 -1
  105. package/build/types/utils/schema/writeAllSdkFiles.d.ts +0 -1
  106. package/build/types/utils/schema/writeAllSdkFiles.d.ts.map +1 -1
  107. package/build/types/utils/steps/convertStepsToIr.d.ts +19 -4
  108. package/build/types/utils/steps/convertStepsToIr.d.ts.map +1 -1
  109. package/package.json +4 -4
@@ -7,15 +7,30 @@ export interface SchemaMetadata {
7
7
  readonly description?: string;
8
8
  readonly version?: number;
9
9
  }
10
+ /**
11
+ * Per-field version provenance for a schema, keyed by model export key then
12
+ * field name. Supplied by the version-aware caller (`resolveSchemaChain`) so the
13
+ * IR records the version each field first appeared in (and any deprecation)
14
+ * instead of a placeholder. When omitted, fields fall back to the schema's
15
+ * top-level version (correct for single-version / steps-based callers).
16
+ */
17
+ export interface SchemaProvenance {
18
+ readonly fieldVersions?: Record<string, Record<string, number>>;
19
+ readonly modelVersions?: Record<string, number>;
20
+ readonly deprecations?: P.VersionDeprecations;
21
+ }
10
22
  /**
11
23
  * Converts migration steps to Palantir IR format
12
24
  */
13
25
  export declare function convertStepsToIr(steps: readonly MigrationStep[], metadata?: SchemaMetadata): IRealTimeDocumentSchema;
14
26
  /**
15
- * Converts record and union definitions to Palantir IR format
27
+ * Converts record and union definitions to Palantir IR format. When
28
+ * `provenance` is supplied (by the version-aware caller), each field/model is
29
+ * stamped with the version it first appeared in and any deprecation; otherwise
30
+ * everything falls back to `metadata.version` (default 1).
16
31
  */
17
- export declare function convertSchemaToIr(inputSchema: P.Schema<P.ReturnedSchema>, metadata?: SchemaMetadata): IRealTimeDocumentSchema;
18
- export declare function convertRecordDefToIr(recordDef: P.RecordDef, exportKey?: string, nameToExportKey?: Map<string, string>): IRecordDef;
19
- export declare function convertUnionDefToIr(unionDef: P.UnionDef, exportKey?: string, nameToExportKey?: Map<string, string>): IUnionDef;
32
+ export declare function convertSchemaToIr(inputSchema: P.Schema<P.ReturnedSchema>, metadata?: SchemaMetadata, provenance?: SchemaProvenance): IRealTimeDocumentSchema;
33
+ export declare function convertRecordDefToIr(recordDef: P.RecordDef, exportKey?: string, nameToExportKey?: Map<string, string>, fallbackVersion?: number, provenance?: SchemaProvenance): IRecordDef;
34
+ export declare function convertUnionDefToIr(unionDef: P.UnionDef, exportKey?: string, nameToExportKey?: Map<string, string>, fallbackVersion?: number, provenance?: SchemaProvenance): IUnionDef;
20
35
  export declare function convertTypeToFieldTypeUnion(schemaType: P.Type, nameToExportKey?: Map<string, string>): IFieldTypeUnion;
21
36
  //# sourceMappingURL=convertStepsToIr.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"convertStepsToIr.d.ts","sourceRoot":"","sources":["../../../../src/utils/steps/convertStepsToIr.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,CAAC,MAAM,uBAAuB,CAAC;AAMhD,OAAO,KAAK,EAEV,uBAAuB,EACvB,UAAU,EACV,SAAS,EACV,MAAM,yDAAyD,CAAC;AACjE,OAAO,EACL,eAAe,EAGhB,MAAM,yDAAyD,CAAC;AAGjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,SAAS,aAAa,EAAE,EAC/B,QAAQ,CAAC,EAAE,cAAc,GACxB,uBAAuB,CAUzB;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,EACvC,QAAQ,CAAC,EAAE,cAAc,GACxB,uBAAuB,CA6BzB;AAiCD,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,CAAC,CAAC,SAAS,EACtB,SAAS,CAAC,EAAE,MAAM,EAClB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GACpC,UAAU,CAiBZ;AAED,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,CAAC,CAAC,QAAQ,EACpB,SAAS,CAAC,EAAE,MAAM,EAClB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GACpC,SAAS,CAmBX;AAGD,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,CAAC,CAAC,IAAI,EAClB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GACpC,eAAe,CA+BjB"}
1
+ {"version":3,"file":"convertStepsToIr.d.ts","sourceRoot":"","sources":["../../../../src/utils/steps/convertStepsToIr.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,CAAC,MAAM,uBAAuB,CAAC;AAMhD,OAAO,KAAK,EAEV,uBAAuB,EACvB,UAAU,EACV,SAAS,EACV,MAAM,yDAAyD,CAAC;AACjE,OAAO,EACL,eAAe,EAGhB,MAAM,yDAAyD,CAAC;AAGjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAChE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChD,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,mBAAmB,CAAC;CAC/C;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,SAAS,aAAa,EAAE,EAC/B,QAAQ,CAAC,EAAE,cAAc,GACxB,uBAAuB,CAUzB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,EACvC,QAAQ,CAAC,EAAE,cAAc,EACzB,UAAU,CAAC,EAAE,gBAAgB,GAC5B,uBAAuB,CA8BzB;AAuCD,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,CAAC,CAAC,SAAS,EACtB,SAAS,CAAC,EAAE,MAAM,EAClB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EACrC,eAAe,GAAE,MAAU,EAC3B,UAAU,CAAC,EAAE,gBAAgB,GAC5B,UAAU,CA8BZ;AAED,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,CAAC,CAAC,QAAQ,EACpB,SAAS,CAAC,EAAE,MAAM,EAClB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EACrC,eAAe,GAAE,MAAU,EAC3B,UAAU,CAAC,EAAE,gBAAgB,GAC5B,SAAS,CAqBX;AAGD,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,CAAC,CAAC,IAAI,EAClB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GACpC,eAAe,CA+BjB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@palantir/pack.document-schema.type-gen",
3
- "version": "0.11.0",
3
+ "version": "0.13.0",
4
4
  "description": "TypeScript type generation from document schema",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -18,7 +18,7 @@
18
18
  },
19
19
  "dependencies": {
20
20
  "@osdk/client": "^2.5.2",
21
- "@osdk/foundry.pack": "^2.60.0",
21
+ "@osdk/foundry.pack": "^2.63.0",
22
22
  "commander": "^14.0.0",
23
23
  "conjure-client": "^2.15.0",
24
24
  "consola": "^3.4.2",
@@ -27,8 +27,8 @@
27
27
  "tiny-invariant": "^1.3.3",
28
28
  "yaml": "^2.8.2",
29
29
  "zod": "^4.1.13",
30
- "@palantir/pack.document-schema.model-types": "~0.10.0",
31
- "@palantir/pack.schema": "0.6.0"
30
+ "@palantir/pack.document-schema.model-types": "~0.12.0",
31
+ "@palantir/pack.schema": "0.8.0"
32
32
  },
33
33
  "devDependencies": {
34
34
  "@types/fs-extra": "^11.0.4",