@palantir/pack.document-schema.model-types 0.31.0 → 0.33.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.
- package/.turbo/turbo-lint.log +1 -1
- package/.turbo/turbo-transpileBrowser.log +1 -1
- package/.turbo/turbo-transpileCjs.log +1 -1
- package/.turbo/turbo-transpileEsm.log +1 -1
- package/.turbo/turbo-transpileTypes.log +1 -1
- package/.turbo/turbo-typecheck.log +1 -1
- package/CHANGELOG.md +23 -0
- package/build/browser/index.js +6 -1
- package/build/browser/index.js.map +1 -1
- package/build/cjs/index.cjs +6 -0
- package/build/cjs/index.cjs.map +1 -1
- package/build/cjs/index.d.cts +230 -194
- package/build/esm/index.js +6 -1
- package/build/esm/index.js.map +1 -1
- package/build/types/index.d.ts +3 -1
- package/build/types/index.d.ts.map +1 -1
- package/build/types/types/ActivityEvent.d.ts +22 -1
- package/build/types/types/ActivityEvent.d.ts.map +1 -1
- package/build/types/types/UnknownUnionVariant.d.ts +10 -0
- package/build/types/types/UnknownUnionVariant.d.ts.map +1 -0
- package/build/types/types/UpgradeLens.d.ts +5 -2
- package/build/types/types/UpgradeLens.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +4 -0
- package/src/types/ActivityEvent.ts +25 -0
- package/src/types/UnknownUnionVariant.ts +27 -0
- package/src/types/UpgradeLens.ts +5 -2
package/build/types/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { ActivityEventDataType } from "./types/ActivityEvent.js";
|
|
2
|
-
export type { ActivityEvent, ActivityEventData, ActivityEventDataCustom, ActivityEventDataDocumentCreate, ActivityEventDataDocumentDescriptionUpdate, ActivityEventDataDocumentDiscretionarySecurityUpdate, ActivityEventDataDocumentMandatorySecurityUpdate, ActivityEventDataDocumentRename, ActivityEventDataUnknown, ActivityEventId } from "./types/ActivityEvent.js";
|
|
2
|
+
export type { ActivityEvent, ActivityEventData, ActivityEventDataCustom, ActivityEventDataDocumentCreate, ActivityEventDataDocumentDescriptionUpdate, ActivityEventDataDocumentDiscretionarySecurityUpdate, ActivityEventDataDocumentMandatorySecurityUpdate, ActivityEventDataDocumentRename, ActivityEventDataPublishedVersionCreate, ActivityEventDataPublishedVersionDelete, ActivityEventDataUnknown, ActivityEventId } from "./types/ActivityEvent.js";
|
|
3
3
|
export { ChannelErrorCode, toChannelError, toUnknownChannelError } from "./types/ChannelError.js";
|
|
4
4
|
export type { ChannelError } from "./types/ChannelError.js";
|
|
5
5
|
export type { DiscretionaryPrincipal, DiscretionaryPrincipal_All, DiscretionaryPrincipal_GroupId, DiscretionaryPrincipal_UserId, DocumentMetadata, DocumentOperation, DocumentSecurity, DocumentSecurityDiscretionary, DocumentSecurityMandatory } from "./types/DocumentMetadata.js";
|
|
@@ -24,6 +24,8 @@ export type { RecordId, RecordRef } from "./types/RecordRef.js";
|
|
|
24
24
|
export { RecordInvalidError } from "./types/RecordValidation.js";
|
|
25
25
|
export type { RecordValidationError, RecordValidationIssue } from "./types/RecordValidation.js";
|
|
26
26
|
export type { ResourceRid } from "./types/ResourceRid.js";
|
|
27
|
+
export { UNKNOWN_UNION_VARIANT } from "./types/UnknownUnionVariant.js";
|
|
28
|
+
export type { UnknownUnionVariant } from "./types/UnknownUnionVariant.js";
|
|
27
29
|
export type { Unsubscribe } from "./types/Unsubscribe.js";
|
|
28
30
|
export type { FieldDef, FieldLensDef, FieldTypeDescriptor, UnionUpgradeRegistry, UpgradeFns, UpgradeRegistry, UpgradeRegistryEntry, UpgradeRegistryMap, UpgradeStepDef } from "./types/UpgradeLens.js";
|
|
29
31
|
export { UserRefBrand } from "./types/UserRef.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,SAAS,6BAA6B;AACtC,cACE,eACA,mBACA,yBACA,iCACA,4CACA,sDACA,kDACA,iCACA,0BACA,uBACK;AACP,SAAS,kBAAkB,gBAAgB,6BAA6B;AACxE,cAAc,oBAAoB;AAClC,cACE,wBACA,4BACA,gCACA,+BACA,kBACA,mBACA,kBACA,+BACA,iCACK;AACP,SAAS,wBAAwB;AACjC,cACE,YACA,aACA,wBACA,mCACK;AACP,cACE,gBACA,wBACA,qBACK;AACP,SAAS,qBAAqB;AAC9B,cAAc,SAAS,gBAAgB;AACvC,SAAS,aAAa,aAAa,gBAAgB;AACnD,cAAc,oBAAoB;AAClC,SAAS,uBAAuB;AAChC,cACE,iBACA,OACA,WACA,eACA,aACA,kBACK;AACP,SAAS,sBAAsB;AAC/B,cAAc,UAAU,iBAAiB;AACzC,SAAS,6BAA6B;AACtC,cACE,eACA,mBACA,0BACA,yBACA,2BACA,gCACK;AACP,cACE,kBACA,6BACA,0BACK;AACP,SAAS,gCAAgC;AACzC,cAAc,2BAA2B;AACzC,SAAS,sBAAsB;AAC/B,cAAc,UAAU,iBAAiB;AACzC,SAAS,0BAA0B;AACnC,cAAc,uBAAuB,6BAA6B;AAClE,cAAc,mBAAmB;AACjC,cAAc,mBAAmB;AACjC,cACE,UACA,cACA,qBACA,sBACA,YACA,iBACA,sBACA,oBACA,sBACK;AACP,SAAS,oBAAoB;AAC7B,cAAc,QAAQ,eAAe;AACrC,YAAY,oBAAoB;AAChC,YAAY,oBAAoB","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}
|
|
1
|
+
{"mappings":"AAgBA,SAAS,6BAA6B;AACtC,cACE,eACA,mBACA,yBACA,iCACA,4CACA,sDACA,kDACA,iCACA,yCACA,yCACA,0BACA,uBACK;AACP,SAAS,kBAAkB,gBAAgB,6BAA6B;AACxE,cAAc,oBAAoB;AAClC,cACE,wBACA,4BACA,gCACA,+BACA,kBACA,mBACA,kBACA,+BACA,iCACK;AACP,SAAS,wBAAwB;AACjC,cACE,YACA,aACA,wBACA,mCACK;AACP,cACE,gBACA,wBACA,qBACK;AACP,SAAS,qBAAqB;AAC9B,cAAc,SAAS,gBAAgB;AACvC,SAAS,aAAa,aAAa,gBAAgB;AACnD,cAAc,oBAAoB;AAClC,SAAS,uBAAuB;AAChC,cACE,iBACA,OACA,WACA,eACA,aACA,kBACK;AACP,SAAS,sBAAsB;AAC/B,cAAc,UAAU,iBAAiB;AACzC,SAAS,6BAA6B;AACtC,cACE,eACA,mBACA,0BACA,yBACA,2BACA,gCACK;AACP,cACE,kBACA,6BACA,0BACK;AACP,SAAS,gCAAgC;AACzC,cAAc,2BAA2B;AACzC,SAAS,sBAAsB;AAC/B,cAAc,UAAU,iBAAiB;AACzC,SAAS,0BAA0B;AACnC,cAAc,uBAAuB,6BAA6B;AAClE,cAAc,mBAAmB;AACjC,SAAS,6BAA6B;AACtC,cAAc,2BAA2B;AACzC,cAAc,mBAAmB;AACjC,cACE,UACA,cACA,qBACA,sBACA,YACA,iBACA,sBACA,oBACA,sBACK;AACP,SAAS,oBAAoB;AAC7B,cAAc,QAAQ,eAAe;AACrC,YAAY,oBAAoB;AAChC,YAAY,oBAAoB","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { Flavored } from "@palantir/pack.core";
|
|
2
2
|
import type { DocumentSecurityDiscretionary, DocumentSecurityMandatory } from "./DocumentMetadata.js";
|
|
3
3
|
import type { Model, ModelData } from "./Model.js";
|
|
4
|
+
import type { PublishedVersionId } from "./PublishedVersion.js";
|
|
4
5
|
import type { UserId } from "./UserRef.js";
|
|
5
6
|
export type ActivityEventId = Flavored<"pack:EventId">;
|
|
6
7
|
export declare const ActivityEventDataType: {
|
|
@@ -10,6 +11,8 @@ export declare const ActivityEventDataType: {
|
|
|
10
11
|
readonly DOCUMENT_RENAME: "documentRename";
|
|
11
12
|
readonly DOCUMENT_MANDATORY_SECURITY_UPDATE: "documentMandatorySecurityUpdate";
|
|
12
13
|
readonly DOCUMENT_DISCRETIONARY_SECURITY_UPDATE: "documentDiscretionarySecurityUpdate";
|
|
14
|
+
readonly PUBLISHED_VERSION_CREATE: "publishedVersionCreate";
|
|
15
|
+
readonly PUBLISHED_VERSION_DELETE: "publishedVersionDelete";
|
|
13
16
|
readonly UNKNOWN: "unknown";
|
|
14
17
|
};
|
|
15
18
|
/**
|
|
@@ -86,6 +89,24 @@ export interface ActivityEventDataDocumentMandatorySecurityUpdate {
|
|
|
86
89
|
readonly newMarkings: readonly string[];
|
|
87
90
|
}
|
|
88
91
|
/**
|
|
92
|
+
* Activity event emitted when a published version of a document is created.
|
|
93
|
+
*/
|
|
94
|
+
export interface ActivityEventDataPublishedVersionCreate {
|
|
95
|
+
readonly type: typeof ActivityEventDataType.PUBLISHED_VERSION_CREATE;
|
|
96
|
+
readonly publishedVersionId: PublishedVersionId;
|
|
97
|
+
readonly name?: string;
|
|
98
|
+
readonly description?: string;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Activity event emitted when a published version of a document is deleted.
|
|
102
|
+
*/
|
|
103
|
+
export interface ActivityEventDataPublishedVersionDelete {
|
|
104
|
+
readonly type: typeof ActivityEventDataType.PUBLISHED_VERSION_DELETE;
|
|
105
|
+
readonly publishedVersionId: PublishedVersionId;
|
|
106
|
+
readonly name?: string;
|
|
107
|
+
readonly description?: string;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
89
110
|
* Fallback for unrecognized activity event types.
|
|
90
111
|
*
|
|
91
112
|
* This allows some flexibility with new event types added to the platform.
|
|
@@ -98,7 +119,7 @@ export interface ActivityEventDataUnknown {
|
|
|
98
119
|
readonly rawType: string;
|
|
99
120
|
readonly rawData: unknown;
|
|
100
121
|
}
|
|
101
|
-
export type ActivityEventData = ActivityEventDataCustom | ActivityEventDataDocumentCreate | ActivityEventDataDocumentDescriptionUpdate | ActivityEventDataDocumentRename | ActivityEventDataDocumentMandatorySecurityUpdate | ActivityEventDataDocumentDiscretionarySecurityUpdate | ActivityEventDataUnknown;
|
|
122
|
+
export type ActivityEventData = ActivityEventDataCustom | ActivityEventDataDocumentCreate | ActivityEventDataDocumentDescriptionUpdate | ActivityEventDataDocumentRename | ActivityEventDataDocumentMandatorySecurityUpdate | ActivityEventDataDocumentDiscretionarySecurityUpdate | ActivityEventDataPublishedVersionCreate | ActivityEventDataPublishedVersionDelete | ActivityEventDataUnknown;
|
|
102
123
|
/**
|
|
103
124
|
* An event representing an activity that has occurred on a document. This
|
|
104
125
|
* includes standard document events as well as custom application-specific
|
|
@@ -1 +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"}
|
|
1
|
+
{"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"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/** The discriminant value of a union variant this SDK doesn't know. Reserved: no real variant can use it. */
|
|
2
|
+
export declare const UNKNOWN_UNION_VARIANT = "unknown";
|
|
3
|
+
/**
|
|
4
|
+
* A union value whose variant this SDK doesn't know, e.g. one added by a newer version of the app.
|
|
5
|
+
* Every generated union includes this case. `rawValue` is the stored value, kept as-is: saving a
|
|
6
|
+
* record or list that contains it writes it back unchanged.
|
|
7
|
+
*/
|
|
8
|
+
export type UnknownUnionVariant<D extends string> = { readonly [K in D] : typeof UNKNOWN_UNION_VARIANT } & {
|
|
9
|
+
readonly rawValue?: unknown;
|
|
10
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":";AAiBA,OAAO,cAAM,wBAAwB;;;;;;AAOrC,YAAY,oBAAoB,gCAChB,KAAK,YAAW,0BAC5B;UAAW","names":[],"sources":["../../../src/types/UnknownUnionVariant.ts"],"version":3,"file":"UnknownUnionVariant.d.ts"}
|
|
@@ -28,8 +28,10 @@ export interface FieldDef {
|
|
|
28
28
|
addedInVersion?: number;
|
|
29
29
|
}
|
|
30
30
|
export interface UpgradeStepDef {
|
|
31
|
-
/**
|
|
31
|
+
/** Major version that added this step's fields, e.g. 3 for a step added in 3.2. */
|
|
32
32
|
addedInVersion: number;
|
|
33
|
+
/** Minor version that added this step's fields, e.g. 2 for 3.2. Absent means 0. */
|
|
34
|
+
addedInMinorVersion?: number;
|
|
33
35
|
fields: Record<string, FieldLensDef>;
|
|
34
36
|
removedFields?: string[];
|
|
35
37
|
}
|
|
@@ -58,7 +60,8 @@ export type UpgradeRegistryMap = Record<string, UpgradeRegistryEntry>;
|
|
|
58
60
|
* Runtime-supplied collection of forward upgrade functions. The application
|
|
59
61
|
* passes a `DocumentUpgradeFns` value to the generated `DocumentModel(...)`
|
|
60
62
|
* factory at boot; the factory installs it on the schema's metadata under
|
|
61
|
-
* this loose shape: `fns[modelName][
|
|
63
|
+
* this loose shape: `fns[modelName][stepKey][fieldName] -> fn`, where `stepKey` is
|
|
64
|
+
* `v2` for version 2.0 and `v2_1` for version 2.1.
|
|
62
65
|
*
|
|
63
66
|
* The generated `DocumentUpgradeFns` interface is a precisely-typed refinement
|
|
64
67
|
* of this shape; both `BaseYjsDocumentService` and `applyReadLens` read from
|
|
@@ -1 +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
|
|
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;;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;;AAGZ,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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@palantir/pack.document-schema.model-types",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.33.0",
|
|
4
4
|
"description": "Minimal types supporting generated PACK schemas",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
}
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@palantir/pack.core": "~0.
|
|
31
|
+
"@palantir/pack.core": "~0.33.0"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
34
|
"zod": "^4.1.7"
|
package/src/index.ts
CHANGED
|
@@ -24,6 +24,8 @@ export type {
|
|
|
24
24
|
ActivityEventDataDocumentDiscretionarySecurityUpdate,
|
|
25
25
|
ActivityEventDataDocumentMandatorySecurityUpdate,
|
|
26
26
|
ActivityEventDataDocumentRename,
|
|
27
|
+
ActivityEventDataPublishedVersionCreate,
|
|
28
|
+
ActivityEventDataPublishedVersionDelete,
|
|
27
29
|
ActivityEventDataUnknown,
|
|
28
30
|
ActivityEventId,
|
|
29
31
|
} from "./types/ActivityEvent.js";
|
|
@@ -88,6 +90,8 @@ export type { RecordId, RecordRef } from "./types/RecordRef.js";
|
|
|
88
90
|
export { RecordInvalidError } from "./types/RecordValidation.js";
|
|
89
91
|
export type { RecordValidationError, RecordValidationIssue } from "./types/RecordValidation.js";
|
|
90
92
|
export type { ResourceRid } from "./types/ResourceRid.js";
|
|
93
|
+
export { UNKNOWN_UNION_VARIANT } from "./types/UnknownUnionVariant.js";
|
|
94
|
+
export type { UnknownUnionVariant } from "./types/UnknownUnionVariant.js";
|
|
91
95
|
export type { Unsubscribe } from "./types/Unsubscribe.js";
|
|
92
96
|
export type {
|
|
93
97
|
FieldDef,
|
|
@@ -20,6 +20,7 @@ import type {
|
|
|
20
20
|
DocumentSecurityMandatory,
|
|
21
21
|
} from "./DocumentMetadata.js";
|
|
22
22
|
import type { Model, ModelData } from "./Model.js";
|
|
23
|
+
import type { PublishedVersionId } from "./PublishedVersion.js";
|
|
23
24
|
import type { UserId } from "./UserRef.js";
|
|
24
25
|
|
|
25
26
|
export type ActivityEventId = Flavored<"pack:EventId">;
|
|
@@ -31,6 +32,8 @@ export const ActivityEventDataType = {
|
|
|
31
32
|
DOCUMENT_RENAME: "documentRename",
|
|
32
33
|
DOCUMENT_MANDATORY_SECURITY_UPDATE: "documentMandatorySecurityUpdate",
|
|
33
34
|
DOCUMENT_DISCRETIONARY_SECURITY_UPDATE: "documentDiscretionarySecurityUpdate",
|
|
35
|
+
PUBLISHED_VERSION_CREATE: "publishedVersionCreate",
|
|
36
|
+
PUBLISHED_VERSION_DELETE: "publishedVersionDelete",
|
|
34
37
|
UNKNOWN: "unknown",
|
|
35
38
|
} as const;
|
|
36
39
|
|
|
@@ -113,6 +116,26 @@ export interface ActivityEventDataDocumentMandatorySecurityUpdate {
|
|
|
113
116
|
readonly newMarkings: readonly string[];
|
|
114
117
|
}
|
|
115
118
|
|
|
119
|
+
/**
|
|
120
|
+
* Activity event emitted when a published version of a document is created.
|
|
121
|
+
*/
|
|
122
|
+
export interface ActivityEventDataPublishedVersionCreate {
|
|
123
|
+
readonly type: typeof ActivityEventDataType.PUBLISHED_VERSION_CREATE;
|
|
124
|
+
readonly publishedVersionId: PublishedVersionId;
|
|
125
|
+
readonly name?: string;
|
|
126
|
+
readonly description?: string;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Activity event emitted when a published version of a document is deleted.
|
|
131
|
+
*/
|
|
132
|
+
export interface ActivityEventDataPublishedVersionDelete {
|
|
133
|
+
readonly type: typeof ActivityEventDataType.PUBLISHED_VERSION_DELETE;
|
|
134
|
+
readonly publishedVersionId: PublishedVersionId;
|
|
135
|
+
readonly name?: string;
|
|
136
|
+
readonly description?: string;
|
|
137
|
+
}
|
|
138
|
+
|
|
116
139
|
/**
|
|
117
140
|
* Fallback for unrecognized activity event types.
|
|
118
141
|
*
|
|
@@ -134,6 +157,8 @@ export type ActivityEventData =
|
|
|
134
157
|
| ActivityEventDataDocumentRename
|
|
135
158
|
| ActivityEventDataDocumentMandatorySecurityUpdate
|
|
136
159
|
| ActivityEventDataDocumentDiscretionarySecurityUpdate
|
|
160
|
+
| ActivityEventDataPublishedVersionCreate
|
|
161
|
+
| ActivityEventDataPublishedVersionDelete
|
|
137
162
|
| ActivityEventDataUnknown;
|
|
138
163
|
|
|
139
164
|
/**
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2026 Palantir Technologies, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
/** The discriminant value of a union variant this SDK doesn't know. Reserved: no real variant can use it. */
|
|
18
|
+
export const UNKNOWN_UNION_VARIANT = "unknown";
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* A union value whose variant this SDK doesn't know, e.g. one added by a newer version of the app.
|
|
22
|
+
* Every generated union includes this case. `rawValue` is the stored value, kept as-is: saving a
|
|
23
|
+
* record or list that contains it writes it back unchanged.
|
|
24
|
+
*/
|
|
25
|
+
export type UnknownUnionVariant<D extends string> =
|
|
26
|
+
& { readonly [K in D]: typeof UNKNOWN_UNION_VARIANT }
|
|
27
|
+
& { readonly rawValue?: unknown };
|
package/src/types/UpgradeLens.ts
CHANGED
|
@@ -38,8 +38,10 @@ export interface FieldDef {
|
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
export interface UpgradeStepDef {
|
|
41
|
-
/**
|
|
41
|
+
/** Major version that added this step's fields, e.g. 3 for a step added in 3.2. */
|
|
42
42
|
addedInVersion: number;
|
|
43
|
+
/** Minor version that added this step's fields, e.g. 2 for 3.2. Absent means 0. */
|
|
44
|
+
addedInMinorVersion?: number;
|
|
43
45
|
fields: Record<string, FieldLensDef>;
|
|
44
46
|
removedFields?: string[];
|
|
45
47
|
}
|
|
@@ -73,7 +75,8 @@ export type UpgradeRegistryMap = Record<string, UpgradeRegistryEntry>;
|
|
|
73
75
|
* Runtime-supplied collection of forward upgrade functions. The application
|
|
74
76
|
* passes a `DocumentUpgradeFns` value to the generated `DocumentModel(...)`
|
|
75
77
|
* factory at boot; the factory installs it on the schema's metadata under
|
|
76
|
-
* this loose shape: `fns[modelName][
|
|
78
|
+
* this loose shape: `fns[modelName][stepKey][fieldName] -> fn`, where `stepKey` is
|
|
79
|
+
* `v2` for version 2.0 and `v2_1` for version 2.1.
|
|
77
80
|
*
|
|
78
81
|
* The generated `DocumentUpgradeFns` interface is a precisely-typed refinement
|
|
79
82
|
* of this shape; both `BaseYjsDocumentService` and `applyReadLens` read from
|