@palantir/pack.document-schema.model-types 0.0.1-beta.1 → 0.1.0-beta.3

package/.turbo/turbo-lint.log

@@ -1,10 +1,4 @@
 
-> @palantir/pack.document-schema.model-types@0.0.1-beta.1 lint /home/runner/work/pack/pack/packages/document-schema/model-types
+> @palantir/pack.document-schema.model-types@0.1.0-beta.3 lint /home/runner/work/pack/pack/packages/document-schema/model-types
 > eslint ./src ; dprint check --config $(find-up dprint.json) --allow-no-files
 
-Compiling https://plugins.dprint.dev/g-plane/markup_fmt-v0.23.1.wasm
-Compiling https://plugins.dprint.dev/json-0.20.0.wasm
-Compiling https://plugins.dprint.dev/g-plane/malva-v0.14.2.wasm
-Compiling https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.1.wasm
-Compiling https://plugins.dprint.dev/typescript-0.95.10.wasm
-Compiling https://plugins.dprint.dev/markdown-0.19.0.wasm

package/.turbo/turbo-transpileBrowser.log

@@ -1,5 +1,5 @@
 
-> @palantir/pack.document-schema.model-types@0.0.1-beta.1 transpileBrowser /home/runner/work/pack/pack/packages/document-schema/model-types
+> @palantir/pack.document-schema.model-types@0.1.0-beta.3 transpileBrowser /home/runner/work/pack/pack/packages/document-schema/model-types
 > monorepo-transpile -f esm -m bundle -t browser
 
 👍

package/.turbo/turbo-transpileCjs.log

@@ -1,5 +1,5 @@
 
-> @palantir/pack.document-schema.model-types@0.0.1-beta.1 transpileCjs /home/runner/work/pack/pack/packages/document-schema/model-types
+> @palantir/pack.document-schema.model-types@0.1.0-beta.3 transpileCjs /home/runner/work/pack/pack/packages/document-schema/model-types
 > monorepo-transpile -f cjs -m bundle -t node
 
 👍

package/.turbo/turbo-transpileEsm.log

@@ -1,5 +1,5 @@
 
-> @palantir/pack.document-schema.model-types@0.0.1-beta.1 transpileEsm /home/runner/work/pack/pack/packages/document-schema/model-types
+> @palantir/pack.document-schema.model-types@0.1.0-beta.3 transpileEsm /home/runner/work/pack/pack/packages/document-schema/model-types
 > monorepo-transpile -f esm -m bundle -t node
 
 👍

package/.turbo/turbo-transpileTypes.log

@@ -1,5 +1,5 @@
 
-> @palantir/pack.document-schema.model-types@0.0.1-beta.1 transpileTypes /home/runner/work/pack/pack/packages/document-schema/model-types
+> @palantir/pack.document-schema.model-types@0.1.0-beta.3 transpileTypes /home/runner/work/pack/pack/packages/document-schema/model-types
 > monorepo-transpile -f esm -m types -t node
 
 👍

package/.turbo/turbo-typecheck.log

@@ -1,4 +1,4 @@
 
-> @palantir/pack.document-schema.model-types@0.0.1-beta.1 typecheck /home/runner/work/pack/pack/packages/document-schema/model-types
+> @palantir/pack.document-schema.model-types@0.1.0-beta.3 typecheck /home/runner/work/pack/pack/packages/document-schema/model-types
 > tsc --noEmit --emitDeclarationOnly false
 

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @palantir/pack.document-schema.model-types
+
+## 0.1.0-beta.3
+
+### Minor Changes
+
+- 77c07c4: Add Core and State Core packages, add Refs to core model types
+
+### Patch Changes
+
+- Updated dependencies [77c07c4]
+  - @palantir/pack.core@0.1.0-beta.2
+
+## 0.1.0-beta.2
+
+### Minor Changes
+
+- 27a3b33: Initial release
+- 511ee0c: Resetting to beta version of package

package/build/browser/index.js

@@ -1,5 +1,11 @@
+// src/types/DocumentRef.ts
+var DocumentRefBrand = Symbol("pack:DocumentRef");
+
+// src/types/MediaRef.ts
+var MediaRefBrand = Symbol("pack:MediaRef");
+
 // src/types/Metadata.ts
-var Metadata = Symbol("@pack/document-schema/metadata");
+var Metadata = Symbol("@palantir/pack.document-schema/metadata");
 function getMetadata(obj) {
   const metadata = obj[Metadata];
   if (metadata == null) {
@@ -8,6 +14,26 @@ function getMetadata(obj) {
   return metadata;
 }
 
-export { Metadata, getMetadata };
+// src/types/Model.ts
+var ExternalRefType = {
+  DOC_REF: "docRef",
+  MEDIA_REF: "mediaRef",
+  OBJECT_REF: "objectRef",
+  USER_REF: "userRef"
+};
+
+// src/types/ObjectRef.ts
+var ObjectRefBrand = Symbol("pack:ObjectRef");
+
+// src/types/RecordCollectionRef.ts
+var RecordCollectionRefBrand = Symbol("pack:RecordCollectionRef");
+
+// src/types/RecordRef.ts
+var RecordRefBrand = Symbol("pack:RecordRef");
+
+// src/types/UserRef.ts
+var UserRefBrand = Symbol("pack:UserRef");
+
+export { DocumentRefBrand, ExternalRefType, MediaRefBrand, Metadata, ObjectRefBrand, RecordCollectionRefBrand, RecordRefBrand, UserRefBrand, getMetadata };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/build/browser/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/Metadata.ts"],"names":[],"mappings":";AAgBO,IAAM,QAAA,GAAW,OAAO,gCAAgC;AACxD,SAAS,YAAY,GAAA,EAAK;AAE/B,EAAA,MAAM,QAAA,GAAW,IAAI,QAAQ,CAAA;AAC7B,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,MAAM,IAAI,MAAM,+BAA+B,CAAA;AAAA,EACjD;AACA,EAAA,OAAO,QAAA;AACT","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 Metadata = Symbol(\"@pack/document-schema/metadata\");\nexport function getMetadata(obj) {\n  // TS always treats symbol keys as optional\n  const metadata = obj[Metadata];\n  if (metadata == null) {\n    throw new Error(\"Object does not have metadata\");\n  }\n  return metadata;\n}"]}
+{"version":3,"sources":["../../src/types/DocumentRef.ts","../../src/types/MediaRef.ts","../../src/types/Metadata.ts","../../src/types/Model.ts","../../src/types/ObjectRef.ts","../../src/types/RecordCollectionRef.ts","../../src/types/RecordRef.ts","../../src/types/UserRef.ts"],"names":[],"mappings":";AAgBO,IAAM,gBAAA,GAAmB,OAAO,kBAAkB;;;ACAlD,IAAM,aAAA,GAAgB,OAAO,eAAe;;;ACA5C,IAAM,QAAA,GAAW,OAAO,yCAAyC;AACjE,SAAS,YAAY,GAAA,EAAK;AAE/B,EAAA,MAAM,QAAA,GAAW,IAAI,QAAQ,CAAA;AAC7B,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,MAAM,IAAI,MAAM,+BAA+B,CAAA;AAAA,EACjD;AACA,EAAA,OAAO,QAAA;AACT;;;ACDO,IAAM,eAAA,GAAkB;AAAA,EAC7B,OAAA,EAAS,QAAA;AAAA,EACT,SAAA,EAAW,UAAA;AAAA,EACX,UAAA,EAAY,WAAA;AAAA,EACZ,QAAA,EAAU;AACZ;;;ACZO,IAAM,cAAA,GAAiB,OAAO,gBAAgB;;;ACA9C,IAAM,wBAAA,GAA2B,OAAO,0BAA0B;;;ACAlE,IAAM,cAAA,GAAiB,OAAO,gBAAgB;;;ACA9C,IAAM,YAAA,GAAe,OAAO,cAAc","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 DocumentRefBrand = Symbol(\"pack:DocumentRef\");","/*\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 MediaRefBrand = Symbol(\"pack:MediaRef\");\n\n/**\n * @experimental\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 Metadata = Symbol(\"@palantir/pack.document-schema/metadata\");\nexport function getMetadata(obj) {\n  // TS always treats symbol keys as optional\n  const metadata = obj[Metadata];\n  if (metadata == null) {\n    throw new Error(\"Object does not have metadata\");\n  }\n  return metadata;\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\n/**\n * A Model defines the structure of a document record or union.\n *\n * It includes a zod schema for validation and type information.\n */\n// TODO: I think we can/should hide the zod types\n\nexport const ExternalRefType = {\n  DOC_REF: \"docRef\",\n  MEDIA_REF: \"mediaRef\",\n  OBJECT_REF: \"objectRef\",\n  USER_REF: \"userRef\"\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 ObjectRefBrand = Symbol(\"pack:ObjectRef\");\n\n/**\n * @experimental\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 RecordCollectionRefBrand = Symbol(\"pack:RecordCollectionRef\");","/*\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 RecordRefBrand = Symbol(\"pack:RecordRef\");","/*\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 UserRefBrand = Symbol(\"pack:UserRef\");"]}

