@palantir/pack.document-schema.model-types 0.32.0 → 0.34.0

package/build/types/types/ActivityEvent.d.ts

@@ -1,6 +1,7 @@
 import type { Flavored } from "@palantir/pack.core";
 import type { DocumentSecurityDiscretionary, DocumentSecurityMandatory } from "./DocumentMetadata.js";
 import type { Model, ModelData } from "./Model.js";
+import type { PublishedVersionId } from "./PublishedVersion.js";
 import type { UserId } from "./UserRef.js";
 export type ActivityEventId = Flavored<"pack:EventId">;
 export declare const ActivityEventDataType: {
@@ -10,6 +11,8 @@ export declare const ActivityEventDataType: {
 	readonly DOCUMENT_RENAME: "documentRename";
 	readonly DOCUMENT_MANDATORY_SECURITY_UPDATE: "documentMandatorySecurityUpdate";
 	readonly DOCUMENT_DISCRETIONARY_SECURITY_UPDATE: "documentDiscretionarySecurityUpdate";
+	readonly PUBLISHED_VERSION_CREATE: "publishedVersionCreate";
+	readonly PUBLISHED_VERSION_DELETE: "publishedVersionDelete";
 	readonly UNKNOWN: "unknown";
 };
 /**
@@ -86,6 +89,24 @@ export interface ActivityEventDataDocumentMandatorySecurityUpdate {
 	readonly newMarkings: readonly string[];
 }
 /**
+* Activity event emitted when a published version of a document is created.
+*/
+export interface ActivityEventDataPublishedVersionCreate {
+	readonly type: typeof ActivityEventDataType.PUBLISHED_VERSION_CREATE;
+	readonly publishedVersionId: PublishedVersionId;
+	readonly name?: string;
+	readonly description?: string;
+}
+/**
+* Activity event emitted when a published version of a document is deleted.
+*/
+export interface ActivityEventDataPublishedVersionDelete {
+	readonly type: typeof ActivityEventDataType.PUBLISHED_VERSION_DELETE;
+	readonly publishedVersionId: PublishedVersionId;
+	readonly name?: string;
+	readonly description?: string;
+}
+/**
 * Fallback for unrecognized activity event types.
 *
 * This allows some flexibility with new event types added to the platform.
@@ -98,7 +119,7 @@ export interface ActivityEventDataUnknown {
 	readonly rawType: string;
 	readonly rawData: unknown;
 }
-export type ActivityEventData = ActivityEventDataCustom | ActivityEventDataDocumentCreate | ActivityEventDataDocumentDescriptionUpdate | ActivityEventDataDocumentRename | ActivityEventDataDocumentMandatorySecurityUpdate | ActivityEventDataDocumentDiscretionarySecurityUpdate | ActivityEventDataUnknown;
+export type ActivityEventData = ActivityEventDataCustom | ActivityEventDataDocumentCreate | ActivityEventDataDocumentDescriptionUpdate | ActivityEventDataDocumentRename | ActivityEventDataDocumentMandatorySecurityUpdate | ActivityEventDataDocumentDiscretionarySecurityUpdate | ActivityEventDataPublishedVersionCreate | ActivityEventDataPublishedVersionDelete | ActivityEventDataUnknown;
 /**
 * An event representing an activity that has occurred on a document. This
 * includes standard document events as well as custom application-specific

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

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,gBAAgB;AAC9B,cACE,+BACA,iCACK;AACP,cAAc,OAAO,iBAAiB;AACtC,cAAc,cAAc;AAE5B,YAAY,kBAAkB,SAAS;AAEvC,OAAO,cAAM;UACX,cAAc;UACd,iBAAiB;UACjB,6BAA6B;UAC7B,iBAAiB;UACjB,oCAAoC;UACpC,wCAAwC;UACxC,SAAS;;;;;;;;;;;;;;;;;;;;;;;AAwBX,iBAAiB,wBAAwB,UAAU,QAAQ,OAAO;UACvD,aAAa,sBAAsB;UACnC,OAAO;UACP;UACA;UACA,MAAM,UAAU;;;;;AAM3B,iBAAiB,gCAAgC;UACtC,aAAa,sBAAsB;UACnC,0BAA0B;UAC1B;;;;;AAMX,iBAAiB,gCAAgC;UACtC,aAAa,sBAAsB;UACnC;UACA;;;;;AAMX,iBAAiB,2CAA2C;UACjD,aAAa,sBAAsB;UACnC;;;;;UAKA;;;;;AAMX,iBAAiB,qDAAqD;UAC3D,aAAa,sBAAsB;UACnC,eAAe,kBAAkB;UACjC,gCAAgC;UAChC,0BAA0B;;;;;AAMrC,iBAAiB,iDAAiD;UACvD,aAAa,sBAAsB;UACnC;UACA;;;;;;;;;;AAWX,iBAAiB,yBAAyB;UAC/B,aAAa,sBAAsB;UACnC;UACA;;AAGX,YAAY,oBACR,0BACA,kCACA,6CACA,kCACA,mDACA,uDACA;;;;;;;;AASJ,iBAAiB,cAAc;;UAEpB;UACA,WAAW;UACX;UACA,WAAW;UACX,SAAS;UACT","names":[],"sources":["../../../src/types/ActivityEvent.ts"],"version":3,"file":"ActivityEvent.d.ts"}
+{"mappings":"AAgBA,cAAc,gBAAgB;AAC9B,cACE,+BACA,iCACK;AACP,cAAc,OAAO,iBAAiB;AACtC,cAAc,0BAA0B;AACxC,cAAc,cAAc;AAE5B,YAAY,kBAAkB,SAAS;AAEvC,OAAO,cAAM;UACX,cAAc;UACd,iBAAiB;UACjB,6BAA6B;UAC7B,iBAAiB;UACjB,oCAAoC;UACpC,wCAAwC;UACxC,0BAA0B;UAC1B,0BAA0B;UAC1B,SAAS;;;;;;;;;;;;;;;;;;;;;;;AAwBX,iBAAiB,wBAAwB,UAAU,QAAQ,OAAO;UACvD,aAAa,sBAAsB;UACnC,OAAO;UACP;UACA;UACA,MAAM,UAAU;;;;;AAM3B,iBAAiB,gCAAgC;UACtC,aAAa,sBAAsB;UACnC,0BAA0B;UAC1B;;;;;AAMX,iBAAiB,gCAAgC;UACtC,aAAa,sBAAsB;UACnC;UACA;;;;;AAMX,iBAAiB,2CAA2C;UACjD,aAAa,sBAAsB;UACnC;;;;;UAKA;;;;;AAMX,iBAAiB,qDAAqD;UAC3D,aAAa,sBAAsB;UACnC,eAAe,kBAAkB;UACjC,gCAAgC;UAChC,0BAA0B;;;;;AAMrC,iBAAiB,iDAAiD;UACvD,aAAa,sBAAsB;UACnC;UACA;;;;;AAMX,iBAAiB,wCAAwC;UAC9C,aAAa,sBAAsB;UACnC,oBAAoB;UACpB;UACA;;;;;AAMX,iBAAiB,wCAAwC;UAC9C,aAAa,sBAAsB;UACnC,oBAAoB;UACpB;UACA;;;;;;;;;;AAWX,iBAAiB,yBAAyB;UAC/B,aAAa,sBAAsB;UACnC;UACA;;AAGX,YAAY,oBACR,0BACA,kCACA,6CACA,kCACA,mDACA,uDACA,0CACA,0CACA;;;;;;;;AASJ,iBAAiB,cAAc;;UAEpB;UACA,WAAW;UACX;UACA,WAAW;UACX,SAAS;UACT","names":[],"sources":["../../../src/types/ActivityEvent.ts"],"version":3,"file":"ActivityEvent.d.ts"}

package/build/types/types/UpgradeLens.d.ts

@@ -28,8 +28,10 @@ export interface FieldDef {
 	addedInVersion?: number;
 }
 export interface UpgradeStepDef {
-	/** Schema version this step upgrades to. Unique within a model's chain. */
+	/** Major version that added this step's fields, e.g. 3 for a step added in 3.2. */
 	addedInVersion: number;
+	/** Minor version that added this step's fields, e.g. 2 for 3.2. Absent means 0. */
+	addedInMinorVersion?: number;
 	fields: Record<string, FieldLensDef>;
 	removedFields?: string[];
 }
