@osdk/widget.api 2.1.0

package/build/esm/parameters.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 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.
+ */
+/**
+ * Map of the name of the type to the corresponding JavaScript type.
+ */
+/**
+ * Wire format of parameter values that will be sent through postMessage events to custom widgets.
+ */
+export let ParameterValue;
+//# sourceMappingURL=parameters.js.map

package/build/esm/parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.js","names":["ParameterValue"],"sources":["parameters.ts"],"sourcesContent":["/*\n * Copyright 2024 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 type { AsyncValue } from \"./utils/asyncValue.js\";\n\n/**\n * Map of the name of the type to the corresponding JavaScript type.\n */\ntype PrimitiveParameterTypes = {\n  boolean: boolean;\n  /** Formatted as an ISO date string, e.g. YYYY-MM-DD */\n  date: string;\n  number: number;\n  string: string;\n  /** Formatted as an ISO datetime string */\n  timestamp: string;\n};\ntype PrimitiveParameterType = keyof PrimitiveParameterTypes;\n\nexport interface AbstractParameterValue<T extends PrimitiveParameterType> {\n  type: T;\n  value: AsyncValue<PrimitiveParameterTypes[T]>;\n}\n\nexport interface GenericArrayParameterValue<T extends PrimitiveParameterType> {\n  type: \"array\";\n  subType: T;\n  value: AsyncValue<PrimitiveParameterTypes[T][]>;\n}\n\n/**\n * Wire format of parameter values that will be sent through postMessage events to custom widgets.\n */\nexport namespace ParameterValue {\n  export type String = AbstractParameterValue<\"string\">;\n  export type Number = AbstractParameterValue<\"number\">;\n  export type Boolean = AbstractParameterValue<\"boolean\">;\n  export type Date = AbstractParameterValue<\"date\">;\n  export type Timestamp = AbstractParameterValue<\"timestamp\">;\n\n  export type StringArray = GenericArrayParameterValue<\"string\">;\n  export type NumberArray = GenericArrayParameterValue<\"number\">;\n  export type BooleanArray = GenericArrayParameterValue<\"boolean\">;\n  export type DateArray = GenericArrayParameterValue<\"date\">;\n  export type TimestampArray = GenericArrayParameterValue<\"timestamp\">;\n  export type Array =\n    | StringArray\n    | NumberArray\n    | BooleanArray\n    | DateArray\n    | TimestampArray;\n\n  export type Type = ParameterValue[\"type\"];\n  export type PrimitiveType = PrimitiveParameterType;\n}\nexport type ParameterValue =\n  | ParameterValue.String\n  | ParameterValue.Number\n  | ParameterValue.Boolean\n  | ParameterValue.Date\n  | ParameterValue.Timestamp\n  | ParameterValue.Array;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAIA;AACA;AACA;AAuBA;AACA;AACA;AAFA,WAGiBA,cAAc","ignoreList":[]}

package/build/esm/parameters.test.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2024 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 { describe, expectTypeOf, it } from "vitest";
+describe("Parameters", () => {
+  describe("ArrayParameterValue", () => {
+    it("should be able to narrow the type of the array value", () => {
+      expectTypeOf(testStringTypeNarrowing({
+        type: "array",
+        subType: "string",
+        value: {
+          type: "loaded",
+          value: ["a", "b", "c"]
+        }
+      })).toEqualTypeOf();
+    });
+  });
+});
+function testStringTypeNarrowing(array) {
+  if (array.subType === "string" && array.value.type === "loaded") {
+    return array.value.value;
+  }
+  return undefined;
+}
+//# sourceMappingURL=parameters.test.js.map

