@palantir/pack.schema 0.3.1 → 0.4.0

package/build/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/defs.ts","../../src/primitives.ts","../../src/utils.ts","../../src/defineUnion.ts","../../src/defineMigration.ts","../../src/defineRecord.ts"],"names":[],"mappings":";AAgBO,IAAM,YAAA,GAAe;AAAA,EAC1B,MAAA,EAAQ,QAAA;AAAA,EACR,KAAA,EAAO;AACT;;;ACHO,IAAM,QAAA,GAAW;AAAA,EACtB,KAAA,EAAO,OAAA;AAAA,EACP,OAAA,EAAS,SAAA;AAAA,EACT,OAAA,EAAS,QAAA;AAAA,EACT,MAAA,EAAQ,QAAA;AAAA,EACR,SAAA,EAAW,UAAA;AAAA,EACX,UAAA,EAAY,WAAA;AAAA,EACZ,QAAA,EAAU,UAAA;AAAA,EACV,GAAA,EAAK,KAAA;AAAA,EACL,MAAA,EAAQ,QAAA;AAAA,EACR,OAAA,EAAS,SAAA;AAAA,EACT,QAAA,EAAU;AACZ;AAMO,IAAM,MAAA,GAAS;AAAA,EACpB,MAAM,QAAA,CAAS;AACjB;AACO,IAAM,MAAA,GAAS;AAAA,EACpB,MAAM,QAAA,CAAS;AACjB;AACO,IAAM,OAAA,GAAU;AAAA,EACrB,MAAM,QAAA,CAAS;AACjB;AACO,IAAM,OAAA,GAAU;AAAA,EACrB,MAAM,QAAA,CAAS;AACjB;AACO,IAAM,QAAQ,CAAA,IAAA,MAAS;AAAA,EAC5B,MAAM,QAAA,CAAS,KAAA;AAAA,EACf,KAAA,EAAO;AACT,CAAA;AACO,IAAM,WAAW,CAAA,IAAA,MAAS;AAAA,EAC/B,MAAM,QAAA,CAAS,QAAA;AAAA,EACf;AACF,CAAA;;;AC9BO,SAAS,WAAW,KAAA,EAAO;AAChC,EAAA,OAAO,SAAA,CAAU,KAAA,CAAM,IAAA,EAAM,KAAA,CAAM,IAAI,CAAA;AACzC;AAMO,SAAS,SAAA,CAAU,MAAM,OAAA,EAAS;AACvC,EAAA,OAAO;AAAA,IACL,MAAM,QAAA,CAAS,GAAA;AAAA,IACf,IAAA;AAAA,IACA;AAAA,GACF;AACF;AAKO,SAAS,YAAY,KAAA,EAAO;AACjC,EAAA,OAAO,KAAA,IAAS,IAAA,IAAQ,OAAO,KAAA,KAAU,QAAA,IAAY,MAAA,IAAU,KAAA,IAAS,KAAA,CAAM,IAAA,KAAS,YAAA,CAAa,MAAA,IAAU,QAAA,IAAY,KAAA;AAC5H;AAKO,SAAS,WAAW,KAAA,EAAO;AAChC,EAAA,OAAO,KAAA,IAAS,IAAA,IAAQ,OAAO,KAAA,KAAU,QAAA,IAAY,MAAA,IAAU,KAAA,IAAS,KAAA,CAAM,IAAA,KAAS,YAAA,CAAa,KAAA,IAAS,UAAA,IAAc,KAAA;AAC7H;;;AChCO,SAAS,YAAY,IAAA,EAAM;AAAA,EAChC,YAAA,GAAe,MAAA;AAAA,EACf,IAAA;AAAA,EACA;AACF,CAAA,EAAG;AACD,EAAA,MAAM,UAAU,MAAA,CAAO,OAAA,CAAQ,QAAQ,CAAA,CAAE,IAAI,CAAC,CAAC,GAAA,EAAK,KAAK,MAAM,CAAC,GAAA,EAAK,sBAAA,CAAuB,KAAK,CAAC,CAAC,CAAA;AACnG,EAAA,MAAM,gBAAA,GAAmB,MAAA,CAAO,WAAA,CAAY,OAAO,CAAA;AACnD,EAAA,OAAO;AAAA,IACL,MAAM,YAAA,CAAa,KAAA;AAAA,IACnB,YAAA;AAAA,IACA,IAAA;AAAA,IACA,IAAA;AAAA,IACA,QAAA,EAAU;AAAA,GACZ;AACF;AACO,SAAS,uBAAuB,GAAA,EAAK;AAC1C,EAAA,MAAM,QAAA,GAAW,OAAO,GAAA,KAAQ,UAAA,GAAa,KAAI,GAAI,GAAA;AACrD,EAAA,OAAO,SAAS,IAAA,KAAS,QAAA,CAAS,GAAA,GAAM,QAAA,GAAW,WAAW,QAAQ,CAAA;AACxE;;;AClBA,IAAM,gBAAA,GAAN,MAAM,iBAAA,CAAiB;AAAA,EACrB,IAAA;AAAA,EACA,IAAA;AAAA,EACA,QAAA;AAAA,EACA,WAAA,CAAY;AAAA,IACV,IAAA;AAAA,IACA,IAAA;AAAA,IACA;AAAA,GACF,EAAG;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,QAAA,GAAW;AAAA,MACd,GAAG;AAAA,KACL;AAAA,EACF;AAAA,EACA,UAAA,CAAW,aAAa,aAAA,EAAe;AACrC,IAAA,MAAM,GAAA,GAAM,uBAAuB,aAAa,CAAA;AAChD,IAAA,MAAM,WAAA,GAAc;AAAA,MAClB,GAAG,IAAA,CAAK,QAAA;AAAA,MACR,CAAC,WAAW,GAAG;AAAA,KACjB;AACA,IAAA,OAAO,IAAI,iBAAA,CAAiB;AAAA,MAC1B,MAAM,YAAA,CAAa,KAAA;AAAA,MACnB,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,QAAA,EAAU,WAAA;AAAA,MACV,YAAA,EAAc;AAAA,KACf,CAAA;AAAA,EACH;AAAA,EACA,KAAA,GAAQ;AACN,IAAA,OAAO;AAAA,MACL,MAAM,YAAA,CAAa,KAAA;AAAA,MACnB,UAAU,IAAA,CAAK,QAAA;AAAA,MACf,YAAA,EAAc,MAAA;AAAA,MACd,MAAM,IAAA,CAAK;AAAA,KACb;AAAA,EACF;AACF,CAAA;AACA,IAAM,iBAAA,GAAN,MAAM,kBAAA,CAAkB;AAAA,EACtB,IAAA;AAAA,EACA,MAAA;AAAA,EACA,YAAY,gBAAA,EAAkB;AAC5B,IAAA,IAAA,CAAK,OAAO,gBAAA,CAAiB,IAAA;AAC7B,IAAA,IAAA,CAAK,MAAA,GAAS;AAAA,MACZ,GAAG,gBAAA,CAAiB;AAAA,KACtB;AAAA,EACF;AAAA;AAAA,EAGA,QAAA,CAAS,MAAM,KAAA,EAAO;AACpB,IAAA,OAAO,IAAI,kBAAA,CAAkB;AAAA,MAC3B,MAAM,YAAA,CAAa,MAAA;AAAA,MACnB,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,MAAA,EAAQ;AAAA,QACN,GAAG,IAAA,CAAK,MAAA;AAAA,QACR,CAAC,IAAI,GAAG;AAAA,OACV;AAAA,MACA,IAAA,EAAM;AAAA,KACP,CAAA;AAAA,EACH;AAAA,EACA,KAAA,GAAQ;AACN,IAAA,OAAO;AAAA,MACL,MAAM,YAAA,CAAa,MAAA;AAAA,MACnB,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,IAAA,EAAM;AAAA,KACR;AAAA,EACF;AACF,CAAA;AACO,SAAS,eAAA,CAAgB,UAAU,SAAA,EAAW;AAenD,EAAA,MAAM,WAAW,EAAC;AAClB,EAAA,KAAA,MAAW,OAAO,QAAA,EAAU;AAC1B,IAAA,MAAM,CAAA,GAAI,SAAS,GAAG,CAAA;AAGtB,IAAA,IAAI,WAAA,CAAY,CAAC,CAAA,EAAG;AAGlB,MAAA,MAAM,aAAA,GAAgB,IAAI,iBAAA,CAAkB,CAAC,CAAA;AAC7C,MAAA,QAAA,CAAS,GAAG,CAAA,GAAI,aAAA;AAAA,IAClB,CAAA,MAAA,IAAW,UAAA,CAAW,CAAC,CAAA,EAAG;AAExB,MAAA,MAAM,YAAA,GAAe,IAAI,gBAAA,CAAiB,CAAC,CAAA;AAC3C,MAAA,QAAA,CAAS,GAAG,CAAA,GAAI,YAAA;AAAA,IAClB;AAAA,EACF;AACA,EAAA,OAAO;AAAA,IACL,GAAG,QAAA;AAAA,IACH,GAAG,UAAU,QAAQ;AAAA,GACvB;AACF;;;ACpGA,SAAS,gBAAgB,KAAA,EAAO;AAE9B,EAAA,MAAM,QAAA,GAAW,OAAO,KAAA,KAAU,UAAA,GAAa,OAAM,GAAI,KAAA;AACzD,EAAA,IAAI,WAAA,CAAY,QAAQ,CAAA,IAAK,UAAA,CAAW,QAAQ,CAAA,EAAG;AACjD,IAAA,OAAO,WAAW,QAAQ,CAAA;AAAA,EAC5B;AAGA,EAAA,OAAO,QAAA;AACT;AACO,SAAS,YAAA,CAAa,MAAM,MAAA,EAAQ;AACzC,EAAA,MAAM,UAAU,MAAA,CAAO,OAAA,CAAQ,MAAA,CAAO,MAAM,EAAE,GAAA,CAAI,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM,CAAC,KAAK,eAAA,CAAgB,KAAK,CAAC,CAAC,CAAA;AACjG,EAAA,MAAM,MAAA,GAAS,MAAA,CAAO,WAAA,CAAY,OAAO,CAAA;AACzC,EAAA,OAAO;AAAA,IACL,MAAM,YAAA,CAAa,MAAA;AAAA,IACnB,IAAA;AAAA,IACA,MAAM,MAAA,CAAO,IAAA;AAAA,IACb;AAAA,GACF;AACF","file":"index.js","sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const ModelDefType = {\n  RECORD: \"record\",\n  UNION: \"union\"\n};","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const TypeKind = {\n  ARRAY: \"array\",\n  BOOLEAN: \"boolean\",\n  DOC_REF: \"docRef\",\n  DOUBLE: \"double\",\n  MEDIA_REF: \"mediaRef\",\n  OBJECT_REF: \"objectRef\",\n  OPTIONAL: \"optional\",\n  REF: \"ref\",\n  STRING: \"string\",\n  UNKNOWN: \"unknown\",\n  USER_REF: \"userRef\"\n};\n\n// Forward declaration to avoid circular reference\n\n// A reference to a record or a union type\n\nexport const String = {\n  type: TypeKind.STRING\n};\nexport const Double = {\n  type: TypeKind.DOUBLE\n};\nexport const Boolean = {\n  type: TypeKind.BOOLEAN\n};\nexport const Unknown = {\n  type: TypeKind.UNKNOWN\n};\nexport const Array = item => ({\n  type: TypeKind.ARRAY,\n  items: item\n});\nexport const Optional = item => ({\n  type: TypeKind.OPTIONAL,\n  item\n});","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ModelDefType } from \"./defs.js\";\nimport { TypeKind } from \"./primitives.js\";\n\n/**\n * Helper function to safely transform a record definition to a reference.\n * This function helps TypeScript track type transformations better.\n */\nexport function modelToRef(model) {\n  return createRef(model.name, model.type);\n}\n\n/**\n * Helper function to create a reference with proper typing.\n * This avoids type assertions in multiple places.\n */\nexport function createRef(name, refType) {\n  return {\n    type: TypeKind.REF,\n    name,\n    refType\n  };\n}\n\n/**\n * Type guard to check if a value is a RecordDef\n */\nexport function isRecordDef(value) {\n  return value != null && typeof value === \"object\" && \"type\" in value && value.type === ModelDefType.RECORD && \"fields\" in value;\n}\n\n/**\n * Type guard to check if a value is a UnionDef\n */\nexport function isUnionDef(value) {\n  return value != null && typeof value === \"object\" && \"type\" in value && value.type === ModelDefType.UNION && \"variants\" in value;\n}","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ModelDefType } from \"./defs.js\";\nimport { TypeKind } from \"./primitives.js\";\nimport { modelToRef } from \"./utils.js\";\nexport function defineUnion(name, {\n  discriminant = \"type\",\n  docs,\n  variants\n}) {\n  const entries = Object.entries(variants).map(([key, value]) => [key, resolveUnionVariantArg(value)]);\n  const resolvedVariants = Object.fromEntries(entries);\n  return {\n    type: ModelDefType.UNION,\n    discriminant,\n    name,\n    docs,\n    variants: resolvedVariants\n  };\n}\nexport function resolveUnionVariantArg(arg) {\n  const resolved = typeof arg === \"function\" ? arg() : arg;\n  return resolved.type === TypeKind.REF ? resolved : modelToRef(resolved);\n}","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { resolveUnionVariantArg } from \"./defineUnion.js\";\nimport { ModelDefType } from \"./defs.js\";\nimport { isRecordDef, isUnionDef } from \"./utils.js\";\nclass UnionBuilderImpl {\n  name;\n  docs;\n  variants;\n  constructor({\n    name,\n    docs,\n    variants\n  }) {\n    this.name = name;\n    this.docs = docs;\n    this.variants = {\n      ...variants\n    };\n  }\n  addVariant(variantName, modelDefOrRef) {\n    const ref = resolveUnionVariantArg(modelDefOrRef);\n    const newVariants = {\n      ...this.variants,\n      [variantName]: ref\n    };\n    return new UnionBuilderImpl({\n      type: ModelDefType.UNION,\n      name: this.name,\n      variants: newVariants,\n      discriminant: \"type\"\n    });\n  }\n  build() {\n    return {\n      type: ModelDefType.UNION,\n      variants: this.variants,\n      discriminant: \"type\",\n      name: this.name\n    };\n  }\n}\nclass RecordBuilderImpl {\n  name;\n  fields;\n  constructor(initialRecordDef) {\n    this.name = initialRecordDef.name;\n    this.fields = {\n      ...initialRecordDef.fields\n    };\n  }\n\n  // TODO: resolve field value from arg instead\n  addField(name, value) {\n    return new RecordBuilderImpl({\n      type: ModelDefType.RECORD,\n      name: this.name,\n      fields: {\n        ...this.fields,\n        [name]: value\n      },\n      docs: \"\"\n    });\n  }\n  build() {\n    return {\n      type: ModelDefType.RECORD,\n      name: this.name,\n      fields: this.fields,\n      docs: \"\"\n    };\n  }\n}\nexport function defineMigration(previous, migration) {\n  /**\n   * Create a map of builders for the schema.\n   *\n   * Note about type assertions:\n   * We use a type assertion here (SchemaBuilder<T>) because TypeScript cannot\n   * track the relationship between the keys in the original schema and the\n   * corresponding builder types. This is a fundamental limitation of TypeScript's\n   * type system when dealing with dynamically constructed objects.\n   *\n   * The assertion is safe because:\n   * 1. We're only adding keys that exist in the original schema\n   * 2. For each key, we're creating a builder of the correct type\n   * 3. The resulting object exactly matches the SchemaBuilder<T> type\n   */\n  const builders = {};\n  for (const key in previous) {\n    const v = previous[key];\n\n    // Use our type guards for safer type narrowing\n    if (isRecordDef(v)) {\n      // This assertion is necessary because TypeScript can't track the field types\n      // through the dynamic property access and object construction\n      const recordBuilder = new RecordBuilderImpl(v);\n      builders[key] = recordBuilder;\n    } else if (isUnionDef(v)) {\n      // Similar assertion needed for union builders\n      const unionBuilder = new UnionBuilderImpl(v);\n      builders[key] = unionBuilder;\n    }\n  }\n  return {\n    ...previous,\n    ...migration(builders)\n  };\n}","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ModelDefType } from \"./defs.js\";\nimport { isRecordDef, isUnionDef, modelToRef } from \"./utils.js\";\n/**\n * Helper function to resolve a field value, handling functions and transforming\n * types as needed.\n */\nfunction resolveFieldArg(value) {\n  // Handle function values\n  const resolved = typeof value === \"function\" ? value() : value;\n  if (isRecordDef(resolved) || isUnionDef(resolved)) {\n    return modelToRef(resolved);\n  }\n\n  // For primitive types and other Types\n  return resolved;\n}\nexport function defineRecord(name, record) {\n  const entries = Object.entries(record.fields).map(([key, value]) => [key, resolveFieldArg(value)]);\n  const fields = Object.fromEntries(entries);\n  return {\n    type: ModelDefType.RECORD,\n    name: name,\n    docs: record.docs,\n    fields\n  };\n}"]}
+{"version":3,"sources":["../../src/defs.ts","../../src/primitives.ts","../../src/utils.ts","../../src/defineUnion.ts","../../src/defineMigration.ts","../../src/defineRecord.ts","../../src/defineSchemaUpdate.ts"],"names":[],"mappings":";AAgBO,IAAM,YAAA,GAAe;AAAA,EAC1B,MAAA,EAAQ,QAAA;AAAA,EACR,KAAA,EAAO;AACT;;;ACHO,IAAM,QAAA,GAAW;AAAA,EACtB,KAAA,EAAO,OAAA;AAAA,EACP,OAAA,EAAS,SAAA;AAAA,EACT,OAAA,EAAS,QAAA;AAAA,EACT,MAAA,EAAQ,QAAA;AAAA,EACR,SAAA,EAAW,UAAA;AAAA,EACX,UAAA,EAAY,WAAA;AAAA,EACZ,QAAA,EAAU,UAAA;AAAA,EACV,GAAA,EAAK,KAAA;AAAA,EACL,MAAA,EAAQ,QAAA;AAAA,EACR,OAAA,EAAS,SAAA;AAAA,EACT,QAAA,EAAU;AACZ;AAMO,IAAM,MAAA,GAAS;AAAA,EACpB,MAAM,QAAA,CAAS;AACjB;AACO,IAAM,MAAA,GAAS;AAAA,EACpB,MAAM,QAAA,CAAS;AACjB;AACO,IAAM,OAAA,GAAU;AAAA,EACrB,MAAM,QAAA,CAAS;AACjB;AACO,IAAM,OAAA,GAAU;AAAA,EACrB,MAAM,QAAA,CAAS;AACjB;AACO,IAAM,QAAQ,CAAA,IAAA,MAAS;AAAA,EAC5B,MAAM,QAAA,CAAS,KAAA;AAAA,EACf,KAAA,EAAO;AACT,CAAA;AACO,IAAM,WAAW,CAAA,IAAA,MAAS;AAAA,EAC/B,MAAM,QAAA,CAAS,QAAA;AAAA,EACf;AACF,CAAA;;;AC9BO,SAAS,WAAW,KAAA,EAAO;AAChC,EAAA,OAAO,SAAA,CAAU,KAAA,CAAM,IAAA,EAAM,KAAA,CAAM,IAAI,CAAA;AACzC;AAMO,SAAS,SAAA,CAAU,MAAM,OAAA,EAAS;AACvC,EAAA,OAAO;AAAA,IACL,MAAM,QAAA,CAAS,GAAA;AAAA,IACf,IAAA;AAAA,IACA;AAAA,GACF;AACF;AAKO,SAAS,YAAY,KAAA,EAAO;AACjC,EAAA,OAAO,KAAA,IAAS,IAAA,IAAQ,OAAO,KAAA,KAAU,QAAA,IAAY,MAAA,IAAU,KAAA,IAAS,KAAA,CAAM,IAAA,KAAS,YAAA,CAAa,MAAA,IAAU,QAAA,IAAY,KAAA;AAC5H;AAKO,SAAS,WAAW,KAAA,EAAO;AAChC,EAAA,OAAO,KAAA,IAAS,IAAA,IAAQ,OAAO,KAAA,KAAU,QAAA,IAAY,MAAA,IAAU,KAAA,IAAS,KAAA,CAAM,IAAA,KAAS,YAAA,CAAa,KAAA,IAAS,UAAA,IAAc,KAAA;AAC7H;;;AChCO,SAAS,YAAY,IAAA,EAAM;AAAA,EAChC,YAAA,GAAe,MAAA;AAAA,EACf,IAAA;AAAA,EACA;AACF,CAAA,EAAG;AACD,EAAA,MAAM,UAAU,MAAA,CAAO,OAAA,CAAQ,QAAQ,CAAA,CAAE,IAAI,CAAC,CAAC,GAAA,EAAK,KAAK,MAAM,CAAC,GAAA,EAAK,sBAAA,CAAuB,KAAK,CAAC,CAAC,CAAA;AACnG,EAAA,MAAM,gBAAA,GAAmB,MAAA,CAAO,WAAA,CAAY,OAAO,CAAA;AACnD,EAAA,OAAO;AAAA,IACL,MAAM,YAAA,CAAa,KAAA;AAAA,IACnB,YAAA;AAAA,IACA,IAAA;AAAA,IACA,IAAA;AAAA,IACA,QAAA,EAAU;AAAA,GACZ;AACF;AACO,SAAS,uBAAuB,GAAA,EAAK;AAC1C,EAAA,MAAM,QAAA,GAAW,OAAO,GAAA,KAAQ,UAAA,GAAa,KAAI,GAAI,GAAA;AACrD,EAAA,OAAO,SAAS,IAAA,KAAS,QAAA,CAAS,GAAA,GAAM,QAAA,GAAW,WAAW,QAAQ,CAAA;AACxE;;;ACbA,IAAM,gBAAA,GAAN,MAAM,iBAAA,CAAiB;AAAA,EACrB,IAAA;AAAA,EACA,IAAA;AAAA,EACA,QAAA;AAAA,EACA,WAAA,CAAY;AAAA,IACV,IAAA;AAAA,IACA,IAAA;AAAA,IACA;AAAA,GACF,EAAG;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,QAAA,GAAW;AAAA,MACd,GAAG;AAAA,KACL;AAAA,EACF;AAAA,EACA,UAAA,CAAW,aAAa,aAAA,EAAe;AACrC,IAAA,MAAM,GAAA,GAAM,uBAAuB,aAAa,CAAA;AAChD,IAAA,MAAM,WAAA,GAAc;AAAA,MAClB,GAAG,IAAA,CAAK,QAAA;AAAA,MACR,CAAC,WAAW,GAAG;AAAA,KACjB;AACA,IAAA,OAAO,IAAI,iBAAA,CAAiB;AAAA,MAC1B,MAAM,YAAA,CAAa,KAAA;AAAA,MACnB,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,QAAA,EAAU,WAAA;AAAA,MACV,YAAA,EAAc;AAAA,KACf,CAAA;AAAA,EACH;AAAA,EACA,KAAA,GAAQ;AACN,IAAA,OAAO;AAAA,MACL,MAAM,YAAA,CAAa,KAAA;AAAA,MACnB,UAAU,IAAA,CAAK,QAAA;AAAA,MACf,YAAA,EAAc,MAAA;AAAA,MACd,MAAM,IAAA,CAAK;AAAA,KACb;AAAA,EACF;AACF,CAAA;AACA,IAAM,iBAAA,GAAN,MAAM,kBAAA,CAAkB;AAAA,EACtB,IAAA;AAAA,EACA,MAAA;AAAA,EACA,YAAY,gBAAA,EAAkB;AAC5B,IAAA,IAAA,CAAK,OAAO,gBAAA,CAAiB,IAAA;AAC7B,IAAA,IAAA,CAAK,MAAA,GAAS;AAAA,MACZ,GAAG,gBAAA,CAAiB;AAAA,KACtB;AAAA,EACF;AAAA;AAAA,EAGA,QAAA,CAAS,MAAM,KAAA,EAAO;AACpB,IAAA,OAAO,IAAI,kBAAA,CAAkB;AAAA,MAC3B,MAAM,YAAA,CAAa,MAAA;AAAA,MACnB,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,MAAA,EAAQ;AAAA,QACN,GAAG,IAAA,CAAK,MAAA;AAAA,QACR,CAAC,IAAI,GAAG;AAAA,OACV;AAAA,MACA,IAAA,EAAM;AAAA,KACP,CAAA;AAAA,EACH;AAAA,EACA,KAAA,GAAQ;AACN,IAAA,OAAO;AAAA,MACL,MAAM,YAAA,CAAa,MAAA;AAAA,MACnB,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,QAAQ,IAAA,CAAK,MAAA;AAAA,MACb,IAAA,EAAM;AAAA,KACR;AAAA,EACF;AACF,CAAA;AACO,SAAS,eAAA,CAAgB,QAAQ,SAAA,EAAW;AACjD,EAAA,MAAM,WAAW,EAAC;AAClB,EAAA,KAAA,MAAW,OAAO,MAAA,EAAQ;AACxB,IAAA,MAAM,CAAA,GAAI,OAAO,GAAG,CAAA;AACpB,IAAA,IAAI,WAAA,CAAY,CAAC,CAAA,EAAG;AAClB,MAAA,MAAM,aAAA,GAAgB,IAAI,iBAAA,CAAkB,CAAC,CAAA;AAC7C,MAAA,QAAA,CAAS,GAAG,CAAA,GAAI,aAAA;AAAA,IAClB,CAAA,MAAA,IAAW,UAAA,CAAW,CAAC,CAAA,EAAG;AACxB,MAAA,MAAM,YAAA,GAAe,IAAI,gBAAA,CAAiB,CAAC,CAAA;AAC3C,MAAA,QAAA,CAAS,GAAG,CAAA,GAAI,YAAA;AAAA,IAClB;AAAA,EACF;AACA,EAAA,OAAO;AAAA,IACL,GAAG,MAAA;AAAA,IACH,GAAG,UAAU,QAAQ;AAAA,GACvB;AACF;;;ACtFA,SAAS,gBAAgB,KAAA,EAAO;AAE9B,EAAA,MAAM,QAAA,GAAW,OAAO,KAAA,KAAU,UAAA,GAAa,OAAM,GAAI,KAAA;AACzD,EAAA,IAAI,WAAA,CAAY,QAAQ,CAAA,IAAK,UAAA,CAAW,QAAQ,CAAA,EAAG;AACjD,IAAA,OAAO,WAAW,QAAQ,CAAA;AAAA,EAC5B;AAGA,EAAA,OAAO,QAAA;AACT;AACO,SAAS,YAAA,CAAa,MAAM,MAAA,EAAQ;AACzC,EAAA,MAAM,UAAU,MAAA,CAAO,OAAA,CAAQ,MAAA,CAAO,MAAM,EAAE,GAAA,CAAI,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM,CAAC,KAAK,eAAA,CAAgB,KAAK,CAAC,CAAC,CAAA;AACjG,EAAA,MAAM,MAAA,GAAS,MAAA,CAAO,WAAA,CAAY,OAAO,CAAA;AACzC,EAAA,OAAO;AAAA,IACL,MAAM,YAAA,CAAa,MAAA;AAAA,IACnB,IAAA;AAAA,IACA,MAAM,MAAA,CAAO,IAAA;AAAA,IACb;AAAA,GACF;AACF;;;ACxBO,SAAS,aAAa,MAAA,EAAQ;AACnC,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,SAAA;AAAA,IACN,OAAA,EAAS,CAAA;AAAA,IACT;AAAA,GACF;AACF;AACO,SAAS,kBAAA,CAAmB,MAAM,SAAA,EAAW;AAClD,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA;AAAA,GACF;AACF;AACA,IAAM,wBAAA,GAAN,MAAM,yBAAA,CAAyB;AAAA,EAC7B,MAAA;AAAA,EACA,OAAA;AAAA,EACA,QAAA;AAAA,EACA,WAAA;AAAA,EACA,WAAA,CAAY,MAAA,EAAQ,OAAA,EAAS,QAAA,EAAU,UAAA,EAAY;AACjD,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,QAAA,GAAW,QAAA;AAChB,IAAA,IAAA,CAAK,WAAA,GAAc,UAAA;AAAA,EACrB;AAAA,EACA,gBAAgB,MAAA,EAAQ;AACtB,IAAA,MAAM,MAAA,GAAS,eAAA,CAAgB,IAAA,CAAK,MAAA,EAAQ,OAAO,SAAS,CAAA;AAC5D,IAAA,OAAO,IAAI,0BAAyB,MAAA,EAAQ,IAAA,CAAK,SAAS,IAAA,CAAK,QAAA,EAAU,KAAK,WAAW,CAAA;AAAA,EAC3F;AAAA,EACA,eAAe,UAAA,EAAY;AACzB,IAAA,OAAO,IAAI,0BAAyB,IAAA,CAAK,MAAA,EAAQ,KAAK,OAAA,EAAS,IAAA,CAAK,UAAU,UAAU,CAAA;AAAA,EAC1F;AAAA,EACA,KAAA,GAAQ;AACN,IAAA,OAAO;AAAA,MACL,IAAA,EAAM,WAAA;AAAA,MACN,MAAA,EAAQ;AAAA,QACN,GAAG,IAAA,CAAK;AAAA,OACV;AAAA,MACA,SAAS,IAAA,CAAK,OAAA;AAAA,MACd,UAAU,IAAA,CAAK,QAAA;AAAA,MACf,GAAI,IAAA,CAAK,WAAA,IAAe,IAAA,GAAO;AAAA,QAC7B,YAAY,IAAA,CAAK;AAAA,UACf;AAAC,KACP;AAAA,EACF;AACF,CAAA;AACO,SAAS,WAAW,QAAA,EAAU;AACnC,EAAA,OAAO,IAAI,wBAAA,CAAyB,QAAA,CAAS,QAAQ,QAAA,CAAS,OAAA,GAAU,GAAG,QAAQ,CAAA;AACrF","file":"index.js","sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const ModelDefType = {\n  RECORD: \"record\",\n  UNION: \"union\"\n};","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const TypeKind = {\n  ARRAY: \"array\",\n  BOOLEAN: \"boolean\",\n  DOC_REF: \"docRef\",\n  DOUBLE: \"double\",\n  MEDIA_REF: \"mediaRef\",\n  OBJECT_REF: \"objectRef\",\n  OPTIONAL: \"optional\",\n  REF: \"ref\",\n  STRING: \"string\",\n  UNKNOWN: \"unknown\",\n  USER_REF: \"userRef\"\n};\n\n// Forward declaration to avoid circular reference\n\n// A reference to a record or a union type\n\nexport const String = {\n  type: TypeKind.STRING\n};\nexport const Double = {\n  type: TypeKind.DOUBLE\n};\nexport const Boolean = {\n  type: TypeKind.BOOLEAN\n};\nexport const Unknown = {\n  type: TypeKind.UNKNOWN\n};\nexport const Array = item => ({\n  type: TypeKind.ARRAY,\n  items: item\n});\nexport const Optional = item => ({\n  type: TypeKind.OPTIONAL,\n  item\n});","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ModelDefType } from \"./defs.js\";\nimport { TypeKind } from \"./primitives.js\";\n\n/**\n * Helper function to safely transform a record definition to a reference.\n * This function helps TypeScript track type transformations better.\n */\nexport function modelToRef(model) {\n  return createRef(model.name, model.type);\n}\n\n/**\n * Helper function to create a reference with proper typing.\n * This avoids type assertions in multiple places.\n */\nexport function createRef(name, refType) {\n  return {\n    type: TypeKind.REF,\n    name,\n    refType\n  };\n}\n\n/**\n * Type guard to check if a value is a RecordDef\n */\nexport function isRecordDef(value) {\n  return value != null && typeof value === \"object\" && \"type\" in value && value.type === ModelDefType.RECORD && \"fields\" in value;\n}\n\n/**\n * Type guard to check if a value is a UnionDef\n */\nexport function isUnionDef(value) {\n  return value != null && typeof value === \"object\" && \"type\" in value && value.type === ModelDefType.UNION && \"variants\" in value;\n}","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ModelDefType } from \"./defs.js\";\nimport { TypeKind } from \"./primitives.js\";\nimport { modelToRef } from \"./utils.js\";\nexport function defineUnion(name, {\n  discriminant = \"type\",\n  docs,\n  variants\n}) {\n  const entries = Object.entries(variants).map(([key, value]) => [key, resolveUnionVariantArg(value)]);\n  const resolvedVariants = Object.fromEntries(entries);\n  return {\n    type: ModelDefType.UNION,\n    discriminant,\n    name,\n    docs,\n    variants: resolvedVariants\n  };\n}\nexport function resolveUnionVariantArg(arg) {\n  const resolved = typeof arg === \"function\" ? arg() : arg;\n  return resolved.type === TypeKind.REF ? resolved : modelToRef(resolved);\n}","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { resolveUnionVariantArg } from \"./defineUnion.js\";\nimport { ModelDefType } from \"./defs.js\";\nimport { isRecordDef, isUnionDef } from \"./utils.js\";\n\n/** Soon to be deprecated - Use `ModelDefs` instead. */\n\n/** Soon to be deprecated - use `ModelDefs` instead. */\n\nclass UnionBuilderImpl {\n  name;\n  docs;\n  variants;\n  constructor({\n    name,\n    docs,\n    variants\n  }) {\n    this.name = name;\n    this.docs = docs;\n    this.variants = {\n      ...variants\n    };\n  }\n  addVariant(variantName, modelDefOrRef) {\n    const ref = resolveUnionVariantArg(modelDefOrRef);\n    const newVariants = {\n      ...this.variants,\n      [variantName]: ref\n    };\n    return new UnionBuilderImpl({\n      type: ModelDefType.UNION,\n      name: this.name,\n      variants: newVariants,\n      discriminant: \"type\"\n    });\n  }\n  build() {\n    return {\n      type: ModelDefType.UNION,\n      variants: this.variants,\n      discriminant: \"type\",\n      name: this.name\n    };\n  }\n}\nclass RecordBuilderImpl {\n  name;\n  fields;\n  constructor(initialRecordDef) {\n    this.name = initialRecordDef.name;\n    this.fields = {\n      ...initialRecordDef.fields\n    };\n  }\n\n  // TODO: resolve field value from arg instead\n  addField(name, value) {\n    return new RecordBuilderImpl({\n      type: ModelDefType.RECORD,\n      name: this.name,\n      fields: {\n        ...this.fields,\n        [name]: value\n      },\n      docs: \"\"\n    });\n  }\n  build() {\n    return {\n      type: ModelDefType.RECORD,\n      name: this.name,\n      fields: this.fields,\n      docs: \"\"\n    };\n  }\n}\nexport function defineMigration(models, migration) {\n  const builders = {};\n  for (const key in models) {\n    const v = models[key];\n    if (isRecordDef(v)) {\n      const recordBuilder = new RecordBuilderImpl(v);\n      builders[key] = recordBuilder;\n    } else if (isUnionDef(v)) {\n      const unionBuilder = new UnionBuilderImpl(v);\n      builders[key] = unionBuilder;\n    }\n  }\n  return {\n    ...models,\n    ...migration(builders)\n  };\n}","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ModelDefType } from \"./defs.js\";\nimport { isRecordDef, isUnionDef, modelToRef } from \"./utils.js\";\n/**\n * Helper function to resolve a field value, handling functions and transforming\n * types as needed.\n */\nfunction resolveFieldArg(value) {\n  // Handle function values\n  const resolved = typeof value === \"function\" ? value() : value;\n  if (isRecordDef(resolved) || isUnionDef(resolved)) {\n    return modelToRef(resolved);\n  }\n\n  // For primitive types and other Types\n  return resolved;\n}\nexport function defineRecord(name, record) {\n  const entries = Object.entries(record.fields).map(([key, value]) => [key, resolveFieldArg(value)]);\n  const fields = Object.fromEntries(entries);\n  return {\n    type: ModelDefType.RECORD,\n    name: name,\n    docs: record.docs,\n    fields\n  };\n}","/*\n * Copyright 2026 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { defineMigration } from \"./defineMigration.js\";\nexport function defineSchema(models) {\n  return {\n    type: \"initial\",\n    version: 1,\n    models\n  };\n}\nexport function defineSchemaUpdate(name, migration) {\n  return {\n    name,\n    migration\n  };\n}\nclass SchemaVersionBuilderImpl {\n  models;\n  version;\n  previous;\n  _migrations;\n  constructor(models, version, previous, migrations) {\n    this.models = models;\n    this.version = version;\n    this.previous = previous;\n    this._migrations = migrations;\n  }\n  addSchemaUpdate(update) {\n    const merged = defineMigration(this.models, update.migration);\n    return new SchemaVersionBuilderImpl(merged, this.version, this.previous, this._migrations);\n  }\n  withMigrations(migrations) {\n    return new SchemaVersionBuilderImpl(this.models, this.version, this.previous, migrations);\n  }\n  build() {\n    return {\n      type: \"versioned\",\n      models: {\n        ...this.models\n      },\n      version: this.version,\n      previous: this.previous,\n      ...(this._migrations != null ? {\n        migrations: this._migrations\n      } : {})\n    };\n  }\n}\nexport function nextSchema(previous) {\n  return new SchemaVersionBuilderImpl(previous.models, previous.version + 1, previous);\n}"]}

