RDP's in TS OSDK #1035
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| "@osdk/shared.test": minor | ||
| "@osdk/client": minor | ||
| "@osdk/api": minor | ||
| --- | ||
|
|
||
| Adds support for runtime derived properties |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /* | ||
| * Copyright 2024 Palantir Technologies, Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import type { | ||
| ObjectOrInterfaceDefinition, | ||
| } from "../ontology/ObjectOrInterface.js"; | ||
| import type { | ||
| ObjectMetadata, | ||
| PropertyDef, | ||
| } from "../ontology/ObjectTypeDefinition.js"; | ||
| import type { BaseDeriveObjectSet } from "./DeriveObjectSet.js"; | ||
|
|
||
| export type DerivedPropertyDefinition< | ||
| T extends ObjectMetadata.Property, | ||
| > = { | ||
| definitionId: unknown; | ||
| type: T; | ||
| }; | ||
|
|
||
| export type DeriveClause< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| > = { | ||
| [key: string]: ( | ||
| baseObjectSet: BaseDeriveObjectSet<Q>, | ||
| ) => DerivedPropertyDefinition<ObjectMetadata.Property>; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| /* | ||
| * Copyright 2024 Palantir Technologies, Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import type { ValidAggregationKeys } from "../aggregate/AggregatableKeys.js"; | ||
| import type { WhereClause } from "../aggregate/WhereClause.js"; | ||
| import type { | ||
| ObjectOrInterfaceDefinition, | ||
| PropertyKeys, | ||
| } from "../ontology/ObjectOrInterface.js"; | ||
| import type { | ||
| CompileTimeMetadata, | ||
| PropertyDef, | ||
| } from "../ontology/ObjectTypeDefinition.js"; | ||
| import type { LinkedType, LinkNames } from "../util/LinkUtils.js"; | ||
| import type { DerivedPropertyDefinition } from "./DeriveClause.js"; | ||
|
|
||
| export interface BaseDeriveObjectSet<Q extends ObjectOrInterfaceDefinition> | ||
| extends FilterableDeriveObjectSet<Q> | ||
| { | ||
| readonly pivotTo: <L extends LinkNames<Q>>( | ||
| type: L, | ||
| ) => NonNullable<CompileTimeMetadata<Q>["links"][L]["multiplicity"]> extends | ||
| false ? SingleLinkDeriveObjectSet<LinkedType<Q, L>> | ||
| : ManyLinkDeriveObjectSet<LinkedType<Q, L>>; | ||
| } | ||
|
|
||
| export interface DeriveObjectSet<Q extends ObjectOrInterfaceDefinition> | ||
| extends | ||
| BaseDeriveObjectSet<Q>, | ||
| AggregatableDeriveObjectSet<Q>, | ||
| SingleLinkDeriveObjectSet<Q> | ||
| {} | ||
|
|
||
| interface FilterableDeriveObjectSet< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| > { | ||
| readonly where: ( | ||
| clause: WhereClause<Q>, | ||
| ) => this; | ||
| } | ||
|
|
||
| type CollectAggregations = "collectSet" | "collectList"; | ||
|
There was a problem hiding this comment. Parroting gateway names for now. This probably needs a review into |
||
|
|
||
| type BaseDeriveAggregations = | ||
| | "approximateDistinct" | ||
| | "exactDistinct" | ||
| | "approximatePercentile"; | ||
|
|
||
| export type StringDeriveAggregateOption = | ||
| | BaseDeriveAggregations | ||
| | CollectAggregations; | ||
| export type NumericDeriveAggregateOption = | ||
| | "min" | ||
| | "max" | ||
| | "sum" | ||
| | "avg" | ||
| | BaseDeriveAggregations | ||
| | CollectAggregations; | ||
|
|
||
| interface AggregatableDeriveObjectSet< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| > extends FilterableDeriveObjectSet<Q> { | ||
| readonly aggregate: < | ||
| V extends ValidAggregationKeys< | ||
| Q, | ||
| StringDeriveAggregateOption, | ||
| NumericDeriveAggregateOption | ||
| >, | ||
| >( | ||
| aggregationSpecifier: V, | ||
| opts?: V extends `${any}:${infer P}` | ||
| ? P extends CollectAggregations ? { limit: number } | ||
| : P extends "approximatePercentile" ? { percentile: number } | ||
| : never | ||
| : never, | ||
| ) => DerivedPropertyDefinition< | ||
| V extends `${infer N}:${infer P}` | ||
| ? P extends CollectAggregations ? PropertyDef< | ||
| CompileTimeMetadata<Q>["properties"][N]["type"], | ||
| "nullable", | ||
| "array" | ||
| > | ||
| : P extends "approximateDistinct" | "exactDistinct" | "$count" | ||
| ? PropertyDef<"integer"> | ||
| : PropertyDef<"double"> | ||
| : never | ||
| >; | ||
| } | ||
|
|
||
| interface SingleLinkDeriveObjectSet< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| > extends AggregatableDeriveObjectSet<Q>, BaseDeriveObjectSet<Q> { | ||
| readonly selectProperty: <R extends PropertyKeys<Q>>( | ||
| propertyName: R, | ||
| ) => DerivedPropertyDefinition<CompileTimeMetadata<Q>["properties"][R]>; | ||
| } | ||
|
|
||
| interface ManyLinkDeriveObjectSet< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| > extends AggregatableDeriveObjectSet<Q> { | ||
| readonly pivotTo: <L extends LinkNames<Q>>( | ||
| type: L, | ||
| ) => ManyLinkDeriveObjectSet<LinkedType<Q, L>>; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we want to keep all the agg options a bit simpler to parse though, another way to format this type could be keeping the
Agg_For_Typeand modifying it to take an extra boolean (that controls whether this is for derive or not, default to false) and have it branch to the right agg options that way, rather than having the responsibility on the user to pass in custom options if they want. That being said, if you feel like in the future we'll need to customize agg options even more, this does make it more flexible so up to youThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you do keep it like this, lets remove
AGG_FOR_TYPEif its not being used anywhereThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm yeah this does make sense to me, will refactor