@palantir/pack.document-schema.type-gen 0.12.0 → 0.14.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 (101) hide show
  1. package/build/esm/commands/asset/assetUpdateSchemaHandler.js +3 -2
  2. package/build/esm/commands/asset/assetUpdateSchemaHandler.js.map +1 -1
  3. package/build/esm/commands/ir/__tests__/resolveIrInput.test.js +88 -0
  4. package/build/esm/commands/ir/__tests__/resolveIrInput.test.js.map +1 -0
  5. package/build/esm/commands/ir/irDeployHandler.js +4 -3
  6. package/build/esm/commands/ir/irDeployHandler.js.map +1 -1
  7. package/build/esm/commands/ir/irGenAssetHandler.js +2 -31
  8. package/build/esm/commands/ir/irGenAssetHandler.js.map +1 -1
  9. package/build/esm/commands/ir/irGenTypesHandler.js +6 -6
  10. package/build/esm/commands/ir/irGenTypesHandler.js.map +1 -1
  11. package/build/esm/commands/ir/registerIrCommands.js +1 -1
  12. package/build/esm/commands/ir/registerIrCommands.js.map +1 -1
  13. package/build/esm/commands/ir/resolveIrInput.js +50 -0
  14. package/build/esm/commands/ir/resolveIrInput.js.map +1 -0
  15. package/build/esm/commands/schema/registerSchemaCommands.js +1 -1
  16. package/build/esm/commands/schema/registerSchemaCommands.js.map +1 -1
  17. package/build/esm/commands/schema/schemaIrHandler.js +14 -4
  18. package/build/esm/commands/schema/schemaIrHandler.js.map +1 -1
  19. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/custom-discriminant.js +1 -1
  20. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/custom-discriminant.js.map +1 -1
  21. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/external-refs.js +1 -1
  22. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/external-refs.js.map +1 -1
  23. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/simple-record.js +1 -1
  24. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/simple-record.js.map +1 -1
  25. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/union-types.js +1 -1
  26. package/build/esm/utils/ir/__tests__/__snapshots__/generateModelsFromIr/union-types.js.map +1 -1
  27. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/array-and-map-types.js +1 -1
  28. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/array-and-map-types.js.map +1 -1
  29. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/boolean-fields.js +1 -1
  30. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/boolean-fields.js.map +1 -1
  31. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/custom-discriminant.js +1 -1
  32. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/custom-discriminant.js.map +1 -1
  33. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/datetime-fields.js +1 -1
  34. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/datetime-fields.js.map +1 -1
  35. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/simple-records.js +1 -1
  36. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/simple-records.js.map +1 -1
  37. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/union-before-records.js +1 -1
  38. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/union-before-records.js.map +1 -1
  39. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/union-types.js +1 -1
  40. package/build/esm/utils/ir/__tests__/__snapshots__/generateZodSchemasFromIr/union-types.js.map +1 -1
  41. package/build/esm/utils/schema/__tests__/__snapshots__/generateDocumentTypeFromSchema/with-name-and-description.js +1 -1
  42. package/build/esm/utils/schema/__tests__/__snapshots__/generateDocumentTypeFromSchema/with-name-and-description.js.map +1 -1
  43. package/build/esm/utils/schema/__tests__/__snapshots__/generateVersionsFromSchema/single-version.js.map +1 -1
  44. package/build/esm/utils/schema/__tests__/__snapshots__/generateVersionsFromSchema/three-version-chain.js.map +1 -1
  45. package/build/esm/utils/schema/__tests__/__snapshots__/generateVersionsFromSchema/two-version.js.map +1 -1
  46. package/build/esm/utils/schema/__tests__/fixtures.js +11 -0
  47. package/build/esm/utils/schema/__tests__/fixtures.js.map +1 -1
  48. package/build/esm/utils/schema/__tests__/generateInternalFromSchema.test.js +6 -1
  49. package/build/esm/utils/schema/__tests__/generateInternalFromSchema.test.js.map +1 -1
  50. package/build/esm/utils/schema/__tests__/provenanceScenarios.test.js +184 -0
  51. package/build/esm/utils/schema/__tests__/provenanceScenarios.test.js.map +1 -0
  52. package/build/esm/utils/schema/__tests__/resolveSchemaChain.test.js +135 -0
  53. package/build/esm/utils/schema/__tests__/resolveSchemaChain.test.js.map +1 -0
  54. package/build/esm/utils/schema/generateInternalFromSchema.js +55 -34
  55. package/build/esm/utils/schema/generateInternalFromSchema.js.map +1 -1
  56. package/build/esm/utils/schema/generateModelMetadataFromSchema.js +12 -10
  57. package/build/esm/utils/schema/generateModelMetadataFromSchema.js.map +1 -1
  58. package/build/esm/utils/schema/generateScopeFromSchema.js +15 -3
  59. package/build/esm/utils/schema/generateScopeFromSchema.js.map +1 -1
  60. package/build/esm/utils/schema/loadSchemaModule.js +2 -5
  61. package/build/esm/utils/schema/loadSchemaModule.js.map +1 -1
  62. package/build/esm/utils/schema/resolveSchemaChain.js +135 -29
  63. package/build/esm/utils/schema/resolveSchemaChain.js.map +1 -1
  64. package/build/esm/utils/steps/__tests__/__snapshots__/types/arrayFields.js.map +1 -1
  65. package/build/esm/utils/steps/__tests__/__snapshots__/types/customDiscriminant.js +1 -1
  66. package/build/esm/utils/steps/__tests__/__snapshots__/types/customDiscriminant.js.map +1 -1
  67. package/build/esm/utils/steps/__tests__/__snapshots__/types/generateTypeScriptInterfaces.js +1 -1
  68. package/build/esm/utils/steps/__tests__/__snapshots__/types/generateTypeScriptInterfaces.js.map +1 -1
  69. package/build/esm/utils/steps/__tests__/__snapshots__/types/refTypes.js.map +1 -1
  70. package/build/esm/utils/steps/__tests__/__snapshots__/types/simpleRecord.js.map +1 -1
  71. package/build/esm/utils/steps/__tests__/__snapshots__/types/simpleSteps.js +1 -1
  72. package/build/esm/utils/steps/__tests__/__snapshots__/types/simpleSteps.js.map +1 -1
  73. package/build/esm/utils/steps/convertStepsToIr.js +49 -24
  74. package/build/esm/utils/steps/convertStepsToIr.js.map +1 -1
  75. package/build/types/commands/asset/assetUpdateSchemaHandler.d.ts.map +1 -1
  76. package/build/types/commands/ir/__tests__/resolveIrInput.test.d.ts +2 -0
  77. package/build/types/commands/ir/__tests__/resolveIrInput.test.d.ts.map +1 -0
  78. package/build/types/commands/ir/irDeployHandler.d.ts.map +1 -1
  79. package/build/types/commands/ir/irGenAssetHandler.d.ts.map +1 -1
  80. package/build/types/commands/ir/irGenTypesHandler.d.ts.map +1 -1
  81. package/build/types/commands/ir/registerIrCommands.d.ts.map +1 -1
  82. package/build/types/commands/ir/resolveIrInput.d.ts +8 -0
  83. package/build/types/commands/ir/resolveIrInput.d.ts.map +1 -0
  84. package/build/types/commands/schema/registerSchemaCommands.d.ts.map +1 -1
  85. package/build/types/commands/schema/schemaIrHandler.d.ts +4 -3
  86. package/build/types/commands/schema/schemaIrHandler.d.ts.map +1 -1
  87. package/build/types/utils/schema/__tests__/fixtures.d.ts +1 -0
  88. package/build/types/utils/schema/__tests__/fixtures.d.ts.map +1 -1
  89. package/build/types/utils/schema/__tests__/provenanceScenarios.test.d.ts +2 -0
  90. package/build/types/utils/schema/__tests__/provenanceScenarios.test.d.ts.map +1 -0
  91. package/build/types/utils/schema/__tests__/resolveSchemaChain.test.d.ts +2 -0
  92. package/build/types/utils/schema/__tests__/resolveSchemaChain.test.d.ts.map +1 -0
  93. package/build/types/utils/schema/generateInternalFromSchema.d.ts.map +1 -1
  94. package/build/types/utils/schema/generateModelMetadataFromSchema.d.ts.map +1 -1
  95. package/build/types/utils/schema/generateScopeFromSchema.d.ts.map +1 -1
  96. package/build/types/utils/schema/loadSchemaModule.d.ts.map +1 -1
  97. package/build/types/utils/schema/resolveSchemaChain.d.ts +25 -5
  98. package/build/types/utils/schema/resolveSchemaChain.d.ts.map +1 -1
  99. package/build/types/utils/steps/convertStepsToIr.d.ts +19 -4
  100. package/build/types/utils/steps/convertStepsToIr.d.ts.map +1 -1
  101. package/package.json +4 -4