package/build/types/__tests__/defineSchemaUpdate.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/__tests__/defineSchemaUpdate.test.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"","names":[],"sources":["../../../src/__tests__/defineSchemaUpdate.test.ts"],"version":3,"file":"defineSchemaUpdate.test.d.ts"}

package/build/types/defineMigration.d.ts

@@ -1,9 +1,11 @@
 import type { UnionVariantArg } from "./defineUnion.js";
-import type { RecordDef, UnionDef, UnionVariants } from "./defs.js";
+import type { ModelDefs, RecordDef, UnionDef, UnionVariants } from "./defs.js";
 import type { Ref, Type } from "./primitives.js";
-export type ReturnedSchema = Record<string, RecordDef | UnionDef>;
-export type Schema<T extends ReturnedSchema> = T;
-export type SchemaBuilder<T extends ReturnedSchema> = { [k in keyof T] : T[k] extends UnionDef<infer R> ? UnionBuilder<R> : T[k] extends RecordDef<infer R> ? RecordBuilder<R> : never };
+/** Soon to be deprecated - Use `ModelDefs` instead. */
+export type ReturnedSchema = ModelDefs;
+/** Soon to be deprecated - use `ModelDefs` instead. */
+export type Schema<T extends ModelDefs> = T;
+export type SchemaBuilder<T extends ModelDefs> = { [k in keyof T] : T[k] extends UnionDef<infer R> ? UnionBuilder<R> : T[k] extends RecordDef<infer R> ? RecordBuilder<R> : never };
 export interface RecordBuilder<T extends Record<string, Type>> {
 	addField<
 		const K extends string,
@@ -16,6 +18,6 @@ export interface UnionBuilder<S extends UnionVariants> {
 	build(): UnionDef<S>;
 }
 export declare function defineMigration<
-	const T extends ReturnedSchema,
-	const S extends ReturnedSchema
->(previous: Schema<T>, migration: (schema: SchemaBuilder<T>) => S): Schema<T & S>;
+	const T extends ModelDefs,
+	const S extends ModelDefs
+>(models: T, migration: (schema: SchemaBuilder<T>) => S): T & S;

package/build/types/defineMigration.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,uBAAuB;AAErC,cAAc,WAAyB,UAAU,qBAAqB;AAEtE,cAAc,KAAK,YAAY;AAG/B,YAAY,iBAAiB,eAAe,YAAY;AAExD,YAAY,OAAO,UAAU,kBAAkB;AAE/C,YAAY,cAAc,UAAU,qBACjC,WAAW,KAAI,EAAE,WAAW,eAAe,KAAK,aAAa,KAC1D,EAAE,WAAW,gBAAgB,KAAK,cAAc;AAItD,iBAAiB,cAAc,UAAU,eAAe,OAAO;CAE7D;QAAe;EAAkB,UAAU;GACzC,MAAM,GACN,MAAM,IACL,cAAc,OAAO,KAAK,KAAI;CACjC,SAAS,UAAU;;AAGrB,iBAAiB,aAAa,UAAU,eAAe;CAErD,iBAAiB,kBACf,MAAM,GACN,eAAe,kBACd,aAAa,OAAO,KAAK,KAAI;CAChC,SAAS,SAAS;;AAmEpB,OAAO,iBAAS;OACR,UAAU;OACV,UAAU;EAEhB,UAAU,OAAO,IACjB,YAAY,QAAQ,cAAc,OAAO,IACxC,OAAO,IAAI","names":[],"sources":["../../src/defineMigration.ts"],"version":3,"file":"defineMigration.d.ts"}
+{"mappings":"AAgBA,cAAc,uBAAuB;AAErC,cAAc,WAAW,WAAyB,UAAU,qBAAqB;AAEjF,cAAc,KAAK,YAAY;;AAI/B,YAAY,iBAAiB;;AAG7B,YAAY,OAAO,UAAU,aAAa;AAE1C,YAAY,cAAc,UAAU,gBACjC,WAAW,KAAI,EAAE,WAAW,eAAe,KAAK,aAAa,KAC1D,EAAE,WAAW,gBAAgB,KAAK,cAAc;AAItD,iBAAiB,cAAc,UAAU,eAAe,OAAO;CAE7D;QAAe;EAAkB,UAAU;GACzC,MAAM,GACN,MAAM,IACL,cAAc,OAAO,KAAK,KAAI;CACjC,SAAS,UAAU;;AAGrB,iBAAiB,aAAa,UAAU,eAAe;CAErD,iBAAiB,kBACf,MAAM,GACN,eAAe,kBACd,aAAa,OAAO,KAAK,KAAI;CAChC,SAAS,SAAS;;AAmEpB,OAAO,iBAAS;OACR,UAAU;OACV,UAAU;EAEhB,QAAQ,GACR,YAAY,QAAQ,cAAc,OAAO,IACxC,IAAI","names":[],"sources":["../../src/defineMigration.ts"],"version":3,"file":"defineMigration.d.ts"}

package/build/types/defineSchemaUpdate.d.ts

@@ -0,0 +1,38 @@
+import type { SchemaBuilder } from "./defineMigration.js";
+import type { ModelDefs } from "./defs.js";
+export interface InitialSchema<T extends ModelDefs = ModelDefs> {
+	readonly type: "initial";
+	readonly version: 1;
+	readonly models: T;
+}
+export interface FieldMigration {
+	readonly derivedFrom: readonly string[];
+	readonly forward: (oldFields: Record<string, unknown>) => unknown;
+}
+export type VersionMigrations = Record<string, Record<string, FieldMigration>>;
+export interface VersionedSchema<T extends ModelDefs = ModelDefs> {
+	readonly type: "versioned";
+	readonly models: T;
+	readonly version: number;
+	readonly previous: SchemaDefinition;
+	readonly migrations?: VersionMigrations;
+}
+export type SchemaDefinition<T extends ModelDefs = ModelDefs> = InitialSchema<T> | VersionedSchema<T>;
+export declare function defineSchema<T extends ModelDefs>(models: T): InitialSchema<T>;
+export interface SchemaUpdate<
+	T extends ModelDefs,
+	S extends ModelDefs
+> {
+	readonly name: string;
+	readonly migration: (schema: SchemaBuilder<T>) => S;
+}
+export declare function defineSchemaUpdate<
+	T extends ModelDefs,
+	S extends ModelDefs
+>(name: string, migration: (schema: SchemaBuilder<T>) => S): SchemaUpdate<T, S>;
+export interface SchemaVersionBuilder<T extends ModelDefs> {
+	addSchemaUpdate<S extends ModelDefs>(update: SchemaUpdate<T, S>): SchemaVersionBuilder<T & S>;
+	withMigrations(migrations: VersionMigrations): SchemaVersionBuilder<T>;
+	build(): VersionedSchema<T>;
+}
+export declare function nextSchema<T extends ModelDefs>(previous: SchemaDefinition<T>): SchemaVersionBuilder<T>;

package/build/types/defineSchemaUpdate.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,qBAAqB;AAEnC,cAAc,iBAAiB;AAE/B,iBAAiB,cAAc,UAAU,YAAY,WAAW;UACrD,MAAM;UACN,SAAS;UACT,QAAQ;;AAGnB,iBAAiB,eAAe;UACrB;UACA,UAAU,WAAW;;AAGhC,YAAY,oBAAoB,eAAe,eAAe;AAE9D,iBAAiB,gBAAgB,UAAU,YAAY,WAAW;UACvD,MAAM;UACN,QAAQ;UACR;UACA,UAAU;UACV,aAAa;;AAGxB,YAAY,iBAAiB,UAAU,YAAY,aAC/C,cAAc,KACd,gBAAgB;AAEpB,OAAO,iBAAS,aAAa,UAAU,WAAW,QAAQ,IAAI,cAAc;AAI5E,iBAAiB;CAAa,UAAU;CAAW,UAAU;EAAW;UAC7D;UACA,YAAY,QAAQ,cAAc,OAAO;;AAGpD,OAAO,iBAAS;CAAmB,UAAU;CAAW,UAAU;EAChE,cACA,YAAY,QAAQ,cAAc,OAAO,IACxC,aAAa,GAAG;AAInB,iBAAiB,qBAAqB,UAAU,WAAW;CACzD,gBAAgB,UAAU,WACxB,QAAQ,aAAa,GAAG,KACvB,qBAAqB,IAAI;CAC5B,eAAe,YAAY,oBAAoB,qBAAqB;CACpE,SAAS,gBAAgB;;AA2C3B,OAAO,iBAAS,WAAW,UAAU,WACnC,UAAU,iBAAiB,KAC1B,qBAAqB","names":[],"sources":["../../src/defineSchemaUpdate.ts"],"version":3,"file":"defineSchemaUpdate.d.ts"}

package/build/types/defs.d.ts

@@ -21,4 +21,5 @@ export interface RecordDef<TFields extends RecordFields = RecordFields> extends
 	readonly fields: TFields;
 }
 export type ModelDef = RecordDef | UnionDef;