package/build/esm/parameters.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.test.js","names":["describe","expectTypeOf","it","testStringTypeNarrowing","type","subType","value","toEqualTypeOf","array","undefined"],"sources":["parameters.test.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { describe, expectTypeOf, it } from \"vitest\";\nimport type { ParameterValue } from \"./parameters.js\";\n\ndescribe(\"Parameters\", () => {\n  describe(\"ArrayParameterValue\", () => {\n    it(\"should be able to narrow the type of the array value\", () => {\n      expectTypeOf(\n        testStringTypeNarrowing({\n          type: \"array\",\n          subType: \"string\",\n          value: { type: \"loaded\", value: [\"a\", \"b\", \"c\"] },\n        }),\n      ).toEqualTypeOf<string[] | undefined>();\n    });\n  });\n});\n\nfunction testStringTypeNarrowing(array: ParameterValue.Array) {\n  if (array.subType === \"string\" && array.value.type === \"loaded\") {\n    return array.value.value;\n  }\n  return undefined;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,QAAQ,EAAEC,YAAY,EAAEC,EAAE,QAAQ,QAAQ;AAGnDF,QAAQ,CAAC,YAAY,EAAE,MAAM;EAC3BA,QAAQ,CAAC,qBAAqB,EAAE,MAAM;IACpCE,EAAE,CAAC,sDAAsD,EAAE,MAAM;MAC/DD,YAAY,CACVE,uBAAuB,CAAC;QACtBC,IAAI,EAAE,OAAO;QACbC,OAAO,EAAE,QAAQ;QACjBC,KAAK,EAAE;UAAEF,IAAI,EAAE,QAAQ;UAAEE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG;QAAE;MAClD,CAAC,CACH,CAAC,CAACC,aAAa,CAAuB,CAAC;IACzC,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,SAASJ,uBAAuBA,CAACK,KAA2B,EAAE;EAC5D,IAAIA,KAAK,CAACH,OAAO,KAAK,QAAQ,IAAIG,KAAK,CAACF,KAAK,CAACF,IAAI,KAAK,QAAQ,EAAE;IAC/D,OAAOI,KAAK,CAACF,KAAK,CAACA,KAAK;EAC1B;EACA,OAAOG,SAAS;AAClB","ignoreList":[]}

package/build/esm/utils/asyncValue.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=asyncValue.js.map

package/build/esm/utils/asyncValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncValue.js","names":[],"sources":["asyncValue.ts"],"sourcesContent":["/*\n * Copyright 2024 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 interface AsyncNotStartedLoadingValue {\n  type: \"not-started\";\n  value?: never;\n  error?: never;\n}\n\nexport interface AsyncLoadingValue {\n  type: \"loading\";\n  value?: never;\n  error?: never;\n}\n\nexport interface AsyncLoadedValue<V> {\n  type: \"loaded\";\n  value: V | undefined;\n  error?: never;\n}\n\nexport interface AsyncReloadingValue<V> {\n  type: \"reloading\";\n  value: V | undefined;\n  error?: never;\n}\n\nexport interface AsyncFailedValue<V, E = Error> {\n  type: \"failed\";\n  error: E;\n  value: V | undefined;\n}\n\n/**\n * Represents a value that is loaded asynchronously.\n * This allows for type safe checking of what the value's loading state is.\n * The expected lifecycle is:\n *    not-started -> loading -> loaded or failed -> reloading -> ....\n */\nexport type AsyncValue<V, E = Error> =\n  | AsyncNotStartedLoadingValue\n  | AsyncLoadingValue\n  | AsyncLoadedValue<V>\n  | AsyncReloadingValue<V>\n  | AsyncFailedValue<V, E>;\n"],"mappings":"","ignoreList":[]}

package/build/types/config.d.ts

