@osdk/api 2.7.0-beta.11 → 2.7.0-beta.13

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @osdk/api
 
+## 2.7.0-beta.13
+
+### Minor Changes
+
+- fb83808: Allow arrays to use all subtype filters
+
+## 2.7.0-beta.12
+
+### Minor Changes
+
+- bb9d25c: Allow requesting rids for OSW updates
+
 ## 2.7.0-beta.11
 
 ### Minor Changes

package/build/browser/aggregate/WhereClause.js

@@ -39,5 +39,5 @@ export const DistanceUnitMapping = {
   "nautical miles": "NAUTICAL_MILES"
 };
 
-// FIXME we need to represent all types
+// Fallback for unknown types
 //# sourceMappingURL=WhereClause.js.map

package/build/browser/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  DerivedObjectOrInterfaceDefinition,\n  ObjectOrInterfaceDefinition,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.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 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]?: FilterFor<{ \"type\": ST[K] }>;\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 type AndWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $and: WhereClause<T, RDPs>[];\n};\n\nexport type OrWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $or: WhereClause<T, RDPs>[];\n};\n\nexport type NotWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $not: WhereClause<T, RDPs>;\n};\n\nexport type PropertyWhereClause<T extends ObjectOrInterfaceDefinition> = {\n  [P in keyof CompileTimeMetadata<T>[\"properties\"]]?: FilterFor<\n    CompileTimeMetadata<T>[\"properties\"][P]\n  >;\n};\n\ntype MergedPropertyWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = PropertyWhereClause<\n  DerivedObjectOrInterfaceDefinition.WithDerivedProperties<T, RDPs>\n>;\n\nexport type WhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> =\n  | OrWhereClause<T, RDPs>\n  | AndWhereClause<T, RDPs>\n  | NotWhereClause<T, RDPs>\n  | (IsNever<keyof CompileTimeMetadata<T>[\"properties\"]> extends true\n    ? Record<string, never>\n    : MergedPropertyWhereClause<T, RDPs>);\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwCA;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":[]}
+{"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  DerivedObjectOrInterfaceDefinition,\n  ObjectOrInterfaceDefinition,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.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 BaseFilterFor<T> = T extends Record<string, BaseWirePropertyTypes>\n  ? StructFilterOpts<T>\n  : T extends \"string\" ? StringFilter\n  : T extends \"geopoint\" | \"geoshape\" ? GeoFilter\n  : T extends \"datetime\" | \"timestamp\" ? DatetimeFilter\n  : T extends \"boolean\" ? BooleanFilter\n  : T extends WhereClauseNumberPropertyTypes ? NumberFilter\n  : BaseFilter<string>; // Fallback for unknown types\n\ntype FilterFor<PD extends ObjectMetadata.Property> = PD[\"multiplicity\"] extends\n  true ? ArrayFilter<BaseFilterFor<PD[\"type\"]>>\n  : PD[\"type\"] extends Record<string, BaseWirePropertyTypes>\n    ? StructFilter<PD[\"type\"]> | BaseFilter.$isNull<string>\n  : BaseFilterFor<PD[\"type\"]>;\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 WhereClauseNumberPropertyTypes =\n  | \"double\"\n  | \"integer\"\n  | \"long\"\n  | \"float\"\n  | \"decimal\"\n  | \"byte\";\n\nexport type AndWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $and: WhereClause<T, RDPs>[];\n};\n\nexport type OrWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $or: WhereClause<T, RDPs>[];\n};\n\nexport type NotWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $not: WhereClause<T, RDPs>;\n};\n\nexport type PropertyWhereClause<T extends ObjectOrInterfaceDefinition> = {\n  [P in keyof CompileTimeMetadata<T>[\"properties\"]]?: FilterFor<\n    CompileTimeMetadata<T>[\"properties\"][P]\n  >;\n};\n\ntype MergedPropertyWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = PropertyWhereClause<\n  DerivedObjectOrInterfaceDefinition.WithDerivedProperties<T, RDPs>\n>;\n\nexport type WhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> =\n  | OrWhereClause<T, RDPs>\n  | AndWhereClause<T, RDPs>\n  | NotWhereClause<T, RDPs>\n  | (IsNever<keyof CompileTimeMetadata<T>[\"properties\"]> extends true\n    ? Record<string, never>\n    : MergedPropertyWhereClause<T, RDPs>);\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwCA;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;;AA+CuB","ignoreList":[]}

package/build/browser/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 { 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 {\n  LinkTypeApiNamesFor,\n  MinimalDirectedObjectLinkInstance,\n} from \"./ObjectSetLinks.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, 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  AsyncIterLinks<Q>\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    args?: FetchPageArgs<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): Promise<\n    PageResult<\n      MaybeScore<\n        Osdk.Instance<\n          Q,\n          ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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  PROPERTY_SECURITIES extends boolean = false,\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<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): Promise<\n    Result<\n      PageResult<\n        MaybeScore<\n          Osdk.Instance<\n            Q,\n            ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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  PROPERTY_SECURITIES extends boolean = false,\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<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): AsyncIterableIterator<\n    MaybeScore<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>,\n  ): Promise<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S, false, PROPERTY_SECURITIES>,\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>,\n  ): Promise<\n    Result<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, false, PROPERTY_SECURITIES>,\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 NarrowToType<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 narrowToType: <\n    CONVERT_TO extends RestrictToImplementingObjectTypes<Q>,\n  >(\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 extends string> }\n    ? (ObjectTypeDefinition & { apiName: API_NAME }) | InterfaceDefinition\n    : InterfaceDefinition;\n\ninterface AsyncIterLinks<Q extends ObjectOrInterfaceDefinition> {\n  /**\n   * Batch load links on an object set. This is an experimental method that may change while in beta.\n   * Use this method in conjunction with `.asyncIter()` and `.pivotTo(...).asyncIter()` to build an\n   * object graph in memory.\n   *\n   * Please keep these limitations in mind:\n   * - Links returned may be stale. For example, primary keys returned by this endpoint may not exist anymore.\n   * - The backend API fetches pages of *n* objects at a time. If, for any page of *n* objects, there are more\n   *   than 100,000 links present, results are limited to 100,000 links and should be considered partial.\n   * - This method does not support OSv1 links and will throw an exception if links provided are backed by OSv1.\n   * - This method currently does not support interface links, but support will be added in the near future.\n   */\n  readonly experimental_asyncIterLinks: <\n    LINK_TYPE_API_NAME extends LinkTypeApiNamesFor<Q>,\n  >(\n    links: LINK_TYPE_API_NAME[],\n  ) => AsyncIterableIterator<\n    MinimalDirectedObjectLinkInstance<Q, LINK_TYPE_API_NAME>\n  >;\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  NarrowToType<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 {\n  LinkTypeApiNamesFor,\n  MinimalDirectedObjectLinkInstance,\n} from \"./ObjectSetLinks.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, 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  AsyncIterLinks<Q>\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    args?: FetchPageArgs<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): Promise<\n    PageResult<\n      MaybeScore<\n        Osdk.Instance<\n          Q,\n          ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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  PROPERTY_SECURITIES extends boolean = false,\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<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): Promise<\n    Result<\n      PageResult<\n        MaybeScore<\n          Osdk.Instance<\n            Q,\n            ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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  PROPERTY_SECURITIES extends boolean = false,\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<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): AsyncIterableIterator<\n    MaybeScore<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>,\n  ): Promise<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S, false, PROPERTY_SECURITIES>,\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>,\n  ): Promise<\n    Result<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, false, PROPERTY_SECURITIES>,\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    const R extends boolean = false,\n  >(\n    listener: ObjectSetSubscription.Listener<Q, P, R>,\n    opts?: ObjectSetSubscription.Options<Q, P, R>,\n  ) => { unsubscribe: () => void };\n}\n\ninterface NarrowToType<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 narrowToType: <\n    CONVERT_TO extends RestrictToImplementingObjectTypes<Q>,\n  >(\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 extends string> }\n    ? (ObjectTypeDefinition & { apiName: API_NAME }) | InterfaceDefinition\n    : InterfaceDefinition;\n\ninterface AsyncIterLinks<Q extends ObjectOrInterfaceDefinition> {\n  /**\n   * Batch load links on an object set. This is an experimental method that may change while in beta.\n   * Use this method in conjunction with `.asyncIter()` and `.pivotTo(...).asyncIter()` to build an\n   * object graph in memory.\n   *\n   * Please keep these limitations in mind:\n   * - Links returned may be stale. For example, primary keys returned by this endpoint may not exist anymore.\n   * - The backend API fetches pages of *n* objects at a time. If, for any page of *n* objects, there are more\n   *   than 100,000 links present, results are limited to 100,000 links and should be considered partial.\n   * - This method does not support OSv1 links and will throw an exception if links provided are backed by OSv1.\n   * - This method currently does not support interface links, but support will be added in the near future.\n   */\n  readonly experimental_asyncIterLinks: <\n    LINK_TYPE_API_NAME extends LinkTypeApiNamesFor<Q>,\n  >(\n    links: LINK_TYPE_API_NAME[],\n  ) => AsyncIterableIterator<\n    MinimalDirectedObjectLinkInstance<Q, LINK_TYPE_API_NAME>\n  >;\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  NarrowToType<Q>\n{\n}\n"],"mappings":"","ignoreList":[]}

package/build/browser/objectSet/ObjectSetListener.js.map