+export type ModelDefs = Record<string, ModelDef>;
 export {};

package/build/types/defs.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,KAAK,YAAY;AAE/B,OAAO,cAAM;UACX,QAAQ;UACR,OAAO;;AAGT,YAAY,sBAAsB,0BAA0B;UAElD,aAAa;UACZ,MAAM;UACN;UACA;;AAGX,YAAY,eAAe,eAAe;AAC1C,YAAY,gBAAgB,eAAe;AAE3C,iBAAiB,SAAS,kBAAkB,gBAAgB,uBAAuB,aAAa;UACrF,aAAa,aAAa;UAC1B,UAAU;UACV;;AAGX,iBAAiB,UAAU,gBAAgB,eAAe,sBAAsB,aAAa;UAClF,aAAa,aAAa;UAC1B,QAAQ;;AAGnB,YAAY,WAAW,YAAY","names":[],"sources":["../../src/defs.ts"],"version":3,"file":"defs.d.ts"}
+{"mappings":"AAgBA,cAAc,KAAK,YAAY;AAE/B,OAAO,cAAM;UACX,QAAQ;UACR,OAAO;;AAGT,YAAY,sBAAsB,0BAA0B;UAElD,aAAa;UACZ,MAAM;UACN;UACA;;AAGX,YAAY,eAAe,eAAe;AAC1C,YAAY,gBAAgB,eAAe;AAE3C,iBAAiB,SAAS,kBAAkB,gBAAgB,uBAAuB,aAAa;UACrF,aAAa,aAAa;UAC1B,UAAU;UACV;;AAGX,iBAAiB,UAAU,gBAAgB,eAAe,sBAAsB,aAAa;UAClF,aAAa,aAAa;UAC1B,QAAQ;;AAGnB,YAAY,WAAW,YAAY;AACnC,YAAY,YAAY,eAAe","names":[],"sources":["../../src/defs.ts"],"version":3,"file":"defs.d.ts"}