@@ -0,0 +1,74 @@
+import type { ParameterValue } from "./parameters.js";
+import type { AsyncValue } from "./utils/asyncValue.js";
+interface PrimitiveParameterDefinition<T extends ParameterValue.PrimitiveType> {
+	type: T;
+	displayName: string;
+}
+interface ArrayParameterDefinition<S extends ParameterValue.PrimitiveType> {
+	type: ParameterValue.Array["type"];
+	displayName: string;
+	subType: S;
+}
+export type ParameterDefinition = PrimitiveParameterDefinition<ParameterValue.PrimitiveType> | ArrayParameterDefinition<ParameterValue.PrimitiveType>;
+export interface EventDefinition<P extends ParameterConfig> {
+	displayName: string;
+	parameterUpdateIds: Array<ParameterId<P>>;
+}
+export type ParameterConfig = Record<string, ParameterDefinition>;
+export interface WidgetConfig<P extends ParameterConfig> {
+	id: string;
+	name: string;
+	description?: string;
+	type: "workshop";
+	parameters: ParameterConfig;
+	events: {
+		[eventId: string]: EventDefinition<NoInfer<P>>
+	};
+}
+/**
+* Extracts the parameter ID strings as types from the given ParameterConfig.
+*/
+export type ParameterId<C extends ParameterConfig> = Extract<keyof C, string>;
+/**
+* Extracts a map of parameter IDs to their async-wrapped value types from the given ParameterConfig.
+*/
+export type AsyncParameterValueMap<C extends WidgetConfig<C["parameters"]>> = { [K in ParameterId<C["parameters"]>] : C["parameters"][K] extends ArrayParameterDefinition<infer S> ? Extract<ParameterValue.Array, {
+	type: C["parameters"][K]["type"]
+	subType: S
+}>["value"] extends AsyncValue<infer P> ? {
+	type: "array"
+	subType: S
+	value: AsyncValue<P>
+} : never : Extract<ParameterValue, {
+	type: C["parameters"][K]["type"]
+}>["value"] extends AsyncValue<infer P> ? {
+	type: C["parameters"][K]["type"]
+	value: AsyncValue<P>
+} : never };
+/**
+* Extracts a map of parameter IDs to the raw parameter values from the given ParameterConfig.
+*/
+export type ParameterValueMap<C extends WidgetConfig<C["parameters"]>> = { [K in ParameterId<C["parameters"]>] : C["parameters"][K] extends ArrayParameterDefinition<infer S> ? Extract<ParameterValue.Array, {
+	type: C["parameters"][K]["type"]
+	subType: S
+}>["value"] extends AsyncValue<infer P> ? P : never : Extract<ParameterValue, {
+	type: C["parameters"][K]["type"]
+}>["value"] extends AsyncValue<infer P> ? P : never };
+export type EventId<C extends WidgetConfig<C["parameters"]>> = keyof C["events"];
+/**
+* Extracts a list of strongly-typed parameter IDs from the given WidgetConfig for a given event ID.
+* If a parameter ID is referenced by an event but does not exist, its type will be never
+*/
+export type EventParameterIdList<
+	C extends WidgetConfig<C["parameters"]>,
+	K extends EventId<C>
+> = C["events"][K]["parameterUpdateIds"] extends Array<ParameterId<C["parameters"]>> ? C["events"][K]["parameterUpdateIds"] : never;
+/**
+* Extracts a map of event IDs to their raw parameter value types from the given WidgetConfig.
+*/
+export type EventParameterValueMap<
+	C extends WidgetConfig<C["parameters"]>,
+	K extends EventId<C>
+> = { [P in EventParameterIdList<C, K>[number]] : ParameterValueMap<C>[P] };
+export declare function defineConfig<const C extends WidgetConfig<any>>(c: C): C;
+export {};

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,sBAAsB,iBAAkB;AACtD,cAAc,kBAAkB,uBAAwB;UAE9C,6BAA6B,UAAU,eAAe,eAAe;CAC7E,MAAM;CACN;AACD;UACS,yBAAyB,UAAU,eAAe,eAAe;CACzE,MAAM,eAAe,MAAM;CAC3B;CACA,SAAS;AACV;AACD,YAAY,sBACR,6BAA6B,eAAe,iBAC5C,yBAAyB,eAAe;AAE5C,iBAAiB,gBAAgB,UAAU,iBAAiB;CAC1D;CACA,oBAAoB,MAAM,YAAY;AACvC;AAED,YAAY,kBAAkB,eAAe;AAE7C,iBAAiB,aAAa,UAAU,iBAAiB;CACvD;CACA;CACA;CAEA,MAAM;CACN,YAAY;CACZ,QAAQ;qBAAqB,gBAAgB,QAAQ;CAAK;AAC3D;;;;AAKD,YAAY,YAAY,UAAU,mBAAmB,cAAc;;;;AAKnE,YAAY,uBAAuB,UAAU,aAAa,EAAE,qBAExD,KAAK,YACH,EAAE,kBAEH,EAAE,cAAc,WAAW,+BAA+B,KAEzD,QACA,eAAe,OACf;CAAE,MAAM,EAAE,cAAc,GAAG;CAAS,SAAS;AAAG,GAChD,iBAAiB,iBAAiB,KAAK;CACrC,MAAM;CACN,SAAS;CACT,OAAO,WAAW;AACnB,YAED,QACA,gBACA;CAAE,MAAM,EAAE,cAAc,GAAG;AAAS,GACpC,iBAAiB,iBAAiB,KAAK;CACrC,MAAM,EAAE,cAAc,GAAG;CACzB,OAAO,WAAW;AACnB;;;;AAOP,YAAY,kBAAkB,UAAU,aAAa,EAAE,qBAEnD,KAAK,YACH,EAAE,kBAEH,EAAE,cAAc,WAAW,+BAA+B,KAAK,QAC9D,eAAe,OACf;CAAE,MAAM,EAAE,cAAc,GAAG;CAAS,SAAS;AAAG,GAChD,iBAAiB,iBAAiB,KAAK,YAEvC,QACA,gBACA;CAAE,MAAM,EAAE,cAAc,GAAG;AAAS,GACpC,iBAAiB,iBAAiB,KAAK;AAI7C,YAAY,QAAQ,UAAU,aAAa,EAAE,wBACrC,EAAE;;;;;AAMV,YAAY;CACV,UAAU,aAAa,EAAE;CACzB,UAAU,QAAQ;IAChB,EAAE,UAAU,GAAG,8BACjB,MAAM,YAAY,EAAE,kBAAkB,EAAE,UAAU,GAAG;;;;AAMvD,YAAY;CACV,UAAU,aAAa,EAAE;CACzB,UAAU,QAAQ;OAEjB,KAAK,qBAAqB,GAAG,cAAa,kBAAkB,GAAG;AAGlE,OAAO,iBAAS,mBAAmB,UAAU,mBAAmBA,GAAG,IAAI","names":["c: C"],"sources":["../../src/config.ts"],"version":3,"file":"config.d.ts"}