@@ -1 +1 @@
-{"version":3,"file":"ObjectSetListener.js","names":["ObjectSetSubscription"],"sources":["ObjectSetListener.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 {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { Osdk } from \"../OsdkObjectFrom.js\";\n\nexport namespace ObjectSetSubscription {\n  export interface Listener<\n    O extends ObjectOrInterfaceDefinition,\n    P extends PropertyKeys<O> = PropertyKeys<O>,\n  > {\n    /**\n     * Specific objects have changed and can be immediately updated\n     */\n    onChange?: (\n      objectUpdate: ObjectUpdate<O, P>,\n    ) => void;\n\n    /**\n     * The subscription has been successfully established and updates can be expected to be received.\n     */\n    onSuccessfulSubscription?: () => void;\n\n    /**\n     * The ObjectSet has become outdated and should be re-fetched in its entirety.\n     * This is also sent when the subscription is first initialized.\n     */\n    onOutOfDate?: () => void;\n\n    /**\n     * There was a fatal error with the subscription process. The subscription will close or will not be established.\n     */\n    onError?: (errors: { subscriptionClosed: boolean; error: any }) => void;\n  }\n\n  /**\n   * Options for subscribing to an ObjectSet.\n   *\n   * properties - The properties to request a subscription for. Requesting specific properties limits the possible properties\n   * that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.\n   */\n  export interface Options<\n    O extends ObjectOrInterfaceDefinition,\n    P extends PropertyKeys<O> = PropertyKeys<O>,\n  > {\n    properties?: Array<P>;\n  }\n}\n\ntype ObjectUpdate<\n  O extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<O>,\n> = {\n  object: Osdk.Instance<O, never, P>;\n  state: \"ADDED_OR_UPDATED\" | \"REMOVED\";\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WAsBiBA,qBAAqB","ignoreList":[]}
+{"version":3,"file":"ObjectSetListener.js","names":["ObjectSetSubscription"],"sources":["ObjectSetListener.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 {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { WirePropertyTypes } from \"../ontology/WirePropertyTypes.js\";\nimport type { Osdk } from \"../OsdkObjectFrom.js\";\n\nexport namespace ObjectSetSubscription {\n  export interface Listener<\n    O extends ObjectOrInterfaceDefinition,\n    P extends PropertyKeys<O> = PropertyKeys<O>,\n    R extends boolean = false,\n  > {\n    /**\n     * Specific objects have changed and can be immediately updated\n     */\n    onChange?: (\n      objectUpdate: ObjectUpdate<O, P, R>,\n    ) => void;\n\n    /**\n     * The subscription has been successfully established and updates can be expected to be received.\n     */\n    onSuccessfulSubscription?: () => void;\n\n    /**\n     * The ObjectSet has become outdated and should be re-fetched in its entirety.\n     * This is also sent when the subscription is first initialized.\n     */\n    onOutOfDate?: () => void;\n\n    /**\n     * There was a fatal error with the subscription process. The subscription will close or will not be established.\n     */\n    onError?: (errors: { subscriptionClosed: boolean; error: any }) => void;\n  }\n\n  /**\n   * Options for subscribing to an ObjectSet.\n   *\n   * @param properties The properties to request a subscription for. Requesting specific properties limits the possible properties\n   * that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.\n   *\n   * @param includeRid Whether to include the $rid property in the subscription. Defaults to false. RIDs will be returned on all updates unless the update\n   * contains a new value for a geotime series reference property, in which case the RID will be undefined.\n   */\n  export interface Options<\n    O extends ObjectOrInterfaceDefinition,\n    P extends PropertyKeys<O> = PropertyKeys<O>,\n    R extends boolean = false,\n  > {\n    /**\n     * The properties to request a subscription for. Requesting specific properties limits the possible properties\n     * that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.\n     */\n    properties?: Array<P>;\n\n    /**\n     * Whether to include the $rid property in the subscription. Defaults to false. RIDs will be returned on all updates unless the update\n     * contains a new value for a geotime series reference property, in which case the RID will be undefined. RIDs will not be included\n     * on the objects themselves.\n     */\n    includeRid?: AllFalse<\n      PropertyTypesOnDefMatchesType<O, P, \"geotimeSeriesReference\">\n    > extends true ? R\n      : false;\n  }\n}\n\ntype ObjectUpdate<\n  O extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<O>,\n  R extends boolean = false,\n> = {\n  object: R extends false ? Osdk.Instance<O, never, P>\n    : Osdk.Instance<O, \"$rid\", P>;\n  state: \"ADDED_OR_UPDATED\" | \"REMOVED\";\n};\n\ntype PropertyTypesOnDefMatchesType<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<Q>,\n  T extends WirePropertyTypes,\n> = {\n  [K in P]: CompileTimeMetadata<Q>[\"properties\"][K][\n    \"type\"\n  ] extends T ? true\n    : false;\n};\n\ntype AllFalse<T extends Record<string, boolean>> =\n  Exclude<T[keyof T], false> extends never ? true : false;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WAwBiBA,qBAAqB","ignoreList":[]}

package/build/cjs/{ObjectSet-DlNhU1QE.d.cts → ObjectSet-CqVqDXKn.d.cts}

@@ -1289,12 +1289,8 @@ type GeoFilter_Intersects = {
         $bbox?: never;
     } | Polygon;
 };
-type FilterFor<PD extends ObjectMetadata.Property> = PD["multiplicity"] extends true ? (PD["type"] extends Record<string, BaseWirePropertyTypes> ? ArrayFilter<StructArrayFilterOpts<PD["type"]>> : PD["type"] extends PropertyTypesRepresentedAsStringsForArrayWhereClause ? ArrayFilter<string> : (PD["type"] extends boolean ? ArrayFilter<boolean> : ArrayFilter<number>)) : PD["type"] extends Record<string, BaseWirePropertyTypes> ? StructFilter<PD["type"]> | BaseFilter.$isNull<string> : (PD["type"] extends "string" ? StringFilter : PD["type"] extends "geopoint" | "geoshape" ? GeoFilter : PD["type"] extends "datetime" | "timestamp" ? DatetimeFilter : PD["type"] extends "boolean" ? BooleanFilter : PD["type"] extends WhereClauseNumberPropertyTypes ? NumberFilter : BaseFilter<string>);
-type StructArrayFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {
-    [K in keyof ST]?: FilterFor<{
-        "type": ST[K];
-    }>;
-};
+type BaseFilterFor<T> = T extends Record<string, BaseWirePropertyTypes> ? StructFilterOpts<T> : T extends "string" ? StringFilter : T extends "geopoint" | "geoshape" ? GeoFilter : T extends "datetime" | "timestamp" ? DatetimeFilter : T extends "boolean" ? BooleanFilter : T extends WhereClauseNumberPropertyTypes ? NumberFilter : BaseFilter<string>;
+type FilterFor<PD extends ObjectMetadata.Property> = PD["multiplicity"] extends true ? ArrayFilter<BaseFilterFor<PD["type"]>> : PD["type"] extends Record<string, BaseWirePropertyTypes> ? StructFilter<PD["type"]> | BaseFilter.$isNull<string> : BaseFilterFor<PD["type"]>;
 type StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {
     [K in keyof ST]?: FilterFor<{
         "type": ST[K];
@@ -1303,7 +1299,6 @@ type StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = {
 type StructFilter<ST extends Record<string, BaseWirePropertyTypes>> = {
     [K in keyof ST]: Just<K, StructFilterOpts<ST>>;
 }[keyof ST];
-type PropertyTypesRepresentedAsStringsForArrayWhereClause = "string" | "geopoint" | "geoshape" | "datetime" | "timestamp";
 type WhereClauseNumberPropertyTypes = "double" | "integer" | "long" | "float" | "decimal" | "byte";
 type AndWhereClause<T extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> = {
     $and: WhereClause<T, RDPs>[];
@@ -1418,11 +1413,11 @@ type FetchLinksPageResult<Q extends ObjectOrInterfaceDefinition, LINK_TYPE exten
 };
 
 declare namespace ObjectSetSubscription {
-    interface Listener<O extends ObjectOrInterfaceDefinition, P extends PropertyKeys<O> = PropertyKeys<O>> {
+    interface Listener<O extends ObjectOrInterfaceDefinition, P extends PropertyKeys<O> = PropertyKeys<O>, R extends boolean = false> {
         /**
          * Specific objects have changed and can be immediately updated
          */
-        onChange?: (objectUpdate: ObjectUpdate<O, P>) => void;
+        onChange?: (objectUpdate: ObjectUpdate<O, P, R>) => void;
         /**
          * The subscription has been successfully established and updates can be expected to be received.
          */
@@ -1443,17 +1438,34 @@ declare namespace ObjectSetSubscription {
     /**
      * Options for subscribing to an ObjectSet.
      *
-     * properties - The properties to request a subscription for. Requesting specific properties limits the possible properties
+     * @param properties The properties to request a subscription for. Requesting specific properties limits the possible properties
      * that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.
+     *
+     * @param includeRid Whether to include the $rid property in the subscription. Defaults to false. RIDs will be returned on all updates unless the update
+     * contains a new value for a geotime series reference property, in which case the RID will be undefined.
      */
-    interface Options<O extends ObjectOrInterfaceDefinition, P extends PropertyKeys<O> = PropertyKeys<O>> {
+    interface Options<O extends ObjectOrInterfaceDefinition, P extends PropertyKeys<O> = PropertyKeys<O>, R extends boolean = false> {
+        /**
+         * The properties to request a subscription for. Requesting specific properties limits the possible properties
+         * that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.
+         */
         properties?: Array<P>;
+        /**
+         * Whether to include the $rid property in the subscription. Defaults to false. RIDs will be returned on all updates unless the update
+         * contains a new value for a geotime series reference property, in which case the RID will be undefined. RIDs will not be included
+         * on the objects themselves.
+         */
+        includeRid?: AllFalse<PropertyTypesOnDefMatchesType<O, P, "geotimeSeriesReference">> extends true ? R : false;
     }
 }
-type ObjectUpdate<O extends ObjectOrInterfaceDefinition, P extends PropertyKeys<O>> = {
-    object: Osdk.Instance<O, never, P>;
+type ObjectUpdate<O extends ObjectOrInterfaceDefinition, P extends PropertyKeys<O>, R extends boolean = false> = {
+    object: R extends false ? Osdk.Instance<O, never, P> : Osdk.Instance<O, "$rid", P>;
     state: "ADDED_OR_UPDATED" | "REMOVED";
 };
+type PropertyTypesOnDefMatchesType<Q extends ObjectOrInterfaceDefinition, P extends PropertyKeys<Q>, T extends WirePropertyTypes> = {
+    [K in P]: CompileTimeMetadata<Q>["properties"][K]["type"] extends T ? true : false;
+};
+type AllFalse<T extends Record<string, boolean>> = Exclude<T[keyof T], false> extends never ? true : false;
 
 type MergeObjectSet<Q extends ObjectOrInterfaceDefinition, D extends Record<string, SimplePropertyDef> = {}> = DerivedObjectOrInterfaceDefinition.WithDerivedProperties<Q, D>;
 type ExtractRdp<D extends BaseObjectSet<any> | Record<string, SimplePropertyDef>> = [D] extends [never] ? {} : D extends BaseObjectSet<any> ? {} : D extends Record<string, SimplePropertyDef> ? D : {};
@@ -1665,7 +1677,7 @@ interface Subscribe<Q extends ObjectOrInterfaceDefinition> {
      * @param opts - Options to modify what properties are returned on subscription updates.
      * @returns an object containing a function to unsubscribe.
      */
-    readonly subscribe: <const P extends PropertyKeys<Q>>(listener: ObjectSetSubscription.Listener<Q, P>, opts?: ObjectSetSubscription.Options<Q, P>) => {
+    readonly subscribe: <const P extends PropertyKeys<Q>, const R extends boolean = false>(listener: ObjectSetSubscription.Listener<Q, P, R>, opts?: ObjectSetSubscription.Options<Q, P, R>) => {
         unsubscribe: () => void;
     };
 }

package/build/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/aggregate/WhereClause.ts","../../src/mapping/DurationMapping.ts","../../src/groupby/GroupByClause.ts","../../src/object/Result.ts","../../src/timeseries/timeseries.ts"],"names":[],"mappings":";;;AAkBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,YAAc,EAAA,aAAA;AAAA,EACd,aAAe,EAAA,aAAA;AAAA,EACf,IAAM,EAAA,aAAA;AAAA,EACN,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,GAAK,EAAA,QAAA;AAAA,EACL,WAAa,EAAA,YAAA;AAAA,EACb,YAAc,EAAA,YAAA;AAAA,EACd,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA,QAAA;AAAA,EACR,QAAU,EAAA,QAAA;AAAA,EACV,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,eAAiB,EAAA,gBAAA;AAAA,EACjB,cAAgB,EAAA,gBAAA;AAAA,EAChB,gBAAkB,EAAA;AACpB;;;ACvBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,KAAO,EAAA,SAAA;AAAA,EACP,SAAW,EAAA,SAAA;AAAA,EACX,KAAO,EAAA,SAAA;AAAA,EACP,QAAU,EAAA,SAAA;AAAA,EACV,SAAW,EAAA,SAAA;AAAA,EACX,IAAM,EAAA,OAAA;AAAA,EACN,KAAO,EAAA,OAAA;AAAA,EACP,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,MAAA;AAAA,EACP,MAAQ,EAAA,MAAA;AAAA,EACR,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,QAAA;AAAA,EACP,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA;AACX,CAAA;;;ACpBO,IAAM,eAAkB,GAAA;AAAA,EAC7B,GAAG,mBAAA;AAAA,EACH,SAAW,EAAA,UAAA;AAAA,EACX,UAAY,EAAA;AACd;;;ACAO,SAAS,KAAK,CAAG,EAAA;AACtB,EAAA,OAAO,OAAW,IAAA,CAAA;AACpB;;;ACNO,IAAM,yBAA4B,GAAA;AAAA,EACvC,IAAM,EAAA,cAAA;AAAA,EACN,cAAgB,EAAA,cAAA;AAAA,EAChB,GAAG;AACL","file":"index.cjs","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\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\n// FIXME we need to represent all types","/*\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 const TimeDurationMapping = {\n  \"sec\": \"SECONDS\",\n  \"seconds\": \"SECONDS\",\n  \"min\": \"MINUTES\",\n  \"minute\": \"MINUTES\",\n  \"minutes\": \"MINUTES\",\n  \"hr\": \"HOURS\",\n  \"hrs\": \"HOURS\",\n  \"hour\": \"HOURS\",\n  \"hours\": \"HOURS\",\n  \"day\": \"DAYS\",\n  \"days\": \"DAYS\",\n  \"wk\": \"WEEKS\",\n  \"week\": \"WEEKS\",\n  \"weeks\": \"WEEKS\",\n  \"mos\": \"MONTHS\",\n  \"month\": \"MONTHS\",\n  \"months\": \"MONTHS\",\n  \"yr\": \"YEARS\",\n  \"year\": \"YEARS\",\n  \"years\": \"YEARS\"\n};","/*\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 { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const DurationMapping = {\n  ...TimeDurationMapping,\n  \"quarter\": \"QUARTERS\",\n  \"quarters\": \"QUARTERS\"\n};","/*\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\n/**\n * Check if a result was successfully received\n * @param a - result wrapped value\n * @returns whether a result has a value in it\n */\nexport function isOk(a) {\n  return \"value\" in a;\n}\n\n/**\n * Check if a result contains an error value\n * @param a Result wrapped value\n * @returns whether a result has an error in it\n */\nexport function isError(a) {\n  return \"error\" in a;\n}","/*\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 { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const TimeseriesDurationMapping = {\n  \"ms\": \"MILLISECONDS\",\n  \"milliseconds\": \"MILLISECONDS\",\n  ...TimeDurationMapping\n};"]}
+{"version":3,"sources":["../../src/aggregate/WhereClause.ts","../../src/mapping/DurationMapping.ts","../../src/groupby/GroupByClause.ts","../../src/object/Result.ts","../../src/timeseries/timeseries.ts"],"names":[],"mappings":";;;AAkBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,YAAc,EAAA,aAAA;AAAA,EACd,aAAe,EAAA,aAAA;AAAA,EACf,IAAM,EAAA,aAAA;AAAA,EACN,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,GAAK,EAAA,QAAA;AAAA,EACL,WAAa,EAAA,YAAA;AAAA,EACb,YAAc,EAAA,YAAA;AAAA,EACd,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA,QAAA;AAAA,EACR,QAAU,EAAA,QAAA;AAAA,EACV,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,eAAiB,EAAA,gBAAA;AAAA,EACjB,cAAgB,EAAA,gBAAA;AAAA,EAChB,gBAAkB,EAAA;AACpB;;;ACvBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,KAAO,EAAA,SAAA;AAAA,EACP,SAAW,EAAA,SAAA;AAAA,EACX,KAAO,EAAA,SAAA;AAAA,EACP,QAAU,EAAA,SAAA;AAAA,EACV,SAAW,EAAA,SAAA;AAAA,EACX,IAAM,EAAA,OAAA;AAAA,EACN,KAAO,EAAA,OAAA;AAAA,EACP,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,MAAA;AAAA,EACP,MAAQ,EAAA,MAAA;AAAA,EACR,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,QAAA;AAAA,EACP,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA;AACX,CAAA;;;ACpBO,IAAM,eAAkB,GAAA;AAAA,EAC7B,GAAG,mBAAA;AAAA,EACH,SAAW,EAAA,UAAA;AAAA,EACX,UAAY,EAAA;AACd;;;ACAO,SAAS,KAAK,CAAG,EAAA;AACtB,EAAA,OAAO,OAAW,IAAA,CAAA;AACpB;;;ACNO,IAAM,yBAA4B,GAAA;AAAA,EACvC,IAAM,EAAA,cAAA;AAAA,EACN,cAAgB,EAAA,cAAA;AAAA,EAChB,GAAG;AACL","file":"index.cjs","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\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\n// Fallback for unknown types","/*\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 const TimeDurationMapping = {\n  \"sec\": \"SECONDS\",\n  \"seconds\": \"SECONDS\",\n  \"min\": \"MINUTES\",\n  \"minute\": \"MINUTES\",\n  \"minutes\": \"MINUTES\",\n  \"hr\": \"HOURS\",\n  \"hrs\": \"HOURS\",\n  \"hour\": \"HOURS\",\n  \"hours\": \"HOURS\",\n  \"day\": \"DAYS\",\n  \"days\": \"DAYS\",\n  \"wk\": \"WEEKS\",\n  \"week\": \"WEEKS\",\n  \"weeks\": \"WEEKS\",\n  \"mos\": \"MONTHS\",\n  \"month\": \"MONTHS\",\n  \"months\": \"MONTHS\",\n  \"yr\": \"YEARS\",\n  \"year\": \"YEARS\",\n  \"years\": \"YEARS\"\n};","/*\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 { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const DurationMapping = {\n  ...TimeDurationMapping,\n  \"quarter\": \"QUARTERS\",\n  \"quarters\": \"QUARTERS\"\n};","/*\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\n/**\n * Check if a result was successfully received\n * @param a - result wrapped value\n * @returns whether a result has a value in it\n */\nexport function isOk(a) {\n  return \"value\" in a;\n}\n\n/**\n * Check if a result contains an error value\n * @param a Result wrapped value\n * @returns whether a result has an error in it\n */\nexport function isError(a) {\n  return \"error\" in a;\n}","/*\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 { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const TimeseriesDurationMapping = {\n  \"ms\": \"MILLISECONDS\",\n  \"milliseconds\": \"MILLISECONDS\",\n  ...TimeDurationMapping\n};"]}

package/build/cjs/index.d.cts

@@ -1,5 +1,5 @@
-import { A as AttachmentUpload, M as MediaReference, a as MediaUpload, b as Attachment, O as ObjectTypeDefinition, c as ObjectIdentifiers, d as OsdkObjectPrimaryKeyType, e as ObjectSet, I as InterfaceDefinition, C as CompileTimeMetadata, f as OsdkMetadata, R as ReleaseStatus, g as ObjectOrInterfaceDefinition, P as PropertyValueWireToClient, h as PrimaryKeyTypes, i as OsdkBase } from './ObjectSet-DlNhU1QE.cjs';
-export { ar as Affix, j as AggregateOpts, k as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, n as AggregationClause, l as AggregationResultsWithGroups, m as AggregationResultsWithoutGroups, o as AggregationsResults, z as AllGroupByValues, p as AndWhereClause, F as AsyncIterArgs, H as Augment, J as Augments, a3 as BaseObjectSet, aS as BaseWirePropertyTypes, aV as ConvertProps, ag as DatetimeFormat, ah as DatetimeLocalizedFormat, ai as DatetimeLocalizedFormatType, aj as DatetimeStringFormat, ak as DatetimeTimezone, al as DatetimeTimezoneStatic, am as DatetimeTimezoneUser, x as DerivedProperty, D as DistanceUnitMapping, as as DurationBaseValue, at as DurationFormatStyle, y as DurationMapping, au as DurationPrecision, a4 as FetchLinksPageResult, K as FetchPageArgs, X as FetchPageResult, G as GeoFilterOptions, q as GeoFilter_Intersects, r as GeoFilter_Within, a_ as GeotimeSeriesProperty, B as GroupByClause, E as GroupByRange, av as HumanReadableFormat, a8 as InterfaceMetadata, ap as KnownType, b3 as LinkNames, a5 as LinkTypeApiNamesFor, b2 as LinkedType, aW as MaybeScore, Z as Media, _ as MediaMetadata, a6 as MinimalDirectedObjectLinkInstance, N as NotWhereClause, L as NullabilityAdherence, aw as NumberFormatAffix, ax as NumberFormatCurrency, ay as NumberFormatCurrencyStyle, az as NumberFormatCustomUnit, aA as NumberFormatDuration, aB as NumberFormatFixedValues, aC as NumberFormatNotation, aD as NumberFormatOptions, aE as NumberFormatRatio, aF as NumberFormatScale, aG as NumberFormatStandard, aH as NumberFormatStandardUnit, aI as NumberRatioType, aJ as NumberRoundingMode, aK as NumberScaleType, ab as ObjectMetadata, Q as ObjectSetArgs, a7 as ObjectSetSubscription, aa as ObjectSpecifier, s as OrWhereClause, aX as Osdk, u as OsdkObjectCreatePropertyType, w as OsdkObjectLinksObject, v as OsdkObjectPropertyType, aY as PageResult, t as PossibleWhereClauseFilters, aU as PrimaryKeyType, af as PropertyBooleanFormattingRule, an as PropertyDateFormattingRule, ac as PropertyDef, a9 as PropertyKeys, aq as PropertyKnownTypeFormattingRule, $ as PropertyMarkings, aL as PropertyNumberFormattingRule, aM as PropertyNumberFormattingRuleType, a0 as PropertySecurity, ao as PropertyTimestampFormattingRule, aP as PropertyTypeReference, aQ as PropertyTypeReferenceOrStringConstant, aO as PropertyValueFormattingRule, a2 as Result, T as SelectArg, U as SelectArgToKeys, ae as SimplePropertyDef, S as SingleLinkAccessor, Y as SingleOsdkResult, aR as StringConstant, aN as TimeCodeFormat, a$ as TimeSeriesPoint, b0 as TimeSeriesProperty, b1 as TimeSeriesQuery, aZ as TimeseriesDurationMapping, V as ValidAggregationKeys, ad as VersionBound, W as WhereClause, aT as WirePropertyTypes, a1 as isOk } from './ObjectSet-DlNhU1QE.cjs';
+import { A as AttachmentUpload, M as MediaReference, a as MediaUpload, b as Attachment, O as ObjectTypeDefinition, c as ObjectIdentifiers, d as OsdkObjectPrimaryKeyType, e as ObjectSet, I as InterfaceDefinition, C as CompileTimeMetadata, f as OsdkMetadata, R as ReleaseStatus, g as ObjectOrInterfaceDefinition, P as PropertyValueWireToClient, h as PrimaryKeyTypes, i as OsdkBase } from './ObjectSet-CqVqDXKn.cjs';
+export { ar as Affix, j as AggregateOpts, k as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, n as AggregationClause, l as AggregationResultsWithGroups, m as AggregationResultsWithoutGroups, o as AggregationsResults, z as AllGroupByValues, p as AndWhereClause, F as AsyncIterArgs, H as Augment, J as Augments, a3 as BaseObjectSet, aS as BaseWirePropertyTypes, aV as ConvertProps, ag as DatetimeFormat, ah as DatetimeLocalizedFormat, ai as DatetimeLocalizedFormatType, aj as DatetimeStringFormat, ak as DatetimeTimezone, al as DatetimeTimezoneStatic, am as DatetimeTimezoneUser, x as DerivedProperty, D as DistanceUnitMapping, as as DurationBaseValue, at as DurationFormatStyle, y as DurationMapping, au as DurationPrecision, a4 as FetchLinksPageResult, K as FetchPageArgs, X as FetchPageResult, G as GeoFilterOptions, q as GeoFilter_Intersects, r as GeoFilter_Within, a_ as GeotimeSeriesProperty, B as GroupByClause, E as GroupByRange, av as HumanReadableFormat, a8 as InterfaceMetadata, ap as KnownType, b3 as LinkNames, a5 as LinkTypeApiNamesFor, b2 as LinkedType, aW as MaybeScore, Z as Media, _ as MediaMetadata, a6 as MinimalDirectedObjectLinkInstance, N as NotWhereClause, L as NullabilityAdherence, aw as NumberFormatAffix, ax as NumberFormatCurrency, ay as NumberFormatCurrencyStyle, az as NumberFormatCustomUnit, aA as NumberFormatDuration, aB as NumberFormatFixedValues, aC as NumberFormatNotation, aD as NumberFormatOptions, aE as NumberFormatRatio, aF as NumberFormatScale, aG as NumberFormatStandard, aH as NumberFormatStandardUnit, aI as NumberRatioType, aJ as NumberRoundingMode, aK as NumberScaleType, ab as ObjectMetadata, Q as ObjectSetArgs, a7 as ObjectSetSubscription, aa as ObjectSpecifier, s as OrWhereClause, aX as Osdk, u as OsdkObjectCreatePropertyType, w as OsdkObjectLinksObject, v as OsdkObjectPropertyType, aY as PageResult, t as PossibleWhereClauseFilters, aU as PrimaryKeyType, af as PropertyBooleanFormattingRule, an as PropertyDateFormattingRule, ac as PropertyDef, a9 as PropertyKeys, aq as PropertyKnownTypeFormattingRule, $ as PropertyMarkings, aL as PropertyNumberFormattingRule, aM as PropertyNumberFormattingRuleType, a0 as PropertySecurity, ao as PropertyTimestampFormattingRule, aP as PropertyTypeReference, aQ as PropertyTypeReferenceOrStringConstant, aO as PropertyValueFormattingRule, a2 as Result, T as SelectArg, U as SelectArgToKeys, ae as SimplePropertyDef, S as SingleLinkAccessor, Y as SingleOsdkResult, aR as StringConstant, aN as TimeCodeFormat, a$ as TimeSeriesPoint, b0 as TimeSeriesProperty, b1 as TimeSeriesQuery, aZ as TimeseriesDurationMapping, V as ValidAggregationKeys, ad as VersionBound, W as WhereClause, aT as WirePropertyTypes, a1 as isOk } from './ObjectSet-CqVqDXKn.cjs';
 import 'type-fest';
 import 'geojson';
 

package/build/cjs/public/unstable.d.cts

@@ -1,5 +1,5 @@
-import { g as ObjectOrInterfaceDefinition, a9 as PropertyKeys, M as MediaReference, L as NullabilityAdherence, T as SelectArg, aX as Osdk, b4 as ExtractOptions, K as FetchPageArgs, X as FetchPageResult, i as OsdkBase } from '../ObjectSet-DlNhU1QE.cjs';
-export { b5 as MinimalObjectSet } from '../ObjectSet-DlNhU1QE.cjs';
+import { g as ObjectOrInterfaceDefinition, a9 as PropertyKeys, M as MediaReference, L as NullabilityAdherence, T as SelectArg, aX as Osdk, b4 as ExtractOptions, K as FetchPageArgs, X as FetchPageResult, i as OsdkBase } from '../ObjectSet-CqVqDXKn.cjs';
+export { b5 as MinimalObjectSet } from '../ObjectSet-CqVqDXKn.cjs';
 import 'type-fest';
 import 'geojson';
 

package/build/esm/aggregate/WhereClause.js

@@ -39,5 +39,5 @@ export const DistanceUnitMapping = {
   "nautical miles": "NAUTICAL_MILES"
 };
 
-// FIXME we need to represent all types
+// Fallback for unknown types
 //# sourceMappingURL=WhereClause.js.map

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  DerivedObjectOrInterfaceDefinition,\n  ObjectOrInterfaceDefinition,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.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 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]?: FilterFor<{ \"type\": ST[K] }>;\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 type AndWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $and: WhereClause<T, RDPs>[];\n};\n\nexport type OrWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $or: WhereClause<T, RDPs>[];\n};\n\nexport type NotWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $not: WhereClause<T, RDPs>;\n};\n\nexport type PropertyWhereClause<T extends ObjectOrInterfaceDefinition> = {\n  [P in keyof CompileTimeMetadata<T>[\"properties\"]]?: FilterFor<\n    CompileTimeMetadata<T>[\"properties\"][P]\n  >;\n};\n\ntype MergedPropertyWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = PropertyWhereClause<\n  DerivedObjectOrInterfaceDefinition.WithDerivedProperties<T, RDPs>\n>;\n\nexport type WhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> =\n  | OrWhereClause<T, RDPs>\n  | AndWhereClause<T, RDPs>\n  | NotWhereClause<T, RDPs>\n  | (IsNever<keyof CompileTimeMetadata<T>[\"properties\"]> extends true\n    ? Record<string, never>\n    : MergedPropertyWhereClause<T, RDPs>);\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwCA;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":[]}
+{"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  DerivedObjectOrInterfaceDefinition,\n  ObjectOrInterfaceDefinition,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.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 BaseFilterFor<T> = T extends Record<string, BaseWirePropertyTypes>\n  ? StructFilterOpts<T>\n  : T extends \"string\" ? StringFilter\n  : T extends \"geopoint\" | \"geoshape\" ? GeoFilter\n  : T extends \"datetime\" | \"timestamp\" ? DatetimeFilter\n  : T extends \"boolean\" ? BooleanFilter\n  : T extends WhereClauseNumberPropertyTypes ? NumberFilter\n  : BaseFilter<string>; // Fallback for unknown types\n\ntype FilterFor<PD extends ObjectMetadata.Property> = PD[\"multiplicity\"] extends\n  true ? ArrayFilter<BaseFilterFor<PD[\"type\"]>>\n  : PD[\"type\"] extends Record<string, BaseWirePropertyTypes>\n    ? StructFilter<PD[\"type\"]> | BaseFilter.$isNull<string>\n  : BaseFilterFor<PD[\"type\"]>;\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 WhereClauseNumberPropertyTypes =\n  | \"double\"\n  | \"integer\"\n  | \"long\"\n  | \"float\"\n  | \"decimal\"\n  | \"byte\";\n\nexport type AndWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $and: WhereClause<T, RDPs>[];\n};\n\nexport type OrWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $or: WhereClause<T, RDPs>[];\n};\n\nexport type NotWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = {\n  $not: WhereClause<T, RDPs>;\n};\n\nexport type PropertyWhereClause<T extends ObjectOrInterfaceDefinition> = {\n  [P in keyof CompileTimeMetadata<T>[\"properties\"]]?: FilterFor<\n    CompileTimeMetadata<T>[\"properties\"][P]\n  >;\n};\n\ntype MergedPropertyWhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = PropertyWhereClause<\n  DerivedObjectOrInterfaceDefinition.WithDerivedProperties<T, RDPs>\n>;\n\nexport type WhereClause<\n  T extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> =\n  | OrWhereClause<T, RDPs>\n  | AndWhereClause<T, RDPs>\n  | NotWhereClause<T, RDPs>\n  | (IsNever<keyof CompileTimeMetadata<T>[\"properties\"]> extends true\n    ? Record<string, never>\n    : MergedPropertyWhereClause<T, RDPs>);\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwCA;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;;AA+CuB","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 { 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 {\n  LinkTypeApiNamesFor,\n  MinimalDirectedObjectLinkInstance,\n} from \"./ObjectSetLinks.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, 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  AsyncIterLinks<Q>\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    args?: FetchPageArgs<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): Promise<\n    PageResult<\n      MaybeScore<\n        Osdk.Instance<\n          Q,\n          ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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  PROPERTY_SECURITIES extends boolean = false,\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<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): Promise<\n    Result<\n      PageResult<\n        MaybeScore<\n          Osdk.Instance<\n            Q,\n            ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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  PROPERTY_SECURITIES extends boolean = false,\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<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): AsyncIterableIterator<\n    MaybeScore<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>,\n  ): Promise<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S, false, PROPERTY_SECURITIES>,\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>,\n  ): Promise<\n    Result<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, false, PROPERTY_SECURITIES>,\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 NarrowToType<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 narrowToType: <\n    CONVERT_TO extends RestrictToImplementingObjectTypes<Q>,\n  >(\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 extends string> }\n    ? (ObjectTypeDefinition & { apiName: API_NAME }) | InterfaceDefinition\n    : InterfaceDefinition;\n\ninterface AsyncIterLinks<Q extends ObjectOrInterfaceDefinition> {\n  /**\n   * Batch load links on an object set. This is an experimental method that may change while in beta.\n   * Use this method in conjunction with `.asyncIter()` and `.pivotTo(...).asyncIter()` to build an\n   * object graph in memory.\n   *\n   * Please keep these limitations in mind:\n   * - Links returned may be stale. For example, primary keys returned by this endpoint may not exist anymore.\n   * - The backend API fetches pages of *n* objects at a time. If, for any page of *n* objects, there are more\n   *   than 100,000 links present, results are limited to 100,000 links and should be considered partial.\n   * - This method does not support OSv1 links and will throw an exception if links provided are backed by OSv1.\n   * - This method currently does not support interface links, but support will be added in the near future.\n   */\n  readonly experimental_asyncIterLinks: <\n    LINK_TYPE_API_NAME extends LinkTypeApiNamesFor<Q>,\n  >(\n    links: LINK_TYPE_API_NAME[],\n  ) => AsyncIterableIterator<\n    MinimalDirectedObjectLinkInstance<Q, LINK_TYPE_API_NAME>\n  >;\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  NarrowToType<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 {\n  LinkTypeApiNamesFor,\n  MinimalDirectedObjectLinkInstance,\n} from \"./ObjectSetLinks.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, 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  AsyncIterLinks<Q>\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    args?: FetchPageArgs<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): Promise<\n    PageResult<\n      MaybeScore<\n        Osdk.Instance<\n          Q,\n          ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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  PROPERTY_SECURITIES extends boolean = false,\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<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): Promise<\n    Result<\n      PageResult<\n        MaybeScore<\n          Osdk.Instance<\n            Q,\n            ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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  PROPERTY_SECURITIES extends boolean = false,\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<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >,\n  ): AsyncIterableIterator<\n    MaybeScore<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, T, PROPERTY_SECURITIES>,\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>,\n  ): Promise<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S, false, PROPERTY_SECURITIES>,\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    PROPERTY_SECURITIES extends boolean = false,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>,\n  ): Promise<\n    Result<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, false, PROPERTY_SECURITIES>,\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    const R extends boolean = false,\n  >(\n    listener: ObjectSetSubscription.Listener<Q, P, R>,\n    opts?: ObjectSetSubscription.Options<Q, P, R>,\n  ) => { unsubscribe: () => void };\n}\n\ninterface NarrowToType<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 narrowToType: <\n    CONVERT_TO extends RestrictToImplementingObjectTypes<Q>,\n  >(\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 extends string> }\n    ? (ObjectTypeDefinition & { apiName: API_NAME }) | InterfaceDefinition\n    : InterfaceDefinition;\n\ninterface AsyncIterLinks<Q extends ObjectOrInterfaceDefinition> {\n  /**\n   * Batch load links on an object set. This is an experimental method that may change while in beta.\n   * Use this method in conjunction with `.asyncIter()` and `.pivotTo(...).asyncIter()` to build an\n   * object graph in memory.\n   *\n   * Please keep these limitations in mind:\n   * - Links returned may be stale. For example, primary keys returned by this endpoint may not exist anymore.\n   * - The backend API fetches pages of *n* objects at a time. If, for any page of *n* objects, there are more\n   *   than 100,000 links present, results are limited to 100,000 links and should be considered partial.\n   * - This method does not support OSv1 links and will throw an exception if links provided are backed by OSv1.\n   * - This method currently does not support interface links, but support will be added in the near future.\n   */\n  readonly experimental_asyncIterLinks: <\n    LINK_TYPE_API_NAME extends LinkTypeApiNamesFor<Q>,\n  >(\n    links: LINK_TYPE_API_NAME[],\n  ) => AsyncIterableIterator<\n    MinimalDirectedObjectLinkInstance<Q, LINK_TYPE_API_NAME>\n  >;\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  NarrowToType<Q>\n{\n}\n"],"mappings":"","ignoreList":[]}

package/build/esm/objectSet/ObjectSetListener.js.map

@@ -1 +1 @@
-{"version":3,"file":"ObjectSetListener.js","names":["ObjectSetSubscription"],"sources":["ObjectSetListener.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 {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { Osdk } from \"../OsdkObjectFrom.js\";\n\nexport namespace ObjectSetSubscription {\n  export interface Listener<\n    O extends ObjectOrInterfaceDefinition,\n    P extends PropertyKeys<O> = PropertyKeys<O>,\n  > {\n    /**\n     * Specific objects have changed and can be immediately updated\n     */\n    onChange?: (\n      objectUpdate: ObjectUpdate<O, P>,\n    ) => void;\n\n    /**\n     * The subscription has been successfully established and updates can be expected to be received.\n     */\n    onSuccessfulSubscription?: () => void;\n\n    /**\n     * The ObjectSet has become outdated and should be re-fetched in its entirety.\n     * This is also sent when the subscription is first initialized.\n     */\n    onOutOfDate?: () => void;\n\n    /**\n     * There was a fatal error with the subscription process. The subscription will close or will not be established.\n     */\n    onError?: (errors: { subscriptionClosed: boolean; error: any }) => void;\n  }\n\n  /**\n   * Options for subscribing to an ObjectSet.\n   *\n   * properties - The properties to request a subscription for. Requesting specific properties limits the possible properties\n   * that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.\n   */\n  export interface Options<\n    O extends ObjectOrInterfaceDefinition,\n    P extends PropertyKeys<O> = PropertyKeys<O>,\n  > {\n    properties?: Array<P>;\n  }\n}\n\ntype ObjectUpdate<\n  O extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<O>,\n> = {\n  object: Osdk.Instance<O, never, P>;\n  state: \"ADDED_OR_UPDATED\" | \"REMOVED\";\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WAsBiBA,qBAAqB","ignoreList":[]}
+{"version":3,"file":"ObjectSetListener.js","names":["ObjectSetSubscription"],"sources":["ObjectSetListener.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 {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { WirePropertyTypes } from \"../ontology/WirePropertyTypes.js\";\nimport type { Osdk } from \"../OsdkObjectFrom.js\";\n\nexport namespace ObjectSetSubscription {\n  export interface Listener<\n    O extends ObjectOrInterfaceDefinition,\n    P extends PropertyKeys<O> = PropertyKeys<O>,\n    R extends boolean = false,\n  > {\n    /**\n     * Specific objects have changed and can be immediately updated\n     */\n    onChange?: (\n      objectUpdate: ObjectUpdate<O, P, R>,\n    ) => void;\n\n    /**\n     * The subscription has been successfully established and updates can be expected to be received.\n     */\n    onSuccessfulSubscription?: () => void;\n\n    /**\n     * The ObjectSet has become outdated and should be re-fetched in its entirety.\n     * This is also sent when the subscription is first initialized.\n     */\n    onOutOfDate?: () => void;\n\n    /**\n     * There was a fatal error with the subscription process. The subscription will close or will not be established.\n     */\n    onError?: (errors: { subscriptionClosed: boolean; error: any }) => void;\n  }\n\n  /**\n   * Options for subscribing to an ObjectSet.\n   *\n   * @param properties The properties to request a subscription for. Requesting specific properties limits the possible properties\n   * that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.\n   *\n   * @param includeRid Whether to include the $rid property in the subscription. Defaults to false. RIDs will be returned on all updates unless the update\n   * contains a new value for a geotime series reference property, in which case the RID will be undefined.\n   */\n  export interface Options<\n    O extends ObjectOrInterfaceDefinition,\n    P extends PropertyKeys<O> = PropertyKeys<O>,\n    R extends boolean = false,\n  > {\n    /**\n     * The properties to request a subscription for. Requesting specific properties limits the possible properties\n     * that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.\n     */\n    properties?: Array<P>;\n\n    /**\n     * Whether to include the $rid property in the subscription. Defaults to false. RIDs will be returned on all updates unless the update\n     * contains a new value for a geotime series reference property, in which case the RID will be undefined. RIDs will not be included\n     * on the objects themselves.\n     */\n    includeRid?: AllFalse<\n      PropertyTypesOnDefMatchesType<O, P, \"geotimeSeriesReference\">\n    > extends true ? R\n      : false;\n  }\n}\n\ntype ObjectUpdate<\n  O extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<O>,\n  R extends boolean = false,\n> = {\n  object: R extends false ? Osdk.Instance<O, never, P>\n    : Osdk.Instance<O, \"$rid\", P>;\n  state: \"ADDED_OR_UPDATED\" | \"REMOVED\";\n};\n\ntype PropertyTypesOnDefMatchesType<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<Q>,\n  T extends WirePropertyTypes,\n> = {\n  [K in P]: CompileTimeMetadata<Q>[\"properties\"][K][\n    \"type\"\n  ] extends T ? true\n    : false;\n};\n\ntype AllFalse<T extends Record<string, boolean>> =\n  Exclude<T[keyof T], false> extends never ? true : false;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WAwBiBA,qBAAqB","ignoreList":[]}

package/build/types/aggregate/WhereClause.d.ts

@@ -62,15 +62,12 @@ export type GeoFilter_Intersects = {
 		$bbox?: never
 	} | Polygon
 };
-type FilterFor<PD extends ObjectMetadata.Property> = PD["multiplicity"] extends true ? (PD["type"] extends Record<string, BaseWirePropertyTypes> ? ArrayFilter<StructArrayFilterOpts<PD["type"]>> : PD["type"] extends PropertyTypesRepresentedAsStringsForArrayWhereClause ? ArrayFilter<string> : (PD["type"] extends boolean ? ArrayFilter<boolean> : ArrayFilter<number>)) : PD["type"] extends Record<string, BaseWirePropertyTypes> ? StructFilter<PD["type"]> | BaseFilter.$isNull<string> : (PD["type"] extends "string" ? StringFilter : PD["type"] extends "geopoint" | "geoshape" ? GeoFilter : PD["type"] extends "datetime" | "timestamp" ? DatetimeFilter : PD["type"] extends "boolean" ? BooleanFilter : PD["type"] extends WhereClauseNumberPropertyTypes ? NumberFilter : BaseFilter<string>);
-type StructArrayFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = { [K in keyof ST]? : FilterFor<{
-	"type": ST[K]
-}> };
+type BaseFilterFor<T> = T extends Record<string, BaseWirePropertyTypes> ? StructFilterOpts<T> : T extends "string" ? StringFilter : T extends "geopoint" | "geoshape" ? GeoFilter : T extends "datetime" | "timestamp" ? DatetimeFilter : T extends "boolean" ? BooleanFilter : T extends WhereClauseNumberPropertyTypes ? NumberFilter : BaseFilter<string>;
+type FilterFor<PD extends ObjectMetadata.Property> = PD["multiplicity"] extends true ? ArrayFilter<BaseFilterFor<PD["type"]>> : PD["type"] extends Record<string, BaseWirePropertyTypes> ? StructFilter<PD["type"]> | BaseFilter.$isNull<string> : BaseFilterFor<PD["type"]>;
 type StructFilterOpts<ST extends Record<string, BaseWirePropertyTypes>> = { [K in keyof ST]? : FilterFor<{
 	"type": ST[K]
 }> };
 type StructFilter<ST extends Record<string, BaseWirePropertyTypes>> = { [K in keyof ST] : Just<K, StructFilterOpts<ST>> }[keyof ST];
-type PropertyTypesRepresentedAsStringsForArrayWhereClause = "string" | "geopoint" | "geoshape" | "datetime" | "timestamp";
 type WhereClauseNumberPropertyTypes = "double" | "integer" | "long" | "float" | "decimal" | "byte";
 export type AndWhereClause<
 	T extends ObjectOrInterfaceDefinition,

package/build/types/aggregate/WhereClause.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,MAAM,OAAO,eAAe,SAAU;AACpD,cACE,oCACA,mCACK,kCAAmC;AAC1C,cACE,qBACA,sBACK,qCAAsC;AAC7C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,6BAA6B,kCAAmC;AAC9E,cAAc,eAAe,sBAAuB;AACpD,cAAc,mBAAmB,kBAAmB;AACpD,cAAc,kBAAkB,iBAAkB;AAClD,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,sBAAsB,qBAAsB;AAC1D,cAAc,iBAAiB,gBAAiB;AAChD,cAAc,YAAY,WAAY;AACtC,cAAc,oBAAoB,mBAAoB;AACtD,cAAc,oBAAoB,mBAAoB;AAEtD,YAAY,6BACR,QACA,QACA,QACA,YACA,cACA,SACA,QACA,SACA,YACA,QACA,gBACA,gBACA,6BACA,qBACA;AAIJ,OAAO,cAAMA,qBAAqB;CAChC,YAAY;CACZ,aAAa;CACb,IAAI;CACJ,OAAO;CACP,QAAQ;CACR,GAAG;CACH,WAAW;CACX,YAAY;CACZ,IAAI;CACJ,MAAM;CACN,QAAQ;CACR,MAAM;CACN,MAAM;CACN,MAAM;CACN,OAAO;CACP,MAAM;CACN,OAAO;CACP,eAAe;CACf,cAAc;CACd,kBAAkB;AACnB;AAiCD,YAAY,mBAAmB;CAC7B,WACI;EACA,iCAAiC;EACjC,wBAAwB,SAAS;EACjC;EACA;CACD,IACC;EACA,OAAO;EACP;EACA;EACA;CACD,IACC,OACA;EACA,UAAU,QAAQ;EAClB;EACA;EACA;CACD,IACC;AACL;AAED,YAAY,uBAAuB;CACjC,eACI;EACA,OAAO;EACP;CACD,IACC,OACA;EACA,UAAU,QAAQ;EAClB;CACD,IACC;AACL;KAEI,UAAU,WAAW,eAAe,YAAY,GAAG,wBACtD,QACG,GAAG,gBAAgB,eAAe,yBACjC,YAAY,sBAAsB,GAAG,YACrC,GAAG,gBAAgB,uDACjB,uBACD,GAAG,0BAA0B,uBAC5B,wBACJ,GAAG,gBAAgB,eAAe,yBAC9B,aAAa,GAAG,WAChB,WAAW,mBACd,GAAG,gBAAgB,WAAW,eAC7B,GAAG,gBAAgB,aAAa,aAAa,YAC7C,GAAG,gBAAgB,aAAa,cAAc,iBAC9C,GAAG,gBAAgB,YAAY,gBAC/B,GAAG,gBAAgB,iCAAiC,eACpD;KAED,sBAAsB,WAAW,eAAe,6BAClD,WAAW,OAAM,UAAU;CAAE,QAAQ,GAAG;AAAI;KAG1C,iBAAiB,WAAW,eAAe,6BAC7C,WAAW,OAAM,UAAU;CAAE,QAAQ,GAAG;AAAI;KAE1C,aAAa,WAAW,eAAe,6BACzC,WAAW,MAAK,KAAK,GAAG,iBAAiB,aACpC;KAEH,uDACD,WACA,aACA,aACA,aACA;KACC,iCACD,WACA,YACA,SACA,UACA,YACA;AAEJ,YAAY;CACV,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IACjD;CACF,MAAM,YAAY,GAAG;AACtB;AAED,YAAY;CACV,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IACjD;CACF,KAAK,YAAY,GAAG;AACrB;AAED,YAAY;CACV,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IACjD;CACF,MAAM,YAAY,GAAG;AACtB;AAED,YAAY,oBAAoB,UAAU,kCACvC,WAAW,oBAAoB,GAAG,kBAAiB,UAClD,oBAAoB,GAAG,cAAc;KAIpC;CACH,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IACjD,oBACF,mCAAmC,sBAAsB,GAAG;AAG9D,YAAY;CACV,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IAEjD,cAAc,GAAG,QACjB,eAAe,GAAG,QAClB,eAAe,GAAG,SACjB,cAAc,oBAAoB,GAAG,uBAAuB,OAC3D,wBACA,0BAA0B,GAAG","names":["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}"],"sources":["../../../src/aggregate/WhereClause.ts"],"version":3,"file":"WhereClause.d.ts"}
+{"mappings":"AAgBA,cAAc,MAAM,OAAO,eAAe,SAAU;AACpD,cACE,oCACA,mCACK,kCAAmC;AAC1C,cACE,qBACA,sBACK,qCAAsC;AAC7C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,6BAA6B,kCAAmC;AAC9E,cAAc,eAAe,sBAAuB;AACpD,cAAc,mBAAmB,kBAAmB;AACpD,cAAc,kBAAkB,iBAAkB;AAClD,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,sBAAsB,qBAAsB;AAC1D,cAAc,iBAAiB,gBAAiB;AAChD,cAAc,YAAY,WAAY;AACtC,cAAc,oBAAoB,mBAAoB;AACtD,cAAc,oBAAoB,mBAAoB;AAEtD,YAAY,6BACR,QACA,QACA,QACA,YACA,cACA,SACA,QACA,SACA,YACA,QACA,gBACA,gBACA,6BACA,qBACA;AAIJ,OAAO,cAAMA,qBAAqB;CAChC,YAAY;CACZ,aAAa;CACb,IAAI;CACJ,OAAO;CACP,QAAQ;CACR,GAAG;CACH,WAAW;CACX,YAAY;CACZ,IAAI;CACJ,MAAM;CACN,QAAQ;CACR,MAAM;CACN,MAAM;CACN,MAAM;CACN,OAAO;CACP,MAAM;CACN,OAAO;CACP,eAAe;CACf,cAAc;CACd,kBAAkB;AACnB;AAiCD,YAAY,mBAAmB;CAC7B,WACI;EACA,iCAAiC;EACjC,wBAAwB,SAAS;EACjC;EACA;CACD,IACC;EACA,OAAO;EACP;EACA;EACA;CACD,IACC,OACA;EACA,UAAU,QAAQ;EAClB;EACA;EACA;CACD,IACC;AACL;AAED,YAAY,uBAAuB;CACjC,eACI;EACA,OAAO;EACP;CACD,IACC,OACA;EACA,UAAU,QAAQ;EAClB;CACD,IACC;AACL;KAEI,cAAc,KAAK,UAAU,eAAe,yBAC7C,iBAAiB,KACjB,UAAU,WAAW,eACrB,UAAU,aAAa,aAAa,YACpC,UAAU,aAAa,cAAc,iBACrC,UAAU,YAAY,gBACtB,UAAU,iCAAiC,eAC3C;KAEC,UAAU,WAAW,eAAe,YAAY,GAAG,wBACtD,OAAO,YAAY,cAAc,GAAG,YAClC,GAAG,gBAAgB,eAAe,yBAChC,aAAa,GAAG,WAAW,WAAW,kBACxC,cAAc,GAAG;KAEhB,iBAAiB,WAAW,eAAe,6BAC7C,WAAW,OAAM,UAAU;CAAE,QAAQ,GAAG;AAAI;KAE1C,aAAa,WAAW,eAAe,6BACzC,WAAW,MAAK,KAAK,GAAG,iBAAiB,aACpC;KAEH,iCACD,WACA,YACA,SACA,UACA,YACA;AAEJ,YAAY;CACV,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IACjD;CACF,MAAM,YAAY,GAAG;AACtB;AAED,YAAY;CACV,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IACjD;CACF,KAAK,YAAY,GAAG;AACrB;AAED,YAAY;CACV,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IACjD;CACF,MAAM,YAAY,GAAG;AACtB;AAED,YAAY,oBAAoB,UAAU,kCACvC,WAAW,oBAAoB,GAAG,kBAAiB,UAClD,oBAAoB,GAAG,cAAc;KAIpC;CACH,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IACjD,oBACF,mCAAmC,sBAAsB,GAAG;AAG9D,YAAY;CACV,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IAEjD,cAAc,GAAG,QACjB,eAAe,GAAG,QAClB,eAAe,GAAG,SACjB,cAAc,oBAAoB,GAAG,uBAAuB,OAC3D,wBACA,0BAA0B,GAAG","names":["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}"],"sources":["../../../src/aggregate/WhereClause.ts"],"version":3,"file":"WhereClause.d.ts"}

package/build/types/objectSet/ObjectSet.d.ts

@@ -311,7 +311,10 @@ interface Subscribe<Q extends ObjectOrInterfaceDefinition> {
 	* @param opts - Options to modify what properties are returned on subscription updates.
 	* @returns an object containing a function to unsubscribe.
 	*/
-	readonly subscribe: <const P extends PropertyKeys<Q>>(listener: ObjectSetSubscription.Listener<Q, P>, opts?: ObjectSetSubscription.Options<Q, P>) => {
+	readonly subscribe: <
+		const P extends PropertyKeys<Q>,
+		const R extends boolean = false
+	>(listener: ObjectSetSubscription.Listener<Q, P, R>, opts?: ObjectSetSubscription.Options<Q, P, R>) => {
 		unsubscribe: () => void
 	};
 }

package/build/types/objectSet/ObjectSet.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,qBAAqB,+BAAgC;AACnE,cAAc,sEAAsE,yCAA0C;AAC9H,cAAc,2BAA2B,qCAAsC;AAC/E,cAAc,mBAAmB,6BAA8B;AAC/D,cAAc,uBAAuB,yCAA0C;AAC/E,cACE,eACA,UACA,eACA,sBACA,eACA,iBACK,4BAA6B;AACpC,cAAc,cAAc,qBAAsB;AAClD,cAAc,2BAA2B,oCAAqC;AAC9E,cACE,oCACA,6BACA,oBACK,kCAAmC;AAC1C,cACE,qBACA,4BACK,qCAAsC;AAC7C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,sBAAsB,gBAAiB;AACrD,cACE,4BACA,gBACA,kBACA,YACA,YACK,sBAAuB;AAC9B,cAAc,kBAAkB,kBAAmB;AACnD,cAAc,YAAY,iBAAiB,sBAAuB;AAClE,cAAc,qBAAqB,oBAAqB;AACxD,cACE,qBACA,yCACK,qBAAsB;AAC7B,cAAc,6BAA6B,wBAAyB;KAE/D;CACH,UAAU;CACV,UAAU,eAAe,qBAAqB,CAAE;IAC9C,mCAAmC,sBAAsB,GAAG;KAE3D,WACH,UACI,qBACA,eAAe,uBAChB,qBAAqB,CAAE,IACxB,UAAU,qBAAqB,CAAE,IACjC,UAAU,eAAe,qBAAqB,IAC9C,CAAE;KAOD;CACH,UAAU;CACV;KACG,qBAAqB,aAAa,KACnC,aAAa,WAAW,IAAI,aAAa,KACzC,IAAI,aAAa;KAEhB;CACH,UAAU;CACV,UAAU,UAAU,GAAG,aAAa;IAClC,oBAAoB,GAAG,eAAe;KAErC,KAAK,KAAK,WAAW,GAAG,sBAAsB,IAC/C,wBAAuB,GAAG,sBAAsB,OAC7C,WAAW,KAAI,EAAE;KAEnB;CACH,UAAU,oCAAoC;CAC9C;KACG,qBAAqB,WACrB,EAAE,iCAAiC;KAEnC;CACH,aAAa,eAAe;CAC5B,UAAU,wBAAwB,aAAa,wBAAwB;KACpE,gCACD,QAAQ,KAAK,oBAAoB,kBAAkB,SAAQ,KAAK;AAEpE,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;UAE3E,cAAc,IACd,UAAU,GAAG,OACb,UAAU,GAAG,MAAM,mBACnB,MAAM,GAAG,OACT,eAAe,GACjB,CACC;AAED,YAAY,gBACV,UAAU,qDACP,6BAEC,iBAAiB,EAAE,uBAAuB,OAAO,OAAO,SACxD,2BACA,EAAE,2CAA2C,OAAO,OAAO;KAG5D,eAAe,UAAU,2BAA2B,YACvD,EAAE;UAGM;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,WAAW,mBAAmB,GAAG;UACjC,qBAAqB,6BAA6B,GAAG;AAC/D;KAEI;CACH,UAAU;CACV,aAAa,eAAe;CAC5B,yBAAyB,cAAc,eAAe,aAAa;IACjE,cAAc,UAChB,GACA,aAAa,4BAEE,MACf;KAGG;CACH,UAAU;CACV,aAAa,eAAe;IAE1B,cAAc,UACd,GACA,aAAa,IACb,sBACe,QAEf,cACA,yBAKA,qBACe;UAGT;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;EAcE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;EAC7D,sCAAsC;GAEtCA,OAAO,cACL,GACA,GACA,GACA,GACA,GACA,UAEA,kBACA,uBAED,QACD,WACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,GAAG,sBACxB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAIP;UAES,iBAAiB,UAAU,6BAA6B;;;;;;;;;;;;;UAcvD,mBACPC,0BACAC,sBACAC,UAAU,aAAa,SAAS,GAAG;AAEtC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,sCAAsC;EACtC;;;;;;;;;;;;;;;;EAgBE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;GAE7DH,OAAO,cACL,GACA,GACA,GACA,GACA,GACA,UAEA,kBACA,uBAED,QACD,OACE,WACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,GAAG,sBACxB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAKT;UAGS;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;UAWS,QACPI,QAAQ,YAAY,eAAe,GAAG;AAEzC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;CAC3E,sCAAsC;EACtC;;;;;;;;;EASC,UAAU,mBAAmB,GAAG,eAC/BC,OAAO,IACN,sBACD,KAAK,SACH,GACA,gBAAgB,IAChB,cAAc,GAAG,IACjB,cAAc,MAAM;;;;;;;;;;EAatB,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;GAE3EC,OAAO,cACL,GACA,GACA,GACA,GACA,GACA,UAEA,kBACA,uBAED,sBACD,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,GAAG,sBACxB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAGL;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;EAC3E;CACA,WAAW,mBAAmB,GAAG,MAAM;AACxC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,iBACP,YAAY,eAAe,oBAE3BC,WAAW,WAAW,OAAM,gBAAgB,QAAQ,GAAG,IAAI,UACxD,UACH,MAEG,YAAY,YAAY,QAAO,iBAAiB,MAAM,IAAI,MACvD,iBAAiB,OAAO,KAAK;AAItC;AAED,iBAAiB;CACf,UAAU;CAGV,sBACI,cAAc,KACd,eAAe;UAEnB,sBACE,GACA,WAAW,gBACX,eAAe,GAAG,WAAW,iBAEjC,CACC;UAGS,UACR,UAAU,6BACV;;;;;;;;;;;;;;;;;;;;;;;;UAwBS,YAAY,WAAW,cAAc,IAC5CC,KAAK,+DAA+D,GAAG,QACpE,QAAQ,oBAAoB,GAAG;AACrC;UAGS,cACR,UAAU,6BACV;;;;;;;;;;UAUS,QACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,YACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,WACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;AAEvD;UAGS,QACR,UAAU,6BACV;;;;;;UAMS,UAAU,UAAU,UAAU,IACrCC,MAAM,MACH,UAAU,WAAW,GAAG;AAC9B;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;EACvD,sCAAsC;GAEtCC,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,UAAU,uBACtC,QACD,KAAK,SACH,GACA,eAAe,GAAG,GAAG,OAAO,sBAC5B,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAG9C;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;EACvD,sCAAsC;GAEtCD,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,UAAU,uBACtC,QACD,OACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,OAAO,sBAC5B,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAIhD;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;CACA,UAAU,UAAU,uBAAuB,kBAAkB,GAAG;CAChE,oBAAoB,UAAU,uBAC1B,4BAA4B,GAAG;AAEpC;UAGS,UACR,UAAU,6BACV;;;;;;;UAOS,kBACD,UAAU,aAAa,IAE7BC,UAAU,sBAAsB,SAAS,GAAG,IAC5CC,OAAO,sBAAsB,QAAQ,GAAG,OACrC;EAAE;CAAyB;AACjC;UAES,aAAa,UAAU,6BAA6B;;;;;;;;;UASnD,eACP,mBAAmB,kCAAkC,IAErDC,MAAM,eACH,UAAU;AAChB;KAEI,kCAAkC,UAAU,+BAC/C,UAAU,uBAAuB,6BAA6B,KAC1D,UAAU,sBAAsB,yBAAyB;KAG1D,6BAA6B,UAAU,wBAC1C,oBAAoB,WAAW;CAAE,YAAY,oBAAoB;AAAW,IACxE,0BAA0B,sBAAsB;CAAE,SAAS;AAAU;KAItE,yBAAyB,UAAU,uBACtC,oBAAoB,WAClB;CAAE,eAAe,oBAAoB;AAA0B,KAC5D,uBAAuB;CAAE,SAAS;AAAU,KAAI,sBACjD;UAEI,eAAe,UAAU,6BAA6B;;;;;;;;;;;;;UAarD,8BACP,2BAA2B,oBAAoB,IAE/CC,OAAO,yBACJ,sBACH,kCAAkC,GAAG;AAExC;UAES;CACR,UAAU;CACV,UAAU,eAAe;CACzB,eAAe,8BAA8B;CAC7C,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;UAE3E,iBAAiB,GAAG,GAAG,mBACvB,eAAe,GAAG,IAClB,UAAU,SACV,cAAc,SACd,QAAQ,IACR,SAAS,GAAG,IACZ,UAAU,SACV,iBAAiB,IACjB,aAAa,GACf,CACC","names":["args?: FetchPageArgs<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >","query: string | number[]","numNeighbors: number","property: PropertyKeys.Filtered<Q, \"vector\">","clause: WhereClause<MergeObjectSet<Q, RDPs>>","args?: X","args?: AsyncIterArgs<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >","clause: { [K in keyof NEW]: DerivedProperty.Creator<Q, NEW[K]> }","req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>","type: L","primaryKey: PrimaryKeyType<Q>","options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>","listener: ObjectSetSubscription.Listener<Q, P>","opts?: ObjectSetSubscription.Options<Q, P>","type: CONVERT_TO","links: LINK_TYPE_API_NAME[]"],"sources":["../../../src/objectSet/ObjectSet.ts"],"version":3,"file":"ObjectSet.d.ts"}
+{"mappings":"AAgBA,cAAc,qBAAqB,+BAAgC;AACnE,cAAc,sEAAsE,yCAA0C;AAC9H,cAAc,2BAA2B,qCAAsC;AAC/E,cAAc,mBAAmB,6BAA8B;AAC/D,cAAc,uBAAuB,yCAA0C;AAC/E,cACE,eACA,UACA,eACA,sBACA,eACA,iBACK,4BAA6B;AACpC,cAAc,cAAc,qBAAsB;AAClD,cAAc,2BAA2B,oCAAqC;AAC9E,cACE,oCACA,6BACA,oBACK,kCAAmC;AAC1C,cACE,qBACA,4BACK,qCAAsC;AAC7C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,sBAAsB,gBAAiB;AACrD,cACE,4BACA,gBACA,kBACA,YACA,YACK,sBAAuB;AAC9B,cAAc,kBAAkB,kBAAmB;AACnD,cAAc,YAAY,iBAAiB,sBAAuB;AAClE,cAAc,qBAAqB,oBAAqB;AACxD,cACE,qBACA,yCACK,qBAAsB;AAC7B,cAAc,6BAA6B,wBAAyB;KAE/D;CACH,UAAU;CACV,UAAU,eAAe,qBAAqB,CAAE;IAC9C,mCAAmC,sBAAsB,GAAG;KAE3D,WACH,UACI,qBACA,eAAe,uBAChB,qBAAqB,CAAE,IACxB,UAAU,qBAAqB,CAAE,IACjC,UAAU,eAAe,qBAAqB,IAC9C,CAAE;KAOD;CACH,UAAU;CACV;KACG,qBAAqB,aAAa,KACnC,aAAa,WAAW,IAAI,aAAa,KACzC,IAAI,aAAa;KAEhB;CACH,UAAU;CACV,UAAU,UAAU,GAAG,aAAa;IAClC,oBAAoB,GAAG,eAAe;KAErC,KAAK,KAAK,WAAW,GAAG,sBAAsB,IAC/C,wBAAuB,GAAG,sBAAsB,OAC7C,WAAW,KAAI,EAAE;KAEnB;CACH,UAAU,oCAAoC;CAC9C;KACG,qBAAqB,WACrB,EAAE,iCAAiC;KAEnC;CACH,aAAa,eAAe;CAC5B,UAAU,wBAAwB,aAAa,wBAAwB;KACpE,gCACD,QAAQ,KAAK,oBAAoB,kBAAkB,SAAQ,KAAK;AAEpE,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;UAE3E,cAAc,IACd,UAAU,GAAG,OACb,UAAU,GAAG,MAAM,mBACnB,MAAM,GAAG,OACT,eAAe,GACjB,CACC;AAED,YAAY,gBACV,UAAU,qDACP,6BAEC,iBAAiB,EAAE,uBAAuB,OAAO,OAAO,SACxD,2BACA,EAAE,2CAA2C,OAAO,OAAO;KAG5D,eAAe,UAAU,2BAA2B,YACvD,EAAE;UAGM;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,WAAW,mBAAmB,GAAG;UACjC,qBAAqB,6BAA6B,GAAG;AAC/D;KAEI;CACH,UAAU;CACV,aAAa,eAAe;CAC5B,yBAAyB,cAAc,eAAe,aAAa;IACjE,cAAc,UAChB,GACA,aAAa,4BAEE,MACf;KAGG;CACH,UAAU;CACV,aAAa,eAAe;IAE1B,cAAc,UACd,GACA,aAAa,IACb,sBACe,QAEf,cACA,yBAKA,qBACe;UAGT;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;EAcE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;EAC7D,sCAAsC;GAEtCA,OAAO,cACL,GACA,GACA,GACA,GACA,GACA,UAEA,kBACA,uBAED,QACD,WACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,GAAG,sBACxB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAIP;UAES,iBAAiB,UAAU,6BAA6B;;;;;;;;;;;;;UAcvD,mBACPC,0BACAC,sBACAC,UAAU,aAAa,SAAS,GAAG;AAEtC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,sCAAsC;EACtC;;;;;;;;;;;;;;;;EAgBE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;GAE7DH,OAAO,cACL,GACA,GACA,GACA,GACA,GACA,UAEA,kBACA,uBAED,QACD,OACE,WACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,GAAG,sBACxB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAKT;UAGS;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;UAWS,QACPI,QAAQ,YAAY,eAAe,GAAG;AAEzC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;CAC3E,sCAAsC;EACtC;;;;;;;;;EASC,UAAU,mBAAmB,GAAG,eAC/BC,OAAO,IACN,sBACD,KAAK,SACH,GACA,gBAAgB,IAChB,cAAc,GAAG,IACjB,cAAc,MAAM;;;;;;;;;;EAatB,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;GAE3EC,OAAO,cACL,GACA,GACA,GACA,GACA,GACA,UAEA,kBACA,uBAED,sBACD,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,GAAG,sBACxB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAGL;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;EAC3E;CACA,WAAW,mBAAmB,GAAG,MAAM;AACxC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,iBACP,YAAY,eAAe,oBAE3BC,WAAW,WAAW,OAAM,gBAAgB,QAAQ,GAAG,IAAI,UACxD,UACH,MAEG,YAAY,YAAY,QAAO,iBAAiB,MAAM,IAAI,MACvD,iBAAiB,OAAO,KAAK;AAItC;AAED,iBAAiB;CACf,UAAU;CAGV,sBACI,cAAc,KACd,eAAe;UAEnB,sBACE,GACA,WAAW,gBACX,eAAe,GAAG,WAAW,iBAEjC,CACC;UAGS,UACR,UAAU,6BACV;;;;;;;;;;;;;;;;;;;;;;;;UAwBS,YAAY,WAAW,cAAc,IAC5CC,KAAK,+DAA+D,GAAG,QACpE,QAAQ,oBAAoB,GAAG;AACrC;UAGS,cACR,UAAU,6BACV;;;;;;;;;;UAUS,QACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,YACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,WACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;AAEvD;UAGS,QACR,UAAU,6BACV;;;;;;UAMS,UAAU,UAAU,UAAU,IACrCC,MAAM,MACH,UAAU,WAAW,GAAG;AAC9B;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;EACvD,sCAAsC;GAEtCC,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,UAAU,uBACtC,QACD,KAAK,SACH,GACA,eAAe,GAAG,GAAG,OAAO,sBAC5B,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAG9C;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;EACvD,sCAAsC;GAEtCD,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,UAAU,uBACtC,QACD,OACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,OAAO,sBAC5B,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAIhD;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;CACA,UAAU,UAAU,uBAAuB,kBAAkB,GAAG;CAChE,oBAAoB,UAAU,uBAC1B,4BAA4B,GAAG;AAEpC;UAGS,UACR,UAAU,6BACV;;;;;;;UAOS;QACD,UAAU,aAAa;QACvB,oBAAoB;GAE1BC,UAAU,sBAAsB,SAAS,GAAG,GAAG,IAC/CC,OAAO,sBAAsB,QAAQ,GAAG,GAAG,OACxC;EAAE;CAAyB;AACjC;UAES,aAAa,UAAU,6BAA6B;;;;;;;;;UASnD,eACP,mBAAmB,kCAAkC,IAErDC,MAAM,eACH,UAAU;AAChB;KAEI,kCAAkC,UAAU,+BAC/C,UAAU,uBAAuB,6BAA6B,KAC1D,UAAU,sBAAsB,yBAAyB;KAG1D,6BAA6B,UAAU,wBAC1C,oBAAoB,WAAW;CAAE,YAAY,oBAAoB;AAAW,IACxE,0BAA0B,sBAAsB;CAAE,SAAS;AAAU;KAItE,yBAAyB,UAAU,uBACtC,oBAAoB,WAClB;CAAE,eAAe,oBAAoB;AAA0B,KAC5D,uBAAuB;CAAE,SAAS;AAAU,KAAI,sBACjD;UAEI,eAAe,UAAU,6BAA6B;;;;;;;;;;;;;UAarD,8BACP,2BAA2B,oBAAoB,IAE/CC,OAAO,yBACJ,sBACH,kCAAkC,GAAG;AAExC;UAES;CACR,UAAU;CACV,UAAU,eAAe;CACzB,eAAe,8BAA8B;CAC7C,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;UAE3E,iBAAiB,GAAG,GAAG,mBACvB,eAAe,GAAG,IAClB,UAAU,SACV,cAAc,SACd,QAAQ,IACR,SAAS,GAAG,IACZ,UAAU,SACV,iBAAiB,IACjB,aAAa,GACf,CACC","names":["args?: FetchPageArgs<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >","query: string | number[]","numNeighbors: number","property: PropertyKeys.Filtered<Q, \"vector\">","clause: WhereClause<MergeObjectSet<Q, RDPs>>","args?: X","args?: AsyncIterArgs<\n      Q,\n      L,\n      R,\n      A,\n      S,\n      T,\n      never,\n      ORDER_BY_OPTIONS,\n      PROPERTY_SECURITIES\n    >","clause: { [K in keyof NEW]: DerivedProperty.Creator<Q, NEW[K]> }","req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>","type: L","primaryKey: PrimaryKeyType<Q>","options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>","listener: ObjectSetSubscription.Listener<Q, P, R>","opts?: ObjectSetSubscription.Options<Q, P, R>","type: CONVERT_TO","links: LINK_TYPE_API_NAME[]"],"sources":["../../../src/objectSet/ObjectSet.ts"],"version":3,"file":"ObjectSet.d.ts"}

package/build/types/objectSet/ObjectSetListener.d.ts

@@ -1,14 +1,17 @@
 import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
+import type { CompileTimeMetadata } from "../ontology/ObjectTypeDefinition.js";
+import type { WirePropertyTypes } from "../ontology/WirePropertyTypes.js";
 import type { Osdk } from "../OsdkObjectFrom.js";
 export declare namespace ObjectSetSubscription {
 	interface Listener<
 		O extends ObjectOrInterfaceDefinition,
-		P extends PropertyKeys<O> = PropertyKeys<O>
+		P extends PropertyKeys<O> = PropertyKeys<O>,
+		R extends boolean = false
 	> {
 		/**
 		* Specific objects have changed and can be immediately updated
 		*/
-		onChange?: (objectUpdate: ObjectUpdate<O, P>) => void;
+		onChange?: (objectUpdate: ObjectUpdate<O, P, R>) => void;
 		/**
 		* The subscription has been successfully established and updates can be expected to be received.
 		*/
@@ -28,16 +31,34 @@ export declare namespace ObjectSetSubscription {
 	}
 	interface Options<
 		O extends ObjectOrInterfaceDefinition,
-		P extends PropertyKeys<O> = PropertyKeys<O>
+		P extends PropertyKeys<O> = PropertyKeys<O>,
+		R extends boolean = false
 	> {
+		/**
+		* The properties to request a subscription for. Requesting specific properties limits the possible properties
+		* that can be returned from the subscription. If not provided, all properties will be requested and potentially be returned on updates.
+		*/
 		properties?: Array<P>;
+		/**
+		* Whether to include the $rid property in the subscription. Defaults to false. RIDs will be returned on all updates unless the update
+		* contains a new value for a geotime series reference property, in which case the RID will be undefined. RIDs will not be included
+		* on the objects themselves.
+		*/
+		includeRid?: AllFalse<PropertyTypesOnDefMatchesType<O, P, "geotimeSeriesReference">> extends true ? R : false;
 	}
 }
 type ObjectUpdate<
 	O extends ObjectOrInterfaceDefinition,
-	P extends PropertyKeys<O>
+	P extends PropertyKeys<O>,
+	R extends boolean = false
 > = {
-	object: Osdk.Instance<O, never, P>
+	object: R extends false ? Osdk.Instance<O, never, P> : Osdk.Instance<O, "$rid", P>
 	state: "ADDED_OR_UPDATED" | "REMOVED"
 };
+type PropertyTypesOnDefMatchesType<
+	Q extends ObjectOrInterfaceDefinition,
+	P extends PropertyKeys<Q>,
+	T extends WirePropertyTypes
+> = { [K in P] : CompileTimeMetadata<Q>["properties"][K]["type"] extends T ? true : false };
+type AllFalse<T extends Record<string, boolean>> = Exclude<T[keyof T], false> extends never ? true : false;
 export {};

package/build/types/objectSet/ObjectSetListener.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,YAAY,sBAAuB;AAEjD,yBAAiB;WACE;EACf,UAAU;EACV,UAAU,aAAa,KAAK,aAAa;GACzC;;;;EAIA,YACEA,cAAc,aAAa,GAAG;;;;EAMhC;;;;;EAMA;;;;EAKA,WAAWC,QAAQ;GAAE;GAA6B;EAAY;CAC/D;WAQgB;EACf,UAAU;EACV,UAAU,aAAa,KAAK,aAAa;GACzC;EACA,aAAa,MAAM;CACpB;;KAGE;CACH,UAAU;CACV,UAAU,aAAa;IACrB;CACF,QAAQ,KAAK,SAAS,UAAU;CAChC,OAAO,qBAAqB;AAC7B","names":["objectUpdate: ObjectUpdate<O, P>","errors: { subscriptionClosed: boolean; error: any }"],"sources":["../../../src/objectSet/ObjectSetListener.ts"],"version":3,"file":"ObjectSetListener.d.ts"}
+{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,2BAA2B,qCAAsC;AAC/E,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,YAAY,sBAAuB;AAEjD,yBAAiB;WACE;EACf,UAAU;EACV,UAAU,aAAa,KAAK,aAAa;EACzC,oBAAoB;GACpB;;;;EAIA,YACEA,cAAc,aAAa,GAAG,GAAG;;;;EAMnC;;;;;EAMA;;;;EAKA,WAAWC,QAAQ;GAAE;GAA6B;EAAY;CAC/D;WAWgB;EACf,UAAU;EACV,UAAU,aAAa,KAAK,aAAa;EACzC,oBAAoB;GACpB;;;;;EAKA,aAAa,MAAM;;;;;;EAOnB,aAAa,SACX,8BAA8B,GAAG,GAAG,mCAC5B,OAAO,IACb;CACL;;KAGE;CACH,UAAU;CACV,UAAU,aAAa;CACvB,oBAAoB;IAClB;CACF,QAAQ,UAAU,QAAQ,KAAK,SAAS,UAAU,KAC9C,KAAK,SAAS,GAAG,QAAQ;CAC7B,OAAO,qBAAqB;AAC7B;KAEI;CACH,UAAU;CACV,UAAU,aAAa;CACvB,UAAU;OAET,KAAK,KAAI,oBAAoB,GAAG,cAAc,GAC7C,gBACQ,IAAI,OACV;KAGD,SAAS,UAAU,2BACtB,QAAQ,QAAQ,IAAI,uBAAuB,OAAO","names":["objectUpdate: ObjectUpdate<O, P, R>","errors: { subscriptionClosed: boolean; error: any }"],"sources":["../../../src/objectSet/ObjectSetListener.ts"],"version":3,"file":"ObjectSetListener.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/api",
-  "version": "2.7.0-beta.11",
+  "version": "2.7.0-beta.13",
   "description": "",
   "access": "public",
   "license": "Apache-2.0",