@palantir/pack.core 0.0.1-beta.1

package/.turbo/turbo-lint.log

@@ -0,0 +1,4 @@
+
+> @palantir/pack.core@0.0.1-beta.1 lint /home/runner/work/pack/pack/packages/core
+> eslint ./src ; dprint check --config $(find-up dprint.json) --allow-no-files
+

package/.turbo/turbo-transpileBrowser.log

@@ -0,0 +1,5 @@
+
+> @palantir/pack.core@0.0.1-beta.1 transpileBrowser /home/runner/work/pack/pack/packages/core
+> monorepo-transpile -f esm -m bundle -t browser
+
+👍

package/.turbo/turbo-transpileCjs.log

@@ -0,0 +1,5 @@
+
+> @palantir/pack.core@0.0.1-beta.1 transpileCjs /home/runner/work/pack/pack/packages/core
+> monorepo-transpile -f cjs -m bundle -t node
+
+👍

package/.turbo/turbo-transpileEsm.log

@@ -0,0 +1,5 @@
+
+> @palantir/pack.core@0.0.1-beta.1 transpileEsm /home/runner/work/pack/pack/packages/core
+> monorepo-transpile -f esm -m bundle -t node
+
+👍

package/.turbo/turbo-transpileTypes.log

@@ -0,0 +1,5 @@
+
+> @palantir/pack.core@0.0.1-beta.1 transpileTypes /home/runner/work/pack/pack/packages/core
+> monorepo-transpile -f esm -m types -t node
+
+👍

package/.turbo/turbo-typecheck.log

@@ -0,0 +1,4 @@
+
+> @palantir/pack.core@0.0.1-beta.1 typecheck /home/runner/work/pack/pack/packages/core
+> tsc --noEmit --emitDeclarationOnly false
+

package/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2025 Palantir Technologies, Inc.
+
+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.

package/README.md

@@ -0,0 +1,7 @@
+# @palantir/pack.core
+
+Core functionality and utilities used across all PACK packages, providing shared types and utilities.
+
+## Overview
+
+This package contains the fundamental building blocks for PACK applications, including type definitions, utility functions, and core interfaces that other PACK packages depend on.

package/build/browser/index.js