package/build/types/config.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/config.test.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"","names":[],"sources":["../../src/config.test.ts"],"version":3,"file":"config.test.d.ts"}

package/build/types/index.d.ts

@@ -0,0 +1,10 @@
+export type { AsyncParameterValueMap, EventId, EventParameterValueMap, ParameterConfig, ParameterDefinition, ParameterValueMap, WidgetConfig } from "./config.js";
+export { defineConfig } from "./config.js";
+export type { WidgetManifestConfigV1 as WidgetManifestConfig, WidgetSetManifestV1 as WidgetSetManifest } from "./manifest.js";
+export { MANIFEST_FILE_LOCATION } from "./manifest.js";
+export { HostMessage, isHostParametersUpdatedMessage, visitHostMessage } from "./messages/hostMessages.js";
+export { isWidgetEmitEventMessage, isWidgetReadyMessage, visitWidgetMessage } from "./messages/widgetMessages.js";
+export type { WidgetMessage } from "./messages/widgetMessages.js";
+export { META_TAG_HOST_ORIGIN } from "./metaTags.js";
+export type { ParameterValue } from "./parameters.js";
+export type { AsyncFailedValue, AsyncLoadedValue, AsyncLoadingValue, AsyncNotStartedLoadingValue, AsyncReloadingValue, AsyncValue } from "./utils/asyncValue.js";

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACE,wBACA,SACA,wBACA,iBACA,qBACA,mBACA,oBACK;AACP,SAAS,oBAAoB;AAC7B,cACE,0BAA0B,sBAC1B,uBAAuB,yBAClB;AACP,SAAS,8BAA8B;AACvC,SACE,aACA,gCACA,wBACK;AACP,SACE,0BACA,sBACA,0BACK;AACP,cAAc,qBAAqB;AACnC,SAAS,4BAA4B;AACrC,cAAc,sBAAsB;AACpC,cACE,kBACA,kBACA,mBACA,6BACA,qBACA,kBACK","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}

package/build/types/manifest.d.ts

@@ -0,0 +1,64 @@
+import type { EventDefinition, ParameterConfig, ParameterDefinition } from "./config.js";
+export interface WidgetSetManifestV1 {
+	manifestVersion: "1.0.0";
+	widgetSet: WidgetSetManifestContentV1;
+}
+export interface WidgetSetManifestContentV1 {
+	/**
+	* RID of the widget set that this config corresponds to
+	*/
+	rid: string;
+	/**
+	* The version of the widget to publish as
+	*/
+	version: string;
+	/**
+	* Set of widgets that are available to be rendered.
+	* The key can be arbitrary, and is usually the name of your entrypoint, e.g. "main"
+	*/
+	widgets: Record<string, WidgetManifestConfigV1>;
+}
+export interface WidgetManifestConfigV1 {
+	/**
+	* The ID of this widget. Must be unique within the widget set
+	*/
+	id: string;
+	/**
+	* The user friendly name of this widget
+	*/
+	name: string;
+	/**
+	* A user friendly description of this widget
+	*/
+	description?: string;
+	/**
+	* The target Foundry UI that this widget is intended to be used in
+	*/
+	type: "workshopWidgetV1";
+	/**
+	* List of entrypoint JS files to be loaded, in order. These will be placed on the page in script tags
+	*/
+	entrypointJs: Array<{
+		/** Relative path of the JS file to load */
+		path: string
+		/** The type to use in the script tag when loading this JS file */
+		type: "module" | "text/javascript"
+	}>;
+	/**
+	* Any CSS files to be loaded, in order.
+	* @optional
+	*/
+	entrypointCss?: Array<{
+		/** Relative path of the CSS file to load */
+		path: string
+	}>;
+	/**
+	* The map of parameter IDs to their definition
+	*/
+	parameters: Record<string, ParameterDefinition>;
+	/**
+	* The map of events to their definition. Any parameter IDs referenced must be defined in the `parameters` field
+	*/
+	events: Record<string, EventDefinition<ParameterConfig>>;
+}
+export declare const MANIFEST_FILE_LOCATION = ".palantir/widgets.config.json";

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACE,iBACA,iBACA,2BACK,aAAc;AAErB,iBAAiB,oBAAoB;CACnC,iBAAiB;CACjB,WAAW;AACZ;AAED,iBAAiB,2BAA2B;;;;CAI1C;;;;CAKA;;;;;CAMA,SAAS,eAAe;AACzB;AAED,iBAAiB,uBAAuB;;;;CAItC;;;;CAKA;;;;CAKA;;;;CAKA,MAAM;;;;CAKN,cAAc,MAAM;;EAElB;;EAGA,MAAM,WAAW;CAClB;;;;;CAMD,gBAAgB,MAAM;;EAEpB;CACD;;;;CAKD,YAAY,eAAe;;;;CAK3B,QAAQ,eAAe,gBAAgB;AACxC;AAED,OAAO,cAAM,yBAAyB","names":[],"sources":["../../src/manifest.ts"],"version":3,"file":"manifest.d.ts"}

