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 |
|---|---|---|
|
|
@@ -14,6 +14,10 @@ | |
| * limitations under the License. | ||
| */ | ||
|
|
||
| import type { | ||
| NumericWithPropAggregateOption, | ||
| StringWithPropAggregateOption, | ||
| } from "../derivedProperties/WithPropertiesAggregationOptions.js"; | ||
| import type { | ||
| GetWirePropertyValueFromClient, | ||
| } from "../mapping/PropertyValueMapping.js"; | ||
|
|
@@ -32,19 +36,23 @@ export type NumericAggregateOption = | |
| | "approximateDistinct" | ||
| | "exactDistinct"; | ||
|
|
||
| type AGG_FOR_TYPE<T, U extends boolean> = number extends T | ||
| ? U extends true ? NumericAggregateOption : NumericWithPropAggregateOption | ||
| : string extends T | ||
| ? U extends true ? StringAggregateOption : StringWithPropAggregateOption | ||
| : never; | ||
|
|
||
| export type ValidAggregationKeys< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| R extends "aggregate" | "withPropertiesAggregate" = "aggregate", | ||
|
There was a problem hiding this comment. @ssanjay1 Is this what you had in mind? There was a problem hiding this comment. Though maybe keeping parity with the other names it should be |
||
| > = keyof ( | ||
| & { | ||
| [ | ||
| KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE< | ||
| GetWirePropertyValueFromClient< | ||
| CompileTimeMetadata<Q>["properties"][KK]["type"] | ||
| >, | ||
| R extends "aggregate" ? true : false | ||
| >}` | ||
| ]?: any; | ||
| } | ||
|
|
||
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,132 @@ | ||
| /* | ||
| * 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 } from "../ontology/ObjectTypeDefinition.js"; | ||
| import type { SimplePropertyDef } from "../ontology/SimplePropertyDef.js"; | ||
| import type { LinkedType, LinkNames } from "../util/LinkUtils.js"; | ||
| import type { CollectWithPropAggregations } from "./WithPropertiesAggregationOptions.js"; | ||
|
|
||
| export namespace DerivedProperty { | ||
| export type SelectorResult< | ||
| T extends SimplePropertyDef, | ||
| > = { | ||
| type: T; | ||
| }; | ||
|
|
||
| export type Clause< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| > = { | ||
| [key: string]: Selector<Q, SimplePropertyDef>; | ||
| }; | ||
|
|
||
| export type Selector< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| T extends SimplePropertyDef, | ||
| > = ( | ||
| baseObjectSet: DerivedProperty.Builder<Q, false>, | ||
| ) => SelectorResult<T>; | ||
|
|
||
| export interface Builder< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| CONSTRAINED extends boolean, | ||
| > extends Filterable<Q, CONSTRAINED>, Pivotable<Q, CONSTRAINED> { | ||
| } | ||
|
|
||
| export interface AggregateBuilder< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| CONSTRAINED extends boolean, | ||
| > extends Builder<Q, CONSTRAINED>, Aggregatable<Q> { | ||
| } | ||
|
|
||
| export interface SelectPropertyBuilder< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| CONSTRAINED extends boolean, | ||
| > extends AggregateBuilder<Q, CONSTRAINED>, Selectable<Q> { | ||
| } | ||
| } | ||
|
|
||
| type BuilderTypeFromConstraint< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| CONSTRAINED extends boolean, | ||
| > = CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<Q, true> | ||
| : DerivedProperty.SelectPropertyBuilder<Q, false>; | ||
|
|
||
| type Filterable< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| CONSTRAINED extends boolean, | ||
| > = { | ||
| readonly where: ( | ||
| clause: WhereClause<Q>, | ||
| ) => BuilderTypeFromConstraint<Q, CONSTRAINED>; | ||
| }; | ||
|
|
||
| type Pivotable< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| CONSTRAINED extends boolean, | ||
| > = { | ||
| readonly pivotTo: <L extends LinkNames<Q>>( | ||
| type: L, | ||
| ) => CONSTRAINED extends true | ||
| ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> | ||
| : NonNullable<CompileTimeMetadata<Q>["links"][L]["multiplicity"]> extends | ||
| true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> | ||
| : DerivedProperty.SelectPropertyBuilder<LinkedType<Q, L>, false>; | ||
| }; | ||
|
|
||
| type Aggregatable< | ||
| Q extends ObjectOrInterfaceDefinition, | ||
| > = { | ||
| readonly aggregate: < | ||
| V extends ValidAggregationKeys< | ||
| Q, | ||
| "withPropertiesAggregate" | ||
| >, | ||
| >( | ||
| aggregationSpecifier: V, | ||
| opts?: V extends `${any}:${infer P}` | ||
| ? P extends CollectWithPropAggregations ? { limit: number } | ||
| : P extends "approximatePercentile" ? { percentile: number } | ||
| : never | ||
| : never, | ||
| ) => DerivedProperty.SelectorResult< | ||
| V extends `${infer N}:${infer P}` | ||
| ? P extends CollectWithPropAggregations | ||
| ? Array<CompileTimeMetadata<Q>["properties"][N]["type"]> | undefined | ||
| : P extends "approximateDistinct" | "exactDistinct" | "$count" | ||
| ? "integer" | undefined | ||
| : "double" | undefined | ||
| : V extends "$count" ? "integer" | undefined | ||
| : never | ||
| >; | ||
| }; | ||
|
|
||
| type Selectable<Q extends ObjectOrInterfaceDefinition> = { | ||
| readonly selectProperty: <R extends PropertyKeys<Q>>( | ||
| propertyName: R, | ||
| ) => DerivedProperty.SelectorResult< | ||
| SimplePropertyDef.Make< | ||
| CompileTimeMetadata<Q>["properties"][R]["type"], | ||
| CompileTimeMetadata<Q>["properties"][R]["nullable"], | ||
| CompileTimeMetadata<Q>["properties"][R]["multiplicity"] | ||
| > | ||
| >; | ||
| }; |
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.
nit: rename
Uso its clear what that boolean generic is for