@osdk/api 2.3.0-rc.11 → 2.4.0-beta.1

package/build/esm/derivedProperties/DerivedProperty.js

@@ -13,20 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export let DerivedProperty; // type Selectable<Q extends ObjectOrInterfaceDefinition> = {
-//   readonly selectProperty: <R extends PropertyKeys<Q>>(
-//     propertyName: R,
-//   ) => DefinitionForType<
-//     Q,
-//     SimplePropertyDef.Make<
-//       CompileTimeMetadata<Q>["properties"][R]["type"],
-//       CompileTimeMetadata<Q>["properties"][R]["nullable"] extends true
-//         ? "nullable"
-//         : "non-nullable",
-//       CompileTimeMetadata<Q>["properties"][R]["multiplicity"] extends true
-//         ? "array"
-//         : "single"
-//     >
-//   >;
-// };
+export let DerivedProperty;
 //# sourceMappingURL=DerivedProperty.js.map

package/build/esm/derivedProperties/DerivedProperty.js.map

@@ -1 +1 @@
-{"version":3,"file":"DerivedProperty.js","names":["DerivedProperty"],"sources":["DerivedProperty.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 { ValidAggregationKeys } from \"../aggregate/AggregatableKeys.js\";\nimport type { WhereClause } from \"../aggregate/WhereClause.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { LinkedType, LinkNames } from \"../util/LinkUtils.js\";\nimport type {\n  CollectWithPropAggregations,\n  MinMaxWithPropAggregateOption,\n} from \"./WithPropertiesAggregationOptions.js\";\n\ndeclare const DerivedPropertyDefinitionBrand: unique symbol;\n\nexport namespace DerivedProperty {\n  export interface Definition<\n    T extends SimplePropertyDef,\n    Q extends ObjectOrInterfaceDefinition,\n  > {\n    readonly [DerivedPropertyDefinitionBrand]: true;\n  }\n\n  export type Clause<\n    Q extends ObjectOrInterfaceDefinition,\n  > = {\n    [key: string]: DerivedPropertyCreator<Q, SimplePropertyDef>;\n  };\n\n  interface BaseBuilder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends Filterable<Q, CONSTRAINED>, Pivotable<Q, CONSTRAINED> {\n  }\n\n  export interface Builder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends BaseBuilder<Q, CONSTRAINED> {\n  }\n\n  export interface AggregateBuilder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends BaseBuilder<Q, CONSTRAINED>, Aggregatable<Q> {\n  }\n\n  // export interface SelectPropertyBuilder<\n  //   Q extends ObjectOrInterfaceDefinition,\n  //   CONSTRAINED extends boolean,\n  // > extends AggregateBuilder<Q, CONSTRAINED> {\n  // }\n}\n\nexport type DerivedPropertyCreator<\n  Q extends ObjectOrInterfaceDefinition,\n  T extends SimplePropertyDef,\n> = (\n  baseObjectSet: DerivedProperty.Builder<Q, false>,\n) => DerivedProperty.Definition<T, Q>;\n\ntype BuilderTypeFromConstraint<\n  Q extends ObjectOrInterfaceDefinition,\n  CONSTRAINED extends boolean,\n> = CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<Q, true>\n  : DerivedProperty.AggregateBuilder<Q, false>;\n\ntype Filterable<\n  Q extends ObjectOrInterfaceDefinition,\n  CONSTRAINED extends boolean,\n> = {\n  readonly where: (\n    clause: WhereClause<Q>,\n  ) => BuilderTypeFromConstraint<Q, CONSTRAINED>;\n};\n\ntype Pivotable<\n  Q extends ObjectOrInterfaceDefinition,\n  CONSTRAINED extends boolean,\n> = {\n  readonly pivotTo: <L extends LinkNames<Q>>(\n    type: L,\n  ) => CONSTRAINED extends true\n    ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true>\n    : NonNullable<CompileTimeMetadata<Q>[\"links\"][L][\"multiplicity\"]> extends\n      true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true>\n    : DerivedProperty.AggregateBuilder<LinkedType<Q, L>, false>;\n};\n\ntype Aggregatable<\n  Q extends ObjectOrInterfaceDefinition,\n> = {\n  readonly aggregate: <\n    V extends ValidAggregationKeys<\n      Q,\n      \"withPropertiesAggregate\"\n    >,\n  >(\n    aggregationSpecifier: V,\n    opts?: V extends `${any}:${infer P}`\n      ? P extends CollectWithPropAggregations ? { limit: number }\n      : P extends \"approximatePercentile\" ? { percentile: number }\n      : never\n      : never,\n  ) => DerivedProperty.Definition<\n    V extends `${infer N}:${infer P}`\n      ? P extends CollectWithPropAggregations ? SimplePropertyDef.Make<\n          CompileTimeMetadata<Q>[\"properties\"][N][\"type\"],\n          \"nullable\",\n          \"array\"\n        >\n      : P extends MinMaxWithPropAggregateOption ? SimplePropertyDef.Make<\n          CompileTimeMetadata<Q>[\"properties\"][N][\"type\"],\n          \"nullable\",\n          \"single\"\n        >\n      : P extends \"approximateDistinct\" | \"exactDistinct\"\n        ? SimplePropertyDef.Make<\n          \"integer\",\n          \"non-nullable\",\n          \"single\"\n        >\n      : SimplePropertyDef.Make<\n        \"double\",\n        \"nullable\",\n        \"single\"\n      >\n      : V extends \"$count\" ? SimplePropertyDef.Make<\n          \"integer\",\n          \"non-nullable\",\n          \"single\"\n        >\n      : never,\n    Q\n  >;\n};\n\n// type Selectable<Q extends ObjectOrInterfaceDefinition> = {\n//   readonly selectProperty: <R extends PropertyKeys<Q>>(\n//     propertyName: R,\n//   ) => DefinitionForType<\n//     Q,\n//     SimplePropertyDef.Make<\n//       CompileTimeMetadata<Q>[\"properties\"][R][\"type\"],\n//       CompileTimeMetadata<Q>[\"properties\"][R][\"nullable\"] extends true\n//         ? \"nullable\"\n//         : \"non-nullable\",\n//       CompileTimeMetadata<Q>[\"properties\"][R][\"multiplicity\"] extends true\n//         ? \"array\"\n//         : \"single\"\n//     >\n//   >;\n// };\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WA+BiBA,eAAe,EA0HhC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"DerivedProperty.js","names":["DerivedProperty"],"sources":["DerivedProperty.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 { ValidAggregationKeys } from \"../aggregate/AggregatableKeys.js\";\nimport type { WhereClause } from \"../aggregate/WhereClause.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { LinkedType, LinkNames } from \"../util/LinkUtils.js\";\nimport type {\n  DatetimeExpressions,\n  DefinitionForType,\n  NumericExpressions,\n} from \"./Expressions.js\";\nimport type {\n  CollectWithPropAggregations,\n  MinMaxWithPropAggregateOption,\n} from \"./WithPropertiesAggregationOptions.js\";\n\ndeclare const DerivedPropertyDefinitionBrand: unique symbol;\n\nexport namespace DerivedProperty {\n  export interface Definition<\n    T extends SimplePropertyDef,\n    Q extends ObjectOrInterfaceDefinition,\n  > {\n    readonly [DerivedPropertyDefinitionBrand]: true;\n  }\n\n  export interface NumericPropertyDefinition<\n    T extends SimplePropertyDef,\n    Q extends ObjectOrInterfaceDefinition,\n  > extends Definition<T, Q>, NumericExpressions<Q, T> {}\n\n  export interface DatetimePropertyDefinition<\n    T extends SimplePropertyDef,\n    Q extends ObjectOrInterfaceDefinition,\n  > extends Definition<T, Q>, DatetimeExpressions<Q, T> {}\n\n  export type Clause<\n    Q extends ObjectOrInterfaceDefinition,\n  > = {\n    [key: string]: DerivedPropertyCreator<Q, SimplePropertyDef>;\n  };\n\n  interface BaseBuilder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends Filterable<Q, CONSTRAINED>, Pivotable<Q, CONSTRAINED> {\n  }\n\n  export interface Builder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends BaseBuilder<Q, CONSTRAINED>, Selectable<Q>, Constant<Q> {\n  }\n\n  export interface AggregateBuilder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends BaseBuilder<Q, CONSTRAINED>, Aggregatable<Q> {\n  }\n\n  export interface SelectPropertyBuilder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends AggregateBuilder<Q, CONSTRAINED>, Selectable<Q> {\n  }\n\n  export type ValidParts = \"DAYS\" | \"MONTHS\" | \"QUARTERS\" | \"YEARS\";\n}\n\nexport type DerivedPropertyCreator<\n  Q extends ObjectOrInterfaceDefinition,\n  T extends SimplePropertyDef,\n> = (\n  baseObjectSet: DerivedProperty.Builder<Q, false>,\n) =>\n  | DerivedProperty.Definition<T, Q>\n  | DerivedProperty.NumericPropertyDefinition<T, Q>\n  | DerivedProperty.DatetimePropertyDefinition<T, Q>;\n\ntype BuilderTypeFromConstraint<\n  Q extends ObjectOrInterfaceDefinition,\n  CONSTRAINED extends boolean,\n> = CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<Q, true>\n  : DerivedProperty.SelectPropertyBuilder<Q, false>;\n\ntype Filterable<\n  Q extends ObjectOrInterfaceDefinition,\n  CONSTRAINED extends boolean,\n> = {\n  readonly where: (\n    clause: WhereClause<Q>,\n  ) => BuilderTypeFromConstraint<Q, CONSTRAINED>;\n};\n\ntype Pivotable<\n  Q extends ObjectOrInterfaceDefinition,\n  CONSTRAINED extends boolean,\n> = {\n  readonly pivotTo: <L extends LinkNames<Q>>(\n    type: L,\n  ) => CONSTRAINED extends true\n    ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true>\n    : NonNullable<CompileTimeMetadata<Q>[\"links\"][L][\"multiplicity\"]> extends\n      true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true>\n    : DerivedProperty.SelectPropertyBuilder<LinkedType<Q, L>, false>;\n};\n\ntype Constant<Q extends ObjectOrInterfaceDefinition> = {\n  readonly constant: {\n    readonly double: (\n      value: number,\n    ) => DerivedProperty.NumericPropertyDefinition<\n      SimplePropertyDef.Make<\"double\", \"non-nullable\", \"single\">,\n      Q\n    >;\n\n    readonly integer: (\n      value: number,\n    ) => DerivedProperty.NumericPropertyDefinition<\n      SimplePropertyDef.Make<\"integer\", \"non-nullable\", \"single\">,\n      Q\n    >;\n    readonly long: (\n      value: string,\n    ) => DerivedProperty.NumericPropertyDefinition<\n      SimplePropertyDef.Make<\"long\", \"non-nullable\", \"single\">,\n      Q\n    >;\n\n    readonly datetime: (\n      value: string,\n    ) => DerivedProperty.DatetimePropertyDefinition<\n      SimplePropertyDef.Make<\"datetime\", \"non-nullable\", \"single\">,\n      Q\n    >;\n    readonly timestamp: (\n      value: string,\n    ) => DerivedProperty.DatetimePropertyDefinition<\n      SimplePropertyDef.Make<\"timestamp\", \"non-nullable\", \"single\">,\n      Q\n    >;\n  };\n};\n\ntype Aggregatable<\n  Q extends ObjectOrInterfaceDefinition,\n> = {\n  readonly aggregate: <\n    V extends ValidAggregationKeys<\n      Q,\n      \"withPropertiesAggregate\"\n    >,\n  >(\n    aggregationSpecifier: V,\n    opts?: V extends `${any}:${infer P}`\n      ? P extends CollectWithPropAggregations ? { limit: number }\n      : P extends \"approximatePercentile\" ? { percentile: number }\n      : never\n      : never,\n  ) => DefinitionForType<\n    Q,\n    V extends `${infer N}:${infer P}`\n      ? P extends CollectWithPropAggregations ? SimplePropertyDef.Make<\n          CompileTimeMetadata<Q>[\"properties\"][N][\"type\"],\n          \"nullable\",\n          \"array\"\n        >\n      : P extends MinMaxWithPropAggregateOption ? SimplePropertyDef.Make<\n          CompileTimeMetadata<Q>[\"properties\"][N][\"type\"],\n          \"nullable\",\n          \"single\"\n        >\n      : P extends \"approximateDistinct\" | \"exactDistinct\"\n        ? SimplePropertyDef.Make<\n          \"integer\",\n          \"non-nullable\",\n          \"single\"\n        >\n      : SimplePropertyDef.Make<\n        \"double\",\n        \"nullable\",\n        \"single\"\n      >\n      : V extends \"$count\" ? SimplePropertyDef.Make<\n          \"integer\",\n          \"non-nullable\",\n          \"single\"\n        >\n      : never\n  >;\n};\n\ntype Selectable<Q extends ObjectOrInterfaceDefinition> = {\n  readonly selectProperty: <R extends PropertyKeys<Q>>(\n    propertyName: R,\n  ) => DefinitionForType<\n    Q,\n    SimplePropertyDef.Make<\n      CompileTimeMetadata<Q>[\"properties\"][R][\"type\"],\n      CompileTimeMetadata<Q>[\"properties\"][R][\"nullable\"] extends true\n        ? \"nullable\"\n        : \"non-nullable\",\n      CompileTimeMetadata<Q>[\"properties\"][R][\"multiplicity\"] extends true\n        ? \"array\"\n        : \"single\"\n    >\n  >;\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WAqCiBA,eAAe","ignoreList":[]}

package/build/esm/derivedProperties/Expressions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Expressions.js.map

package/build/esm/derivedProperties/Expressions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Expressions.js","names":[],"sources":["Expressions.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { WirePropertyTypes } from \"../ontology/WirePropertyTypes.js\";\nimport type { DerivedProperty } from \"./DerivedProperty.js\";\n\ntype WithPropertiesNumerics =\n  | \"integer\"\n  | \"double\"\n  | \"float\"\n  | \"short\"\n  | \"long\";\n\ntype WithPropertiesDatetime =\n  | \"datetime\"\n  | \"timestamp\";\n\nexport type DefinitionForType<\n  Q extends ObjectOrInterfaceDefinition,\n  T extends SimplePropertyDef,\n> = SimplePropertyDef.ExtractMultiplicity<T> extends \"array\"\n  ? DerivedProperty.Definition<T, Q>\n  : SimplePropertyDef.ExtractWirePropertyType<T> extends WithPropertiesNumerics\n    ? DerivedProperty.NumericPropertyDefinition<T, Q>\n  : SimplePropertyDef.ExtractWirePropertyType<T> extends WithPropertiesDatetime\n    ? DerivedProperty.DatetimePropertyDefinition<T, Q>\n  : DerivedProperty.Definition<T, Q>;\n\ntype NumericExpressionArg<Q extends ObjectOrInterfaceDefinition> =\n  | number\n  | DerivedProperty.NumericPropertyDefinition<any, Q>;\n\ntype ReturnTypeForNumericMethod<\n  Q extends ObjectOrInterfaceDefinition,\n  LEFT extends WirePropertyTypes,\n  RIGHT extends WirePropertyTypes,\n> = \"double\" extends (LEFT | RIGHT) ? DerivedProperty.NumericPropertyDefinition<\n    SimplePropertyDef.Make<\"double\", \"non-nullable\", \"single\">,\n    Q\n  >\n  : \"float\" extends (LEFT | RIGHT) ? DerivedProperty.NumericPropertyDefinition<\n      SimplePropertyDef.Make<\"double\", \"non-nullable\", \"single\">,\n      Q\n    >\n  : \"long\" extends (LEFT | RIGHT) ? DerivedProperty.NumericPropertyDefinition<\n      SimplePropertyDef.Make<\"long\", \"non-nullable\", \"single\">,\n      Q\n    >\n  : DerivedProperty.NumericPropertyDefinition<\n    SimplePropertyDef.Make<\"integer\", \"non-nullable\", \"single\">,\n    Q\n  >;\n\ntype ReturnTypeForDatetimeMethod<\n  Q extends ObjectOrInterfaceDefinition,\n  LEFT extends WirePropertyTypes,\n  RIGHT extends WirePropertyTypes,\n> = \"timestamp\" extends (LEFT | RIGHT)\n  ? DerivedProperty.DatetimePropertyDefinition<\n    SimplePropertyDef.Make<\"timestamp\", \"non-nullable\", \"single\">,\n    Q\n  >\n  : DerivedProperty.DatetimePropertyDefinition<\n    SimplePropertyDef.Make<\"datetime\", \"non-nullable\", \"single\">,\n    Q\n  >;\n\ntype ExtractWirePropertyTypeFromNumericArg<\n  Q extends ObjectOrInterfaceDefinition,\n  ARG extends NumericExpressionArg<Q>,\n> = ARG extends number ? \"double\"\n  : ARG extends DerivedProperty.NumericPropertyDefinition<infer T, Q>\n    ? T extends SimplePropertyDef ? SimplePropertyDef.ExtractWirePropertyType<T>\n    : never\n  : ARG extends PropertyKeys.Filtered<Q, WithPropertiesNumerics>\n    ? NonNullable<CompileTimeMetadata<Q>[\"properties\"][ARG][\"type\"]>\n  : never;\n\nexport type NumericExpressions<\n  Q extends ObjectOrInterfaceDefinition,\n  LEFT_PROPERTY_TYPE extends SimplePropertyDef,\n> = {\n  readonly add: <A extends NumericExpressionArg<Q>>(\n    value: A,\n  ) => ReturnTypeForNumericMethod<\n    Q,\n    SimplePropertyDef.ExtractWirePropertyType<LEFT_PROPERTY_TYPE>,\n    ExtractWirePropertyTypeFromNumericArg<Q, A>\n  >;\n\n  readonly subtract: <A extends NumericExpressionArg<Q>>(\n    value: A,\n  ) => ReturnTypeForNumericMethod<\n    Q,\n    SimplePropertyDef.ExtractWirePropertyType<LEFT_PROPERTY_TYPE>,\n    ExtractWirePropertyTypeFromNumericArg<Q, A>\n  >;\n\n  readonly multiply: <A extends NumericExpressionArg<Q>>(\n    value: A,\n  ) => ReturnTypeForNumericMethod<\n    Q,\n    SimplePropertyDef.ExtractWirePropertyType<LEFT_PROPERTY_TYPE>,\n    ExtractWirePropertyTypeFromNumericArg<Q, A>\n  >;\n\n  readonly divide: <A extends NumericExpressionArg<Q>>(\n    value: A,\n  ) => ReturnTypeForNumericMethod<\n    Q,\n    SimplePropertyDef.ExtractWirePropertyType<LEFT_PROPERTY_TYPE>,\n    ExtractWirePropertyTypeFromNumericArg<Q, A>\n  >;\n\n  readonly abs: () => DerivedProperty.NumericPropertyDefinition<\n    LEFT_PROPERTY_TYPE,\n    Q\n  >;\n\n  readonly negate: () => DerivedProperty.NumericPropertyDefinition<\n    LEFT_PROPERTY_TYPE,\n    Q\n  >;\n\n  readonly max: <A extends NumericExpressionArg<Q>>(\n    value: A,\n  ) => ReturnTypeForNumericMethod<\n    Q,\n    SimplePropertyDef.ExtractWirePropertyType<LEFT_PROPERTY_TYPE>,\n    ExtractWirePropertyTypeFromNumericArg<Q, A>\n  >;\n\n  readonly min: <A extends NumericExpressionArg<Q>>(\n    value: A,\n  ) => ReturnTypeForNumericMethod<\n    Q,\n    SimplePropertyDef.ExtractWirePropertyType<LEFT_PROPERTY_TYPE>,\n    ExtractWirePropertyTypeFromNumericArg<Q, A>\n  >;\n};\n\ntype DatetimeExpressionArg<Q extends ObjectOrInterfaceDefinition> =\n  DerivedProperty.DatetimePropertyDefinition<any, Q>;\n\ntype ExtractPropertyTypeFromDatetimeArg<\n  Q extends ObjectOrInterfaceDefinition,\n  ARG extends DatetimeExpressionArg<Q>,\n> = ARG extends DerivedProperty.DatetimePropertyDefinition<infer T, Q>\n  ? T extends SimplePropertyDef ? SimplePropertyDef.ExtractWirePropertyType<T>\n  : never\n  : ARG extends PropertyKeys.Filtered<Q, WithPropertiesDatetime>\n    ? NonNullable<CompileTimeMetadata<Q>[\"properties\"][ARG][\"type\"]>\n  : never;\n\nexport type DatetimeExpressions<\n  Q extends ObjectOrInterfaceDefinition,\n  LEFT_PROPERTY_TYPE extends SimplePropertyDef,\n> = {\n  readonly min: <A extends DatetimeExpressionArg<Q>>(\n    value: A,\n  ) => ReturnTypeForDatetimeMethod<\n    Q,\n    SimplePropertyDef.ExtractWirePropertyType<LEFT_PROPERTY_TYPE>,\n    ExtractPropertyTypeFromDatetimeArg<Q, A>\n  >;\n  readonly max: (\n    value: DatetimeExpressionArg<Q>,\n  ) => ReturnTypeForDatetimeMethod<\n    Q,\n    SimplePropertyDef.ExtractWirePropertyType<LEFT_PROPERTY_TYPE>,\n    ExtractPropertyTypeFromDatetimeArg<Q, typeof value>\n  >;\n  readonly extractPart: (\n    value: DerivedProperty.ValidParts,\n  ) => DerivedProperty.Definition<\n    SimplePropertyDef.Make<\"string\", \"non-nullable\", \"single\">,\n    Q\n  >;\n};\n"],"mappings":"","ignoreList":[]}