package/build/types/manifest.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/manifest.test.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"","names":[],"sources":["../../src/manifest.test.ts"],"version":3,"file":"manifest.test.d.ts"}

package/build/types/messages/hostMessages.d.ts

@@ -0,0 +1,33 @@
+import type { AsyncParameterValueMap, WidgetConfig } from "../config.js";
+interface HostBaseMessage<
+	T extends string,
+	P = unknown
+> {
+	type: T;
+	payload: P;
+}
+export declare namespace HostMessage {
+	const Version = "1.0.0";
+	type Version = typeof Version;
+	namespace Payload {
+		interface UpdateParameters<C extends WidgetConfig<C["parameters"]>> {
+			parameters: AsyncParameterValueMap<C>;
+		}
+	}
+	type Payload = Payload.UpdateParameters<any>;
+	interface UpdateParameters<C extends WidgetConfig<C["parameters"]>> extends HostBaseMessage<"host.update-parameters", Payload.UpdateParameters<C>> {}
+}
+export type HostMessage<C extends WidgetConfig<C["parameters"]>> = HostMessage.UpdateParameters<C>;
+export declare function isHostParametersUpdatedMessage<C extends WidgetConfig<C["parameters"]>>(event: HostMessage<C>): event is HostMessage.UpdateParameters<C>;
+type HostMessageVisitor<C extends WidgetConfig<C["parameters"]>> = { [T in HostMessage<C>["type"]] : (payload: Extract<HostMessage<C>, {
+	type: T
+}> extends {
+	payload: infer P
+} ? P : never) => void } & {
+	_unknown: (type: string) => void
+};
+/**
+* Strongly typed visitor to handle every type of host message
+*/
+export declare function visitHostMessage<C extends WidgetConfig<C["parameters"]>>(message: HostMessage<C>, visitor: HostMessageVisitor<C>): void;
+export {};

package/build/types/messages/hostMessages.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,wBAAwB,oBAAoB,cAAe;UAG/D;CAAgB;CAAkB;EAAa;CACvD,MAAM;CACN,SAAS;AACV;AAED,yBAAiB;CACR,MAAM,UAAU;MACX,iBAAiB;WAEZ;YACE,iBAAiB,UAAU,aAAa,EAAE,gBAAgB;GACzE,YAAY,uBAAuB;EACpC;;MAGS,UAAU,QAAQ;WAEb,iBAAiB,UAAU,aAAa,EAAE,wBAEvD,gBACE,0BACA,QAAQ,iBAAiB,IAE/B,CAAE;;AAGJ,YAAY,YAAY,UAAU,aAAa,EAAE,kBAC/C,YAAY,iBAAiB;AAE/B,OAAO,iBAAS,+BACd,UAAU,aAAa,EAAE,gBACzBA,OAAO,YAAY,KAAK,SAAS,YAAY,iBAAiB;KAI3D,mBAAmB,UAAU,aAAa,EAAE,qBAE5C,KAAK,YAAY,GAAG,YACnBC,SAAS,QAAQ,YAAY,IAAI;CAAE,MAAM;AAAG,WAAU;CACpD,eAAe;AAChB,IAAG,uBAIN;CACA,WAAWC;AACZ;;;;AAKH,OAAO,iBAAS,iBAAiB,UAAU,aAAa,EAAE,gBACxDC,SAAS,YAAY,IACrBC,SAAS,mBAAmB","names":["event: HostMessage<C>","payload: Extract<HostMessage<C>, { type: T }> extends {\n        payload: infer P;\n      } ? P\n        : never","type: string","message: HostMessage<C>","visitor: HostMessageVisitor<C>"],"sources":["../../../src/messages/hostMessages.ts"],"version":3,"file":"hostMessages.d.ts"}