@@ -2,6 +2,7 @@ interface SchemaIrOptions {
2
2
  input: string;
3
3
  output: string;
4
4
  config: string;
5
+ maxVersion?: string;
5
6
  }
6
7
  interface PackConfigValues {
7
8
  readonly documentTypeName: string;
@@ -32,9 +33,9 @@ export declare function readPackConfig(configPath: string): Promise<PackConfigVa
32
33
  * downstream tools default to supporting only the latest schema version.
33
34
  *
34
35
  * Note: this is distinct from the legacy single-version IR JSON consumed by
35
- * `ir deploy` / `ir zod`, which is a bare `IRealTimeDocumentSchema` (no chain,
36
- * no migrations). Tools that previously read that format should pick the
37
- * entry matching `latestVersion` from `chain` and use its `ir` field.
36
+ * `ir zod`, which is a bare `IRealTimeDocumentSchema` (no chain, no migrations).
37
+ * Tools that previously read that format should pick the entry matching
38
+ * `latestVersion` from `chain` and use its `ir` field.
38
39
  */
39
40
  export declare function schemaIrHandler(options: SchemaIrOptions): Promise<void>;
40
41
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"schemaIrHandler.d.ts","sourceRoot":"","sources":["../../../../src/commands/schema/schemaIrHandler.ts"],"names":[],"mappings":"AAuBA,UAAU,eAAe;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAQD,UAAU,gBAAgB;IACxB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CACvC;AAwBD,wBAAsB,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAiClF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAuC7E"}
1
+ {"version":3,"file":"schemaIrHandler.d.ts","sourceRoot":"","sources":["../../../../src/commands/schema/schemaIrHandler.ts"],"names":[],"mappings":"AAuBA,UAAU,eAAe;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAQD,UAAU,gBAAgB;IACxB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CACvC;AAwBD,wBAAsB,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAiClF;AAgBD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CA6C7E"}
@@ -3,6 +3,7 @@ export declare const singleVersionSchema: SchemaDefinition;
3
3
  /** Two-version schema with field removal (color removed, fillColor + strokeColor + opacity added) */