@@ -0,0 +1,50 @@
+// ../../node_modules/.pnpm/tiny-invariant@1.3.3/node_modules/tiny-invariant/dist/esm/tiny-invariant.js
+var isProduction = process.env.NODE_ENV === "production";
+var prefix = "Invariant failed";
+function invariant(condition, message) {
+  if (isProduction) {
+    throw new Error(prefix);
+  }
+  var provided = typeof message === "function" ? message() : message;
+  var value = provided ? "".concat(prefix, ": ").concat(provided) : prefix;
+  throw new Error(value);
+}
+
+// src/types/PackApp.ts
+var isModuleConfigTuple = (config) => {
+  return Array.isArray(config);
+};
+function assertIsAppInternal(app) {
+  !("getModule" in app) ? process.env.NODE_ENV !== "production" ? invariant(false, "App is not an PackAppInternal") : invariant() : void 0;
+}
+
+// src/utils/assertNever.ts
+function assertNever(_x) {
+  throw new Error("Hit unreachable code");
+}
+
+// src/utils/generateId.ts
+function toHexString(byteArray) {
+  return Array.from(byteArray, function(byte) {
+    const h = (byte & 255).toString(16);
+    return h.length === 1 ? `0${h}` : h;
+  }).join("");
+}
+function generateId(bytes = 12) {
+  const array = new Int8Array(bytes);
+  const r = crypto.getRandomValues(array);
+  return toHexString(r);
+}
+
+// src/utils/justOnce.ts
+var SEEN_KEYS = /* @__PURE__ */ new Set();
+function justOnce(key, fn) {
+  if (!SEEN_KEYS.has(key)) {
+    SEEN_KEYS.add(key);
+    fn();
+  }
+}
+
+export { assertIsAppInternal, assertNever, generateId, isModuleConfigTuple, justOnce };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/build/browser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../node_modules/.pnpm/tiny-invariant@1.3.3/node_modules/tiny-invariant/dist/esm/tiny-invariant.js","../../src/types/PackApp.ts","../../src/utils/assertNever.ts","../../src/utils/generateId.ts","../../src/utils/justOnce.ts"],"names":[],"mappings":";AAAA,IAAI,YAAA,GAAe,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,YAAA;AAC5C,IAAI,MAAA,GAAS,kBAAA;AACb,SAAS,SAAA,CAAU,WAAW,OAAA,EAAS;AAIrC,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAM,IAAI,MAAM,MAAM,CAAA;AAAA,EACxB;AACA,EAAA,IAAI,QAAA,GAAW,OAAO,OAAA,KAAY,UAAA,GAAa,SAAQ,GAAI,OAAA;AAC3D,EAAA,IAAI,KAAA,GAAQ,WAAW,EAAA,CAAG,MAAA,CAAO,QAAQ,IAAI,CAAA,CAAE,MAAA,CAAO,QAAQ,CAAA,GAAI,MAAA;AAClE,EAAA,MAAM,IAAI,MAAM,KAAK,CAAA;AACvB;;;ACqCO,IAAM,sBAAsB,CAAA,MAAA,KAAU;AAC3C,EAAA,OAAO,KAAA,CAAM,QAAQ,MAAM,CAAA;AAC7B;AACO,SAAS,oBAAoB,GAAA,EAAK;AACvC,EAAA,EAAE,WAAA,IAAe,GAAA,CAAA,GAAO,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,YAAA,GAAe,SAAA,CAAU,KAAA,EAAO,+BAA+B,CAAA,GAAI,SAAA,CAAe,CAAA,GAAI,MAAA;AACzI;;;ACtCO,SAAS,YAAY,EAAA,EAAI;AAC9B,EAAA,MAAM,IAAI,MAAM,sBAAsB,CAAA;AACxC;;;ACFA,SAAS,YAAY,SAAA,EAAW;AAC9B,EAAA,OAAO,KAAA,CAAM,IAAA,CAAK,SAAA,EAAW,SAAU,IAAA,EAAM;AAC3C,IAAA,MAAM,CAAA,GAAA,CAAK,IAAA,GAAO,GAAA,EAAM,QAAA,CAAS,EAAE,CAAA;AACnC,IAAA,OAAO,CAAA,CAAE,MAAA,KAAW,CAAA,GAAI,CAAA,CAAA,EAAI,CAAC,CAAA,CAAA,GAAK,CAAA;AAAA,EACpC,CAAC,CAAA,CAAE,IAAA,CAAK,EAAE,CAAA;AACZ;AACO,SAAS,UAAA,CAAW,QAAQ,EAAA,EAAI;AACrC,EAAA,MAAM,KAAA,GAAQ,IAAI,SAAA,CAAU,KAAK,CAAA;AACjC,EAAA,MAAM,CAAA,GAAI,MAAA,CAAO,eAAA,CAAgB,KAAK,CAAA;AACtC,EAAA,OAAO,YAAY,CAAC,CAAA;AACtB;;;ACVA,IAAM,SAAA,uBAAgB,GAAA,EAAI;AAWnB,SAAS,QAAA,CAAS,KAAK,EAAA,EAAI;AAChC,EAAA,IAAI,CAAC,SAAA,CAAU,GAAA,CAAI,GAAG,CAAA,EAAG;AACvB,IAAA,SAAA,CAAU,IAAI,GAAG,CAAA;AACjB,IAAA,EAAA,EAAG;AAAA,EACL;AACF","file":"index.js","sourcesContent":["var isProduction = process.env.NODE_ENV === 'production';\nvar prefix = 'Invariant failed';\nfunction invariant(condition, message) {\n  if (condition) {\n    return;\n  }\n  if (isProduction) {\n    throw new Error(prefix);\n  }\n  var provided = typeof message === 'function' ? message() : message;\n  var value = provided ? \"\".concat(prefix, \": \").concat(provided) : prefix;\n  throw new Error(value);\n}\nexport { invariant as default };","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport invariant from \"tiny-invariant\";\n\n/**\n * PackApp provides access to various pack subsystems.\n *\n * Specific modules are available after configuration and through declarations mixed in by import.\n * Eg for state system, if you import @palantir/pack.state.core you will have access to `app.state` accessor.\n * Similarly, auth is added automatically by initPackApp.\n *\n * @example\n * ```typescript\n * import { DocumentRef } from '@palantir/pack.state.core';\n * import { DocSchema } from '@my-app/schema';\n *\n * const app = initPackApp({\n *   tokenProvider: () => 'your-token',\n *   moduleConfigs: {\n *     ...createPackDocumentServiceConfig({appId: 'your-app-id', documentType: 'your-document-type'})\n *   },\n * });\n *\n * const docRef = app.state.getDocument(docSchema, 'your-document-id');\n * const doc = await docRef.getSnapshot(); // get pojo of your doc state.\n * ```\n */\n\n/**\n * Module configuration - either a tuple of [ModuleKey, config] or just a ModuleKey (for modules with no config)\n */\n\n/**\n * Type guard to check if a ModuleConfig is a tuple configuration\n */\nexport const isModuleConfigTuple = config => {\n  return Array.isArray(config);\n};\nexport function assertIsAppInternal(app) {\n  !(\"getModule\" in app) ? process.env.NODE_ENV !== \"production\" ? invariant(false, \"App is not an PackAppInternal\") : invariant(false) : void 0;\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 function assertNever(_x) {\n  throw new Error(\"Hit unreachable code\");\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\nfunction toHexString(byteArray) {\n  return Array.from(byteArray, function (byte) {\n    const h = (byte & 0xff).toString(16);\n    return h.length === 1 ? `0${h}` : h;\n  }).join(\"\");\n}\nexport function generateId(bytes = 12) {\n  const array = new Int8Array(bytes);\n  const r = crypto.getRandomValues(array);\n  return toHexString(r);\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\nconst SEEN_KEYS = new Set();\n\n/**\n * Used to call fn only once between app reloads.\n * eg: Useful for logging warnings that should only be logged once.\n *\n * @example\n * ```ts\n * justOnce(\"unexpected-value\", () => console.warn(\"There was an unexpected value returned\", {value}));\n * ```\n */\nexport function justOnce(key, fn) {\n  if (!SEEN_KEYS.has(key)) {\n    SEEN_KEYS.add(key);\n    fn();\n  }\n}"]}

package/build/cjs/index.cjs