package/build/types/messages/widgetMessages.d.ts

@@ -0,0 +1,36 @@
+import type { EventId, EventParameterValueMap, WidgetConfig } from "../config.js";
+import type { HostMessage } from "./hostMessages.js";
+interface WidgetBaseMessage<
+	T extends string,
+	P = unknown
+> {
+	type: T;
+	payload: P;
+}
+type EmitEventIdMap<C extends WidgetConfig<C["parameters"]>> = { [K in EventId<C>] : {
+	eventId: K
+	parameterUpdates: EventParameterValueMap<C, K>
+} };
+export declare namespace WidgetMessage {
+	namespace Payload {
+		interface Ready {
+			apiVersion: HostMessage.Version;
+		}
+		type EmitEvent<C extends WidgetConfig<C["parameters"]>> = EmitEventIdMap<C>[EventId<C>];
+	}
+	type Payload<C extends WidgetConfig<C["parameters"]>> = Payload.Ready | Payload.EmitEvent<C>;
+	interface Ready extends WidgetBaseMessage<"widget.ready", Payload.Ready> {}
+	interface EmitEvent<C extends WidgetConfig<C["parameters"]>> extends WidgetBaseMessage<"widget.emit-event", Payload.EmitEvent<C>> {}
+}
+export type WidgetMessage<C extends WidgetConfig<C["parameters"]>> = WidgetMessage.Ready | WidgetMessage.EmitEvent<C>;
+export declare function isWidgetReadyMessage<C extends WidgetConfig<C["parameters"]>>(event: WidgetMessage<C>): event is WidgetMessage.Ready;
+export declare function isWidgetEmitEventMessage<C extends WidgetConfig<C["parameters"]>>(event: WidgetMessage<C>): event is WidgetMessage.EmitEvent<C>;
+type WidgetMessageVisitor<C extends WidgetConfig<C["parameters"]>> = { [T in WidgetMessage<C>["type"]] : (payload: Extract<WidgetMessage<C>, {
+	type: T
+}> extends {
+	payload: infer P
+} ? P : never) => void } & {
+	_unknown: (type: string) => void
+};
+export declare function visitWidgetMessage<C extends WidgetConfig<C["parameters"]>>(message: WidgetMessage<C>, visitor: WidgetMessageVisitor<C>): void;
+export {};

package/build/types/messages/widgetMessages.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACE,SACA,wBACA,oBACK,cAAe;AACtB,cAAc,mBAAmB,mBAAoB;UAI3C;CAAkB;CAAkB;EAAa;CACzD,MAAM;CACN,SAAS;AACV;KAEI,eAAe,UAAU,aAAa,EAAE,qBAC1C,KAAK,QAAQ,MAAK;CACjB,SAAS;CACT,kBAAkB,uBAAuB,GAAG;AAC7C;AAGH,yBAAiB;WACE;YACE,MAAM;GACrB,YAAY,YAAY;EACzB;OAEW,UAAU,UAAU,aAAa,EAAE,kBAC7C,eAAe,GAAG,QAAQ;;MAGlB,QAAQ,UAAU,aAAa,EAAE,kBACzC,QAAQ,QACR,QAAQ,UAAU;WAKL,cACP,kBAAkB,gBAAgB,QAAQ,OACpD,CAAE;WAKe,UAAU,UAAU,aAAa,EAAE,wBAC1C,kBAAkB,qBAAqB,QAAQ,UAAU,IACnE,CAAE;;AAGJ,YAAY,cAAc,UAAU,aAAa,EAAE,kBAC/C,cAAc,QACd,cAAc,UAAU;AAE5B,OAAO,iBAAS,qBAAqB,UAAU,aAAa,EAAE,gBAC5DA,OAAO,cAAc,KACpB,SAAS,cAAc;AAI1B,OAAO,iBAAS,yBACd,UAAU,aAAa,EAAE,gBACzBA,OAAO,cAAc,KAAK,SAAS,cAAc,UAAU;KAIxD,qBAAqB,UAAU,aAAa,EAAE,qBAE9C,KAAK,cAAc,GAAG,YACrBC,SAAS,QAAQ,cAAc,IAAI;CAAE,MAAM;AAAG,WAAU;CACtD,eAAe;AAChB,IAAG,uBAIN;CACA,WAAWC;AACZ;AAEH,OAAO,iBAAS,mBAAmB,UAAU,aAAa,EAAE,gBAC1DC,SAAS,cAAc,IACvBC,SAAS,qBAAqB","names":["event: WidgetMessage<C>","payload: Extract<WidgetMessage<C>, { type: T }> extends {\n        payload: infer P;\n      } ? P\n        : never","type: string","message: WidgetMessage<C>","visitor: WidgetMessageVisitor<C>"],"sources":["../../../src/messages/widgetMessages.ts"],"version":3,"file":"widgetMessages.d.ts"}

