|
| 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 type { |
| 18 | + LinkTypeApiNamesFor, |
| 19 | + LinkedObjectType, |
| 20 | +} from "../objectSet/ObjectSetLinks.js"; |
| 21 | +import type { ObjectTypeDefinition } from "../ontology/ObjectTypeDefinition.js"; |
| 22 | +import type { ObjectIdentifiers } from "../OsdkBase.js"; |
| 23 | +import type { OsdkObjectPrimaryKeyType } from "../OsdkObjectPrimaryKeyType.js"; |
| 24 | +import type { Experiment } from "./Experiment.js"; |
| 25 | + |
| 26 | +export namespace LinkSubscription { |
| 27 | + export interface Args< |
| 28 | + Q extends ObjectTypeDefinition, |
| 29 | + L extends LinkTypeApiNamesFor<Q>, |
| 30 | + > { |
| 31 | + readonly links: ReadonlyArray<L>; |
| 32 | + readonly listener: Listener<NoInfer<Q>, NoInfer<L>>; |
| 33 | + readonly objects: ReadonlyArray< |
| 34 | + ObjectIdentifiers<NoInfer<Q>> | OsdkObjectPrimaryKeyType<NoInfer<Q>> |
| 35 | + >; |
| 36 | + } |
| 37 | + |
| 38 | + export interface Listener< |
| 39 | + Q extends ObjectTypeDefinition, |
| 40 | + L extends LinkTypeApiNamesFor<Q>, |
| 41 | + > { |
| 42 | + readonly onChange?: (linkUpdate: LinkUpdate<Q, L>) => void; |
| 43 | + readonly onError?: (error: { |
| 44 | + readonly error: unknown; |
| 45 | + readonly subscriptionClosed: boolean; |
| 46 | + }) => void; |
| 47 | + readonly onOutOfDate?: (event: OutOfDateEvent<L>) => void; |
| 48 | + readonly onSuccessfulSubscription?: () => void; |
| 49 | + } |
| 50 | + |
| 51 | + export type LinkUpdate< |
| 52 | + Q extends ObjectTypeDefinition, |
| 53 | + L extends LinkTypeApiNamesFor<Q>, |
| 54 | + > = |
| 55 | + L extends LinkTypeApiNamesFor<Q> |
| 56 | + ? { |
| 57 | + readonly linkType: L; |
| 58 | + readonly source: ObjectIdentifiers<Q>; |
| 59 | + readonly state: "ADDED" | "REMOVED"; |
| 60 | + readonly target: ObjectIdentifiers<LinkedObjectType<Q, L>>; |
| 61 | + } |
| 62 | + : never; |
| 63 | + |
| 64 | + export interface OutOfDateEvent<L extends string> { |
| 65 | + readonly links: ReadonlyArray<L>; |
| 66 | + } |
| 67 | +} |
| 68 | + |
| 69 | +type SubscribeToLinks = < |
| 70 | + const Q extends ObjectTypeDefinition, |
| 71 | + const L extends LinkTypeApiNamesFor<NoInfer<Q>>, |
| 72 | +>( |
| 73 | + objectType: Q, |
| 74 | + args: LinkSubscription.Args<Q, L>, |
| 75 | +) => { readonly unsubscribe: () => void }; |
| 76 | + |
| 77 | +export const __EXPERIMENTAL__NOT_SUPPORTED_YET__linkSubscriptions: Experiment< |
| 78 | + "2.59.0", |
| 79 | + "__EXPERIMENTAL__NOT_SUPPORTED_YET__linkSubscriptions", |
| 80 | + { readonly subscribeToLinks: SubscribeToLinks } |
| 81 | +> = { |
| 82 | + name: "__EXPERIMENTAL__NOT_SUPPORTED_YET__linkSubscriptions", |
| 83 | + type: "experiment", |
| 84 | + version: "2.59.0", |
| 85 | +}; |
0 commit comments