@@ -51,6 +53,8 @@ export interface UnionUpgradeRegistry<ModelName extends string = string> {
 	discriminant: string;
 	/** Maps discriminant values to variant model names in the UpgradeRegistryMap. */
 	variants: Record<string, string>;
+	/** Major version each variant was added in, for variants added after the union. */
+	variantAddedInVersions?: Record<string, number>;
 }
 export type UpgradeRegistryEntry = UpgradeRegistry | UnionUpgradeRegistry;
 export type UpgradeRegistryMap = Record<string, UpgradeRegistryEntry>;
@@ -58,7 +62,8 @@ export type UpgradeRegistryMap = Record<string, UpgradeRegistryEntry>;
 * Runtime-supplied collection of forward upgrade functions. The application
 * passes a `DocumentUpgradeFns` value to the generated `DocumentModel(...)`
 * factory at boot; the factory installs it on the schema's metadata under
-* this loose shape: `fns[modelName][\`v${addedInVersion}\`][fieldName] -> fn`.
+* this loose shape: `fns[modelName][stepKey][fieldName] -> fn`, where `stepKey` is
+* `v2` for version 2.0 and `v2_1` for version 2.1.
 *
 * The generated `DocumentUpgradeFns` interface is a precisely-typed refinement
 * of this shape; both `BaseYjsDocumentService` and `applyReadLens` read from

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