4
4
  export declare const twoVersionFieldRemovalSchema: SchemaDefinition;
5
5
  export declare const twoVersionAdditiveSchema: SchemaDefinition;
6
+ export declare const twoVersionRequiredAdditiveSchema: SchemaDefinition;
6
7
  export declare const refFieldsSchema: SchemaDefinition;
7
8
  export declare const unionTypesSchema: SchemaDefinition;
8
9
  /** Schema with nested optionals: tests that optional inside array structures is preserved */
@@ -1 +1 @@
1
- {"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../../../../src/utils/schema/__tests__/fixtures.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAiB,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAyB7E,eAAO,MAAM,mBAAmB,EAAE,gBAA4C,CAAC;AAE/E,qGAAqG;AACrG,eAAO,MAAM,4BAA4B,EAAE,gBAkB1C,CAAC;AAYF,eAAO,MAAM,wBAAwB,EAAE,gBAE7B,CAAC;AAaX,eAAO,MAAM,eAAe,EAAE,gBAY5B,CAAC;AAWH,eAAO,MAAM,gBAAgB,EAAE,gBAU7B,CAAC;AAEH,6FAA6F;AAC7F,eAAO,MAAM,qBAAqB,EAAE,gBASlC,CAAC;AAEH,wFAAwF;AACxF,eAAO,MAAM,6BAA6B,EAAE,gBA4B3C,CAAC;AAEF,0FAA0F;AAC1F,eAAO,MAAM,sBAAsB,EAAE,gBAOnC,CAAC;AAqBH,eAAO,MAAM,iBAAiB,EAAE,gBAU9B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,EAAE,gBAwBxC,CAAC;AAEL,wFAAwF;AACxF,eAAO,MAAM,uBAAuB,EAAE,gBAwClC,CAAC"}
1
+ {"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../../../../src/utils/schema/__tests__/fixtures.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAiB,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAyB7E,eAAO,MAAM,mBAAmB,EAAE,gBAA4C,CAAC;AAE/E,qGAAqG;AACrG,eAAO,MAAM,4BAA4B,EAAE,gBAkB1C,CAAC;AAYF,eAAO,MAAM,wBAAwB,EAAE,gBAE7B,CAAC;AAiBX,eAAO,MAAM,gCAAgC,EAAE,gBAEI,CAAC;AAapD,eAAO,MAAM,eAAe,EAAE,gBAY5B,CAAC;AAWH,eAAO,MAAM,gBAAgB,EAAE,gBAU7B,CAAC;AAEH,6FAA6F;AAC7F,eAAO,MAAM,qBAAqB,EAAE,gBASlC,CAAC;AAEH,wFAAwF;AACxF,eAAO,MAAM,6BAA6B,EAAE,gBA4B3C,CAAC;AAEF,0FAA0F;AAC1F,eAAO,MAAM,sBAAsB,EAAE,gBAOnC,CAAC;AAqBH,eAAO,MAAM,iBAAiB,EAAE,gBAU9B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,EAAE,gBAwBxC,CAAC;AAEL,wFAAwF;AACxF,eAAO,MAAM,uBAAuB,EAAE,gBAwClC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=provenanceScenarios.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"provenanceScenarios.test.d.ts","sourceRoot":"","sources":["../../../../../src/utils/schema/__tests__/provenanceScenarios.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=resolveSchemaChain.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resolveSchemaChain.test.d.ts","sourceRoot":"","sources":["../../../../../src/utils/schema/__tests__/resolveSchemaChain.test.ts"],"names":[],"mappings":""}
@@ -1 +1 @@
1
- {"version":3,"file":"generateInternalFromSchema.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/generateInternalFromSchema.ts"],"names":[],"mappings":"AA2BA,OAAO,EAEL,KAAK,eAAe,EAErB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,WAAW,mBAAmB;IAClC,iCAAiC;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,cAAc,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AA2bD;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,eAAe,GACxB,mBAAmB,CAarB"}
1
+ {"version":3,"file":"generateInternalFromSchema.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/generateInternalFromSchema.ts"],"names":[],"mappings":"AA2BA,OAAO,EAEL,KAAK,eAAe,EAErB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,WAAW,mBAAmB;IAClC,iCAAiC;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,cAAc,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAgdD;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,eAAe,GACxB,mBAAmB,CAarB"}
@@ -1 +1 @@
1
- {"version":3,"file":"generateModelMetadataFromSchema.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/generateModelMetadataFromSchema.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAW/D,MAAM,WAAW,mBAAmB;IAClC,sFAAsF;IACtF,UAAU,EAAE,MAAM,CAAC;CACpB;AAeD;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,eAAe,EACzB,mBAAmB,CAAC,EAAE,MAAM,GAC3B,mBAAmB,CAsLrB"}
1
+ {"version":3,"file":"generateModelMetadataFromSchema.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/generateModelMetadataFromSchema.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAW/D,MAAM,WAAW,mBAAmB;IAClC,sFAAsF;IACtF,UAAU,EAAE,MAAM,CAAC;CACpB;AAeD;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,eAAe,EACzB,mBAAmB,CAAC,EAAE,MAAM,GAC3B,mBAAmB,CAwLrB"}
@@ -1 +1 @@
1
- {"version":3,"file":"generateScopeFromSchema.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/generateScopeFromSchema.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAW/D;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,eAAe,EACzB,mBAAmB,CAAC,EAAE,MAAM,GAC3B,MAAM,CA8HR"}
1
+ {"version":3,"file":"generateScopeFromSchema.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/generateScopeFromSchema.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAW/D;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,eAAe,EACzB,mBAAmB,CAAC,EAAE,MAAM,GAC3B,MAAM,CA8IR"}
@@ -1 +1 @@
1
- {"version":3,"file":"loadSchemaModule.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/loadSchemaModule.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAiB,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAM7E;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,OAAO,GAAG,gBAAgB,CAc/E;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAOlF"}
1
+ {"version":3,"file":"loadSchemaModule.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/loadSchemaModule.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAO9D;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,OAAO,GAAG,gBAAgB,CAc/E;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAOlF"}
@@ -42,11 +42,31 @@ export declare function resolveMinVersion(chain: VersionedIrEntry[], minSupporte
42
42
  * defaults.
43
43
  * Throws on empty chain or invalid minSupportedVersion.
44
44
  */
45
- export declare function resolveSchemaChain(schema: SchemaDefinition, minSupportedVersion?: number, identity?: SchemaIdentity): ResolvedIrChain;
45
+ export declare function resolveSchemaChain(schema: SchemaDefinition, minSupportedVersion?: number, identity?: SchemaIdentity, maxVersion?: number): ResolvedIrChain;
46
46
  /**
47
- * True if any migration in the chain declares a non-empty `derivedFrom`. Drives
48
- * whether the generated SDK emits `DocumentModel` as a factory (requires the
49
- * app to supply typed upgrade functions) or as a const (no upgrade functions needed).
47
+ * Return a copy of the chain with deprecated fields removed from every version
48
+ * at or after the version in which they were deprecated.
49
+ *
50
+ * The SDK type generators (`writeAllSdkFiles` and friends) must treat a
51
+ * deprecated field exactly as a removed field: it disappears from that version's
52
+ * public read/write types and per-version internal types, and the prev/curr diff
53
+ * records it as a `removedField` (driving the upgrade lens). The field is still
54
+ * collected into the all-versions `__Internal` type from earlier versions, which
55
+ * are left untouched.
50
56
  */
51
- export declare function chainHasDerivedFields(chain: VersionedIrEntry[]): boolean;
57
+ export declare function stripDeprecatedFieldsForSdk(chain: VersionedIrEntry[]): VersionedIrEntry[];
58
+ /**
59
+ * True if the chain has any field that requires a runtime upgrade function.
60
+ * Drives whether the generated SDK emits `DocumentModel` as a factory
61
+ * (requires the app to supply typed upgrade functions) or as a const.
62
+ *
63
+ * Two cases trigger this:
64
+ * - A field declares `derivedFrom` with one or more source fields — the app
65
+ * must supply a forward function.
66
+ * - A required field is added in a version past v1 (no `derivedFrom`) — the
67
+ * app must supply a zero-arg thunk; `undefined` is not a legal value.
68
+ *
69
+ * Optional additive fields don't trigger it; the lens leaves them alone.
70
+ */
71
+ export declare function chainNeedsUpgradeFns(chain: VersionedIrEntry[]): boolean;
52
72
  //# sourceMappingURL=resolveSchemaChain.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"resolveSchemaChain.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/resolveSchemaChain.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,gBAAgB,EAAqB,MAAM,uBAAuB,CAAC;AACjF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yDAAyD,CAAC;AAGvG,0DAA0D;AAC1D,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC;AAED,qEAAqE;AACrE,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAC9C,MAAM,EACN,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CACzC,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,uBAAuB,CAAC;IAC5B,UAAU,CAAC,EAAE,2BAA2B,CAAC;CAC1C;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAmDD;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,gBAAgB,EAAE,EACzB,mBAAmB,EAAE,MAAM,GAAG,SAAS,GACtC;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAkB/C;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,gBAAgB,EACxB,mBAAmB,CAAC,EAAE,MAAM,EAC5B,QAAQ,GAAE,cAAmB,GAC5B,eAAe,CAIjB;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAUxE"}
1
+ {"version":3,"file":"resolveSchemaChain.d.ts","sourceRoot":"","sources":["../../../../src/utils/schema/resolveSchemaChain.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,gBAAgB,EAAqB,MAAM,uBAAuB,CAAC;AACjF,OAAO,KAAK,EAEV,uBAAuB,EACxB,MAAM,yDAAyD,CAAC;AAKjE,0DAA0D;AAC1D,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC;AAED,qEAAqE;AACrE,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAC9C,MAAM,EACN,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CACzC,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,uBAAuB,CAAC;IAC5B,UAAU,CAAC,EAAE,2BAA2B,CAAC;CAC1C;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAmGD;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,gBAAgB,EAAE,EACzB,mBAAmB,EAAE,MAAM,GAAG,SAAS,GACtC;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAkB/C;AAoBD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,gBAAgB,EACxB,mBAAmB,CAAC,EAAE,MAAM,EAC5B,QAAQ,GAAE,cAAmB,EAC7B,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAIjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,gBAAgB,EAAE,GAAG,gBAAgB,EAAE,CAgBzF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAmBvE"}
@@ -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.12.0",
3
+ "version": "0.14.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.schema": "0.7.0",
31
- "@palantir/pack.document-schema.model-types": "~0.11.0"
30
+ "@palantir/pack.document-schema.model-types": "~0.13.0",
31
+ "@palantir/pack.schema": "0.9.0"
32
32
  },
33
33
  "devDependencies": {
34
34
  "@types/fs-extra": "^11.0.4",