package/build/cjs/index.cjs

@@ -1,7 +1,13 @@
 'use strict';
 
+// src/types/DocumentRef.ts
+var DocumentRefBrand = Symbol("pack:DocumentRef");
+
+// src/types/MediaRef.ts
+var MediaRefBrand = Symbol("pack:MediaRef");
+
 // src/types/Metadata.ts
-var Metadata = Symbol("@pack/document-schema/metadata");
+var Metadata = Symbol("@palantir/pack.document-schema/metadata");
 function getMetadata(obj) {
   const metadata = obj[Metadata];
   if (metadata == null) {
@@ -10,7 +16,34 @@ function getMetadata(obj) {
   return metadata;
 }
 
+// src/types/Model.ts
+var ExternalRefType = {
+  DOC_REF: "docRef",
+  MEDIA_REF: "mediaRef",
+  OBJECT_REF: "objectRef",
+  USER_REF: "userRef"
+};
+
+// src/types/ObjectRef.ts
+var ObjectRefBrand = Symbol("pack:ObjectRef");
+
+// src/types/RecordCollectionRef.ts
+var RecordCollectionRefBrand = Symbol("pack:RecordCollectionRef");
+
+// src/types/RecordRef.ts
+var RecordRefBrand = Symbol("pack:RecordRef");
+
+// src/types/UserRef.ts
+var UserRefBrand = Symbol("pack:UserRef");
+
+exports.DocumentRefBrand = DocumentRefBrand;
+exports.ExternalRefType = ExternalRefType;
+exports.MediaRefBrand = MediaRefBrand;
 exports.Metadata = Metadata;
+exports.ObjectRefBrand = ObjectRefBrand;
+exports.RecordCollectionRefBrand = RecordCollectionRefBrand;
+exports.RecordRefBrand = RecordRefBrand;
+exports.UserRefBrand = UserRefBrand;
 exports.getMetadata = getMetadata;
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/build/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/Metadata.ts"],"names":[],"mappings":";;;AAgBO,IAAM,QAAA,GAAW,OAAO,gCAAgC;AACxD,SAAS,YAAY,GAAA,EAAK;AAE/B,EAAA,MAAM,QAAA,GAAW,IAAI,QAAQ,CAAA;AAC7B,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,MAAM,IAAI,MAAM,+BAA+B,CAAA;AAAA,EACjD;AACA,EAAA,OAAO,QAAA;AACT","file":"index.cjs","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 Metadata = Symbol(\"@pack/document-schema/metadata\");\nexport function getMetadata(obj) {\n  // TS always treats symbol keys as optional\n  const metadata = obj[Metadata];\n  if (metadata == null) {\n    throw new Error(\"Object does not have metadata\");\n  }\n  return metadata;\n}"]}
+{"version":3,"sources":["../../src/types/DocumentRef.ts","../../src/types/MediaRef.ts","../../src/types/Metadata.ts","../../src/types/Model.ts","../../src/types/ObjectRef.ts","../../src/types/RecordCollectionRef.ts","../../src/types/RecordRef.ts","../../src/types/UserRef.ts"],"names":[],"mappings":";;;AAgBO,IAAM,gBAAA,GAAmB,OAAO,kBAAkB;;;ACAlD,IAAM,aAAA,GAAgB,OAAO,eAAe;;;ACA5C,IAAM,QAAA,GAAW,OAAO,yCAAyC;AACjE,SAAS,YAAY,GAAA,EAAK;AAE/B,EAAA,MAAM,QAAA,GAAW,IAAI,QAAQ,CAAA;AAC7B,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,MAAM,IAAI,MAAM,+BAA+B,CAAA;AAAA,EACjD;AACA,EAAA,OAAO,QAAA;AACT;;;ACDO,IAAM,eAAA,GAAkB;AAAA,EAC7B,OAAA,EAAS,QAAA;AAAA,EACT,SAAA,EAAW,UAAA;AAAA,EACX,UAAA,EAAY,WAAA;AAAA,EACZ,QAAA,EAAU;AACZ;;;ACZO,IAAM,cAAA,GAAiB,OAAO,gBAAgB;;;ACA9C,IAAM,wBAAA,GAA2B,OAAO,0BAA0B;;;ACAlE,IAAM,cAAA,GAAiB,OAAO,gBAAgB;;;ACA9C,IAAM,YAAA,GAAe,OAAO,cAAc","file":"index.cjs","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 DocumentRefBrand = Symbol(\"pack:DocumentRef\");","/*\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 MediaRefBrand = Symbol(\"pack:MediaRef\");\n\n/**\n * @experimental\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 Metadata = Symbol(\"@palantir/pack.document-schema/metadata\");\nexport function getMetadata(obj) {\n  // TS always treats symbol keys as optional\n  const metadata = obj[Metadata];\n  if (metadata == null) {\n    throw new Error(\"Object does not have metadata\");\n  }\n  return metadata;\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\n/**\n * A Model defines the structure of a document record or union.\n *\n * It includes a zod schema for validation and type information.\n */\n// TODO: I think we can/should hide the zod types\n\nexport const ExternalRefType = {\n  DOC_REF: \"docRef\",\n  MEDIA_REF: \"mediaRef\",\n  OBJECT_REF: \"objectRef\",\n  USER_REF: \"userRef\"\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 ObjectRefBrand = Symbol(\"pack:ObjectRef\");\n\n/**\n * @experimental\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 RecordCollectionRefBrand = Symbol(\"pack:RecordCollectionRef\");","/*\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 RecordRefBrand = Symbol(\"pack:RecordRef\");","/*\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 UserRefBrand = Symbol(\"pack:UserRef\");"]}

