@osdk/api 2.5.0-rc.15 → 2.6.0-beta.2

package/build/esm/aggregate/WhereClause.js.map

@@ -1 +1 @@
-{"version":3,"file":"WhereClause.js","names":["DistanceUnitMapping"],"sources":["WhereClause.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 { BBox, Point, Polygon } from \"geojson\";\nimport type {\n  ObjectOrInterfaceDefinition,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { BaseWirePropertyTypes } from \"../ontology/WirePropertyTypes.js\";\nimport type { IsNever } from \"../OsdkObjectFrom.js\";\nimport type { ArrayFilter } from \"./ArrayFilter.js\";\nimport type { BaseFilter } from \"./BaseFilter.js\";\nimport type { BooleanFilter } from \"./BooleanFilter.js\";\nimport type { DatetimeFilter } from \"./DatetimeFilter.js\";\nimport type { GeoFilter } from \"./GeoFilter.js\";\nimport type { Just } from \"./Just.js\";\nimport type { NumberFilter } from \"./NumberFilter.js\";\nimport type { StringFilter } from \"./StringFilter.js\";\n\nexport type PossibleWhereClauseFilters =\n  | \"$gt\"\n  | \"$eq\"\n  | \"$ne\"\n  | \"$isNull\"\n  | \"$contains\"\n  | \"$gte\"\n  | \"$lt\"\n  | \"$lte\"\n  | \"$within\"\n  | \"$in\"\n  | \"$intersects\"\n  | \"$startsWith\"\n  | \"$containsAllTermsInOrder\"\n  | \"$containsAnyTerm\"\n  | \"$containsAllTerms\";\n\n// the value side of this needs to match DistanceUnit from @osdk/foundry but we don't\n// want the dependency\nexport const DistanceUnitMapping: {\n  centimeter: \"CENTIMETERS\";\n  centimeters: \"CENTIMETERS\";\n  cm: \"CENTIMETERS\";\n  meter: \"METERS\";\n  meters: \"METERS\";\n  m: \"METERS\";\n  kilometer: \"KILOMETERS\";\n  kilometers: \"KILOMETERS\";\n  km: \"KILOMETERS\";\n  inch: \"INCHES\";\n  inches: \"INCHES\";\n  foot: \"FEET\";\n  feet: \"FEET\";\n  yard: \"YARDS\";\n  yards: \"YARDS\";\n  mile: \"MILES\";\n  miles: \"MILES\";\n  nautical_mile: \"NAUTICAL_MILES\";\n  nauticalMile: \"NAUTICAL_MILES\";\n  \"nautical miles\": \"NAUTICAL_MILES\";\n} = {\n  \"centimeter\": \"CENTIMETERS\",\n  \"centimeters\": \"CENTIMETERS\",\n  \"cm\": \"CENTIMETERS\",\n  \"meter\": \"METERS\",\n  \"meters\": \"METERS\",\n  \"m\": \"METERS\",\n  \"kilometer\": \"KILOMETERS\",\n  \"kilometers\": \"KILOMETERS\",\n  \"km\": \"KILOMETERS\",\n  \"inch\": \"INCHES\",\n  \"inches\": \"INCHES\",\n  \"foot\": \"FEET\",\n  \"feet\": \"FEET\",\n  \"yard\": \"YARDS\",\n  \"yards\": \"YARDS\",\n  \"mile\": \"MILES\",\n  \"miles\": \"MILES\",\n  \"nautical_mile\": \"NAUTICAL_MILES\",\n  \"nauticalMile\": \"NAUTICAL_MILES\",\n  \"nautical miles\": \"NAUTICAL_MILES\",\n} satisfies Record<\n  string,\n  | \"CENTIMETERS\"\n  | \"METERS\"\n  | \"KILOMETERS\"\n  | \"INCHES\"\n  | \"FEET\"\n  | \"YARDS\"\n  | \"MILES\"\n  | \"NAUTICAL_MILES\"\n>;\n\nexport type GeoFilter_Within = {\n  \"$within\":\n    | {\n      $distance: [number, keyof typeof DistanceUnitMapping];\n      $of: [number, number] | Readonly<Point>;\n      $bbox?: never;\n      $polygon?: never;\n    }\n    | {\n      $bbox: BBox;\n      $distance?: never;\n      $of?: never;\n      $polygon?: never;\n    }\n    | BBox\n    | {\n      $polygon: Polygon[\"coordinates\"];\n      $bbox?: never;\n      $distance?: never;\n      $of?: never;\n    }\n    | Polygon;\n};\n\nexport type GeoFilter_Intersects = {\n  \"$intersects\":\n    | {\n      $bbox: BBox;\n      $polygon?: never;\n    }\n    | BBox\n    | {\n      $polygon: Polygon[\"coordinates\"];\n      $bbox?: never;\n    }\n    | Polygon;\n};\n\ntype FilterFor<PD extends ObjectMetadata.Property> = PD[\"multiplicity\"] extends\n  true\n  ? (PD[\"type\"] extends\n    \"string\" | \"geopoint\" | \"geoshape\" | \"datetime\" | \"timestamp\"\n    ? ArrayFilter<string>\n    : (PD[\"type\"] extends boolean ? ArrayFilter<boolean>\n      : ArrayFilter<number>))\n  : PD[\"type\"] extends Record<string, BaseWirePropertyTypes> ?\n      | StructFilter<PD[\"type\"]>\n      | BaseFilter.$isNull<string>\n  : (PD[\"type\"] extends \"string\" ? StringFilter\n    : PD[\"type\"] extends \"geopoint\" | \"geoshape\" ? GeoFilter\n    : PD[\"type\"] extends \"datetime\" | \"timestamp\" ? DatetimeFilter\n    : PD[\"type\"] extends \"boolean\" ? BooleanFilter\n    : PD[\"type\"] extends\n      \"double\" | \"integer\" | \"long\" | \"float\" | \"decimal\" | \"byte\"\n      ? NumberFilter\n    : BaseFilter<string>); // FIXME we need to represent all types\n\ntype StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {\n  [K in keyof ST]?: FilterFor<{ \"type\": ST[K] }>;\n};\ntype StructFilter<ST extends Record<string, BaseWirePropertyTypes>> = {\n  [K in keyof ST]: Just<K, StructFilterOpts<ST>>;\n}[keyof ST];\n\nexport interface AndWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  $and: WhereClause<T>[];\n}\n\nexport interface OrWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  $or: WhereClause<T>[];\n}\n\nexport interface NotWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  $not: WhereClause<T>;\n}\n\nexport type PropertyWhereClause<T extends ObjectOrInterfaceDefinition> = {\n  [P in keyof CompileTimeMetadata<T>[\"properties\"]]?: FilterFor<\n    CompileTimeMetadata<T>[\"properties\"][P]\n  >;\n};\n\nexport type WhereClause<\n  T extends ObjectOrInterfaceDefinition,\n> =\n  | OrWhereClause<T>\n  | AndWhereClause<T>\n  | NotWhereClause<T>\n  | (IsNever<keyof CompileTimeMetadata<T>[\"properties\"]> extends true\n    ? Record<string, never>\n    : PropertyWhereClause<T>);\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAsCA;AACA;AACA,OAAO,MAAMA,mBAqBZ,GAAG;EACF,YAAY,EAAE,aAAa;EAC3B,aAAa,EAAE,aAAa;EAC5B,IAAI,EAAE,aAAa;EACnB,OAAO,EAAE,QAAQ;EACjB,QAAQ,EAAE,QAAQ;EAClB,GAAG,EAAE,QAAQ;EACb,WAAW,EAAE,YAAY;EACzB,YAAY,EAAE,YAAY;EAC1B,IAAI,EAAE,YAAY;EAClB,MAAM,EAAE,QAAQ;EAChB,QAAQ,EAAE,QAAQ;EAClB,MAAM,EAAE,MAAM;EACd,MAAM,EAAE,MAAM;EACd,MAAM,EAAE,OAAO;EACf,OAAO,EAAE,OAAO;EAChB,MAAM,EAAE,OAAO;EACf,OAAO,EAAE,OAAO;EAChB,eAAe,EAAE,gBAAgB;EACjC,cAAc,EAAE,gBAAgB;EAChC,gBAAgB,EAAE;AACpB,CAUC;;AAyD0B","ignoreList":[]}
+{"version":3,"file":"WhereClause.js","names":["DistanceUnitMapping"],"sources":["WhereClause.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 { BBox, Point, Polygon } from \"geojson\";\nimport type {\n  ObjectOrInterfaceDefinition,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { BaseWirePropertyTypes } from \"../ontology/WirePropertyTypes.js\";\nimport type { IsNever } from \"../OsdkObjectFrom.js\";\nimport type { ArrayFilter } from \"./ArrayFilter.js\";\nimport type { BaseFilter, EqFilter } from \"./BaseFilter.js\";\nimport type { BooleanFilter } from \"./BooleanFilter.js\";\nimport type { DatetimeFilter } from \"./DatetimeFilter.js\";\nimport type { GeoFilter } from \"./GeoFilter.js\";\nimport type { Just } from \"./Just.js\";\nimport type { NumberFilter } from \"./NumberFilter.js\";\nimport type { StringFilter } from \"./StringFilter.js\";\n\nexport type PossibleWhereClauseFilters =\n  | \"$gt\"\n  | \"$eq\"\n  | \"$ne\"\n  | \"$isNull\"\n  | \"$contains\"\n  | \"$gte\"\n  | \"$lt\"\n  | \"$lte\"\n  | \"$within\"\n  | \"$in\"\n  | \"$intersects\"\n  | \"$startsWith\"\n  | \"$containsAllTermsInOrder\"\n  | \"$containsAnyTerm\"\n  | \"$containsAllTerms\";\n\n// the value side of this needs to match DistanceUnit from @osdk/foundry but we don't\n// want the dependency\nexport const DistanceUnitMapping: {\n  centimeter: \"CENTIMETERS\";\n  centimeters: \"CENTIMETERS\";\n  cm: \"CENTIMETERS\";\n  meter: \"METERS\";\n  meters: \"METERS\";\n  m: \"METERS\";\n  kilometer: \"KILOMETERS\";\n  kilometers: \"KILOMETERS\";\n  km: \"KILOMETERS\";\n  inch: \"INCHES\";\n  inches: \"INCHES\";\n  foot: \"FEET\";\n  feet: \"FEET\";\n  yard: \"YARDS\";\n  yards: \"YARDS\";\n  mile: \"MILES\";\n  miles: \"MILES\";\n  nautical_mile: \"NAUTICAL_MILES\";\n  nauticalMile: \"NAUTICAL_MILES\";\n  \"nautical miles\": \"NAUTICAL_MILES\";\n} = {\n  \"centimeter\": \"CENTIMETERS\",\n  \"centimeters\": \"CENTIMETERS\",\n  \"cm\": \"CENTIMETERS\",\n  \"meter\": \"METERS\",\n  \"meters\": \"METERS\",\n  \"m\": \"METERS\",\n  \"kilometer\": \"KILOMETERS\",\n  \"kilometers\": \"KILOMETERS\",\n  \"km\": \"KILOMETERS\",\n  \"inch\": \"INCHES\",\n  \"inches\": \"INCHES\",\n  \"foot\": \"FEET\",\n  \"feet\": \"FEET\",\n  \"yard\": \"YARDS\",\n  \"yards\": \"YARDS\",\n  \"mile\": \"MILES\",\n  \"miles\": \"MILES\",\n  \"nautical_mile\": \"NAUTICAL_MILES\",\n  \"nauticalMile\": \"NAUTICAL_MILES\",\n  \"nautical miles\": \"NAUTICAL_MILES\",\n} satisfies Record<\n  string,\n  | \"CENTIMETERS\"\n  | \"METERS\"\n  | \"KILOMETERS\"\n  | \"INCHES\"\n  | \"FEET\"\n  | \"YARDS\"\n  | \"MILES\"\n  | \"NAUTICAL_MILES\"\n>;\n\nexport type GeoFilter_Within = {\n  \"$within\":\n    | {\n      $distance: [number, keyof typeof DistanceUnitMapping];\n      $of: [number, number] | Readonly<Point>;\n      $bbox?: never;\n      $polygon?: never;\n    }\n    | {\n      $bbox: BBox;\n      $distance?: never;\n      $of?: never;\n      $polygon?: never;\n    }\n    | BBox\n    | {\n      $polygon: Polygon[\"coordinates\"];\n      $bbox?: never;\n      $distance?: never;\n      $of?: never;\n    }\n    | Polygon;\n};\n\nexport type GeoFilter_Intersects = {\n  \"$intersects\":\n    | {\n      $bbox: BBox;\n      $polygon?: never;\n    }\n    | BBox\n    | {\n      $polygon: Polygon[\"coordinates\"];\n      $bbox?: never;\n    }\n    | Polygon;\n};\n\ntype FilterFor<PD extends ObjectMetadata.Property> = PD[\"multiplicity\"] extends\n  true\n  ? (PD[\"type\"] extends Record<string, BaseWirePropertyTypes>\n    ? ArrayFilter<StructArrayFilterOpts<PD[\"type\"]>>\n    : PD[\"type\"] extends PropertyTypesRepresentedAsStringsForArrayWhereClause\n      ? ArrayFilter<string>\n    : (PD[\"type\"] extends boolean ? ArrayFilter<boolean>\n      : ArrayFilter<number>))\n  : PD[\"type\"] extends Record<string, BaseWirePropertyTypes> ?\n      | StructFilter<PD[\"type\"]>\n      | BaseFilter.$isNull<string>\n  : (PD[\"type\"] extends \"string\" ? StringFilter\n    : PD[\"type\"] extends \"geopoint\" | \"geoshape\" ? GeoFilter\n    : PD[\"type\"] extends \"datetime\" | \"timestamp\" ? DatetimeFilter\n    : PD[\"type\"] extends \"boolean\" ? BooleanFilter\n    : PD[\"type\"] extends WhereClauseNumberPropertyTypes ? NumberFilter\n    : BaseFilter<string>); // FIXME we need to represent all types\n\ntype StructArrayFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {\n  [K in keyof ST]?: ST[K] extends\n    PropertyTypesRepresentedAsStringsForArrayWhereClause ? EqFilter.$eq<string>\n    : ST[K] extends boolean ? EqFilter.$eq<boolean>\n    : ST[K] extends WhereClauseNumberPropertyTypes ? EqFilter.$eq<number>\n    : never;\n};\n\ntype StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {\n  [K in keyof ST]?: FilterFor<{ \"type\": ST[K] }>;\n};\ntype StructFilter<ST extends Record<string, BaseWirePropertyTypes>> = {\n  [K in keyof ST]: Just<K, StructFilterOpts<ST>>;\n}[keyof ST];\n\ntype PropertyTypesRepresentedAsStringsForArrayWhereClause =\n  | \"string\"\n  | \"geopoint\"\n  | \"geoshape\"\n  | \"datetime\"\n  | \"timestamp\";\ntype WhereClauseNumberPropertyTypes =\n  | \"double\"\n  | \"integer\"\n  | \"long\"\n  | \"float\"\n  | \"decimal\"\n  | \"byte\";\n\nexport interface AndWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  $and: WhereClause<T>[];\n}\n\nexport interface OrWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  $or: WhereClause<T>[];\n}\n\nexport interface NotWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n> {\n  $not: WhereClause<T>;\n}\n\nexport type PropertyWhereClause<T extends ObjectOrInterfaceDefinition> = {\n  [P in keyof CompileTimeMetadata<T>[\"properties\"]]?: FilterFor<\n    CompileTimeMetadata<T>[\"properties\"][P]\n  >;\n};\n\nexport type WhereClause<\n  T extends ObjectOrInterfaceDefinition,\n> =\n  | OrWhereClause<T>\n  | AndWhereClause<T>\n  | NotWhereClause<T>\n  | (IsNever<keyof CompileTimeMetadata<T>[\"properties\"]> extends true\n    ? Record<string, never>\n    : PropertyWhereClause<T>);\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAsCA;AACA;AACA,OAAO,MAAMA,mBAqBZ,GAAG;EACF,YAAY,EAAE,aAAa;EAC3B,aAAa,EAAE,aAAa;EAC5B,IAAI,EAAE,aAAa;EACnB,OAAO,EAAE,QAAQ;EACjB,QAAQ,EAAE,QAAQ;EAClB,GAAG,EAAE,QAAQ;EACb,WAAW,EAAE,YAAY;EACzB,YAAY,EAAE,YAAY;EAC1B,IAAI,EAAE,YAAY;EAClB,MAAM,EAAE,QAAQ;EAChB,QAAQ,EAAE,QAAQ;EAClB,MAAM,EAAE,MAAM;EACd,MAAM,EAAE,MAAM;EACd,MAAM,EAAE,OAAO;EACf,OAAO,EAAE,OAAO;EAChB,MAAM,EAAE,OAAO;EACf,OAAO,EAAE,OAAO;EAChB,eAAe,EAAE,gBAAgB;EACjC,cAAc,EAAE,gBAAgB;EAChC,gBAAgB,EAAE;AACpB,CAUC;;AAwD0B","ignoreList":[]}

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  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 Creator<\n    Q extends ObjectOrInterfaceDefinition,\n    T extends SimplePropertyDef,\n  > = (\n    baseObjectSet: Builder<Q, false>,\n  ) =>\n    | Definition<T, Q>\n    | NumericPropertyDefinition<T, Q>\n    | DatetimePropertyDefinition<T, Q>;\n\n  export type Clause<\n    Q extends ObjectOrInterfaceDefinition,\n  > = {\n    [key: string]: Creator<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> {\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\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":[]}
+{"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 Creator<\n    Q extends ObjectOrInterfaceDefinition,\n    T extends SimplePropertyDef,\n  > = (\n    baseObjectSet: Builder<Q, false>,\n  ) =>\n    | Definition<T, Q>\n    | NumericPropertyDefinition<T, Q>\n    | DatetimePropertyDefinition<T, Q>;\n\n  export type Clause<\n    Q extends ObjectOrInterfaceDefinition,\n  > = {\n    [key: string]: Creator<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\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/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 {\n  OsdkObjectCreatePropertyType,\n  OsdkObjectPropertyType,\n} 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 { Logger } from \"./Logger.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  InterfaceQueryDataType,\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\";\n// eslint-disable-next-line @typescript-eslint/no-deprecated\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 {};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkBA,SAASA,mBAAmB,QAAQ,4BAA4B;AAgBhE,SAASC,eAAe,QAAQ,4BAA4B;AA+B5D,SAASC,IAAI,QAAQ,oBAAoB;;AA+CzC;;AAUA,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 {\n  OsdkObjectCreatePropertyType,\n  OsdkObjectPropertyType,\n} 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 { Logger } from \"./Logger.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  ObjectSetArgs,\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  InterfaceQueryDataType,\n  ObjectQueryDataType,\n  ObjectSetQueryDataType,\n  QueryDataTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  QueryParameterDefinition,\n  ThreeDimensionalQueryAggregationDefinition,\n  TwoDimensionalQueryAggregationDefinition,\n} from \"./ontology/QueryDefinition.js\";\nexport type { PropertyBooleanFormattingRule } from \"./ontology/valueFormatting/PropertyBooleanFormattingRule.js\";\nexport type {\n  DatetimeFormat,\n  DatetimeLocalizedFormat,\n  DatetimeLocalizedFormatType,\n  DatetimeStringFormat,\n  DatetimeTimezone,\n  DatetimeTimezoneStatic,\n  DatetimeTimezoneUser,\n  PropertyDateFormattingRule,\n  PropertyTimestampFormattingRule,\n} from \"./ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js\";\nexport type {\n  KnownType,\n  PropertyKnownTypeFormattingRule,\n} from \"./ontology/valueFormatting/PropertyKnownTypeFormattingRule.js\";\nexport type {\n  Affix,\n  DurationBaseValue,\n  DurationFormatStyle,\n  DurationPrecision,\n  HumanReadableFormat,\n  NumberFormatAffix,\n  NumberFormatCurrency,\n  NumberFormatCurrencyStyle,\n  NumberFormatCustomUnit,\n  NumberFormatDuration,\n  NumberFormatFixedValues,\n  NumberFormatNotation,\n  NumberFormatOptions,\n  NumberFormatRatio,\n  NumberFormatScale,\n  NumberFormatStandard,\n  NumberFormatStandardUnit,\n  NumberRatioType,\n  NumberRoundingMode,\n  NumberScaleType,\n  PropertyNumberFormattingRule,\n  PropertyNumberFormattingRuleType,\n  TimeCodeFormat,\n} from \"./ontology/valueFormatting/PropertyNumberFormattingRule.js\";\nexport type { PropertyValueFormattingRule } from \"./ontology/valueFormatting/PropertyValueFormattingRule.js\";\nexport type {\n  PropertyTypeReference,\n  PropertyTypeReferenceOrStringConstant,\n  StringConstant,\n} from \"./ontology/valueFormatting/PropertyValueFormattingUtils.js\";\nexport type {\n  BaseWirePropertyTypes,\n  WirePropertyTypes,\n} from \"./ontology/WirePropertyTypes.js\";\nexport type {\n  ObjectIdentifiers,\n  OsdkBase,\n  PrimaryKeyType,\n} from \"./OsdkBase.js\";\n// eslint-disable-next-line @typescript-eslint/no-deprecated\nexport type { OsdkObject } from \"./OsdkObject.js\";\nexport type { ConvertProps, MaybeScore, 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 {};\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;AAgBhE,SAASC,eAAe,QAAQ,4BAA4B;AAqC5D,SAASC,IAAI,QAAQ,oBAAoB;;AA8FzC;;AAUA,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.js.map

@@ -1 +1 @@
-{"version":3,"file":"ObjectSet.js","names":[],"sources":["ObjectSet.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 { AggregateOpts } from \"../aggregate/AggregateOpts.js\";\nimport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"../aggregate/AggregateOptsThatErrors.js\";\nimport type { AggregationsResults } from \"../aggregate/AggregationsResults.js\";\nimport type { WhereClause } from \"../aggregate/WhereClause.js\";\nimport type { DerivedProperty } from \"../derivedProperties/DerivedProperty.js\";\nimport type {\n  AsyncIterArgs,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  ObjectSetArgs,\n  SelectArg,\n} from \"../object/FetchPageArgs.js\";\nimport type { Result } from \"../object/Result.js\";\nimport type {\n  DerivedObjectOrInterfaceDefinition,\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectTypeDefinition,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { PrimaryKeyType } from \"../OsdkBase.js\";\nimport type {\n  ExtractAllPropertiesOption,\n  ExtractOptions,\n  ExtractRidOption,\n  MaybeScore,\n  Osdk,\n} from \"../OsdkObjectFrom.js\";\nimport type { PageResult } from \"../PageResult.js\";\nimport type { LinkedType, LinkNames } from \"../util/LinkUtils.js\";\nimport type { BaseObjectSet } from \"./BaseObjectSet.js\";\nimport type { ObjectSetSubscription } from \"./ObjectSetListener.js\";\n\ntype MergeObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n  D extends Record<string, SimplePropertyDef> = {},\n> = DerivedObjectOrInterfaceDefinition.WithDerivedProperties<Q, D>;\n\ntype ExtractRdp<\n  D extends\n    | BaseObjectSet<any>\n    | Record<string, SimplePropertyDef>,\n> = [D] extends [never] ? {}\n  : D extends BaseObjectSet<any> ? {}\n  : D extends Record<string, SimplePropertyDef> ? D\n  : {};\n\ntype MaybeSimplifyPropertyKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends PropertyKeys<Q>,\n> = PropertyKeys<Q> extends L ? PropertyKeys<Q> : L & PropertyKeys<Q>;\n\ntype SubSelectKeysHelper<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends string,\n> = [L] extends [never] ? PropertyKeys<Q>\n  : PropertyKeys<Q> extends L ? PropertyKeys<Q>\n  : L & PropertyKeys<Q>;\n\ntype SubSelectKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  X extends SelectArg<Q, PropertyKeys<Q>, any, any> = never,\n> = SubSelectKeysHelper<Q, Extract$Select<X>>;\n\ntype NOOP<T> = T extends (...args: any[]) => any ? T\n  : T extends abstract new(...args: any[]) => any ? T\n  : { [K in keyof T]: T[K] };\n\ntype SubSelectRDPsHelper<\n  X extends ValidFetchPageArgs<any, any, any> | ValidAsyncIterArgs<any, any>,\n  DEFAULT extends string,\n> = [X] extends [never] ? DEFAULT\n  : (X[\"$select\"] & string[])[number] & DEFAULT;\n\ntype SubSelectRDPs<\n  RDPs extends Record<string, SimplePropertyDef>,\n  X extends ValidFetchPageArgs<any, RDPs, any> | ValidAsyncIterArgs<any, RDPs>,\n> = [RDPs] extends [never] ? never\n  : NOOP<{ [K in SubSelectRDPsHelper<X, string & keyof RDPs>]: RDPs[K] }>;\n\nexport interface MinimalObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n> extends\n  BaseObjectSet<Q>,\n  FetchPage<Q, RDPs>,\n  AsyncIter<Q, RDPs, ORDER_BY_OPTIONS>,\n  Where<Q, RDPs>\n{\n}\n\nexport type ExtractOptions2<\n  X extends FetchPageArgs<any, any, any, any, any, any, any>,\n> = [X] extends [never] ? never\n  :\n    | ExtractRidOption<X[\"$includeRid\"] extends true ? true : false>\n    | ExtractAllPropertiesOption<\n      X[\"$includeAllBaseObjectProperties\"] extends true ? true : false\n    >;\n\ntype Extract$Select<X extends FetchPageArgs<any, any>> = NonNullable<\n  X[\"$select\"]\n>[number];\n\ninterface FetchPage<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  readonly fetchPage: FetchPageSignature<Q, RDPs>;\n  readonly fetchPageWithErrors: FetchPageWithErrorsSignature<Q, RDPs>;\n}\n\ntype ValidFetchPageArgs<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>>,\n> = ObjectSetArgs.FetchPage<\n  Q,\n  PropertyKeys<Q>,\n  boolean,\n  string & keyof RDPs,\n  ORDER_BY_OPTIONS\n>;\n\ntype ValidAsyncIterArgs<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> =\n  | ObjectSetArgs.AsyncIter<\n    Q,\n    PropertyKeys<Q>,\n    false,\n    string & keyof RDPs\n  >\n  | AsyncIterArgs<\n    Q,\n    never,\n    any,\n    any,\n    any,\n    true,\n    string & keyof RDPs\n  >;\n\ninterface FetchPageSignature<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Gets a page of objects of this type, with a result wrapper\n   * @param args - Args to specify next page token and page size, if applicable\n   * @example\n   *  const myObjs = await objectSet.fetchPage({\n      $pageSize: 10,\n      $nextPageToken: \"nextPage\"\n    });\n     const myObjsResult = myObjs.data;\n\n   * @returns a page of objects\n   */\n  <\n    L extends PropertyKeys<Q> | (string & keyof RDPs),\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n    T extends boolean = false,\n    ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {},\n  >(\n    args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>,\n  ): Promise<\n    PageResult<\n      MaybeScore<\n        Osdk.Instance<\n          Q,\n          ExtractOptions<R, S, T>,\n          NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n          SubSelectRDPs<RDPs, NonNullable<typeof args>>\n        >,\n        ORDER_BY_OPTIONS\n      >\n    >\n  >;\n}\n\ninterface NearestNeighbors<Q extends ObjectOrInterfaceDefinition> {\n  /**\n   * Finds the nearest neighbors for a given text or vector within the object set.\n   *\n   * @param query - Queries support either a vector matching the embedding model defined on the property, or text that is\n        automatically embedded.\n   * @param numNeighbors - The number of objects to return. If the number of documents in the objectType is less than the provided\n            value, all objects will be returned. This value is limited to 1 &le; numNeighbors &ge; 500.\n   * @param property - The property key with a defined embedding model to search over.\n   *\n   * @returns An object set containing the `numNeighbors` nearest neighbors. To return the objects ordered by relevance and each\n   * objects associated score, specify \"relevance\" in the orderBy.\n */\n\n  readonly nearestNeighbors: (\n    query: string | number[],\n    numNeighbors: number,\n    property: PropertyKeys.Filtered<Q, \"vector\">,\n  ) => this;\n}\n\ninterface FetchPageWithErrorsSignature<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Gets a page of objects of this type, with a result wrapper\n   * @param args - Args to specify next page token and page size, if applicable\n   * @example\n   *  const myObjs = await objectSet.fetchPage({\n      $pageSize: 10,\n      $nextPageToken: \"nextPage\"\n    });\n\n     if(isOk(myObjs)){\n     const myObjsResult = myObjs.value.data;\n    }\n   * @returns a page of objects, wrapped in a result wrapper\n   */\n  <\n    L extends PropertyKeys<Q> | (string & keyof RDPs),\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n    T extends boolean = false,\n    ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {},\n  >(\n    args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>,\n  ): Promise<\n    Result<\n      PageResult<\n        MaybeScore<\n          Osdk.Instance<\n            Q,\n            ExtractOptions<R, S, T>,\n            NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n            SubSelectRDPs<RDPs, NonNullable<typeof args>>\n          >,\n          ORDER_BY_OPTIONS\n        >\n      >\n    >\n  >;\n}\n\n// TODO MOVE THIS\ninterface Where<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n * Allows you to filter an object set with a given clause\n * @param clause - Takes a filter clause\n * @example\n * await client(Office).where({\n    meetingRooms: { $contains: \"Grand Central\" },\n    meetingRoomCapacities: { $contains: 30 },\n});\n* @returns an objectSet\n  */\n  readonly where: (\n    clause: WhereClause<MergeObjectSet<Q, RDPs>>,\n  ) => this;\n}\n\ninterface AsyncIterSignature<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n> {\n  /**\n   * Returns an async iterator to load all objects of this type\n   * @example\n   * for await (const obj of myObjectSet.asyncIter()){\n   * // Handle obj\n   * }\n   * @returns an async iterator to load all objects\n   */\n  <X extends ValidAsyncIterArgs<Q, RDPs> = never>(\n    args?: X,\n  ): AsyncIterableIterator<\n    Osdk.Instance<\n      Q,\n      ExtractOptions2<X>,\n      SubSelectKeys<Q, X>,\n      SubSelectRDPs<RDPs, X>\n    >\n  >;\n\n  /**\n   * Returns an async iterator to load all objects of this type\n   * @example\n   * for await (const obj of myObjectSet.asyncIter()){\n   * // Handle obj\n   * }\n   * @returns an async iterator to load all objects\n   */\n  <\n    L extends PropertyKeys<Q> | (string & keyof RDPs),\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n    T extends boolean = false,\n    ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n  >(\n    args?: AsyncIterArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>,\n  ): AsyncIterableIterator<\n    MaybeScore<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, T>,\n        NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n        SubSelectRDPs<RDPs, NonNullable<typeof args>>\n      >,\n      ORDER_BY_OPTIONS\n    >\n  >;\n}\n\ninterface AsyncIter<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n> {\n  asyncIter: AsyncIterSignature<Q, RDPs, ORDER_BY_OPTIONS>;\n}\n\ninterface WithProperties<\n  Q extends ObjectOrInterfaceDefinition = any,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  readonly withProperties: <\n    NEW extends Record<string, SimplePropertyDef>,\n  >(\n    clause: { [K in keyof NEW]: DerivedProperty.Creator<Q, NEW[K]> },\n  ) => ObjectSet<\n    Q,\n    {\n      [NN in keyof NEW | keyof RDPs]: NN extends keyof NEW ? NEW[NN]\n        : NN extends keyof RDPs ? RDPs[NN]\n        : never;\n    }\n  >;\n}\n\nexport interface ObjectSet<\n  Q extends ObjectOrInterfaceDefinition = any,\n  // Generated code has what is basically ObjectSet<Q> set in here\n  // but we never used it so I am repurposing it for RDP\n  UNUSED_OR_RDP extends\n    | BaseObjectSet<Q>\n    | Record<string, SimplePropertyDef> = never,\n> extends\n  ObjectSetCleanedTypes<\n    Q,\n    ExtractRdp<UNUSED_OR_RDP>,\n    MergeObjectSet<Q, ExtractRdp<UNUSED_OR_RDP>>\n  >\n{\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface Aggregate<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Aggregate on a field in an object type\n   * @param req - an aggregation request where you can select fields and choose how to aggregate, e.g., max, min, avg, and also choose\n   * whether or not you order your results. You can also specify a groupBy field to group your aggregations\n   * @example\n   * const testAggregateCountWithGroups = await client(BoundariesUsState)\n    .aggregate({\n      $select: {\n        $count: \"unordered\",\n        \"latitude:max\": \"unordered\",\n        \"latitude:min\": \"unordered\",\n        \"latitude:avg\": \"unordered\",\n      },\n      $groupBy: {\n        usState: \"exact\",\n        longitude: {\n          $fixedWidth: 10,\n        },\n      },\n    });\n\n   * @returns aggregation results, sorted in the groups based on the groupBy clause (if applicable)\n   */\n  readonly aggregate: <AO extends AggregateOpts<Q>>(\n    req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>,\n  ) => Promise<AggregationsResults<Q, AO>>;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface SetArithmetic<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Unions object sets together\n   * @param objectSets - objectSets you want to union with\n   * @example\n   * const unionObjectSet = complexFilteredEmployeeObjectSet.union(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the unioned object set\n   */\n  readonly union: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n\n  /**\n   * Computes the intersection of object sets\n   * @param objectSets - objectSets you want to intersect with\n   * @example\n   * const intersectedObjectSet = complexFilteredEmployeeObjectSet.intersect(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the intersected object set\n   */\n  readonly intersect: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n\n  /**\n   * Computes the subtraction of object sets\n   * @param objectSets - objectSets you want to subtract from\n   * @example\n   * const subtractObjectSet = complexFilteredEmployeeObjectSet.subtract(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the subtract object set\n   */\n  readonly subtract: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface PivotTo<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Pivots the object set over to all its linked objects of the specified type\n   * @param type - The linked object type you want to pivot to\n   * @returns an object set of the specified linked type\n   */\n  readonly pivotTo: <L extends LinkNames<Q>>(\n    type: L,\n  ) => ObjectSet<LinkedType<Q, L>>;\n}\n\ninterface FetchOneSignature<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  /**\n   * Fetches one object with the specified primary key, without a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q> | (string & keyof RDPs),\n    const R extends boolean,\n    const S extends false | \"throw\" = NullabilityAdherence.Default,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S>,\n  ): Promise<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S>,\n      NoInfer<SubSelectKeys<Q, { $select: Array<L> }>>,\n      SubSelectRDPs<RDPs, { $select: Array<L> }>\n    >\n  >;\n}\n\ninterface FetchOneWithErrorsSignature<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  /**\n   * Fetches one object with the specified primary key, with a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q> | (string & keyof RDPs),\n    const R extends boolean,\n    const S extends false | \"throw\" = NullabilityAdherence.Default,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S>,\n  ): Promise<\n    Result<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S>,\n        NoInfer<SubSelectKeys<Q, { $select: Array<L> }>>,\n        SubSelectRDPs<RDPs, { $select: Array<L> }>\n      >\n    >\n  >;\n}\n\ninterface FetchOne<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  fetchOne: Q extends ObjectTypeDefinition ? FetchOneSignature<Q, RDPs> : never;\n  fetchOneWithErrors: Q extends ObjectTypeDefinition\n    ? FetchOneWithErrorsSignature<Q, RDPs>\n    : never;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface Subscribe<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Request updates when the objects in an object set are added, updated, or removed.\n   * @param listener - The handlers to be executed during the lifecycle of the subscription.\n   * @param opts - Options to modify what properties are returned on subscription updates.\n   * @returns an object containing a function to unsubscribe.\n   */\n  readonly subscribe: <\n    const P extends PropertyKeys<Q>,\n  >(\n    listener: ObjectSetSubscription.Listener<Q, P>,\n    opts?: ObjectSetSubscription.Options<Q, P>,\n  ) => { unsubscribe: () => void };\n}\n\ninterface ObjectSetCleanedTypes<\n  Q extends ObjectOrInterfaceDefinition,\n  D extends Record<string, SimplePropertyDef>,\n  MERGED extends ObjectOrInterfaceDefinition & Q,\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n> extends\n  MinimalObjectSet<Q, D, ORDER_BY_OPTIONS>,\n  WithProperties<Q, D>,\n  Aggregate<MERGED>,\n  SetArithmetic<MERGED>,\n  PivotTo<Q>,\n  FetchOne<Q, D>,\n  Subscribe<MERGED>,\n  NearestNeighbors<Q>\n{\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"ObjectSet.js","names":[],"sources":["ObjectSet.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 { AggregateOpts } from \"../aggregate/AggregateOpts.js\";\nimport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"../aggregate/AggregateOptsThatErrors.js\";\nimport type { AggregationsResults } from \"../aggregate/AggregationsResults.js\";\nimport type { WhereClause } from \"../aggregate/WhereClause.js\";\nimport type { DerivedProperty } from \"../derivedProperties/DerivedProperty.js\";\nimport type {\n  AsyncIterArgs,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  ObjectSetArgs,\n  SelectArg,\n} from \"../object/FetchPageArgs.js\";\nimport type { Result } from \"../object/Result.js\";\nimport type { InterfaceDefinition } from \"../ontology/InterfaceDefinition.js\";\nimport type {\n  DerivedObjectOrInterfaceDefinition,\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectTypeDefinition,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { PrimaryKeyType } from \"../OsdkBase.js\";\nimport type {\n  ExtractAllPropertiesOption,\n  ExtractOptions,\n  ExtractRidOption,\n  MaybeScore,\n  Osdk,\n} from \"../OsdkObjectFrom.js\";\nimport type { PageResult } from \"../PageResult.js\";\nimport type { LinkedType, LinkNames } from \"../util/LinkUtils.js\";\nimport type { BaseObjectSet } from \"./BaseObjectSet.js\";\nimport type { ObjectSetSubscription } from \"./ObjectSetListener.js\";\n\ntype MergeObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n  D extends Record<string, SimplePropertyDef> = {},\n> = DerivedObjectOrInterfaceDefinition.WithDerivedProperties<Q, D>;\n\ntype ExtractRdp<\n  D extends\n    | BaseObjectSet<any>\n    | Record<string, SimplePropertyDef>,\n> = [D] extends [never] ? {}\n  : D extends BaseObjectSet<any> ? {}\n  : D extends Record<string, SimplePropertyDef> ? D\n  : {};\n\ntype MaybeSimplifyPropertyKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends PropertyKeys<Q>,\n> = PropertyKeys<Q> extends L ? PropertyKeys<Q> : L & PropertyKeys<Q>;\n\ntype SubSelectKeysHelper<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends string,\n> = [L] extends [never] ? PropertyKeys<Q>\n  : PropertyKeys<Q> extends L ? PropertyKeys<Q>\n  : L & PropertyKeys<Q>;\n\ntype SubSelectKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  X extends SelectArg<Q, PropertyKeys<Q>, any, any> = never,\n> = SubSelectKeysHelper<Q, Extract$Select<X>>;\n\ntype NOOP<T> = T extends (...args: any[]) => any ? T\n  : T extends abstract new(...args: any[]) => any ? T\n  : { [K in keyof T]: T[K] };\n\ntype SubSelectRDPsHelper<\n  X extends ValidFetchPageArgs<any, any, any> | ValidAsyncIterArgs<any, any>,\n  DEFAULT extends string,\n> = [X] extends [never] ? DEFAULT\n  : (X[\"$select\"] & string[])[number] & DEFAULT;\n\ntype SubSelectRDPs<\n  RDPs extends Record<string, SimplePropertyDef>,\n  X extends ValidFetchPageArgs<any, RDPs, any> | ValidAsyncIterArgs<any, RDPs>,\n> = [RDPs] extends [never] ? never\n  : NOOP<{ [K in SubSelectRDPsHelper<X, string & keyof RDPs>]: RDPs[K] }>;\n\nexport interface MinimalObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n> extends\n  BaseObjectSet<Q>,\n  FetchPage<Q, RDPs>,\n  AsyncIter<Q, RDPs, ORDER_BY_OPTIONS>,\n  Where<Q, RDPs>\n{\n}\n\nexport type ExtractOptions2<\n  X extends FetchPageArgs<any, any, any, any, any, any, any>,\n> = [X] extends [never] ? never\n  :\n    | ExtractRidOption<X[\"$includeRid\"] extends true ? true : false>\n    | ExtractAllPropertiesOption<\n      X[\"$includeAllBaseObjectProperties\"] extends true ? true : false\n    >;\n\ntype Extract$Select<X extends FetchPageArgs<any, any>> = NonNullable<\n  X[\"$select\"]\n>[number];\n\ninterface FetchPage<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  readonly fetchPage: FetchPageSignature<Q, RDPs>;\n  readonly fetchPageWithErrors: FetchPageWithErrorsSignature<Q, RDPs>;\n}\n\ntype ValidFetchPageArgs<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>>,\n> = ObjectSetArgs.FetchPage<\n  Q,\n  PropertyKeys<Q>,\n  boolean,\n  string & keyof RDPs,\n  ORDER_BY_OPTIONS\n>;\n\ntype ValidAsyncIterArgs<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> =\n  | ObjectSetArgs.AsyncIter<\n    Q,\n    PropertyKeys<Q>,\n    false,\n    string & keyof RDPs\n  >\n  | AsyncIterArgs<\n    Q,\n    never,\n    any,\n    any,\n    any,\n    true,\n    string & keyof RDPs\n  >;\n\ninterface FetchPageSignature<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Gets a page of objects of this type, with a result wrapper\n   * @param args - Args to specify next page token and page size, if applicable\n   * @example\n   *  const myObjs = await objectSet.fetchPage({\n      $pageSize: 10,\n      $nextPageToken: \"nextPage\"\n    });\n     const myObjsResult = myObjs.data;\n\n   * @returns a page of objects\n   */\n  <\n    L extends PropertyKeys<Q> | (string & keyof RDPs),\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n    T extends boolean = false,\n    ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {},\n  >(\n    args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>,\n  ): Promise<\n    PageResult<\n      MaybeScore<\n        Osdk.Instance<\n          Q,\n          ExtractOptions<R, S, T>,\n          NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n          SubSelectRDPs<RDPs, NonNullable<typeof args>>\n        >,\n        ORDER_BY_OPTIONS\n      >\n    >\n  >;\n}\n\ninterface NearestNeighbors<Q extends ObjectOrInterfaceDefinition> {\n  /**\n   * Finds the nearest neighbors for a given text or vector within the object set.\n   *\n   * @param query - Queries support either a vector matching the embedding model defined on the property, or text that is\n        automatically embedded.\n   * @param numNeighbors - The number of objects to return. If the number of documents in the objectType is less than the provided\n            value, all objects will be returned. This value is limited to 1 &le; numNeighbors &ge; 500.\n   * @param property - The property key with a defined embedding model to search over.\n   *\n   * @returns An object set containing the `numNeighbors` nearest neighbors. To return the objects ordered by relevance and each\n   * objects associated score, specify \"relevance\" in the orderBy.\n */\n\n  readonly nearestNeighbors: (\n    query: string | number[],\n    numNeighbors: number,\n    property: PropertyKeys.Filtered<Q, \"vector\">,\n  ) => this;\n}\n\ninterface FetchPageWithErrorsSignature<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Gets a page of objects of this type, with a result wrapper\n   * @param args - Args to specify next page token and page size, if applicable\n   * @example\n   *  const myObjs = await objectSet.fetchPage({\n      $pageSize: 10,\n      $nextPageToken: \"nextPage\"\n    });\n\n     if(isOk(myObjs)){\n     const myObjsResult = myObjs.value.data;\n    }\n   * @returns a page of objects, wrapped in a result wrapper\n   */\n  <\n    L extends PropertyKeys<Q> | (string & keyof RDPs),\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n    T extends boolean = false,\n    ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {},\n  >(\n    args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>,\n  ): Promise<\n    Result<\n      PageResult<\n        MaybeScore<\n          Osdk.Instance<\n            Q,\n            ExtractOptions<R, S, T>,\n            NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n            SubSelectRDPs<RDPs, NonNullable<typeof args>>\n          >,\n          ORDER_BY_OPTIONS\n        >\n      >\n    >\n  >;\n}\n\n// TODO MOVE THIS\ninterface Where<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n * Allows you to filter an object set with a given clause\n * @param clause - Takes a filter clause\n * @example\n * await client(Office).where({\n    meetingRooms: { $contains: \"Grand Central\" },\n    meetingRoomCapacities: { $contains: 30 },\n});\n* @returns an objectSet\n  */\n  readonly where: (\n    clause: WhereClause<MergeObjectSet<Q, RDPs>>,\n  ) => this;\n}\n\ninterface AsyncIterSignature<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n> {\n  /**\n   * Returns an async iterator to load all objects of this type\n   * @example\n   * for await (const obj of myObjectSet.asyncIter()){\n   * // Handle obj\n   * }\n   * @returns an async iterator to load all objects\n   */\n  <X extends ValidAsyncIterArgs<Q, RDPs> = never>(\n    args?: X,\n  ): AsyncIterableIterator<\n    Osdk.Instance<\n      Q,\n      ExtractOptions2<X>,\n      SubSelectKeys<Q, X>,\n      SubSelectRDPs<RDPs, X>\n    >\n  >;\n\n  /**\n   * Returns an async iterator to load all objects of this type\n   * @example\n   * for await (const obj of myObjectSet.asyncIter()){\n   * // Handle obj\n   * }\n   * @returns an async iterator to load all objects\n   */\n  <\n    L extends PropertyKeys<Q> | (string & keyof RDPs),\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n    T extends boolean = false,\n    ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n  >(\n    args?: AsyncIterArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>,\n  ): AsyncIterableIterator<\n    MaybeScore<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, T>,\n        NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n        SubSelectRDPs<RDPs, NonNullable<typeof args>>\n      >,\n      ORDER_BY_OPTIONS\n    >\n  >;\n}\n\ninterface AsyncIter<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n> {\n  asyncIter: AsyncIterSignature<Q, RDPs, ORDER_BY_OPTIONS>;\n}\n\ninterface WithProperties<\n  Q extends ObjectOrInterfaceDefinition = any,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  readonly withProperties: <\n    NEW extends Record<string, SimplePropertyDef>,\n  >(\n    clause: { [K in keyof NEW]: DerivedProperty.Creator<Q, NEW[K]> },\n  ) => ObjectSet<\n    Q,\n    {\n      [NN in keyof NEW | keyof RDPs]: NN extends keyof NEW ? NEW[NN]\n        : NN extends keyof RDPs ? RDPs[NN]\n        : never;\n    }\n  >;\n}\n\nexport interface ObjectSet<\n  Q extends ObjectOrInterfaceDefinition = any,\n  // Generated code has what is basically ObjectSet<Q> set in here\n  // but we never used it so I am repurposing it for RDP\n  UNUSED_OR_RDP extends\n    | BaseObjectSet<Q>\n    | Record<string, SimplePropertyDef> = never,\n> extends\n  ObjectSetCleanedTypes<\n    Q,\n    ExtractRdp<UNUSED_OR_RDP>,\n    MergeObjectSet<Q, ExtractRdp<UNUSED_OR_RDP>>\n  >\n{\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface Aggregate<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Aggregate on a field in an object type\n   * @param req - an aggregation request where you can select fields and choose how to aggregate, e.g., max, min, avg, and also choose\n   * whether or not you order your results. You can also specify a groupBy field to group your aggregations\n   * @example\n   * const testAggregateCountWithGroups = await client(BoundariesUsState)\n    .aggregate({\n      $select: {\n        $count: \"unordered\",\n        \"latitude:max\": \"unordered\",\n        \"latitude:min\": \"unordered\",\n        \"latitude:avg\": \"unordered\",\n      },\n      $groupBy: {\n        usState: \"exact\",\n        longitude: {\n          $fixedWidth: 10,\n        },\n      },\n    });\n\n   * @returns aggregation results, sorted in the groups based on the groupBy clause (if applicable)\n   */\n  readonly aggregate: <AO extends AggregateOpts<Q>>(\n    req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>,\n  ) => Promise<AggregationsResults<Q, AO>>;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface SetArithmetic<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Unions object sets together\n   * @param objectSets - objectSets you want to union with\n   * @example\n   * const unionObjectSet = complexFilteredEmployeeObjectSet.union(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the unioned object set\n   */\n  readonly union: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n\n  /**\n   * Computes the intersection of object sets\n   * @param objectSets - objectSets you want to intersect with\n   * @example\n   * const intersectedObjectSet = complexFilteredEmployeeObjectSet.intersect(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the intersected object set\n   */\n  readonly intersect: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n\n  /**\n   * Computes the subtraction of object sets\n   * @param objectSets - objectSets you want to subtract from\n   * @example\n   * const subtractObjectSet = complexFilteredEmployeeObjectSet.subtract(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the subtract object set\n   */\n  readonly subtract: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface PivotTo<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Pivots the object set over to all its linked objects of the specified type\n   * @param type - The linked object type you want to pivot to\n   * @returns an object set of the specified linked type\n   */\n  readonly pivotTo: <L extends LinkNames<Q>>(\n    type: L,\n  ) => ObjectSet<LinkedType<Q, L>>;\n}\n\ninterface FetchOneSignature<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  /**\n   * Fetches one object with the specified primary key, without a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q> | (string & keyof RDPs),\n    const R extends boolean,\n    const S extends false | \"throw\" = NullabilityAdherence.Default,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S>,\n  ): Promise<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S>,\n      NoInfer<SubSelectKeys<Q, { $select: Array<L> }>>,\n      SubSelectRDPs<RDPs, { $select: Array<L> }>\n    >\n  >;\n}\n\ninterface FetchOneWithErrorsSignature<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  /**\n   * Fetches one object with the specified primary key, with a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q> | (string & keyof RDPs),\n    const R extends boolean,\n    const S extends false | \"throw\" = NullabilityAdherence.Default,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S>,\n  ): Promise<\n    Result<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S>,\n        NoInfer<SubSelectKeys<Q, { $select: Array<L> }>>,\n        SubSelectRDPs<RDPs, { $select: Array<L> }>\n      >\n    >\n  >;\n}\n\ninterface FetchOne<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  fetchOne: Q extends ObjectTypeDefinition ? FetchOneSignature<Q, RDPs> : never;\n  fetchOneWithErrors: Q extends ObjectTypeDefinition\n    ? FetchOneWithErrorsSignature<Q, RDPs>\n    : never;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface Subscribe<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Request updates when the objects in an object set are added, updated, or removed.\n   * @param listener - The handlers to be executed during the lifecycle of the subscription.\n   * @param opts - Options to modify what properties are returned on subscription updates.\n   * @returns an object containing a function to unsubscribe.\n   */\n  readonly subscribe: <\n    const P extends PropertyKeys<Q>,\n  >(\n    listener: ObjectSetSubscription.Listener<Q, P>,\n    opts?: ObjectSetSubscription.Options<Q, P>,\n  ) => { unsubscribe: () => void };\n}\n\ninterface AsType<Q extends ObjectOrInterfaceDefinition> {\n  /**\n   * Casts the object set to the specified object type or interface type.\n   * Any downstream object set operations (e.g. where, fetchPage, aggregate) will be\n   * performed on the specified type. Objects from the original object set that do not\n   * implement the specified interface or match the specified object set will be filtered out.\n   * @param type - The object type you want to cast to.\n   * @returns an object set of the specified type.\n   */\n  readonly asType: <CONVERT_TO extends RestrictToImplementingObjectTypes<Q>>(\n    type: CONVERT_TO,\n  ) => ObjectSet<CONVERT_TO>;\n}\n\ntype RestrictToImplementingObjectTypes<T extends ObjectOrInterfaceDefinition> =\n  T extends ObjectTypeDefinition ? ExtractImplementedInterfaces<T>\n    : T extends InterfaceDefinition ? ExtractImplementingTypes<T>\n    : never;\n\ntype ExtractImplementedInterfaces<T extends ObjectTypeDefinition> =\n  CompileTimeMetadata<T> extends { implements: ReadonlyArray<infer API_NAME> }\n    ? API_NAME extends string ? InterfaceDefinition & { apiName: API_NAME }\n    : never\n    : never;\n\ntype ExtractImplementingTypes<T extends InterfaceDefinition> =\n  CompileTimeMetadata<T> extends\n    { implementedBy: ReadonlyArray<infer API_NAME> }\n    ? API_NAME extends string\n      ? (ObjectTypeDefinition & { apiName: API_NAME }) | InterfaceDefinition\n    : never\n    : never;\n\ninterface ObjectSetCleanedTypes<\n  Q extends ObjectOrInterfaceDefinition,\n  D extends Record<string, SimplePropertyDef>,\n  MERGED extends ObjectOrInterfaceDefinition & Q,\n  ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {},\n> extends\n  MinimalObjectSet<Q, D, ORDER_BY_OPTIONS>,\n  WithProperties<Q, D>,\n  Aggregate<MERGED>,\n  SetArithmetic<MERGED>,\n  PivotTo<Q>,\n  FetchOne<Q, D>,\n  Subscribe<MERGED>,\n  NearestNeighbors<Q>,\n  AsType<Q>\n{\n}\n"],"mappings":"","ignoreList":[]}

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

@@ -15,6 +15,8 @@
  */
 
 import { describe, expectTypeOf, it, test, vi } from "vitest";
+import { EmployeeApiTest } from "../test/EmployeeApiTest.js";
+import { FooInterfaceApiTest } from "../test/FooInterfaceApiTest.js";
 export function createMockObjectSet() {
   let fauxObject, fauxResults, fauxObjectSet;
 
@@ -60,6 +62,7 @@ export function createMockObjectSet() {
 }
 describe("ObjectSet", () => {
   const fauxObjectSet = createMockObjectSet();
+  createMockObjectSet();
   describe("normal", () => {
     test("select none", async () => {
       await fauxObjectSet.fetchPage();
@@ -488,6 +491,17 @@ describe("ObjectSet", () => {
           }
         });
       });
+      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 => {
@@ -533,6 +547,17 @@ describe("ObjectSet", () => {
           }
         });
       });
+      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 => {
@@ -631,5 +656,28 @@ describe("ObjectSet", () => {
       expectTypeOf(nearestNeighborsObjectSetWithErrors.value?.data[0]).not.toHaveProperty("$score");
     });
   });
+  describe("asType", () => {
+    it("restricts casting from interface to object type", () => {
+      const objectSet = {
+        asType: () => {}
+      };
+      objectSet.asType(EmployeeApiTest);
+      objectSet.asType(FooInterfaceApiTest);
+      objectSet.asType({
+        type: "interface",
+        apiName: "AnyInterface :)"
+      });
+
+      // @ts-expect-error
+      objectSet.asType({
+        type: "object",
+        apiName: "NotImplemented"
+      });
+    });
+    it("restricts casting from object type to interface", () => {
+      expectTypeOf().toEqualTypeOf();
+      expectTypeOf().toEqualTypeOf();
+    });
+  });
 });
 //# sourceMappingURL=ObjectSet.test.js.map