package/build/esm/index.js

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+export { NULL_VALUE } from "./actions/NullValue.js";
 export { DistanceUnitMapping } from "./aggregate/WhereClause.js";
 export { DurationMapping } from "./groupby/GroupByClause.js";
 export { isOk } from "./object/Result.js";

package/build/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["DistanceUnitMapping","DurationMapping","isOk","TimeseriesDurationMapping"],"sources":["index.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\nexport type { ActionReturnTypeForOptions } from \"./actions/ActionReturnTypeForOptions.js\";\nexport type {\n  ActionEditResponse,\n  ActionParam,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n} from \"./actions/Actions.js\";\nexport type { ValidAggregationKeys } from \"./aggregate/AggregatableKeys.js\";\nexport type { AggregateOpts } from \"./aggregate/AggregateOpts.js\";\nexport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"./aggregate/AggregateOptsThatErrors.js\";\nexport type { AggregationResultsWithGroups } from \"./aggregate/AggregationResultsWithGroups.js\";\nexport type { AggregationResultsWithoutGroups } from \"./aggregate/AggregationResultsWithoutGroups.js\";\nexport type { AggregationClause } from \"./aggregate/AggregationsClause.js\";\nexport type { AggregationsResults } from \"./aggregate/AggregationsResults.js\";\nexport type { GeoFilterOptions } from \"./aggregate/GeoFilter.js\";\nexport { DistanceUnitMapping } from \"./aggregate/WhereClause.js\";\nexport type {\n  GeoFilter_Intersects,\n  GeoFilter_Within,\n  PossibleWhereClauseFilters,\n  WhereClause,\n} from \"./aggregate/WhereClause.js\";\nexport type { OsdkObjectPropertyType } from \"./Definitions.js\";\nexport type {\n  OsdkObjectLinksObject,\n  SingleLinkAccessor,\n} from \"./definitions/LinkDefinitions.js\";\nexport type { DerivedProperty } from \"./derivedProperties/DerivedProperty.js\";\nexport { DurationMapping } from \"./groupby/GroupByClause.js\";\nexport type {\n  AllGroupByValues,\n  GroupByClause,\n  GroupByRange,\n} from \"./groupby/GroupByClause.js\";\nexport type {\n  AllowedBucketKeyTypes,\n  AllowedBucketTypes,\n  DataValueClientToWire,\n  DataValueWireToClient,\n} from \"./mapping/DataValueMapping.js\";\nexport type {\n  PropertyValueWireToClient,\n} from \"./mapping/PropertyValueMapping.js\";\nexport type { Attachment, AttachmentUpload } from \"./object/Attachment.js\";\nexport type {\n  AsyncIterArgs,\n  Augment,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  SelectArg,\n  SelectArgToKeys,\n} from \"./object/FetchPageArgs.js\";\nexport type {\n  FetchPageResult,\n  SingleOsdkResult,\n} from \"./object/FetchPageResult.js\";\nexport type { Media, MediaMetadata, MediaReference } from \"./object/Media.js\";\nexport { isOk } from \"./object/Result.js\";\nexport type { Result } from \"./object/Result.js\";\nexport type { BaseObjectSet } from \"./objectSet/BaseObjectSet.js\";\nexport type { ObjectSet } from \"./objectSet/ObjectSet.js\";\nexport type { ObjectSetSubscription } from \"./objectSet/ObjectSetListener.js\";\nexport type {\n  ActionDefinition,\n  ActionMetadata,\n} from \"./ontology/ActionDefinition.js\";\nexport type {\n  InterfaceDefinition,\n  InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nexport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nexport type { ObjectSpecifier } from \"./ontology/ObjectSpecifier.js\";\nexport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n  ObjectTypeDefinition,\n  PropertyDef,\n  VersionBound,\n} from \"./ontology/ObjectTypeDefinition.js\";\nexport type { OntologyMetadata } from \"./ontology/OntologyMetadata.js\";\nexport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nexport type {\n  ObjectQueryDataType,\n  ObjectSetQueryDataType,\n  QueryDataTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  QueryParameterDefinition,\n  ThreeDimensionalQueryAggregationDefinition,\n  TwoDimensionalQueryAggregationDefinition,\n} from \"./ontology/QueryDefinition.js\";\nexport type {\n  BaseWirePropertyTypes,\n  WirePropertyTypes,\n} from \"./ontology/WirePropertyTypes.js\";\nexport type {\n  ObjectIdentifiers,\n  OsdkBase,\n  PrimaryKeyType,\n} from \"./OsdkBase.js\";\nexport type { OsdkObject } from \"./OsdkObject.js\";\nexport type { ConvertProps, Osdk } from \"./OsdkObjectFrom.js\";\nexport type { PageResult } from \"./PageResult.js\";\nexport type {\n  Range,\n  ThreeDimensionalAggregation,\n  TwoDimensionalAggregation,\n} from \"./queries/Aggregations.js\";\nexport type { QueryParam, QueryResult } from \"./queries/Queries.js\";\nexport { TimeseriesDurationMapping } from \"./timeseries/timeseries.js\";\nexport type {\n  GeotimeSeriesProperty,\n  TimeSeriesPoint,\n  TimeSeriesProperty,\n  TimeSeriesQuery,\n} from \"./timeseries/timeseries.js\";\nexport type { LinkedType, LinkNames } from \"./util/LinkUtils.js\";\nexport {};\nexport type { Logger } from \"./Logger.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkBA,SAASA,mBAAmB,QAAQ,4BAA4B;AAahE,SAASC,eAAe,QAAQ,4BAA4B;AA8B5D,SAASC,IAAI,QAAQ,oBAAoB;AAuDzC,SAASC,yBAAyB,QAAQ,4BAA4B;AAQtE","ignoreList":[]}
+{"version":3,"file":"index.js","names":["NULL_VALUE","DistanceUnitMapping","DurationMapping","isOk","TimeseriesDurationMapping"],"sources":["index.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\nexport type { ActionReturnTypeForOptions } from \"./actions/ActionReturnTypeForOptions.js\";\nexport type {\n  ActionEditResponse,\n  ActionParam,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n} from \"./actions/Actions.js\";\nexport { NULL_VALUE } from \"./actions/NullValue.js\";\nexport type { ValidAggregationKeys } from \"./aggregate/AggregatableKeys.js\";\nexport type { AggregateOpts } from \"./aggregate/AggregateOpts.js\";\nexport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"./aggregate/AggregateOptsThatErrors.js\";\nexport type { AggregationResultsWithGroups } from \"./aggregate/AggregationResultsWithGroups.js\";\nexport type { AggregationResultsWithoutGroups } from \"./aggregate/AggregationResultsWithoutGroups.js\";\nexport type { AggregationClause } from \"./aggregate/AggregationsClause.js\";\nexport type { AggregationsResults } from \"./aggregate/AggregationsResults.js\";\nexport type { GeoFilterOptions } from \"./aggregate/GeoFilter.js\";\nexport { DistanceUnitMapping } from \"./aggregate/WhereClause.js\";\nexport type {\n  GeoFilter_Intersects,\n  GeoFilter_Within,\n  PossibleWhereClauseFilters,\n  WhereClause,\n} from \"./aggregate/WhereClause.js\";\nexport type { OsdkObjectPropertyType } from \"./Definitions.js\";\nexport type {\n  OsdkObjectLinksObject,\n  SingleLinkAccessor,\n} from \"./definitions/LinkDefinitions.js\";\nexport type { DerivedProperty } from \"./derivedProperties/DerivedProperty.js\";\nexport { DurationMapping } from \"./groupby/GroupByClause.js\";\nexport type {\n  AllGroupByValues,\n  GroupByClause,\n  GroupByRange,\n} from \"./groupby/GroupByClause.js\";\nexport type {\n  AllowedBucketKeyTypes,\n  AllowedBucketTypes,\n  DataValueClientToWire,\n  DataValueWireToClient,\n} from \"./mapping/DataValueMapping.js\";\nexport type {\n  PropertyValueWireToClient,\n} from \"./mapping/PropertyValueMapping.js\";\nexport type { Attachment, AttachmentUpload } from \"./object/Attachment.js\";\nexport type {\n  AsyncIterArgs,\n  Augment,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  SelectArg,\n  SelectArgToKeys,\n} from \"./object/FetchPageArgs.js\";\nexport type {\n  FetchPageResult,\n  SingleOsdkResult,\n} from \"./object/FetchPageResult.js\";\nexport type {\n  Media,\n  MediaMetadata,\n  MediaReference,\n  MediaUpload,\n} from \"./object/Media.js\";\nexport { isOk } from \"./object/Result.js\";\nexport type { Result } from \"./object/Result.js\";\nexport type { BaseObjectSet } from \"./objectSet/BaseObjectSet.js\";\nexport type { ObjectSet } from \"./objectSet/ObjectSet.js\";\nexport type { ObjectSetSubscription } from \"./objectSet/ObjectSetListener.js\";\nexport type {\n  ActionDefinition,\n  ActionMetadata,\n} from \"./ontology/ActionDefinition.js\";\nexport type {\n  InterfaceDefinition,\n  InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nexport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nexport type { ObjectSpecifier } from \"./ontology/ObjectSpecifier.js\";\nexport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n  ObjectTypeDefinition,\n  PropertyDef,\n  VersionBound,\n} from \"./ontology/ObjectTypeDefinition.js\";\nexport type { OntologyMetadata } from \"./ontology/OntologyMetadata.js\";\nexport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nexport type {\n  ObjectQueryDataType,\n  ObjectSetQueryDataType,\n  QueryDataTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  QueryParameterDefinition,\n  ThreeDimensionalQueryAggregationDefinition,\n  TwoDimensionalQueryAggregationDefinition,\n} from \"./ontology/QueryDefinition.js\";\nexport type {\n  BaseWirePropertyTypes,\n  WirePropertyTypes,\n} from \"./ontology/WirePropertyTypes.js\";\nexport type {\n  ObjectIdentifiers,\n  OsdkBase,\n  PrimaryKeyType,\n} from \"./OsdkBase.js\";\nexport type { OsdkObject } from \"./OsdkObject.js\";\nexport type { ConvertProps, Osdk } from \"./OsdkObjectFrom.js\";\nexport type { PageResult } from \"./PageResult.js\";\nexport type {\n  Range,\n  ThreeDimensionalAggregation,\n  TwoDimensionalAggregation,\n} from \"./queries/Aggregations.js\";\nexport type { QueryParam, QueryResult } from \"./queries/Queries.js\";\nexport { TimeseriesDurationMapping } from \"./timeseries/timeseries.js\";\nexport type {\n  GeotimeSeriesProperty,\n  TimeSeriesPoint,\n  TimeSeriesProperty,\n  TimeSeriesQuery,\n} from \"./timeseries/timeseries.js\";\nexport type { LinkedType, LinkNames } from \"./util/LinkUtils.js\";\nexport {};\nexport type { Logger } from \"./Logger.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,SAASA,UAAU,QAAQ,wBAAwB;AASnD,SAASC,mBAAmB,QAAQ,4BAA4B;AAahE,SAASC,eAAe,QAAQ,4BAA4B;AAmC5D,SAASC,IAAI,QAAQ,oBAAoB;AAuDzC,SAASC,yBAAyB,QAAQ,4BAA4B;AAQtE","ignoreList":[]}

package/build/esm/mapping/DataValueMapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataValueMapping.js","names":[],"sources":["DataValueMapping.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 { Attachment, AttachmentUpload } from \"../object/Attachment.js\";\nimport type { MediaReference } from \"../object/Media.js\";\n\n/**\n * Map from the DataValue type to the typescript type that we return\n */\nexport interface DataValueWireToClient {\n  attachment: Attachment;\n  boolean: boolean;\n  byte: number;\n  datetime: string;\n  date: string;\n  decimal: string;\n  float: number;\n  double: number;\n  integer: number;\n  long: string;\n  marking: string;\n  null: null;\n  short: number;\n  string: string;\n  timestamp: string;\n  mediaReference: MediaReference;\n  twoDimensionalAggregation: {\n    key: AllowedBucketKeyTypes;\n    value: AllowedBucketTypes;\n  }[];\n  threeDimensionalAggregation: {\n    key: AllowedBucketKeyTypes;\n    groups: { key: AllowedBucketKeyTypes; value: AllowedBucketTypes }[];\n  }[];\n  struct: Record<string, any>;\n  set: Set<any>;\n  objectType: string;\n  geohash: GeoJSON.Point;\n  geoshape: GeoJSON.GeoJSON;\n}\n\n/**\n * Map from the DataValue type to the typescript type that we accept\n */\nexport interface DataValueClientToWire {\n  attachment: string | AttachmentUpload | Blob & { readonly name: string };\n  boolean: boolean;\n  byte: number;\n  datetime: string;\n  date: string;\n  decimal: string | number;\n  float: number;\n  double: number;\n  integer: number;\n  long: string | number;\n  marking: string;\n  null: null;\n  short: number;\n  string: string;\n  timestamp: string;\n  set: Set<any>;\n  mediaReference: MediaReference;\n  twoDimensionalAggregation: {\n    key: AllowedBucketKeyTypes;\n    value: AllowedBucketTypes;\n  }[];\n  threeDimensionalAggregation: {\n    key: AllowedBucketKeyTypes;\n    groups: { key: AllowedBucketKeyTypes; value: AllowedBucketTypes }[];\n  }[];\n  struct: Record<string, any>;\n  objectType: string;\n  geohash: GeoJSON.Point;\n  geoshape: GeoJSON.GeoJSON;\n}\n\nexport type AllowedBucketTypes = string | number | boolean;\nexport type AllowedBucketKeyTypes =\n  | AllowedBucketTypes\n  | {\n    startValue: AllowedBucketTypes;\n    endValue: AllowedBucketTypes;\n  };\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"DataValueMapping.js","names":[],"sources":["DataValueMapping.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 { Attachment, AttachmentUpload } from \"../object/Attachment.js\";\nimport type { MediaReference, MediaUpload } from \"../object/Media.js\";\n\n/**\n * Map from the DataValue type to the typescript type that we return\n */\nexport interface DataValueWireToClient {\n  attachment: Attachment;\n  boolean: boolean;\n  byte: number;\n  datetime: string;\n  date: string;\n  decimal: string;\n  float: number;\n  double: number;\n  integer: number;\n  long: string;\n  marking: string;\n  null: null;\n  short: number;\n  string: string;\n  timestamp: string;\n  mediaReference: MediaReference;\n  twoDimensionalAggregation: {\n    key: AllowedBucketKeyTypes;\n    value: AllowedBucketTypes;\n  }[];\n  threeDimensionalAggregation: {\n    key: AllowedBucketKeyTypes;\n    groups: { key: AllowedBucketKeyTypes; value: AllowedBucketTypes }[];\n  }[];\n  struct: Record<string, any>;\n  set: Set<any>;\n  objectType: string;\n  geohash: GeoJSON.Point;\n  geoshape: GeoJSON.GeoJSON;\n}\n\n/**\n * Map from the DataValue type to the typescript type that we accept\n */\nexport interface DataValueClientToWire {\n  attachment: string | AttachmentUpload | Blob & { readonly name: string };\n  boolean: boolean;\n  byte: number;\n  datetime: string;\n  date: string;\n  decimal: string | number;\n  float: number;\n  double: number;\n  integer: number;\n  long: string | number;\n  marking: string;\n  null: null;\n  short: number;\n  string: string;\n  timestamp: string;\n  set: Set<any>;\n  mediaReference: MediaReference | MediaUpload;\n  twoDimensionalAggregation: {\n    key: AllowedBucketKeyTypes;\n    value: AllowedBucketTypes;\n  }[];\n  threeDimensionalAggregation: {\n    key: AllowedBucketKeyTypes;\n    groups: { key: AllowedBucketKeyTypes; value: AllowedBucketTypes }[];\n  }[];\n  struct: Record<string, any>;\n  objectType: string;\n  geohash: GeoJSON.Point;\n  geoshape: GeoJSON.GeoJSON;\n}\n\nexport type AllowedBucketTypes = string | number | boolean;\nexport type AllowedBucketKeyTypes =\n  | AllowedBucketTypes\n  | {\n    startValue: AllowedBucketTypes;\n    endValue: AllowedBucketTypes;\n  };\n"],"mappings":"","ignoreList":[]}