package/build/cjs/index.d.cts

@@ -1,5 +1,36 @@
+import { Flavored } from '@palantir/pack.core';
 import { ZodType } from 'zod';
 
+interface DiscretionaryPrincipal_All {
+    "all": Record<string, never>;
+    "type": "all";
+}
+interface DiscretionaryPrincipal_UserId {
+    "type": "userId";
+    "userId": string;
+}
+interface DiscretionaryPrincipal_GroupId {
+    "groupId": string;
+    "type": "groupId";
+}
+type DiscretionaryPrincipal = DiscretionaryPrincipal_All | DiscretionaryPrincipal_GroupId | DiscretionaryPrincipal_UserId;
+interface DocumentMetadata {
+    readonly documentTypeName: string;
+    readonly name: string;
+    readonly ontologyRid: string;
+    readonly security: {
+        readonly discretionary: {
+            readonly editors?: readonly DiscretionaryPrincipal[];
+            readonly owners: readonly DiscretionaryPrincipal[];
+            readonly viewers?: readonly DiscretionaryPrincipal[];
+        };
+        readonly mandatory: {
+            readonly classification?: readonly string[];
+            readonly markings?: readonly string[];
+        };
+    };
+}
+
 declare const Metadata: symbol;
 interface WithMetadata<T> {
     readonly [Metadata]: T;
@@ -11,12 +42,20 @@ declare function getMetadata<T>(obj: WithMetadata<T>): T;
  *
  * It includes a zod schema for validation and type information.
  */
-interface Model<T = unknown, Z extends ZodType<T> = ZodType<T>> extends WithMetadata<ModelMetadata> {
+interface Model<T = unknown, Z extends ZodType<T> = ZodType<T>> extends WithMetadata<ModelMetadata<T>> {
     readonly __type: T;
     readonly zodSchema: Readonly<Z>;
 }
 type ModelData<M extends Model> = M["__type"];
-interface ModelMetadata {
+declare const ExternalRefType: {
+    readonly DOC_REF: "docRef";
+    readonly MEDIA_REF: "mediaRef";
+    readonly OBJECT_REF: "objectRef";
+    readonly USER_REF: "userRef";
+};
+type ExternalRefType = typeof ExternalRefType[keyof typeof ExternalRefType];
+interface ModelMetadata<T = unknown> {
+    readonly externalRefFieldTypes?: Readonly<Record<keyof T, ExternalRefType>>;
     readonly name: string;
 }
 
@@ -32,4 +71,77 @@ interface DocumentSchemaMetadata {
     readonly version: number;
 }
 
-export { type DocumentSchema, type DocumentSchemaMetadata, type DocumentState, Metadata, type Model, type ModelData, type ModelMetadata, type WithMetadata, getMetadata };
+type Unsubscribe = () => void;
+
+type RecordId = Flavored<"RecordId">;
+declare const RecordRefBrand: unique symbol;
+interface RecordRef<M extends Model = Model> {
+    readonly docRef: DocumentRef;
+    readonly id: RecordId;
+    readonly model: M;
+    readonly [RecordRefBrand]: typeof RecordRefBrand;
+    getSnapshot(): Promise<ModelData<M>>;
+    onChange(callback: (snapshot: ModelData<M>, recordRef: RecordRef<M>) => void): Unsubscribe;
+    onDeleted(callback: (recordRef: RecordRef<M>) => void): Unsubscribe;
+    set(record: ModelData<M>): Promise<void>;
+}
+
+declare const RecordCollectionRefBrand: unique symbol;
+interface RecordCollectionRef<M extends Model = Model> {
+    readonly docRef: DocumentRef;
+    readonly model: M;
+    readonly [RecordCollectionRefBrand]: typeof RecordCollectionRefBrand;
+    delete(id: RecordId): Promise<void>;
+    get(id: RecordId): RecordRef<M> | undefined;
+    has(id: RecordId): boolean;
+    set(id: RecordId, state: ModelData<M>): Promise<void>;
+    readonly size: number;
+    [Symbol.iterator](): Iterator<RecordRef<M>>;
+    readonly onItemsAdded: (callback: (items: readonly RecordRef<M>[]) => void) => () => void;
+    readonly onItemsChanged: (callback: (items: readonly RecordRef<M>[]) => void) => () => void;
+    readonly onItemsDeleted: (callback: (items: readonly RecordRef<M>[]) => void) => () => void;
+}
+
+type DocumentId = Flavored<"DocumentId">;
+declare const DocumentRefBrand: unique symbol;
+interface DocumentRef<D extends DocumentSchema = DocumentSchema> {
+    readonly id: DocumentId;
+    readonly schema: D;
+    readonly [DocumentRefBrand]: typeof DocumentRefBrand;
+    readonly getDocSnapshot: () => Promise<DocumentState<D>>;
+    readonly getRecords: <R extends Model>(model: R) => RecordCollectionRef<R>;
+    readonly onMetadataChange: (callback: (docId: DocumentRef<D>, metadata: DocumentMetadata) => void) => Unsubscribe;
+    readonly onStateChange: (callback: (docRef: DocumentRef<D>) => void) => Unsubscribe;
+}
+
+type MediaId = Flavored<"MediaId">;
+declare const MediaRefBrand: unique symbol;
+/**
+ * @experimental
+ */
+interface MediaRef {
+    readonly mediaId: MediaId;
+    readonly [MediaRefBrand]: typeof MediaRefBrand;
+    readonly subscribe?: (callback: unknown) => unknown;
+}
+
+type ObjectId = Flavored<"ObjectId">;
+declare const ObjectRefBrand: unique symbol;
+/**
+ * @experimental
+ */
+interface ObjectRef {
+    readonly objectId: ObjectId;
+    readonly [ObjectRefBrand]: typeof ObjectRefBrand;
+    readonly subscribe?: (callback: unknown) => unknown;
+}
+
+type UserId = Flavored<"pack:UserId">;
+declare const UserRefBrand: unique symbol;
+interface UserRef {
+    readonly userId: UserId;
+    readonly [UserRefBrand]: typeof UserRefBrand;
+    readonly get: (force?: boolean) => Promise<unknown>;
+}
+
+export { type DiscretionaryPrincipal, type DiscretionaryPrincipal_All, type DiscretionaryPrincipal_GroupId, type DiscretionaryPrincipal_UserId, type DocumentId, type DocumentMetadata, type DocumentRef, DocumentRefBrand, type DocumentSchema, type DocumentSchemaMetadata, type DocumentState, ExternalRefType, type MediaId, type MediaRef, MediaRefBrand, Metadata, type Model, type ModelData, type ModelMetadata, type ObjectId, type ObjectRef, ObjectRefBrand, type RecordCollectionRef, RecordCollectionRefBrand, type RecordId, type RecordRef, RecordRefBrand, type Unsubscribe, type UserId, type UserRef, UserRefBrand, type WithMetadata, getMetadata };

package/build/esm/index.js

@@ -1,5 +1,11 @@
+// src/types/DocumentRef.ts
+var DocumentRefBrand = Symbol("pack:DocumentRef");
+
+// src/types/MediaRef.ts
+var MediaRefBrand = Symbol("pack:MediaRef");
+
 // src/types/Metadata.ts
-var Metadata = Symbol("@pack/document-schema/metadata");
+var Metadata = Symbol("@palantir/pack.document-schema/metadata");
 function getMetadata(obj) {
   const metadata = obj[Metadata];
   if (metadata == null) {
@@ -8,6 +14,26 @@ function getMetadata(obj) {
   return metadata;
 }
 
-export { Metadata, getMetadata };
+// src/types/Model.ts
+var ExternalRefType = {
+  DOC_REF: "docRef",
+  MEDIA_REF: "mediaRef",
+  OBJECT_REF: "objectRef",
+  USER_REF: "userRef"
+};
+
+// src/types/ObjectRef.ts
+var ObjectRefBrand = Symbol("pack:ObjectRef");
+
+// src/types/RecordCollectionRef.ts
+var RecordCollectionRefBrand = Symbol("pack:RecordCollectionRef");
+
+// src/types/RecordRef.ts
+var RecordRefBrand = Symbol("pack:RecordRef");
+
+// src/types/UserRef.ts
+var UserRefBrand = Symbol("pack:UserRef");
+
+export { DocumentRefBrand, ExternalRefType, MediaRefBrand, Metadata, ObjectRefBrand, RecordCollectionRefBrand, RecordRefBrand, UserRefBrand, getMetadata };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/build/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/Metadata.ts"],"names":[],"mappings":";AAgBO,IAAM,QAAA,GAAW,OAAO,gCAAgC;AACxD,SAAS,YAAY,GAAA,EAAK;AAE/B,EAAA,MAAM,QAAA,GAAW,IAAI,QAAQ,CAAA;AAC7B,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,MAAM,IAAI,MAAM,+BAA+B,CAAA;AAAA,EACjD;AACA,EAAA,OAAO,QAAA;AACT","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 Metadata = Symbol(\"@pack/document-schema/metadata\");\nexport function getMetadata(obj) {\n  // TS always treats symbol keys as optional\n  const metadata = obj[Metadata];\n  if (metadata == null) {\n    throw new Error(\"Object does not have metadata\");\n  }\n  return metadata;\n}"]}
+{"version":3,"sources":["../../src/types/DocumentRef.ts","../../src/types/MediaRef.ts","../../src/types/Metadata.ts","../../src/types/Model.ts","../../src/types/ObjectRef.ts","../../src/types/RecordCollectionRef.ts","../../src/types/RecordRef.ts","../../src/types/UserRef.ts"],"names":[],"mappings":";AAgBO,IAAM,gBAAA,GAAmB,OAAO,kBAAkB;;;ACAlD,IAAM,aAAA,GAAgB,OAAO,eAAe;;;ACA5C,IAAM,QAAA,GAAW,OAAO,yCAAyC;AACjE,SAAS,YAAY,GAAA,EAAK;AAE/B,EAAA,MAAM,QAAA,GAAW,IAAI,QAAQ,CAAA;AAC7B,EAAA,IAAI,YAAY,IAAA,EAAM;AACpB,IAAA,MAAM,IAAI,MAAM,+BAA+B,CAAA;AAAA,EACjD;AACA,EAAA,OAAO,QAAA;AACT;;;ACDO,IAAM,eAAA,GAAkB;AAAA,EAC7B,OAAA,EAAS,QAAA;AAAA,EACT,SAAA,EAAW,UAAA;AAAA,EACX,UAAA,EAAY,WAAA;AAAA,EACZ,QAAA,EAAU;AACZ;;;ACZO,IAAM,cAAA,GAAiB,OAAO,gBAAgB;;;ACA9C,IAAM,wBAAA,GAA2B,OAAO,0BAA0B;;;ACAlE,IAAM,cAAA,GAAiB,OAAO,gBAAgB;;;ACA9C,IAAM,YAAA,GAAe,OAAO,cAAc","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 DocumentRefBrand = Symbol(\"pack:DocumentRef\");","/*\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 MediaRefBrand = Symbol(\"pack:MediaRef\");\n\n/**\n * @experimental\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 Metadata = Symbol(\"@palantir/pack.document-schema/metadata\");\nexport function getMetadata(obj) {\n  // TS always treats symbol keys as optional\n  const metadata = obj[Metadata];\n  if (metadata == null) {\n    throw new Error(\"Object does not have metadata\");\n  }\n  return metadata;\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\n/**\n * A Model defines the structure of a document record or union.\n *\n * It includes a zod schema for validation and type information.\n */\n// TODO: I think we can/should hide the zod types\n\nexport const ExternalRefType = {\n  DOC_REF: \"docRef\",\n  MEDIA_REF: \"mediaRef\",\n  OBJECT_REF: \"objectRef\",\n  USER_REF: \"userRef\"\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 ObjectRefBrand = Symbol(\"pack:ObjectRef\");\n\n/**\n * @experimental\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 RecordCollectionRefBrand = Symbol(\"pack:RecordCollectionRef\");","/*\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 RecordRefBrand = Symbol(\"pack:RecordRef\");","/*\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 UserRefBrand = Symbol(\"pack:UserRef\");"]}

package/build/types/index.d.ts

@@ -1,4 +1,19 @@
+export type { DiscretionaryPrincipal, DiscretionaryPrincipal_All, DiscretionaryPrincipal_GroupId, DiscretionaryPrincipal_UserId, DocumentMetadata } from "./types/DocumentMetadata.js";
+export { DocumentRefBrand } from "./types/DocumentRef.js";
+export type { DocumentId, DocumentRef } from "./types/DocumentRef.js";
 export type { DocumentSchema, DocumentSchemaMetadata, DocumentState } from "./types/DocumentSchema.js";
+export { MediaRefBrand } from "./types/MediaRef.js";
+export type { MediaId, MediaRef } from "./types/MediaRef.js";
 export { getMetadata, Metadata } from "./types/Metadata.js";
 export type { WithMetadata } from "./types/Metadata.js";
+export { ExternalRefType } from "./types/Model.js";
 export type { Model, ModelData, ModelMetadata } from "./types/Model.js";
+export { ObjectRefBrand } from "./types/ObjectRef.js";
+export type { ObjectId, ObjectRef } from "./types/ObjectRef.js";
+export { RecordCollectionRefBrand } from "./types/RecordCollectionRef.js";
+export type { RecordCollectionRef } from "./types/RecordCollectionRef.js";
+export { RecordRefBrand } from "./types/RecordRef.js";
+export type { RecordId, RecordRef } from "./types/RecordRef.js";
+export type { Unsubscribe } from "./types/Unsubscribe.js";
+export { UserRefBrand } from "./types/UserRef.js";
+export type { UserId, UserRef } from "./types/UserRef.js";

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

@@ -1 +1 @@
-{"mappings":"AAgBA,cACE,gBACA,wBACA,qBACK;AACP,SAAS,aAAa,gBAAgB;AACtC,cAAc,oBAAoB;AAClC,cAAc,OAAO,WAAW,qBAAqB","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}
+{"mappings":"AAgBA,cACE,wBACA,4BACA,gCACA,+BACA,wBACK;AACP,SAAS,wBAAwB;AACjC,cAAc,YAAY,mBAAmB;AAC7C,cACE,gBACA,wBACA,qBACK;AACP,SAAS,qBAAqB;AAC9B,cAAc,SAAS,gBAAgB;AACvC,SAAS,aAAa,gBAAgB;AACtC,cAAc,oBAAoB;AAClC,SAAS,uBAAuB;AAChC,cAAc,OAAO,WAAW,qBAAqB;AACrD,SAAS,sBAAsB;AAC/B,cAAc,UAAU,iBAAiB;AACzC,SAAS,gCAAgC;AACzC,cAAc,2BAA2B;AACzC,SAAS,sBAAsB;AAC/B,cAAc,UAAU,iBAAiB;AACzC,cAAc,mBAAmB;AACjC,SAAS,oBAAoB;AAC7B,cAAc,QAAQ,eAAe","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}

package/build/types/types/DocumentMetadata.d.ts

@@ -0,0 +1,29 @@
+export interface DiscretionaryPrincipal_All {
+	"all": Record<string, never>;
+	"type": "all";
+}
+export interface DiscretionaryPrincipal_UserId {
+	"type": "userId";
+	"userId": string;
+}
+export interface DiscretionaryPrincipal_GroupId {
+	"groupId": string;
+	"type": "groupId";
+}
+export type DiscretionaryPrincipal = DiscretionaryPrincipal_All | DiscretionaryPrincipal_GroupId | DiscretionaryPrincipal_UserId;
+export interface DocumentMetadata {
+	readonly documentTypeName: string;
+	readonly name: string;
+	readonly ontologyRid: string;
+	readonly security: {
+		readonly discretionary: {
+			readonly editors?: readonly DiscretionaryPrincipal[];
+			readonly owners: readonly DiscretionaryPrincipal[];
+			readonly viewers?: readonly DiscretionaryPrincipal[];
+		};
+		readonly mandatory: {
+			readonly classification?: readonly string[];
+			readonly markings?: readonly string[];
+		};
+	};
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,iBAAiB,2BAA2B;CAC1C,OAAO;CACP,QAAQ;;AAEV,iBAAiB,8BAA8B;CAC7C,QAAQ;CACR;;AAEF,iBAAiB,+BAA+B;CAC9C;CACA,QAAQ;;AAGV,YAAY,yBACR,6BACA,iCACA;AAEJ,iBAAiB,iBAAiB;UACvB;UACA;UACA;UACA,UAAU;WACR,eAAe;YACb,mBAAmB;YACnB,iBAAiB;YACjB,mBAAmB;;WAErB,WAAW;YACT;YACA","names":[],"sources":["../../../src/types/DocumentMetadata.ts"],"version":3,"file":"DocumentMetadata.d.ts"}

package/build/types/types/DocumentRef.d.ts

@@ -0,0 +1,17 @@
+import type { Flavored } from "@palantir/pack.core";
+import type { DocumentMetadata } from "./DocumentMetadata.js";
+import type { DocumentSchema, DocumentState } from "./DocumentSchema.js";
+import type { Model } from "./Model.js";
+import type { RecordCollectionRef } from "./RecordCollectionRef.js";
+import type { Unsubscribe } from "./Unsubscribe.js";
+export type DocumentId = Flavored<"DocumentId">;
+export declare const DocumentRefBrand: unique symbol;
+export interface DocumentRef<D extends DocumentSchema = DocumentSchema> {
+	readonly id: DocumentId;
+	readonly schema: D;
+	readonly [DocumentRefBrand]: typeof DocumentRefBrand;
+	readonly getDocSnapshot: () => Promise<DocumentState<D>>;
+	readonly getRecords: <R extends Model>(model: R) => RecordCollectionRef<R>;
+	readonly onMetadataChange: (callback: (docId: DocumentRef<D>, metadata: DocumentMetadata) => void) => Unsubscribe;
+	readonly onStateChange: (callback: (docRef: DocumentRef<D>) => void) => Unsubscribe;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,gBAAgB;AAC9B,cAAc,wBAAwB;AACtC,cAAc,gBAAgB,qBAAqB;AACnD,cAAc,aAAa;AAC3B,cAAc,2BAA2B;AACzC,cAAc,mBAAmB;AAEjC,YAAY,aAAa,SAAS;AAElC,OAAO,cAAMA;AAEb,iBAAiB,YAAY,UAAU,iBAAiB,gBAAgB;UAC7D,IAAI;UACJ,QAAQ;WACP,0BAA0B;UAE3B,sBAAsB,QAAQ,cAAc;UAC5C,aAAa,UAAU,OAAO,OAAO,MAAM,oBAAoB;UAC/D,mBACP,WAAW,OAAO,YAAY,IAAI,UAAU,8BACzC;UACI,gBACP,WAAW,QAAQ,YAAY,gBAC5B","names":["DocumentRefBrand: unique symbol"],"sources":["../../../src/types/DocumentRef.ts"],"version":3,"file":"DocumentRef.d.ts"}

package/build/types/types/MediaRef.d.ts

@@ -0,0 +1,11 @@
+import type { Flavored } from "@palantir/pack.core";
+export type MediaId = Flavored<"MediaId">;
+export declare const MediaRefBrand: unique symbol;
+/**
+* @experimental
+*/
+export interface MediaRef {
+	readonly mediaId: MediaId;
+	readonly [MediaRefBrand]: typeof MediaRefBrand;
+	readonly subscribe?: (callback: unknown) => unknown;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,gBAAgB;AAE9B,YAAY,UAAU,SAAS;AAE/B,OAAO,cAAMA;;;;AAKb,iBAAiB,SAAS;UACf,SAAS;WACR,uBAAuB;UAGxB,aAAa","names":["MediaRefBrand: unique symbol"],"sources":["../../../src/types/MediaRef.ts"],"version":3,"file":"MediaRef.d.ts"}

package/build/types/types/Model.d.ts

@@ -8,11 +8,19 @@ import type { WithMetadata } from "./Metadata.js";
 export interface Model<
 	T = unknown,
 	Z extends ZodType<T> = ZodType<T>
-> extends WithMetadata<ModelMetadata> {
+> extends WithMetadata<ModelMetadata<T>> {
 	readonly __type: T;
 	readonly zodSchema: Readonly<Z>;
 }
 export type ModelData<M extends Model> = M["__type"];
-export interface ModelMetadata {
+export declare const ExternalRefType: {
+	readonly DOC_REF: "docRef";
+	readonly MEDIA_REF: "mediaRef";
+	readonly OBJECT_REF: "objectRef";
+	readonly USER_REF: "userRef";
+};
+export type ExternalRefType = typeof ExternalRefType[keyof typeof ExternalRefType];
+export interface ModelMetadata<T = unknown> {
+	readonly externalRefFieldTypes?: Readonly<Record<keyof T, ExternalRefType>>;
 	readonly name: string;
 }

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

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,eAAe;AAC7B,cAAc,oBAAoB;;;;;;AAQlC,iBAAiB;CAAM;CAAa,UAAU,QAAQ,KAAK,QAAQ;UACzD,aAAa,eACvB;UACW,QAAQ;UACR,WAAW,SAAS;;AAG/B,YAAY,UAAU,UAAU,SAAS,EAAE;AAE3C,iBAAiB,cAAc;UACpB","names":[],"sources":["../../../src/types/Model.ts"],"version":3,"file":"Model.d.ts"}
+{"mappings":"AAgBA,cAAc,eAAe;AAC7B,cAAc,oBAAoB;;;;;;AAQlC,iBAAiB;CAAM;CAAa,UAAU,QAAQ,KAAK,QAAQ;UACzD,aAAa,cAAc,IACrC;UACW,QAAQ;UACR,WAAW,SAAS;;AAG/B,YAAY,UAAU,UAAU,SAAS,EAAE;AAE3C,OAAO,cAAM;UACX,SAAS;UACT,WAAW;UACX,YAAY;UACZ,UAAU;;AAGZ,YAAY,yBAAyB,6BAA6B;AAElE,iBAAiB,cAAc,aAAa;UACjC,wBAAwB,SAAS,aAAa,GAAG;UACjD","names":[],"sources":["../../../src/types/Model.ts"],"version":3,"file":"Model.d.ts"}

package/build/types/types/ObjectRef.d.ts

@@ -0,0 +1,11 @@
+import type { Flavored } from "@palantir/pack.core";
+export type ObjectId = Flavored<"ObjectId">;
+export declare const ObjectRefBrand: unique symbol;
+/**
+* @experimental
+*/
+export interface ObjectRef {
+	readonly objectId: ObjectId;
+	readonly [ObjectRefBrand]: typeof ObjectRefBrand;
+	readonly subscribe?: (callback: unknown) => unknown;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,gBAAgB;AAE9B,YAAY,WAAW,SAAS;AAEhC,OAAO,cAAMA;;;;AAKb,iBAAiB,UAAU;UAChB,UAAU;WACT,wBAAwB;UAGzB,aAAa","names":["ObjectRefBrand: unique symbol"],"sources":["../../../src/types/ObjectRef.ts"],"version":3,"file":"ObjectRef.d.ts"}

package/build/types/types/RecordCollectionRef.d.ts

@@ -0,0 +1,18 @@
+import type { DocumentRef } from "./DocumentRef.js";
+import type { Model, ModelData } from "./Model.js";
+import type { RecordId, RecordRef } from "./RecordRef.js";
+export declare const RecordCollectionRefBrand: unique symbol;
+export interface RecordCollectionRef<M extends Model = Model> {
+	readonly docRef: DocumentRef;
+	readonly model: M;
+	readonly [RecordCollectionRefBrand]: typeof RecordCollectionRefBrand;
+	delete(id: RecordId): Promise<void>;
+	get(id: RecordId): RecordRef<M> | undefined;
+	has(id: RecordId): boolean;
+	set(id: RecordId, state: ModelData<M>): Promise<void>;
+	readonly size: number;
+	[Symbol.iterator](): Iterator<RecordRef<M>>;
+	readonly onItemsAdded: (callback: (items: readonly RecordRef<M>[]) => void) => () => void;
+	readonly onItemsChanged: (callback: (items: readonly RecordRef<M>[]) => void) => () => void;
+	readonly onItemsDeleted: (callback: (items: readonly RecordRef<M>[]) => void) => () => void;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,mBAAmB;AACjC,cAAc,OAAO,iBAAiB;AACtC,cAAc,UAAU,iBAAiB;AAEzC,OAAO,cAAMA;AAIb,iBAAiB,oBAAoB,UAAU,QAAQ,OAAO;UACnD,QAAQ;UACR,OAAO;WACN,kCAAkC;CAE5C,OAAO,IAAI,WAAW;CACtB,IAAI,IAAI,WAAW,UAAU;CAC7B,IAAI,IAAI;CACR,IAAI,IAAI,UAAU,OAAO,UAAU,KAAK;UAC/B;EAER,OAAO,aAAa,SAAS,UAAU;UAE/B,eACP,WAAW,gBAAgB,UAAU;UAG9B,iBACP,WAAW,gBAAgB,UAAU;UAG9B,iBACP,WAAW,gBAAgB,UAAU","names":["RecordCollectionRefBrand: unique symbol"],"sources":["../../../src/types/RecordCollectionRef.ts"],"version":3,"file":"RecordCollectionRef.d.ts"}

package/build/types/types/RecordRef.d.ts

@@ -0,0 +1,16 @@
+import type { Flavored } from "@palantir/pack.core";
+import type { DocumentRef } from "./DocumentRef.js";
+import type { Model, ModelData } from "./Model.js";
+import type { Unsubscribe } from "./Unsubscribe.js";
+export type RecordId = Flavored<"RecordId">;
+export declare const RecordRefBrand: unique symbol;
+export interface RecordRef<M extends Model = Model> {
+	readonly docRef: DocumentRef;
+	readonly id: RecordId;
+	readonly model: M;
+	readonly [RecordRefBrand]: typeof RecordRefBrand;
+	getSnapshot(): Promise<ModelData<M>>;
+	onChange(callback: (snapshot: ModelData<M>, recordRef: RecordRef<M>) => void): Unsubscribe;
+	onDeleted(callback: (recordRef: RecordRef<M>) => void): Unsubscribe;
+	set(record: ModelData<M>): Promise<void>;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,gBAAgB;AAC9B,cAAc,mBAAmB;AACjC,cAAc,OAAO,iBAAiB;AACtC,cAAc,mBAAmB;AAEjC,YAAY,WAAW,SAAS;AAEhC,OAAO,cAAMA;AAEb,iBAAiB,UAAU,UAAU,QAAQ,OAAO;UACzC,QAAQ;UACR,IAAI;UACJ,OAAO;WACN,wBAAwB;CAElC,eAAe,QAAQ,UAAU;CACjC,SAAS,WAAW,UAAU,UAAU,IAAI,WAAW,UAAU,cAAc;CAC/E,UAAU,WAAW,WAAW,UAAU,cAAc;CACxD,IAAI,QAAQ,UAAU,KAAK","names":["RecordRefBrand: unique symbol"],"sources":["../../../src/types/RecordRef.ts"],"version":3,"file":"RecordRef.d.ts"}

package/build/types/types/Unsubscribe.d.ts

@@ -0,0 +1 @@
+export type Unsubscribe = () => void;

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,YAAY","names":[],"sources":["../../../src/types/Unsubscribe.ts"],"version":3,"file":"Unsubscribe.d.ts"}

package/build/types/types/UserRef.d.ts

@@ -0,0 +1,8 @@
+import type { Flavored } from "@palantir/pack.core";
+export type UserId = Flavored<"pack:UserId">;
+export declare const UserRefBrand: unique symbol;
+export interface UserRef {
+	readonly userId: UserId;
+	readonly [UserRefBrand]: typeof UserRefBrand;
+	readonly get: (force?: boolean) => Promise<unknown>;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,gBAAgB;AAE9B,YAAY,SAAS,SAAS;AAE9B,OAAO,cAAMA;AAEb,iBAAiB,QAAQ;UACd,QAAQ;WACP,sBAAsB;UACvB,MAAM,oBAAoB","names":["UserRefBrand: unique symbol"],"sources":["../../../src/types/UserRef.ts"],"version":3,"file":"UserRef.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palantir/pack.document-schema.model-types",
-  "version": "0.0.1-beta.1",
+  "version": "0.1.0-beta.3",
   "description": "Minimal types supporting generated PACK schemas",
   "license": "Apache-2.0",
   "repository": {
@@ -27,6 +27,9 @@
       "default": "./build/browser/public/*.js"
     }
   },
+  "dependencies": {
+    "@palantir/pack.core": "~0.1.0-beta.2"
+  },
   "peerDependencies": {
     "zod": "^4.1.7"
   },

package/src/index.ts

@@ -14,11 +14,32 @@
  * limitations under the License.
  */
 
+export type {
+  DiscretionaryPrincipal,
+  DiscretionaryPrincipal_All,
+  DiscretionaryPrincipal_GroupId,
+  DiscretionaryPrincipal_UserId,
+  DocumentMetadata,
+} from "./types/DocumentMetadata.js";
+export { DocumentRefBrand } from "./types/DocumentRef.js";
+export type { DocumentId, DocumentRef } from "./types/DocumentRef.js";
 export type {
   DocumentSchema,
   DocumentSchemaMetadata,
   DocumentState,
 } from "./types/DocumentSchema.js";
+export { MediaRefBrand } from "./types/MediaRef.js";
+export type { MediaId, MediaRef } from "./types/MediaRef.js";
 export { getMetadata, Metadata } from "./types/Metadata.js";
 export type { WithMetadata } from "./types/Metadata.js";
+export { ExternalRefType } from "./types/Model.js";
 export type { Model, ModelData, ModelMetadata } from "./types/Model.js";
+export { ObjectRefBrand } from "./types/ObjectRef.js";
+export type { ObjectId, ObjectRef } from "./types/ObjectRef.js";
+export { RecordCollectionRefBrand } from "./types/RecordCollectionRef.js";
+export type { RecordCollectionRef } from "./types/RecordCollectionRef.js";
+export { RecordRefBrand } from "./types/RecordRef.js";
+export type { RecordId, RecordRef } from "./types/RecordRef.js";
+export type { Unsubscribe } from "./types/Unsubscribe.js";
+export { UserRefBrand } from "./types/UserRef.js";
+export type { UserId, UserRef } from "./types/UserRef.js";

package/src/types/DocumentMetadata.ts

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2025 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.
+ */
+
+export interface DiscretionaryPrincipal_All {
+  "all": Record<string, never>;
+  "type": "all";
+}
+export interface DiscretionaryPrincipal_UserId {
+  "type": "userId";
+  "userId": string;
+}
+export interface DiscretionaryPrincipal_GroupId {
+  "groupId": string;
+  "type": "groupId";
+}
+
+export type DiscretionaryPrincipal =
+  | DiscretionaryPrincipal_All
+  | DiscretionaryPrincipal_GroupId
+  | DiscretionaryPrincipal_UserId;
+
+export interface DocumentMetadata {
+  readonly documentTypeName: string;
+  readonly name: string;
+  readonly ontologyRid: string;
+  readonly security: {
+    readonly discretionary: {
+      readonly editors?: readonly DiscretionaryPrincipal[];
+      readonly owners: readonly DiscretionaryPrincipal[];
+      readonly viewers?: readonly DiscretionaryPrincipal[];
+    };
+    readonly mandatory: {
+      readonly classification?: readonly string[];
+      readonly markings?: readonly string[];
+    };
+  };
+}

package/src/types/DocumentRef.ts

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2025 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 { Flavored } from "@palantir/pack.core";
+import type { DocumentMetadata } from "./DocumentMetadata.js";
+import type { DocumentSchema, DocumentState } from "./DocumentSchema.js";
+import type { Model } from "./Model.js";
+import type { RecordCollectionRef } from "./RecordCollectionRef.js";
+import type { Unsubscribe } from "./Unsubscribe.js";
+
+export type DocumentId = Flavored<"DocumentId">;
+
+export const DocumentRefBrand: unique symbol = Symbol("pack:DocumentRef");
+
+export interface DocumentRef<D extends DocumentSchema = DocumentSchema> {
+  readonly id: DocumentId;
+  readonly schema: D;
+  readonly [DocumentRefBrand]: typeof DocumentRefBrand;
+
+  readonly getDocSnapshot: () => Promise<DocumentState<D>>;
+  readonly getRecords: <R extends Model>(model: R) => RecordCollectionRef<R>;
+  readonly onMetadataChange: (
+    callback: (docId: DocumentRef<D>, metadata: DocumentMetadata) => void,
+  ) => Unsubscribe;
+  readonly onStateChange: (
+    callback: (docRef: DocumentRef<D>) => void,
+  ) => Unsubscribe;
+}

package/src/types/MediaRef.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2025 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 { Flavored } from "@palantir/pack.core";
+
+export type MediaId = Flavored<"MediaId">;
+
+export const MediaRefBrand: unique symbol = Symbol("pack:MediaRef");
+
+/**
+ * @experimental
+ */
+export interface MediaRef {
+  readonly mediaId: MediaId;
+  readonly [MediaRefBrand]: typeof MediaRefBrand;
+
+  // TODO: implement this correctly
+  readonly subscribe?: (callback: unknown) => unknown;
+}

package/src/types/Metadata.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-export const Metadata: symbol = Symbol("@pack/document-schema/metadata");
+export const Metadata: symbol = Symbol("@palantir/pack.document-schema/metadata");
 
 export interface WithMetadata<T> {
   readonly [Metadata]: T;

package/src/types/Model.ts

@@ -24,7 +24,7 @@ import type { WithMetadata } from "./Metadata.js";
  */
 // TODO: I think we can/should hide the zod types
 export interface Model<T = unknown, Z extends ZodType<T> = ZodType<T>>
-  extends WithMetadata<ModelMetadata>
+  extends WithMetadata<ModelMetadata<T>>
 {
   readonly __type: T;
   readonly zodSchema: Readonly<Z>;
@@ -32,6 +32,16 @@ export interface Model<T = unknown, Z extends ZodType<T> = ZodType<T>>
 
 export type ModelData<M extends Model> = M["__type"];
 
-export interface ModelMetadata {
+export const ExternalRefType = {
+  DOC_REF: "docRef",
+  MEDIA_REF: "mediaRef",
+  OBJECT_REF: "objectRef",
+  USER_REF: "userRef",
+} as const;
+
+export type ExternalRefType = typeof ExternalRefType[keyof typeof ExternalRefType];
+
+export interface ModelMetadata<T = unknown> {
+  readonly externalRefFieldTypes?: Readonly<Record<keyof T, ExternalRefType>>;
   readonly name: string;
 }

package/src/types/ObjectRef.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2025 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 { Flavored } from "@palantir/pack.core";
+
+export type ObjectId = Flavored<"ObjectId">;
+
+export const ObjectRefBrand: unique symbol = Symbol("pack:ObjectRef");
+
+/**
+ * @experimental
+ */
+export interface ObjectRef {
+  readonly objectId: ObjectId;
+  readonly [ObjectRefBrand]: typeof ObjectRefBrand;
+
+  // TODO: implement this correctly
+  readonly subscribe?: (callback: unknown) => unknown;
+}

package/src/types/RecordCollectionRef.ts

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2025 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 { DocumentRef } from "./DocumentRef.js";
+import type { Model, ModelData } from "./Model.js";
+import type { RecordId, RecordRef } from "./RecordRef.js";
+
+export const RecordCollectionRefBrand: unique symbol = Symbol(
+  "pack:RecordCollectionRef",
+);
+
+export interface RecordCollectionRef<M extends Model = Model> {
+  readonly docRef: DocumentRef;
+  readonly model: M;
+  readonly [RecordCollectionRefBrand]: typeof RecordCollectionRefBrand;
+
+  delete(id: RecordId): Promise<void>;
+  get(id: RecordId): RecordRef<M> | undefined;
+  has(id: RecordId): boolean;
+  set(id: RecordId, state: ModelData<M>): Promise<void>;
+  readonly size: number;
+
+  [Symbol.iterator](): Iterator<RecordRef<M>>;
+
+  readonly onItemsAdded: (
+    callback: (items: readonly RecordRef<M>[]) => void,
+  ) => () => void;
+
+  readonly onItemsChanged: (
+    callback: (items: readonly RecordRef<M>[]) => void,
+  ) => () => void;
+
+  readonly onItemsDeleted: (
+    callback: (items: readonly RecordRef<M>[]) => void,
+  ) => () => void;
+}

package/src/types/RecordRef.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2025 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 { Flavored } from "@palantir/pack.core";
+import type { DocumentRef } from "./DocumentRef.js";
+import type { Model, ModelData } from "./Model.js";
+import type { Unsubscribe } from "./Unsubscribe.js";
+
+export type RecordId = Flavored<"RecordId">;
+
+export const RecordRefBrand: unique symbol = Symbol("pack:RecordRef");
+
+export interface RecordRef<M extends Model = Model> {
+  readonly docRef: DocumentRef;
+  readonly id: RecordId;
+  readonly model: M;
+  readonly [RecordRefBrand]: typeof RecordRefBrand;
+
+  getSnapshot(): Promise<ModelData<M>>;
+  onChange(callback: (snapshot: ModelData<M>, recordRef: RecordRef<M>) => void): Unsubscribe;
+  onDeleted(callback: (recordRef: RecordRef<M>) => void): Unsubscribe;
+  set(record: ModelData<M>): Promise<void>;
+}

package/src/types/Unsubscribe.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2025 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.
+ */
+
+export type Unsubscribe = () => void;

package/src/types/UserRef.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2025 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 { Flavored } from "@palantir/pack.core";
+
+export type UserId = Flavored<"pack:UserId">;
+
+export const UserRefBrand: unique symbol = Symbol("pack:UserRef");
+
+export interface UserRef {
+  readonly userId: UserId;
+  readonly [UserRefBrand]: typeof UserRefBrand;
+  readonly get: (force?: boolean) => Promise<unknown>;
+}