@osdk/widget.api 3.3.0-beta.1 → 3.3.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/build/browser/index.js.map +1 -1
- package/build/browser/parameters.js.map +1 -1
- package/build/cjs/index.d.cts +5 -5
- package/build/esm/index.js.map +1 -1
- package/build/esm/parameters.js.map +1 -1
- package/build/types/index.d.ts +1 -1
- package/build/types/index.d.ts.map +1 -1
- package/build/types/parameters.d.ts +4 -5
- package/build/types/parameters.d.ts.map +1 -1
- package/package.json +6 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# @osdk/widget.api
|
|
2
2
|
|
|
3
|
+
## 3.3.0-beta.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies [2556c64]
|
|
8
|
+
- @osdk/api@2.6.0-beta.5
|
|
9
|
+
|
|
10
|
+
## 3.3.0-beta.2
|
|
11
|
+
|
|
12
|
+
### Minor Changes
|
|
13
|
+
|
|
14
|
+
- 4d37e98: Improved support for object set parameters in widget.client-react
|
|
15
|
+
|
|
3
16
|
## 3.2.0-beta.5
|
|
4
17
|
|
|
5
18
|
### Minor Changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["defineConfig","MANIFEST_FILE_LOCATION","HostMessage","isHostParametersUpdatedMessage","visitHostMessage","isWidgetEmitEventMessage","isWidgetReadyMessage","visitWidgetMessage"],"sources":["index.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 type {\n AsyncParameterValueMap,\n EventId,\n EventParameterValueMap,\n ManifestParameterDefinition,\n ParameterConfig,\n ParameterDefinition,\n ParameterValueMap,\n WidgetConfig,\n} from \"./config.js\";\nexport { defineConfig } from \"./config.js\";\nexport type {\n OntologySdkInputSpecV1 as OntologySdkInputSpec,\n WidgetManifestConfigV1 as WidgetManifestConfig,\n WidgetSetDiscoveredInputSpecV1 as WidgetSetDiscoveredInputSpec,\n WidgetSetInputSpecV1 as WidgetSetInputSpec,\n WidgetSetManifestV1 as WidgetSetManifest,\n} from \"./manifest.js\";\nexport { MANIFEST_FILE_LOCATION } from \"./manifest.js\";\nexport {\n HostMessage,\n isHostParametersUpdatedMessage,\n visitHostMessage,\n} from \"./messages/hostMessages.js\";\nexport {\n isWidgetEmitEventMessage,\n isWidgetReadyMessage,\n visitWidgetMessage,\n} from \"./messages/widgetMessages.js\";\nexport type { WidgetMessage } from \"./messages/widgetMessages.js\";\nexport type { ParameterValue } from \"./parameters.js\";\nexport type {\n AsyncFailedValue,\n AsyncLoadedValue,\n AsyncLoadingValue,\n AsyncNotStartedLoadingValue,\n AsyncReloadingValue,\n AsyncValue,\n} from \"./utils/asyncValue.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,SAASA,YAAY,QAAQ,aAAa;AAQ1C,SAASC,sBAAsB,QAAQ,eAAe;AACtD,SACEC,WAAW,EACXC,8BAA8B,EAC9BC,gBAAgB,QACX,4BAA4B;AACnC,SACEC,wBAAwB,EACxBC,oBAAoB,EACpBC,kBAAkB,QACb,8BAA8B","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"index.js","names":["defineConfig","MANIFEST_FILE_LOCATION","HostMessage","isHostParametersUpdatedMessage","visitHostMessage","isWidgetEmitEventMessage","isWidgetReadyMessage","visitWidgetMessage"],"sources":["index.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 type {\n AsyncParameterValueMap,\n EventId,\n EventParameterValueMap,\n ManifestParameterDefinition,\n ParameterConfig,\n ParameterDefinition,\n ParameterValueMap,\n WidgetConfig,\n} from \"./config.js\";\nexport { defineConfig } from \"./config.js\";\nexport type {\n OntologySdkInputSpecV1 as OntologySdkInputSpec,\n WidgetManifestConfigV1 as WidgetManifestConfig,\n WidgetSetDiscoveredInputSpecV1 as WidgetSetDiscoveredInputSpec,\n WidgetSetInputSpecV1 as WidgetSetInputSpec,\n WidgetSetManifestV1 as WidgetSetManifest,\n} from \"./manifest.js\";\nexport { MANIFEST_FILE_LOCATION } from \"./manifest.js\";\nexport {\n HostMessage,\n isHostParametersUpdatedMessage,\n visitHostMessage,\n} from \"./messages/hostMessages.js\";\nexport {\n isWidgetEmitEventMessage,\n isWidgetReadyMessage,\n visitWidgetMessage,\n} from \"./messages/widgetMessages.js\";\nexport type { WidgetMessage } from \"./messages/widgetMessages.js\";\nexport type { ObjectType, ParameterValue } from \"./parameters.js\";\nexport type {\n AsyncFailedValue,\n AsyncLoadedValue,\n AsyncLoadingValue,\n AsyncNotStartedLoadingValue,\n AsyncReloadingValue,\n AsyncValue,\n} from \"./utils/asyncValue.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,SAASA,YAAY,QAAQ,aAAa;AAQ1C,SAASC,sBAAsB,QAAQ,eAAe;AACtD,SACEC,WAAW,EACXC,8BAA8B,EAC9BC,gBAAgB,QACX,4BAA4B;AACnC,SACEC,wBAAwB,EACxBC,oBAAoB,EACpBC,kBAAkB,QACb,8BAA8B","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
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\nexport
|
|
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 { ObjectTypeDefinition } from \"@osdk/api\";\nimport type { AsyncValue } from \"./utils/asyncValue.js\";\n\nexport interface ObjectType extends ObjectTypeDefinition {\n internalDoNotUseMetadata?: {\n rid: string;\n };\n}\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 ObjectSetParameterValue<T extends ObjectType> {\n type: \"objectSet\";\n value: AsyncValue<{\n objectSetRid: string;\n }>;\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 export type ObjectSet<T extends ObjectType = ObjectType> =\n ObjectSetParameterValue<T>;\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.ObjectSet\n | ParameterValue.Array;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAWA;AACA;AACA;AA8BA;AACA;AACA;AAFA,WAGiBA,cAAc","ignoreList":[]}
|
package/build/cjs/index.d.cts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { ObjectTypeDefinition } from '@osdk/api';
|
|
2
|
+
|
|
1
3
|
interface AsyncNotStartedLoadingValue {
|
|
2
4
|
type: "not-started";
|
|
3
5
|
value?: never;
|
|
@@ -31,13 +33,11 @@ interface AsyncFailedValue<V, E = Error> {
|
|
|
31
33
|
*/
|
|
32
34
|
type AsyncValue<V, E = Error> = AsyncNotStartedLoadingValue | AsyncLoadingValue | AsyncLoadedValue<V> | AsyncReloadingValue<V> | AsyncFailedValue<V, E>;
|
|
33
35
|
|
|
34
|
-
|
|
35
|
-
type: "object";
|
|
36
|
-
apiName: string;
|
|
36
|
+
interface ObjectType extends ObjectTypeDefinition {
|
|
37
37
|
internalDoNotUseMetadata?: {
|
|
38
38
|
rid: string;
|
|
39
39
|
};
|
|
40
|
-
}
|
|
40
|
+
}
|
|
41
41
|
/**
|
|
42
42
|
* Map of the name of the type to the corresponding JavaScript type.
|
|
43
43
|
*/
|
|
@@ -337,4 +337,4 @@ type WidgetMessageVisitor<C extends WidgetConfig<C["parameters"]>> = {
|
|
|
337
337
|
};
|
|
338
338
|
declare function visitWidgetMessage<C extends WidgetConfig<C["parameters"]>>(message: WidgetMessage<C>, visitor: WidgetMessageVisitor<C>): void;
|
|
339
339
|
|
|
340
|
-
export { type AsyncFailedValue, type AsyncLoadedValue, type AsyncLoadingValue, type AsyncNotStartedLoadingValue, type AsyncParameterValueMap, type AsyncReloadingValue, type AsyncValue, type EventId, type EventParameterValueMap, HostMessage, MANIFEST_FILE_LOCATION, type ManifestParameterDefinition, type OntologySdkInputSpecV1 as OntologySdkInputSpec, type ParameterConfig, type ParameterDefinition, ParameterValue, type ParameterValueMap, type WidgetConfig, type WidgetManifestConfigV1 as WidgetManifestConfig, WidgetMessage, type WidgetSetDiscoveredInputSpecV1 as WidgetSetDiscoveredInputSpec, type WidgetSetInputSpecV1 as WidgetSetInputSpec, type WidgetSetManifestV1 as WidgetSetManifest, defineConfig, isHostParametersUpdatedMessage, isWidgetEmitEventMessage, isWidgetReadyMessage, visitHostMessage, visitWidgetMessage };
|
|
340
|
+
export { type AsyncFailedValue, type AsyncLoadedValue, type AsyncLoadingValue, type AsyncNotStartedLoadingValue, type AsyncParameterValueMap, type AsyncReloadingValue, type AsyncValue, type EventId, type EventParameterValueMap, HostMessage, MANIFEST_FILE_LOCATION, type ManifestParameterDefinition, type ObjectType, type OntologySdkInputSpecV1 as OntologySdkInputSpec, type ParameterConfig, type ParameterDefinition, ParameterValue, type ParameterValueMap, type WidgetConfig, type WidgetManifestConfigV1 as WidgetManifestConfig, WidgetMessage, type WidgetSetDiscoveredInputSpecV1 as WidgetSetDiscoveredInputSpec, type WidgetSetInputSpecV1 as WidgetSetInputSpec, type WidgetSetManifestV1 as WidgetSetManifest, defineConfig, isHostParametersUpdatedMessage, isWidgetEmitEventMessage, isWidgetReadyMessage, visitHostMessage, visitWidgetMessage };
|
package/build/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["defineConfig","MANIFEST_FILE_LOCATION","HostMessage","isHostParametersUpdatedMessage","visitHostMessage","isWidgetEmitEventMessage","isWidgetReadyMessage","visitWidgetMessage"],"sources":["index.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 type {\n AsyncParameterValueMap,\n EventId,\n EventParameterValueMap,\n ManifestParameterDefinition,\n ParameterConfig,\n ParameterDefinition,\n ParameterValueMap,\n WidgetConfig,\n} from \"./config.js\";\nexport { defineConfig } from \"./config.js\";\nexport type {\n OntologySdkInputSpecV1 as OntologySdkInputSpec,\n WidgetManifestConfigV1 as WidgetManifestConfig,\n WidgetSetDiscoveredInputSpecV1 as WidgetSetDiscoveredInputSpec,\n WidgetSetInputSpecV1 as WidgetSetInputSpec,\n WidgetSetManifestV1 as WidgetSetManifest,\n} from \"./manifest.js\";\nexport { MANIFEST_FILE_LOCATION } from \"./manifest.js\";\nexport {\n HostMessage,\n isHostParametersUpdatedMessage,\n visitHostMessage,\n} from \"./messages/hostMessages.js\";\nexport {\n isWidgetEmitEventMessage,\n isWidgetReadyMessage,\n visitWidgetMessage,\n} from \"./messages/widgetMessages.js\";\nexport type { WidgetMessage } from \"./messages/widgetMessages.js\";\nexport type { ParameterValue } from \"./parameters.js\";\nexport type {\n AsyncFailedValue,\n AsyncLoadedValue,\n AsyncLoadingValue,\n AsyncNotStartedLoadingValue,\n AsyncReloadingValue,\n AsyncValue,\n} from \"./utils/asyncValue.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,SAASA,YAAY,QAAQ,aAAa;AAQ1C,SAASC,sBAAsB,QAAQ,eAAe;AACtD,SACEC,WAAW,EACXC,8BAA8B,EAC9BC,gBAAgB,QACX,4BAA4B;AACnC,SACEC,wBAAwB,EACxBC,oBAAoB,EACpBC,kBAAkB,QACb,8BAA8B","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"index.js","names":["defineConfig","MANIFEST_FILE_LOCATION","HostMessage","isHostParametersUpdatedMessage","visitHostMessage","isWidgetEmitEventMessage","isWidgetReadyMessage","visitWidgetMessage"],"sources":["index.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 type {\n AsyncParameterValueMap,\n EventId,\n EventParameterValueMap,\n ManifestParameterDefinition,\n ParameterConfig,\n ParameterDefinition,\n ParameterValueMap,\n WidgetConfig,\n} from \"./config.js\";\nexport { defineConfig } from \"./config.js\";\nexport type {\n OntologySdkInputSpecV1 as OntologySdkInputSpec,\n WidgetManifestConfigV1 as WidgetManifestConfig,\n WidgetSetDiscoveredInputSpecV1 as WidgetSetDiscoveredInputSpec,\n WidgetSetInputSpecV1 as WidgetSetInputSpec,\n WidgetSetManifestV1 as WidgetSetManifest,\n} from \"./manifest.js\";\nexport { MANIFEST_FILE_LOCATION } from \"./manifest.js\";\nexport {\n HostMessage,\n isHostParametersUpdatedMessage,\n visitHostMessage,\n} from \"./messages/hostMessages.js\";\nexport {\n isWidgetEmitEventMessage,\n isWidgetReadyMessage,\n visitWidgetMessage,\n} from \"./messages/widgetMessages.js\";\nexport type { WidgetMessage } from \"./messages/widgetMessages.js\";\nexport type { ObjectType, ParameterValue } from \"./parameters.js\";\nexport type {\n AsyncFailedValue,\n AsyncLoadedValue,\n AsyncLoadingValue,\n AsyncNotStartedLoadingValue,\n AsyncReloadingValue,\n AsyncValue,\n} from \"./utils/asyncValue.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,SAASA,YAAY,QAAQ,aAAa;AAQ1C,SAASC,sBAAsB,QAAQ,eAAe;AACtD,SACEC,WAAW,EACXC,8BAA8B,EAC9BC,gBAAgB,QACX,4BAA4B;AACnC,SACEC,wBAAwB,EACxBC,oBAAoB,EACpBC,kBAAkB,QACb,8BAA8B","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
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\nexport
|
|
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 { ObjectTypeDefinition } from \"@osdk/api\";\nimport type { AsyncValue } from \"./utils/asyncValue.js\";\n\nexport interface ObjectType extends ObjectTypeDefinition {\n internalDoNotUseMetadata?: {\n rid: string;\n };\n}\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 ObjectSetParameterValue<T extends ObjectType> {\n type: \"objectSet\";\n value: AsyncValue<{\n objectSetRid: string;\n }>;\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 export type ObjectSet<T extends ObjectType = ObjectType> =\n ObjectSetParameterValue<T>;\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.ObjectSet\n | ParameterValue.Array;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAWA;AACA;AACA;AA8BA;AACA;AACA;AAFA,WAGiBA,cAAc","ignoreList":[]}
|
package/build/types/index.d.ts
CHANGED
|
@@ -5,5 +5,5 @@ export { MANIFEST_FILE_LOCATION } from "./manifest.js";
|
|
|
5
5
|
export { HostMessage, isHostParametersUpdatedMessage, visitHostMessage } from "./messages/hostMessages.js";
|
|
6
6
|
export { isWidgetEmitEventMessage, isWidgetReadyMessage, visitWidgetMessage } from "./messages/widgetMessages.js";
|
|
7
7
|
export type { WidgetMessage } from "./messages/widgetMessages.js";
|
|
8
|
-
export type { ParameterValue } from "./parameters.js";
|
|
8
|
+
export type { ObjectType, ParameterValue } from "./parameters.js";
|
|
9
9
|
export type { AsyncFailedValue, AsyncLoadedValue, AsyncLoadingValue, AsyncNotStartedLoadingValue, AsyncReloadingValue, AsyncValue } from "./utils/asyncValue.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cACE,wBACA,SACA,wBACA,6BACA,iBACA,qBACA,mBACA,oBACK;AACP,SAAS,oBAAoB;AAC7B,cACE,0BAA0B,sBAC1B,0BAA0B,sBAC1B,kCAAkC,8BAClC,wBAAwB,oBACxB,uBAAuB,yBAClB;AACP,SAAS,8BAA8B;AACvC,SACE,aACA,gCACA,wBACK;AACP,SACE,0BACA,sBACA,0BACK;AACP,cAAc,qBAAqB;AACnC,cAAc,sBAAsB;
|
|
1
|
+
{"mappings":"AAgBA,cACE,wBACA,SACA,wBACA,6BACA,iBACA,qBACA,mBACA,oBACK;AACP,SAAS,oBAAoB;AAC7B,cACE,0BAA0B,sBAC1B,0BAA0B,sBAC1B,kCAAkC,8BAClC,wBAAwB,oBACxB,uBAAuB,yBAClB;AACP,SAAS,8BAA8B;AACvC,SACE,aACA,gCACA,wBACK;AACP,SACE,0BACA,sBACA,0BACK;AACP,cAAc,qBAAqB;AACnC,cAAc,YAAY,sBAAsB;AAChD,cACE,kBACA,kBACA,mBACA,6BACA,qBACA,kBACK","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}
|
|
@@ -1,11 +1,10 @@
|
|
|
1
|
+
import type { ObjectTypeDefinition } from "@osdk/api";
|
|
1
2
|
import type { AsyncValue } from "./utils/asyncValue.js";
|
|
2
|
-
export
|
|
3
|
-
type: "object"
|
|
4
|
-
apiName: string
|
|
3
|
+
export interface ObjectType extends ObjectTypeDefinition {
|
|
5
4
|
internalDoNotUseMetadata?: {
|
|
6
5
|
rid: string
|
|
7
|
-
}
|
|
8
|
-
}
|
|
6
|
+
};
|
|
7
|
+
}
|
|
9
8
|
/**
|
|
10
9
|
* Map of the name of the type to the corresponding JavaScript type.
|
|
11
10
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cAAc,kBAAkB,uBAAwB;AAExD,
|
|
1
|
+
{"mappings":"AAgBA,cAAc,4BAA4B,WAAY;AACtD,cAAc,kBAAkB,uBAAwB;AAExD,iBAAiB,mBAAmB,qBAAqB;CACvD,2BAA2B;EACzB;CACD;AACF;;;;KAKI,0BAA0B;CAC7B;;CAEA;CACA;CACA;;CAEA;AACD;KACI,+BAA+B;AAEpC,iBAAiB,uBAAuB,UAAU,wBAAwB;CACxE,MAAM;CACN,OAAO,WAAW,wBAAwB;AAC3C;AAED,iBAAiB,wBAAwB,UAAU,YAAY;CAC7D,MAAM;CACN,OAAO,WAAW;EAChB;CACD;AACF;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;MACnC,UAAU,UAAU,aAAa,cAC3C,wBAAwB;MAEd,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,YACf,eAAe","names":[],"sources":["../../src/parameters.ts"],"version":3,"file":"parameters.d.ts"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osdk/widget.api",
|
|
3
|
-
"version": "3.3.0-beta.
|
|
3
|
+
"version": "3.3.0-beta.3",
|
|
4
4
|
"description": "API contract between Foundry UIs that can embed custom widgets and the custom widgets themselves",
|
|
5
5
|
"access": "public",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -28,13 +28,15 @@
|
|
|
28
28
|
"default": "./build/browser/public/*.js"
|
|
29
29
|
}
|
|
30
30
|
},
|
|
31
|
+
"dependencies": {
|
|
32
|
+
"@osdk/api": "2.6.0-beta.5"
|
|
33
|
+
},
|
|
31
34
|
"devDependencies": {
|
|
32
35
|
"ts-expect": "^1.3.0",
|
|
33
36
|
"typescript": "~5.5.4",
|
|
34
37
|
"vitest": "^3.2.4",
|
|
35
|
-
"@osdk/
|
|
36
|
-
"@osdk/monorepo.api-extractor": "~0.5.0-beta.1"
|
|
37
|
-
"@osdk/monorepo.tsconfig": "~0.5.0-beta.1"
|
|
38
|
+
"@osdk/monorepo.tsconfig": "~0.5.0-beta.1",
|
|
39
|
+
"@osdk/monorepo.api-extractor": "~0.5.0-beta.1"
|
|
38
40
|
},
|
|
39
41
|
"publishConfig": {
|
|
40
42
|
"access": "public"
|