package/build/esm/object/Media.js.map

@@ -1 +1 @@
-{"version":3,"file":"Media.js","names":[],"sources":["Media.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\nexport interface Media {\n  /**\n   * Fetches metadata for media reference property\n   */\n  fetchMetadata(): Promise<MediaMetadata>;\n  /**\n   * Fetches content of a media reference property\n   */\n  fetchContents(): Promise<Response>;\n  /**\n   * Returns the media reference\n   */\n  getMediaReference(): MediaReference;\n}\n\n/**\n * Unique identifier of a media item in Foundry.\n */\nexport interface MediaReference {\n  mimeType: string;\n  reference: {\n    type: \"mediaSetViewItem\";\n    mediaSetViewItem: {\n      mediaItemRid: string;\n      mediaSetRid: string;\n      mediaSetViewRid: string;\n      readToken?: string;\n    };\n  };\n}\n\n/**\n * Metadata of a media item\n */\nexport interface MediaMetadata {\n  path?: string;\n  sizeBytes: number;\n  mediaType: string;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"Media.js","names":[],"sources":["Media.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\nexport interface Media {\n  /**\n   * Fetches metadata for media reference property\n   */\n  fetchMetadata(): Promise<MediaMetadata>;\n  /**\n   * Fetches content of a media reference property\n   */\n  fetchContents(): Promise<Response>;\n  /**\n   * Returns the media reference\n   */\n  getMediaReference(): MediaReference;\n}\n\n/**\n * Unique identifier of a media item in Foundry.\n */\nexport interface MediaReference {\n  mimeType: string;\n  reference: {\n    type: \"mediaSetViewItem\";\n    mediaSetViewItem: {\n      mediaItemRid: string;\n      mediaSetRid: string;\n      mediaSetViewRid: string;\n      readToken?: string;\n    };\n  };\n}\n\n/**\n * Object for uploading Media\n */\nexport interface MediaUpload {\n  readonly path: string;\n  readonly data: Blob;\n}\n\n/**\n * Metadata of a media item\n */\nexport interface MediaMetadata {\n  path?: string;\n  sizeBytes: number;\n  mediaType: string;\n}\n"],"mappings":"","ignoreList":[]}

package/build/esm/objectSet/ObjectSet.test.js

@@ -151,7 +151,7 @@ describe("ObjectSet", () => {
     });
     it("can be sub-selected", () => {
       fauxObjectSet.withProperties({
-        "derivedPropertyName": base => base.pivotTo("lead").aggregate("dateOfJoining:max")
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId")
       }).fetchOne(3, {
         $select: ["derivedPropertyName"]
       });
@@ -159,7 +159,7 @@ describe("ObjectSet", () => {
     test("multiple properties", async () => {
       const withFamily = fauxObjectSet.withProperties({
         "mom": base => base.pivotTo("lead").aggregate("$count"),
-        "dad": base => base.pivotTo("lead").aggregate("dateOfJoining:max"),
+        "dad": base => base.pivotTo("lead").selectProperty("fullName"),
         "sister": base => base.pivotTo("lead").aggregate("class:collectList")
       });
       expectTypeOf(withFamily).toEqualTypeOf();
@@ -175,7 +175,7 @@ describe("ObjectSet", () => {
           "mom": base => base.pivotTo("lead").aggregate("$count")
         });
         const withParents = withMom.withProperties({
-          "dad": base => base.pivotTo("lead").aggregate("fullName:approximateDistinct")
+          "dad": base => base.pivotTo("lead").selectProperty("fullName")
         });
         expectTypeOf(withParents).toEqualTypeOf();
       });
@@ -194,6 +194,7 @@ describe("ObjectSet", () => {
       it("collectToSet, collectToList, selectProperty, and numeric aggregations are nullable", async () => {
         const withAggregations = fauxObjectSet.withProperties({
           "collectSet": base => base.pivotTo("lead").aggregate("class:collectSet"),
+          "select": base => base.pivotTo("lead").selectProperty("fullName"),
           "collectList": base => base.pivotTo("lead").aggregate("class:collectList"),
           "min": base => base.pivotTo("lead").aggregate("employeeId:max"),
           "max": base => base.pivotTo("lead").aggregate("employeeId:min"),
@@ -208,6 +209,7 @@ describe("ObjectSet", () => {
     describe("fetch functions return correct Osdk.Instance", () => {
       const withFamily = fauxObjectSet.withProperties({
         "mom": base => base.pivotTo("lead").aggregate("$count"),
+        "dad": base => base.pivotTo("lead").selectProperty("fullName"),
         "sister": base => base.pivotTo("lead").aggregate("class:collectList")
       });
       it("works with .where", async () => {
@@ -242,7 +244,7 @@ describe("ObjectSet", () => {
       });
       it("Works with selecting all RDPs", async () => {
         await withFamily.fetchPage({
-          $select: ["mom", "sister"]
+          $select: ["mom", "dad", "sister"]
         });
         expectTypeOf().toEqualTypeOf();
         expectTypeOf().toEqualTypeOf();
@@ -370,5 +372,204 @@ describe("ObjectSet", () => {
       });
     });
   });
+  describe("expressions", () => {
+    "Test all property types";
+
+    describe("numeric expressions", () => {
+      it("provides correct methods off of selected numeric derived property definitions", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const selectedInteger = base.pivotTo("lead").selectProperty("employeeId");
+            expectTypeOf(selectedInteger).toEqualTypeOf;
+            selectedInteger.add(1);
+            selectedInteger.subtract(1);
+            selectedInteger.multiply(1);
+            selectedInteger.divide(1);
+            selectedInteger.abs();
+            selectedInteger.negate();
+            selectedInteger.max(1);
+            selectedInteger.min(1);
+
+            // @ts-expect-error
+            selectedInteger.extractPart("1");
+            expectTypeOf(base.pivotTo("lead").selectProperty("performanceScore")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("rank")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("yearsOfExperience")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("hourlyRate")).toEqualTypeOf();
+            return selectedInteger;
+          }
+        });
+      });
+      it("provides correct methods off of selection definitions", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const selectedInteger = base.pivotTo("lead").selectProperty("employeeId");
+            expectTypeOf(selectedInteger).toEqualTypeOf;
+            selectedInteger.add(1);
+            selectedInteger.subtract(1);
+            selectedInteger.multiply(1);
+            selectedInteger.divide(1);
+            selectedInteger.abs();
+            selectedInteger.negate();
+            selectedInteger.max(1);
+            selectedInteger.min(1);
+
+            // @ts-expect-error
+            selectedInteger.extractPart("1");
+            expectTypeOf(base.pivotTo("lead").selectProperty("performanceScore")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("rank")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("yearsOfExperience")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("hourlyRate")).toEqualTypeOf();
+            return selectedInteger;
+          }
+        });
+      });
+      it("provides correct methods off of aggregated properties", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const maxAggregation = base.pivotTo("lead").aggregate("employeeId:max");
+            expectTypeOf(maxAggregation).toEqualTypeOf;
+            maxAggregation.add(1);
+            maxAggregation.subtract(1);
+            maxAggregation.multiply(1);
+            maxAggregation.divide(1);
+            maxAggregation.abs();
+            maxAggregation.negate();
+            maxAggregation.max(1);
+            maxAggregation.min(1);
+            expectTypeOf(base.pivotTo("peeps").aggregate("employeeId:sum")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("peeps").aggregate("employeeId:avg")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("peeps").aggregate("employeeId:min")).toEqualTypeOf();
+            const collectList = base.pivotTo("peeps").aggregate("employeeId:collectList");
+            expectTypeOf(collectList).toEqualTypeOf();
+
+            // @ts-expect-error
+            collectList.plus(1);
+            expectTypeOf(base.pivotTo("peeps").aggregate("employeeId:collectList")).toEqualTypeOf();
+            return maxAggregation;
+          }
+        });
+      });
+      it("correctly coerces numeric types", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const intAndLong = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("yearsOfExperience")).add(base.selectProperty("employeeId"));
+            expectTypeOf(intAndLong).toEqualTypeOf();
+            const intAndDouble = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("performanceScore")).add(base.selectProperty("employeeId"));
+            expectTypeOf(intAndDouble).toEqualTypeOf();
+            const longAndDouble = base.pivotTo("lead").selectProperty("yearsOfExperience").add(base.selectProperty("performanceScore")).add(base.selectProperty("yearsOfExperience"));
+            expectTypeOf(longAndDouble).toEqualTypeOf();
+            const longAndLong = base.pivotTo("lead").selectProperty("yearsOfExperience").add(base.selectProperty("yearsOfExperience"));
+            expectTypeOf(longAndLong).toEqualTypeOf();
+            const intAndInt = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("employeeId"));
+            expectTypeOf(intAndInt).toEqualTypeOf();
+            const intLongDoubleChain = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("yearsOfExperience")).add(base.selectProperty("employeeId")).add(base.selectProperty("performanceScore")).add(base.selectProperty("employeeId"));
+            expectTypeOf(intLongDoubleChain).toEqualTypeOf();
+            const shortAndIntReturnsInt = base.pivotTo("lead").selectProperty("rank").add(base.selectProperty("employeeId"));
+            expectTypeOf(shortAndIntReturnsInt).toEqualTypeOf();
+            const shortAndFloatReturnsDouble = base.pivotTo("lead").selectProperty("rank").add(base.selectProperty("hourlyRate"));
+            expectTypeOf(shortAndFloatReturnsDouble).toEqualTypeOf();
+            return intLongDoubleChain;
+          }
+        });
+      });
+      it("allows adding number literals as a double", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const plus = base.pivotTo("lead").selectProperty("employeeId").add(1);
+            expectTypeOf(plus).toEqualTypeOf();
+            return plus;
+          }
+        });
+      });
+      it("allows adding literals via base.constant", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const plus = base.pivotTo("lead").selectProperty("employeeId").add(base.constant.double(1));
+            expectTypeOf(plus).toEqualTypeOf();
+            const intPlusIntReturnsInt = base.pivotTo("lead").selectProperty("employeeId").add(base.constant.integer(1));
+            expectTypeOf(intPlusIntReturnsInt).toEqualTypeOf();
+            return plus;
+          }
+        });
+      });
+      it("allows correctly typed nested property definitions", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const nested = base.pivotTo("lead").selectProperty("employeeId").add(base.pivotTo("peeps").aggregate("employeeId:sum"));
+            expectTypeOf(nested).toEqualTypeOf();
+            return nested;
+          }
+        });
+      });
+      it("allows correctly types property keys off the linked OT", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const nested = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("performanceScore"));
+            expectTypeOf(nested).toEqualTypeOf();
+            return nested;
+          }
+        });
+      });
+
+      // it("allows correctly types property keys off the base OT", () => {});
+    });
+    describe("datetime expressions", () => {
+      it("provides correct methods off of datetime selections", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const selectedDatetime = base.pivotTo("lead").selectProperty("dateOfJoining");
+            expectTypeOf(selectedDatetime).toEqualTypeOf();
+            selectedDatetime.max(base.selectProperty("dateOfJoining"));
+            selectedDatetime.min(base.selectProperty("lastUpdated"));
+            expectTypeOf(base.pivotTo("lead").selectProperty("lastUpdated")).toEqualTypeOf();
+            return selectedDatetime;
+          }
+        });
+      });
+      it("correctly coerces datetime types", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const max = base.pivotTo("lead").selectProperty("dateOfJoining").max(base.selectProperty("lastUpdated"));
+            expectTypeOf(max).toEqualTypeOf();
+            const min = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.selectProperty("dateOfJoining"));
+            expectTypeOf(min).toEqualTypeOf();
+            return max;
+          }
+        });
+      });
+      it("allows adding literals via base.constant", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const dateAndDateReturnDate = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.constant.datetime("2025-01-01T00:00:00Z"));
+            expectTypeOf(dateAndDateReturnDate).toEqualTypeOf();
+            const dateAndTimeReturnTime = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.constant.timestamp("2025-01-01T00:00:00Z"));
+            expectTypeOf(dateAndTimeReturnTime).toEqualTypeOf();
+            return dateAndTimeReturnTime;
+          }
+        });
+      });
+      it("allows correctly typed nested property definitions", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const nested = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.pivotTo("lead").pivotTo("lead").selectProperty("lastUpdated"));
+            expectTypeOf(nested).toEqualTypeOf();
+            return nested;
+          }
+        });
+      });
+      it("allows correctly typed property keys off the linked OT", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const nested = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.selectProperty("lastUpdated"));
+            expectTypeOf(nested).toEqualTypeOf();
+            return nested;
+          }
+        });
+      });
+
+      // it("allows correctly typed property keys off the base OT", () => {});
+    });
+  });
 });
 //# sourceMappingURL=ObjectSet.test.js.map