@osdk/client 2.61.0-main-c742209e719ed5ad879076a91bcf383a88bb623f → 2.61.0
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 +10 -6
- package/build/browser/Client.js.map +1 -1
- package/build/browser/createClient.js +12 -1
- package/build/browser/createClient.js.map +1 -1
- package/build/browser/objectSet/LinkSubscriptionWebsocket.js +225 -0
- package/build/browser/objectSet/LinkSubscriptionWebsocket.js.map +1 -0
- package/build/browser/objectSet/MockWebSocket.js +58 -0
- package/build/browser/objectSet/MockWebSocket.js.map +1 -0
- package/build/browser/objectSet/ObjectSetListenerWebsocket.js +77 -308
- package/build/browser/objectSet/ObjectSetListenerWebsocket.js.map +1 -1
- package/build/browser/objectSet/SubscriptionWebsocket.js +259 -0
- package/build/browser/objectSet/SubscriptionWebsocket.js.map +1 -0
- package/build/browser/objectSet/websocketUtils.js +55 -0
- package/build/browser/objectSet/websocketUtils.js.map +1 -0
- package/build/browser/util/UserAgent.js +2 -2
- package/build/browser/util/UserAgent.js.map +1 -1
- package/build/cjs/{Client-ClFX5q-o.d.cts → Client-BMQ0XiuQ.d.cts} +1 -1
- package/build/cjs/LinkSubscriptionWebsocket-4Q6Y5GMF.cjs +215 -0
- package/build/cjs/LinkSubscriptionWebsocket-4Q6Y5GMF.cjs.map +1 -0
- package/build/cjs/ObjectSetListenerWebsocket-F7SQAZQF.cjs +14 -0
- package/build/cjs/{ObjectSetListenerWebsocket-FCRXEEMH.cjs.map → ObjectSetListenerWebsocket-F7SQAZQF.cjs.map} +1 -1
- package/build/cjs/{applyStreamingQuery-XVCEQR5M.cjs → applyStreamingQuery-LWMQIM2A.cjs} +8 -8
- package/build/cjs/{applyStreamingQuery-XVCEQR5M.cjs.map → applyStreamingQuery-LWMQIM2A.cjs.map} +1 -1
- package/build/cjs/{chunk-PCEWDDZH.cjs → chunk-6PYKTSSA.cjs} +59 -48
- package/build/cjs/chunk-6PYKTSSA.cjs.map +1 -0
- package/build/cjs/{chunk-TLF57A6A.cjs → chunk-7OV445PV.cjs} +13 -13
- package/build/cjs/{chunk-TLF57A6A.cjs.map → chunk-7OV445PV.cjs.map} +1 -1
- package/build/cjs/chunk-KTZGY72C.cjs +283 -0
- package/build/cjs/chunk-KTZGY72C.cjs.map +1 -0
- package/build/cjs/{chunk-OF32UWWG.cjs → chunk-OED5MHLX.cjs} +3 -3
- package/build/cjs/{chunk-OF32UWWG.cjs.map → chunk-OED5MHLX.cjs.map} +1 -1
- package/build/cjs/{chunk-J6TKWB4H.cjs → chunk-P6T2ZSKG.cjs} +8 -8
- package/build/cjs/{chunk-J6TKWB4H.cjs.map → chunk-P6T2ZSKG.cjs.map} +1 -1
- package/build/cjs/chunk-WJMJDOZQ.cjs +334 -0
- package/build/cjs/chunk-WJMJDOZQ.cjs.map +1 -0
- package/build/cjs/{chunk-VWYKCAH2.cjs → chunk-Z7JGRZFA.cjs} +80 -80
- package/build/cjs/{chunk-VWYKCAH2.cjs.map → chunk-Z7JGRZFA.cjs.map} +1 -1
- package/build/cjs/{createClient-DXxUN4kV.d.cts → createClient-DN8qGXVs.d.cts} +1 -1
- package/build/cjs/index.cjs +13 -12
- package/build/cjs/index.cjs.map +1 -1
- package/build/cjs/index.d.cts +2 -2
- package/build/cjs/public/experimental.cjs +11 -10
- package/build/cjs/public/experimental.cjs.map +1 -1
- package/build/cjs/public/experimental.d.cts +3 -3
- package/build/cjs/public/internal.cjs +7 -7
- package/build/cjs/public/internal.d.cts +1 -1
- package/build/cjs/public/observable.cjs +7 -6
- package/build/cjs/public/observable.d.cts +2 -2
- package/build/cjs/public/unstable-do-not-use.cjs +18 -17
- package/build/cjs/public/unstable-do-not-use.cjs.map +1 -1
- package/build/cjs/public/unstable-do-not-use.d.cts +4 -4
- package/build/cjs/{withScenario-CBe_jZoM.d.cts → withScenario-CJN1flg_.d.cts} +1 -1
- package/build/esm/Client.js.map +1 -1
- package/build/esm/createClient.js +12 -1
- package/build/esm/createClient.js.map +1 -1
- package/build/esm/objectSet/LinkSubscriptionWebsocket.js +225 -0
- package/build/esm/objectSet/LinkSubscriptionWebsocket.js.map +1 -0
- package/build/esm/objectSet/MockWebSocket.js +58 -0
- package/build/esm/objectSet/MockWebSocket.js.map +1 -0
- package/build/esm/objectSet/ObjectSetListenerWebsocket.js +77 -308
- package/build/esm/objectSet/ObjectSetListenerWebsocket.js.map +1 -1
- package/build/esm/objectSet/SubscriptionWebsocket.js +259 -0
- package/build/esm/objectSet/SubscriptionWebsocket.js.map +1 -0
- package/build/esm/objectSet/websocketUtils.js +55 -0
- package/build/esm/objectSet/websocketUtils.js.map +1 -0
- package/build/esm/util/UserAgent.js +2 -2
- package/build/esm/util/UserAgent.js.map +1 -1
- package/build/types/Client.d.ts +1 -1
- package/build/types/Client.d.ts.map +1 -1
- package/build/types/createClient.d.ts.map +1 -1
- package/build/types/objectSet/LinkSubscriptionWebsocket.d.ts +1 -0
- package/build/types/objectSet/LinkSubscriptionWebsocket.d.ts.map +1 -0
- package/build/types/objectSet/MockWebSocket.d.ts +14 -0
- package/build/types/objectSet/MockWebSocket.d.ts.map +1 -0
- package/build/types/objectSet/SubscriptionWebsocket.d.ts +9 -0
- package/build/types/objectSet/SubscriptionWebsocket.d.ts.map +1 -0
- package/build/types/objectSet/websocketUtils.d.ts +7 -0
- package/build/types/objectSet/websocketUtils.d.ts.map +1 -0
- package/package.json +9 -9
- package/build/cjs/ObjectSetListenerWebsocket-FCRXEEMH.cjs +0 -17
- package/build/cjs/chunk-I2SCCYG7.cjs +0 -554
- package/build/cjs/chunk-I2SCCYG7.cjs.map +0 -1
- package/build/cjs/chunk-PCEWDDZH.cjs.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,18 +1,22 @@
|
|
|
1
1
|
# @osdk/client
|
|
2
2
|
|
|
3
|
-
## 2.61.0
|
|
3
|
+
## 2.61.0
|
|
4
4
|
|
|
5
|
-
###
|
|
5
|
+
### Minor Changes
|
|
6
6
|
|
|
7
|
+
- bdf45fa: Add experimental subscriptions for directed link changes between selected objects.
|
|
7
8
|
- 34cb7e0: Type the OCR and transcription language parameters on the experimental media transformation surface as the closed enums the platform actually declares, and export the encoding types that were previously unreachable.
|
|
8
9
|
|
|
9
10
|
These four parameters were previously `string`, so this narrows a shipped public type on the `@osdk/api/unstable` entrypoint. Existing call sites holding a `string` in those positions no longer compile, and a language the pinned platform SDK does not list must be cast until the pin moves.
|
|
10
11
|
|
|
12
|
+
### Patch Changes
|
|
13
|
+
|
|
14
|
+
- Updated dependencies [bdf45fa]
|
|
11
15
|
- Updated dependencies [34cb7e0]
|
|
12
|
-
- @osdk/api@2.61.0
|
|
13
|
-
- @osdk/generator-converters@2.61.0
|
|
14
|
-
- @osdk/shared.test@2.
|
|
15
|
-
- @osdk/client.unstable@2.61.0
|
|
16
|
+
- @osdk/api@2.61.0
|
|
17
|
+
- @osdk/generator-converters@2.61.0
|
|
18
|
+
- @osdk/shared.test@2.41.0
|
|
19
|
+
- @osdk/client.unstable@2.61.0
|
|
16
20
|
|
|
17
21
|
## 2.60.0
|
|
18
22
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Client.js","names":["additionalContext","Symbol","MaxOsdkVersion","ErrorMessage"],"sources":["Client.ts"],"sourcesContent":["/*\n * Copyright 2023 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 ActionDefinition,\n ActionMetadata,\n CompileTimeMetadata,\n InterfaceDefinition,\n InterfaceMetadata,\n ObjectMetadata,\n ObjectSet,\n ObjectTypeDefinition,\n QueryDefinition,\n QueryMetadata,\n VersionBound,\n} from \"@osdk/api\";\nimport type {\n Experiment,\n ExperimentFns,\n MinimalObjectSet,\n} from \"@osdk/api/unstable\";\nimport type { SharedClient } from \"@osdk/shared.client2\";\n\nimport type { ActionSignatureFromDef } from \"./actions/applyAction.js\";\nimport type { MinimalClient } from \"./MinimalClientContext.js\";\nimport type { QuerySignatureFromDef } from \"./queries/types.js\";\nimport type { SatisfiesSemver } from \"./SatisfiesSemver.js\";\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-imports\ntype OldSharedClient = import(\"@osdk/shared.client\").SharedClient;\n\nexport type CheckVersionBound<Q> =\n Q extends VersionBound<infer V>\n ? SatisfiesSemver<V, MaxOsdkVersion> extends true\n ? Q\n : Q & {\n [ErrorMessage]: `Your SDK requires a semver compatible version with ${V}. You have ${MaxOsdkVersion}. Update your package.json`;\n }\n : Q;\n\nexport interface Client extends SharedClient, OldSharedClient {\n /**\n * Returns the operation surface for the given ontology definition. The shape of the\n * returned value is dispatched on what kind of definition is passed:\n * - object type → the object set type for that ontology object (typically a generated extension of {@link ObjectSet})\n * - interface → a {@link MinimalObjectSet} for the interface\n * - action → a callable with `applyAction` / `batchApplyAction`\n * - query → a callable with `executeFunction`\n * - experiment → the unstable feature surface for that experiment\n *\n * @param o - The object type definition to wrap.\n * @example\n * ```ts\n * const employees = await client(Employee).fetchPage({ $pageSize: 30 });\n * const employee = await client(Employee).fetchOne(12345);\n * ```\n * @returns an object set scoped to all objects of this type.\n */\n <Q extends ObjectTypeDefinition>(\n o: Q,\n ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"]\n ? ObjectSet<Q>\n : CompileTimeMetadata<Q>[\"objectSet\"];\n\n /**\n * @param o - The interface definition to wrap.\n * @example\n * ```ts\n * const page = await client(MyInterface).fetchPage({ $pageSize: 30 });\n * ```\n * @returns a minimal object set over all objects implementing the interface.\n */\n <Q extends InterfaceDefinition>(\n o: Q,\n ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"]\n ? MinimalObjectSet<Q>\n : CompileTimeMetadata<Q>[\"objectSet\"];\n\n /**\n * @param o - The action definition to invoke.\n * @example\n * ```ts\n * const result = await client(createEmployee).applyAction(\n * { name: \"Jane\", department: \"Engineering\" },\n * { $returnEdits: true },\n * );\n * ```\n * @returns a callable for applying (or batch-applying) the action.\n */\n <Q extends ActionDefinition<any>>(o: Q): ActionSignatureFromDef<Q>;\n\n /**\n * @param o - The query definition to invoke.\n * @example\n * ```ts\n * const result = await client(getEmployeeCount).executeFunction({ department: \"Engineering\" });\n * ```\n * @returns a callable for executing the query function.\n */\n <Q extends QueryDefinition<any>>(o: Q): QuerySignatureFromDef<Q>;\n\n /**\n * @param experiment - The experiment marker that gates an unstable feature.\n * @example\n * ```ts\n * const employee = await client(__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid)\n * .fetchOneByRid(Employee, \"ri.phonograph2-objects.main.object.1234\");\n * ```\n * @returns the experiment-specific function surface.\n */\n <\n Q extends\n | Experiment<\"2.0.8\">\n | Experiment<\"2.1.0\">\n | Experiment<\"2.2.0\">\n | Experiment<\"2.8.0\">\n | Experiment<\"2.19.0\">,\n >(\n experiment: Q,\n ): ExperimentFns<Q>;\n\n /**\n * Fetches runtime metadata for the given ontology definition. The returned shape\n * is dispatched on the kind of definition passed: {@link ObjectMetadata},\n * {@link InterfaceMetadata}, {@link ActionMetadata}, or {@link QueryMetadata}.\n * @param o - The object type, interface, action, or query definition to look up.\n * @example\n * ```ts\n * const meta = await client.fetchMetadata(Employee);\n * console.log(meta.displayName, meta.description);\n * ```\n * @returns a promise resolving to the metadata for the given definition.\n */\n fetchMetadata<\n Q extends\n | ObjectTypeDefinition\n | InterfaceDefinition\n | ActionDefinition<any>\n | QueryDefinition<any>,\n >(\n o: Q,\n ): Promise<\n Q extends ObjectTypeDefinition\n ? ObjectMetadata\n : Q extends InterfaceDefinition\n ? InterfaceMetadata\n : Q extends ActionDefinition<any>\n ? ActionMetadata\n : Q extends QueryDefinition<any>\n ? QueryMetadata\n : never\n >;\n\n /** @internal */\n [additionalContext]: MinimalClient;\n}\n\n// DO NOT EXPORT FROM PACKAGE\n/** @internal */\nexport const additionalContext: unique symbol = Symbol(\"additionalContext\");\n\n// BEGIN: THIS IS GENERATED CODE. DO NOT EDIT.\nconst MaxOsdkVersion = \"2.61.0\";\n// END: THIS IS GENERATED CODE. DO NOT EDIT.\nexport type MaxOsdkVersion = typeof MaxOsdkVersion;\nconst ErrorMessage: unique symbol = Symbol(\"ErrorMessage\");\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA2BA;;
|
|
1
|
+
{"version":3,"file":"Client.js","names":["additionalContext","Symbol","MaxOsdkVersion","ErrorMessage"],"sources":["Client.ts"],"sourcesContent":["/*\n * Copyright 2023 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 ActionDefinition,\n ActionMetadata,\n CompileTimeMetadata,\n InterfaceDefinition,\n InterfaceMetadata,\n ObjectMetadata,\n ObjectSet,\n ObjectTypeDefinition,\n QueryDefinition,\n QueryMetadata,\n VersionBound,\n} from \"@osdk/api\";\nimport type {\n Experiment,\n ExperimentFns,\n MinimalObjectSet,\n} from \"@osdk/api/unstable\";\nimport type { SharedClient } from \"@osdk/shared.client2\";\n\nimport type { ActionSignatureFromDef } from \"./actions/applyAction.js\";\nimport type { MinimalClient } from \"./MinimalClientContext.js\";\nimport type { QuerySignatureFromDef } from \"./queries/types.js\";\nimport type { SatisfiesSemver } from \"./SatisfiesSemver.js\";\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-imports\ntype OldSharedClient = import(\"@osdk/shared.client\").SharedClient;\n\nexport type CheckVersionBound<Q> =\n Q extends VersionBound<infer V>\n ? SatisfiesSemver<V, MaxOsdkVersion> extends true\n ? Q\n : Q & {\n [ErrorMessage]: `Your SDK requires a semver compatible version with ${V}. You have ${MaxOsdkVersion}. Update your package.json`;\n }\n : Q;\n\nexport interface Client extends SharedClient, OldSharedClient {\n /**\n * Returns the operation surface for the given ontology definition. The shape of the\n * returned value is dispatched on what kind of definition is passed:\n * - object type → the object set type for that ontology object (typically a generated extension of {@link ObjectSet})\n * - interface → a {@link MinimalObjectSet} for the interface\n * - action → a callable with `applyAction` / `batchApplyAction`\n * - query → a callable with `executeFunction`\n * - experiment → the unstable feature surface for that experiment\n *\n * @param o - The object type definition to wrap.\n * @example\n * ```ts\n * const employees = await client(Employee).fetchPage({ $pageSize: 30 });\n * const employee = await client(Employee).fetchOne(12345);\n * ```\n * @returns an object set scoped to all objects of this type.\n */\n <Q extends ObjectTypeDefinition>(\n o: Q,\n ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"]\n ? ObjectSet<Q>\n : CompileTimeMetadata<Q>[\"objectSet\"];\n\n /**\n * @param o - The interface definition to wrap.\n * @example\n * ```ts\n * const page = await client(MyInterface).fetchPage({ $pageSize: 30 });\n * ```\n * @returns a minimal object set over all objects implementing the interface.\n */\n <Q extends InterfaceDefinition>(\n o: Q,\n ): unknown extends CompileTimeMetadata<Q>[\"objectSet\"]\n ? MinimalObjectSet<Q>\n : CompileTimeMetadata<Q>[\"objectSet\"];\n\n /**\n * @param o - The action definition to invoke.\n * @example\n * ```ts\n * const result = await client(createEmployee).applyAction(\n * { name: \"Jane\", department: \"Engineering\" },\n * { $returnEdits: true },\n * );\n * ```\n * @returns a callable for applying (or batch-applying) the action.\n */\n <Q extends ActionDefinition<any>>(o: Q): ActionSignatureFromDef<Q>;\n\n /**\n * @param o - The query definition to invoke.\n * @example\n * ```ts\n * const result = await client(getEmployeeCount).executeFunction({ department: \"Engineering\" });\n * ```\n * @returns a callable for executing the query function.\n */\n <Q extends QueryDefinition<any>>(o: Q): QuerySignatureFromDef<Q>;\n\n /**\n * @param experiment - The experiment marker that gates an unstable feature.\n * @example\n * ```ts\n * const employee = await client(__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid)\n * .fetchOneByRid(Employee, \"ri.phonograph2-objects.main.object.1234\");\n * ```\n * @returns the experiment-specific function surface.\n */\n <\n Q extends\n | Experiment<\"2.0.8\">\n | Experiment<\"2.1.0\">\n | Experiment<\"2.59.0\">\n | Experiment<\"2.2.0\">\n | Experiment<\"2.8.0\">\n | Experiment<\"2.19.0\">,\n >(\n experiment: Q,\n ): ExperimentFns<Q>;\n\n /**\n * Fetches runtime metadata for the given ontology definition. The returned shape\n * is dispatched on the kind of definition passed: {@link ObjectMetadata},\n * {@link InterfaceMetadata}, {@link ActionMetadata}, or {@link QueryMetadata}.\n * @param o - The object type, interface, action, or query definition to look up.\n * @example\n * ```ts\n * const meta = await client.fetchMetadata(Employee);\n * console.log(meta.displayName, meta.description);\n * ```\n * @returns a promise resolving to the metadata for the given definition.\n */\n fetchMetadata<\n Q extends\n | ObjectTypeDefinition\n | InterfaceDefinition\n | ActionDefinition<any>\n | QueryDefinition<any>,\n >(\n o: Q,\n ): Promise<\n Q extends ObjectTypeDefinition\n ? ObjectMetadata\n : Q extends InterfaceDefinition\n ? InterfaceMetadata\n : Q extends ActionDefinition<any>\n ? ActionMetadata\n : Q extends QueryDefinition<any>\n ? QueryMetadata\n : never\n >;\n\n /** @internal */\n [additionalContext]: MinimalClient;\n}\n\n// DO NOT EXPORT FROM PACKAGE\n/** @internal */\nexport const additionalContext: unique symbol = Symbol(\"additionalContext\");\n\n// BEGIN: THIS IS GENERATED CODE. DO NOT EDIT.\nconst MaxOsdkVersion = \"2.61.0\";\n// END: THIS IS GENERATED CODE. DO NOT EDIT.\nexport type MaxOsdkVersion = typeof MaxOsdkVersion;\nconst ErrorMessage: unique symbol = Symbol(\"ErrorMessage\");\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA2BA;;AAkIA;AACA;AACA,OAAO,MAAMA,iBAAgC,GAAGC,MAAM,CAAC,mBAAmB,CAAC;;AAE3E;AACA,MAAMC,cAAc,GAAG,QAAQ;AAC/B;;AAEA,MAAMC,YAA2B,GAAGF,MAAM,CAAC,cAAc,CAAC","ignoreList":[]}
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
|
-
import { __EXPERIMENTAL__NOT_SUPPORTED_YET__executeStreamingFunction, __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid, __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid, __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks, __EXPERIMENTAL__NOT_SUPPORTED_YET__subscribeToNoTypeObjectSet, transformAndWait } from "@osdk/api/unstable";
|
|
17
|
+
import { __EXPERIMENTAL__NOT_SUPPORTED_YET__executeStreamingFunction, __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid, __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid, __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks, __EXPERIMENTAL__NOT_SUPPORTED_YET__linkSubscriptions, __EXPERIMENTAL__NOT_SUPPORTED_YET__subscribeToNoTypeObjectSet, transformAndWait } from "@osdk/api/unstable";
|
|
18
18
|
import { symbolClientContext as oldSymbolClientContext } from "@osdk/shared.client";
|
|
19
19
|
import { applyAction } from "./actions/applyAction.js";
|
|
20
20
|
import { additionalContext } from "./Client.js";
|
|
@@ -111,6 +111,17 @@ export function createClientFromContext(clientCtx) {
|
|
|
111
111
|
yield* createBulkLinksAsyncIterFactory(clientCtx)(objs, linkTypes);
|
|
112
112
|
}
|
|
113
113
|
};
|
|
114
|
+
case __EXPERIMENTAL__NOT_SUPPORTED_YET__linkSubscriptions.name:
|
|
115
|
+
return {
|
|
116
|
+
subscribeToLinks: (objectType, args) => {
|
|
117
|
+
const pendingSubscription = import("./objectSet/LinkSubscriptionWebsocket.js").then(({
|
|
118
|
+
LinkSubscriptionWebsocket
|
|
119
|
+
}) => LinkSubscriptionWebsocket.getInstance(clientCtx).subscribe(objectType, args));
|
|
120
|
+
return {
|
|
121
|
+
unsubscribe: async () => (await pendingSubscription)()
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
};
|
|
114
125
|
case __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid.name:
|
|
115
126
|
return {
|
|
116
127
|
fetchOneByRid: async (objectType, rid, options) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createClient.js","names":["__EXPERIMENTAL__NOT_SUPPORTED_YET__executeStreamingFunction","__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid","__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid","__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks","__EXPERIMENTAL__NOT_SUPPORTED_YET__subscribeToNoTypeObjectSet","transformAndWait","symbolClientContext","oldSymbolClientContext","applyAction","additionalContext","createMinimalClient","fetchMetadataInternal","makeMediaTransformation","MinimalLogger","fetchPage","fetchStaticRidPage","fetchSingle","createObjectSet","ObjectSetListenerWebsocket","applyQuery","ActionInvoker","constructor","clientCtx","actionDef","bind","undefined","batchApplyAction","QueryInvoker","queryDef","executeFunction","createClientInternal","objectSetFactory","transactionRid","flushEdits","scenarioRid","subscribeConnectionFn","baseUrl","ontologyRid","tokenProvider","options","fetchFn","fetch","startsWith","Error","then","logger","transactionId","branch","UNSTABLE_DO_NOT_USE_BRANCH","createSubscriptionConnection","createClientFromContext","fetchMetadata","client","Object","defineProperties","o","type","name","executeStreamingFunction","query","params","applyStreamingQuery","getBulkLinks","objs","linkTypes","createBulkLinksAsyncIterFactory","fetchOneByRid","objectType","rid","createWithRid","fetchPageByRid","objectOrInterfaceType","rids","fetchPageByRidNoType","subscribeToNoTypeObjectSet","listener","opts","unsubscribe","getInstance","subscribeWithoutType","reference","includeRid","args","transformAndWaitInternal","mediaSetRid","mediaItemRid","token","media","getMediaReference","mediaSetViewItem","transformation","value","createClient","createClientWithTransaction","createClientWithSubscriptionConnection","createClientWithScenario","objects"],"sources":["createClient.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 {\n ActionDefinition,\n FetchPageArgs,\n InterfaceDefinition,\n Logger,\n Media,\n NullabilityAdherence,\n ObjectOrInterfaceDefinition,\n ObjectSet,\n ObjectSetSubscription,\n ObjectTypeDefinition,\n Osdk,\n OsdkBase,\n PropertyKeys,\n QueryDefinition,\n SelectArg,\n} from \"@osdk/api\";\nimport type {\n Experiment,\n ExperimentFns,\n MediaTransformation,\n MinimalObjectSet,\n TransformOptions,\n} from \"@osdk/api/unstable\";\nimport {\n __EXPERIMENTAL__NOT_SUPPORTED_YET__executeStreamingFunction,\n __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid,\n __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid,\n __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks,\n __EXPERIMENTAL__NOT_SUPPORTED_YET__subscribeToNoTypeObjectSet,\n transformAndWait,\n} from \"@osdk/api/unstable\";\nimport type { ObjectSet as WireObjectSet } from \"@osdk/foundry.ontologies\";\nimport { symbolClientContext as oldSymbolClientContext } from \"@osdk/shared.client\";\n\nimport type { ActionSignatureFromDef } from \"./actions/applyAction.js\";\nimport { applyAction } from \"./actions/applyAction.js\";\nimport { additionalContext, type Client } from \"./Client.js\";\nimport { createMinimalClient } from \"./createMinimalClient.js\";\nimport { fetchMetadataInternal } from \"./fetchMetadata.js\";\nimport { makeMediaTransformation } from \"./internal/conversions/makeMediaTransformation.js\";\nimport { MinimalLogger } from \"./logger/MinimalLogger.js\";\nimport type { MinimalClient } from \"./MinimalClientContext.js\";\nimport { fetchPage, fetchStaticRidPage } from \"./object/fetchPage.js\";\nimport { fetchSingle } from \"./object/fetchSingle.js\";\nimport { createObjectSet } from \"./objectSet/createObjectSet.js\";\nimport type { ObjectSetFactory } from \"./objectSet/ObjectSetFactory.js\";\nimport { ObjectSetListenerWebsocket } from \"./objectSet/ObjectSetListenerWebsocket.js\";\nimport { applyQuery } from \"./queries/applyQuery.js\";\nimport type { QuerySignatureFromDef } from \"./queries/types.js\";\nimport type { CreateSubscriptionConnectionFn } from \"./SubscriptionConnection.js\";\n\n// We import it this way to keep compatible with CJS. If we referenced the\n// value of `symbolClientContext` directly, then we would have to a dynamic import\n// in `createClientInternal` which would make it async and a break.\n// Since this is just a string in `@osdk/shared.client2` instead of a symbol,\n// we can safely perform this trick.\ntype newSymbolClientContext =\n // eslint-disable-next-line @typescript-eslint/consistent-type-imports\n typeof import(\"@osdk/shared.client2\").symbolClientContext;\n\nclass ActionInvoker<\n Q extends ActionDefinition<any>,\n> implements ActionSignatureFromDef<Q> {\n constructor(clientCtx: MinimalClient, actionDef: ActionDefinition<any>) {\n // We type the property as a generic function as binding `applyAction`\n // doesn't return a type thats all that useful anyway\n // The implements covers us for the most part here as this exact type doesn't\n // escape this file\n this.applyAction = applyAction.bind(undefined, clientCtx, actionDef);\n this.batchApplyAction = applyAction.bind(undefined, clientCtx, actionDef);\n }\n\n applyAction: (...args: any[]) => any;\n batchApplyAction: (...args: any[]) => any;\n}\n\nclass QueryInvoker<\n Q extends QueryDefinition<any>,\n> implements QuerySignatureFromDef<Q> {\n constructor(clientCtx: MinimalClient, queryDef: QueryDefinition<any>) {\n this.executeFunction = applyQuery.bind(undefined, clientCtx, queryDef);\n }\n\n executeFunction: (...args: any[]) => any;\n}\n\n/** @internal */\nexport function createClientInternal(\n objectSetFactory: ObjectSetFactory<any, any>,\n transactionRid: string | undefined,\n flushEdits: (() => Promise<void>) | undefined,\n scenarioRid: string | undefined,\n subscribeConnectionFn: CreateSubscriptionConnectionFn | undefined,\n baseUrl: string,\n ontologyRid: string | Promise<string>,\n tokenProvider: () => Promise<string>,\n options:\n | {\n logger?: Logger;\n UNSTABLE_DO_NOT_USE_BRANCH?: string;\n headers?: Record<string, string>;\n }\n | undefined = undefined,\n fetchFn: typeof globalThis.fetch = fetch,\n): Client {\n if (typeof ontologyRid === \"string\") {\n if (!ontologyRid.startsWith(\"ri.\")) {\n throw new Error(\"Invalid ontology RID\");\n }\n } else {\n // eslint-disable-next-line @typescript-eslint/no-floating-promises\n ontologyRid.then((ontologyRid) => {\n if (!ontologyRid.startsWith(\"ri.\")) {\n // FIXME this promise is not await so this just shows up as an unhandled promise rejection\n throw new Error(\"Invalid ontology RID\");\n }\n });\n }\n\n const clientCtx: MinimalClient = createMinimalClient(\n { ontologyRid },\n baseUrl,\n tokenProvider,\n {\n ...options,\n logger: options?.logger ?? new MinimalLogger(),\n transactionId: transactionRid,\n flushEdits,\n scenarioRid,\n branch: options?.UNSTABLE_DO_NOT_USE_BRANCH,\n createSubscriptionConnection: subscribeConnectionFn,\n },\n fetchFn,\n objectSetFactory,\n );\n\n return createClientFromContext(clientCtx);\n}\n\n/**\n * @internal\n */\nexport function createClientFromContext(clientCtx: MinimalClient) {\n function clientFn<\n T extends\n | ObjectOrInterfaceDefinition\n | ActionDefinition<any>\n | QueryDefinition<any>\n | Experiment<\"2.0.8\">\n | Experiment<\"2.1.0\">\n | Experiment<\"2.8.0\">\n | Experiment<\"2.19.0\">,\n >(\n o: T,\n ): T extends ObjectTypeDefinition\n ? ObjectSet<T>\n : T extends InterfaceDefinition\n ? MinimalObjectSet<T>\n : T extends ActionDefinition<any>\n ? ActionSignatureFromDef<T>\n : T extends QueryDefinition<any>\n ? QuerySignatureFromDef<T>\n : T extends\n | Experiment<\"2.0.8\">\n | Experiment<\"2.1.0\">\n | Experiment<\"2.8.0\">\n | Experiment<\"2.19.0\">\n ? { invoke: ExperimentFns<T> }\n : never {\n if (o.type === \"object\" || o.type === \"interface\") {\n return clientCtx.objectSetFactory(o, clientCtx) as any;\n } else if (o.type === \"action\") {\n return new ActionInvoker(clientCtx, o) as T extends ActionDefinition<any>\n ? // first `as` to the action definition for our \"real\" typecheck\n ActionSignatureFromDef<T>\n : never as any; // then as any for dealing with the conditional return value\n } else if (o.type === \"query\") {\n return new QueryInvoker(clientCtx, o) as T extends QueryDefinition<any>\n ? QuerySignatureFromDef<T>\n : never as any;\n } else if (o.type === \"experiment\") {\n switch (o.name) {\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__executeStreamingFunction.name:\n return {\n async *executeStreamingFunction(\n query: QueryDefinition<any>,\n params?: Record<string, any>,\n ) {\n const { applyStreamingQuery } =\n await import(\"./queries/applyStreamingQuery.js\");\n yield* applyStreamingQuery(clientCtx, query, params);\n },\n } as any;\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks.name:\n return {\n async *getBulkLinks(\n objs: Array<OsdkBase<any>>,\n linkTypes: string[],\n ) {\n const { createBulkLinksAsyncIterFactory } =\n await import(\"./__unstable/createBulkLinksAsyncIterFactory.js\");\n yield* createBulkLinksAsyncIterFactory(clientCtx)(\n objs,\n linkTypes,\n );\n },\n } as any;\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid.name:\n return {\n fetchOneByRid: async <\n Q extends ObjectOrInterfaceDefinition,\n const L extends PropertyKeys<Q>,\n const R extends boolean,\n const S extends false | \"throw\" = NullabilityAdherence.Default,\n >(\n objectType: Q,\n rid: string,\n options: SelectArg<Q, L, R, S>,\n ) => {\n return (await fetchSingle(\n clientCtx,\n objectType,\n options,\n createWithRid([rid]),\n )) as Osdk<Q>;\n },\n } as any;\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid.name:\n return {\n fetchPageByRid: async <\n Q extends ObjectOrInterfaceDefinition,\n const L extends PropertyKeys<Q>,\n const R extends boolean,\n const S extends false | \"throw\" = NullabilityAdherence.Default,\n const T extends boolean = false,\n const PROPERTY_SECURITIES extends boolean = false,\n >(\n objectOrInterfaceType: Q,\n rids: string[],\n options: FetchPageArgs<\n Q,\n L,\n R,\n any,\n S,\n T,\n never,\n {},\n PROPERTY_SECURITIES\n > = {},\n ) => {\n return await fetchPage(\n clientCtx,\n objectOrInterfaceType,\n options,\n createWithRid(rids),\n );\n },\n fetchPageByRidNoType: async <\n const R extends boolean,\n const S extends NullabilityAdherence,\n const T extends boolean,\n const PROPERTY_SECURITIES extends boolean = false,\n >(\n rids: readonly string[],\n options?: FetchPageArgs<\n ObjectOrInterfaceDefinition,\n any,\n R,\n any,\n S,\n T,\n never,\n {},\n PROPERTY_SECURITIES\n >,\n ) => {\n return await fetchStaticRidPage(clientCtx, rids, options ?? {});\n },\n } as any;\n\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__subscribeToNoTypeObjectSet.name:\n return {\n subscribeToNoTypeObjectSet: <R extends boolean = false>(\n rid: string,\n listener: ObjectSetSubscription.Listener<\n ObjectOrInterfaceDefinition,\n never,\n R\n >,\n opts?: { includeRid?: R },\n ) => {\n const unsubscribe = ObjectSetListenerWebsocket.getInstance(\n clientCtx,\n ).subscribeWithoutType(\n { type: \"reference\", reference: rid },\n listener as ObjectSetSubscription.Listener<\n ObjectOrInterfaceDefinition,\n never\n >,\n opts?.includeRid ?? false,\n );\n return { unsubscribe };\n },\n } as any;\n\n case transformAndWait.name:\n return {\n transformAndWait: async (args: {\n media: Media;\n transformation: MediaTransformation;\n options?: TransformOptions;\n }) => {\n const { transformAndWaitInternal } =\n await import(\"./util/transformAndWaitInternal.js\");\n const { mediaSetRid, mediaItemRid, token } =\n args.media.getMediaReference().reference.mediaSetViewItem;\n return transformAndWaitInternal(\n clientCtx,\n mediaSetRid,\n mediaItemRid,\n makeMediaTransformation(args.transformation),\n token,\n args.options,\n );\n },\n } as any;\n }\n\n throw new Error(\"not implemented\");\n } else {\n throw new Error(\"not implemented\");\n }\n }\n\n const fetchMetadata = fetchMetadataInternal.bind(undefined, clientCtx);\n\n const symbolClientContext: newSymbolClientContext = \"__osdkClientContext\";\n\n const client: Client = Object.defineProperties<Client>(clientFn as Client, {\n [oldSymbolClientContext]: {\n value: clientCtx,\n },\n [symbolClientContext]: {\n value: clientCtx,\n },\n [additionalContext]: {\n value: clientCtx,\n },\n fetchMetadata: {\n value: fetchMetadata,\n },\n } satisfies Record<keyof Client, PropertyDescriptor>);\n\n return client;\n}\n\n/**\n * Creates a {@link Client} for interacting with a Foundry Ontology. This is the primary entry point for\n * the OSDK and is typically called once per application during setup. The returned client is then used\n * to load object sets, apply actions, and execute queries against the configured ontology.\n * @param baseUrl - The base URL of the Foundry stack (e.g. `\"https://example.palantirfoundry.com\"`).\n * @param ontologyRid - The ontology RID to scope the client to. May be provided directly or as a `Promise`\n * that resolves to the RID. Typically the generated `$ontologyRid` export from your generated SDK is passed here.\n * @param tokenProvider - A function returning a `Promise` that resolves to a bearer token used to authenticate\n * requests. Typically the OAuth client returned by `createPublicOauthClient` or `createConfidentialOauthClient`\n * from `@osdk/oauth`, which handles caching and refresh; you can also provide a custom function if you\n * manage tokens yourself.\n * @param options - Optional client configuration: a custom `logger`, an experimental `UNSTABLE_DO_NOT_USE_BRANCH`\n * for branch-aware requests, and additional `headers` to include on every request.\n * @param fetchFn - An optional `fetch` implementation to use for all requests. Defaults to the global `fetch`.\n * @example\n * ```ts\n * import { createClient, type Client } from \"@osdk/client\";\n * import { createPublicOauthClient } from \"@osdk/oauth\";\n * import { $ontologyRid } from \"./generatedNoCheck/index.js\";\n *\n * const auth = createPublicOauthClient(\n * \"<your-client-id>\",\n * \"https://example.palantirfoundry.com\",\n * `${window.location.origin}/auth/callback`,\n * );\n *\n * export const client: Client = createClient(\n * \"https://example.palantirfoundry.com\",\n * $ontologyRid,\n * auth,\n * );\n * ```\n * @returns a {@link Client} configured to talk to the given Foundry stack and ontology\n */\nexport const createClient: (\n baseUrl: string,\n ontologyRid: string | Promise<string>,\n tokenProvider: () => Promise<string>,\n options?:\n | {\n logger?: Logger;\n /** @beta This is an experimental feature subject to change */\n UNSTABLE_DO_NOT_USE_BRANCH?: string;\n headers?: Record<string, string>;\n }\n | undefined,\n fetchFn?: typeof fetch | undefined,\n) => Client = createClientInternal.bind(\n undefined,\n createObjectSet,\n undefined,\n undefined,\n undefined,\n undefined,\n);\n\nexport const createClientWithTransaction: (\n transactionId: string,\n flushEdits: () => Promise<void>,\n ...args: Parameters<typeof createClient>\n) => Client = (transactionRid, flushEdits, ...args) =>\n createClientInternal(\n createObjectSet,\n transactionRid,\n flushEdits,\n undefined,\n undefined,\n ...args,\n ) as Client;\n\n/**\n * Creates a {@link Client} whose `objectSet.subscribe()` calls are routed through a caller-supplied\n * connection factory instead of the default `WebSocket`. This lets an embedder (e.g. an embedded\n * backend) supply an alternate transport that speaks the same `StreamMessage` wire protocol — the\n * OSDK subscription machinery (wire→OSDK conversion, multiplexing, reconnection, heartbeats) is\n * unchanged; only the underlying connection is swapped.\n *\n * @param createSubscriptionConnection - A zero-arg factory returning a {@link SubscriptionConnection}\n * (or a promise of one), used for every subscription connection.\n * @param args - The remaining {@link createClient} arguments (`baseUrl`, `ontologyRid`,\n * `tokenProvider`, `options`, `fetchFn`).\n */\nexport const createClientWithSubscriptionConnection: (\n createSubscriptionConnection: CreateSubscriptionConnectionFn,\n ...args: Parameters<typeof createClient>\n) => Client = (createSubscriptionConnection, ...args) =>\n createClientInternal(\n createObjectSet,\n undefined,\n undefined,\n undefined,\n createSubscriptionConnection,\n ...args,\n ) as Client;\n\n/** @internal */\nexport const createClientWithScenario: (\n scenarioRid: string,\n ...args: Parameters<typeof createClient>\n) => Client = (scenarioRid, ...args) =>\n createClientInternal(\n createObjectSet,\n undefined,\n undefined,\n scenarioRid,\n undefined,\n ...args,\n ) as Client;\n\nfunction createWithRid(rids: string[]) {\n const withRid: WireObjectSet = {\n type: \"static\",\n objects: rids,\n };\n\n return withRid;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA0BA,SACEA,2DAA2D,EAC3DC,gDAAgD,EAChDC,iDAAiD,EACjDC,+CAA+C,EAC/CC,6DAA6D,EAC7DC,gBAAgB,QACX,oBAAoB;AAE3B,SAASC,mBAAmB,IAAIC,sBAAsB,QAAQ,qBAAqB;AAGnF,SAASC,WAAW,QAAQ,0BAA0B;AACtD,SAASC,iBAAiB,QAAqB,aAAa;AAC5D,SAASC,mBAAmB,QAAQ,0BAA0B;AAC9D,SAASC,qBAAqB,QAAQ,oBAAoB;AAC1D,SAASC,uBAAuB,QAAQ,mDAAmD;AAC3F,SAASC,aAAa,QAAQ,2BAA2B;AAEzD,SAASC,SAAS,EAAEC,kBAAkB,QAAQ,uBAAuB;AACrE,SAASC,WAAW,QAAQ,yBAAyB;AACrD,SAASC,eAAe,QAAQ,gCAAgC;AAEhE,SAASC,0BAA0B,QAAQ,2CAA2C;AACtF,SAASC,UAAU,QAAQ,yBAAyB;;AAIpD;AACA;AACA;AACA;AACA;;AAKA,MAAMC,aAAa,CAEoB;EACrCC,WAAWA,CAACC,SAAwB,EAAEC,SAAgC,EAAE;IACtE;IACA;IACA;IACA;IACA,IAAI,CAACf,WAAW,GAAGA,WAAW,CAACgB,IAAI,CAACC,SAAS,EAAEH,SAAS,EAAEC,SAAS,CAAC;IACpE,IAAI,CAACG,gBAAgB,GAAGlB,WAAW,CAACgB,IAAI,CAACC,SAAS,EAAEH,SAAS,EAAEC,SAAS,CAAC;EAC3E;AAIF;AAEA,MAAMI,YAAY,CAEoB;EACpCN,WAAWA,CAACC,SAAwB,EAAEM,QAA8B,EAAE;IACpE,IAAI,CAACC,eAAe,GAAGV,UAAU,CAACK,IAAI,CAACC,SAAS,EAAEH,SAAS,EAAEM,QAAQ,CAAC;EACxE;AAGF;;AAEA;AACA,OAAO,SAASE,oBAAoBA,CAClCC,gBAA4C,EAC5CC,cAAkC,EAClCC,UAA6C,EAC7CC,WAA+B,EAC/BC,qBAAiE,EACjEC,OAAe,EACfC,WAAqC,EACrCC,aAAoC,EACpCC,OAMa,GAAGd,SAAS,EACzBe,OAAgC,GAAGC,KAAK,EAChC;EACR,IAAI,OAAOJ,WAAW,KAAK,QAAQ,EAAE;IACnC,IAAI,CAACA,WAAW,CAACK,UAAU,CAAC,KAAK,CAAC,EAAE;MAClC,MAAM,IAAIC,KAAK,CAAC,sBAAsB,CAAC;IACzC;EACF,CAAC,MAAM;IACL;IACAN,WAAW,CAACO,IAAI,CAAEP,WAAW,IAAK;MAChC,IAAI,CAACA,WAAW,CAACK,UAAU,CAAC,KAAK,CAAC,EAAE;QAClC;QACA,MAAM,IAAIC,KAAK,CAAC,sBAAsB,CAAC;MACzC;IACF,CAAC,CAAC;EACJ;EAEA,MAAMrB,SAAwB,GAAGZ,mBAAmB,CAClD;IAAE2B;EAAY,CAAC,EACfD,OAAO,EACPE,aAAa,EACb;IACE,GAAGC,OAAO;IACVM,MAAM,EAAEN,OAAO,EAAEM,MAAM,IAAI,IAAIhC,aAAa,CAAC,CAAC;IAC9CiC,aAAa,EAAEd,cAAc;IAC7BC,UAAU;IACVC,WAAW;IACXa,MAAM,EAAER,OAAO,EAAES,0BAA0B;IAC3CC,4BAA4B,EAAEd;EAChC,CAAC,EACDK,OAAO,EACPT,gBACF,CAAC;EAED,OAAOmB,uBAAuB,CAAC5B,SAAS,CAAC;AAC3C;;AAEA;AACA;AACA;AACA,OAAO,SAAS4B,uBAAuBA,CAAC5B,SAAwB,EAAE;EAiMhE,MAAM6B,aAAa,GAAGxC,qBAAqB,CAACa,IAAI,CAACC,SAAS,EAAEH,SAAS,CAAC;EAItE,MAAM8B,MAAc,GAAGC,MAAM,CAACC,gBAAgB,CApM9C,UAUEC,CAAI,EAeY;IAChB,IAAIA,CAAC,CAACC,IAAI,KAAK,QAAQ,IAAID,CAAC,CAACC,IAAI,KAAK,WAAW,EAAE;MACjD,OAAOlC,SAAS,CAACS,gBAAgB,CAACwB,CAAC,EAAEjC,SAAS,CAAC;IACjD,CAAC,MAAM,IAAIiC,CAAC,CAACC,IAAI,KAAK,QAAQ,EAAE;MAC9B,OAAO,IAAIpC,aAAa,CAACE,SAAS,EAAEiC,CAAC,CAAC,CAGrB,CAAC;IACpB,CAAC,MAAM,IAAIA,CAAC,CAACC,IAAI,KAAK,OAAO,EAAE;MAC7B,OAAO,IAAI7B,YAAY,CAACL,SAAS,EAAEiC,CAAC,CAAC;IAGvC,CAAC,MAAM,IAAIA,CAAC,CAACC,IAAI,KAAK,YAAY,EAAE;MAClC,QAAQD,CAAC,CAACE,IAAI;QACZ,KAAKzD,2DAA2D,CAACyD,IAAI;UACnE,OAAO;YACL,OAAOC,wBAAwBA,CAC7BC,KAA2B,EAC3BC,MAA4B,EAC5B;cACA,MAAM;gBAAEC;cAAoB,CAAC,GAC3B,MAAM,MAAM,CAAC,kCAAkC,CAAC;cAClD,OAAOA,mBAAmB,CAACvC,SAAS,EAAEqC,KAAK,EAAEC,MAAM,CAAC;YACtD;UACF,CAAC;QACH,KAAKzD,+CAA+C,CAACsD,IAAI;UACvD,OAAO;YACL,OAAOK,YAAYA,CACjBC,IAA0B,EAC1BC,SAAmB,EACnB;cACA,MAAM;gBAAEC;cAAgC,CAAC,GACvC,MAAM,MAAM,CAAC,iDAAiD,CAAC;cACjE,OAAOA,+BAA+B,CAAC3C,SAAS,CAAC,CAC/CyC,IAAI,EACJC,SACF,CAAC;YACH;UACF,CAAC;QACH,KAAK/D,gDAAgD,CAACwD,IAAI;UACxD,OAAO;YACLS,aAAa,EAAE,MAAAA,CAMbC,UAAa,EACbC,GAAW,EACX7B,OAA8B,KAC3B;cACH,OAAQ,MAAMvB,WAAW,CACvBM,SAAS,EACT6C,UAAU,EACV5B,OAAO,EACP8B,aAAa,CAAC,CAACD,GAAG,CAAC,CACrB,CAAC;YACH;UACF,CAAC;QACH,KAAKlE,iDAAiD,CAACuD,IAAI;UACzD,OAAO;YACLa,cAAc,EAAE,MAAAA,CAQdC,qBAAwB,EACxBC,IAAc,EACdjC,OAUC,GAAG,CAAC,CAAC,KACH;cACH,OAAO,MAAMzB,SAAS,CACpBQ,SAAS,EACTiD,qBAAqB,EACrBhC,OAAO,EACP8B,aAAa,CAACG,IAAI,CACpB,CAAC;YACH,CAAC;YACDC,oBAAoB,EAAE,MAAAA,CAMpBD,IAAuB,EACvBjC,OAUC,KACE;cACH,OAAO,MAAMxB,kBAAkB,CAACO,SAAS,EAAEkD,IAAI,EAAEjC,OAAO,IAAI,CAAC,CAAC,CAAC;YACjE;UACF,CAAC;QAEH,KAAKnC,6DAA6D,CAACqD,IAAI;UACrE,OAAO;YACLiB,0BAA0B,EAAEA,CAC1BN,GAAW,EACXO,QAIC,EACDC,IAAyB,KACtB;cACH,MAAMC,WAAW,GAAG3D,0BAA0B,CAAC4D,WAAW,CACxDxD,SACF,CAAC,CAACyD,oBAAoB,CACpB;gBAAEvB,IAAI,EAAE,WAAW;gBAAEwB,SAAS,EAAEZ;cAAI,CAAC,EACrCO,QAAQ,EAIRC,IAAI,EAAEK,UAAU,IAAI,KACtB,CAAC;cACD,OAAO;gBAAEJ;cAAY,CAAC;YACxB;UACF,CAAC;QAEH,KAAKxE,gBAAgB,CAACoD,IAAI;UACxB,OAAO;YACLpD,gBAAgB,EAAE,MAAO6E,IAIxB,IAAK;cACJ,MAAM;gBAAEC;cAAyB,CAAC,GAChC,MAAM,MAAM,CAAC,oCAAoC,CAAC;cACpD,MAAM;gBAAEC,WAAW;gBAAEC,YAAY;gBAAEC;cAAM,CAAC,GACxCJ,IAAI,CAACK,KAAK,CAACC,iBAAiB,CAAC,CAAC,CAACR,SAAS,CAACS,gBAAgB;cAC3D,OAAON,wBAAwB,CAC7B7D,SAAS,EACT8D,WAAW,EACXC,YAAY,EACZzE,uBAAuB,CAACsE,IAAI,CAACQ,cAAc,CAAC,EAC5CJ,KAAK,EACLJ,IAAI,CAAC3C,OACP,CAAC;YACH;UACF,CAAC;MACL;MAEA,MAAM,IAAII,KAAK,CAAC,iBAAiB,CAAC;IACpC,CAAC,MAAM;MACL,MAAM,IAAIA,KAAK,CAAC,iBAAiB,CAAC;IACpC;EACF,CAAC,EAM0E;IACzE,CAACpC,sBAAsB,GAAG;MACxBoF,KAAK,EAAErE;IACT,CAAC;IACD,CANkD,qBAAqB,GAMhD;MACrBqE,KAAK,EAAErE;IACT,CAAC;IACD,CAACb,iBAAiB,GAAG;MACnBkF,KAAK,EAAErE;IACT,CAAC;IACD6B,aAAa,EAAE;MACbwC,KAAK,EAAExC;IACT;EACF,CAAoD,CAAC;EAErD,OAAOC,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMwC,YAaF,GAAG9D,oBAAoB,CAACN,IAAI,CACrCC,SAAS,EACTR,eAAe,EACfQ,SAAS,EACTA,SAAS,EACTA,SAAS,EACTA,SACF,CAAC;AAED,OAAO,MAAMoE,2BAIF,GAAGA,CAAC7D,cAAc,EAAEC,UAAU,EAAE,GAAGiD,IAAI,KAChDpD,oBAAoB,CAClBb,eAAe,EACfe,cAAc,EACdC,UAAU,EACVR,SAAS,EACTA,SAAS,EACT,GAAGyD,IACL,CAAW;;AAEb;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMY,sCAGF,GAAGA,CAAC7C,4BAA4B,EAAE,GAAGiC,IAAI,KAClDpD,oBAAoB,CAClBb,eAAe,EACfQ,SAAS,EACTA,SAAS,EACTA,SAAS,EACTwB,4BAA4B,EAC5B,GAAGiC,IACL,CAAW;;AAEb;AACA,OAAO,MAAMa,wBAGF,GAAGA,CAAC7D,WAAW,EAAE,GAAGgD,IAAI,KACjCpD,oBAAoB,CAClBb,eAAe,EACfQ,SAAS,EACTA,SAAS,EACTS,WAAW,EACXT,SAAS,EACT,GAAGyD,IACL,CAAW;AAEb,SAASb,aAAaA,CAACG,IAAc,EAAE;EAMrC,OAL+B;IAC7BhB,IAAI,EAAE,QAAQ;IACdwC,OAAO,EAAExB;EACX,CAAC;AAGH","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"createClient.js","names":["__EXPERIMENTAL__NOT_SUPPORTED_YET__executeStreamingFunction","__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid","__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid","__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks","__EXPERIMENTAL__NOT_SUPPORTED_YET__linkSubscriptions","__EXPERIMENTAL__NOT_SUPPORTED_YET__subscribeToNoTypeObjectSet","transformAndWait","symbolClientContext","oldSymbolClientContext","applyAction","additionalContext","createMinimalClient","fetchMetadataInternal","makeMediaTransformation","MinimalLogger","fetchPage","fetchStaticRidPage","fetchSingle","createObjectSet","ObjectSetListenerWebsocket","applyQuery","ActionInvoker","constructor","clientCtx","actionDef","bind","undefined","batchApplyAction","QueryInvoker","queryDef","executeFunction","createClientInternal","objectSetFactory","transactionRid","flushEdits","scenarioRid","subscribeConnectionFn","baseUrl","ontologyRid","tokenProvider","options","fetchFn","fetch","startsWith","Error","then","logger","transactionId","branch","UNSTABLE_DO_NOT_USE_BRANCH","createSubscriptionConnection","createClientFromContext","fetchMetadata","client","Object","defineProperties","o","type","name","executeStreamingFunction","query","params","applyStreamingQuery","getBulkLinks","objs","linkTypes","createBulkLinksAsyncIterFactory","subscribeToLinks","objectType","args","pendingSubscription","LinkSubscriptionWebsocket","getInstance","subscribe","unsubscribe","fetchOneByRid","rid","createWithRid","fetchPageByRid","objectOrInterfaceType","rids","fetchPageByRidNoType","subscribeToNoTypeObjectSet","listener","opts","subscribeWithoutType","reference","includeRid","transformAndWaitInternal","mediaSetRid","mediaItemRid","token","media","getMediaReference","mediaSetViewItem","transformation","value","createClient","createClientWithTransaction","createClientWithSubscriptionConnection","createClientWithScenario","objects"],"sources":["createClient.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 {\n ActionDefinition,\n FetchPageArgs,\n InterfaceDefinition,\n LinkTypeApiNamesFor,\n Logger,\n Media,\n NullabilityAdherence,\n ObjectOrInterfaceDefinition,\n ObjectSet,\n ObjectSetSubscription,\n ObjectTypeDefinition,\n Osdk,\n OsdkBase,\n PropertyKeys,\n QueryDefinition,\n SelectArg,\n} from \"@osdk/api\";\nimport type {\n Experiment,\n ExperimentFns,\n LinkSubscription,\n MediaTransformation,\n MinimalObjectSet,\n TransformOptions,\n} from \"@osdk/api/unstable\";\nimport {\n __EXPERIMENTAL__NOT_SUPPORTED_YET__executeStreamingFunction,\n __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid,\n __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid,\n __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks,\n __EXPERIMENTAL__NOT_SUPPORTED_YET__linkSubscriptions,\n __EXPERIMENTAL__NOT_SUPPORTED_YET__subscribeToNoTypeObjectSet,\n transformAndWait,\n} from \"@osdk/api/unstable\";\nimport type { ObjectSet as WireObjectSet } from \"@osdk/foundry.ontologies\";\nimport { symbolClientContext as oldSymbolClientContext } from \"@osdk/shared.client\";\n\nimport type { ActionSignatureFromDef } from \"./actions/applyAction.js\";\nimport { applyAction } from \"./actions/applyAction.js\";\nimport { additionalContext, type Client } from \"./Client.js\";\nimport { createMinimalClient } from \"./createMinimalClient.js\";\nimport { fetchMetadataInternal } from \"./fetchMetadata.js\";\nimport { makeMediaTransformation } from \"./internal/conversions/makeMediaTransformation.js\";\nimport { MinimalLogger } from \"./logger/MinimalLogger.js\";\nimport type { MinimalClient } from \"./MinimalClientContext.js\";\nimport { fetchPage, fetchStaticRidPage } from \"./object/fetchPage.js\";\nimport { fetchSingle } from \"./object/fetchSingle.js\";\nimport { createObjectSet } from \"./objectSet/createObjectSet.js\";\nimport type { ObjectSetFactory } from \"./objectSet/ObjectSetFactory.js\";\nimport { ObjectSetListenerWebsocket } from \"./objectSet/ObjectSetListenerWebsocket.js\";\nimport { applyQuery } from \"./queries/applyQuery.js\";\nimport type { QuerySignatureFromDef } from \"./queries/types.js\";\nimport type { CreateSubscriptionConnectionFn } from \"./SubscriptionConnection.js\";\n\n// We import it this way to keep compatible with CJS. If we referenced the\n// value of `symbolClientContext` directly, then we would have to a dynamic import\n// in `createClientInternal` which would make it async and a break.\n// Since this is just a string in `@osdk/shared.client2` instead of a symbol,\n// we can safely perform this trick.\ntype newSymbolClientContext =\n // eslint-disable-next-line @typescript-eslint/consistent-type-imports\n typeof import(\"@osdk/shared.client2\").symbolClientContext;\n\nclass ActionInvoker<\n Q extends ActionDefinition<any>,\n> implements ActionSignatureFromDef<Q> {\n constructor(clientCtx: MinimalClient, actionDef: ActionDefinition<any>) {\n // We type the property as a generic function as binding `applyAction`\n // doesn't return a type thats all that useful anyway\n // The implements covers us for the most part here as this exact type doesn't\n // escape this file\n this.applyAction = applyAction.bind(undefined, clientCtx, actionDef);\n this.batchApplyAction = applyAction.bind(undefined, clientCtx, actionDef);\n }\n\n applyAction: (...args: any[]) => any;\n batchApplyAction: (...args: any[]) => any;\n}\n\nclass QueryInvoker<\n Q extends QueryDefinition<any>,\n> implements QuerySignatureFromDef<Q> {\n constructor(clientCtx: MinimalClient, queryDef: QueryDefinition<any>) {\n this.executeFunction = applyQuery.bind(undefined, clientCtx, queryDef);\n }\n\n executeFunction: (...args: any[]) => any;\n}\n\n/** @internal */\nexport function createClientInternal(\n objectSetFactory: ObjectSetFactory<any, any>,\n transactionRid: string | undefined,\n flushEdits: (() => Promise<void>) | undefined,\n scenarioRid: string | undefined,\n subscribeConnectionFn: CreateSubscriptionConnectionFn | undefined,\n baseUrl: string,\n ontologyRid: string | Promise<string>,\n tokenProvider: () => Promise<string>,\n options:\n | {\n logger?: Logger;\n UNSTABLE_DO_NOT_USE_BRANCH?: string;\n headers?: Record<string, string>;\n }\n | undefined = undefined,\n fetchFn: typeof globalThis.fetch = fetch,\n): Client {\n if (typeof ontologyRid === \"string\") {\n if (!ontologyRid.startsWith(\"ri.\")) {\n throw new Error(\"Invalid ontology RID\");\n }\n } else {\n // eslint-disable-next-line @typescript-eslint/no-floating-promises\n ontologyRid.then((ontologyRid) => {\n if (!ontologyRid.startsWith(\"ri.\")) {\n // FIXME this promise is not await so this just shows up as an unhandled promise rejection\n throw new Error(\"Invalid ontology RID\");\n }\n });\n }\n\n const clientCtx: MinimalClient = createMinimalClient(\n { ontologyRid },\n baseUrl,\n tokenProvider,\n {\n ...options,\n logger: options?.logger ?? new MinimalLogger(),\n transactionId: transactionRid,\n flushEdits,\n scenarioRid,\n branch: options?.UNSTABLE_DO_NOT_USE_BRANCH,\n createSubscriptionConnection: subscribeConnectionFn,\n },\n fetchFn,\n objectSetFactory,\n );\n\n return createClientFromContext(clientCtx);\n}\n\n/**\n * @internal\n */\nexport function createClientFromContext(clientCtx: MinimalClient) {\n function clientFn<\n T extends\n | ObjectOrInterfaceDefinition\n | ActionDefinition<any>\n | QueryDefinition<any>\n | Experiment<\"2.0.8\">\n | Experiment<\"2.1.0\">\n | Experiment<\"2.59.0\">\n | Experiment<\"2.8.0\">\n | Experiment<\"2.19.0\">,\n >(\n o: T,\n ): T extends ObjectTypeDefinition\n ? ObjectSet<T>\n : T extends InterfaceDefinition\n ? MinimalObjectSet<T>\n : T extends ActionDefinition<any>\n ? ActionSignatureFromDef<T>\n : T extends QueryDefinition<any>\n ? QuerySignatureFromDef<T>\n : T extends\n | Experiment<\"2.0.8\">\n | Experiment<\"2.1.0\">\n | Experiment<\"2.59.0\">\n | Experiment<\"2.8.0\">\n | Experiment<\"2.19.0\">\n ? { invoke: ExperimentFns<T> }\n : never {\n if (o.type === \"object\" || o.type === \"interface\") {\n return clientCtx.objectSetFactory(o, clientCtx) as any;\n } else if (o.type === \"action\") {\n return new ActionInvoker(clientCtx, o) as T extends ActionDefinition<any>\n ? // first `as` to the action definition for our \"real\" typecheck\n ActionSignatureFromDef<T>\n : never as any; // then as any for dealing with the conditional return value\n } else if (o.type === \"query\") {\n return new QueryInvoker(clientCtx, o) as T extends QueryDefinition<any>\n ? QuerySignatureFromDef<T>\n : never as any;\n } else if (o.type === \"experiment\") {\n switch (o.name) {\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__executeStreamingFunction.name:\n return {\n async *executeStreamingFunction(\n query: QueryDefinition<any>,\n params?: Record<string, any>,\n ) {\n const { applyStreamingQuery } =\n await import(\"./queries/applyStreamingQuery.js\");\n yield* applyStreamingQuery(clientCtx, query, params);\n },\n } as any;\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks.name:\n return {\n async *getBulkLinks(\n objs: Array<OsdkBase<any>>,\n linkTypes: string[],\n ) {\n const { createBulkLinksAsyncIterFactory } =\n await import(\"./__unstable/createBulkLinksAsyncIterFactory.js\");\n yield* createBulkLinksAsyncIterFactory(clientCtx)(\n objs,\n linkTypes,\n );\n },\n } as any;\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__linkSubscriptions.name:\n return {\n subscribeToLinks: (\n objectType: ObjectTypeDefinition,\n args: LinkSubscription.Args<\n ObjectTypeDefinition,\n LinkTypeApiNamesFor<ObjectTypeDefinition>\n >,\n ) => {\n const pendingSubscription =\n import(\"./objectSet/LinkSubscriptionWebsocket.js\").then(\n ({ LinkSubscriptionWebsocket }) =>\n LinkSubscriptionWebsocket.getInstance(clientCtx).subscribe(\n objectType,\n args,\n ),\n );\n return {\n unsubscribe: async () => (await pendingSubscription)(),\n };\n },\n } as any;\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid.name:\n return {\n fetchOneByRid: async <\n Q extends ObjectOrInterfaceDefinition,\n const L extends PropertyKeys<Q>,\n const R extends boolean,\n const S extends false | \"throw\" = NullabilityAdherence.Default,\n >(\n objectType: Q,\n rid: string,\n options: SelectArg<Q, L, R, S>,\n ) => {\n return (await fetchSingle(\n clientCtx,\n objectType,\n options,\n createWithRid([rid]),\n )) as Osdk<Q>;\n },\n } as any;\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid.name:\n return {\n fetchPageByRid: async <\n Q extends ObjectOrInterfaceDefinition,\n const L extends PropertyKeys<Q>,\n const R extends boolean,\n const S extends false | \"throw\" = NullabilityAdherence.Default,\n const T extends boolean = false,\n const PROPERTY_SECURITIES extends boolean = false,\n >(\n objectOrInterfaceType: Q,\n rids: string[],\n options: FetchPageArgs<\n Q,\n L,\n R,\n any,\n S,\n T,\n never,\n {},\n PROPERTY_SECURITIES\n > = {},\n ) => {\n return await fetchPage(\n clientCtx,\n objectOrInterfaceType,\n options,\n createWithRid(rids),\n );\n },\n fetchPageByRidNoType: async <\n const R extends boolean,\n const S extends NullabilityAdherence,\n const T extends boolean,\n const PROPERTY_SECURITIES extends boolean = false,\n >(\n rids: readonly string[],\n options?: FetchPageArgs<\n ObjectOrInterfaceDefinition,\n any,\n R,\n any,\n S,\n T,\n never,\n {},\n PROPERTY_SECURITIES\n >,\n ) => {\n return await fetchStaticRidPage(clientCtx, rids, options ?? {});\n },\n } as any;\n\n case __EXPERIMENTAL__NOT_SUPPORTED_YET__subscribeToNoTypeObjectSet.name:\n return {\n subscribeToNoTypeObjectSet: <R extends boolean = false>(\n rid: string,\n listener: ObjectSetSubscription.Listener<\n ObjectOrInterfaceDefinition,\n never,\n R\n >,\n opts?: { includeRid?: R },\n ) => {\n const unsubscribe = ObjectSetListenerWebsocket.getInstance(\n clientCtx,\n ).subscribeWithoutType(\n { type: \"reference\", reference: rid },\n listener as ObjectSetSubscription.Listener<\n ObjectOrInterfaceDefinition,\n never\n >,\n opts?.includeRid ?? false,\n );\n return { unsubscribe };\n },\n } as any;\n\n case transformAndWait.name:\n return {\n transformAndWait: async (args: {\n media: Media;\n transformation: MediaTransformation;\n options?: TransformOptions;\n }) => {\n const { transformAndWaitInternal } =\n await import(\"./util/transformAndWaitInternal.js\");\n const { mediaSetRid, mediaItemRid, token } =\n args.media.getMediaReference().reference.mediaSetViewItem;\n return transformAndWaitInternal(\n clientCtx,\n mediaSetRid,\n mediaItemRid,\n makeMediaTransformation(args.transformation),\n token,\n args.options,\n );\n },\n } as any;\n }\n\n throw new Error(\"not implemented\");\n } else {\n throw new Error(\"not implemented\");\n }\n }\n\n const fetchMetadata = fetchMetadataInternal.bind(undefined, clientCtx);\n\n const symbolClientContext: newSymbolClientContext = \"__osdkClientContext\";\n\n const client: Client = Object.defineProperties<Client>(clientFn as Client, {\n [oldSymbolClientContext]: {\n value: clientCtx,\n },\n [symbolClientContext]: {\n value: clientCtx,\n },\n [additionalContext]: {\n value: clientCtx,\n },\n fetchMetadata: {\n value: fetchMetadata,\n },\n } satisfies Record<keyof Client, PropertyDescriptor>);\n\n return client;\n}\n\n/**\n * Creates a {@link Client} for interacting with a Foundry Ontology. This is the primary entry point for\n * the OSDK and is typically called once per application during setup. The returned client is then used\n * to load object sets, apply actions, and execute queries against the configured ontology.\n * @param baseUrl - The base URL of the Foundry stack (e.g. `\"https://example.palantirfoundry.com\"`).\n * @param ontologyRid - The ontology RID to scope the client to. May be provided directly or as a `Promise`\n * that resolves to the RID. Typically the generated `$ontologyRid` export from your generated SDK is passed here.\n * @param tokenProvider - A function returning a `Promise` that resolves to a bearer token used to authenticate\n * requests. Typically the OAuth client returned by `createPublicOauthClient` or `createConfidentialOauthClient`\n * from `@osdk/oauth`, which handles caching and refresh; you can also provide a custom function if you\n * manage tokens yourself.\n * @param options - Optional client configuration: a custom `logger`, an experimental `UNSTABLE_DO_NOT_USE_BRANCH`\n * for branch-aware requests, and additional `headers` to include on every request.\n * @param fetchFn - An optional `fetch` implementation to use for all requests. Defaults to the global `fetch`.\n * @example\n * ```ts\n * import { createClient, type Client } from \"@osdk/client\";\n * import { createPublicOauthClient } from \"@osdk/oauth\";\n * import { $ontologyRid } from \"./generatedNoCheck/index.js\";\n *\n * const auth = createPublicOauthClient(\n * \"<your-client-id>\",\n * \"https://example.palantirfoundry.com\",\n * `${window.location.origin}/auth/callback`,\n * );\n *\n * export const client: Client = createClient(\n * \"https://example.palantirfoundry.com\",\n * $ontologyRid,\n * auth,\n * );\n * ```\n * @returns a {@link Client} configured to talk to the given Foundry stack and ontology\n */\nexport const createClient: (\n baseUrl: string,\n ontologyRid: string | Promise<string>,\n tokenProvider: () => Promise<string>,\n options?:\n | {\n logger?: Logger;\n /** @beta This is an experimental feature subject to change */\n UNSTABLE_DO_NOT_USE_BRANCH?: string;\n headers?: Record<string, string>;\n }\n | undefined,\n fetchFn?: typeof fetch | undefined,\n) => Client = createClientInternal.bind(\n undefined,\n createObjectSet,\n undefined,\n undefined,\n undefined,\n undefined,\n);\n\nexport const createClientWithTransaction: (\n transactionId: string,\n flushEdits: () => Promise<void>,\n ...args: Parameters<typeof createClient>\n) => Client = (transactionRid, flushEdits, ...args) =>\n createClientInternal(\n createObjectSet,\n transactionRid,\n flushEdits,\n undefined,\n undefined,\n ...args,\n ) as Client;\n\n/**\n * Creates a {@link Client} whose `objectSet.subscribe()` calls are routed through a caller-supplied\n * connection factory instead of the default `WebSocket`. This lets an embedder (e.g. an embedded\n * backend) supply an alternate transport that speaks the same `StreamMessage` wire protocol — the\n * OSDK subscription machinery (wire→OSDK conversion, multiplexing, reconnection, heartbeats) is\n * unchanged; only the underlying connection is swapped.\n *\n * @param createSubscriptionConnection - A zero-arg factory returning a {@link SubscriptionConnection}\n * (or a promise of one), used for every subscription connection.\n * @param args - The remaining {@link createClient} arguments (`baseUrl`, `ontologyRid`,\n * `tokenProvider`, `options`, `fetchFn`).\n */\nexport const createClientWithSubscriptionConnection: (\n createSubscriptionConnection: CreateSubscriptionConnectionFn,\n ...args: Parameters<typeof createClient>\n) => Client = (createSubscriptionConnection, ...args) =>\n createClientInternal(\n createObjectSet,\n undefined,\n undefined,\n undefined,\n createSubscriptionConnection,\n ...args,\n ) as Client;\n\n/** @internal */\nexport const createClientWithScenario: (\n scenarioRid: string,\n ...args: Parameters<typeof createClient>\n) => Client = (scenarioRid, ...args) =>\n createClientInternal(\n createObjectSet,\n undefined,\n undefined,\n scenarioRid,\n undefined,\n ...args,\n ) as Client;\n\nfunction createWithRid(rids: string[]) {\n const withRid: WireObjectSet = {\n type: \"static\",\n objects: rids,\n };\n\n return withRid;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA4BA,SACEA,2DAA2D,EAC3DC,gDAAgD,EAChDC,iDAAiD,EACjDC,+CAA+C,EAC/CC,oDAAoD,EACpDC,6DAA6D,EAC7DC,gBAAgB,QACX,oBAAoB;AAE3B,SAASC,mBAAmB,IAAIC,sBAAsB,QAAQ,qBAAqB;AAGnF,SAASC,WAAW,QAAQ,0BAA0B;AACtD,SAASC,iBAAiB,QAAqB,aAAa;AAC5D,SAASC,mBAAmB,QAAQ,0BAA0B;AAC9D,SAASC,qBAAqB,QAAQ,oBAAoB;AAC1D,SAASC,uBAAuB,QAAQ,mDAAmD;AAC3F,SAASC,aAAa,QAAQ,2BAA2B;AAEzD,SAASC,SAAS,EAAEC,kBAAkB,QAAQ,uBAAuB;AACrE,SAASC,WAAW,QAAQ,yBAAyB;AACrD,SAASC,eAAe,QAAQ,gCAAgC;AAEhE,SAASC,0BAA0B,QAAQ,2CAA2C;AACtF,SAASC,UAAU,QAAQ,yBAAyB;;AAIpD;AACA;AACA;AACA;AACA;;AAKA,MAAMC,aAAa,CAEoB;EACrCC,WAAWA,CAACC,SAAwB,EAAEC,SAAgC,EAAE;IACtE;IACA;IACA;IACA;IACA,IAAI,CAACf,WAAW,GAAGA,WAAW,CAACgB,IAAI,CAACC,SAAS,EAAEH,SAAS,EAAEC,SAAS,CAAC;IACpE,IAAI,CAACG,gBAAgB,GAAGlB,WAAW,CAACgB,IAAI,CAACC,SAAS,EAAEH,SAAS,EAAEC,SAAS,CAAC;EAC3E;AAIF;AAEA,MAAMI,YAAY,CAEoB;EACpCN,WAAWA,CAACC,SAAwB,EAAEM,QAA8B,EAAE;IACpE,IAAI,CAACC,eAAe,GAAGV,UAAU,CAACK,IAAI,CAACC,SAAS,EAAEH,SAAS,EAAEM,QAAQ,CAAC;EACxE;AAGF;;AAEA;AACA,OAAO,SAASE,oBAAoBA,CAClCC,gBAA4C,EAC5CC,cAAkC,EAClCC,UAA6C,EAC7CC,WAA+B,EAC/BC,qBAAiE,EACjEC,OAAe,EACfC,WAAqC,EACrCC,aAAoC,EACpCC,OAMa,GAAGd,SAAS,EACzBe,OAAgC,GAAGC,KAAK,EAChC;EACR,IAAI,OAAOJ,WAAW,KAAK,QAAQ,EAAE;IACnC,IAAI,CAACA,WAAW,CAACK,UAAU,CAAC,KAAK,CAAC,EAAE;MAClC,MAAM,IAAIC,KAAK,CAAC,sBAAsB,CAAC;IACzC;EACF,CAAC,MAAM;IACL;IACAN,WAAW,CAACO,IAAI,CAAEP,WAAW,IAAK;MAChC,IAAI,CAACA,WAAW,CAACK,UAAU,CAAC,KAAK,CAAC,EAAE;QAClC;QACA,MAAM,IAAIC,KAAK,CAAC,sBAAsB,CAAC;MACzC;IACF,CAAC,CAAC;EACJ;EAEA,MAAMrB,SAAwB,GAAGZ,mBAAmB,CAClD;IAAE2B;EAAY,CAAC,EACfD,OAAO,EACPE,aAAa,EACb;IACE,GAAGC,OAAO;IACVM,MAAM,EAAEN,OAAO,EAAEM,MAAM,IAAI,IAAIhC,aAAa,CAAC,CAAC;IAC9CiC,aAAa,EAAEd,cAAc;IAC7BC,UAAU;IACVC,WAAW;IACXa,MAAM,EAAER,OAAO,EAAES,0BAA0B;IAC3CC,4BAA4B,EAAEd;EAChC,CAAC,EACDK,OAAO,EACPT,gBACF,CAAC;EAED,OAAOmB,uBAAuB,CAAC5B,SAAS,CAAC;AAC3C;;AAEA;AACA;AACA;AACA,OAAO,SAAS4B,uBAAuBA,CAAC5B,SAAwB,EAAE;EAyNhE,MAAM6B,aAAa,GAAGxC,qBAAqB,CAACa,IAAI,CAACC,SAAS,EAAEH,SAAS,CAAC;EAItE,MAAM8B,MAAc,GAAGC,MAAM,CAACC,gBAAgB,CA5N9C,UAWEC,CAAI,EAgBY;IAChB,IAAIA,CAAC,CAACC,IAAI,KAAK,QAAQ,IAAID,CAAC,CAACC,IAAI,KAAK,WAAW,EAAE;MACjD,OAAOlC,SAAS,CAACS,gBAAgB,CAACwB,CAAC,EAAEjC,SAAS,CAAC;IACjD,CAAC,MAAM,IAAIiC,CAAC,CAACC,IAAI,KAAK,QAAQ,EAAE;MAC9B,OAAO,IAAIpC,aAAa,CAACE,SAAS,EAAEiC,CAAC,CAAC,CAGrB,CAAC;IACpB,CAAC,MAAM,IAAIA,CAAC,CAACC,IAAI,KAAK,OAAO,EAAE;MAC7B,OAAO,IAAI7B,YAAY,CAACL,SAAS,EAAEiC,CAAC,CAAC;IAGvC,CAAC,MAAM,IAAIA,CAAC,CAACC,IAAI,KAAK,YAAY,EAAE;MAClC,QAAQD,CAAC,CAACE,IAAI;QACZ,KAAK1D,2DAA2D,CAAC0D,IAAI;UACnE,OAAO;YACL,OAAOC,wBAAwBA,CAC7BC,KAA2B,EAC3BC,MAA4B,EAC5B;cACA,MAAM;gBAAEC;cAAoB,CAAC,GAC3B,MAAM,MAAM,CAAC,kCAAkC,CAAC;cAClD,OAAOA,mBAAmB,CAACvC,SAAS,EAAEqC,KAAK,EAAEC,MAAM,CAAC;YACtD;UACF,CAAC;QACH,KAAK1D,+CAA+C,CAACuD,IAAI;UACvD,OAAO;YACL,OAAOK,YAAYA,CACjBC,IAA0B,EAC1BC,SAAmB,EACnB;cACA,MAAM;gBAAEC;cAAgC,CAAC,GACvC,MAAM,MAAM,CAAC,iDAAiD,CAAC;cACjE,OAAOA,+BAA+B,CAAC3C,SAAS,CAAC,CAC/CyC,IAAI,EACJC,SACF,CAAC;YACH;UACF,CAAC;QACH,KAAK7D,oDAAoD,CAACsD,IAAI;UAC5D,OAAO;YACLS,gBAAgB,EAAEA,CAChBC,UAAgC,EAChCC,IAGC,KACE;cACH,MAAMC,mBAAmB,GACvB,MAAM,CAAC,0CAA0C,CAAC,CAACzB,IAAI,CACrD,CAAC;gBAAE0B;cAA0B,CAAC,KAC5BA,yBAAyB,CAACC,WAAW,CAACjD,SAAS,CAAC,CAACkD,SAAS,CACxDL,UAAU,EACVC,IACF,CACJ,CAAC;cACH,OAAO;gBACLK,WAAW,EAAE,MAAAA,CAAA,KAAY,CAAC,MAAMJ,mBAAmB,EAAE;cACvD,CAAC;YACH;UACF,CAAC;QACH,KAAKrE,gDAAgD,CAACyD,IAAI;UACxD,OAAO;YACLiB,aAAa,EAAE,MAAAA,CAMbP,UAAa,EACbQ,GAAW,EACXpC,OAA8B,KAC3B;cACH,OAAQ,MAAMvB,WAAW,CACvBM,SAAS,EACT6C,UAAU,EACV5B,OAAO,EACPqC,aAAa,CAAC,CAACD,GAAG,CAAC,CACrB,CAAC;YACH;UACF,CAAC;QACH,KAAK1E,iDAAiD,CAACwD,IAAI;UACzD,OAAO;YACLoB,cAAc,EAAE,MAAAA,CAQdC,qBAAwB,EACxBC,IAAc,EACdxC,OAUC,GAAG,CAAC,CAAC,KACH;cACH,OAAO,MAAMzB,SAAS,CACpBQ,SAAS,EACTwD,qBAAqB,EACrBvC,OAAO,EACPqC,aAAa,CAACG,IAAI,CACpB,CAAC;YACH,CAAC;YACDC,oBAAoB,EAAE,MAAAA,CAMpBD,IAAuB,EACvBxC,OAUC,KACE;cACH,OAAO,MAAMxB,kBAAkB,CAACO,SAAS,EAAEyD,IAAI,EAAExC,OAAO,IAAI,CAAC,CAAC,CAAC;YACjE;UACF,CAAC;QAEH,KAAKnC,6DAA6D,CAACqD,IAAI;UACrE,OAAO;YACLwB,0BAA0B,EAAEA,CAC1BN,GAAW,EACXO,QAIC,EACDC,IAAyB,KACtB;cACH,MAAMV,WAAW,GAAGvD,0BAA0B,CAACqD,WAAW,CACxDjD,SACF,CAAC,CAAC8D,oBAAoB,CACpB;gBAAE5B,IAAI,EAAE,WAAW;gBAAE6B,SAAS,EAAEV;cAAI,CAAC,EACrCO,QAAQ,EAIRC,IAAI,EAAEG,UAAU,IAAI,KACtB,CAAC;cACD,OAAO;gBAAEb;cAAY,CAAC;YACxB;UACF,CAAC;QAEH,KAAKpE,gBAAgB,CAACoD,IAAI;UACxB,OAAO;YACLpD,gBAAgB,EAAE,MAAO+D,IAIxB,IAAK;cACJ,MAAM;gBAAEmB;cAAyB,CAAC,GAChC,MAAM,MAAM,CAAC,oCAAoC,CAAC;cACpD,MAAM;gBAAEC,WAAW;gBAAEC,YAAY;gBAAEC;cAAM,CAAC,GACxCtB,IAAI,CAACuB,KAAK,CAACC,iBAAiB,CAAC,CAAC,CAACP,SAAS,CAACQ,gBAAgB;cAC3D,OAAON,wBAAwB,CAC7BjE,SAAS,EACTkE,WAAW,EACXC,YAAY,EACZ7E,uBAAuB,CAACwD,IAAI,CAAC0B,cAAc,CAAC,EAC5CJ,KAAK,EACLtB,IAAI,CAAC7B,OACP,CAAC;YACH;UACF,CAAC;MACL;MAEA,MAAM,IAAII,KAAK,CAAC,iBAAiB,CAAC;IACpC,CAAC,MAAM;MACL,MAAM,IAAIA,KAAK,CAAC,iBAAiB,CAAC;IACpC;EACF,CAAC,EAM0E;IACzE,CAACpC,sBAAsB,GAAG;MACxBwF,KAAK,EAAEzE;IACT,CAAC;IACD,CANkD,qBAAqB,GAMhD;MACrByE,KAAK,EAAEzE;IACT,CAAC;IACD,CAACb,iBAAiB,GAAG;MACnBsF,KAAK,EAAEzE;IACT,CAAC;IACD6B,aAAa,EAAE;MACb4C,KAAK,EAAE5C;IACT;EACF,CAAoD,CAAC;EAErD,OAAOC,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM4C,YAaF,GAAGlE,oBAAoB,CAACN,IAAI,CACrCC,SAAS,EACTR,eAAe,EACfQ,SAAS,EACTA,SAAS,EACTA,SAAS,EACTA,SACF,CAAC;AAED,OAAO,MAAMwE,2BAIF,GAAGA,CAACjE,cAAc,EAAEC,UAAU,EAAE,GAAGmC,IAAI,KAChDtC,oBAAoB,CAClBb,eAAe,EACfe,cAAc,EACdC,UAAU,EACVR,SAAS,EACTA,SAAS,EACT,GAAG2C,IACL,CAAW;;AAEb;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM8B,sCAGF,GAAGA,CAACjD,4BAA4B,EAAE,GAAGmB,IAAI,KAClDtC,oBAAoB,CAClBb,eAAe,EACfQ,SAAS,EACTA,SAAS,EACTA,SAAS,EACTwB,4BAA4B,EAC5B,GAAGmB,IACL,CAAW;;AAEb;AACA,OAAO,MAAM+B,wBAGF,GAAGA,CAACjE,WAAW,EAAE,GAAGkC,IAAI,KACjCtC,oBAAoB,CAClBb,eAAe,EACfQ,SAAS,EACTA,SAAS,EACTS,WAAW,EACXT,SAAS,EACT,GAAG2C,IACL,CAAW;AAEb,SAASQ,aAAaA,CAACG,IAAc,EAAE;EAMrC,OAL+B;IAC7BvB,IAAI,EAAE,QAAQ;IACd4C,OAAO,EAAErB;EACX,CAAC;AAGH","ignoreList":[]}
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2026 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 WebSocket from "isomorphic-ws";
|
|
18
|
+
import invariant from "tiny-invariant";
|
|
19
|
+
import { isSubscriptionDone, SubscriptionWebsocket } from "./SubscriptionWebsocket.js";
|
|
20
|
+
import { constructLinkSubscriptionWebsocketUrl, nextUuid } from "./websocketUtils.js";
|
|
21
|
+
/** @internal */
|
|
22
|
+
export class LinkSubscriptionWebsocket extends SubscriptionWebsocket {
|
|
23
|
+
static #instances = new WeakMap();
|
|
24
|
+
static getInstance(client) {
|
|
25
|
+
let instance = LinkSubscriptionWebsocket.#instances.get(client.clientCacheKey);
|
|
26
|
+
if (instance == null) {
|
|
27
|
+
instance = new LinkSubscriptionWebsocket(client);
|
|
28
|
+
LinkSubscriptionWebsocket.#instances.set(client.clientCacheKey, instance);
|
|
29
|
+
}
|
|
30
|
+
return instance;
|
|
31
|
+
}
|
|
32
|
+
constructor(client) {
|
|
33
|
+
super(client, "<LSW> ");
|
|
34
|
+
}
|
|
35
|
+
subscribe(objectType, args) {
|
|
36
|
+
!(args.links.length > 0) ? process.env.NODE_ENV !== "production" ? invariant(false, "At least one link type is required to subscribe to links.") : invariant(false) : void 0;
|
|
37
|
+
!(args.objects.length > 0) ? process.env.NODE_ENV !== "production" ? invariant(false, "At least one object is required to subscribe to links.") : invariant(false) : void 0;
|
|
38
|
+
const subscription = {
|
|
39
|
+
links: args.links,
|
|
40
|
+
listener: args.listener,
|
|
41
|
+
objects: args.objects,
|
|
42
|
+
objectType,
|
|
43
|
+
status: "preparing",
|
|
44
|
+
subscriptionId: `TMP-${nextUuid()}`
|
|
45
|
+
};
|
|
46
|
+
this.subscriptions.set(subscription.subscriptionId, subscription);
|
|
47
|
+
this.cancelIdleDisconnect();
|
|
48
|
+
void this.#initiateSubscribe(subscription);
|
|
49
|
+
return () => this.endSubscription(subscription);
|
|
50
|
+
}
|
|
51
|
+
async createConnection() {
|
|
52
|
+
const [ontologyRid, token] = await Promise.all([this.client.ontologyRid, this.client.tokenProvider()]);
|
|
53
|
+
const url = constructLinkSubscriptionWebsocketUrl(this.client.baseUrl, ontologyRid);
|
|
54
|
+
return new WebSocket(url, [`Bearer-${token}`]);
|
|
55
|
+
}
|
|
56
|
+
createSubscribeRequests(requestId, readySubscriptions) {
|
|
57
|
+
return {
|
|
58
|
+
id: requestId,
|
|
59
|
+
requests: readySubscriptions.map(subscription => {
|
|
60
|
+
!(subscription.request != null) ? process.env.NODE_ENV !== "production" ? invariant(false, "Expected a prepared request.") : invariant(false) : void 0;
|
|
61
|
+
return subscription.request;
|
|
62
|
+
})
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
isSubscriptionReady(subscription) {
|
|
66
|
+
return subscription.request != null;
|
|
67
|
+
}
|
|
68
|
+
clearListener(subscription) {
|
|
69
|
+
subscription.listener = {};
|
|
70
|
+
}
|
|
71
|
+
reconnect() {
|
|
72
|
+
void this.ensureWebsocket().catch(error => this.#failAll(error));
|
|
73
|
+
}
|
|
74
|
+
cycleWebsocket() {
|
|
75
|
+
this.pendingSubscriptions.clear();
|
|
76
|
+
super.cycleWebsocket();
|
|
77
|
+
}
|
|
78
|
+
handleWebsocketMessage(message) {
|
|
79
|
+
switch (message.type) {
|
|
80
|
+
case "refresh":
|
|
81
|
+
{
|
|
82
|
+
const subscription = this.subscriptions.get(message.id);
|
|
83
|
+
if (subscription != null) {
|
|
84
|
+
this.#callListener(subscription, () => subscription.listener.onOutOfDate?.({
|
|
85
|
+
links: message.linkTypes
|
|
86
|
+
}));
|
|
87
|
+
}
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
case "subscribeResponses":
|
|
91
|
+
this.#handleSubscribeResponses(message.id, message.responses);
|
|
92
|
+
return;
|
|
93
|
+
case "subscriptionClosed":
|
|
94
|
+
{
|
|
95
|
+
const subscription = this.subscriptions.get(message.id);
|
|
96
|
+
if (subscription != null) {
|
|
97
|
+
this.#fail(subscription, message.cause);
|
|
98
|
+
}
|
|
99
|
+
return;
|
|
100
|
+
}
|
|
101
|
+
case "updates":
|
|
102
|
+
{
|
|
103
|
+
const subscription = this.subscriptions.get(message.id);
|
|
104
|
+
if (subscription == null) return;
|
|
105
|
+
for (const update of message.updates) {
|
|
106
|
+
this.#callListener(subscription, () => subscription.listener.onChange?.({
|
|
107
|
+
linkType: update.linkType,
|
|
108
|
+
source: toObjectIdentifiers(update.selectedSide),
|
|
109
|
+
state: update.state,
|
|
110
|
+
target: toObjectIdentifiers(update.linkedSide)
|
|
111
|
+
}));
|
|
112
|
+
}
|
|
113
|
+
return;
|
|
114
|
+
}
|
|
115
|
+
default:
|
|
116
|
+
{
|
|
117
|
+
this.#failAll(new Error(`Unexpected message: ${message}`));
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
async #initiateSubscribe(subscription) {
|
|
122
|
+
try {
|
|
123
|
+
const objectDefinition = await this.client.ontologyProvider.getObjectDefinition(subscription.objectType.apiName);
|
|
124
|
+
if (isSubscriptionDone(subscription)) return;
|
|
125
|
+
subscription.request = {
|
|
126
|
+
linkTypes: [...subscription.links],
|
|
127
|
+
selectedObjects: subscription.objects.map(object => ({
|
|
128
|
+
objectType: subscription.objectType.apiName,
|
|
129
|
+
primaryKey: {
|
|
130
|
+
[objectDefinition.primaryKeyApiName]: typeof object === "object" ? object.$primaryKey : object
|
|
131
|
+
}
|
|
132
|
+
}))
|
|
133
|
+
};
|
|
134
|
+
await this.ensureWebsocket();
|
|
135
|
+
if (isSubscriptionDone(subscription)) return;
|
|
136
|
+
if (this.ws?.readyState === WebSocket.OPEN) {
|
|
137
|
+
this.sendSubscribeMessage();
|
|
138
|
+
}
|
|
139
|
+
} catch (error) {
|
|
140
|
+
this.logger?.error(error, "Error in #initiateSubscribe");
|
|
141
|
+
this.#fail(subscription, error);
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
#handleSubscribeResponses(requestId, responses) {
|
|
145
|
+
const subscriptions = this.pendingSubscriptions.get(requestId);
|
|
146
|
+
if (subscriptions == null) return;
|
|
147
|
+
this.pendingSubscriptions.delete(requestId);
|
|
148
|
+
responses.forEach((response, index) => {
|
|
149
|
+
const subscription = subscriptions[index];
|
|
150
|
+
if (subscription == null || isSubscriptionDone(subscription)) return;
|
|
151
|
+
switch (response.type) {
|
|
152
|
+
case "error":
|
|
153
|
+
this.#fail(subscription, response.errors);
|
|
154
|
+
return;
|
|
155
|
+
case "qos":
|
|
156
|
+
this.cycleWebsocket();
|
|
157
|
+
return;
|
|
158
|
+
case "success":
|
|
159
|
+
{
|
|
160
|
+
const previousStatus = subscription.status;
|
|
161
|
+
this.subscriptions.delete(subscription.subscriptionId);
|
|
162
|
+
subscription.status = "subscribed";
|
|
163
|
+
subscription.subscriptionId = response.id;
|
|
164
|
+
this.subscriptions.set(subscription.subscriptionId, subscription);
|
|
165
|
+
this.#callListener(subscription, () => {
|
|
166
|
+
if (previousStatus === "reconnecting") {
|
|
167
|
+
subscription.listener.onOutOfDate?.({
|
|
168
|
+
links: subscription.links
|
|
169
|
+
});
|
|
170
|
+
} else if (previousStatus === "preparing") {
|
|
171
|
+
subscription.listener.onSuccessfulSubscription?.();
|
|
172
|
+
}
|
|
173
|
+
});
|
|
174
|
+
return;
|
|
175
|
+
}
|
|
176
|
+
default:
|
|
177
|
+
{
|
|
178
|
+
this.#fail(subscription, new Error(`Unexpected response: ${response}`));
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
});
|
|
182
|
+
}
|
|
183
|
+
#callListener(subscription, callback) {
|
|
184
|
+
try {
|
|
185
|
+
callback();
|
|
186
|
+
} catch (error) {
|
|
187
|
+
try {
|
|
188
|
+
subscription.listener.onError?.({
|
|
189
|
+
error,
|
|
190
|
+
subscriptionClosed: false
|
|
191
|
+
});
|
|
192
|
+
} catch (onErrorError) {
|
|
193
|
+
this.#fail(subscription, onErrorError);
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
#fail(subscription, error) {
|
|
198
|
+
if (isSubscriptionDone(subscription)) return;
|
|
199
|
+
try {
|
|
200
|
+
subscription.listener.onError?.({
|
|
201
|
+
error,
|
|
202
|
+
subscriptionClosed: true
|
|
203
|
+
});
|
|
204
|
+
} catch (onErrorError) {
|
|
205
|
+
this.logger?.error(onErrorError, "Error in onError callback");
|
|
206
|
+
} finally {
|
|
207
|
+
this.endSubscription(subscription, "error");
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
#failAll(error) {
|
|
211
|
+
for (const subscription of this.subscriptions.values()) {
|
|
212
|
+
this.#fail(subscription, error);
|
|
213
|
+
}
|
|
214
|
+
this.cycleWebsocket();
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
function toObjectIdentifiers(locator) {
|
|
218
|
+
const primaryKey = Object.values(locator.primaryKey)[0];
|
|
219
|
+
!(primaryKey != null) ? process.env.NODE_ENV !== "production" ? invariant(false, "Expected a link object primary key.") : invariant(false) : void 0;
|
|
220
|
+
return {
|
|
221
|
+
$apiName: locator.objectType,
|
|
222
|
+
$primaryKey: primaryKey
|
|
223
|
+
};
|
|
224
|
+
}
|
|
225
|
+
//# sourceMappingURL=LinkSubscriptionWebsocket.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"LinkSubscriptionWebsocket.js","names":["WebSocket","invariant","isSubscriptionDone","SubscriptionWebsocket","constructLinkSubscriptionWebsocketUrl","nextUuid","LinkSubscriptionWebsocket","instances","WeakMap","getInstance","client","instance","get","clientCacheKey","set","constructor","subscribe","objectType","args","links","length","process","env","NODE_ENV","objects","subscription","listener","status","subscriptionId","subscriptions","cancelIdleDisconnect","initiateSubscribe","endSubscription","createConnection","ontologyRid","token","Promise","all","tokenProvider","url","baseUrl","createSubscribeRequests","requestId","readySubscriptions","id","requests","map","request","isSubscriptionReady","clearListener","reconnect","ensureWebsocket","catch","error","failAll","cycleWebsocket","pendingSubscriptions","clear","handleWebsocketMessage","message","type","callListener","onOutOfDate","linkTypes","handleSubscribeResponses","responses","fail","cause","update","updates","onChange","linkType","source","toObjectIdentifiers","selectedSide","state","target","linkedSide","Error","#initiateSubscribe","objectDefinition","ontologyProvider","getObjectDefinition","apiName","selectedObjects","object","primaryKey","primaryKeyApiName","$primaryKey","ws","readyState","OPEN","sendSubscribeMessage","logger","#handleSubscribeResponses","delete","forEach","response","index","errors","previousStatus","onSuccessfulSubscription","#callListener","callback","onError","subscriptionClosed","onErrorError","#fail","#failAll","values","locator","Object","$apiName"],"sources":["LinkSubscriptionWebsocket.ts"],"sourcesContent":["/*\n * Copyright 2026 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 LinkTypeApiNamesFor,\n ObjectIdentifiers,\n ObjectTypeDefinition,\n} from \"@osdk/api\";\nimport type { LinkSubscription } from \"@osdk/api/unstable\";\nimport type {\n LinkSubscriptionObjectLocator,\n LinksMessage,\n LinkTypeSubscribeRequest,\n LinkTypeSubscribeRequests,\n ObjectSetSubscribeResponse,\n} from \"@osdk/foundry.ontologies\";\nimport WebSocket from \"isomorphic-ws\";\nimport invariant from \"tiny-invariant\";\n\nimport type { ClientCacheKey, MinimalClient } from \"../MinimalClientContext.js\";\nimport type { SubscriptionConnection } from \"../SubscriptionConnection.js\";\nimport type { BaseSubscription } from \"./SubscriptionWebsocket.js\";\nimport {\n isSubscriptionDone,\n SubscriptionWebsocket,\n} from \"./SubscriptionWebsocket.js\";\nimport {\n constructLinkSubscriptionWebsocketUrl,\n nextUuid,\n} from \"./websocketUtils.js\";\n\ninterface Subscription<\n Q extends ObjectTypeDefinition,\n L extends LinkTypeApiNamesFor<Q>,\n> extends BaseSubscription {\n readonly links: ReadonlyArray<L>;\n listener: LinkSubscription.Listener<Q, L>;\n readonly objects: LinkSubscription.Args<Q, L>[\"objects\"];\n readonly objectType: Q;\n request?: LinkTypeSubscribeRequest;\n}\n\n/** @internal */\nexport class LinkSubscriptionWebsocket extends SubscriptionWebsocket<\n Subscription<any, any>,\n LinksMessage\n> {\n static #instances = new WeakMap<ClientCacheKey, LinkSubscriptionWebsocket>();\n\n static getInstance(client: MinimalClient): LinkSubscriptionWebsocket {\n let instance = LinkSubscriptionWebsocket.#instances.get(\n client.clientCacheKey,\n );\n if (instance == null) {\n instance = new LinkSubscriptionWebsocket(client);\n LinkSubscriptionWebsocket.#instances.set(client.clientCacheKey, instance);\n }\n return instance;\n }\n\n constructor(client: MinimalClient) {\n super(client, \"<LSW> \");\n }\n\n subscribe<Q extends ObjectTypeDefinition, L extends LinkTypeApiNamesFor<Q>>(\n objectType: Q,\n args: LinkSubscription.Args<Q, L>,\n ): () => void {\n invariant(\n args.links.length > 0,\n \"At least one link type is required to subscribe to links.\",\n );\n invariant(\n args.objects.length > 0,\n \"At least one object is required to subscribe to links.\",\n );\n\n const subscription: Subscription<Q, L> = {\n links: args.links,\n listener: args.listener,\n objects: args.objects,\n objectType,\n status: \"preparing\",\n subscriptionId: `TMP-${nextUuid()}`,\n };\n this.subscriptions.set(subscription.subscriptionId, subscription);\n this.cancelIdleDisconnect();\n\n void this.#initiateSubscribe(subscription);\n\n return () => this.endSubscription(subscription);\n }\n\n protected override async createConnection(): Promise<SubscriptionConnection> {\n const [ontologyRid, token] = await Promise.all([\n this.client.ontologyRid,\n this.client.tokenProvider(),\n ]);\n const url = constructLinkSubscriptionWebsocketUrl(\n this.client.baseUrl,\n ontologyRid,\n );\n return new WebSocket(url, [`Bearer-${token}`]);\n }\n\n protected override createSubscribeRequests(\n requestId: string,\n readySubscriptions: ReadonlyArray<Subscription<any, any>>,\n ): LinkTypeSubscribeRequests {\n return {\n id: requestId,\n requests: readySubscriptions.map((subscription) => {\n invariant(subscription.request != null, \"Expected a prepared request.\");\n return subscription.request;\n }),\n };\n }\n\n protected override isSubscriptionReady(\n subscription: Subscription<any, any>,\n ): boolean {\n return subscription.request != null;\n }\n\n protected override clearListener(subscription: Subscription<any, any>): void {\n subscription.listener = {};\n }\n\n protected override reconnect(): void {\n void this.ensureWebsocket().catch((error) => this.#failAll(error));\n }\n\n protected override cycleWebsocket(): void {\n this.pendingSubscriptions.clear();\n super.cycleWebsocket();\n }\n\n protected override handleWebsocketMessage(message: LinksMessage): void {\n switch (message.type) {\n case \"refresh\": {\n const subscription = this.subscriptions.get(message.id);\n if (subscription != null) {\n this.#callListener(subscription, () =>\n subscription.listener.onOutOfDate?.({\n links: message.linkTypes,\n }),\n );\n }\n return;\n }\n case \"subscribeResponses\":\n this.#handleSubscribeResponses(message.id, message.responses);\n return;\n case \"subscriptionClosed\": {\n const subscription = this.subscriptions.get(message.id);\n if (subscription != null) {\n this.#fail(subscription, message.cause);\n }\n return;\n }\n case \"updates\": {\n const subscription = this.subscriptions.get(message.id);\n if (subscription == null) return;\n for (const update of message.updates) {\n this.#callListener(subscription, () =>\n subscription.listener.onChange?.({\n linkType: update.linkType,\n source: toObjectIdentifiers(update.selectedSide),\n state: update.state,\n target: toObjectIdentifiers(update.linkedSide),\n }),\n );\n }\n return;\n }\n default: {\n const unexpectedMessage: never = message;\n this.#failAll(new Error(`Unexpected message: ${unexpectedMessage}`));\n }\n }\n }\n\n async #initiateSubscribe(\n subscription: Subscription<any, any>,\n ): Promise<void> {\n try {\n const objectDefinition =\n await this.client.ontologyProvider.getObjectDefinition(\n subscription.objectType.apiName,\n );\n\n if (isSubscriptionDone(subscription)) return;\n\n subscription.request = {\n linkTypes: [...subscription.links],\n selectedObjects: subscription.objects.map((object) => ({\n objectType: subscription.objectType.apiName,\n primaryKey: {\n [objectDefinition.primaryKeyApiName]:\n typeof object === \"object\" ? object.$primaryKey : object,\n },\n })),\n };\n\n await this.ensureWebsocket();\n if (isSubscriptionDone(subscription)) return;\n if (this.ws?.readyState === WebSocket.OPEN) {\n this.sendSubscribeMessage();\n }\n } catch (error) {\n this.logger?.error(error, \"Error in #initiateSubscribe\");\n this.#fail(subscription, error);\n }\n }\n\n #handleSubscribeResponses(\n requestId: string,\n responses: ReadonlyArray<ObjectSetSubscribeResponse>,\n ): void {\n const subscriptions = this.pendingSubscriptions.get(requestId);\n if (subscriptions == null) return;\n this.pendingSubscriptions.delete(requestId);\n\n responses.forEach((response, index) => {\n const subscription = subscriptions[index];\n if (subscription == null || isSubscriptionDone(subscription)) return;\n\n switch (response.type) {\n case \"error\":\n this.#fail(subscription, response.errors);\n return;\n case \"qos\":\n this.cycleWebsocket();\n return;\n case \"success\": {\n const previousStatus = subscription.status;\n this.subscriptions.delete(subscription.subscriptionId);\n subscription.status = \"subscribed\";\n subscription.subscriptionId = response.id;\n this.subscriptions.set(subscription.subscriptionId, subscription);\n this.#callListener(subscription, () => {\n if (previousStatus === \"reconnecting\") {\n subscription.listener.onOutOfDate?.({\n links: subscription.links,\n });\n } else if (previousStatus === \"preparing\") {\n subscription.listener.onSuccessfulSubscription?.();\n }\n });\n return;\n }\n default: {\n const unexpectedResponse: never = response;\n this.#fail(\n subscription,\n new Error(`Unexpected response: ${unexpectedResponse}`),\n );\n }\n }\n });\n }\n\n #callListener(\n subscription: Subscription<any, any>,\n callback: () => void,\n ): void {\n try {\n callback();\n } catch (error) {\n try {\n subscription.listener.onError?.({\n error,\n subscriptionClosed: false,\n });\n } catch (onErrorError) {\n this.#fail(subscription, onErrorError);\n }\n }\n }\n\n #fail(subscription: Subscription<any, any>, error: unknown): void {\n if (isSubscriptionDone(subscription)) return;\n try {\n subscription.listener.onError?.({ error, subscriptionClosed: true });\n } catch (onErrorError) {\n this.logger?.error(onErrorError, \"Error in onError callback\");\n } finally {\n this.endSubscription(subscription, \"error\");\n }\n }\n\n #failAll(error: unknown): void {\n for (const subscription of this.subscriptions.values()) {\n this.#fail(subscription, error);\n }\n this.cycleWebsocket();\n }\n}\n\nfunction toObjectIdentifiers(\n locator: LinkSubscriptionObjectLocator,\n): ObjectIdentifiers<ObjectTypeDefinition> {\n const primaryKey = Object.values(locator.primaryKey)[0];\n invariant(primaryKey != null, \"Expected a link object primary key.\");\n return {\n $apiName: locator.objectType,\n $primaryKey: primaryKey,\n };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA,OAAOA,SAAS,MAAM,eAAe;AACrC,OAAOC,SAAS,MAAM,gBAAgB;AAKtC,SACEC,kBAAkB,EAClBC,qBAAqB,QAChB,4BAA4B;AACnC,SACEC,qCAAqC,EACrCC,QAAQ,QACH,qBAAqB;AAa5B;AACA,OAAO,MAAMC,yBAAyB,SAASH,qBAAqB,CAGlE;EACA,OAAO,CAACI,SAAS,GAAG,IAAIC,OAAO,CAA4C,CAAC;EAE5E,OAAOC,WAAWA,CAACC,MAAqB,EAA6B;IACnE,IAAIC,QAAQ,GAAGL,yBAAyB,CAAC,CAACC,SAAS,CAACK,GAAG,CACrDF,MAAM,CAACG,cACT,CAAC;IACD,IAAIF,QAAQ,IAAI,IAAI,EAAE;MACpBA,QAAQ,GAAG,IAAIL,yBAAyB,CAACI,MAAM,CAAC;MAChDJ,yBAAyB,CAAC,CAACC,SAAS,CAACO,GAAG,CAACJ,MAAM,CAACG,cAAc,EAAEF,QAAQ,CAAC;IAC3E;IACA,OAAOA,QAAQ;EACjB;EAEAI,WAAWA,CAACL,MAAqB,EAAE;IACjC,KAAK,CAACA,MAAM,EAAE,QAAQ,CAAC;EACzB;EAEAM,SAASA,CACPC,UAAa,EACbC,IAAiC,EACrB;IACZ,EACEA,IAAI,CAACC,KAAK,CAACC,MAAM,GAAG,CAAC,IAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADvBtB,SAAS,QAEP,2DAA2D,IAF7DA,SAAS;IAIT,EACEiB,IAAI,CAACM,OAAO,CAACJ,MAAM,GAAG,CAAC,IAAAC,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBADzBtB,SAAS,QAEP,wDAAwD,IAF1DA,SAAS;IAKT,MAAMwB,YAAgC,GAAG;MACvCN,KAAK,EAAED,IAAI,CAACC,KAAK;MACjBO,QAAQ,EAAER,IAAI,CAACQ,QAAQ;MACvBF,OAAO,EAAEN,IAAI,CAACM,OAAO;MACrBP,UAAU;MACVU,MAAM,EAAE,WAAW;MACnBC,cAAc,EAAE,OAAOvB,QAAQ,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,CAACwB,aAAa,CAACf,GAAG,CAACW,YAAY,CAACG,cAAc,EAAEH,YAAY,CAAC;IACjE,IAAI,CAACK,oBAAoB,CAAC,CAAC;IAE3B,KAAK,IAAI,CAAC,CAACC,iBAAiB,CAACN,YAAY,CAAC;IAE1C,OAAO,MAAM,IAAI,CAACO,eAAe,CAACP,YAAY,CAAC;EACjD;EAEA,MAAyBQ,gBAAgBA,CAAA,EAAoC;IAC3E,MAAM,CAACC,WAAW,EAAEC,KAAK,CAAC,GAAG,MAAMC,OAAO,CAACC,GAAG,CAAC,CAC7C,IAAI,CAAC3B,MAAM,CAACwB,WAAW,EACvB,IAAI,CAACxB,MAAM,CAAC4B,aAAa,CAAC,CAAC,CAC5B,CAAC;IACF,MAAMC,GAAG,GAAGnC,qCAAqC,CAC/C,IAAI,CAACM,MAAM,CAAC8B,OAAO,EACnBN,WACF,CAAC;IACD,OAAO,IAAIlC,SAAS,CAACuC,GAAG,EAAE,CAAC,UAAUJ,KAAK,EAAE,CAAC,CAAC;EAChD;EAEmBM,uBAAuBA,CACxCC,SAAiB,EACjBC,kBAAyD,EAC9B;IAC3B,OAAO;MACLC,EAAE,EAAEF,SAAS;MACbG,QAAQ,EAAEF,kBAAkB,CAACG,GAAG,CAAErB,YAAY,IAAK;QACjD,EAAUA,YAAY,CAACsB,OAAO,IAAI,IAAI,IAAA1B,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAtCtB,SAAS,QAA+B,8BAA8B,IAAtEA,SAAS;QACT,OAAOwB,YAAY,CAACsB,OAAO;MAC7B,CAAC;IACH,CAAC;EACH;EAEmBC,mBAAmBA,CACpCvB,YAAoC,EAC3B;IACT,OAAOA,YAAY,CAACsB,OAAO,IAAI,IAAI;EACrC;EAEmBE,aAAaA,CAACxB,YAAoC,EAAQ;IAC3EA,YAAY,CAACC,QAAQ,GAAG,CAAC,CAAC;EAC5B;EAEmBwB,SAASA,CAAA,EAAS;IACnC,KAAK,IAAI,CAACC,eAAe,CAAC,CAAC,CAACC,KAAK,CAAEC,KAAK,IAAK,IAAI,CAAC,CAACC,OAAO,CAACD,KAAK,CAAC,CAAC;EACpE;EAEmBE,cAAcA,CAAA,EAAS;IACxC,IAAI,CAACC,oBAAoB,CAACC,KAAK,CAAC,CAAC;IACjC,KAAK,CAACF,cAAc,CAAC,CAAC;EACxB;EAEmBG,sBAAsBA,CAACC,OAAqB,EAAQ;IACrE,QAAQA,OAAO,CAACC,IAAI;MAClB,KAAK,SAAS;QAAE;UACd,MAAMnC,YAAY,GAAG,IAAI,CAACI,aAAa,CAACjB,GAAG,CAAC+C,OAAO,CAACf,EAAE,CAAC;UACvD,IAAInB,YAAY,IAAI,IAAI,EAAE;YACxB,IAAI,CAAC,CAACoC,YAAY,CAACpC,YAAY,EAAE,MAC/BA,YAAY,CAACC,QAAQ,CAACoC,WAAW,GAAG;cAClC3C,KAAK,EAAEwC,OAAO,CAACI;YACjB,CAAC,CACH,CAAC;UACH;UACA;QACF;MACA,KAAK,oBAAoB;QACvB,IAAI,CAAC,CAACC,wBAAwB,CAACL,OAAO,CAACf,EAAE,EAAEe,OAAO,CAACM,SAAS,CAAC;QAC7D;MACF,KAAK,oBAAoB;QAAE;UACzB,MAAMxC,YAAY,GAAG,IAAI,CAACI,aAAa,CAACjB,GAAG,CAAC+C,OAAO,CAACf,EAAE,CAAC;UACvD,IAAInB,YAAY,IAAI,IAAI,EAAE;YACxB,IAAI,CAAC,CAACyC,IAAI,CAACzC,YAAY,EAAEkC,OAAO,CAACQ,KAAK,CAAC;UACzC;UACA;QACF;MACA,KAAK,SAAS;QAAE;UACd,MAAM1C,YAAY,GAAG,IAAI,CAACI,aAAa,CAACjB,GAAG,CAAC+C,OAAO,CAACf,EAAE,CAAC;UACvD,IAAInB,YAAY,IAAI,IAAI,EAAE;UAC1B,KAAK,MAAM2C,MAAM,IAAIT,OAAO,CAACU,OAAO,EAAE;YACpC,IAAI,CAAC,CAACR,YAAY,CAACpC,YAAY,EAAE,MAC/BA,YAAY,CAACC,QAAQ,CAAC4C,QAAQ,GAAG;cAC/BC,QAAQ,EAAEH,MAAM,CAACG,QAAQ;cACzBC,MAAM,EAAEC,mBAAmB,CAACL,MAAM,CAACM,YAAY,CAAC;cAChDC,KAAK,EAAEP,MAAM,CAACO,KAAK;cACnBC,MAAM,EAAEH,mBAAmB,CAACL,MAAM,CAACS,UAAU;YAC/C,CAAC,CACH,CAAC;UACH;UACA;QACF;MACA;QAAS;UAEP,IAAI,CAAC,CAACvB,OAAO,CAAC,IAAIwB,KAAK,CAAC,uBADSnB,OAAO,EAC0B,CAAC,CAAC;QACtE;IACF;EACF;EAEA,MAAM,CAAC5B,iBAAiBgD,CACtBtD,YAAoC,EACrB;IACf,IAAI;MACF,MAAMuD,gBAAgB,GACpB,MAAM,IAAI,CAACtE,MAAM,CAACuE,gBAAgB,CAACC,mBAAmB,CACpDzD,YAAY,CAACR,UAAU,CAACkE,OAC1B,CAAC;MAEH,IAAIjF,kBAAkB,CAACuB,YAAY,CAAC,EAAE;MAEtCA,YAAY,CAACsB,OAAO,GAAG;QACrBgB,SAAS,EAAE,CAAC,GAAGtC,YAAY,CAACN,KAAK,CAAC;QAClCiE,eAAe,EAAE3D,YAAY,CAACD,OAAO,CAACsB,GAAG,CAAEuC,MAAM,KAAM;UACrDpE,UAAU,EAAEQ,YAAY,CAACR,UAAU,CAACkE,OAAO;UAC3CG,UAAU,EAAE;YACV,CAACN,gBAAgB,CAACO,iBAAiB,GACjC,OAAOF,MAAM,KAAK,QAAQ,GAAGA,MAAM,CAACG,WAAW,GAAGH;UACtD;QACF,CAAC,CAAC;MACJ,CAAC;MAED,MAAM,IAAI,CAAClC,eAAe,CAAC,CAAC;MAC5B,IAAIjD,kBAAkB,CAACuB,YAAY,CAAC,EAAE;MACtC,IAAI,IAAI,CAACgE,EAAE,EAAEC,UAAU,KAAK1F,SAAS,CAAC2F,IAAI,EAAE;QAC1C,IAAI,CAACC,oBAAoB,CAAC,CAAC;MAC7B;IACF,CAAC,CAAC,OAAOvC,KAAK,EAAE;MACd,IAAI,CAACwC,MAAM,EAAExC,KAAK,CAACA,KAAK,EAAE,6BAA6B,CAAC;MACxD,IAAI,CAAC,CAACa,IAAI,CAACzC,YAAY,EAAE4B,KAAK,CAAC;IACjC;EACF;EAEA,CAACW,wBAAwB8B,CACvBpD,SAAiB,EACjBuB,SAAoD,EAC9C;IACN,MAAMpC,aAAa,GAAG,IAAI,CAAC2B,oBAAoB,CAAC5C,GAAG,CAAC8B,SAAS,CAAC;IAC9D,IAAIb,aAAa,IAAI,IAAI,EAAE;IAC3B,IAAI,CAAC2B,oBAAoB,CAACuC,MAAM,CAACrD,SAAS,CAAC;IAE3CuB,SAAS,CAAC+B,OAAO,CAAC,CAACC,QAAQ,EAAEC,KAAK,KAAK;MACrC,MAAMzE,YAAY,GAAGI,aAAa,CAACqE,KAAK,CAAC;MACzC,IAAIzE,YAAY,IAAI,IAAI,IAAIvB,kBAAkB,CAACuB,YAAY,CAAC,EAAE;MAE9D,QAAQwE,QAAQ,CAACrC,IAAI;QACnB,KAAK,OAAO;UACV,IAAI,CAAC,CAACM,IAAI,CAACzC,YAAY,EAAEwE,QAAQ,CAACE,MAAM,CAAC;UACzC;QACF,KAAK,KAAK;UACR,IAAI,CAAC5C,cAAc,CAAC,CAAC;UACrB;QACF,KAAK,SAAS;UAAE;YACd,MAAM6C,cAAc,GAAG3E,YAAY,CAACE,MAAM;YAC1C,IAAI,CAACE,aAAa,CAACkE,MAAM,CAACtE,YAAY,CAACG,cAAc,CAAC;YACtDH,YAAY,CAACE,MAAM,GAAG,YAAY;YAClCF,YAAY,CAACG,cAAc,GAAGqE,QAAQ,CAACrD,EAAE;YACzC,IAAI,CAACf,aAAa,CAACf,GAAG,CAACW,YAAY,CAACG,cAAc,EAAEH,YAAY,CAAC;YACjE,IAAI,CAAC,CAACoC,YAAY,CAACpC,YAAY,EAAE,MAAM;cACrC,IAAI2E,cAAc,KAAK,cAAc,EAAE;gBACrC3E,YAAY,CAACC,QAAQ,CAACoC,WAAW,GAAG;kBAClC3C,KAAK,EAAEM,YAAY,CAACN;gBACtB,CAAC,CAAC;cACJ,CAAC,MAAM,IAAIiF,cAAc,KAAK,WAAW,EAAE;gBACzC3E,YAAY,CAACC,QAAQ,CAAC2E,wBAAwB,GAAG,CAAC;cACpD;YACF,CAAC,CAAC;YACF;UACF;QACA;UAAS;YAEP,IAAI,CAAC,CAACnC,IAAI,CACRzC,YAAY,EACZ,IAAIqD,KAAK,CAAC,wBAHsBmB,QAAQ,EAGc,CACxD,CAAC;UACH;MACF;IACF,CAAC,CAAC;EACJ;EAEA,CAACpC,YAAYyC,CACX7E,YAAoC,EACpC8E,QAAoB,EACd;IACN,IAAI;MACFA,QAAQ,CAAC,CAAC;IACZ,CAAC,CAAC,OAAOlD,KAAK,EAAE;MACd,IAAI;QACF5B,YAAY,CAACC,QAAQ,CAAC8E,OAAO,GAAG;UAC9BnD,KAAK;UACLoD,kBAAkB,EAAE;QACtB,CAAC,CAAC;MACJ,CAAC,CAAC,OAAOC,YAAY,EAAE;QACrB,IAAI,CAAC,CAACxC,IAAI,CAACzC,YAAY,EAAEiF,YAAY,CAAC;MACxC;IACF;EACF;EAEA,CAACxC,IAAIyC,CAAClF,YAAoC,EAAE4B,KAAc,EAAQ;IAChE,IAAInD,kBAAkB,CAACuB,YAAY,CAAC,EAAE;IACtC,IAAI;MACFA,YAAY,CAACC,QAAQ,CAAC8E,OAAO,GAAG;QAAEnD,KAAK;QAAEoD,kBAAkB,EAAE;MAAK,CAAC,CAAC;IACtE,CAAC,CAAC,OAAOC,YAAY,EAAE;MACrB,IAAI,CAACb,MAAM,EAAExC,KAAK,CAACqD,YAAY,EAAE,2BAA2B,CAAC;IAC/D,CAAC,SAAS;MACR,IAAI,CAAC1E,eAAe,CAACP,YAAY,EAAE,OAAO,CAAC;IAC7C;EACF;EAEA,CAAC6B,OAAOsD,CAACvD,KAAc,EAAQ;IAC7B,KAAK,MAAM5B,YAAY,IAAI,IAAI,CAACI,aAAa,CAACgF,MAAM,CAAC,CAAC,EAAE;MACtD,IAAI,CAAC,CAAC3C,IAAI,CAACzC,YAAY,EAAE4B,KAAK,CAAC;IACjC;IACA,IAAI,CAACE,cAAc,CAAC,CAAC;EACvB;AACF;AAEA,SAASkB,mBAAmBA,CAC1BqC,OAAsC,EACG;EACzC,MAAMxB,UAAU,GAAGyB,MAAM,CAACF,MAAM,CAACC,OAAO,CAACxB,UAAU,CAAC,CAAC,CAAC,CAAC;EACvD,EAAUA,UAAU,IAAI,IAAI,IAAAjE,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAA5BtB,SAAS,QAAqB,qCAAqC,IAAnEA,SAAS;EACT,OAAO;IACL+G,QAAQ,EAAEF,OAAO,CAAC7F,UAAU;IAC5BuE,WAAW,EAAEF;EACf,CAAC;AACH","ignoreList":[]}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2026 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 ImportedWebSocket from "isomorphic-ws";
|
|
18
|
+
import { vi } from "vitest";
|
|
19
|
+
export function createMockWebSocketConstructor(OriginalWebSocket, logger) {
|
|
20
|
+
let webSocketInstance = 0;
|
|
21
|
+
const MockWebSocket = vi.fn((..._args) => {
|
|
22
|
+
const currentWebSocketInstance = webSocketInstance++;
|
|
23
|
+
logger?.debug("WebSocket constructor called");
|
|
24
|
+
const eventEmitter = new EventTarget();
|
|
25
|
+
return {
|
|
26
|
+
addEventListener: vi.fn(eventEmitter.addEventListener.bind(eventEmitter)),
|
|
27
|
+
close: vi.fn(),
|
|
28
|
+
readyState: OriginalWebSocket.CONNECTING,
|
|
29
|
+
removeEventListener: vi.fn(eventEmitter.removeEventListener.bind(eventEmitter)),
|
|
30
|
+
send: vi.fn(data => {
|
|
31
|
+
logger?.debug({
|
|
32
|
+
message: JSON.parse(data.toString()),
|
|
33
|
+
webSocketInstance: currentWebSocketInstance
|
|
34
|
+
}, "send() called");
|
|
35
|
+
}),
|
|
36
|
+
_eventEmitter: eventEmitter
|
|
37
|
+
};
|
|
38
|
+
});
|
|
39
|
+
Object.assign(MockWebSocket, {
|
|
40
|
+
CLOSED: OriginalWebSocket.CLOSED,
|
|
41
|
+
CLOSING: OriginalWebSocket.CLOSING,
|
|
42
|
+
CONNECTING: OriginalWebSocket.CONNECTING,
|
|
43
|
+
OPEN: OriginalWebSocket.OPEN
|
|
44
|
+
});
|
|
45
|
+
return MockWebSocket;
|
|
46
|
+
}
|
|
47
|
+
export function sendToClient(webSocket, data) {
|
|
48
|
+
webSocket._eventEmitter.dispatchEvent(Object.assign(new Event("message"), {
|
|
49
|
+
data: JSON.stringify(data)
|
|
50
|
+
}));
|
|
51
|
+
}
|
|
52
|
+
export function setWebSocketState(webSocket, readyState) {
|
|
53
|
+
const newState = readyState === "open" ? ImportedWebSocket.OPEN : ImportedWebSocket.CLOSED;
|
|
54
|
+
if (newState === webSocket.readyState) return;
|
|
55
|
+
webSocket.readyState = newState;
|
|
56
|
+
webSocket._eventEmitter.dispatchEvent(new Event(readyState));
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=MockWebSocket.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MockWebSocket.js","names":["ImportedWebSocket","vi","createMockWebSocketConstructor","OriginalWebSocket","logger","webSocketInstance","MockWebSocket","fn","_args","currentWebSocketInstance","debug","eventEmitter","EventTarget","addEventListener","bind","close","readyState","CONNECTING","removeEventListener","send","data","message","JSON","parse","toString","_eventEmitter","Object","assign","CLOSED","CLOSING","OPEN","sendToClient","webSocket","dispatchEvent","Event","stringify","setWebSocketState","newState"],"sources":["MockWebSocket.ts"],"sourcesContent":["/*\n * Copyright 2026 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 { Logger } from \"@osdk/api\";\nimport ImportedWebSocket from \"isomorphic-ws\";\nimport type { MockedClass, MockedFunction, MockedObject } from \"vitest\";\nimport { vi } from \"vitest\";\n\ninterface RawWebSocketPlus extends Pick<\n ImportedWebSocket,\n \"addEventListener\" | \"removeEventListener\"\n> {\n readonly _eventEmitter: EventTarget;\n readonly close: MockedFunction<ImportedWebSocket[\"close\"]>;\n readyState: 0 | 1 | 2 | 3;\n readonly send: MockedFunction<ImportedWebSocket[\"send\"]>;\n}\n\nexport interface MockedWebSocket\n extends\n MockedClass<typeof ImportedWebSocket>,\n MockedObject<RawWebSocketPlus> {}\n\nexport function createMockWebSocketConstructor(\n OriginalWebSocket: typeof ImportedWebSocket,\n logger?: Pick<Logger, \"debug\">,\n): MockedWebSocket {\n let webSocketInstance = 0;\n const MockWebSocket = vi.fn((..._args: any[]): MockedWebSocket => {\n const currentWebSocketInstance = webSocketInstance++;\n logger?.debug(\"WebSocket constructor called\");\n const eventEmitter = new EventTarget();\n\n return {\n addEventListener: vi.fn(\n eventEmitter.addEventListener.bind(eventEmitter),\n ) as any,\n close: vi.fn(),\n readyState: OriginalWebSocket.CONNECTING,\n removeEventListener: vi.fn(\n eventEmitter.removeEventListener.bind(eventEmitter),\n ) as any,\n send: vi.fn((data, _callback: any) => {\n logger?.debug(\n {\n message: JSON.parse(data.toString()),\n webSocketInstance: currentWebSocketInstance,\n },\n \"send() called\",\n );\n }),\n _eventEmitter: eventEmitter,\n } satisfies RawWebSocketPlus as any as MockedWebSocket;\n }) as any as MockedWebSocket;\n\n Object.assign(MockWebSocket, {\n CLOSED: OriginalWebSocket.CLOSED,\n CLOSING: OriginalWebSocket.CLOSING,\n CONNECTING: OriginalWebSocket.CONNECTING,\n OPEN: OriginalWebSocket.OPEN,\n });\n\n return MockWebSocket;\n}\n\nexport function sendToClient<T>(webSocket: MockedWebSocket, data: T): void {\n webSocket._eventEmitter.dispatchEvent(\n Object.assign(new Event(\"message\"), { data: JSON.stringify(data) }),\n );\n}\n\nexport function setWebSocketState(\n webSocket: MockedWebSocket,\n readyState: \"close\" | \"open\",\n): void {\n const newState =\n readyState === \"open\" ? ImportedWebSocket.OPEN : ImportedWebSocket.CLOSED;\n\n if (newState === webSocket.readyState) return;\n\n webSocket.readyState = newState;\n webSocket._eventEmitter.dispatchEvent(new Event(readyState));\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,OAAOA,iBAAiB,MAAM,eAAe;AAE7C,SAASC,EAAE,QAAQ,QAAQ;AAiB3B,OAAO,SAASC,8BAA8BA,CAC5CC,iBAA2C,EAC3CC,MAA8B,EACb;EACjB,IAAIC,iBAAiB,GAAG,CAAC;EACzB,MAAMC,aAAa,GAAGL,EAAE,CAACM,EAAE,CAAC,CAAC,GAAGC,KAAY,KAAsB;IAChE,MAAMC,wBAAwB,GAAGJ,iBAAiB,EAAE;IACpDD,MAAM,EAAEM,KAAK,CAAC,8BAA8B,CAAC;IAC7C,MAAMC,YAAY,GAAG,IAAIC,WAAW,CAAC,CAAC;IAEtC,OAAO;MACLC,gBAAgB,EAAEZ,EAAE,CAACM,EAAE,CACrBI,YAAY,CAACE,gBAAgB,CAACC,IAAI,CAACH,YAAY,CACjD,CAAQ;MACRI,KAAK,EAAEd,EAAE,CAACM,EAAE,CAAC,CAAC;MACdS,UAAU,EAAEb,iBAAiB,CAACc,UAAU;MACxCC,mBAAmB,EAAEjB,EAAE,CAACM,EAAE,CACxBI,YAAY,CAACO,mBAAmB,CAACJ,IAAI,CAACH,YAAY,CACpD,CAAQ;MACRQ,IAAI,EAAElB,EAAE,CAACM,EAAE,CAAEa,IAAI,IAAqB;QACpChB,MAAM,EAAEM,KAAK,CACX;UACEW,OAAO,EAAEC,IAAI,CAACC,KAAK,CAACH,IAAI,CAACI,QAAQ,CAAC,CAAC,CAAC;UACpCnB,iBAAiB,EAAEI;QACrB,CAAC,EACD,eACF,CAAC;MACH,CAAC,CAAC;MACFgB,aAAa,EAAEd;IACjB,CAAC;EACH,CAAC,CAA2B;EAE5Be,MAAM,CAACC,MAAM,CAACrB,aAAa,EAAE;IAC3BsB,MAAM,EAAEzB,iBAAiB,CAACyB,MAAM;IAChCC,OAAO,EAAE1B,iBAAiB,CAAC0B,OAAO;IAClCZ,UAAU,EAAEd,iBAAiB,CAACc,UAAU;IACxCa,IAAI,EAAE3B,iBAAiB,CAAC2B;EAC1B,CAAC,CAAC;EAEF,OAAOxB,aAAa;AACtB;AAEA,OAAO,SAASyB,YAAYA,CAAIC,SAA0B,EAAEZ,IAAO,EAAQ;EACzEY,SAAS,CAACP,aAAa,CAACQ,aAAa,CACnCP,MAAM,CAACC,MAAM,CAAC,IAAIO,KAAK,CAAC,SAAS,CAAC,EAAE;IAAEd,IAAI,EAAEE,IAAI,CAACa,SAAS,CAACf,IAAI;EAAE,CAAC,CACpE,CAAC;AACH;AAEA,OAAO,SAASgB,iBAAiBA,CAC/BJ,SAA0B,EAC1BhB,UAA4B,EACtB;EACN,MAAMqB,QAAQ,GACZrB,UAAU,KAAK,MAAM,GAAGhB,iBAAiB,CAAC8B,IAAI,GAAG9B,iBAAiB,CAAC4B,MAAM;EAE3E,IAAIS,QAAQ,KAAKL,SAAS,CAAChB,UAAU,EAAE;EAEvCgB,SAAS,CAAChB,UAAU,GAAGqB,QAAQ;EAC/BL,SAAS,CAACP,aAAa,CAACQ,aAAa,CAAC,IAAIC,KAAK,CAAClB,UAAU,CAAC,CAAC;AAC9D","ignoreList":[]}
|