@@ -0,0 +1,56 @@
+'use strict';
+
+// ../../node_modules/.pnpm/tiny-invariant@1.3.3/node_modules/tiny-invariant/dist/esm/tiny-invariant.js
+var isProduction = process.env.NODE_ENV === "production";
+var prefix = "Invariant failed";
+function invariant(condition, message) {
+  if (isProduction) {
+    throw new Error(prefix);
+  }
+  var provided = typeof message === "function" ? message() : message;
+  var value = provided ? "".concat(prefix, ": ").concat(provided) : prefix;
+  throw new Error(value);
+}
+
+// src/types/PackApp.ts
+var isModuleConfigTuple = (config) => {
+  return Array.isArray(config);
+};
+function assertIsAppInternal(app) {
+  !("getModule" in app) ? process.env.NODE_ENV !== "production" ? invariant(false, "App is not an PackAppInternal") : invariant() : void 0;
+}
+
+// src/utils/assertNever.ts
+function assertNever(_x) {
+  throw new Error("Hit unreachable code");
+}
+
+// src/utils/generateId.ts
+function toHexString(byteArray) {
+  return Array.from(byteArray, function(byte) {
+    const h = (byte & 255).toString(16);
+    return h.length === 1 ? `0${h}` : h;
+  }).join("");
+}
+function generateId(bytes = 12) {
+  const array = new Int8Array(bytes);
+  const r = crypto.getRandomValues(array);
+  return toHexString(r);
+}
+
+// src/utils/justOnce.ts
+var SEEN_KEYS = /* @__PURE__ */ new Set();
+function justOnce(key, fn) {
+  if (!SEEN_KEYS.has(key)) {
+    SEEN_KEYS.add(key);
+    fn();
+  }
+}
+
+exports.assertIsAppInternal = assertIsAppInternal;
+exports.assertNever = assertNever;
+exports.generateId = generateId;
+exports.isModuleConfigTuple = isModuleConfigTuple;
+exports.justOnce = justOnce;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/build/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../node_modules/.pnpm/tiny-invariant@1.3.3/node_modules/tiny-invariant/dist/esm/tiny-invariant.js","../../src/types/PackApp.ts","../../src/utils/assertNever.ts","../../src/utils/generateId.ts","../../src/utils/justOnce.ts"],"names":[],"mappings":";;;AAAA,IAAI,YAAA,GAAe,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,YAAA;AAC5C,IAAI,MAAA,GAAS,kBAAA;AACb,SAAS,SAAA,CAAU,WAAW,OAAA,EAAS;AAIrC,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAM,IAAI,MAAM,MAAM,CAAA;AAAA,EACxB;AACA,EAAA,IAAI,QAAA,GAAW,OAAO,OAAA,KAAY,UAAA,GAAa,SAAQ,GAAI,OAAA;AAC3D,EAAA,IAAI,KAAA,GAAQ,WAAW,EAAA,CAAG,MAAA,CAAO,QAAQ,IAAI,CAAA,CAAE,MAAA,CAAO,QAAQ,CAAA,GAAI,MAAA;AAClE,EAAA,MAAM,IAAI,MAAM,KAAK,CAAA;AACvB;;;ACqCO,IAAM,sBAAsB,CAAA,MAAA,KAAU;AAC3C,EAAA,OAAO,KAAA,CAAM,QAAQ,MAAM,CAAA;AAC7B;AACO,SAAS,oBAAoB,GAAA,EAAK;AACvC,EAAA,EAAE,WAAA,IAAe,GAAA,CAAA,GAAO,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,YAAA,GAAe,SAAA,CAAU,KAAA,EAAO,+BAA+B,CAAA,GAAI,SAAA,CAAe,CAAA,GAAI,MAAA;AACzI;;;ACtCO,SAAS,YAAY,EAAA,EAAI;AAC9B,EAAA,MAAM,IAAI,MAAM,sBAAsB,CAAA;AACxC;;;ACFA,SAAS,YAAY,SAAA,EAAW;AAC9B,EAAA,OAAO,KAAA,CAAM,IAAA,CAAK,SAAA,EAAW,SAAU,IAAA,EAAM;AAC3C,IAAA,MAAM,CAAA,GAAA,CAAK,IAAA,GAAO,GAAA,EAAM,QAAA,CAAS,EAAE,CAAA;AACnC,IAAA,OAAO,CAAA,CAAE,MAAA,KAAW,CAAA,GAAI,CAAA,CAAA,EAAI,CAAC,CAAA,CAAA,GAAK,CAAA;AAAA,EACpC,CAAC,CAAA,CAAE,IAAA,CAAK,EAAE,CAAA;AACZ;AACO,SAAS,UAAA,CAAW,QAAQ,EAAA,EAAI;AACrC,EAAA,MAAM,KAAA,GAAQ,IAAI,SAAA,CAAU,KAAK,CAAA;AACjC,EAAA,MAAM,CAAA,GAAI,MAAA,CAAO,eAAA,CAAgB,KAAK,CAAA;AACtC,EAAA,OAAO,YAAY,CAAC,CAAA;AACtB;;;ACVA,IAAM,SAAA,uBAAgB,GAAA,EAAI;AAWnB,SAAS,QAAA,CAAS,KAAK,EAAA,EAAI;AAChC,EAAA,IAAI,CAAC,SAAA,CAAU,GAAA,CAAI,GAAG,CAAA,EAAG;AACvB,IAAA,SAAA,CAAU,IAAI,GAAG,CAAA;AACjB,IAAA,EAAA,EAAG;AAAA,EACL;AACF","file":"index.cjs","sourcesContent":["var isProduction = process.env.NODE_ENV === 'production';\nvar prefix = 'Invariant failed';\nfunction invariant(condition, message) {\n  if (condition) {\n    return;\n  }\n  if (isProduction) {\n    throw new Error(prefix);\n  }\n  var provided = typeof message === 'function' ? message() : message;\n  var value = provided ? \"\".concat(prefix, \": \").concat(provided) : prefix;\n  throw new Error(value);\n}\nexport { invariant as default };","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport invariant from \"tiny-invariant\";\n\n/**\n * PackApp provides access to various pack subsystems.\n *\n * Specific modules are available after configuration and through declarations mixed in by import.\n * Eg for state system, if you import @palantir/pack.state.core you will have access to `app.state` accessor.\n * Similarly, auth is added automatically by initPackApp.\n *\n * @example\n * ```typescript\n * import { DocumentRef } from '@palantir/pack.state.core';\n * import { DocSchema } from '@my-app/schema';\n *\n * const app = initPackApp({\n *   tokenProvider: () => 'your-token',\n *   moduleConfigs: {\n *     ...createPackDocumentServiceConfig({appId: 'your-app-id', documentType: 'your-document-type'})\n *   },\n * });\n *\n * const docRef = app.state.getDocument(docSchema, 'your-document-id');\n * const doc = await docRef.getSnapshot(); // get pojo of your doc state.\n * ```\n */\n\n/**\n * Module configuration - either a tuple of [ModuleKey, config] or just a ModuleKey (for modules with no config)\n */\n\n/**\n * Type guard to check if a ModuleConfig is a tuple configuration\n */\nexport const isModuleConfigTuple = config => {\n  return Array.isArray(config);\n};\nexport function assertIsAppInternal(app) {\n  !(\"getModule\" in app) ? process.env.NODE_ENV !== \"production\" ? invariant(false, \"App is not an PackAppInternal\") : invariant(false) : void 0;\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 function assertNever(_x) {\n  throw new Error(\"Hit unreachable code\");\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\nfunction toHexString(byteArray) {\n  return Array.from(byteArray, function (byte) {\n    const h = (byte & 0xff).toString(16);\n    return h.length === 1 ? `0${h}` : h;\n  }).join(\"\");\n}\nexport function generateId(bytes = 12) {\n  const array = new Int8Array(bytes);\n  const r = crypto.getRandomValues(array);\n  return toHexString(r);\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\nconst SEEN_KEYS = new Set();\n\n/**\n * Used to call fn only once between app reloads.\n * eg: Useful for logging warnings that should only be logged once.\n *\n * @example\n * ```ts\n * justOnce(\"unexpected-value\", () => console.warn(\"There was an unexpected value returned\", {value}));\n * ```\n */\nexport function justOnce(key, fn) {\n  if (!SEEN_KEYS.has(key)) {\n    SEEN_KEYS.add(key);\n    fn();\n  }\n}"]}

