@osdk/widget.client-react 3.3.0-beta.1 → 3.3.0-beta.10
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 +74 -0
- package/build/browser/client.js +9 -5
- package/build/browser/client.js.map +1 -1
- package/build/browser/context.js.map +1 -1
- package/build/browser/utils/extendParametersWithObjectSets.js +62 -0
- package/build/browser/utils/extendParametersWithObjectSets.js.map +1 -0
- package/build/browser/utils/extendParametersWithObjectSets.test.js +372 -0
- package/build/browser/utils/extendParametersWithObjectSets.test.js.map +1 -0
- package/build/browser/utils/initializeParameters.js.map +1 -1
- package/build/cjs/index.cjs +46 -4
- package/build/cjs/index.cjs.map +1 -1
- package/build/cjs/index.d.cts +52 -21
- package/build/esm/client.js +9 -5
- package/build/esm/client.js.map +1 -1
- package/build/esm/context.js.map +1 -1
- package/build/esm/utils/extendParametersWithObjectSets.js +62 -0
- package/build/esm/utils/extendParametersWithObjectSets.js.map +1 -0
- package/build/esm/utils/extendParametersWithObjectSets.test.js +372 -0
- package/build/esm/utils/extendParametersWithObjectSets.test.js.map +1 -0
- package/build/esm/utils/initializeParameters.js.map +1 -1
- package/build/types/client.d.ts +21 -7
- package/build/types/client.d.ts.map +1 -1
- package/build/types/context.d.ts +18 -2
- package/build/types/context.d.ts.map +1 -1
- package/build/types/utils/extendParametersWithObjectSets.d.ts +13 -0
- package/build/types/utils/extendParametersWithObjectSets.d.ts.map +1 -0
- package/build/types/utils/extendParametersWithObjectSets.test.d.ts +1 -0
- package/build/types/utils/extendParametersWithObjectSets.test.d.ts.map +1 -0
- package/build/types/utils/initializeParameters.d.ts +3 -2
- package/build/types/utils/initializeParameters.d.ts.map +1 -1
- package/package.json +6 -5
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extendParametersWithObjectSets.test.js","names":["hydrateObjectSetFromRid","defineConfig","beforeEach","describe","expect","it","vi","extendParametersWithObjectSets","mock","fn","client","cache","Map","createMockObjectType","rid","apiName","type","internalDoNotUseMetadata","createLoadedValue","value","createObjectSetParam","objectSetRid","createStringParam","createNumberParam","createMockObjectSet","name","Symbol","clearAllMocks","clear","config","id","parameters","myObjectSet","displayName","objectType","myString","events","mockObjectSet","mocked","mockReturnValue","result","toEqual","objectSet","myNumber","undefined","not","toHaveBeenCalled","mockObjectType","objectsA","objectsB","mockObjectSetA","mockObjectSetB","mockReturnValueOnce","expectHydratedParam","mockObjectSetB2","result2","get","toMatchObject","initialParameters","initialResult","failedParameters","error","Error","failedResult","has","toBe","toHaveBeenCalledTimes","toThrow","mockObjectSet1","toHaveBeenCalledWith","anything","reloadingResult","mockObjectSet2","newLoadedParameters","newLoadedResult","toHaveBeenLastCalledWith"],"sources":["extendParametersWithObjectSets.test.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Client, ObjectSet } from \"@osdk/client\";\nimport { hydrateObjectSetFromRid } from \"@osdk/client/internal\";\nimport type { AsyncParameterValueMap, ObjectType } from \"@osdk/widget.api\";\nimport { defineConfig } from \"@osdk/widget.client\";\nimport type { Mock } from \"vitest\";\nimport { beforeEach, describe, expect, it, vi } from \"vitest\";\nimport { extendParametersWithObjectSets } from \"./extendParametersWithObjectSets.js\";\n\nvi.mock(\"@osdk/client/internal\", () => ({\n hydrateObjectSetFromRid: vi.fn(),\n}));\n\ndescribe(\"extendParametersWithObjectSets\", () => {\n const client = vi.fn() as Mock<Client> & Client;\n const cache = new Map<\n string,\n { objectSetRid: string; objectSet: ObjectSet }\n >();\n\n // Test helpers\n const createMockObjectType = (rid = \"ri.object-type.123\"): ObjectType => ({\n apiName: \"MyObjectType\",\n type: \"object\",\n internalDoNotUseMetadata: { rid },\n });\n\n const createLoadedValue = <T>(value: T) => ({\n type: \"loaded\" as const,\n value,\n });\n\n const createObjectSetParam = (rid: string) => ({\n type: \"objectSet\" as const,\n value: createLoadedValue({ objectSetRid: rid }),\n });\n\n const createStringParam = (value: string) => ({\n type: \"string\" as const,\n value: createLoadedValue(value),\n });\n\n const createNumberParam = (value: number) => ({\n type: \"number\" as const,\n value: createLoadedValue(value),\n });\n\n const createMockObjectSet = (name = \"MockObjectSet\") =>\n Symbol(name) as unknown as ObjectSet;\n\n beforeEach(() => {\n vi.clearAllMocks();\n cache.clear();\n });\n\n it(\"should hydrate an object set for a valid objectSetRid\", () => {\n const config = defineConfig({\n id: \"testWidget\",\n name: \"Test Widget\",\n type: \"workshop\",\n parameters: {\n myObjectSet: {\n displayName: \"My Object Set\",\n type: \"objectSet\",\n objectType: createMockObjectType(),\n },\n myString: {\n displayName: \"My String\",\n type: \"string\",\n },\n },\n events: {},\n });\n\n const parameters: AsyncParameterValueMap<typeof config> = {\n myString: createStringParam(\"test string\"),\n myObjectSet: createObjectSetParam(\"ri.object-set.123\"),\n };\n\n const mockObjectSet = createMockObjectSet();\n vi.mocked(hydrateObjectSetFromRid).mockReturnValue(mockObjectSet);\n\n const result = extendParametersWithObjectSets(\n client,\n config,\n parameters,\n cache,\n );\n\n expect(result).toEqual({\n myString: parameters.myString,\n myObjectSet: {\n ...parameters.myObjectSet,\n value: {\n ...parameters.myObjectSet.value,\n value: {\n objectSetRid: \"ri.object-set.123\",\n objectSet: mockObjectSet,\n },\n },\n },\n });\n });\n\n it(\"should pass-through a config with no object set parameters\", () => {\n const config = defineConfig({\n id: \"testWidget\",\n name: \"Test Widget\",\n type: \"workshop\",\n parameters: {\n myNumber: {\n displayName: \"My Number\",\n type: \"number\",\n },\n myString: {\n displayName: \"My String\",\n type: \"string\",\n },\n },\n events: {},\n });\n\n const parameters: AsyncParameterValueMap<typeof config> = {\n myString: createStringParam(\"test string\"),\n myNumber: createNumberParam(123),\n };\n\n const result = extendParametersWithObjectSets(\n undefined,\n config,\n parameters,\n cache,\n );\n\n expect(result).toEqual(parameters);\n expect(hydrateObjectSetFromRid).not.toHaveBeenCalled();\n });\n\n it(\"should handle multiple object set parameters independently\", () => {\n const mockObjectType = createMockObjectType();\n const config = defineConfig({\n id: \"testWidget\",\n name: \"Test Widget\",\n type: \"workshop\",\n parameters: {\n objectsA: {\n displayName: \"Object Set A\",\n type: \"objectSet\",\n objectType: mockObjectType,\n },\n objectsB: {\n displayName: \"Object Set B\",\n type: \"objectSet\",\n objectType: mockObjectType,\n },\n },\n events: {},\n });\n\n // Setup initial parameters\n const mockObjectSetA = createMockObjectSet(\"MockObjectSetA\");\n const mockObjectSetB = createMockObjectSet(\"MockObjectSetB\");\n\n vi.mocked(hydrateObjectSetFromRid)\n .mockReturnValueOnce(mockObjectSetA)\n .mockReturnValueOnce(mockObjectSetB);\n\n let parameters: AsyncParameterValueMap<typeof config> = {\n objectsA: createObjectSetParam(\"ri.object-set.123\"),\n objectsB: createObjectSetParam(\"ri.object-set.456\"),\n };\n\n const result = extendParametersWithObjectSets(\n client,\n config,\n parameters,\n cache,\n );\n\n // Helper to create expected result with hydrated object set\n const expectHydratedParam = (rid: string, objectSet: ObjectSet) => ({\n type: \"objectSet\",\n value: createLoadedValue({\n objectSetRid: rid,\n objectSet,\n }),\n });\n\n expect(result).toEqual({\n objectsA: expectHydratedParam(\"ri.object-set.123\", mockObjectSetA),\n objectsB: expectHydratedParam(\"ri.object-set.456\", mockObjectSetB),\n });\n\n // Test parameter update\n const mockObjectSetB2 = createMockObjectSet(\"MockObjectSetB2\");\n vi.mocked(hydrateObjectSetFromRid).mockReturnValueOnce(mockObjectSetB2);\n\n parameters = {\n ...parameters,\n objectsB: createObjectSetParam(\"ri.object-set.789\"),\n };\n\n const result2 = extendParametersWithObjectSets(\n client,\n config,\n parameters,\n cache,\n );\n\n expect(result2).toEqual({\n objectsA: expectHydratedParam(\"ri.object-set.123\", mockObjectSetA),\n objectsB: expectHydratedParam(\"ri.object-set.789\", mockObjectSetB2),\n });\n\n // Verify cache updated correctly\n expect(cache.get(\"objectsB\")).toMatchObject({\n objectSetRid: \"ri.object-set.789\",\n objectSet: mockObjectSetB2,\n });\n });\n\n it(\"should clear cache and provide no object set when parameter transitions to failed state\", () => {\n const config = defineConfig({\n id: \"testWidget\",\n name: \"Test Widget\",\n type: \"workshop\",\n parameters: {\n myObjectSet: {\n displayName: \"My Object Set\",\n type: \"objectSet\",\n objectType: createMockObjectType(),\n },\n myString: {\n displayName: \"My String\",\n type: \"string\",\n },\n },\n events: {},\n });\n\n // Initially load an object set successfully\n const mockObjectSet = createMockObjectSet();\n vi.mocked(hydrateObjectSetFromRid).mockReturnValue(mockObjectSet);\n\n const initialParameters: AsyncParameterValueMap<typeof config> = {\n myString: createStringParam(\"test string\"),\n myObjectSet: createObjectSetParam(\"ri.object-set.123\"),\n };\n\n const initialResult = extendParametersWithObjectSets(\n client,\n config,\n initialParameters,\n cache,\n );\n\n // Verify initial state - object set is loaded and cached\n expect(initialResult.myObjectSet.value.value).toMatchObject({\n objectSetRid: \"ri.object-set.123\",\n objectSet: mockObjectSet,\n });\n expect(cache.get(\"myObjectSet\")).toMatchObject({\n objectSetRid: \"ri.object-set.123\",\n objectSet: mockObjectSet,\n });\n\n // Transition to failed state and omit value\n const failedParameters: AsyncParameterValueMap<typeof config> = {\n myString: createStringParam(\"test string\"),\n myObjectSet: {\n type: \"objectSet\",\n value: {\n type: \"failed\",\n error: new Error(\"Failed to load object set\"),\n value: undefined,\n },\n },\n };\n\n const failedResult = extendParametersWithObjectSets(\n client,\n config,\n failedParameters,\n cache,\n );\n\n // Verify failed state - no object set in result and cache is cleared\n expect(failedResult).toEqual(failedParameters);\n expect(cache.has(\"myObjectSet\")).toBe(false);\n\n // Verify hydrateObjectSetFromRid was not called again for the failed state\n expect(hydrateObjectSetFromRid).toHaveBeenCalledTimes(1);\n });\n\n it(\"should throw an error when osdkClient is undefined but object set parameters used\", () => {\n const config = defineConfig({\n id: \"testWidget\",\n name: \"Test Widget\",\n type: \"workshop\",\n parameters: {\n myObjectSet: {\n displayName: \"My Object Set\",\n type: \"objectSet\",\n objectType: createMockObjectType(),\n },\n },\n events: {},\n });\n\n const parameters: AsyncParameterValueMap<typeof config> = {\n myObjectSet: createObjectSetParam(\"ri.object-set.123\"),\n };\n\n expect(() =>\n extendParametersWithObjectSets(\n undefined,\n config,\n parameters,\n cache,\n )\n ).toThrow(\"Not provided an OSDK client\");\n });\n\n it(\"should pass through loading state without hydration\", () => {\n const config = defineConfig({\n id: \"testWidget\",\n name: \"Test Widget\",\n type: \"workshop\",\n parameters: {\n myObjectSet: {\n displayName: \"My Object Set\",\n type: \"objectSet\",\n objectType: createMockObjectType(),\n },\n },\n events: {},\n });\n\n const parameters: AsyncParameterValueMap<typeof config> = {\n myObjectSet: {\n type: \"objectSet\",\n value: {\n type: \"loading\",\n value: undefined,\n },\n },\n };\n\n const result = extendParametersWithObjectSets(\n client,\n config,\n parameters,\n cache,\n );\n\n expect(result).toEqual(parameters);\n expect(hydrateObjectSetFromRid).not.toHaveBeenCalled();\n });\n\n it(\"should handle transition from loaded to reloading to loaded with new rid\", () => {\n const config = defineConfig({\n id: \"testWidget\",\n name: \"Test Widget\",\n type: \"workshop\",\n parameters: {\n myObjectSet: {\n displayName: \"My Object Set\",\n type: \"objectSet\",\n objectType: createMockObjectType(),\n },\n },\n events: {},\n });\n\n // Step 1: Initial loaded state\n const mockObjectSet1 = createMockObjectSet(\"InitialObjectSet\");\n vi.mocked(hydrateObjectSetFromRid).mockReturnValue(mockObjectSet1);\n\n const initialParameters: AsyncParameterValueMap<typeof config> = {\n myObjectSet: createObjectSetParam(\"ri.object-set.123\"),\n };\n\n const initialResult = extendParametersWithObjectSets(\n client,\n config,\n initialParameters,\n cache,\n );\n\n // Verify initial state\n expect(initialResult.myObjectSet.value.value).toMatchObject({\n objectSetRid: \"ri.object-set.123\",\n objectSet: mockObjectSet1,\n });\n expect(cache.get(\"myObjectSet\")).toMatchObject({\n objectSetRid: \"ri.object-set.123\",\n objectSet: mockObjectSet1,\n });\n expect(hydrateObjectSetFromRid).toHaveBeenCalledTimes(1);\n expect(hydrateObjectSetFromRid).toHaveBeenCalledWith(\n client,\n expect.anything(),\n \"ri.object-set.123\",\n );\n\n // Step 2: Transition to reloading state (value persists during reload)\n const reloadingParameters: AsyncParameterValueMap<typeof config> = {\n myObjectSet: {\n type: \"objectSet\",\n value: {\n type: \"reloading\",\n value: {\n objectSetRid: \"ri.object-set.123\",\n },\n },\n },\n };\n\n const reloadingResult = extendParametersWithObjectSets(\n client,\n config,\n reloadingParameters,\n cache,\n );\n\n // During reloading, the cached objectSet should be reused (no new hydration)\n expect(reloadingResult.myObjectSet.value.value).toMatchObject({\n objectSetRid: \"ri.object-set.123\",\n objectSet: mockObjectSet1, // Same object set from cache\n });\n expect(cache.get(\"myObjectSet\")).toMatchObject({\n objectSetRid: \"ri.object-set.123\",\n objectSet: mockObjectSet1,\n });\n expect(hydrateObjectSetFromRid).toHaveBeenCalledTimes(1); // Still only 1 call\n\n // Step 3: Transition back to loaded with new rid\n const mockObjectSet2 = createMockObjectSet(\"UpdatedObjectSet\");\n vi.mocked(hydrateObjectSetFromRid).mockReturnValue(mockObjectSet2);\n\n const newLoadedParameters: AsyncParameterValueMap<typeof config> = {\n myObjectSet: createObjectSetParam(\"ri.object-set.456\"),\n };\n\n const newLoadedResult = extendParametersWithObjectSets(\n client,\n config,\n newLoadedParameters,\n cache,\n );\n\n // Verify new state - new object set hydrated and cache updated\n expect(newLoadedResult.myObjectSet.value.value).toMatchObject({\n objectSetRid: \"ri.object-set.456\",\n objectSet: mockObjectSet2,\n });\n expect(cache.get(\"myObjectSet\")).toMatchObject({\n objectSetRid: \"ri.object-set.456\",\n objectSet: mockObjectSet2,\n });\n expect(hydrateObjectSetFromRid).toHaveBeenCalledTimes(2);\n expect(hydrateObjectSetFromRid).toHaveBeenLastCalledWith(\n client,\n expect.anything(),\n \"ri.object-set.456\",\n );\n });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,uBAAuB,QAAQ,uBAAuB;AAE/D,SAASC,YAAY,QAAQ,qBAAqB;AAElD,SAASC,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,QAAQ;AAC7D,SAASC,8BAA8B,QAAQ,qCAAqC;AAEpFD,EAAE,CAACE,IAAI,CAAC,uBAAuB,EAAE,OAAO;EACtCR,uBAAuB,EAAEM,EAAE,CAACG,EAAE,CAAC;AACjC,CAAC,CAAC,CAAC;AAEHN,QAAQ,CAAC,gCAAgC,EAAE,MAAM;EAC/C,MAAMO,MAAM,GAAGJ,EAAE,CAACG,EAAE,CAAC,CAA0B;EAC/C,MAAME,KAAK,GAAG,IAAIC,GAAG,CAGnB,CAAC;;EAEH;EACA,MAAMC,oBAAoB,GAAGA,CAACC,GAAG,GAAG,oBAAoB,MAAkB;IACxEC,OAAO,EAAE,cAAc;IACvBC,IAAI,EAAE,QAAQ;IACdC,wBAAwB,EAAE;MAAEH;IAAI;EAClC,CAAC,CAAC;EAEF,MAAMI,iBAAiB,GAAOC,KAAQ,KAAM;IAC1CH,IAAI,EAAE,QAAiB;IACvBG;EACF,CAAC,CAAC;EAEF,MAAMC,oBAAoB,GAAIN,GAAW,KAAM;IAC7CE,IAAI,EAAE,WAAoB;IAC1BG,KAAK,EAAED,iBAAiB,CAAC;MAAEG,YAAY,EAAEP;IAAI,CAAC;EAChD,CAAC,CAAC;EAEF,MAAMQ,iBAAiB,GAAIH,KAAa,KAAM;IAC5CH,IAAI,EAAE,QAAiB;IACvBG,KAAK,EAAED,iBAAiB,CAACC,KAAK;EAChC,CAAC,CAAC;EAEF,MAAMI,iBAAiB,GAAIJ,KAAa,KAAM;IAC5CH,IAAI,EAAE,QAAiB;IACvBG,KAAK,EAAED,iBAAiB,CAACC,KAAK;EAChC,CAAC,CAAC;EAEF,MAAMK,mBAAmB,GAAGA,CAACC,IAAI,GAAG,eAAe,KACjDC,MAAM,CAACD,IAAI,CAAyB;EAEtCvB,UAAU,CAAC,MAAM;IACfI,EAAE,CAACqB,aAAa,CAAC,CAAC;IAClBhB,KAAK,CAACiB,KAAK,CAAC,CAAC;EACf,CAAC,CAAC;EAEFvB,EAAE,CAAC,uDAAuD,EAAE,MAAM;IAChE,MAAMwB,MAAM,GAAG5B,YAAY,CAAC;MAC1B6B,EAAE,EAAE,YAAY;MAChBL,IAAI,EAAE,aAAa;MACnBT,IAAI,EAAE,UAAU;MAChBe,UAAU,EAAE;QACVC,WAAW,EAAE;UACXC,WAAW,EAAE,eAAe;UAC5BjB,IAAI,EAAE,WAAW;UACjBkB,UAAU,EAAErB,oBAAoB,CAAC;QACnC,CAAC;QACDsB,QAAQ,EAAE;UACRF,WAAW,EAAE,WAAW;UACxBjB,IAAI,EAAE;QACR;MACF,CAAC;MACDoB,MAAM,EAAE,CAAC;IACX,CAAC,CAAC;IAEF,MAAML,UAAiD,GAAG;MACxDI,QAAQ,EAAEb,iBAAiB,CAAC,aAAa,CAAC;MAC1CU,WAAW,EAAEZ,oBAAoB,CAAC,mBAAmB;IACvD,CAAC;IAED,MAAMiB,aAAa,GAAGb,mBAAmB,CAAC,CAAC;IAC3ClB,EAAE,CAACgC,MAAM,CAACtC,uBAAuB,CAAC,CAACuC,eAAe,CAACF,aAAa,CAAC;IAEjE,MAAMG,MAAM,GAAGjC,8BAA8B,CAC3CG,MAAM,EACNmB,MAAM,EACNE,UAAU,EACVpB,KACF,CAAC;IAEDP,MAAM,CAACoC,MAAM,CAAC,CAACC,OAAO,CAAC;MACrBN,QAAQ,EAAEJ,UAAU,CAACI,QAAQ;MAC7BH,WAAW,EAAE;QACX,GAAGD,UAAU,CAACC,WAAW;QACzBb,KAAK,EAAE;UACL,GAAGY,UAAU,CAACC,WAAW,CAACb,KAAK;UAC/BA,KAAK,EAAE;YACLE,YAAY,EAAE,mBAAmB;YACjCqB,SAAS,EAAEL;UACb;QACF;MACF;IACF,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFhC,EAAE,CAAC,4DAA4D,EAAE,MAAM;IACrE,MAAMwB,MAAM,GAAG5B,YAAY,CAAC;MAC1B6B,EAAE,EAAE,YAAY;MAChBL,IAAI,EAAE,aAAa;MACnBT,IAAI,EAAE,UAAU;MAChBe,UAAU,EAAE;QACVY,QAAQ,EAAE;UACRV,WAAW,EAAE,WAAW;UACxBjB,IAAI,EAAE;QACR,CAAC;QACDmB,QAAQ,EAAE;UACRF,WAAW,EAAE,WAAW;UACxBjB,IAAI,EAAE;QACR;MACF,CAAC;MACDoB,MAAM,EAAE,CAAC;IACX,CAAC,CAAC;IAEF,MAAML,UAAiD,GAAG;MACxDI,QAAQ,EAAEb,iBAAiB,CAAC,aAAa,CAAC;MAC1CqB,QAAQ,EAAEpB,iBAAiB,CAAC,GAAG;IACjC,CAAC;IAED,MAAMiB,MAAM,GAAGjC,8BAA8B,CAC3CqC,SAAS,EACTf,MAAM,EACNE,UAAU,EACVpB,KACF,CAAC;IAEDP,MAAM,CAACoC,MAAM,CAAC,CAACC,OAAO,CAACV,UAAU,CAAC;IAClC3B,MAAM,CAACJ,uBAAuB,CAAC,CAAC6C,GAAG,CAACC,gBAAgB,CAAC,CAAC;EACxD,CAAC,CAAC;EAEFzC,EAAE,CAAC,4DAA4D,EAAE,MAAM;IACrE,MAAM0C,cAAc,GAAGlC,oBAAoB,CAAC,CAAC;IAC7C,MAAMgB,MAAM,GAAG5B,YAAY,CAAC;MAC1B6B,EAAE,EAAE,YAAY;MAChBL,IAAI,EAAE,aAAa;MACnBT,IAAI,EAAE,UAAU;MAChBe,UAAU,EAAE;QACViB,QAAQ,EAAE;UACRf,WAAW,EAAE,cAAc;UAC3BjB,IAAI,EAAE,WAAW;UACjBkB,UAAU,EAAEa;QACd,CAAC;QACDE,QAAQ,EAAE;UACRhB,WAAW,EAAE,cAAc;UAC3BjB,IAAI,EAAE,WAAW;UACjBkB,UAAU,EAAEa;QACd;MACF,CAAC;MACDX,MAAM,EAAE,CAAC;IACX,CAAC,CAAC;;IAEF;IACA,MAAMc,cAAc,GAAG1B,mBAAmB,CAAC,gBAAgB,CAAC;IAC5D,MAAM2B,cAAc,GAAG3B,mBAAmB,CAAC,gBAAgB,CAAC;IAE5DlB,EAAE,CAACgC,MAAM,CAACtC,uBAAuB,CAAC,CAC/BoD,mBAAmB,CAACF,cAAc,CAAC,CACnCE,mBAAmB,CAACD,cAAc,CAAC;IAEtC,IAAIpB,UAAiD,GAAG;MACtDiB,QAAQ,EAAE5B,oBAAoB,CAAC,mBAAmB,CAAC;MACnD6B,QAAQ,EAAE7B,oBAAoB,CAAC,mBAAmB;IACpD,CAAC;IAED,MAAMoB,MAAM,GAAGjC,8BAA8B,CAC3CG,MAAM,EACNmB,MAAM,EACNE,UAAU,EACVpB,KACF,CAAC;;IAED;IACA,MAAM0C,mBAAmB,GAAGA,CAACvC,GAAW,EAAE4B,SAAoB,MAAM;MAClE1B,IAAI,EAAE,WAAW;MACjBG,KAAK,EAAED,iBAAiB,CAAC;QACvBG,YAAY,EAAEP,GAAG;QACjB4B;MACF,CAAC;IACH,CAAC,CAAC;IAEFtC,MAAM,CAACoC,MAAM,CAAC,CAACC,OAAO,CAAC;MACrBO,QAAQ,EAAEK,mBAAmB,CAAC,mBAAmB,EAAEH,cAAc,CAAC;MAClED,QAAQ,EAAEI,mBAAmB,CAAC,mBAAmB,EAAEF,cAAc;IACnE,CAAC,CAAC;;IAEF;IACA,MAAMG,eAAe,GAAG9B,mBAAmB,CAAC,iBAAiB,CAAC;IAC9DlB,EAAE,CAACgC,MAAM,CAACtC,uBAAuB,CAAC,CAACoD,mBAAmB,CAACE,eAAe,CAAC;IAEvEvB,UAAU,GAAG;MACX,GAAGA,UAAU;MACbkB,QAAQ,EAAE7B,oBAAoB,CAAC,mBAAmB;IACpD,CAAC;IAED,MAAMmC,OAAO,GAAGhD,8BAA8B,CAC5CG,MAAM,EACNmB,MAAM,EACNE,UAAU,EACVpB,KACF,CAAC;IAEDP,MAAM,CAACmD,OAAO,CAAC,CAACd,OAAO,CAAC;MACtBO,QAAQ,EAAEK,mBAAmB,CAAC,mBAAmB,EAAEH,cAAc,CAAC;MAClED,QAAQ,EAAEI,mBAAmB,CAAC,mBAAmB,EAAEC,eAAe;IACpE,CAAC,CAAC;;IAEF;IACAlD,MAAM,CAACO,KAAK,CAAC6C,GAAG,CAAC,UAAU,CAAC,CAAC,CAACC,aAAa,CAAC;MAC1CpC,YAAY,EAAE,mBAAmB;MACjCqB,SAAS,EAAEY;IACb,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFjD,EAAE,CAAC,yFAAyF,EAAE,MAAM;IAClG,MAAMwB,MAAM,GAAG5B,YAAY,CAAC;MAC1B6B,EAAE,EAAE,YAAY;MAChBL,IAAI,EAAE,aAAa;MACnBT,IAAI,EAAE,UAAU;MAChBe,UAAU,EAAE;QACVC,WAAW,EAAE;UACXC,WAAW,EAAE,eAAe;UAC5BjB,IAAI,EAAE,WAAW;UACjBkB,UAAU,EAAErB,oBAAoB,CAAC;QACnC,CAAC;QACDsB,QAAQ,EAAE;UACRF,WAAW,EAAE,WAAW;UACxBjB,IAAI,EAAE;QACR;MACF,CAAC;MACDoB,MAAM,EAAE,CAAC;IACX,CAAC,CAAC;;IAEF;IACA,MAAMC,aAAa,GAAGb,mBAAmB,CAAC,CAAC;IAC3ClB,EAAE,CAACgC,MAAM,CAACtC,uBAAuB,CAAC,CAACuC,eAAe,CAACF,aAAa,CAAC;IAEjE,MAAMqB,iBAAwD,GAAG;MAC/DvB,QAAQ,EAAEb,iBAAiB,CAAC,aAAa,CAAC;MAC1CU,WAAW,EAAEZ,oBAAoB,CAAC,mBAAmB;IACvD,CAAC;IAED,MAAMuC,aAAa,GAAGpD,8BAA8B,CAClDG,MAAM,EACNmB,MAAM,EACN6B,iBAAiB,EACjB/C,KACF,CAAC;;IAED;IACAP,MAAM,CAACuD,aAAa,CAAC3B,WAAW,CAACb,KAAK,CAACA,KAAK,CAAC,CAACsC,aAAa,CAAC;MAC1DpC,YAAY,EAAE,mBAAmB;MACjCqB,SAAS,EAAEL;IACb,CAAC,CAAC;IACFjC,MAAM,CAACO,KAAK,CAAC6C,GAAG,CAAC,aAAa,CAAC,CAAC,CAACC,aAAa,CAAC;MAC7CpC,YAAY,EAAE,mBAAmB;MACjCqB,SAAS,EAAEL;IACb,CAAC,CAAC;;IAEF;IACA,MAAMuB,gBAAuD,GAAG;MAC9DzB,QAAQ,EAAEb,iBAAiB,CAAC,aAAa,CAAC;MAC1CU,WAAW,EAAE;QACXhB,IAAI,EAAE,WAAW;QACjBG,KAAK,EAAE;UACLH,IAAI,EAAE,QAAQ;UACd6C,KAAK,EAAE,IAAIC,KAAK,CAAC,2BAA2B,CAAC;UAC7C3C,KAAK,EAAEyB;QACT;MACF;IACF,CAAC;IAED,MAAMmB,YAAY,GAAGxD,8BAA8B,CACjDG,MAAM,EACNmB,MAAM,EACN+B,gBAAgB,EAChBjD,KACF,CAAC;;IAED;IACAP,MAAM,CAAC2D,YAAY,CAAC,CAACtB,OAAO,CAACmB,gBAAgB,CAAC;IAC9CxD,MAAM,CAACO,KAAK,CAACqD,GAAG,CAAC,aAAa,CAAC,CAAC,CAACC,IAAI,CAAC,KAAK,CAAC;;IAE5C;IACA7D,MAAM,CAACJ,uBAAuB,CAAC,CAACkE,qBAAqB,CAAC,CAAC,CAAC;EAC1D,CAAC,CAAC;EAEF7D,EAAE,CAAC,mFAAmF,EAAE,MAAM;IAC5F,MAAMwB,MAAM,GAAG5B,YAAY,CAAC;MAC1B6B,EAAE,EAAE,YAAY;MAChBL,IAAI,EAAE,aAAa;MACnBT,IAAI,EAAE,UAAU;MAChBe,UAAU,EAAE;QACVC,WAAW,EAAE;UACXC,WAAW,EAAE,eAAe;UAC5BjB,IAAI,EAAE,WAAW;UACjBkB,UAAU,EAAErB,oBAAoB,CAAC;QACnC;MACF,CAAC;MACDuB,MAAM,EAAE,CAAC;IACX,CAAC,CAAC;IAEF,MAAML,UAAiD,GAAG;MACxDC,WAAW,EAAEZ,oBAAoB,CAAC,mBAAmB;IACvD,CAAC;IAEDhB,MAAM,CAAC,MACLG,8BAA8B,CAC5BqC,SAAS,EACTf,MAAM,EACNE,UAAU,EACVpB,KACF,CACF,CAAC,CAACwD,OAAO,CAAC,6BAA6B,CAAC;EAC1C,CAAC,CAAC;EAEF9D,EAAE,CAAC,qDAAqD,EAAE,MAAM;IAC9D,MAAMwB,MAAM,GAAG5B,YAAY,CAAC;MAC1B6B,EAAE,EAAE,YAAY;MAChBL,IAAI,EAAE,aAAa;MACnBT,IAAI,EAAE,UAAU;MAChBe,UAAU,EAAE;QACVC,WAAW,EAAE;UACXC,WAAW,EAAE,eAAe;UAC5BjB,IAAI,EAAE,WAAW;UACjBkB,UAAU,EAAErB,oBAAoB,CAAC;QACnC;MACF,CAAC;MACDuB,MAAM,EAAE,CAAC;IACX,CAAC,CAAC;IAEF,MAAML,UAAiD,GAAG;MACxDC,WAAW,EAAE;QACXhB,IAAI,EAAE,WAAW;QACjBG,KAAK,EAAE;UACLH,IAAI,EAAE,SAAS;UACfG,KAAK,EAAEyB;QACT;MACF;IACF,CAAC;IAED,MAAMJ,MAAM,GAAGjC,8BAA8B,CAC3CG,MAAM,EACNmB,MAAM,EACNE,UAAU,EACVpB,KACF,CAAC;IAEDP,MAAM,CAACoC,MAAM,CAAC,CAACC,OAAO,CAACV,UAAU,CAAC;IAClC3B,MAAM,CAACJ,uBAAuB,CAAC,CAAC6C,GAAG,CAACC,gBAAgB,CAAC,CAAC;EACxD,CAAC,CAAC;EAEFzC,EAAE,CAAC,0EAA0E,EAAE,MAAM;IACnF,MAAMwB,MAAM,GAAG5B,YAAY,CAAC;MAC1B6B,EAAE,EAAE,YAAY;MAChBL,IAAI,EAAE,aAAa;MACnBT,IAAI,EAAE,UAAU;MAChBe,UAAU,EAAE;QACVC,WAAW,EAAE;UACXC,WAAW,EAAE,eAAe;UAC5BjB,IAAI,EAAE,WAAW;UACjBkB,UAAU,EAAErB,oBAAoB,CAAC;QACnC;MACF,CAAC;MACDuB,MAAM,EAAE,CAAC;IACX,CAAC,CAAC;;IAEF;IACA,MAAMgC,cAAc,GAAG5C,mBAAmB,CAAC,kBAAkB,CAAC;IAC9DlB,EAAE,CAACgC,MAAM,CAACtC,uBAAuB,CAAC,CAACuC,eAAe,CAAC6B,cAAc,CAAC;IAElE,MAAMV,iBAAwD,GAAG;MAC/D1B,WAAW,EAAEZ,oBAAoB,CAAC,mBAAmB;IACvD,CAAC;IAED,MAAMuC,aAAa,GAAGpD,8BAA8B,CAClDG,MAAM,EACNmB,MAAM,EACN6B,iBAAiB,EACjB/C,KACF,CAAC;;IAED;IACAP,MAAM,CAACuD,aAAa,CAAC3B,WAAW,CAACb,KAAK,CAACA,KAAK,CAAC,CAACsC,aAAa,CAAC;MAC1DpC,YAAY,EAAE,mBAAmB;MACjCqB,SAAS,EAAE0B;IACb,CAAC,CAAC;IACFhE,MAAM,CAACO,KAAK,CAAC6C,GAAG,CAAC,aAAa,CAAC,CAAC,CAACC,aAAa,CAAC;MAC7CpC,YAAY,EAAE,mBAAmB;MACjCqB,SAAS,EAAE0B;IACb,CAAC,CAAC;IACFhE,MAAM,CAACJ,uBAAuB,CAAC,CAACkE,qBAAqB,CAAC,CAAC,CAAC;IACxD9D,MAAM,CAACJ,uBAAuB,CAAC,CAACqE,oBAAoB,CAClD3D,MAAM,EACNN,MAAM,CAACkE,QAAQ,CAAC,CAAC,EACjB,mBACF,CAAC;;IAED;;IAaA,MAAMC,eAAe,GAAGhE,8BAA8B,CACpDG,MAAM,EACNmB,MAAM,EAd2D;MACjEG,WAAW,EAAE;QACXhB,IAAI,EAAE,WAAW;QACjBG,KAAK,EAAE;UACLH,IAAI,EAAE,WAAW;UACjBG,KAAK,EAAE;YACLE,YAAY,EAAE;UAChB;QACF;MACF;IACF,CAAC,EAMCV,KACF,CAAC;;IAED;IACAP,MAAM,CAACmE,eAAe,CAACvC,WAAW,CAACb,KAAK,CAACA,KAAK,CAAC,CAACsC,aAAa,CAAC;MAC5DpC,YAAY,EAAE,mBAAmB;MACjCqB,SAAS,EAAE0B,cAAc,CAAE;IAC7B,CAAC,CAAC;IACFhE,MAAM,CAACO,KAAK,CAAC6C,GAAG,CAAC,aAAa,CAAC,CAAC,CAACC,aAAa,CAAC;MAC7CpC,YAAY,EAAE,mBAAmB;MACjCqB,SAAS,EAAE0B;IACb,CAAC,CAAC;IACFhE,MAAM,CAACJ,uBAAuB,CAAC,CAACkE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;;IAE1D;IACA,MAAMM,cAAc,GAAGhD,mBAAmB,CAAC,kBAAkB,CAAC;IAC9DlB,EAAE,CAACgC,MAAM,CAACtC,uBAAuB,CAAC,CAACuC,eAAe,CAACiC,cAAc,CAAC;IAElE,MAAMC,mBAA0D,GAAG;MACjEzC,WAAW,EAAEZ,oBAAoB,CAAC,mBAAmB;IACvD,CAAC;IAED,MAAMsD,eAAe,GAAGnE,8BAA8B,CACpDG,MAAM,EACNmB,MAAM,EACN4C,mBAAmB,EACnB9D,KACF,CAAC;;IAED;IACAP,MAAM,CAACsE,eAAe,CAAC1C,WAAW,CAACb,KAAK,CAACA,KAAK,CAAC,CAACsC,aAAa,CAAC;MAC5DpC,YAAY,EAAE,mBAAmB;MACjCqB,SAAS,EAAE8B;IACb,CAAC,CAAC;IACFpE,MAAM,CAACO,KAAK,CAAC6C,GAAG,CAAC,aAAa,CAAC,CAAC,CAACC,aAAa,CAAC;MAC7CpC,YAAY,EAAE,mBAAmB;MACjCqB,SAAS,EAAE8B;IACb,CAAC,CAAC;IACFpE,MAAM,CAACJ,uBAAuB,CAAC,CAACkE,qBAAqB,CAAC,CAAC,CAAC;IACxD9D,MAAM,CAACJ,uBAAuB,CAAC,CAAC2E,wBAAwB,CACtDjE,MAAM,EACNN,MAAM,CAACkE,QAAQ,CAAC,CAAC,EACjB,mBACF,CAAC;EACH,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"initializeParameters.js","names":["initializeParameters","config","initialLoadingState","Object","fromEntries","entries","parameters","map","key","parameterConfig","type","value"],"sources":["initializeParameters.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 {
|
|
1
|
+
{"version":3,"file":"initializeParameters.js","names":["initializeParameters","config","initialLoadingState","Object","fromEntries","entries","parameters","map","key","parameterConfig","type","value"],"sources":["initializeParameters.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 { WidgetConfig } from \"@osdk/widget.client\";\nimport type { ExtendedAsyncParameterValueMap } from \"../context.js\";\n\n/**\n * Utility function to initialize a map of parameter values to either a loading or not-started loading state\n */\nexport function initializeParameters<C extends WidgetConfig<C[\"parameters\"]>>(\n config: C,\n initialLoadingState: \"loading\" | \"not-started\",\n): ExtendedAsyncParameterValueMap<C> {\n return Object.fromEntries(\n Object.entries(config.parameters).map(([key, parameterConfig]) => [\n key,\n { type: parameterConfig.type, value: { type: initialLoadingState } },\n ]),\n ) as ExtendedAsyncParameterValueMap<C>;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA,OAAO,SAASA,oBAAoBA,CAClCC,MAAS,EACTC,mBAA8C,EACX;EACnC,OAAOC,MAAM,CAACC,WAAW,CACvBD,MAAM,CAACE,OAAO,CAACJ,MAAM,CAACK,UAAU,CAAC,CAACC,GAAG,CAAC,CAAC,CAACC,GAAG,EAAEC,eAAe,CAAC,KAAK,CAChED,GAAG,EACH;IAAEE,IAAI,EAAED,eAAe,CAACC,IAAI;IAAEC,KAAK,EAAE;MAAED,IAAI,EAAER;IAAoB;EAAE,CAAC,CACrE,CACH,CAAC;AACH","ignoreList":[]}
|
package/build/cjs/index.cjs
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
var widget_client = require('@osdk/widget.client');
|
|
4
4
|
var React2 = require('react');
|
|
5
|
+
var internal = require('@osdk/client/internal');
|
|
5
6
|
|
|
6
7
|
function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
|
|
7
8
|
|
|
@@ -29,6 +30,44 @@ function useFoundryWidgetContext() {
|
|
|
29
30
|
}
|
|
30
31
|
_useFoundryWidgetContext.withTypes = withTypes;
|
|
31
32
|
})(useFoundryWidgetContext || (useFoundryWidgetContext = {}));
|
|
33
|
+
function extendParametersWithObjectSets(osdkClient, config, parameters, cache) {
|
|
34
|
+
const extendedParameters = {
|
|
35
|
+
...parameters
|
|
36
|
+
};
|
|
37
|
+
for (const parameterId of Object.keys(extendedParameters)) {
|
|
38
|
+
const param = config.parameters[parameterId];
|
|
39
|
+
if (param.type === "objectSet" && extendedParameters[parameterId].type === "objectSet") {
|
|
40
|
+
const parameterValue = extendedParameters[parameterId].value.value;
|
|
41
|
+
if (parameterValue != null) {
|
|
42
|
+
if (typeof parameterValue === "object" && "objectSetRid" in parameterValue && typeof parameterValue.objectSetRid === "string") {
|
|
43
|
+
const objectSetRid = parameterValue.objectSetRid;
|
|
44
|
+
const objectSet = getOrHydrateObjectSet(osdkClient, cache, parameterId, objectSetRid, param.objectType);
|
|
45
|
+
parameterValue.objectSet = objectSet;
|
|
46
|
+
} else {
|
|
47
|
+
throw new Error(`Invalid object set parameter value for parameter "${parameterId}"`);
|
|
48
|
+
}
|
|
49
|
+
} else {
|
|
50
|
+
cache.delete(parameterId);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
return extendedParameters;
|
|
55
|
+
}
|
|
56
|
+
function getOrHydrateObjectSet(osdkClient, cache, paramKey, objectSetRid, definition) {
|
|
57
|
+
if (osdkClient == null) {
|
|
58
|
+
throw new Error("Not provided an OSDK client");
|
|
59
|
+
}
|
|
60
|
+
const cached = cache.get(paramKey);
|
|
61
|
+
if (cached?.objectSetRid === objectSetRid) {
|
|
62
|
+
return cached.objectSet;
|
|
63
|
+
}
|
|
64
|
+
const objectSet = internal.hydrateObjectSetFromRid(osdkClient, definition, objectSetRid);
|
|
65
|
+
cache.set(paramKey, {
|
|
66
|
+
objectSetRid,
|
|
67
|
+
objectSet
|
|
68
|
+
});
|
|
69
|
+
return objectSet;
|
|
70
|
+
}
|
|
32
71
|
|
|
33
72
|
// src/utils/initializeParameters.ts
|
|
34
73
|
function initializeParameters(config, initialLoadingState) {
|
|
@@ -44,26 +83,29 @@ function initializeParameters(config, initialLoadingState) {
|
|
|
44
83
|
var FoundryWidget = ({
|
|
45
84
|
children,
|
|
46
85
|
config,
|
|
47
|
-
initialValues
|
|
86
|
+
initialValues,
|
|
87
|
+
client: osdkClient
|
|
48
88
|
}) => {
|
|
49
89
|
const client = React2.useMemo(() => widget_client.createFoundryWidgetClient(), []);
|
|
50
90
|
const [asyncParameterValues, setAsyncParameterValues] = React2__default.default.useState(initialValues ?? initializeParameters(config, "not-started"));
|
|
51
91
|
const [allParameterValues, setAllParameterValues] = React2__default.default.useState({
|
|
52
92
|
type: "not-started"
|
|
53
93
|
});
|
|
94
|
+
const objectSetCache = React2.useRef(/* @__PURE__ */ new Map());
|
|
54
95
|
React2.useEffect(() => {
|
|
55
96
|
client.subscribe();
|
|
56
97
|
client.hostEventTarget.addEventListener("host.update-parameters", (payload) => {
|
|
98
|
+
const processedParameters = extendParametersWithObjectSets(osdkClient, config, payload.detail.parameters, objectSetCache.current);
|
|
57
99
|
setAsyncParameterValues((currentParameters) => ({
|
|
58
100
|
...currentParameters,
|
|
59
|
-
...
|
|
101
|
+
...processedParameters
|
|
60
102
|
}));
|
|
61
103
|
setAllParameterValues((currentParameters) => {
|
|
62
104
|
let aggregatedLoadedState = "loaded";
|
|
63
105
|
let firstError;
|
|
64
106
|
const newParameterValues = {};
|
|
65
|
-
for (const key in
|
|
66
|
-
const value =
|
|
107
|
+
for (const key in processedParameters) {
|
|
108
|
+
const value = processedParameters[key].value;
|
|
67
109
|
if (value.type === "failed") {
|
|
68
110
|
aggregatedLoadedState = "failed";
|
|
69
111
|
firstError = firstError ?? value.error;
|
package/build/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/context.ts","../../src/utils/initializeParameters.ts","../../src/client.tsx"],"names":["FoundryHostEventTarget","useContext","useMemo","createFoundryWidgetClient","React","useEffect"],"mappings":";;;;;;;;;;AAkBO,IAAM,oBAAA,2CAA0C,aAAc,CAAA;AAAA,EACnE,WAAW,MAAM;AAAA,GAAC;AAAA,EAClB,eAAA,EAAiB,IAAIA,oCAAuB,EAAA;AAAA,EAC5C,sBAAsB,EAAC;AAAA,EACvB,UAAY,EAAA;AAAA,IACV,KAAO,EAAA,aAAA;AAAA,IACP,QAAQ;AAAC;AAEb,CAAC,CAAA;AAKM,SAAS,uBAA0B,GAAA;AACxC,EAAA,OAAOC,kBAAW,oBAAoB,CAAA;AACxC;AAAA,CACC,SAAU,wBAA0B,EAAA;AACnC,EAAA,SAAS,SAAY,GAAA;AACnB,IAAA,OAAO,MAAM;AACX,MAAA,OAAO,uBAAwB,EAAA;AAAA,KACjC;AAAA;AAEF,EAAA,wBAAA,CAAyB,SAAY,GAAA,SAAA;AACvC,CAAG,EAAA,uBAAA,KAA4B,uBAA0B,GAAA,EAAG,CAAA,CAAA;;;ACtBrD,SAAS,oBAAA,CAAqB,QAAQ,mBAAqB,EAAA;AAChE,EAAA,OAAO,MAAO,CAAA,WAAA,CAAY,MAAO,CAAA,OAAA,CAAQ,OAAO,UAAU,CAAA,CAAE,GAAI,CAAA,CAAC,CAAC,GAAA,EAAK,eAAe,CAAA,KAAM,CAAC,GAAK,EAAA;AAAA,IAChG,MAAM,eAAgB,CAAA,IAAA;AAAA,IACtB,KAAO,EAAA;AAAA,MACL,IAAM,EAAA;AAAA;AACR,GACD,CAAC,CAAC,CAAA;AACL;;;ACHO,IAAM,gBAAgB,CAAC;AAAA,EAC5B,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAM,KAAA;AACJ,EAAA,MAAM,SAASC,cAAQ,CAAA,MAAMC,uCAA0B,EAAA,EAAG,EAAE,CAAA;AAC5D,EAAM,MAAA,CAAC,oBAAsB,EAAA,uBAAuB,CAAIC,GAAAA,uBAAAA,CAAM,SAAS,aAAiB,IAAA,oBAAA,CAAqB,MAAQ,EAAA,aAAa,CAAC,CAAA;AACnI,EAAA,MAAM,CAAC,kBAAA,EAAoB,qBAAqB,CAAA,GAAIA,wBAAM,QAAS,CAAA;AAAA,IACjE,IAAM,EAAA;AAAA,GACP,CAAA;AACD,EAAAC,gBAAA,CAAU,MAAM;AACd,IAAA,MAAA,CAAO,SAAU,EAAA;AACjB,IAAO,MAAA,CAAA,eAAA,CAAgB,gBAAiB,CAAA,wBAAA,EAA0B,CAAW,OAAA,KAAA;AAC3E,MAAA,uBAAA,CAAwB,CAAsB,iBAAA,MAAA;AAAA,QAC5C,GAAG,iBAAA;AAAA,QACH,GAAG,QAAQ,MAAO,CAAA;AAAA,OAClB,CAAA,CAAA;AACF,MAAA,qBAAA,CAAsB,CAAqB,iBAAA,KAAA;AACzC,QAAA,IAAI,qBAAwB,GAAA,QAAA;AAC5B,QAAI,IAAA,UAAA;AACJ,QAAA,MAAM,qBAAqB,EAAC;AAC5B,QAAW,KAAA,MAAA,GAAA,IAAO,OAAQ,CAAA,MAAA,CAAO,UAAY,EAAA;AAC3C,UAAA,MAAM,KAAQ,GAAA,OAAA,CAAQ,MAAO,CAAA,UAAA,CAAW,GAAG,CAAE,CAAA,KAAA;AAE7C,UAAI,IAAA,KAAA,CAAM,SAAS,QAAU,EAAA;AAC3B,YAAwB,qBAAA,GAAA,QAAA;AACxB,YAAA,UAAA,GAAa,cAAc,KAAM,CAAA,KAAA;AACjC,YAAmB,kBAAA,CAAA,GAAG,IAAI,KAAM,CAAA,KAAA;AAChC,YAAA;AAAA;AAGF,UAAA,IAAI,KAAM,CAAA,IAAA,KAAS,SAAa,IAAA,qBAAA,KAA0B,QAAU,EAAA;AAClE,YAAwB,qBAAA,GAAA,SAAA;AACxB,YAAA;AAAA;AAGF,UAAA,IAAI,MAAM,IAAS,KAAA,WAAA,IAAe,qBAA0B,KAAA,QAAA,IAAY,0BAA0B,SAAW,EAAA;AAC3G,YAAwB,qBAAA,GAAA,WAAA;AACxB,YAAmB,kBAAA,CAAA,GAAG,IAAI,KAAM,CAAA,KAAA;AAChC,YAAA;AAAA;AAEF,UAAI,IAAA,KAAA,CAAM,SAAS,aAAiB,IAAA,qBAAA,KAA0B,YAAY,qBAA0B,KAAA,SAAA,IAAa,0BAA0B,WAAa,EAAA;AACtJ,YAAwB,qBAAA,GAAA,aAAA;AAAA;AAE1B,UAAI,IAAA,KAAA,CAAM,SAAS,QAAU,EAAA;AAC3B,YAAmB,kBAAA,CAAA,GAAG,IAAI,KAAM,CAAA,KAAA;AAAA;AAClC;AAEF,QAAM,MAAA,qBAAA,GAAwB,kBAAkB,IAAS,KAAA,aAAA,IAAiB,kBAAkB,IAAS,KAAA,SAAA,GAAY,iBAAkB,CAAA,KAAA,GAAQ,EAAC;AAC5I,QAAI,IAAA,qBAAA,KAA0B,aAAiB,IAAA,qBAAA,KAA0B,SAAW,EAAA;AAClF,UAAA,MAAM,YAAe,GAAA;AAAA,YACnB,GAAG,qBAAA;AAAA,YACH,GAAG;AAAA,WACL;AACA,UAAA,OAAO,0BAA0B,QAAW,GAAA;AAAA,YAC1C,IAAM,EAAA,qBAAA;AAAA,YACN,KAAO,EAAA,YAAA;AAAA,YACP,KAAO,EAAA,UAAA,IAAc,IAAI,KAAA,CAAM,2BAA2B;AAAA,WACxD,GAAA;AAAA,YACF,IAAM,EAAA,qBAAA;AAAA,YACN,KAAO,EAAA;AAAA,WACT;AAAA,SACK,MAAA;AACL,UAAO,OAAA;AAAA,YACL,IAAM,EAAA;AAAA,WACR;AAAA;AACF,OACD,CAAA;AAAA,KACF,CAAA;AACD,IAAA,MAAA,CAAO,KAAM,EAAA;AACb,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,CAAO,WAAY,EAAA;AAAA,KACrB;AAAA,GACF,EAAG,EAAE,CAAA;AACL,EAAA,uBAAoBD,uBAAAA,CAAM,aAAc,CAAA,oBAAA,CAAqB,QAAU,EAAA;AAAA,IACrE,KAAO,EAAA;AAAA,MACL,WAAW,MAAO,CAAA,SAAA;AAAA,MAClB,iBAAiB,MAAO,CAAA,eAAA;AAAA,MACxB,oBAAA;AAAA,MACA,UAAY,EAAA;AAAA,QACV,MAAA,EAAQ,kBAAmB,CAAA,KAAA,IAAS,EAAC;AAAA,QACrC,OAAO,kBAAmB,CAAA;AAAA;AAC5B;AAAA;AAEF,KACC,QAAQ,CAAA;AACb","file":"index.cjs","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 { FoundryHostEventTarget } from \"@osdk/widget.client\";\nimport React, { useContext } from \"react\";\nexport const FoundryWidgetContext = /*#__PURE__*/React.createContext({\n emitEvent: () => {},\n hostEventTarget: new FoundryHostEventTarget(),\n asyncParameterValues: {},\n parameters: {\n state: \"not-started\",\n values: {}\n }\n});\n\n/**\n * @returns The current FoundryWidgetClientContext, in the context of your specific parameter configuration\n */\nexport function useFoundryWidgetContext() {\n return useContext(FoundryWidgetContext);\n}\n(function (_useFoundryWidgetContext) {\n function withTypes() {\n return () => {\n return useFoundryWidgetContext();\n };\n }\n _useFoundryWidgetContext.withTypes = withTypes;\n})(useFoundryWidgetContext || (useFoundryWidgetContext = {}));","/*\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\n/**\n * Utility function to initialize a map of parameter values to either a loading or not-started loading state\n */\nexport function initializeParameters(config, initialLoadingState) {\n return Object.fromEntries(Object.entries(config.parameters).map(([key, parameterConfig]) => [key, {\n type: parameterConfig.type,\n value: {\n type: initialLoadingState\n }\n }]));\n}","/*\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 { createFoundryWidgetClient } from \"@osdk/widget.client\";\nimport React, { useEffect, useMemo } from \"react\";\nimport { FoundryWidgetContext } from \"./context.js\";\nimport { initializeParameters } from \"./utils/initializeParameters.js\";\n/**\n * Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context\n */\nexport const FoundryWidget = ({\n children,\n config,\n initialValues\n}) => {\n const client = useMemo(() => createFoundryWidgetClient(), []);\n const [asyncParameterValues, setAsyncParameterValues] = React.useState(initialValues ?? initializeParameters(config, \"not-started\"));\n const [allParameterValues, setAllParameterValues] = React.useState({\n type: \"not-started\"\n });\n useEffect(() => {\n client.subscribe();\n client.hostEventTarget.addEventListener(\"host.update-parameters\", payload => {\n setAsyncParameterValues(currentParameters => ({\n ...currentParameters,\n ...payload.detail.parameters\n }));\n setAllParameterValues(currentParameters => {\n let aggregatedLoadedState = \"loaded\";\n let firstError;\n const newParameterValues = {};\n for (const key in payload.detail.parameters) {\n const value = payload.detail.parameters[key].value;\n // If any fails, consider the whole thing failed\n if (value.type === \"failed\") {\n aggregatedLoadedState = \"failed\";\n firstError = firstError ?? value.error;\n newParameterValues[key] = value.value;\n continue;\n }\n // If any is loading, consider all of it loading unless we have failed somewhere\n if (value.type === \"loading\" && aggregatedLoadedState !== \"failed\") {\n aggregatedLoadedState = \"loading\";\n continue;\n }\n // If any is reloading, consider it loading unless something is failed or loading for the first time\n if (value.type === \"reloading\" && aggregatedLoadedState !== \"failed\" && aggregatedLoadedState !== \"loading\") {\n aggregatedLoadedState = \"reloading\";\n newParameterValues[key] = value.value;\n continue;\n }\n if (value.type === \"not-started\" && aggregatedLoadedState !== \"failed\" && aggregatedLoadedState !== \"loading\" && aggregatedLoadedState !== \"reloading\") {\n aggregatedLoadedState = \"not-started\";\n }\n if (value.type === \"loaded\") {\n newParameterValues[key] = value.value;\n }\n }\n const currentParameterValue = currentParameters.type !== \"not-started\" && currentParameters.type !== \"loading\" ? currentParameters.value : {};\n if (aggregatedLoadedState !== \"not-started\" && aggregatedLoadedState !== \"loading\") {\n const updatedValue = {\n ...currentParameterValue,\n ...newParameterValues\n };\n return aggregatedLoadedState === \"failed\" ? {\n type: aggregatedLoadedState,\n value: updatedValue,\n error: firstError ?? new Error(\"Failed to load parameters\")\n } : {\n type: aggregatedLoadedState,\n value: updatedValue\n };\n } else {\n return {\n type: aggregatedLoadedState\n };\n }\n });\n });\n client.ready();\n return () => {\n client.unsubscribe();\n };\n }, []);\n return /*#__PURE__*/React.createElement(FoundryWidgetContext.Provider, {\n value: {\n emitEvent: client.emitEvent,\n hostEventTarget: client.hostEventTarget,\n asyncParameterValues,\n parameters: {\n values: allParameterValues.value ?? {},\n state: allParameterValues.type\n }\n // Unfortunately the context is statically defined so we can't use the generic type, hence the cast\n }\n }, children);\n};"]}
|
|
1
|
+
{"version":3,"sources":["../../src/context.ts","../../src/utils/extendParametersWithObjectSets.ts","../../src/utils/initializeParameters.ts","../../src/client.tsx"],"names":["FoundryHostEventTarget","useContext","hydrateObjectSetFromRid","useMemo","createFoundryWidgetClient","React","useRef","useEffect"],"mappings":";;;;;;;;;;;AAkBO,IAAM,oBAAA,2CAA0C,aAAc,CAAA;AAAA,EACnE,WAAW,MAAM;AAAA,GAAC;AAAA,EAClB,eAAA,EAAiB,IAAIA,oCAAuB,EAAA;AAAA,EAC5C,sBAAsB,EAAC;AAAA,EACvB,UAAY,EAAA;AAAA,IACV,KAAO,EAAA,aAAA;AAAA,IACP,QAAQ;AAAC;AAEb,CAAC,CAAA;AAKM,SAAS,uBAA0B,GAAA;AACxC,EAAA,OAAOC,kBAAW,oBAAoB,CAAA;AACxC;AAAA,CACC,SAAU,wBAA0B,EAAA;AACnC,EAAA,SAAS,SAAY,GAAA;AACnB,IAAA,OAAO,MAAM;AACX,MAAA,OAAO,uBAAwB,EAAA;AAAA,KACjC;AAAA;AAEF,EAAA,wBAAA,CAAyB,SAAY,GAAA,SAAA;AACvC,CAAG,EAAA,uBAAA,KAA4B,uBAA0B,GAAA,EAAG,CAAA,CAAA;AClBrD,SAAS,8BAA+B,CAAA,UAAA,EAAY,MAAQ,EAAA,UAAA,EAAY,KAAO,EAAA;AACpF,EAAA,MAAM,kBAAqB,GAAA;AAAA,IACzB,GAAG;AAAA,GACL;AACA,EAAA,KAAA,MAAW,WAAe,IAAA,MAAA,CAAO,IAAK,CAAA,kBAAkB,CAAG,EAAA;AACzD,IAAM,MAAA,KAAA,GAAQ,MAAO,CAAA,UAAA,CAAW,WAAW,CAAA;AAC3C,IAAA,IAAI,MAAM,IAAS,KAAA,WAAA,IAAe,mBAAmB,WAAW,CAAA,CAAE,SAAS,WAAa,EAAA;AACtF,MAAA,MAAM,cAAiB,GAAA,kBAAA,CAAmB,WAAW,CAAA,CAAE,KAAM,CAAA,KAAA;AAC7D,MAAA,IAAI,kBAAkB,IAAM,EAAA;AAC1B,QAAI,IAAA,OAAO,mBAAmB,QAAY,IAAA,cAAA,IAAkB,kBAAkB,OAAO,cAAA,CAAe,iBAAiB,QAAU,EAAA;AAC7H,UAAA,MAAM,eAAe,cAAe,CAAA,YAAA;AACpC,UAAA,MAAM,YAAY,qBAAsB,CAAA,UAAA,EAAY,OAAO,WAAa,EAAA,YAAA,EAAc,MAAM,UAAU,CAAA;AACtG,UAAA,cAAA,CAAe,SAAY,GAAA,SAAA;AAAA,SACtB,MAAA;AACL,UAAA,MAAM,IAAI,KAAA,CAAM,CAAqD,kDAAA,EAAA,WAAW,CAAG,CAAA,CAAA,CAAA;AAAA;AACrF,OACK,MAAA;AACL,QAAA,KAAA,CAAM,OAAO,WAAW,CAAA;AAAA;AAC1B;AACF;AAEF,EAAO,OAAA,kBAAA;AACT;AACA,SAAS,qBAAsB,CAAA,UAAA,EAAY,KAAO,EAAA,QAAA,EAAU,cAAc,UAAY,EAAA;AACpF,EAAA,IAAI,cAAc,IAAM,EAAA;AACtB,IAAM,MAAA,IAAI,MAAM,6BAA6B,CAAA;AAAA;AAE/C,EAAM,MAAA,MAAA,GAAS,KAAM,CAAA,GAAA,CAAI,QAAQ,CAAA;AACjC,EAAI,IAAA,MAAA,EAAQ,iBAAiB,YAAc,EAAA;AACzC,IAAA,OAAO,MAAO,CAAA,SAAA;AAAA;AAEhB,EAAA,MAAM,SAAY,GAAAC,gCAAA,CAAwB,UAAY,EAAA,UAAA,EAAY,YAAY,CAAA;AAC9E,EAAA,KAAA,CAAM,IAAI,QAAU,EAAA;AAAA,IAClB,YAAA;AAAA,IACA;AAAA,GACD,CAAA;AACD,EAAO,OAAA,SAAA;AACT;;;ACzCO,SAAS,oBAAA,CAAqB,QAAQ,mBAAqB,EAAA;AAChE,EAAA,OAAO,MAAO,CAAA,WAAA,CAAY,MAAO,CAAA,OAAA,CAAQ,OAAO,UAAU,CAAA,CAAE,GAAI,CAAA,CAAC,CAAC,GAAA,EAAK,eAAe,CAAA,KAAM,CAAC,GAAK,EAAA;AAAA,IAChG,MAAM,eAAgB,CAAA,IAAA;AAAA,IACtB,KAAO,EAAA;AAAA,MACL,IAAM,EAAA;AAAA;AACR,GACD,CAAC,CAAC,CAAA;AACL;;;ACFO,IAAM,gBAAgB,CAAC;AAAA,EAC5B,QAAA;AAAA,EACA,MAAA;AAAA,EACA,aAAA;AAAA,EACA,MAAQ,EAAA;AACV,CAAM,KAAA;AACJ,EAAA,MAAM,SAASC,cAAQ,CAAA,MAAMC,uCAA0B,EAAA,EAAG,EAAE,CAAA;AAC5D,EAAM,MAAA,CAAC,oBAAsB,EAAA,uBAAuB,CAAIC,GAAAA,uBAAAA,CAAM,SAAS,aAAiB,IAAA,oBAAA,CAAqB,MAAQ,EAAA,aAAa,CAAC,CAAA;AACnI,EAAA,MAAM,CAAC,kBAAA,EAAoB,qBAAqB,CAAA,GAAIA,wBAAM,QAAS,CAAA;AAAA,IACjE,IAAM,EAAA;AAAA,GACP,CAAA;AACD,EAAA,MAAM,cAAiB,GAAAC,aAAA,iBAAW,IAAA,GAAA,EAAK,CAAA;AACvC,EAAAC,gBAAA,CAAU,MAAM;AACd,IAAA,MAAA,CAAO,SAAU,EAAA;AACjB,IAAO,MAAA,CAAA,eAAA,CAAgB,gBAAiB,CAAA,wBAAA,EAA0B,CAAW,OAAA,KAAA;AAC3E,MAAM,MAAA,mBAAA,GAAsB,+BAA+B,UAAY,EAAA,MAAA,EAAQ,QAAQ,MAAO,CAAA,UAAA,EAAY,eAAe,OAAO,CAAA;AAChI,MAAA,uBAAA,CAAwB,CAAsB,iBAAA,MAAA;AAAA,QAC5C,GAAG,iBAAA;AAAA,QACH,GAAG;AAAA,OACH,CAAA,CAAA;AACF,MAAA,qBAAA,CAAsB,CAAqB,iBAAA,KAAA;AACzC,QAAA,IAAI,qBAAwB,GAAA,QAAA;AAC5B,QAAI,IAAA,UAAA;AACJ,QAAA,MAAM,qBAAqB,EAAC;AAC5B,QAAA,KAAA,MAAW,OAAO,mBAAqB,EAAA;AACrC,UAAM,MAAA,KAAA,GAAQ,mBAAoB,CAAA,GAAG,CAAE,CAAA,KAAA;AAEvC,UAAI,IAAA,KAAA,CAAM,SAAS,QAAU,EAAA;AAC3B,YAAwB,qBAAA,GAAA,QAAA;AACxB,YAAA,UAAA,GAAa,cAAc,KAAM,CAAA,KAAA;AACjC,YAAmB,kBAAA,CAAA,GAAG,IAAI,KAAM,CAAA,KAAA;AAChC,YAAA;AAAA;AAGF,UAAA,IAAI,KAAM,CAAA,IAAA,KAAS,SAAa,IAAA,qBAAA,KAA0B,QAAU,EAAA;AAClE,YAAwB,qBAAA,GAAA,SAAA;AACxB,YAAA;AAAA;AAGF,UAAA,IAAI,MAAM,IAAS,KAAA,WAAA,IAAe,qBAA0B,KAAA,QAAA,IAAY,0BAA0B,SAAW,EAAA;AAC3G,YAAwB,qBAAA,GAAA,WAAA;AACxB,YAAmB,kBAAA,CAAA,GAAG,IAAI,KAAM,CAAA,KAAA;AAChC,YAAA;AAAA;AAEF,UAAI,IAAA,KAAA,CAAM,SAAS,aAAiB,IAAA,qBAAA,KAA0B,YAAY,qBAA0B,KAAA,SAAA,IAAa,0BAA0B,WAAa,EAAA;AACtJ,YAAwB,qBAAA,GAAA,aAAA;AAAA;AAE1B,UAAI,IAAA,KAAA,CAAM,SAAS,QAAU,EAAA;AAC3B,YAAmB,kBAAA,CAAA,GAAG,IAAI,KAAM,CAAA,KAAA;AAAA;AAClC;AAEF,QAAM,MAAA,qBAAA,GAAwB,kBAAkB,IAAS,KAAA,aAAA,IAAiB,kBAAkB,IAAS,KAAA,SAAA,GAAY,iBAAkB,CAAA,KAAA,GAAQ,EAAC;AAC5I,QAAI,IAAA,qBAAA,KAA0B,aAAiB,IAAA,qBAAA,KAA0B,SAAW,EAAA;AAClF,UAAA,MAAM,YAAe,GAAA;AAAA,YACnB,GAAG,qBAAA;AAAA,YACH,GAAG;AAAA,WACL;AACA,UAAA,OAAO,0BAA0B,QAAW,GAAA;AAAA,YAC1C,IAAM,EAAA,qBAAA;AAAA,YACN,KAAO,EAAA,YAAA;AAAA,YACP,KAAO,EAAA,UAAA,IAAc,IAAI,KAAA,CAAM,2BAA2B;AAAA,WACxD,GAAA;AAAA,YACF,IAAM,EAAA,qBAAA;AAAA,YACN,KAAO,EAAA;AAAA,WACT;AAAA,SACK,MAAA;AACL,UAAO,OAAA;AAAA,YACL,IAAM,EAAA;AAAA,WACR;AAAA;AACF,OACD,CAAA;AAAA,KACF,CAAA;AACD,IAAA,MAAA,CAAO,KAAM,EAAA;AACb,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,CAAO,WAAY,EAAA;AAAA,KACrB;AAAA,GACF,EAAG,EAAE,CAAA;AACL,EAAA,uBAAoBF,uBAAAA,CAAM,aAAc,CAAA,oBAAA,CAAqB,QAAU,EAAA;AAAA,IACrE,KAAO,EAAA;AAAA,MACL,WAAW,MAAO,CAAA,SAAA;AAAA,MAClB,iBAAiB,MAAO,CAAA,eAAA;AAAA,MACxB,oBAAA;AAAA,MACA,UAAY,EAAA;AAAA,QACV,MAAA,EAAQ,kBAAmB,CAAA,KAAA,IAAS,EAAC;AAAA,QACrC,OAAO,kBAAmB,CAAA;AAAA;AAC5B;AAAA;AAEF,KACC,QAAQ,CAAA;AACb","file":"index.cjs","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 { FoundryHostEventTarget } from \"@osdk/widget.client\";\nimport React, { useContext } from \"react\";\nexport const FoundryWidgetContext = /*#__PURE__*/React.createContext({\n emitEvent: () => {},\n hostEventTarget: new FoundryHostEventTarget(),\n asyncParameterValues: {},\n parameters: {\n state: \"not-started\",\n values: {}\n }\n});\n\n/**\n * @returns The current FoundryWidgetClientContext, in the context of your specific parameter configuration\n */\nexport function useFoundryWidgetContext() {\n return useContext(FoundryWidgetContext);\n}\n(function (_useFoundryWidgetContext) {\n function withTypes() {\n return () => {\n return useFoundryWidgetContext();\n };\n }\n _useFoundryWidgetContext.withTypes = withTypes;\n})(useFoundryWidgetContext || (useFoundryWidgetContext = {}));","/*\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 { hydrateObjectSetFromRid } from \"@osdk/client/internal\";\n/**\n * Patches parameter values with hydrated object sets for object set parameters.\n *\n * The cache is used to avoid redundant hydration of the same object set RID, which\n * can cause unnecessary re-renders in React components consuming the parameters.\n */\nexport function extendParametersWithObjectSets(osdkClient, config, parameters, cache) {\n const extendedParameters = {\n ...parameters\n };\n for (const parameterId of Object.keys(extendedParameters)) {\n const param = config.parameters[parameterId];\n if (param.type === \"objectSet\" && extendedParameters[parameterId].type === \"objectSet\") {\n const parameterValue = extendedParameters[parameterId].value.value;\n if (parameterValue != null) {\n if (typeof parameterValue === \"object\" && \"objectSetRid\" in parameterValue && typeof parameterValue.objectSetRid === \"string\") {\n const objectSetRid = parameterValue.objectSetRid;\n const objectSet = getOrHydrateObjectSet(osdkClient, cache, parameterId, objectSetRid, param.objectType);\n parameterValue.objectSet = objectSet;\n } else {\n throw new Error(`Invalid object set parameter value for parameter \"${parameterId}\"`);\n }\n } else {\n cache.delete(parameterId);\n }\n }\n }\n return extendedParameters;\n}\nfunction getOrHydrateObjectSet(osdkClient, cache, paramKey, objectSetRid, definition) {\n if (osdkClient == null) {\n throw new Error(\"Not provided an OSDK client\");\n }\n const cached = cache.get(paramKey);\n if (cached?.objectSetRid === objectSetRid) {\n return cached.objectSet;\n }\n const objectSet = hydrateObjectSetFromRid(osdkClient, definition, objectSetRid);\n cache.set(paramKey, {\n objectSetRid,\n objectSet\n });\n return objectSet;\n}","/*\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\n/**\n * Utility function to initialize a map of parameter values to either a loading or not-started loading state\n */\nexport function initializeParameters(config, initialLoadingState) {\n return Object.fromEntries(Object.entries(config.parameters).map(([key, parameterConfig]) => [key, {\n type: parameterConfig.type,\n value: {\n type: initialLoadingState\n }\n }]));\n}","/*\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 { createFoundryWidgetClient } from \"@osdk/widget.client\";\nimport React, { useEffect, useMemo, useRef } from \"react\";\nimport { FoundryWidgetContext } from \"./context.js\";\nimport { extendParametersWithObjectSets } from \"./utils/extendParametersWithObjectSets.js\";\nimport { initializeParameters } from \"./utils/initializeParameters.js\";\n/**\n * Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context\n */\nexport const FoundryWidget = ({\n children,\n config,\n initialValues,\n client: osdkClient\n}) => {\n const client = useMemo(() => createFoundryWidgetClient(), []);\n const [asyncParameterValues, setAsyncParameterValues] = React.useState(initialValues ?? initializeParameters(config, \"not-started\"));\n const [allParameterValues, setAllParameterValues] = React.useState({\n type: \"not-started\"\n });\n const objectSetCache = useRef(new Map());\n useEffect(() => {\n client.subscribe();\n client.hostEventTarget.addEventListener(\"host.update-parameters\", payload => {\n const processedParameters = extendParametersWithObjectSets(osdkClient, config, payload.detail.parameters, objectSetCache.current);\n setAsyncParameterValues(currentParameters => ({\n ...currentParameters,\n ...processedParameters\n }));\n setAllParameterValues(currentParameters => {\n let aggregatedLoadedState = \"loaded\";\n let firstError;\n const newParameterValues = {};\n for (const key in processedParameters) {\n const value = processedParameters[key].value;\n // If any fails, consider the whole thing failed\n if (value.type === \"failed\") {\n aggregatedLoadedState = \"failed\";\n firstError = firstError ?? value.error;\n newParameterValues[key] = value.value;\n continue;\n }\n // If any is loading, consider all of it loading unless we have failed somewhere\n if (value.type === \"loading\" && aggregatedLoadedState !== \"failed\") {\n aggregatedLoadedState = \"loading\";\n continue;\n }\n // If any is reloading, consider it loading unless something is failed or loading for the first time\n if (value.type === \"reloading\" && aggregatedLoadedState !== \"failed\" && aggregatedLoadedState !== \"loading\") {\n aggregatedLoadedState = \"reloading\";\n newParameterValues[key] = value.value;\n continue;\n }\n if (value.type === \"not-started\" && aggregatedLoadedState !== \"failed\" && aggregatedLoadedState !== \"loading\" && aggregatedLoadedState !== \"reloading\") {\n aggregatedLoadedState = \"not-started\";\n }\n if (value.type === \"loaded\") {\n newParameterValues[key] = value.value;\n }\n }\n const currentParameterValue = currentParameters.type !== \"not-started\" && currentParameters.type !== \"loading\" ? currentParameters.value : {};\n if (aggregatedLoadedState !== \"not-started\" && aggregatedLoadedState !== \"loading\") {\n const updatedValue = {\n ...currentParameterValue,\n ...newParameterValues\n };\n return aggregatedLoadedState === \"failed\" ? {\n type: aggregatedLoadedState,\n value: updatedValue,\n error: firstError ?? new Error(\"Failed to load parameters\")\n } : {\n type: aggregatedLoadedState,\n value: updatedValue\n };\n } else {\n return {\n type: aggregatedLoadedState\n };\n }\n });\n });\n client.ready();\n return () => {\n client.unsubscribe();\n };\n }, []);\n return /*#__PURE__*/React.createElement(FoundryWidgetContext.Provider, {\n value: {\n emitEvent: client.emitEvent,\n hostEventTarget: client.hostEventTarget,\n asyncParameterValues,\n parameters: {\n values: allParameterValues.value ?? {},\n state: allParameterValues.type\n }\n // Unfortunately the context is statically defined so we can't use the generic type, hence the cast\n }\n }, children);\n};"]}
|
package/build/cjs/index.d.cts
CHANGED
|
@@ -1,39 +1,41 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ObjectSet, Client } from '@osdk/client';
|
|
2
|
+
import { ObjectType } from '@osdk/widget.api';
|
|
3
|
+
import { WidgetConfig, AsyncParameterValueMap, AsyncValue, ParameterValueMap, FoundryWidgetClient, FoundryHostEventTarget } from '@osdk/widget.client';
|
|
2
4
|
import React from 'react';
|
|
3
5
|
|
|
4
|
-
interface FoundryWidgetProps<C extends WidgetConfig<C["parameters"]>> {
|
|
5
|
-
children: React.ReactNode;
|
|
6
|
-
/**
|
|
7
|
-
* Parameter configuration for the widget
|
|
8
|
-
*/
|
|
9
|
-
config: C;
|
|
10
|
-
/**
|
|
11
|
-
* Customize what the initial value of each parameter should be
|
|
12
|
-
*
|
|
13
|
-
* @default Sets all parameters to the "not-started" loading state
|
|
14
|
-
*/
|
|
15
|
-
initialValues?: AsyncParameterValueMap<C>;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context
|
|
19
|
-
*/
|
|
20
|
-
declare const FoundryWidget: <C extends WidgetConfig<C["parameters"]>>({ children, config, initialValues, }: FoundryWidgetProps<C>) => React.ReactElement<FoundryWidgetProps<C>>;
|
|
21
|
-
|
|
22
6
|
interface FoundryWidgetClientContext<C extends WidgetConfig<C["parameters"]>> {
|
|
23
7
|
emitEvent: FoundryWidgetClient<C>["emitEvent"];
|
|
24
8
|
hostEventTarget: FoundryHostEventTarget<C>;
|
|
25
9
|
/**
|
|
26
10
|
* Object where the individual parameters have their async state represented
|
|
27
11
|
*/
|
|
28
|
-
asyncParameterValues:
|
|
12
|
+
asyncParameterValues: ExtendedAsyncParameterValueMap<C>;
|
|
29
13
|
/**
|
|
30
14
|
* Convenience object that aggregates the value of all parameters, accounting for their loading states
|
|
31
15
|
*/
|
|
32
16
|
parameters: {
|
|
33
|
-
values: Partial<
|
|
17
|
+
values: Partial<ExtendedParameterValueMap<C>>;
|
|
34
18
|
state: AsyncValue<ParameterValueMap<C>>["type"];
|
|
35
19
|
};
|
|
36
20
|
}
|
|
21
|
+
type ExtendedParameterValueMap<C extends WidgetConfig<C["parameters"]>> = {
|
|
22
|
+
[K in keyof C["parameters"]]: K extends keyof ParameterValueMap<C> ? C["parameters"][K] extends {
|
|
23
|
+
type: "objectSet";
|
|
24
|
+
objectType: infer T;
|
|
25
|
+
} ? T extends ObjectType ? ParameterValueMap<C>[K] & {
|
|
26
|
+
objectSet: ObjectSet<T>;
|
|
27
|
+
} : ParameterValueMap<C>[K] : ParameterValueMap<C>[K] : never;
|
|
28
|
+
};
|
|
29
|
+
type ExtendedAsyncParameterValueMap<C extends WidgetConfig<C["parameters"]>> = {
|
|
30
|
+
[K in keyof C["parameters"]]: K extends keyof AsyncParameterValueMap<C> ? C["parameters"][K] extends {
|
|
31
|
+
type: "objectSet";
|
|
32
|
+
objectType: infer T;
|
|
33
|
+
} ? T extends ObjectType ? AsyncParameterValueMap<C>[K] & {
|
|
34
|
+
value: AsyncValue<ParameterValueMap<C>[K] & {
|
|
35
|
+
objectSet: ObjectSet<T>;
|
|
36
|
+
}>;
|
|
37
|
+
} : AsyncParameterValueMap<C>[K] : AsyncParameterValueMap<C>[K] : never;
|
|
38
|
+
};
|
|
37
39
|
/**
|
|
38
40
|
* @returns The current FoundryWidgetClientContext, in the context of your specific parameter configuration
|
|
39
41
|
*/
|
|
@@ -42,4 +44,33 @@ declare namespace useFoundryWidgetContext {
|
|
|
42
44
|
function withTypes<C extends WidgetConfig<C["parameters"]>>(): () => FoundryWidgetClientContext<C>;
|
|
43
45
|
}
|
|
44
46
|
|
|
47
|
+
type ExtractObjectTypes<C extends WidgetConfig<C["parameters"]>> = C["parameters"][keyof C["parameters"]] extends infer Param ? Param extends {
|
|
48
|
+
type: "objectSet";
|
|
49
|
+
objectType: infer OT;
|
|
50
|
+
} ? OT extends ObjectType ? OT : never : never : never;
|
|
51
|
+
type HasObjectSetParameters<C extends WidgetConfig<C["parameters"]>> = ExtractObjectTypes<C> extends never ? false : true;
|
|
52
|
+
type ObjectSetProps<C extends WidgetConfig<C["parameters"]>> = {
|
|
53
|
+
/**
|
|
54
|
+
* Used to hydrate object sets from their RIDs for object set parameters
|
|
55
|
+
*/
|
|
56
|
+
client: Client;
|
|
57
|
+
};
|
|
58
|
+
type FoundryWidgetProps<C extends WidgetConfig<C["parameters"]>> = {
|
|
59
|
+
children: React.ReactNode;
|
|
60
|
+
/**
|
|
61
|
+
* Parameter configuration for the widget
|
|
62
|
+
*/
|
|
63
|
+
config: C;
|
|
64
|
+
/**
|
|
65
|
+
* Customize what the initial value of each parameter should be
|
|
66
|
+
*
|
|
67
|
+
* @default Sets all parameters to the "not-started" loading state
|
|
68
|
+
*/
|
|
69
|
+
initialValues?: ExtendedAsyncParameterValueMap<C>;
|
|
70
|
+
} & Partial<ObjectSetProps<C>> & (HasObjectSetParameters<C> extends true ? ObjectSetProps<C> : {});
|
|
71
|
+
/**
|
|
72
|
+
* Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context
|
|
73
|
+
*/
|
|
74
|
+
declare const FoundryWidget: <C extends WidgetConfig<C["parameters"]>>({ children, config, initialValues, client: osdkClient, }: FoundryWidgetProps<C>) => React.ReactElement<FoundryWidgetProps<C>>;
|
|
75
|
+
|
|
45
76
|
export { FoundryWidget, type FoundryWidgetClientContext, useFoundryWidgetContext };
|
package/build/esm/client.js
CHANGED
|
@@ -15,8 +15,9 @@
|
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
17
|
import { createFoundryWidgetClient } from "@osdk/widget.client";
|
|
18
|
-
import React, { useEffect, useMemo } from "react";
|
|
18
|
+
import React, { useEffect, useMemo, useRef } from "react";
|
|
19
19
|
import { FoundryWidgetContext } from "./context.js";
|
|
20
|
+
import { extendParametersWithObjectSets } from "./utils/extendParametersWithObjectSets.js";
|
|
20
21
|
import { initializeParameters } from "./utils/initializeParameters.js";
|
|
21
22
|
/**
|
|
22
23
|
* Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context
|
|
@@ -24,26 +25,29 @@ import { initializeParameters } from "./utils/initializeParameters.js";
|
|
|
24
25
|
export const FoundryWidget = ({
|
|
25
26
|
children,
|
|
26
27
|
config,
|
|
27
|
-
initialValues
|
|
28
|
+
initialValues,
|
|
29
|
+
client: osdkClient
|
|
28
30
|
}) => {
|
|
29
31
|
const client = useMemo(() => createFoundryWidgetClient(), []);
|
|
30
32
|
const [asyncParameterValues, setAsyncParameterValues] = React.useState(initialValues ?? initializeParameters(config, "not-started"));
|
|
31
33
|
const [allParameterValues, setAllParameterValues] = React.useState({
|
|
32
34
|
type: "not-started"
|
|
33
35
|
});
|
|
36
|
+
const objectSetCache = useRef(new Map());
|
|
34
37
|
useEffect(() => {
|
|
35
38
|
client.subscribe();
|
|
36
39
|
client.hostEventTarget.addEventListener("host.update-parameters", payload => {
|
|
40
|
+
const processedParameters = extendParametersWithObjectSets(osdkClient, config, payload.detail.parameters, objectSetCache.current);
|
|
37
41
|
setAsyncParameterValues(currentParameters => ({
|
|
38
42
|
...currentParameters,
|
|
39
|
-
...
|
|
43
|
+
...processedParameters
|
|
40
44
|
}));
|
|
41
45
|
setAllParameterValues(currentParameters => {
|
|
42
46
|
let aggregatedLoadedState = "loaded";
|
|
43
47
|
let firstError;
|
|
44
48
|
const newParameterValues = {};
|
|
45
|
-
for (const key in
|
|
46
|
-
const value =
|
|
49
|
+
for (const key in processedParameters) {
|
|
50
|
+
const value = processedParameters[key].value;
|
|
47
51
|
// If any fails, consider the whole thing failed
|
|
48
52
|
if (value.type === "failed") {
|
|
49
53
|
aggregatedLoadedState = "failed";
|
package/build/esm/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","names":["createFoundryWidgetClient","React","useEffect","useMemo","FoundryWidgetContext","initializeParameters","FoundryWidget","children","config","initialValues","client","asyncParameterValues","setAsyncParameterValues","useState","allParameterValues","setAllParameterValues","type","subscribe","hostEventTarget","addEventListener","payload","currentParameters","detail","parameters","aggregatedLoadedState","firstError","newParameterValues","key","value","error","currentParameterValue","updatedValue","Error","ready","unsubscribe","createElement","Provider","emitEvent","values","state"],"sources":["client.tsx"],"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 {\n AsyncParameterValueMap,\n AsyncValue,\n ParameterConfig,\n ParameterValueMap,\n WidgetConfig,\n} from \"@osdk/widget.client\";\nimport { createFoundryWidgetClient } from \"@osdk/widget.client\";\nimport React, { useEffect, useMemo } from \"react\";\nimport type { FoundryWidgetClientContext } from \"./context.js\";\nimport { FoundryWidgetContext } from \"./context.js\";\nimport { initializeParameters } from \"./utils/initializeParameters.js\";\n\ninterface FoundryWidgetProps<C extends WidgetConfig<C[\"parameters\"]>> {\n children: React.ReactNode;\n\n /**\n * Parameter configuration for the widget\n */\n config: C;\n\n /**\n * Customize what the initial value of each parameter should be\n *\n * @default Sets all parameters to the \"not-started\" loading state\n */\n initialValues?: AsyncParameterValueMap<C>;\n}\n\n/**\n * Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context\n */\nexport const FoundryWidget = <C extends WidgetConfig<C[\"parameters\"]>>({\n children,\n config,\n initialValues,\n}: FoundryWidgetProps<C>): React.ReactElement<FoundryWidgetProps<C>> => {\n const client = useMemo(() => createFoundryWidgetClient<C>(), []);\n const [asyncParameterValues, setAsyncParameterValues] = React.useState<\n AsyncParameterValueMap<C>\n >(initialValues ?? initializeParameters(config, \"not-started\"));\n const [allParameterValues, setAllParameterValues] = React.useState<\n AsyncValue<ParameterValueMap<C>>\n >({\n type: \"not-started\",\n });\n\n useEffect(() => {\n client.subscribe();\n client.hostEventTarget.addEventListener(\n \"host.update-parameters\",\n (payload) => {\n setAsyncParameterValues((currentParameters) => ({\n ...currentParameters,\n ...payload.detail.parameters,\n }));\n setAllParameterValues((currentParameters) => {\n let aggregatedLoadedState: AsyncValue<any>[\"type\"] = \"loaded\";\n let firstError: Error | undefined;\n const newParameterValues: ParameterValueMap<\n WidgetConfig<ParameterConfig>\n > = {};\n for (const key in payload.detail.parameters) {\n const value = payload.detail.parameters[key].value;\n // If any fails, consider the whole thing failed\n if (value.type === \"failed\") {\n aggregatedLoadedState = \"failed\";\n firstError = firstError ?? value.error;\n newParameterValues[key as any] = value.value as any;\n continue;\n }\n // If any is loading, consider all of it loading unless we have failed somewhere\n if (\n value.type === \"loading\"\n && aggregatedLoadedState !== \"failed\"\n ) {\n aggregatedLoadedState = \"loading\";\n continue;\n }\n // If any is reloading, consider it loading unless something is failed or loading for the first time\n if (\n value.type === \"reloading\"\n && aggregatedLoadedState !== \"failed\"\n && aggregatedLoadedState !== \"loading\"\n ) {\n aggregatedLoadedState = \"reloading\";\n newParameterValues[key as any] = value.value as any;\n continue;\n }\n if (\n value.type === \"not-started\"\n && aggregatedLoadedState !== \"failed\"\n && aggregatedLoadedState !== \"loading\"\n && aggregatedLoadedState !== \"reloading\"\n ) {\n aggregatedLoadedState = \"not-started\";\n }\n\n if (value.type === \"loaded\") {\n newParameterValues[key as any] = value.value as any;\n }\n }\n const currentParameterValue = currentParameters.type !== \"not-started\"\n && currentParameters.type !== \"loading\"\n ? currentParameters.value\n : {};\n if (\n aggregatedLoadedState !== \"not-started\"\n && aggregatedLoadedState !== \"loading\"\n ) {\n const updatedValue = {\n ...currentParameterValue,\n ...newParameterValues,\n } as ParameterValueMap<C>;\n return aggregatedLoadedState === \"failed\"\n ? {\n type: aggregatedLoadedState,\n value: updatedValue,\n error: firstError ?? new Error(\"Failed to load parameters\"),\n }\n : {\n type: aggregatedLoadedState,\n value: updatedValue,\n };\n } else {\n return { type: aggregatedLoadedState };\n }\n });\n },\n );\n client.ready();\n return () => {\n client.unsubscribe();\n };\n }, []);\n\n return (\n <FoundryWidgetContext.Provider\n value={{\n emitEvent: client.emitEvent,\n hostEventTarget: client.hostEventTarget,\n asyncParameterValues,\n parameters: {\n values: allParameterValues.value ?? {},\n state: allParameterValues.type,\n },\n // Unfortunately the context is statically defined so we can't use the generic type, hence the cast\n } as FoundryWidgetClientContext<WidgetConfig<ParameterConfig>>}\n >\n {children}\n </FoundryWidgetContext.Provider>\n );\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA,SAASA,yBAAyB,QAAQ,qBAAqB;AAC/D,OAAOC,KAAK,IAAIC,SAAS,EAAEC,OAAO,QAAQ,OAAO;AAEjD,SAASC,oBAAoB,QAAQ,cAAc;AACnD,SAASC,oBAAoB,QAAQ,iCAAiC;AAkBtE;AACA;AACA;AACA,OAAO,MAAMC,aAAa,GAAGA,CAA0C;EACrEC,QAAQ;EACRC,MAAM;EACNC;AACqB,CAAC,KAAgD;EACtE,MAAMC,MAAM,GAAGP,OAAO,CAAC,MAAMH,yBAAyB,CAAI,CAAC,EAAE,EAAE,CAAC;EAChE,MAAM,CAACW,oBAAoB,EAAEC,uBAAuB,CAAC,GAAGX,KAAK,CAACY,QAAQ,CAEpEJ,aAAa,IAAIJ,oBAAoB,CAACG,MAAM,EAAE,aAAa,CAAC,CAAC;EAC/D,MAAM,CAACM,kBAAkB,EAAEC,qBAAqB,CAAC,GAAGd,KAAK,CAACY,QAAQ,CAEhE;IACAG,IAAI,EAAE;EACR,CAAC,CAAC;EAEFd,SAAS,CAAC,MAAM;IACdQ,MAAM,CAACO,SAAS,CAAC,CAAC;IAClBP,MAAM,CAACQ,eAAe,CAACC,gBAAgB,CACrC,wBAAwB,EACvBC,OAAO,IAAK;MACXR,uBAAuB,CAAES,iBAAiB,KAAM;QAC9C,GAAGA,iBAAiB;QACpB,GAAGD,OAAO,CAACE,MAAM,CAACC;MACpB,CAAC,CAAC,CAAC;MACHR,qBAAqB,CAAEM,iBAAiB,IAAK;QAC3C,IAAIG,qBAA8C,GAAG,QAAQ;QAC7D,IAAIC,UAA6B;QACjC,MAAMC,kBAEL,GAAG,CAAC,CAAC;QACN,KAAK,MAAMC,GAAG,IAAIP,OAAO,CAACE,MAAM,CAACC,UAAU,EAAE;UAC3C,MAAMK,KAAK,GAAGR,OAAO,CAACE,MAAM,CAACC,UAAU,CAACI,GAAG,CAAC,CAACC,KAAK;UAClD;UACA,IAAIA,KAAK,CAACZ,IAAI,KAAK,QAAQ,EAAE;YAC3BQ,qBAAqB,GAAG,QAAQ;YAChCC,UAAU,GAAGA,UAAU,IAAIG,KAAK,CAACC,KAAK;YACtCH,kBAAkB,CAACC,GAAG,CAAQ,GAAGC,KAAK,CAACA,KAAY;YACnD;UACF;UACA;UACA,IACEA,KAAK,CAACZ,IAAI,KAAK,SAAS,IACrBQ,qBAAqB,KAAK,QAAQ,EACrC;YACAA,qBAAqB,GAAG,SAAS;YACjC;UACF;UACA;UACA,IACEI,KAAK,CAACZ,IAAI,KAAK,WAAW,IACvBQ,qBAAqB,KAAK,QAAQ,IAClCA,qBAAqB,KAAK,SAAS,EACtC;YACAA,qBAAqB,GAAG,WAAW;YACnCE,kBAAkB,CAACC,GAAG,CAAQ,GAAGC,KAAK,CAACA,KAAY;YACnD;UACF;UACA,IACEA,KAAK,CAACZ,IAAI,KAAK,aAAa,IACzBQ,qBAAqB,KAAK,QAAQ,IAClCA,qBAAqB,KAAK,SAAS,IACnCA,qBAAqB,KAAK,WAAW,EACxC;YACAA,qBAAqB,GAAG,aAAa;UACvC;UAEA,IAAII,KAAK,CAACZ,IAAI,KAAK,QAAQ,EAAE;YAC3BU,kBAAkB,CAACC,GAAG,CAAQ,GAAGC,KAAK,CAACA,KAAY;UACrD;QACF;QACA,MAAME,qBAAqB,GAAGT,iBAAiB,CAACL,IAAI,KAAK,aAAa,IAC/DK,iBAAiB,CAACL,IAAI,KAAK,SAAS,GACvCK,iBAAiB,CAACO,KAAK,GACvB,CAAC,CAAC;QACN,IACEJ,qBAAqB,KAAK,aAAa,IACpCA,qBAAqB,KAAK,SAAS,EACtC;UACA,MAAMO,YAAY,GAAG;YACnB,GAAGD,qBAAqB;YACxB,GAAGJ;UACL,CAAyB;UACzB,OAAOF,qBAAqB,KAAK,QAAQ,GACrC;YACAR,IAAI,EAAEQ,qBAAqB;YAC3BI,KAAK,EAAEG,YAAY;YACnBF,KAAK,EAAEJ,UAAU,IAAI,IAAIO,KAAK,CAAC,2BAA2B;UAC5D,CAAC,GACC;YACAhB,IAAI,EAAEQ,qBAAqB;YAC3BI,KAAK,EAAEG;UACT,CAAC;QACL,CAAC,MAAM;UACL,OAAO;YAAEf,IAAI,EAAEQ;UAAsB,CAAC;QACxC;MACF,CAAC,CAAC;IACJ,CACF,CAAC;IACDd,MAAM,CAACuB,KAAK,CAAC,CAAC;IACd,OAAO,MAAM;MACXvB,MAAM,CAACwB,WAAW,CAAC,CAAC;IACtB,CAAC;EACH,CAAC,EAAE,EAAE,CAAC;EAEN,oBACEjC,KAAA,CAAAkC,aAAA,CAAC/B,oBAAoB,CAACgC,QAAQ;IAC5BR,KAAK,EAAE;MACLS,SAAS,EAAE3B,MAAM,CAAC2B,SAAS;MAC3BnB,eAAe,EAAER,MAAM,CAACQ,eAAe;MACvCP,oBAAoB;MACpBY,UAAU,EAAE;QACVe,MAAM,EAAExB,kBAAkB,CAACc,KAAK,IAAI,CAAC,CAAC;QACtCW,KAAK,EAAEzB,kBAAkB,CAACE;MAC5B;MACA;IACF;EAA+D,GAE9DT,QAC4B,CAAC;AAEpC,CAAC","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"client.js","names":["createFoundryWidgetClient","React","useEffect","useMemo","useRef","FoundryWidgetContext","extendParametersWithObjectSets","initializeParameters","FoundryWidget","children","config","initialValues","client","osdkClient","asyncParameterValues","setAsyncParameterValues","useState","allParameterValues","setAllParameterValues","type","objectSetCache","Map","subscribe","hostEventTarget","addEventListener","payload","processedParameters","detail","parameters","current","currentParameters","aggregatedLoadedState","firstError","newParameterValues","key","value","error","currentParameterValue","updatedValue","Error","ready","unsubscribe","createElement","Provider","emitEvent","values","state"],"sources":["client.tsx"],"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 { Client, ObjectSet } from \"@osdk/client\";\nimport type { ObjectType } from \"@osdk/widget.api\";\nimport type {\n AsyncValue,\n ParameterConfig,\n WidgetConfig,\n} from \"@osdk/widget.client\";\nimport { createFoundryWidgetClient } from \"@osdk/widget.client\";\nimport React, { useEffect, useMemo, useRef } from \"react\";\nimport type {\n ExtendedAsyncParameterValueMap,\n ExtendedParameterValueMap,\n FoundryWidgetClientContext,\n} from \"./context.js\";\nimport { FoundryWidgetContext } from \"./context.js\";\nimport { extendParametersWithObjectSets } from \"./utils/extendParametersWithObjectSets.js\";\nimport { initializeParameters } from \"./utils/initializeParameters.js\";\n\ntype ExtractObjectTypes<C extends WidgetConfig<C[\"parameters\"]>> =\n C[\"parameters\"][keyof C[\"parameters\"]] extends infer Param\n ? Param extends { type: \"objectSet\"; objectType: infer OT }\n ? OT extends ObjectType ? OT : never\n : never\n : never;\n\ntype HasObjectSetParameters<C extends WidgetConfig<C[\"parameters\"]>> =\n ExtractObjectTypes<C> extends never ? false : true;\n\ntype ObjectSetProps<C extends WidgetConfig<C[\"parameters\"]>> = {\n /**\n * Used to hydrate object sets from their RIDs for object set parameters\n */\n client: Client;\n};\n\ntype FoundryWidgetProps<C extends WidgetConfig<C[\"parameters\"]>> =\n & {\n children: React.ReactNode;\n\n /**\n * Parameter configuration for the widget\n */\n config: C;\n\n /**\n * Customize what the initial value of each parameter should be\n *\n * @default Sets all parameters to the \"not-started\" loading state\n */\n initialValues?: ExtendedAsyncParameterValueMap<C>;\n }\n & Partial<ObjectSetProps<C>>\n & (HasObjectSetParameters<C> extends true ? ObjectSetProps<C> : {});\n\n/**\n * Handles subscribing to messages from the host Foundry UI and updating the widget's parameter values accordingly via React context\n */\nexport const FoundryWidget = <C extends WidgetConfig<C[\"parameters\"]>>({\n children,\n config,\n initialValues,\n client: osdkClient,\n}: FoundryWidgetProps<C>): React.ReactElement<FoundryWidgetProps<C>> => {\n const client = useMemo(() => createFoundryWidgetClient<C>(), []);\n const [asyncParameterValues, setAsyncParameterValues] = React.useState<\n ExtendedAsyncParameterValueMap<C>\n >(initialValues ?? initializeParameters(config, \"not-started\"));\n const [allParameterValues, setAllParameterValues] = React.useState<\n AsyncValue<ExtendedParameterValueMap<C>>\n >({\n type: \"not-started\",\n });\n\n const objectSetCache = useRef<\n Map<string, { objectSetRid: string; objectSet: ObjectSet }>\n >(new Map());\n\n useEffect(() => {\n client.subscribe();\n client.hostEventTarget.addEventListener(\n \"host.update-parameters\",\n (payload) => {\n const processedParameters = extendParametersWithObjectSets(\n osdkClient,\n config,\n payload.detail.parameters,\n objectSetCache.current,\n );\n setAsyncParameterValues((currentParameters) => ({\n ...currentParameters,\n ...processedParameters,\n }));\n setAllParameterValues((currentParameters) => {\n let aggregatedLoadedState: AsyncValue<any>[\"type\"] = \"loaded\";\n let firstError: Error | undefined;\n const newParameterValues: ExtendedParameterValueMap<\n WidgetConfig<ParameterConfig>\n > = {};\n for (const key in processedParameters) {\n const value = processedParameters[key].value;\n // If any fails, consider the whole thing failed\n if (value.type === \"failed\") {\n aggregatedLoadedState = \"failed\";\n firstError = firstError ?? value.error;\n newParameterValues[key as any] = value.value as any;\n continue;\n }\n // If any is loading, consider all of it loading unless we have failed somewhere\n if (\n value.type === \"loading\"\n && aggregatedLoadedState !== \"failed\"\n ) {\n aggregatedLoadedState = \"loading\";\n continue;\n }\n // If any is reloading, consider it loading unless something is failed or loading for the first time\n if (\n value.type === \"reloading\"\n && aggregatedLoadedState !== \"failed\"\n && aggregatedLoadedState !== \"loading\"\n ) {\n aggregatedLoadedState = \"reloading\";\n newParameterValues[key as any] = value.value as any;\n continue;\n }\n if (\n value.type === \"not-started\"\n && aggregatedLoadedState !== \"failed\"\n && aggregatedLoadedState !== \"loading\"\n && aggregatedLoadedState !== \"reloading\"\n ) {\n aggregatedLoadedState = \"not-started\";\n }\n\n if (value.type === \"loaded\") {\n newParameterValues[key as any] = value.value as any;\n }\n }\n const currentParameterValue = currentParameters.type !== \"not-started\"\n && currentParameters.type !== \"loading\"\n ? currentParameters.value\n : {};\n if (\n aggregatedLoadedState !== \"not-started\"\n && aggregatedLoadedState !== \"loading\"\n ) {\n const updatedValue = {\n ...currentParameterValue,\n ...newParameterValues,\n } as ExtendedParameterValueMap<C>;\n return aggregatedLoadedState === \"failed\"\n ? {\n type: aggregatedLoadedState,\n value: updatedValue,\n error: firstError ?? new Error(\"Failed to load parameters\"),\n }\n : {\n type: aggregatedLoadedState,\n value: updatedValue,\n };\n } else {\n return { type: aggregatedLoadedState };\n }\n });\n },\n );\n client.ready();\n return () => {\n client.unsubscribe();\n };\n }, []);\n\n return (\n <FoundryWidgetContext.Provider\n value={{\n emitEvent: client.emitEvent,\n hostEventTarget: client.hostEventTarget,\n asyncParameterValues,\n parameters: {\n values: allParameterValues.value ?? {},\n state: allParameterValues.type,\n },\n // Unfortunately the context is statically defined so we can't use the generic type, hence the cast\n } as FoundryWidgetClientContext<WidgetConfig<ParameterConfig>>}\n >\n {children}\n </FoundryWidgetContext.Provider>\n );\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA,SAASA,yBAAyB,QAAQ,qBAAqB;AAC/D,OAAOC,KAAK,IAAIC,SAAS,EAAEC,OAAO,EAAEC,MAAM,QAAQ,OAAO;AAMzD,SAASC,oBAAoB,QAAQ,cAAc;AACnD,SAASC,8BAA8B,QAAQ,2CAA2C;AAC1F,SAASC,oBAAoB,QAAQ,iCAAiC;AAsCtE;AACA;AACA;AACA,OAAO,MAAMC,aAAa,GAAGA,CAA0C;EACrEC,QAAQ;EACRC,MAAM;EACNC,aAAa;EACbC,MAAM,EAAEC;AACa,CAAC,KAAgD;EACtE,MAAMD,MAAM,GAAGT,OAAO,CAAC,MAAMH,yBAAyB,CAAI,CAAC,EAAE,EAAE,CAAC;EAChE,MAAM,CAACc,oBAAoB,EAAEC,uBAAuB,CAAC,GAAGd,KAAK,CAACe,QAAQ,CAEpEL,aAAa,IAAIJ,oBAAoB,CAACG,MAAM,EAAE,aAAa,CAAC,CAAC;EAC/D,MAAM,CAACO,kBAAkB,EAAEC,qBAAqB,CAAC,GAAGjB,KAAK,CAACe,QAAQ,CAEhE;IACAG,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMC,cAAc,GAAGhB,MAAM,CAE3B,IAAIiB,GAAG,CAAC,CAAC,CAAC;EAEZnB,SAAS,CAAC,MAAM;IACdU,MAAM,CAACU,SAAS,CAAC,CAAC;IAClBV,MAAM,CAACW,eAAe,CAACC,gBAAgB,CACrC,wBAAwB,EACvBC,OAAO,IAAK;MACX,MAAMC,mBAAmB,GAAGpB,8BAA8B,CACxDO,UAAU,EACVH,MAAM,EACNe,OAAO,CAACE,MAAM,CAACC,UAAU,EACzBR,cAAc,CAACS,OACjB,CAAC;MACDd,uBAAuB,CAAEe,iBAAiB,KAAM;QAC9C,GAAGA,iBAAiB;QACpB,GAAGJ;MACL,CAAC,CAAC,CAAC;MACHR,qBAAqB,CAAEY,iBAAiB,IAAK;QAC3C,IAAIC,qBAA8C,GAAG,QAAQ;QAC7D,IAAIC,UAA6B;QACjC,MAAMC,kBAEL,GAAG,CAAC,CAAC;QACN,KAAK,MAAMC,GAAG,IAAIR,mBAAmB,EAAE;UACrC,MAAMS,KAAK,GAAGT,mBAAmB,CAACQ,GAAG,CAAC,CAACC,KAAK;UAC5C;UACA,IAAIA,KAAK,CAAChB,IAAI,KAAK,QAAQ,EAAE;YAC3BY,qBAAqB,GAAG,QAAQ;YAChCC,UAAU,GAAGA,UAAU,IAAIG,KAAK,CAACC,KAAK;YACtCH,kBAAkB,CAACC,GAAG,CAAQ,GAAGC,KAAK,CAACA,KAAY;YACnD;UACF;UACA;UACA,IACEA,KAAK,CAAChB,IAAI,KAAK,SAAS,IACrBY,qBAAqB,KAAK,QAAQ,EACrC;YACAA,qBAAqB,GAAG,SAAS;YACjC;UACF;UACA;UACA,IACEI,KAAK,CAAChB,IAAI,KAAK,WAAW,IACvBY,qBAAqB,KAAK,QAAQ,IAClCA,qBAAqB,KAAK,SAAS,EACtC;YACAA,qBAAqB,GAAG,WAAW;YACnCE,kBAAkB,CAACC,GAAG,CAAQ,GAAGC,KAAK,CAACA,KAAY;YACnD;UACF;UACA,IACEA,KAAK,CAAChB,IAAI,KAAK,aAAa,IACzBY,qBAAqB,KAAK,QAAQ,IAClCA,qBAAqB,KAAK,SAAS,IACnCA,qBAAqB,KAAK,WAAW,EACxC;YACAA,qBAAqB,GAAG,aAAa;UACvC;UAEA,IAAII,KAAK,CAAChB,IAAI,KAAK,QAAQ,EAAE;YAC3Bc,kBAAkB,CAACC,GAAG,CAAQ,GAAGC,KAAK,CAACA,KAAY;UACrD;QACF;QACA,MAAME,qBAAqB,GAAGP,iBAAiB,CAACX,IAAI,KAAK,aAAa,IAC/DW,iBAAiB,CAACX,IAAI,KAAK,SAAS,GACvCW,iBAAiB,CAACK,KAAK,GACvB,CAAC,CAAC;QACN,IACEJ,qBAAqB,KAAK,aAAa,IACpCA,qBAAqB,KAAK,SAAS,EACtC;UACA,MAAMO,YAAY,GAAG;YACnB,GAAGD,qBAAqB;YACxB,GAAGJ;UACL,CAAiC;UACjC,OAAOF,qBAAqB,KAAK,QAAQ,GACrC;YACAZ,IAAI,EAAEY,qBAAqB;YAC3BI,KAAK,EAAEG,YAAY;YACnBF,KAAK,EAAEJ,UAAU,IAAI,IAAIO,KAAK,CAAC,2BAA2B;UAC5D,CAAC,GACC;YACApB,IAAI,EAAEY,qBAAqB;YAC3BI,KAAK,EAAEG;UACT,CAAC;QACL,CAAC,MAAM;UACL,OAAO;YAAEnB,IAAI,EAAEY;UAAsB,CAAC;QACxC;MACF,CAAC,CAAC;IACJ,CACF,CAAC;IACDnB,MAAM,CAAC4B,KAAK,CAAC,CAAC;IACd,OAAO,MAAM;MACX5B,MAAM,CAAC6B,WAAW,CAAC,CAAC;IACtB,CAAC;EACH,CAAC,EAAE,EAAE,CAAC;EAEN,oBACExC,KAAA,CAAAyC,aAAA,CAACrC,oBAAoB,CAACsC,QAAQ;IAC5BR,KAAK,EAAE;MACLS,SAAS,EAAEhC,MAAM,CAACgC,SAAS;MAC3BrB,eAAe,EAAEX,MAAM,CAACW,eAAe;MACvCT,oBAAoB;MACpBc,UAAU,EAAE;QACViB,MAAM,EAAE5B,kBAAkB,CAACkB,KAAK,IAAI,CAAC,CAAC;QACtCW,KAAK,EAAE7B,kBAAkB,CAACE;MAC5B;MACA;IACF;EAA+D,GAE9DV,QAC4B,CAAC;AAEpC,CAAC","ignoreList":[]}
|
package/build/esm/context.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"context.js","names":["FoundryHostEventTarget","React","useContext","FoundryWidgetContext","createContext","emitEvent","hostEventTarget","asyncParameterValues","parameters","state","values","useFoundryWidgetContext","_useFoundryWidgetContext","withTypes"],"sources":["context.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 {\n type AsyncParameterValueMap,\n type AsyncValue,\n FoundryHostEventTarget,\n type FoundryWidgetClient,\n type ParameterConfig,\n type ParameterValueMap,\n type WidgetConfig,\n} from \"@osdk/widget.client\";\nimport React, { useContext } from \"react\";\n\nexport interface FoundryWidgetClientContext<\n C extends WidgetConfig<C[\"parameters\"]>,\n> {\n emitEvent: FoundryWidgetClient<C>[\"emitEvent\"];\n hostEventTarget: FoundryHostEventTarget<C>;\n\n /**\n * Object where the individual parameters have their async state represented\n */\n asyncParameterValues:
|
|
1
|
+
{"version":3,"file":"context.js","names":["FoundryHostEventTarget","React","useContext","FoundryWidgetContext","createContext","emitEvent","hostEventTarget","asyncParameterValues","parameters","state","values","useFoundryWidgetContext","_useFoundryWidgetContext","withTypes"],"sources":["context.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 { ObjectSet } from \"@osdk/client\";\nimport type { ObjectType } from \"@osdk/widget.api\";\nimport {\n type AsyncParameterValueMap,\n type AsyncValue,\n FoundryHostEventTarget,\n type FoundryWidgetClient,\n type ParameterConfig,\n type ParameterValueMap,\n type WidgetConfig,\n} from \"@osdk/widget.client\";\nimport React, { useContext } from \"react\";\n\nexport interface FoundryWidgetClientContext<\n C extends WidgetConfig<C[\"parameters\"]>,\n> {\n emitEvent: FoundryWidgetClient<C>[\"emitEvent\"];\n hostEventTarget: FoundryHostEventTarget<C>;\n\n /**\n * Object where the individual parameters have their async state represented\n */\n asyncParameterValues: ExtendedAsyncParameterValueMap<C>;\n\n /**\n * Convenience object that aggregates the value of all parameters, accounting for their loading states\n */\n parameters: {\n values: Partial<ExtendedParameterValueMap<C>>;\n state: AsyncValue<ParameterValueMap<C>>[\"type\"];\n };\n}\n\nexport type ExtendedParameterValueMap<C extends WidgetConfig<C[\"parameters\"]>> =\n {\n [K in keyof C[\"parameters\"]]: K extends keyof ParameterValueMap<C>\n ? C[\"parameters\"][K] extends { type: \"objectSet\"; objectType: infer T }\n ? T extends ObjectType\n ? ParameterValueMap<C>[K] & { objectSet: ObjectSet<T> }\n : ParameterValueMap<C>[K]\n : ParameterValueMap<C>[K]\n : never;\n };\n\nexport type ExtendedAsyncParameterValueMap<\n C extends WidgetConfig<C[\"parameters\"]>,\n> = {\n [K in keyof C[\"parameters\"]]: K extends keyof AsyncParameterValueMap<C>\n ? C[\"parameters\"][K] extends { type: \"objectSet\"; objectType: infer T }\n ? T extends ObjectType ? AsyncParameterValueMap<C>[K] & {\n value: AsyncValue<\n ParameterValueMap<C>[K] & { objectSet: ObjectSet<T> }\n >;\n }\n : AsyncParameterValueMap<C>[K]\n : AsyncParameterValueMap<C>[K]\n : never;\n};\n\nexport const FoundryWidgetContext: React.Context<\n FoundryWidgetClientContext<WidgetConfig<ParameterConfig>>\n> = React.createContext<\n FoundryWidgetClientContext<WidgetConfig<ParameterConfig>>\n>({\n emitEvent: () => {},\n hostEventTarget: new FoundryHostEventTarget<WidgetConfig<ParameterConfig>>(),\n asyncParameterValues: {},\n parameters: {\n state: \"not-started\",\n values: {},\n },\n});\n\n/**\n * @returns The current FoundryWidgetClientContext, in the context of your specific parameter configuration\n */\nexport function useFoundryWidgetContext<\n C extends WidgetConfig<C[\"parameters\"]>,\n>() {\n return useContext(FoundryWidgetContext) as FoundryWidgetClientContext<C>;\n}\n\nexport namespace useFoundryWidgetContext {\n export function withTypes<\n C extends WidgetConfig<C[\"parameters\"]>,\n >(): () => FoundryWidgetClientContext<C> {\n return () => {\n return useFoundryWidgetContext<C>();\n };\n }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,SAGEA,sBAAsB,QAKjB,qBAAqB;AAC5B,OAAOC,KAAK,IAAIC,UAAU,QAAQ,OAAO;AAgDzC,OAAO,MAAMC,oBAEZ,gBAAGF,KAAK,CAACG,aAAa,CAErB;EACAC,SAAS,EAAEA,CAAA,KAAM,CAAC,CAAC;EACnBC,eAAe,EAAE,IAAIN,sBAAsB,CAAgC,CAAC;EAC5EO,oBAAoB,EAAE,CAAC,CAAC;EACxBC,UAAU,EAAE;IACVC,KAAK,EAAE,aAAa;IACpBC,MAAM,EAAE,CAAC;EACX;AACF,CAAC,CAAC;;AAEF;AACA;AACA;AACA,OAAO,SAASC,uBAAuBA,CAAA,EAEnC;EACF,OAAOT,UAAU,CAACC,oBAAoB,CAAC;AACzC;AAAC,WAAAS,wBAAA;EAAAA,wBAAA,CAAAC,SAAA,GAGQ,YAEkC;IACvC,OAAO,MAAM;MACX,OAAOF,uBAAuB,CAAI,CAAC;IACrC,CAAC;EACH,CAAC;AAAA,GAPcA,uBAAuB,KAAvBA,uBAAuB","ignoreList":[]}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2025 Palantir Technologies, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import { hydrateObjectSetFromRid } from "@osdk/client/internal";
|
|
18
|
+
/**
|
|
19
|
+
* Patches parameter values with hydrated object sets for object set parameters.
|
|
20
|
+
*
|
|
21
|
+
* The cache is used to avoid redundant hydration of the same object set RID, which
|
|
22
|
+
* can cause unnecessary re-renders in React components consuming the parameters.
|
|
23
|
+
*/
|
|
24
|
+
export function extendParametersWithObjectSets(osdkClient, config, parameters, cache) {
|
|
25
|
+
const extendedParameters = {
|
|
26
|
+
...parameters
|
|
27
|
+
};
|
|
28
|
+
for (const parameterId of Object.keys(extendedParameters)) {
|
|
29
|
+
const param = config.parameters[parameterId];
|
|
30
|
+
if (param.type === "objectSet" && extendedParameters[parameterId].type === "objectSet") {
|
|
31
|
+
const parameterValue = extendedParameters[parameterId].value.value;
|
|
32
|
+
if (parameterValue != null) {
|
|
33
|
+
if (typeof parameterValue === "object" && "objectSetRid" in parameterValue && typeof parameterValue.objectSetRid === "string") {
|
|
34
|
+
const objectSetRid = parameterValue.objectSetRid;
|
|
35
|
+
const objectSet = getOrHydrateObjectSet(osdkClient, cache, parameterId, objectSetRid, param.objectType);
|
|
36
|
+
parameterValue.objectSet = objectSet;
|
|
37
|
+
} else {
|
|
38
|
+
throw new Error(`Invalid object set parameter value for parameter "${parameterId}"`);
|
|
39
|
+
}
|
|
40
|
+
} else {
|
|
41
|
+
cache.delete(parameterId);
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
return extendedParameters;
|
|
46
|
+
}
|
|
47
|
+
function getOrHydrateObjectSet(osdkClient, cache, paramKey, objectSetRid, definition) {
|
|
48
|
+
if (osdkClient == null) {
|
|
49
|
+
throw new Error("Not provided an OSDK client");
|
|
50
|
+
}
|
|
51
|
+
const cached = cache.get(paramKey);
|
|
52
|
+
if (cached?.objectSetRid === objectSetRid) {
|
|
53
|
+
return cached.objectSet;
|
|
54
|
+
}
|
|
55
|
+
const objectSet = hydrateObjectSetFromRid(osdkClient, definition, objectSetRid);
|
|
56
|
+
cache.set(paramKey, {
|
|
57
|
+
objectSetRid,
|
|
58
|
+
objectSet
|
|
59
|
+
});
|
|
60
|
+
return objectSet;
|
|
61
|
+
}
|
|
62
|
+
//# sourceMappingURL=extendParametersWithObjectSets.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extendParametersWithObjectSets.js","names":["hydrateObjectSetFromRid","extendParametersWithObjectSets","osdkClient","config","parameters","cache","extendedParameters","parameterId","Object","keys","param","type","parameterValue","value","objectSetRid","objectSet","getOrHydrateObjectSet","objectType","Error","delete","paramKey","definition","cached","get","set"],"sources":["extendParametersWithObjectSets.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Client, ObjectSet, ObjectTypeDefinition } from \"@osdk/client\";\nimport { hydrateObjectSetFromRid } from \"@osdk/client/internal\";\nimport type { AsyncParameterValueMap, WidgetConfig } from \"@osdk/widget.api\";\nimport type { ExtendedAsyncParameterValueMap } from \"../context.js\";\n\n/**\n * Patches parameter values with hydrated object sets for object set parameters.\n *\n * The cache is used to avoid redundant hydration of the same object set RID, which\n * can cause unnecessary re-renders in React components consuming the parameters.\n */\nexport function extendParametersWithObjectSets<\n C extends WidgetConfig<C[\"parameters\"]>,\n>(\n osdkClient: Client | undefined,\n config: C,\n parameters: AsyncParameterValueMap<C>,\n cache: Map<string, { objectSetRid: string; objectSet: ObjectSet }>,\n): ExtendedAsyncParameterValueMap<C> {\n const extendedParameters = {\n ...parameters,\n } as ExtendedAsyncParameterValueMap<C>;\n\n for (const parameterId of Object.keys(extendedParameters)) {\n const param = config.parameters[parameterId];\n if (\n param.type === \"objectSet\"\n && extendedParameters[parameterId].type === \"objectSet\"\n ) {\n const parameterValue = extendedParameters[parameterId].value.value;\n if (parameterValue != null) {\n if (\n typeof parameterValue === \"object\"\n && \"objectSetRid\" in parameterValue\n && typeof parameterValue.objectSetRid === \"string\"\n ) {\n const objectSetRid = parameterValue.objectSetRid;\n const objectSet = getOrHydrateObjectSet(\n osdkClient,\n cache,\n parameterId,\n objectSetRid,\n param.objectType as ObjectTypeDefinition,\n );\n (parameterValue as any).objectSet = objectSet;\n } else {\n throw new Error(\n `Invalid object set parameter value for parameter \"${parameterId}\"`,\n );\n }\n } else {\n cache.delete(parameterId);\n }\n }\n }\n\n return extendedParameters;\n}\n\nfunction getOrHydrateObjectSet<T extends ObjectTypeDefinition>(\n osdkClient: Client | undefined,\n cache: Map<string, { objectSetRid: string; objectSet: ObjectSet<T> }>,\n paramKey: string,\n objectSetRid: string,\n definition: T,\n) {\n if (osdkClient == null) {\n throw new Error(\"Not provided an OSDK client\");\n }\n const cached = cache.get(paramKey);\n if (cached?.objectSetRid === objectSetRid) {\n return cached.objectSet;\n }\n const objectSet = hydrateObjectSetFromRid(\n osdkClient,\n definition,\n objectSetRid,\n );\n cache.set(paramKey, { objectSetRid, objectSet });\n return objectSet;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,uBAAuB,QAAQ,uBAAuB;AAI/D;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,8BAA8BA,CAG5CC,UAA8B,EAC9BC,MAAS,EACTC,UAAqC,EACrCC,KAAkE,EAC/B;EACnC,MAAMC,kBAAkB,GAAG;IACzB,GAAGF;EACL,CAAsC;EAEtC,KAAK,MAAMG,WAAW,IAAIC,MAAM,CAACC,IAAI,CAACH,kBAAkB,CAAC,EAAE;IACzD,MAAMI,KAAK,GAAGP,MAAM,CAACC,UAAU,CAACG,WAAW,CAAC;IAC5C,IACEG,KAAK,CAACC,IAAI,KAAK,WAAW,IACvBL,kBAAkB,CAACC,WAAW,CAAC,CAACI,IAAI,KAAK,WAAW,EACvD;MACA,MAAMC,cAAc,GAAGN,kBAAkB,CAACC,WAAW,CAAC,CAACM,KAAK,CAACA,KAAK;MAClE,IAAID,cAAc,IAAI,IAAI,EAAE;QAC1B,IACE,OAAOA,cAAc,KAAK,QAAQ,IAC/B,cAAc,IAAIA,cAAc,IAChC,OAAOA,cAAc,CAACE,YAAY,KAAK,QAAQ,EAClD;UACA,MAAMA,YAAY,GAAGF,cAAc,CAACE,YAAY;UAChD,MAAMC,SAAS,GAAGC,qBAAqB,CACrCd,UAAU,EACVG,KAAK,EACLE,WAAW,EACXO,YAAY,EACZJ,KAAK,CAACO,UACR,CAAC;UACAL,cAAc,CAASG,SAAS,GAAGA,SAAS;QAC/C,CAAC,MAAM;UACL,MAAM,IAAIG,KAAK,CACb,qDAAqDX,WAAW,GAClE,CAAC;QACH;MACF,CAAC,MAAM;QACLF,KAAK,CAACc,MAAM,CAACZ,WAAW,CAAC;MAC3B;IACF;EACF;EAEA,OAAOD,kBAAkB;AAC3B;AAEA,SAASU,qBAAqBA,CAC5Bd,UAA8B,EAC9BG,KAAqE,EACrEe,QAAgB,EAChBN,YAAoB,EACpBO,UAAa,EACb;EACA,IAAInB,UAAU,IAAI,IAAI,EAAE;IACtB,MAAM,IAAIgB,KAAK,CAAC,6BAA6B,CAAC;EAChD;EACA,MAAMI,MAAM,GAAGjB,KAAK,CAACkB,GAAG,CAACH,QAAQ,CAAC;EAClC,IAAIE,MAAM,EAAER,YAAY,KAAKA,YAAY,EAAE;IACzC,OAAOQ,MAAM,CAACP,SAAS;EACzB;EACA,MAAMA,SAAS,GAAGf,uBAAuB,CACvCE,UAAU,EACVmB,UAAU,EACVP,YACF,CAAC;EACDT,KAAK,CAACmB,GAAG,CAACJ,QAAQ,EAAE;IAAEN,YAAY;IAAEC;EAAU,CAAC,CAAC;EAChD,OAAOA,SAAS;AAClB","ignoreList":[]}
|