package/build/types/messages/widgetMessages.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/messages/widgetMessages.test.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"","names":[],"sources":["../../../src/messages/widgetMessages.test.ts"],"version":3,"file":"widgetMessages.test.d.ts"}

package/build/types/metaTags.d.ts

@@ -0,0 +1 @@
+export declare const META_TAG_HOST_ORIGIN = "x-palantir-widgets-host-origin";

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,OAAO,cAAM,uBAAuB","names":[],"sources":["../../src/metaTags.ts"],"version":3,"file":"metaTags.d.ts"}

package/build/types/parameters.d.ts

@@ -0,0 +1,43 @@
+import type { AsyncValue } from "./utils/asyncValue.js";
+/**
+* Map of the name of the type to the corresponding JavaScript type.
+*/
+type PrimitiveParameterTypes = {
+	boolean: boolean
+	/** Formatted as an ISO date string, e.g. YYYY-MM-DD */
+	date: string
+	number: number
+	string: string
+	/** Formatted as an ISO datetime string */
+	timestamp: string
+};
+type PrimitiveParameterType = keyof PrimitiveParameterTypes;
+export interface AbstractParameterValue<T extends PrimitiveParameterType> {
+	type: T;
+	value: AsyncValue<PrimitiveParameterTypes[T]>;
+}
+export interface GenericArrayParameterValue<T extends PrimitiveParameterType> {
+	type: "array";
+	subType: T;
+	value: AsyncValue<PrimitiveParameterTypes[T][]>;
+}
+/**
+* Wire format of parameter values that will be sent through postMessage events to custom widgets.
+*/
+export declare namespace ParameterValue {
+	type String = AbstractParameterValue<"string">;
+	type Number = AbstractParameterValue<"number">;
+	type Boolean = AbstractParameterValue<"boolean">;
+	type Date = AbstractParameterValue<"date">;
+	type Timestamp = AbstractParameterValue<"timestamp">;
+	type StringArray = GenericArrayParameterValue<"string">;
+	type NumberArray = GenericArrayParameterValue<"number">;
+	type BooleanArray = GenericArrayParameterValue<"boolean">;
+	type DateArray = GenericArrayParameterValue<"date">;
+	type TimestampArray = GenericArrayParameterValue<"timestamp">;
+	type Array = StringArray | NumberArray | BooleanArray | DateArray | TimestampArray;
+	type Type = ParameterValue["type"];
+	type PrimitiveType = PrimitiveParameterType;
+}
+export type ParameterValue = ParameterValue.String | ParameterValue.Number | ParameterValue.Boolean | ParameterValue.Date | ParameterValue.Timestamp | ParameterValue.Array;
+export {};

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,kBAAkB,uBAAwB;;;;KAKnD,0BAA0B;CAC7B;;CAEA;CACA;CACA;;CAEA;AACD;KACI,+BAA+B;AAEpC,iBAAiB,uBAAuB,UAAU,wBAAwB;CACxE,MAAM;CACN,OAAO,WAAW,wBAAwB;AAC3C;AAED,iBAAiB,2BAA2B,UAAU,wBAAwB;CAC5E,MAAM;CACN,SAAS;CACT,OAAO,WAAW,wBAAwB;AAC3C;;;;AAKD,yBAAiB;MACH,SAAS,uBAAuB;MAChC,SAAS,uBAAuB;MAChC,UAAU,uBAAuB;MACjC,OAAO,uBAAuB;MAC9B,YAAY,uBAAuB;MAEnC,cAAc,2BAA2B;MACzC,cAAc,2BAA2B;MACzC,eAAe,2BAA2B;MAC1C,YAAY,2BAA2B;MACvC,iBAAiB,2BAA2B;MAC5C,QACR,cACA,cACA,eACA,YACA;MAEQ,OAAO,eAAe;MACtB,gBAAgB;;AAE9B,YAAY,iBACR,eAAe,SACf,eAAe,SACf,eAAe,UACf,eAAe,OACf,eAAe,YACf,eAAe","names":[],"sources":["../../src/parameters.ts"],"version":3,"file":"parameters.d.ts"}