package/build/cjs/index.d.cts

@@ -0,0 +1,207 @@
+import { Logger } from '@osdk/api';
+import { Client } from '@osdk/client';
+
+/**
+ * ModuleKey uniquely identifies a module.
+ *
+ * The key is a symbol and is used to identify the module config.
+ * Modules are lazily initialized on first access.
+ *
+ * @example
+ * ```ts
+ * const MY_MODULE_ACCESSOR = "myModule";
+ *
+ * const MY_MODULE_KEY: ModuleKey<MyModule, MyModuleConfig> = {
+ *   key: Symbol.for("my.module"),
+ *
+ *   appMemberName: MY_MODULE_ACCESSOR,
+ *   initModule: initMyModule,
+ * };
+ *
+ * const app = initPackApp({
+ *   moduleConfig: {
+ *     [MY_MODULE_KEY.key]: { ... config ... } satisfies MyModuleConfig
+ *
+ *     // Note this is the actual shape of the moduleConfig, ie index by module key symbol
+ *     // But it is far more ergonomic to spread from a config creator, ie:
+ *     ...createMyModuleConfig({ ... config ... }),
+ *   }
+ * })
+ *
+ * // Get the module (manual way)
+ * const myModule = app.getModule(MY_MODULE_KEY);
+ *
+ * // Get the module from app property (available via appMemberName sugar)
+ * // You also need to declare the appMemberName on the PackApp interface so the type
+ * // system knows it is present. This keeps your module usage limited to where your module
+ * // is imported
+ * declare module '@palantir/pack.core' {
+ *   interface PackApp {
+ *     readonly [MY_MODULE_ACCESSOR]?: MyModule;
+ *   }
+ * }
+ * const myModule = app.myModule;
+ *
+ * ```
+ */
+interface ModuleKey<T, TConfig = unknown> {
+    /** If set, this module will have a getter installed on the PackApp interface */
+    readonly appMemberName?: string;
+    readonly key: symbol;
+    readonly initModule: (app: PackAppInternal, config?: TConfig) => T;
+}
+
+/**
+ * PackApp provides access to various pack subsystems.
+ *
+ * Specific modules are available after configuration and through declarations mixed in by import.
+ * Eg for state system, if you import @palantir/pack.state.core you will have access to `app.state` accessor.
+ * Similarly, auth is added automatically by initPackApp.
+ *
+ * @example
+ * ```typescript
+ * import { DocumentRef } from '@palantir/pack.state.core';
+ * import { DocSchema } from '@my-app/schema';
+ *
+ * const app = initPackApp({
+ *   tokenProvider: () => 'your-token',
+ *   moduleConfigs: {
+ *     ...createPackDocumentServiceConfig({appId: 'your-app-id', documentType: 'your-document-type'})
+ *   },
+ * });
+ *
+ * const docRef = app.state.getDocument(docSchema, 'your-document-id');
+ * const doc = await docRef.getSnapshot(); // get pojo of your doc state.
+ * ```
+ */
+interface PackApp {
+    readonly config: AppConfig;
+}
+/**
+ * Module configuration - either a tuple of [ModuleKey, config] or just a ModuleKey (for modules with no config)
+ */
+type ModuleConfigTuple<T = unknown> = readonly [ModuleKey<T>, unknown];
+type ModuleConfig<T = unknown> = ModuleConfigTuple<T> | ModuleKey<T>;
+/**
+ * Type guard to check if a ModuleConfig is a tuple configuration
+ */
+declare const isModuleConfigTuple: (config: ModuleConfig) => config is readonly [ModuleKey<unknown>, unknown];
+interface PackAppInternal {
+    readonly config: AppConfig;
+    /**
+     * Internal module accessor
+     */
+    getModule<T, TConfig = undefined>(moduleKey: ModuleKey<T, TConfig>): T;
+}
+declare function assertIsAppInternal(app: PackApp): asserts app is PackApp & PackAppInternal;
+declare function assertIsAppInternal(app: PackAppInternal): asserts app is PackAppInternal;
+
+type TokenProvider = () => Promise<string>;
+
+interface AppConfig {
+    readonly app: {
+        readonly appId: string;
+        readonly appVersion?: string;
+    };
+    readonly isTestMode: boolean;
+    readonly logger: Logger;
+    readonly osdkClient: Client;
+    readonly remote: {
+        readonly packApiPath: string;
+        readonly packWsPath: string;
+        readonly baseUrl: string;
+        readonly fetchFn: typeof globalThis.fetch;
+    };
+}
+interface AppOptions {
+    /**
+     * Override the authentication token provider from the OSDK client.
+     *
+     * @default Uses token provider from OSDK client
+     */
+    readonly auth?: TokenProvider;
+    /**
+     * The ID of your application.
+     * @default Uses values from page environment meta tags (pack-appId, pack-appVersion)
+     */
+    readonly app?: {
+        readonly appId: string;
+        readonly appVersion?: string;
+    };
+    /**
+     * Logger configuration.
+     * @see {@link @osdk/client/internal.BrowserLogger} for a richer console logger.
+     * @default Log warnings & errors only.
+     */
+    readonly logger?: Logger;
+    readonly logLevel?: "debug" | "error" | "info" | "warn";
+    /**
+     * Internal testing overrides.
+     */
+    readonly moduleOverrides?: readonly ModuleConfigTuple[];
+    readonly remote?: {
+        /**
+         * @default "/pack/api"
+         */
+        readonly packApiPath?: string;
+        /**
+         * @default "/pack/ws"
+         */
+        readonly packWsPath?: string;
+        /**
+         * Override the base URL from the OSDK client.
+         *
+         * eg "https://example.com"
+         *
+         * @default Uses base URL from OSDK client
+         */
+        readonly baseUrl?: string;
+        /**
+         * Override the fetch function from the OSDK client.
+         */
+        readonly fetchFn?: typeof globalThis.fetch;
+    };
+}
+
+type Branded<Brand extends string, T = string> = T & Readonly<{
+    readonly __pack_brand: Brand;
+}>;
+/**
+ * A type that is "flavored" for self documenting code and prevents some accidental misuse.
+ * This is similar to {@link Branded} but allows implicit use of T without a type assertion,
+ * which is useful for stronger typing within certain systems without forcing it for all
+ * external uses.
+ *
+ * Flavored types with different brands will not match.
+ * A Branded type with the same brand will implicitly match a Flavored type with the same brand,
+ * ie `const foo: Flavored<"foo"> = "foo" as Branded<"foo">`
+ *
+ * @example
+ * type MyId = Flavored<"MyId">;
+ * type OtherId = Flavored<"OtherId">;
+ * const id: MyId = "my-id"; // Good: No type assertion needed
+ * const otherId: OtherId = id; // Error: Type 'MyId' is not assignable to type 'OtherId'
+ * const otherId: OtherId = id as OtherId; // You can assert between flavored types directly
+ */
+type Flavored<Flavor extends string, T = string> = T & Readonly<{
+    readonly __pack_brand?: Flavor;
+}>;
+
+type Unsubscribe = () => void;
+
+declare function assertNever(_x: never): never;
+
+declare function generateId(bytes?: number): string;
+
+/**
+ * Used to call fn only once between app reloads.
+ * eg: Useful for logging warnings that should only be logged once.
+ *
+ * @example
+ * ```ts
+ * justOnce("unexpected-value", () => console.warn("There was an unexpected value returned", {value}));
+ * ```
+ */
+declare function justOnce(key: string, fn: () => void): void;
+
+export { type AppConfig, type AppOptions, type Branded, type Flavored, type ModuleConfig, type ModuleConfigTuple, type ModuleKey, type PackApp, type PackAppInternal, type TokenProvider, type Unsubscribe, assertIsAppInternal, assertNever, generateId, isModuleConfigTuple, justOnce };

