@palantir/pack.schema 0.3.1 → 0.4.0

package/src/defineSchemaUpdate.ts

@@ -0,0 +1,114 @@
+/*
+ * 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 type { SchemaBuilder } from "./defineMigration.js";
+import { defineMigration } 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 function defineSchema<T extends ModelDefs>(models: T): InitialSchema<T> {
+  return { type: "initial", version: 1, models };
+}
+
+export interface SchemaUpdate<T extends ModelDefs, S extends ModelDefs> {
+  readonly name: string;
+  readonly migration: (schema: SchemaBuilder<T>) => S;
+}
+
+export function defineSchemaUpdate<T extends ModelDefs, S extends ModelDefs>(
+  name: string,
+  migration: (schema: SchemaBuilder<T>) => S,
+): SchemaUpdate<T, S> {
+  return { name, migration };
+}
+
+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>;
+}
+
+class SchemaVersionBuilderImpl<T extends ModelDefs> implements SchemaVersionBuilder<T> {
+  private readonly models: T;
+  private readonly version: number;
+  private readonly previous: SchemaDefinition;
+  private readonly _migrations: VersionMigrations | undefined;
+
+  constructor(
+    models: T,
+    version: number,
+    previous: SchemaDefinition,
+    migrations?: VersionMigrations,
+  ) {
+    this.models = models;
+    this.version = version;
+    this.previous = previous;
+    this._migrations = migrations;
+  }
+
+  addSchemaUpdate<S extends ModelDefs>(
+    update: SchemaUpdate<T, S>,
+  ): SchemaVersionBuilder<T & S> {
+    const merged = defineMigration(this.models, update.migration);
+    return new SchemaVersionBuilderImpl(merged, this.version, this.previous, this._migrations);
+  }
+
+  withMigrations(migrations: VersionMigrations): SchemaVersionBuilder<T> {
+    return new SchemaVersionBuilderImpl(this.models, this.version, this.previous, migrations);
+  }
+
+  build(): VersionedSchema<T> {
+    return {
+      type: "versioned",
+      models: { ...this.models },
+      version: this.version,
+      previous: this.previous,
+      ...(this._migrations != null ? { migrations: this._migrations } : {}),
+    };
+  }
+}
+
+export function nextSchema<T extends ModelDefs>(
+  previous: SchemaDefinition<T>,
+): SchemaVersionBuilder<T> {
+  return new SchemaVersionBuilderImpl(previous.models, previous.version + 1, previous);
+}

package/src/defs.ts

@@ -44,3 +44,4 @@ export interface RecordDef<TFields extends RecordFields = RecordFields> extends
 }
 
 export type ModelDef = RecordDef | UnionDef;
+export type ModelDefs = Record<string, ModelDef>;

package/src/index.ts

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