package/build/types/parameters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/parameters.test.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"","names":[],"sources":["../../src/parameters.test.ts"],"version":3,"file":"parameters.test.d.ts"}

package/build/types/utils/asyncValue.d.ts

@@ -0,0 +1,38 @@
+export interface AsyncNotStartedLoadingValue {
+	type: "not-started";
+	value?: never;
+	error?: never;
+}
+export interface AsyncLoadingValue {
+	type: "loading";
+	value?: never;
+	error?: never;
+}
+export interface AsyncLoadedValue<V> {
+	type: "loaded";
+	value: V | undefined;
+	error?: never;
+}
+export interface AsyncReloadingValue<V> {
+	type: "reloading";
+	value: V | undefined;
+	error?: never;
+}
+export interface AsyncFailedValue<
+	V,
+	E = Error
+> {
+	type: "failed";
+	error: E;
+	value: V | undefined;
+}
+/**
+* Represents a value that is loaded asynchronously.
+* This allows for type safe checking of what the value's loading state is.
+* The expected lifecycle is:
+*    not-started -> loading -> loaded or failed -> reloading -> ....
+*/
+export type AsyncValue<
+	V,
+	E = Error
+> = AsyncNotStartedLoadingValue | AsyncLoadingValue | AsyncLoadedValue<V> | AsyncReloadingValue<V> | AsyncFailedValue<V, E>;

package/build/types/utils/asyncValue.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,iBAAiB,4BAA4B;CAC3C,MAAM;CACN;CACA;AACD;AAED,iBAAiB,kBAAkB;CACjC,MAAM;CACN;CACA;AACD;AAED,iBAAiB,iBAAiB,GAAG;CACnC,MAAM;CACN,OAAO;CACP;AACD;AAED,iBAAiB,oBAAoB,GAAG;CACtC,MAAM;CACN,OAAO;CACP;AACD;AAED,iBAAiB;CAAiB;CAAG,IAAI;EAAO;CAC9C,MAAM;CACN,OAAO;CACP,OAAO;AACR;;;;;;;AAQD,YAAY;CAAW;CAAG,IAAI;IAC1B,8BACA,oBACA,iBAAiB,KACjB,oBAAoB,KACpB,iBAAiB,GAAG","names":[],"sources":["../../../src/utils/asyncValue.ts"],"version":3,"file":"asyncValue.d.ts"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@osdk/widget.api",
+  "version": "2.1.0",
+  "description": "API contract between Foundry UIs that can embed custom widgets and the custom widgets themselves",
+  "access": "public",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/palantir/osdk-ts.git"
+  },
+  "exports": {
+    ".": {
+      "browser": "./build/browser/index.js",
+      "import": {
+        "types": "./build/types/index.d.ts",
+        "default": "./build/esm/index.js"
+      },
+      "require": "./build/cjs/index.cjs",
+      "default": "./build/browser/index.js"
+    },
+    "./*": {
+      "browser": "./build/browser/public/*.js",
+      "import": {
+        "types": "./build/types/public/*.d.ts",
+        "default": "./build/esm/public/*.js"
+      },
+      "require": "./build/cjs/public/*.cjs",
+      "default": "./build/browser/public/*.js"
+    }
+  },
+  "devDependencies": {
+    "ts-expect": "^1.3.0",
+    "typescript": "~5.5.4",
+    "vitest": "^3.0.5",
+    "@osdk/monorepo.api-extractor": "~0.1.0",
+    "@osdk/monorepo.tsconfig": "~0.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "files": [
+    "build/cjs",
+    "build/esm",
+    "build/browser",
+    "build/types",
+    "CHANGELOG.md",
+    "package.json",
+    "templates",
+    "*.d.ts"
+  ],
+  "main": "./build/cjs/index.cjs",
+  "module": "./build/esm/index.js",
+  "types": "./build/cjs/index.d.cts",
+  "type": "module",
+  "scripts": {
+    "check-attw": "attw --pack .",
+    "check-spelling": "cspell --quiet .",
+    "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
+    "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
+    "lint": "eslint . && dprint check  --config $(find-up dprint.json)",
+    "test": "vitest run",
+    "transpileBrowser": "monorepo.tool.transpile -f esm -m normal -t browser",
+    "transpileCjs": "monorepo.tool.transpile -f cjs -m bundle -t node",
+    "transpileEsm": "monorepo.tool.transpile -f esm -m normal -t node",
+    "transpileTypes": "monorepo.tool.transpile -f esm -m types -t node",
+    "typecheck": "tsc --noEmit --emitDeclarationOnly false"
+  }
+}