package/build/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./defineMigration.js";
 export * from "./defineRecord.js";
+export * from "./defineSchemaUpdate.js";
 export * from "./defineUnion.js";
 export * from "./defs.js";
 export * from "./primitives.js";

package/build/types/index.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}
+{"mappings":"AAgBA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palantir/pack.schema",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "API package for PACK schema functionality",
   "license": "Apache-2.0",
   "repository": {

package/src/__tests__/defineSchemaUpdate.test.ts

@@ -0,0 +1,365 @@
+/*
+ * Copyright 2026 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { describe, expect, it } from "vitest";
+import type { SchemaBuilder } from "../defineMigration.js";
+import { defineRecord } from "../defineRecord.js";
+import { defineSchema, defineSchemaUpdate, nextSchema } from "../defineSchemaUpdate.js";
+import { defineUnion } from "../defineUnion.js";
+import * as P from "../primitives.js";
+import { assertExactKeys, assertHasKeys, assertTypeEquals } from "./testTypeUtils.js";
+
+describe("defineSchemaUpdate", () => {
+  it("should create a schema update and apply it via nextSchema", () => {
+    const schemaV1 = defineSchema({
+      Person: defineRecord("Person", {
+        docs: "A person",
+        fields: {
+          name: P.String,
+        },
+      }),
+    });
+
+    const addAge = defineSchemaUpdate(
+      "addAge",
+      (schema: SchemaBuilder<typeof schemaV1.models>) => ({
+        PersonV2: schema.Person.addField("age", P.Double).build(),
+      }),
+    );
+
+    const schemaV2 = nextSchema(schemaV1).addSchemaUpdate(addAge).build();
+
+    expect(schemaV2.models.Person).toBe(schemaV1.models.Person);
+    expect(schemaV2.models.PersonV2.fields.name).toEqual({ type: "string" });
+    expect(schemaV2.models.PersonV2.fields.age).toEqual({ type: "double" });
+    expect(schemaV2.version).toBe(2);
+
+    assertHasKeys<typeof schemaV2.models, "Person" | "PersonV2">();
+    assertExactKeys<typeof schemaV2.models.PersonV2.fields, "name" | "age">();
+    assertTypeEquals<typeof schemaV2.models.PersonV2.fields.name, P.String>();
+    assertTypeEquals<typeof schemaV2.models.PersonV2.fields.age, P.Double>();
+  });
+
+  it("should compose multiple schema updates in one version", () => {
+    const schemaV1 = defineSchema({
+      ShapeBox: defineRecord("ShapeBox", {
+        docs: "A box shape",
+        fields: {
+          left: P.Double,
+          right: P.Double,
+          color: P.Optional(P.String),
+        },
+      }),
+      ShapeCircle: defineRecord("ShapeCircle", {
+        docs: "A circle shape",
+        fields: {
+          cx: P.Double,
+          radius: P.Double,
+          color: P.Optional(P.String),
+        },
+      }),
+    });
+
+    const addFillColor = defineSchemaUpdate(
+      "addFillColor",
+      (schema: SchemaBuilder<typeof schemaV1.models>) => ({
+        ShapeBox: schema.ShapeBox
+          .addField("fillColor", P.Optional(P.String))
+          .build(),
+        ShapeCircle: schema.ShapeCircle
+          .addField("fillColor", P.Optional(P.String))
+          .build(),
+      }),
+    );
+
+    const addOpacity = defineSchemaUpdate(
+      "addOpacity",
+      (schema: SchemaBuilder<typeof schemaV1.models>) => ({
+        ShapeBox: schema.ShapeBox
+          .addField("opacity", P.Optional(P.Double))
+          .build(),
+        ShapeCircle: schema.ShapeCircle
+          .addField("opacity", P.Optional(P.Double))
+          .build(),
+      }),
+    );
+
+    const schemaV2 = nextSchema(schemaV1)
+      .addSchemaUpdate(addFillColor)
+      .addSchemaUpdate(addOpacity)
+      .build();
+
+    expect(schemaV2.models.ShapeBox.fields.fillColor).toEqual({
+      type: "optional",
+      item: { type: "string" },
+    });
+    expect(schemaV2.models.ShapeBox.fields.opacity).toEqual({
+      type: "optional",
+      item: { type: "double" },
+    });
+    expect(schemaV2.models.ShapeBox.fields.left).toEqual({ type: "double" });
+    expect(schemaV2.models.ShapeCircle.fields.fillColor).toEqual({
+      type: "optional",
+      item: { type: "string" },
+    });
+    expect(schemaV2.models.ShapeCircle.fields.opacity).toEqual({
+      type: "optional",
+      item: { type: "double" },
+    });
+    expect(schemaV2.version).toBe(2);
+  });
+
+  it("should track version advancement across multiple nextSchema calls", () => {
+    const schemaV1 = defineSchema({
+      Item: defineRecord("Item", {
+        docs: "An item",
+        fields: {
+          name: P.String,
+        },
+      }),
+    });
+
+    const addDescription = defineSchemaUpdate(
+      "addDescription",
+      (schema: SchemaBuilder<typeof schemaV1.models>) => ({
+        Item: schema.Item.addField("description", P.Optional(P.String)).build(),
+      }),
+    );
+
+    const schemaV2 = nextSchema(schemaV1).addSchemaUpdate(addDescription).build();
+
+    expect(schemaV2.version).toBe(2);
+
+    const addTags = defineSchemaUpdate(
+      "addTags",
+      (schema: SchemaBuilder<typeof schemaV2.models>) => ({
+        Item: schema.Item.addField("tags", P.Optional(P.String)).build(),
+      }),
+    );
+
+    const schemaV3 = nextSchema(schemaV2).addSchemaUpdate(addTags).build();
+
+    expect(schemaV3.version).toBe(3);
+    expect(schemaV3.models.Item.fields.name).toEqual({ type: "string" });
+    expect(schemaV3.models.Item.fields.description).toEqual({
+      type: "optional",
+      item: { type: "string" },
+    });
+    expect(schemaV3.models.Item.fields.tags).toEqual({
+      type: "optional",
+      item: { type: "string" },
+    });
+  });
+
+  it("should build a walkable version chain via .previous", () => {
+    const schemaV1 = defineSchema({
+      Node: defineRecord("Node", {
+        docs: "A node",
+        fields: {
+          label: P.String,
+        },
+      }),
+    });
+
+    const addWeight = defineSchemaUpdate(
+      "addWeight",
+      (schema: SchemaBuilder<typeof schemaV1.models>) => ({
+        Node: schema.Node.addField("weight", P.Double).build(),
+      }),
+    );
+
+    const schemaV2 = nextSchema(schemaV1).addSchemaUpdate(addWeight).build();
+
+    // v2 points back to the v1 InitialSchema
+    expect(schemaV2.previous).toBe(schemaV1);
+    expect(schemaV2.previous.type).toBe("initial");
+    expect(schemaV2.version).toBe(2);
+  });
+
+  it("should build a multi-step version chain", () => {
+    const schemaV1 = defineSchema({
+      Item: defineRecord("Item", {
+        docs: "An item",
+        fields: { name: P.String },
+      }),
+    });
+
+    const schemaV2 = nextSchema(schemaV1)
+      .addSchemaUpdate(
+        defineSchemaUpdate(
+          "addPrice",
+          schema => ({
+            Item: schema.Item.addField("price", P.Double).build(),
+          }),
+        ),
+      )
+      .build();
+
+    const schemaV3 = nextSchema(schemaV2)
+      .addSchemaUpdate(
+        defineSchemaUpdate(
+          "addTags",
+          schema => ({
+            Item: schema.Item.addField("tags", P.Optional(P.String)).build(),
+          }),
+        ),
+      )
+      .build();
+
+    // Walk the chain: v3 (versioned) -> v2 (versioned) -> v1 (initial)
+    expect(schemaV3.version).toBe(3);
+    expect(schemaV3.previous).toBe(schemaV2);
+    expect(schemaV3.previous.type).toBe("versioned");
+    if (schemaV3.previous.type === "versioned") {
+      expect(schemaV3.previous.previous).toBe(schemaV1);
+      expect(schemaV3.previous.previous.type).toBe("initial");
+    }
+  });
+
+  it("should discriminate via type field on built schemas", () => {
+    const schemaV1 = defineSchema({
+      Item: defineRecord("Item", {
+        docs: "An item",
+        fields: { name: P.String },
+      }),
+    });
+
+    const schemaV2 = nextSchema(schemaV1)
+      .addSchemaUpdate(
+        defineSchemaUpdate(
+          "addPrice",
+          schema => ({
+            Item: schema.Item.addField("price", P.Double).build(),
+          }),
+        ),
+      )
+      .build();
+
+    expect(schemaV2.type).toBe("versioned");
+    expect(schemaV2.previous.type).toBe("initial");
+  });
+
+  it("should work with union schema updates", () => {
+    const CircleRecord = defineRecord("Circle", {
+      docs: "A circle",
+      fields: { radius: P.Double },
+    });
+
+    const RectangleRecord = defineRecord("Rectangle", {
+      docs: "A rectangle",
+      fields: { width: P.Double, height: P.Double },
+    });
+
+    const TriangleRecord = defineRecord("Triangle", {
+      docs: "A triangle",
+      fields: { base: P.Double, height: P.Double },
+    });
+
+    const schemaV1 = defineSchema({
+      Shape: defineUnion("Shape", {
+        docs: "A shape",
+        variants: {
+          circle: CircleRecord,
+          rectangle: RectangleRecord,
+        },
+      }),
+    });
+
+    const addTriangle = defineSchemaUpdate(
+      "addTriangle",
+      (schema: SchemaBuilder<typeof schemaV1.models>) => ({
+        Shape: schema.Shape.addVariant("triangle", TriangleRecord).build(),
+      }),
+    );
+
+    const schemaV2 = nextSchema(schemaV1).addSchemaUpdate(addTriangle).build();
+
+    expect(schemaV2.models.Shape.variants.circle).toEqual({
+      type: "ref",
+      name: "Circle",
+      refType: "record",
+    });
+    expect(schemaV2.models.Shape.variants.triangle).toEqual({
+      type: "ref",
+      name: "Triangle",
+      refType: "record",
+    });
+    expect(schemaV2.version).toBe(2);
+
+    assertExactKeys<
+      typeof schemaV2.models.Shape.variants,
+      "circle" | "rectangle" | "triangle"
+    >();
+  });
+
+  it("should handle mixed record and union updates in one version", () => {
+    const PersonRecord = defineRecord("Person", {
+      docs: "A person",
+      fields: { name: P.String },
+    });
+
+    const OrganizationRecord = defineRecord("Organization", {
+      docs: "An organization",
+      fields: { orgName: P.String },
+    });
+
+    const schemaV1 = defineSchema({
+      Person: PersonRecord,
+      Entity: defineUnion("Entity", {
+        docs: "An entity",
+        variants: {
+          person: PersonRecord,
+        },
+      }),
+    });
+
+    const addAge = defineSchemaUpdate(
+      "addAge",
+      (schema: SchemaBuilder<typeof schemaV1.models>) => ({
+        PersonV2: schema.Person.addField("age", P.Double).build(),
+      }),
+    );
+
+    const addOrgVariant = defineSchemaUpdate(
+      "addOrgVariant",
+      (schema: SchemaBuilder<typeof schemaV1.models>) => ({
+        Entity: schema.Entity.addVariant("organization", OrganizationRecord).build(),
+      }),
+    );
+
+    const schemaV2 = nextSchema(schemaV1)
+      .addSchemaUpdate(addAge)
+      .addSchemaUpdate(addOrgVariant)
+      .build();
+
+    expect(schemaV2.models.PersonV2.fields.name).toEqual({ type: "string" });
+    expect(schemaV2.models.PersonV2.fields.age).toEqual({ type: "double" });
+    expect(schemaV2.models.Entity.variants.person).toEqual({
+      type: "ref",
+      name: "Person",
+      refType: "record",
+    });
+    expect(schemaV2.models.Entity.variants.organization).toEqual({
+      type: "ref",
+      name: "Organization",
+      refType: "record",
+    });
+
+    assertHasKeys<typeof schemaV2.models, "Person" | "PersonV2" | "Entity">();
+    assertExactKeys<typeof schemaV2.models.PersonV2.fields, "name" | "age">();
+    assertExactKeys<typeof schemaV2.models.Entity.variants, "person" | "organization">();
+  });
+});

package/src/defineMigration.ts

@@ -16,16 +16,18 @@
 
 import type { UnionVariantArg } from "./defineUnion.js";
 import { resolveUnionVariantArg } from "./defineUnion.js";
-import type { RecordDef, RecordFields, UnionDef, UnionVariants } from "./defs.js";
+import type { ModelDefs, RecordDef, RecordFields, UnionDef, UnionVariants } from "./defs.js";
 import { ModelDefType } from "./defs.js";
 import type { Ref, Type } from "./primitives.js";
 import { isRecordDef, isUnionDef } from "./utils.js";
 
-export type ReturnedSchema = Record<string, RecordDef | UnionDef>;
+/** Soon to be deprecated - Use `ModelDefs` instead. */
+export type ReturnedSchema = ModelDefs;
 
-export type Schema<T extends ReturnedSchema> = T;
+/** Soon to be deprecated - use `ModelDefs` instead. */
+export type Schema<T extends ModelDefs> = T;
 
-export type SchemaBuilder<T extends ReturnedSchema> = {
+export type SchemaBuilder<T extends ModelDefs> = {
   [k in keyof T]: T[k] extends UnionDef<infer R> ? UnionBuilder<R>
     : T[k] extends RecordDef<infer R> ? RecordBuilder<R>
     : never;
@@ -114,46 +116,28 @@ class RecordBuilderImpl<T extends RecordFields> implements RecordBuilder<T> {
 }
 
 export function defineMigration<
-  const T extends ReturnedSchema,
-  const S extends ReturnedSchema,
+  const T extends ModelDefs,
+  const S extends ModelDefs,
 >(
-  previous: Schema<T>,
+  models: T,
   migration: (schema: SchemaBuilder<T>) => S,
-): Schema<T & S> {
-  /**
-   * Create a map of builders for the schema.
-   *
-   * Note about type assertions:
-   * We use a type assertion here (SchemaBuilder<T>) because TypeScript cannot
-   * track the relationship between the keys in the original schema and the
-   * corresponding builder types. This is a fundamental limitation of TypeScript's
-   * type system when dealing with dynamically constructed objects.
-   *
-   * The assertion is safe because:
-   * 1. We're only adding keys that exist in the original schema
-   * 2. For each key, we're creating a builder of the correct type
-   * 3. The resulting object exactly matches the SchemaBuilder<T> type
-   */
+): T & S {
   const builders = {} as SchemaBuilder<T>;
 
-  for (const key in previous) {
-    const v = previous[key];
+  for (const key in models) {
+    const v = models[key];
 
-    // Use our type guards for safer type narrowing
     if (isRecordDef(v)) {
-      // This assertion is necessary because TypeScript can't track the field types
-      // through the dynamic property access and object construction
       const recordBuilder = new RecordBuilderImpl(v);
       builders[key] = recordBuilder as unknown as SchemaBuilder<T>[typeof key];
     } else if (isUnionDef(v)) {
-      // Similar assertion needed for union builders
       const unionBuilder = new UnionBuilderImpl(v);
       builders[key] = unionBuilder as unknown as SchemaBuilder<T>[typeof key];
     }
   }
 
   return {
-    ...previous,
+    ...models,
     ...migration(builders),
   };
 }