package/build/esm/index.js

@@ -0,0 +1,50 @@
+// ../../node_modules/.pnpm/tiny-invariant@1.3.3/node_modules/tiny-invariant/dist/esm/tiny-invariant.js
+var isProduction = process.env.NODE_ENV === "production";
+var prefix = "Invariant failed";
+function invariant(condition, message) {
+  if (isProduction) {
+    throw new Error(prefix);
+  }
+  var provided = typeof message === "function" ? message() : message;
+  var value = provided ? "".concat(prefix, ": ").concat(provided) : prefix;
+  throw new Error(value);
+}
+
+// src/types/PackApp.ts
+var isModuleConfigTuple = (config) => {
+  return Array.isArray(config);
+};
+function assertIsAppInternal(app) {
+  !("getModule" in app) ? process.env.NODE_ENV !== "production" ? invariant(false, "App is not an PackAppInternal") : invariant() : void 0;
+}
+
+// src/utils/assertNever.ts
+function assertNever(_x) {
+  throw new Error("Hit unreachable code");
+}
+
+// src/utils/generateId.ts
+function toHexString(byteArray) {
+  return Array.from(byteArray, function(byte) {
+    const h = (byte & 255).toString(16);
+    return h.length === 1 ? `0${h}` : h;
+  }).join("");
+}
+function generateId(bytes = 12) {
+  const array = new Int8Array(bytes);
+  const r = crypto.getRandomValues(array);
+  return toHexString(r);
+}
+
+// src/utils/justOnce.ts
+var SEEN_KEYS = /* @__PURE__ */ new Set();
+function justOnce(key, fn) {
+  if (!SEEN_KEYS.has(key)) {
+    SEEN_KEYS.add(key);
+    fn();
+  }
+}
+
+export { assertIsAppInternal, assertNever, generateId, isModuleConfigTuple, justOnce };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/build/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../node_modules/.pnpm/tiny-invariant@1.3.3/node_modules/tiny-invariant/dist/esm/tiny-invariant.js","../../src/types/PackApp.ts","../../src/utils/assertNever.ts","../../src/utils/generateId.ts","../../src/utils/justOnce.ts"],"names":[],"mappings":";AAAA,IAAI,YAAA,GAAe,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,YAAA;AAC5C,IAAI,MAAA,GAAS,kBAAA;AACb,SAAS,SAAA,CAAU,WAAW,OAAA,EAAS;AAIrC,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAM,IAAI,MAAM,MAAM,CAAA;AAAA,EACxB;AACA,EAAA,IAAI,QAAA,GAAW,OAAO,OAAA,KAAY,UAAA,GAAa,SAAQ,GAAI,OAAA;AAC3D,EAAA,IAAI,KAAA,GAAQ,WAAW,EAAA,CAAG,MAAA,CAAO,QAAQ,IAAI,CAAA,CAAE,MAAA,CAAO,QAAQ,CAAA,GAAI,MAAA;AAClE,EAAA,MAAM,IAAI,MAAM,KAAK,CAAA;AACvB;;;ACqCO,IAAM,sBAAsB,CAAA,MAAA,KAAU;AAC3C,EAAA,OAAO,KAAA,CAAM,QAAQ,MAAM,CAAA;AAC7B;AACO,SAAS,oBAAoB,GAAA,EAAK;AACvC,EAAA,EAAE,WAAA,IAAe,GAAA,CAAA,GAAO,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,YAAA,GAAe,SAAA,CAAU,KAAA,EAAO,+BAA+B,CAAA,GAAI,SAAA,CAAe,CAAA,GAAI,MAAA;AACzI;;;ACtCO,SAAS,YAAY,EAAA,EAAI;AAC9B,EAAA,MAAM,IAAI,MAAM,sBAAsB,CAAA;AACxC;;;ACFA,SAAS,YAAY,SAAA,EAAW;AAC9B,EAAA,OAAO,KAAA,CAAM,IAAA,CAAK,SAAA,EAAW,SAAU,IAAA,EAAM;AAC3C,IAAA,MAAM,CAAA,GAAA,CAAK,IAAA,GAAO,GAAA,EAAM,QAAA,CAAS,EAAE,CAAA;AACnC,IAAA,OAAO,CAAA,CAAE,MAAA,KAAW,CAAA,GAAI,CAAA,CAAA,EAAI,CAAC,CAAA,CAAA,GAAK,CAAA;AAAA,EACpC,CAAC,CAAA,CAAE,IAAA,CAAK,EAAE,CAAA;AACZ;AACO,SAAS,UAAA,CAAW,QAAQ,EAAA,EAAI;AACrC,EAAA,MAAM,KAAA,GAAQ,IAAI,SAAA,CAAU,KAAK,CAAA;AACjC,EAAA,MAAM,CAAA,GAAI,MAAA,CAAO,eAAA,CAAgB,KAAK,CAAA;AACtC,EAAA,OAAO,YAAY,CAAC,CAAA;AACtB;;;ACVA,IAAM,SAAA,uBAAgB,GAAA,EAAI;AAWnB,SAAS,QAAA,CAAS,KAAK,EAAA,EAAI;AAChC,EAAA,IAAI,CAAC,SAAA,CAAU,GAAA,CAAI,GAAG,CAAA,EAAG;AACvB,IAAA,SAAA,CAAU,IAAI,GAAG,CAAA;AACjB,IAAA,EAAA,EAAG;AAAA,EACL;AACF","file":"index.js","sourcesContent":["var isProduction = process.env.NODE_ENV === 'production';\nvar prefix = 'Invariant failed';\nfunction invariant(condition, message) {\n  if (condition) {\n    return;\n  }\n  if (isProduction) {\n    throw new Error(prefix);\n  }\n  var provided = typeof message === 'function' ? message() : message;\n  var value = provided ? \"\".concat(prefix, \": \").concat(provided) : prefix;\n  throw new Error(value);\n}\nexport { invariant as default };","/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport invariant from \"tiny-invariant\";\n\n/**\n * PackApp provides access to various pack subsystems.\n *\n * Specific modules are available after configuration and through declarations mixed in by import.\n * Eg for state system, if you import @palantir/pack.state.core you will have access to `app.state` accessor.\n * Similarly, auth is added automatically by initPackApp.\n *\n * @example\n * ```typescript\n * import { DocumentRef } from '@palantir/pack.state.core';\n * import { DocSchema } from '@my-app/schema';\n *\n * const app = initPackApp({\n *   tokenProvider: () => 'your-token',\n *   moduleConfigs: {\n *     ...createPackDocumentServiceConfig({appId: 'your-app-id', documentType: 'your-document-type'})\n *   },\n * });\n *\n * const docRef = app.state.getDocument(docSchema, 'your-document-id');\n * const doc = await docRef.getSnapshot(); // get pojo of your doc state.\n * ```\n */\n\n/**\n * Module configuration - either a tuple of [ModuleKey, config] or just a ModuleKey (for modules with no config)\n */\n\n/**\n * Type guard to check if a ModuleConfig is a tuple configuration\n */\nexport const isModuleConfigTuple = config => {\n  return Array.isArray(config);\n};\nexport function assertIsAppInternal(app) {\n  !(\"getModule\" in app) ? process.env.NODE_ENV !== \"production\" ? invariant(false, \"App is not an PackAppInternal\") : invariant(false) : void 0;\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 function assertNever(_x) {\n  throw new Error(\"Hit unreachable code\");\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\nfunction toHexString(byteArray) {\n  return Array.from(byteArray, function (byte) {\n    const h = (byte & 0xff).toString(16);\n    return h.length === 1 ? `0${h}` : h;\n  }).join(\"\");\n}\nexport function generateId(bytes = 12) {\n  const array = new Int8Array(bytes);\n  const r = crypto.getRandomValues(array);\n  return toHexString(r);\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\nconst SEEN_KEYS = new Set();\n\n/**\n * Used to call fn only once between app reloads.\n * eg: Useful for logging warnings that should only be logged once.\n *\n * @example\n * ```ts\n * justOnce(\"unexpected-value\", () => console.warn(\"There was an unexpected value returned\", {value}));\n * ```\n */\nexport function justOnce(key, fn) {\n  if (!SEEN_KEYS.has(key)) {\n    SEEN_KEYS.add(key);\n    fn();\n  }\n}"]}