@@ -1 +1 @@
-{"mappings":";AAiBA,YAAY,sBACR;CAAE,MAAM;IACR;CAAE,MAAM;CAAY;IACpB;CAAE,MAAM;CAAS,SAAS;IAC1B;CAAE,MAAM;CAAO,OAAO;IACtB;CAAE,MAAM;CAAY,OAAO;;AAE/B,iBAAiB,aAAa;;;;;;;CAO5B;;AAGF,iBAAiB,SAAS;CACxB,MAAM;CACN;;AAGF,iBAAiB,eAAe;;CAE9B;CACA,QAAQ,eAAe;CACvB;;AAGF,iBAAiB,gBAAgB,mCAAmC;CAClE,WAAW;;CAEX,WAAW,eAAe;;CAE1B,OAAO;;;;;;;AAQT,iBAAiB,qBAAqB,mCAAmC;CACvE,WAAW;;CAEX;;CAEA,UAAU;;AAGZ,YAAY,uBAAuB,kBAAkB;AAErD,YAAY,qBAAqB,eAAe;;;;;;;;;;;;;;AAehD,YAAY,aAAa,eAEvB,eAAe,gBAAgB","names":[],"sources":["../../../src/types/UpgradeLens.ts"],"version":3,"file":"UpgradeLens.d.ts"}
+{"mappings":";AAiBA,YAAY,sBACR;CAAE,MAAM;IACR;CAAE,MAAM;CAAY;IACpB;CAAE,MAAM;CAAS,SAAS;IAC1B;CAAE,MAAM;CAAO,OAAO;IACtB;CAAE,MAAM;CAAY,OAAO;;AAE/B,iBAAiB,aAAa;;;;;;;CAO5B;;AAGF,iBAAiB,SAAS;CACxB,MAAM;CACN;;AAGF,iBAAiB,eAAe;;CAE9B;;CAEA;CACA,QAAQ,eAAe;CACvB;;AAGF,iBAAiB,gBAAgB,mCAAmC;CAClE,WAAW;;CAEX,WAAW,eAAe;;CAE1B,OAAO;;;;;;;AAQT,iBAAiB,qBAAqB,mCAAmC;CACvE,WAAW;;CAEX;;CAEA,UAAU;;CAEV,yBAAyB;;AAG3B,YAAY,uBAAuB,kBAAkB;AAErD,YAAY,qBAAqB,eAAe;;;;;;;;;;;;;;;AAgBhD,YAAY,aAAa,eAEvB,eAAe,gBAAgB","names":[],"sources":["../../../src/types/UpgradeLens.ts"],"version":3,"file":"UpgradeLens.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palantir/pack.document-schema.model-types",
-  "version": "0.32.0",
+  "version": "0.34.0",
   "description": "Minimal types supporting generated PACK schemas",
   "license": "Apache-2.0",
   "repository": {
@@ -21,14 +21,14 @@
       "browser": "./build/browser/public/*.js",
       "import": {
         "types": "./build/types/public/*.d.ts",
-        "default": "./build/js/public/*.js"
+        "default": "./build/esm/public/*.js"
       },
-      "require": "./build/cjs/public/*.js",
+      "require": "./build/cjs/public/*.cjs",
       "default": "./build/browser/public/*.js"
     }
   },
   "dependencies": {
-    "@palantir/pack.core": "~0.32.0"
+    "@palantir/pack.core": "~0.34.0"
   },
   "peerDependencies": {
     "zod": "^4.1.7"

package/src/index.ts

@@ -24,6 +24,8 @@ export type {
   ActivityEventDataDocumentDiscretionarySecurityUpdate,
   ActivityEventDataDocumentMandatorySecurityUpdate,
   ActivityEventDataDocumentRename,
+  ActivityEventDataPublishedVersionCreate,
+  ActivityEventDataPublishedVersionDelete,
   ActivityEventDataUnknown,
   ActivityEventId,
 } from "./types/ActivityEvent.js";

package/src/types/ActivityEvent.ts

@@ -20,6 +20,7 @@ import type {
   DocumentSecurityMandatory,
 } from "./DocumentMetadata.js";
 import type { Model, ModelData } from "./Model.js";
+import type { PublishedVersionId } from "./PublishedVersion.js";
 import type { UserId } from "./UserRef.js";
 
 export type ActivityEventId = Flavored<"pack:EventId">;
@@ -31,6 +32,8 @@ export const ActivityEventDataType = {
   DOCUMENT_RENAME: "documentRename",
   DOCUMENT_MANDATORY_SECURITY_UPDATE: "documentMandatorySecurityUpdate",
   DOCUMENT_DISCRETIONARY_SECURITY_UPDATE: "documentDiscretionarySecurityUpdate",
+  PUBLISHED_VERSION_CREATE: "publishedVersionCreate",
+  PUBLISHED_VERSION_DELETE: "publishedVersionDelete",
   UNKNOWN: "unknown",
 } as const;
 
@@ -113,6 +116,26 @@ export interface ActivityEventDataDocumentMandatorySecurityUpdate {
   readonly newMarkings: readonly string[];
 }
 
+/**
+ * Activity event emitted when a published version of a document is created.
+ */
+export interface ActivityEventDataPublishedVersionCreate {
+  readonly type: typeof ActivityEventDataType.PUBLISHED_VERSION_CREATE;
+  readonly publishedVersionId: PublishedVersionId;
+  readonly name?: string;
+  readonly description?: string;
+}
+
+/**
+ * Activity event emitted when a published version of a document is deleted.
+ */
+export interface ActivityEventDataPublishedVersionDelete {
+  readonly type: typeof ActivityEventDataType.PUBLISHED_VERSION_DELETE;
+  readonly publishedVersionId: PublishedVersionId;
+  readonly name?: string;
+  readonly description?: string;
+}
+
 /**
  * Fallback for unrecognized activity event types.
  *
@@ -134,6 +157,8 @@ export type ActivityEventData =
   | ActivityEventDataDocumentRename
   | ActivityEventDataDocumentMandatorySecurityUpdate
   | ActivityEventDataDocumentDiscretionarySecurityUpdate
+  | ActivityEventDataPublishedVersionCreate
+  | ActivityEventDataPublishedVersionDelete
   | ActivityEventDataUnknown;
 
 /**

package/src/types/UpgradeLens.ts

@@ -38,8 +38,10 @@ export interface FieldDef {
 }
 
 export interface UpgradeStepDef {
-  /** Schema version this step upgrades to. Unique within a model's chain. */
+  /** Major version that added this step's fields, e.g. 3 for a step added in 3.2. */
   addedInVersion: number;
+  /** Minor version that added this step's fields, e.g. 2 for 3.2. Absent means 0. */
+  addedInMinorVersion?: number;
   fields: Record<string, FieldLensDef>;
   removedFields?: string[];
 }
@@ -63,6 +65,8 @@ export interface UnionUpgradeRegistry<ModelName extends string = string> {
   discriminant: string;
   /** Maps discriminant values to variant model names in the UpgradeRegistryMap. */
   variants: Record<string, string>;
+  /** Major version each variant was added in, for variants added after the union. */
+  variantAddedInVersions?: Record<string, number>;
 }
 
 export type UpgradeRegistryEntry = UpgradeRegistry | UnionUpgradeRegistry;
@@ -73,7 +77,8 @@ export type UpgradeRegistryMap = Record<string, UpgradeRegistryEntry>;
  * Runtime-supplied collection of forward upgrade functions. The application
  * passes a `DocumentUpgradeFns` value to the generated `DocumentModel(...)`
  * factory at boot; the factory installs it on the schema's metadata under
- * this loose shape: `fns[modelName][\`v${addedInVersion}\`][fieldName] -> fn`.
+ * this loose shape: `fns[modelName][stepKey][fieldName] -> fn`, where `stepKey` is
+ * `v2` for version 2.0 and `v2_1` for version 2.1.
  *
  * The generated `DocumentUpgradeFns` interface is a precisely-typed refinement
  * of this shape; both `BaseYjsDocumentService` and `applyReadLens` read from