package/build/types/index.d.ts

@@ -0,0 +1,10 @@
+export type { AppConfig, AppOptions } from "./types/AppConfig.js";
+export type { Branded, Flavored } from "./types/Branded.js";
+export type { ModuleKey } from "./types/ModuleKey.js";
+export { assertIsAppInternal, isModuleConfigTuple } from "./types/PackApp.js";
+export type { ModuleConfig, ModuleConfigTuple, PackApp, PackAppInternal } from "./types/PackApp.js";
+export type { TokenProvider } from "./types/TokenProvider.js";
+export type { Unsubscribe } from "./types/Unsubscribe.js";
+export { assertNever } from "./utils/assertNever.js";
+export { generateId } from "./utils/generateId.js";
+export { justOnce } from "./utils/justOnce.js";

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,WAAW,kBAAkB;AAC3C,cAAc,SAAS,gBAAgB;AACvC,cAAc,iBAAiB;AAC/B,SAAS,qBAAqB,2BAA2B;AACzD,cAAc,cAAc,mBAAmB,SAAS,uBAAuB;AAC/E,cAAc,qBAAqB;AACnC,cAAc,mBAAmB;AACjC,SAAS,mBAAmB;AAC5B,SAAS,kBAAkB;AAC3B,SAAS,gBAAgB","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}

package/build/types/types/AppConfig.d.ts

@@ -0,0 +1,68 @@
+import type { Logger } from "@osdk/api";
+import type { Client } from "@osdk/client";
+import type { ModuleConfigTuple } from "./PackApp.js";
+import type { TokenProvider } from "./TokenProvider.js";
+export interface AppConfig {
+	readonly app: {
+		readonly appId: string;
+		readonly appVersion?: string;
+	};
+	readonly isTestMode: boolean;
+	readonly logger: Logger;
+	readonly osdkClient: Client;
+	readonly remote: {
+		readonly packApiPath: string;
+		readonly packWsPath: string;
+		readonly baseUrl: string;
+		readonly fetchFn: typeof globalThis.fetch;
+	};
+}
+export interface AppOptions {
+	/**
+	* Override the authentication token provider from the OSDK client.
+	*
+	* @default Uses token provider from OSDK client
+	*/
+	readonly auth?: TokenProvider;
+	/**
+	* The ID of your application.
+	* @default Uses values from page environment meta tags (pack-appId, pack-appVersion)
+	*/
+	readonly app?: {
+		readonly appId: string;
+		readonly appVersion?: string;
+	};
+	/**
+	* Logger configuration.
+	* @see {@link @osdk/client/internal.BrowserLogger} for a richer console logger.
+	* @default Log warnings & errors only.
+	*/
+	readonly logger?: Logger;
+	readonly logLevel?: "debug" | "error" | "info" | "warn";
+	/**
+	* Internal testing overrides.
+	*/
+	readonly moduleOverrides?: readonly ModuleConfigTuple[];
+	readonly remote?: {
+		/**
+		* @default "/pack/api"
+		*/
+		readonly packApiPath?: string;
+		/**
+		* @default "/pack/ws"
+		*/
+		readonly packWsPath?: string;
+		/**
+		* Override the base URL from the OSDK client.
+		*
+		* eg "https://example.com"
+		*
+		* @default Uses base URL from OSDK client
+		*/
+		readonly baseUrl?: string;
+		/**
+		* Override the fetch function from the OSDK client.
+		*/
+		readonly fetchFn?: typeof globalThis.fetch;
+	};
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,cAAc;AAC5B,cAAc,cAAc;AAC5B,cAAc,yBAAyB;AACvC,cAAc,qBAAqB;AAEnC,iBAAiB,UAAU;UAChB,KAAK;WACH;WACA;;UAGF;UAEA,QAAQ;UAER,YAAY;UAEZ,QAAQ;WACN;WACA;WACA;WACA,gBAAgB,WAAW;;;AAIxC,iBAAiB,WAAW;;;;;;UAMjB,OAAO;;;;;UAMP,MAAM;WACJ;WACA;;;;;;;UAQF,SAAS;UACT,WAAW,UAAU,UAAU,SAAS;;;;UAKxC,2BAA2B;UAE3B,SAAS;;;;WAIP;;;;WAKA;;;;;;;;WASA;;;;WAKA,iBAAiB,WAAW","names":[],"sources":["../../../src/types/AppConfig.ts"],"version":3,"file":"AppConfig.d.ts"}

package/build/types/types/Branded.d.ts

@@ -0,0 +1,29 @@
+export type Branded<
+	Brand extends string,
+	T = string
+> = T & Readonly<{
+	readonly __pack_brand: Brand;
+}>;
+/**
+* A type that is "flavored" for self documenting code and prevents some accidental misuse.
+* This is similar to {@link Branded} but allows implicit use of T without a type assertion,
+* which is useful for stronger typing within certain systems without forcing it for all
+* external uses.
+*
+* Flavored types with different brands will not match.
+* A Branded type with the same brand will implicitly match a Flavored type with the same brand,
+* ie `const foo: Flavored<"foo"> = "foo" as Branded<"foo">`
+*
+* @example
+* type MyId = Flavored<"MyId">;
+* type OtherId = Flavored<"OtherId">;
+* const id: MyId = "my-id"; // Good: No type assertion needed
+* const otherId: OtherId = id; // Error: Type 'MyId' is not assignable to type 'OtherId'
+* const otherId: OtherId = id as OtherId; // You can assert between flavored types directly
+*/
+export type Flavored<
+	Flavor extends string,
+	T = string
+> = T & Readonly<{
+	readonly __pack_brand?: Flavor;
+}>;

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,YAAY;CAAQ;CAAsB;IACtC,IACA,SAAS;UACA,cAAc;;;;;;;;;;;;;;;;;;;AAoB3B,YAAY;CAAS;CAAuB;IACxC,IACA,SAAS;UACA,eAAe","names":[],"sources":["../../../src/types/Branded.ts"],"version":3,"file":"Branded.d.ts"}

package/build/types/types/ModuleKey.d.ts

@@ -0,0 +1,53 @@
+import type { PackAppInternal } from "./PackApp.js";
+/**
+* ModuleKey uniquely identifies a module.
+*
+* The key is a symbol and is used to identify the module config.
+* Modules are lazily initialized on first access.
+*
+* @example
+* ```ts
+* const MY_MODULE_ACCESSOR = "myModule";
+*
+* const MY_MODULE_KEY: ModuleKey<MyModule, MyModuleConfig> = {
+*   key: Symbol.for("my.module"),
+*
+*   appMemberName: MY_MODULE_ACCESSOR,
+*   initModule: initMyModule,
+* };
+*
+* const app = initPackApp({
+*   moduleConfig: {
+*     [MY_MODULE_KEY.key]: { ... config ... } satisfies MyModuleConfig
+*
+*     // Note this is the actual shape of the moduleConfig, ie index by module key symbol
+*     // But it is far more ergonomic to spread from a config creator, ie:
+*     ...createMyModuleConfig({ ... config ... }),
+*   }
+* })
+*
+* // Get the module (manual way)
+* const myModule = app.getModule(MY_MODULE_KEY);
+*
+* // Get the module from app property (available via appMemberName sugar)
+* // You also need to declare the appMemberName on the PackApp interface so the type
+* // system knows it is present. This keeps your module usage limited to where your module
+* // is imported
+* declare module '@palantir/pack.core' {
+*   interface PackApp {
+*     readonly [MY_MODULE_ACCESSOR]?: MyModule;
+*   }
+* }
+* const myModule = app.myModule;
+*
+* ```
+*/
+export interface ModuleKey<
+	T,
+	TConfig = unknown
+> {
+	/** If set, this module will have a getter installed on the PackApp interface */
+	readonly appMemberName?: string;
+	readonly key: symbol;
+	readonly initModule: (app: PackAppInternal, config?: TConfig) => T;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CrC,iBAAiB;CAAU;CAAG;EAAmB;;UAEtC;UACA;UACA,aAAa,KAAK,iBAAiB,SAAS,YAAY","names":[],"sources":["../../../src/types/ModuleKey.ts"],"version":3,"file":"ModuleKey.d.ts"}