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

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @osdk/api
 
+## 2.4.0-beta.11
+
+## 2.4.0-beta.10
+
+## 2.4.0-beta.9
+
+### Minor Changes
+
+- 9101bad: Adds "includeNullValues" option for exact match filters
+
+## 2.4.0-beta.8
+
+### Minor Changes
+
+- 9f4fe9e: Add new types mapping for internal creation workflow.
+
+## 2.4.0-beta.7
+
+## 2.4.0-beta.6
+
+## 2.4.0-beta.5
+
+## 2.4.0-beta.4
+
+## 2.4.0-beta.3
+
+## 2.4.0-beta.2
+
+### Minor Changes
+
+- 29d2ada: Fix type in docs and tests
+- 8c95154: Add nearestNeighbor support
+- c32dcf2: Add a metadata field to all loaded objects
+
 ## 2.3.0-beta.10
 
 ## 2.3.0-beta.9

package/build/browser/Definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Definitions.js","names":[],"sources":["Definitions.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 {\n  GetClientPropertyValueFromWire,\n} from \"./mapping/PropertyValueMapping.js\";\nimport type { ObjectMetadata } from \"./ontology/ObjectTypeDefinition.js\";\n\ntype MaybeArray<T extends { multiplicity?: boolean | undefined }, U> =\n  T[\"multiplicity\"] extends true ? Array<U> : U;\n\ntype MaybeNullable<T extends ObjectMetadata.Property, U> = T[\"nullable\"] extends\n  true ? U | undefined\n  : U;\n\ntype Raw<T> = T extends Array<any> ? T[0] : T;\ntype Converted<T> = T extends Array<any> ? T[1] : T;\n\n/**\n * @param {T} ObjectMetadata.Property in literal form\n * @param {STRICTLY_ENFORCE_NULLABLE}  S for strict. If false, always `|undefined`\n */\nexport type OsdkObjectPropertyType<\n  T extends ObjectMetadata.Property,\n  STRICTLY_ENFORCE_NULLABLE extends boolean = true,\n> = STRICTLY_ENFORCE_NULLABLE extends false ?\n    | MaybeArray<T, Converted<GetClientPropertyValueFromWire<T[\"type\"]>>>\n    | undefined\n  : MaybeNullable<\n    T,\n    MaybeArray<T, Converted<GetClientPropertyValueFromWire<T[\"type\"]>>>\n  >;\n\nexport type OsdkObjectRawPropertyType<T extends ObjectMetadata.Property> =\n  MaybeNullable<\n    T,\n    MaybeArray<T, Raw<GetClientPropertyValueFromWire<T[\"type\"]>>>\n  >;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"Definitions.js","names":[],"sources":["Definitions.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 {\n  GetClientPropertyValueFromWire,\n  GetCreatePropertyValueFromWire,\n} from \"./mapping/PropertyValueMapping.js\";\nimport type { ObjectMetadata } from \"./ontology/ObjectTypeDefinition.js\";\n\ntype MaybeArray<T extends { multiplicity?: boolean | undefined }, U> =\n  T[\"multiplicity\"] extends true ? Array<U> : U;\n\ntype MaybeNullable<T extends ObjectMetadata.Property, U> = T[\"nullable\"] extends\n  true ? U | undefined\n  : U;\n\ntype Raw<T> = T extends Array<any> ? T[0] : T;\ntype Converted<T> = T extends Array<any> ? T[1] : T;\n\n/**\n * @param {T} ObjectMetadata.Property in literal form\n * @param {STRICTLY_ENFORCE_NULLABLE}  S for strict. If false, always `|undefined`\n */\nexport type OsdkObjectPropertyType<\n  T extends ObjectMetadata.Property,\n  STRICTLY_ENFORCE_NULLABLE extends boolean = true,\n> = STRICTLY_ENFORCE_NULLABLE extends false ?\n    | MaybeArray<T, Converted<GetClientPropertyValueFromWire<T[\"type\"]>>>\n    | undefined\n  : MaybeNullable<\n    T,\n    MaybeArray<T, Converted<GetClientPropertyValueFromWire<T[\"type\"]>>>\n  >;\n\n/**\n * @param {T} ObjectMetadata.Property in literal form\n * @param {STRICTLY_ENFORCE_NULLABLE}  S for strict. If false, always `|undefined`\n */\nexport type OsdkObjectCreatePropertyType<\n  T extends ObjectMetadata.Property,\n  STRICTLY_ENFORCE_NULLABLE extends boolean = true,\n> = STRICTLY_ENFORCE_NULLABLE extends false ?\n    | MaybeArray<T, Converted<GetCreatePropertyValueFromWire<T[\"type\"]>>>\n    | undefined\n  : MaybeNullable<\n    T,\n    MaybeArray<T, Converted<GetCreatePropertyValueFromWire<T[\"type\"]>>>\n  >;\n\nexport type OsdkObjectRawPropertyType<T extends ObjectMetadata.Property> =\n  MaybeNullable<\n    T,\n    MaybeArray<T, Raw<GetClientPropertyValueFromWire<T[\"type\"]>>>\n  >;\n"],"mappings":"","ignoreList":[]}

package/build/browser/OsdkObjectFrom.js.map

@@ -1 +1 @@
-{"version":3,"file":"OsdkObjectFrom.js","names":["Osdk"],"sources":["OsdkObjectFrom.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 {\n  DefaultToFalse,\n  OsdkObjectLinksObject,\n} from \"./definitions/LinkDefinitions.js\";\nimport type { NullabilityAdherence } from \"./object/FetchPageArgs.js\";\nimport type { UnionIfTrue } from \"./object/FetchPageResult.js\";\nimport type { InterfaceDefinition } from \"./ontology/InterfaceDefinition.js\";\nimport type {\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 { OsdkBase } from \"./OsdkBase.js\";\n\ntype DropDollarOptions<T extends string> = Exclude<\n  T,\n  \"$rid\" | \"$all\" | \"$notStrict\"\n>;\n\ntype DropDollarAll<T extends string> = Exclude<\n  T,\n  \"$all\"\n>;\n\ntype SpecialOsdkPropParams =\n  | \"$all\"\n  | \"$rid\"\n  | \"$strict\"\n  | \"$notStrict\";\n\ntype ValidOsdkPropParams<Q extends ObjectOrInterfaceDefinition> =\n  | SpecialOsdkPropParams\n  | PropertyKeys<Q>;\n\nexport type ApiNameAsString<\n  T extends ObjectOrInterfaceDefinition,\n> = CompileTimeMetadata<T>[\"apiName\"];\n\nexport type JustProps<\n  T extends ObjectOrInterfaceDefinition,\n  P extends ValidOsdkPropParams<T>,\n> = P extends \"$all\" ? PropertyKeys<T>\n  : Exclude<P, SpecialOsdkPropParams>;\n\nexport type PropMapToObject<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ObjectTypeDefinition,\n> = NonNullable<CompileTimeMetadata<TO>[\"interfaceMap\"]>[ApiNameAsString<FROM>];\n\nexport type MapPropNamesToObjectType<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ObjectTypeDefinition,\n  P extends ValidOsdkPropParams<FROM>,\n  OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = \"$allBaseProperties\" extends OPTIONS\n  ? PropertyKeys<FROM> extends P ? PropertyKeys<TO>\n  : PropMapToObject<\n    FROM,\n    TO\n  >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>]\n  : PropMapToObject<\n    FROM,\n    TO\n  >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];\n\nexport type PropMapToInterface<\n  FROM extends ObjectTypeDefinition,\n  TO extends InterfaceDefinition,\n> = NonNullable<\n  CompileTimeMetadata<FROM>[\"inverseInterfaceMap\"]\n>[ApiNameAsString<TO>];\n\nexport type MapPropNamesToInterface<\n  FROM extends ObjectTypeDefinition,\n  TO extends InterfaceDefinition,\n  P extends ValidOsdkPropParams<FROM>,\n> = PropMapToInterface<\n  FROM,\n  TO\n>[JustProps<FROM, P> & keyof PropMapToInterface<FROM, TO>];\n/**\n * Older version of this helper that allows for `$rid` and co in\n * the properties field.\n * @param FROM - the interface or object type to convert from\n * @param TO - the interface or object type to convert to\n * @param P - the property(s) to convert\n */\nexport type ConvertProps<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ValidToFrom<FROM>,\n  P extends ValidOsdkPropParams<FROM>,\n  OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = TO extends FROM ? P\n  : TO extends ObjectTypeDefinition ? (\n      UnionIfTrue<\n        MapPropNamesToObjectType<FROM, TO, P, OPTIONS>,\n        P extends \"$rid\" ? true : false,\n        \"$rid\"\n      >\n    )\n  : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (\n        UnionIfTrue<\n          MapPropNamesToInterface<FROM, TO, P>,\n          P extends \"$rid\" ? true : false,\n          \"$rid\"\n        >\n      )\n    : never\n  : never;\n\n/** DO NOT EXPORT FROM PACKAGE */\nexport type ValidToFrom<\n  FROM extends ObjectOrInterfaceDefinition,\n> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition\n  : InterfaceDefinition;\n\nexport type IsNever<T> = [T] extends [never] ? true : false;\n\ntype ExtractPropsKeysFromOldPropsStyle<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends ValidOsdkPropParams<Q>,\n> = P extends \"$all\" ? PropertyKeys<Q>\n  : Exclude<P, \"$strict\" | \"$notStrict\" | \"$rid\">;\n\nexport type IsAny<T> = unknown extends T\n  ? [keyof T] extends [never] ? false : true\n  : false;\n\nexport type GetPropsKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<Q>,\n  N extends boolean = false,\n> = IsNever<P> extends true ? N extends true ? never : PropertyKeys<Q>\n  : IsAny<P> extends true ? PropertyKeys<Q>\n  : P;\n\n/**\n * Use `Osdk.Instance` or `YourType.OsdkInstance`\n */\nexport type Osdk<\n  Q extends ObjectOrInterfaceDefinition,\n  OPTIONS extends string = never,\n  P extends PropertyKeys<Q> = PropertyKeys<Q>,\n> =\n  // no middle options is simplest\n  IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n    : IsAny<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n    // Options only includes the two allowed in the new style\n    : (IsNever<Exclude<OPTIONS, \"$rid\">>) extends true\n      ? Osdk.Instance<Q, OPTIONS & \"$rid\", P>\n    // else we are in the old style which was just Q and OPTIONS\n    // and OPTIONS was $things + prop names\n    : Osdk.Instance<\n      Q,\n      (\"$rid\" extends OPTIONS ? \"$rid\" : never),\n      ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>\n    >;\n\nexport namespace Osdk {\n  export type Instance<\n    Q extends ObjectOrInterfaceDefinition,\n    OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n    P extends PropertyKeys<Q> = PropertyKeys<Q>,\n    R extends Record<string, SimplePropertyDef> = {},\n  > =\n    & OsdkBase<Q>\n    & Pick<\n      CompileTimeMetadata<Q>[\"props\"],\n      // If there aren't any additional properties, then we want GetPropsKeys to default to PropertyKeys<Q>\n      GetPropsKeys<Q, P, [R] extends [{}] ? false : true>\n    >\n    & ([R] extends [never] ? {}\n      : { [A in keyof R]: SimplePropertyDef.ToRuntimeProperty<R[A]> })\n    & {\n      readonly $link: Q extends { linksType?: any } ? Q[\"linksType\"]\n        : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q>\n        : never;\n\n      readonly $as: <NEW_Q extends ValidToFrom<Q>>(\n        type: NEW_Q | string,\n      ) => Osdk.Instance<\n        NEW_Q,\n        OPTIONS,\n        ConvertProps<Q, NEW_Q, P, OPTIONS>\n      >;\n\n      readonly $clone: <NEW_PROPS extends PropertyKeys<Q>>(\n        updatedObject?:\n          | Osdk.Instance<Q, any, NEW_PROPS>\n          | {\n            [K in NEW_PROPS]?: CompileTimeMetadata<\n              Q\n            >[\"props\"][K];\n          },\n      ) => Osdk.Instance<Q, OPTIONS, P | NEW_PROPS>;\n    }\n    // We are hiding the $rid field if it wasn't requested as we want to discourage its use\n    & (IsNever<OPTIONS> extends true ? {}\n      : IsAny<OPTIONS> extends true ? {}\n      : \"$rid\" extends OPTIONS ? { readonly $rid: string }\n      : {});\n}\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not `false` should always be `never`.\n *\n * This is structured in a way that it should always short circuit to never early.\n */\nexport type ExtractStrictOption<S extends NullabilityAdherence> =\n  IsNever<S> extends true ? never\n    : \"throw\" extends S ? never // catches any time \"throw\" still exists (including any)\n    : \"drop\" extends S ? never // catches any time \"drop\" still exists (including any)\n    : \"$notStrict\";\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not exactly `true` should always be `never`.\n */\nexport type ExtractRidOption<R extends boolean> = // comment for readability\n  IsNever<R> extends true ? never\n    : DefaultToFalse<R> extends false ? never\n    : \"$rid\";\n\nexport type ExtractAllPropertiesOption<T extends boolean> = // comment for readability\n  IsNever<T> extends true ? never\n    : DefaultToFalse<T> extends false ? never\n    : \"$allBaseProperties\";\n\n// not exported from package\nexport type ExtractOptions<\n  R extends boolean,\n  S extends NullabilityAdherence = NullabilityAdherence.Default,\n  T extends boolean = false,\n> = ExtractRidOption<R> | ExtractAllPropertiesOption<T>;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAsFA;AACA;AACA;AACA;AACA;AACA;AACA;AAwBA;AA0BA;AACA;AACA;AAFA,WAsBiBA,IAAI;AA6CrB;AACA;AACA;AACA;AACA;AACA;AACA;AAOA;AACA;AACA;AACA;AACA;AAWA","ignoreList":[]}
+{"version":3,"file":"OsdkObjectFrom.js","names":["Osdk"],"sources":["OsdkObjectFrom.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 {\n  DefaultToFalse,\n  OsdkObjectLinksObject,\n} from \"./definitions/LinkDefinitions.js\";\nimport type { NullabilityAdherence } from \"./object/FetchPageArgs.js\";\nimport type { UnionIfTrue } from \"./object/FetchPageResult.js\";\nimport type {\n  InterfaceDefinition,\n  InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n  ObjectTypeDefinition,\n} from \"./ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"./ontology/SimplePropertyDef.js\";\nimport type { OsdkBase } from \"./OsdkBase.js\";\n\ntype DropDollarOptions<T extends string> = Exclude<\n  T,\n  \"$rid\" | \"$all\" | \"$notStrict\"\n>;\n\ntype DropDollarAll<T extends string> = Exclude<\n  T,\n  \"$all\"\n>;\n\ntype SpecialOsdkPropParams =\n  | \"$all\"\n  | \"$rid\"\n  | \"$strict\"\n  | \"$notStrict\";\n\ntype ValidOsdkPropParams<Q extends ObjectOrInterfaceDefinition> =\n  | SpecialOsdkPropParams\n  | PropertyKeys<Q>;\n\nexport type ApiNameAsString<\n  T extends ObjectOrInterfaceDefinition,\n> = CompileTimeMetadata<T>[\"apiName\"];\n\nexport type JustProps<\n  T extends ObjectOrInterfaceDefinition,\n  P extends ValidOsdkPropParams<T>,\n> = P extends \"$all\" ? PropertyKeys<T>\n  : Exclude<P, SpecialOsdkPropParams>;\n\nexport type PropMapToObject<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ObjectTypeDefinition,\n> = NonNullable<CompileTimeMetadata<TO>[\"interfaceMap\"]>[ApiNameAsString<FROM>];\n\nexport type MapPropNamesToObjectType<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ObjectTypeDefinition,\n  P extends ValidOsdkPropParams<FROM>,\n  OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = \"$allBaseProperties\" extends OPTIONS\n  ? PropertyKeys<FROM> extends P ? PropertyKeys<TO>\n  : PropMapToObject<\n    FROM,\n    TO\n  >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>]\n  : PropMapToObject<\n    FROM,\n    TO\n  >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];\n\nexport type PropMapToInterface<\n  FROM extends ObjectTypeDefinition,\n  TO extends InterfaceDefinition,\n> = NonNullable<\n  CompileTimeMetadata<FROM>[\"inverseInterfaceMap\"]\n>[ApiNameAsString<TO>];\n\nexport type MapPropNamesToInterface<\n  FROM extends ObjectTypeDefinition,\n  TO extends InterfaceDefinition,\n  P extends ValidOsdkPropParams<FROM>,\n> = PropMapToInterface<\n  FROM,\n  TO\n>[JustProps<FROM, P> & keyof PropMapToInterface<FROM, TO>];\n/**\n * Older version of this helper that allows for `$rid` and co in\n * the properties field.\n * @param FROM - the interface or object type to convert from\n * @param TO - the interface or object type to convert to\n * @param P - the property(s) to convert\n */\nexport type ConvertProps<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ValidToFrom<FROM>,\n  P extends ValidOsdkPropParams<FROM>,\n  OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = TO extends FROM ? P\n  : TO extends ObjectTypeDefinition ? (\n      UnionIfTrue<\n        MapPropNamesToObjectType<FROM, TO, P, OPTIONS>,\n        P extends \"$rid\" ? true : false,\n        \"$rid\"\n      >\n    )\n  : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (\n        UnionIfTrue<\n          MapPropNamesToInterface<FROM, TO, P>,\n          P extends \"$rid\" ? true : false,\n          \"$rid\"\n        >\n      )\n    : never\n  : never;\n\n/** DO NOT EXPORT FROM PACKAGE */\nexport type ValidToFrom<\n  FROM extends ObjectOrInterfaceDefinition,\n> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition\n  : InterfaceDefinition;\n\nexport type IsNever<T> = [T] extends [never] ? true : false;\n\ntype ExtractPropsKeysFromOldPropsStyle<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends ValidOsdkPropParams<Q>,\n> = P extends \"$all\" ? PropertyKeys<Q>\n  : Exclude<P, \"$strict\" | \"$notStrict\" | \"$rid\">;\n\nexport type IsAny<T> = unknown extends T\n  ? [keyof T] extends [never] ? false : true\n  : false;\n\nexport type GetPropsKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<Q>,\n  N extends boolean = false,\n> = IsNever<P> extends true ? N extends true ? never : PropertyKeys<Q>\n  : IsAny<P> extends true ? PropertyKeys<Q>\n  : P;\n\n/**\n * Use `Osdk.Instance` or `YourType.OsdkInstance`\n */\nexport type Osdk<\n  Q extends ObjectOrInterfaceDefinition,\n  OPTIONS extends string = never,\n  P extends PropertyKeys<Q> = PropertyKeys<Q>,\n> =\n  // no middle options is simplest\n  IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n    : IsAny<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n    // Options only includes the two allowed in the new style\n    : (IsNever<Exclude<OPTIONS, \"$rid\">>) extends true\n      ? Osdk.Instance<Q, OPTIONS & \"$rid\", P>\n    // else we are in the old style which was just Q and OPTIONS\n    // and OPTIONS was $things + prop names\n    : Osdk.Instance<\n      Q,\n      (\"$rid\" extends OPTIONS ? \"$rid\" : never),\n      ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>\n    >;\n\nexport namespace Osdk {\n  export type Instance<\n    Q extends ObjectOrInterfaceDefinition,\n    OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n    P extends PropertyKeys<Q> = PropertyKeys<Q>,\n    R extends Record<string, SimplePropertyDef> = {},\n  > =\n    & OsdkBase<Q>\n    & Pick<\n      CompileTimeMetadata<Q>[\"props\"],\n      // If there aren't any additional properties, then we want GetPropsKeys to default to PropertyKeys<Q>\n      GetPropsKeys<Q, P, [R] extends [{}] ? false : true>\n    >\n    & ([R] extends [never] ? {}\n      : { [A in keyof R]: SimplePropertyDef.ToRuntimeProperty<R[A]> })\n    & {\n      readonly $link: Q extends { linksType?: any } ? Q[\"linksType\"]\n        : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q>\n        : never;\n\n      readonly $as: <NEW_Q extends ValidToFrom<Q>>(\n        type: NEW_Q | string,\n      ) => Osdk.Instance<\n        NEW_Q,\n        OPTIONS,\n        ConvertProps<Q, NEW_Q, P, OPTIONS>\n      >;\n\n      readonly $clone: <NEW_PROPS extends PropertyKeys<Q>>(\n        updatedObject?:\n          | Osdk.Instance<Q, any, NEW_PROPS>\n          | {\n            [K in NEW_PROPS]?: CompileTimeMetadata<\n              Q\n            >[\"props\"][K];\n          },\n      ) => Osdk.Instance<Q, OPTIONS, P | NEW_PROPS>;\n\n      readonly $__EXPERIMENTAL__NOT_SUPPORTED_YET__metadata: Q extends\n        ObjectTypeDefinition ? {\n          ObjectMetadata: Q;\n        }\n        : {\n          ObjectMetadata: ObjectMetadata;\n          InterfaceMetadata: InterfaceMetadata;\n        };\n    }\n    // We are hiding the $rid field if it wasn't requested as we want to discourage its use\n    & (IsNever<OPTIONS> extends true ? {}\n      : IsAny<OPTIONS> extends true ? {}\n      : \"$rid\" extends OPTIONS ? { readonly $rid: string }\n      : {});\n}\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not `false` should always be `never`.\n *\n * This is structured in a way that it should always short circuit to never early.\n */\nexport type ExtractStrictOption<S extends NullabilityAdherence> =\n  IsNever<S> extends true ? never\n    : \"throw\" extends S ? never // catches any time \"throw\" still exists (including any)\n    : \"drop\" extends S ? never // catches any time \"drop\" still exists (including any)\n    : \"$notStrict\";\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not exactly `true` should always be `never`.\n */\nexport type ExtractRidOption<R extends boolean> = // comment for readability\n  IsNever<R> extends true ? never\n    : DefaultToFalse<R> extends false ? never\n    : \"$rid\";\n\nexport type ExtractAllPropertiesOption<T extends boolean> = // comment for readability\n  IsNever<T> extends true ? never\n    : DefaultToFalse<T> extends false ? never\n    : \"$allBaseProperties\";\n\n// not exported from package\nexport type ExtractOptions<\n  R extends boolean,\n  S extends NullabilityAdherence = NullabilityAdherence.Default,\n  T extends boolean = false,\n> = ExtractRidOption<R> | ExtractAllPropertiesOption<T>;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AA0FA;AACA;AACA;AACA;AACA;AACA;AACA;AAwBA;AA0BA;AACA;AACA;AAFA,WAsBiBA,IAAI;AAsDrB;AACA;AACA;AACA;AACA;AACA;AACA;AAOA;AACA;AACA;AACA;AACA;AAWA","ignoreList":[]}

package/build/browser/aggregate/AggregateOptsThatErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"AggregateOptsThatErrors.js","names":[],"sources":["AggregateOptsThatErrors.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 { SingleKeyObject } from \"type-fest\";\nimport type { GroupByClause } from \"../groupby/GroupByClause.js\";\nimport type { ObjectOrInterfaceDefinition } from \"../ontology/ObjectOrInterface.js\";\nimport type { AggregateOpts } from \"./AggregateOpts.js\";\nimport type { UnorderedAggregationClause } from \"./AggregationsClause.js\";\n\nexport type AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<\n  Q extends ObjectOrInterfaceDefinition,\n  AO extends AggregateOpts<Q>,\n> = SingleKeyObject<AO[\"$groupBy\"]> extends never ? (\n    AO[\"$select\"] extends UnorderedAggregationClause<Q>\n      ? AggregateOptsThatErrors<Q, AO>\n      : {} extends AO[\"$groupBy\"] ? AggregateOptsThatErrors<Q, AO>\n      : {\n        $groupBy: AO[\"$groupBy\"];\n        $select: UnorderedAggregationClause<Q>;\n      }\n  )\n  : AggregateOptsThatErrors<Q, AO>;\n\ntype AggregateOptsThatErrors<\n  Q extends ObjectOrInterfaceDefinition,\n  AO extends AggregateOpts<Q>,\n> =\n  & AO\n  & {\n    $select:\n      & Pick<\n        AO[\"$select\"],\n        keyof AggregateOpts<Q>[\"$select\"] & keyof AO[\"$select\"]\n      >\n      & Record<\n        Exclude<keyof AO[\"$select\"], keyof AggregateOpts<Q>[\"$select\"]>,\n        never\n      >;\n  }\n  & (unknown extends AO[\"$groupBy\"] ? {}\n    : Exclude<AO[\"$groupBy\"], undefined> extends never ? {}\n    : {\n      $groupBy:\n        & Pick<\n          AO[\"$groupBy\"],\n          keyof GroupByClause<Q> & keyof AO[\"$groupBy\"]\n        >\n        & Record<\n          Exclude<keyof AO[\"$groupBy\"], keyof GroupByClause<Q>>,\n          never\n        >;\n    });\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"AggregateOptsThatErrors.js","names":[],"sources":["AggregateOptsThatErrors.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 { SingleKeyObject } from \"type-fest\";\nimport type { GroupByClause } from \"../groupby/GroupByClause.js\";\nimport type { ObjectOrInterfaceDefinition } from \"../ontology/ObjectOrInterface.js\";\nimport type { AggregateOpts } from \"./AggregateOpts.js\";\nimport type { UnorderedAggregationClause } from \"./AggregationsClause.js\";\n\nexport type AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<\n  Q extends ObjectOrInterfaceDefinition,\n  AO extends AggregateOpts<Q>,\n> = ContainsExactMatchWithNull<AO[\"$groupBy\"]> extends true ? {\n    $groupBy: AO[\"$groupBy\"];\n    $select: UnorderedAggregationClause<Q>;\n  }\n  : SingleKeyObject<AO[\"$groupBy\"]> extends never ? (\n      AO[\"$select\"] extends UnorderedAggregationClause<Q>\n        ? AggregateOptsThatErrors<Q, AO>\n        : {} extends AO[\"$groupBy\"] ? AggregateOptsThatErrors<Q, AO>\n        : {\n          $groupBy: AO[\"$groupBy\"];\n          $select: UnorderedAggregationClause<Q>;\n        }\n    )\n  : AggregateOptsThatErrors<Q, AO>;\n\ntype ContainsExactMatchWithNull<GB extends GroupByClause<any> | undefined> =\n  undefined extends GB ? false : {} extends GB ? false : {\n    [P in keyof GB]: GB[P] extends { $exact: { $includeNullValue: true } }\n      ? true\n      : false;\n  }[keyof GB];\n\ntype AggregateOptsThatErrors<\n  Q extends ObjectOrInterfaceDefinition,\n  AO extends AggregateOpts<Q>,\n> =\n  & AO\n  & {\n    $select:\n      & Pick<\n        AO[\"$select\"],\n        keyof AggregateOpts<Q>[\"$select\"] & keyof AO[\"$select\"]\n      >\n      & Record<\n        Exclude<keyof AO[\"$select\"], keyof AggregateOpts<Q>[\"$select\"]>,\n        never\n      >;\n  }\n  & (unknown extends AO[\"$groupBy\"] ? {}\n    : Exclude<AO[\"$groupBy\"], undefined> extends never ? {}\n    : {\n      $groupBy:\n        & Pick<\n          AO[\"$groupBy\"],\n          keyof GroupByClause<Q> & keyof AO[\"$groupBy\"]\n        >\n        & Record<\n          Exclude<keyof AO[\"$groupBy\"], keyof GroupByClause<Q>>,\n          never\n        >;\n    });\n"],"mappings":"","ignoreList":[]}

package/build/browser/aggregate/AggregationResultsWithGroups.js.map

@@ -1 +1 @@
-{"version":3,"file":"AggregationResultsWithGroups.js","names":[],"sources":["AggregationResultsWithGroups.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 { OsdkObjectPropertyType } from \"../Definitions.js\";\nimport type { GroupByClause, GroupByRange } from \"../groupby/GroupByClause.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { AggregationResultsWithoutGroups } from \"./AggregationResultsWithoutGroups.js\";\nimport type {\n  OrderedAggregationClause,\n  UnorderedAggregationClause,\n} from \"./AggregationsClause.js\";\n\nexport type AggregationResultsWithGroups<\n  Q extends ObjectOrInterfaceDefinition,\n  A extends UnorderedAggregationClause<Q> | OrderedAggregationClause<Q>,\n  G extends GroupByClause<Q> | undefined,\n> = (\n  & {\n    $group: {\n      [P in keyof G & PropertyKeys<Q>]: G[P] extends\n        { $ranges: GroupByRange<infer T>[] } ? { startValue: T; endValue: T }\n        : OsdkObjectPropertyType<CompileTimeMetadata<Q>[\"properties\"][P], true>;\n    };\n  }\n  & AggregationResultsWithoutGroups<Q, A>\n)[];\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"AggregationResultsWithGroups.js","names":[],"sources":["AggregationResultsWithGroups.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 { OsdkObjectPropertyType } from \"../Definitions.js\";\nimport type { GroupByClause, GroupByRange } from \"../groupby/GroupByClause.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { AggregationResultsWithoutGroups } from \"./AggregationResultsWithoutGroups.js\";\nimport type {\n  OrderedAggregationClause,\n  UnorderedAggregationClause,\n} from \"./AggregationsClause.js\";\n\nexport type AggregationResultsWithGroups<\n  Q extends ObjectOrInterfaceDefinition,\n  A extends UnorderedAggregationClause<Q> | OrderedAggregationClause<Q>,\n  G extends GroupByClause<Q> | undefined,\n> = (\n  & {\n    $group: {\n      [P in keyof G & PropertyKeys<Q>]: G[P] extends\n        { $ranges: GroupByRange<infer T>[] } ? { startValue: T; endValue: T }\n        : MaybeNullable<\n          G[P],\n          OsdkObjectPropertyType<\n            CompileTimeMetadata<Q>[\"properties\"][P],\n            true\n          >\n        >;\n    };\n  }\n  & AggregationResultsWithoutGroups<Q, A>\n)[];\n\ntype MaybeNullable<GROUP, VALUE> = GROUP extends {\n  $exact: { $includeNullValue: true };\n} ? VALUE | null\n  : VALUE;\n"],"mappings":"","ignoreList":[]}

package/build/browser/groupby/GroupByClause.js.map

@@ -1 +1 @@
-{"version":3,"file":"GroupByClause.js","names":["TimeDurationMapping","DurationMapping"],"sources":["GroupByClause.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 { AggregatableKeys } from \"../aggregate/AggregatableKeys.js\";\nimport { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nimport type { ObjectOrInterfaceDefinition } from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { GroupByMapper } from \"./GroupByMapper.js\";\n\nexport type GroupByClause<\n  Q extends ObjectOrInterfaceDefinition,\n> = {\n  [P in AggregatableKeys<Q>]?: GroupByEntry<Q, P>;\n};\n\ntype BaseGroupByValue =\n  | \"exact\"\n  | { $exactWithLimit: number }\n  | ExactGroupByWithOptions;\n\ntype ExactGroupByWithOptions = {\n  $exact: { $limit?: number; $defaultValue?: string };\n};\n\nexport type GroupByRange<T> = [T, T];\n\nexport type StringGroupByValue = BaseGroupByValue;\n\nexport type NumericGroupByValue = BaseGroupByValue | {\n  $fixedWidth: number;\n} | { $ranges: GroupByRange<number>[] };\n\nexport type TimestampGroupByValue =\n  | BaseGroupByValue\n  | { $ranges: GroupByRange<string>[] }\n  | { $duration: TimestampDurationGroupBy };\n\nexport type DateGroupByValue =\n  | BaseGroupByValue\n  | { $ranges: GroupByRange<string>[] }\n  | { $duration: DatetimeDurationGroupBy };\n\nexport type BooleanGroupByValue = BaseGroupByValue;\n\nexport type TimestampTimeUnits =\n  | DateTimeUnits\n  | \"SECONDS\"\n  | \"MINUTES\"\n  | \"HOURS\";\n\nexport type DateTimeUnits = \"DAYS\" | \"WEEKS\" | \"MONTHS\" | \"YEARS\" | \"QUARTERS\";\nexport const DurationMapping: {\n  quarter: \"QUARTERS\";\n  quarters: \"QUARTERS\";\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  ...TimeDurationMapping,\n  \"quarter\": \"QUARTERS\",\n  \"quarters\": \"QUARTERS\",\n} satisfies Record<string, DateTimeUnits | TimestampTimeUnits>;\n\ninterface TimeValueMapping {\n  SECONDS: number;\n  MINUTES: number;\n  HOURS: number;\n  DAYS: number;\n  WEEKS: 1;\n  MONTHS: 1;\n  YEARS: 1;\n  QUARTERS: 1;\n}\n\ntype DurationGroupBy<A> = {\n  [K in keyof typeof DurationMapping]: typeof DurationMapping[K] extends A\n    ? [TimeValueMapping[typeof DurationMapping[K]], K]\n    : never;\n}[keyof typeof DurationMapping];\n\ntype TimestampDurationGroupBy = DurationGroupBy<TimestampTimeUnits>;\ntype DatetimeDurationGroupBy = DurationGroupBy<DateTimeUnits>;\n\ntype GroupByEntry<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends AggregatableKeys<Q>,\n> = CompileTimeMetadata<Q>[\"properties\"][P][\"type\"] extends keyof GroupByMapper\n  ? GroupByMapper[CompileTimeMetadata<Q>[\"properties\"][P][\"type\"]]\n  : never;\n\nexport type AllGroupByValues = GroupByMapper[keyof GroupByMapper];\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,mBAAmB,QAAQ,+BAA+B;AA+CnE,OAAO,MAAMC,eAuBZ,GAAG;EACF,GAAGD,mBAAmB;EACtB,SAAS,EAAE,UAAU;EACrB,UAAU,EAAE;AACd,CAA8D","ignoreList":[]}
+{"version":3,"file":"GroupByClause.js","names":["TimeDurationMapping","DurationMapping"],"sources":["GroupByClause.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 { AggregatableKeys } from \"../aggregate/AggregatableKeys.js\";\nimport { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nimport type { ObjectOrInterfaceDefinition } from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { GroupByMapper } from \"./GroupByMapper.js\";\n\nexport type GroupByClause<\n  Q extends ObjectOrInterfaceDefinition,\n> = {\n  [P in AggregatableKeys<Q>]?: GroupByEntry<Q, P>;\n};\n\ntype BaseGroupByValue =\n  | \"exact\"\n  | { $exactWithLimit: number }\n  | ExactGroupByWithOptions;\n\ntype ExactGroupByWithOptions = {\n  $exact:\n    & {\n      $limit?: number;\n    }\n    & (\n      | {\n        $defaultValue?: undefined;\n        $includeNullValue?: false;\n      }\n      | {\n        $defaultValue: string;\n        $includeNullValue?: false;\n      }\n      | {\n        $defaultValue?: never;\n        $includeNullValue: true;\n      }\n    );\n};\n\nexport type GroupByRange<T> = [T, T];\n\nexport type StringGroupByValue = BaseGroupByValue;\n\nexport type NumericGroupByValue = BaseGroupByValue | {\n  $fixedWidth: number;\n} | { $ranges: GroupByRange<number>[] };\n\nexport type TimestampGroupByValue =\n  | BaseGroupByValue\n  | { $ranges: GroupByRange<string>[] }\n  | { $duration: TimestampDurationGroupBy };\n\nexport type DateGroupByValue =\n  | BaseGroupByValue\n  | { $ranges: GroupByRange<string>[] }\n  | { $duration: DatetimeDurationGroupBy };\n\nexport type BooleanGroupByValue = BaseGroupByValue;\n\nexport type TimestampTimeUnits =\n  | DateTimeUnits\n  | \"SECONDS\"\n  | \"MINUTES\"\n  | \"HOURS\";\n\nexport type DateTimeUnits = \"DAYS\" | \"WEEKS\" | \"MONTHS\" | \"YEARS\" | \"QUARTERS\";\nexport const DurationMapping: {\n  quarter: \"QUARTERS\";\n  quarters: \"QUARTERS\";\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  ...TimeDurationMapping,\n  \"quarter\": \"QUARTERS\",\n  \"quarters\": \"QUARTERS\",\n} satisfies Record<string, DateTimeUnits | TimestampTimeUnits>;\n\ninterface TimeValueMapping {\n  SECONDS: number;\n  MINUTES: number;\n  HOURS: number;\n  DAYS: number;\n  WEEKS: 1;\n  MONTHS: 1;\n  YEARS: 1;\n  QUARTERS: 1;\n}\n\ntype DurationGroupBy<A> = {\n  [K in keyof typeof DurationMapping]: typeof DurationMapping[K] extends A\n    ? [TimeValueMapping[typeof DurationMapping[K]], K]\n    : never;\n}[keyof typeof DurationMapping];\n\ntype TimestampDurationGroupBy = DurationGroupBy<TimestampTimeUnits>;\ntype DatetimeDurationGroupBy = DurationGroupBy<DateTimeUnits>;\n\ntype GroupByEntry<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends AggregatableKeys<Q>,\n> = CompileTimeMetadata<Q>[\"properties\"][P][\"type\"] extends keyof GroupByMapper\n  ? GroupByMapper[CompileTimeMetadata<Q>[\"properties\"][P][\"type\"]]\n  : never;\n\nexport type AllGroupByValues = GroupByMapper[keyof GroupByMapper];\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,mBAAmB,QAAQ,+BAA+B;AAgEnE,OAAO,MAAMC,eAuBZ,GAAG;EACF,GAAGD,mBAAmB;EACtB,SAAS,EAAE,UAAU;EACrB,UAAU,EAAE;AACd,CAA8D","ignoreList":[]}

package/build/browser/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["NULL_VALUE","DistanceUnitMapping","DurationMapping","isOk","TimeseriesDurationMapping"],"sources":["index.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type { ActionReturnTypeForOptions } from \"./actions/ActionReturnTypeForOptions.js\";\nexport type {\n  ActionEditResponse,\n  ActionParam,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n} from \"./actions/Actions.js\";\nexport { NULL_VALUE } from \"./actions/NullValue.js\";\nexport type { ValidAggregationKeys } from \"./aggregate/AggregatableKeys.js\";\nexport type { AggregateOpts } from \"./aggregate/AggregateOpts.js\";\nexport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"./aggregate/AggregateOptsThatErrors.js\";\nexport type { AggregationResultsWithGroups } from \"./aggregate/AggregationResultsWithGroups.js\";\nexport type { AggregationResultsWithoutGroups } from \"./aggregate/AggregationResultsWithoutGroups.js\";\nexport type { AggregationClause } from \"./aggregate/AggregationsClause.js\";\nexport type { AggregationsResults } from \"./aggregate/AggregationsResults.js\";\nexport type { GeoFilterOptions } from \"./aggregate/GeoFilter.js\";\nexport { DistanceUnitMapping } from \"./aggregate/WhereClause.js\";\nexport type {\n  GeoFilter_Intersects,\n  GeoFilter_Within,\n  PossibleWhereClauseFilters,\n  WhereClause,\n} from \"./aggregate/WhereClause.js\";\nexport type { OsdkObjectPropertyType } from \"./Definitions.js\";\nexport type {\n  OsdkObjectLinksObject,\n  SingleLinkAccessor,\n} from \"./definitions/LinkDefinitions.js\";\nexport type { DerivedProperty } from \"./derivedProperties/DerivedProperty.js\";\nexport { DurationMapping } from \"./groupby/GroupByClause.js\";\nexport type {\n  AllGroupByValues,\n  GroupByClause,\n  GroupByRange,\n} from \"./groupby/GroupByClause.js\";\nexport type {\n  AllowedBucketKeyTypes,\n  AllowedBucketTypes,\n  DataValueClientToWire,\n  DataValueWireToClient,\n} from \"./mapping/DataValueMapping.js\";\nexport type {\n  PropertyValueWireToClient,\n} from \"./mapping/PropertyValueMapping.js\";\nexport type { Attachment, AttachmentUpload } from \"./object/Attachment.js\";\nexport type {\n  AsyncIterArgs,\n  Augment,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  SelectArg,\n  SelectArgToKeys,\n} from \"./object/FetchPageArgs.js\";\nexport type {\n  FetchPageResult,\n  SingleOsdkResult,\n} from \"./object/FetchPageResult.js\";\nexport type {\n  Media,\n  MediaMetadata,\n  MediaReference,\n  MediaUpload,\n} from \"./object/Media.js\";\nexport { isOk } from \"./object/Result.js\";\nexport type { Result } from \"./object/Result.js\";\nexport type { BaseObjectSet } from \"./objectSet/BaseObjectSet.js\";\nexport type { ObjectSet } from \"./objectSet/ObjectSet.js\";\nexport type { ObjectSetSubscription } from \"./objectSet/ObjectSetListener.js\";\nexport type {\n  ActionDefinition,\n  ActionMetadata,\n} from \"./ontology/ActionDefinition.js\";\nexport type {\n  InterfaceDefinition,\n  InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nexport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nexport type { ObjectSpecifier } from \"./ontology/ObjectSpecifier.js\";\nexport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n  ObjectTypeDefinition,\n  PropertyDef,\n  VersionBound,\n} from \"./ontology/ObjectTypeDefinition.js\";\nexport type { OntologyMetadata } from \"./ontology/OntologyMetadata.js\";\nexport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nexport type {\n  ObjectQueryDataType,\n  ObjectSetQueryDataType,\n  QueryDataTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  QueryParameterDefinition,\n  ThreeDimensionalQueryAggregationDefinition,\n  TwoDimensionalQueryAggregationDefinition,\n} from \"./ontology/QueryDefinition.js\";\nexport type {\n  BaseWirePropertyTypes,\n  WirePropertyTypes,\n} from \"./ontology/WirePropertyTypes.js\";\nexport type {\n  ObjectIdentifiers,\n  OsdkBase,\n  PrimaryKeyType,\n} from \"./OsdkBase.js\";\nexport type { OsdkObject } from \"./OsdkObject.js\";\nexport type { ConvertProps, Osdk } from \"./OsdkObjectFrom.js\";\nexport type { PageResult } from \"./PageResult.js\";\nexport type {\n  Range,\n  ThreeDimensionalAggregation,\n  TwoDimensionalAggregation,\n} from \"./queries/Aggregations.js\";\nexport type { QueryParam, QueryResult } from \"./queries/Queries.js\";\nexport { TimeseriesDurationMapping } from \"./timeseries/timeseries.js\";\nexport type {\n  GeotimeSeriesProperty,\n  TimeSeriesPoint,\n  TimeSeriesProperty,\n  TimeSeriesQuery,\n} from \"./timeseries/timeseries.js\";\nexport type { LinkedType, LinkNames } from \"./util/LinkUtils.js\";\nexport {};\nexport type { Logger } from \"./Logger.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,SAASA,UAAU,QAAQ,wBAAwB;AASnD,SAASC,mBAAmB,QAAQ,4BAA4B;AAahE,SAASC,eAAe,QAAQ,4BAA4B;AAmC5D,SAASC,IAAI,QAAQ,oBAAoB;AAuDzC,SAASC,yBAAyB,QAAQ,4BAA4B;AAQtE","ignoreList":[]}
+{"version":3,"file":"index.js","names":["NULL_VALUE","DistanceUnitMapping","DurationMapping","isOk","TimeseriesDurationMapping"],"sources":["index.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type { ActionReturnTypeForOptions } from \"./actions/ActionReturnTypeForOptions.js\";\nexport type {\n  ActionEditResponse,\n  ActionParam,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n} from \"./actions/Actions.js\";\nexport { NULL_VALUE } from \"./actions/NullValue.js\";\nexport type { ValidAggregationKeys } from \"./aggregate/AggregatableKeys.js\";\nexport type { AggregateOpts } from \"./aggregate/AggregateOpts.js\";\nexport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"./aggregate/AggregateOptsThatErrors.js\";\nexport type { AggregationResultsWithGroups } from \"./aggregate/AggregationResultsWithGroups.js\";\nexport type { AggregationResultsWithoutGroups } from \"./aggregate/AggregationResultsWithoutGroups.js\";\nexport type { AggregationClause } from \"./aggregate/AggregationsClause.js\";\nexport type { AggregationsResults } from \"./aggregate/AggregationsResults.js\";\nexport type { GeoFilterOptions } from \"./aggregate/GeoFilter.js\";\nexport { DistanceUnitMapping } from \"./aggregate/WhereClause.js\";\nexport type {\n  GeoFilter_Intersects,\n  GeoFilter_Within,\n  PossibleWhereClauseFilters,\n  WhereClause,\n} from \"./aggregate/WhereClause.js\";\nexport type {\n  OsdkObjectCreatePropertyType,\n  OsdkObjectPropertyType,\n} from \"./Definitions.js\";\nexport type {\n  OsdkObjectLinksObject,\n  SingleLinkAccessor,\n} from \"./definitions/LinkDefinitions.js\";\nexport type { DerivedProperty } from \"./derivedProperties/DerivedProperty.js\";\nexport { DurationMapping } from \"./groupby/GroupByClause.js\";\nexport type {\n  AllGroupByValues,\n  GroupByClause,\n  GroupByRange,\n} from \"./groupby/GroupByClause.js\";\nexport type {\n  AllowedBucketKeyTypes,\n  AllowedBucketTypes,\n  DataValueClientToWire,\n  DataValueWireToClient,\n} from \"./mapping/DataValueMapping.js\";\nexport type {\n  PropertyValueWireToClient,\n} from \"./mapping/PropertyValueMapping.js\";\nexport type { Attachment, AttachmentUpload } from \"./object/Attachment.js\";\nexport type {\n  AsyncIterArgs,\n  Augment,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  ObjectSetArgs,\n  SelectArg,\n  SelectArgToKeys,\n} from \"./object/FetchPageArgs.js\";\nexport type {\n  FetchPageResult,\n  SingleOsdkResult,\n} from \"./object/FetchPageResult.js\";\nexport type {\n  Media,\n  MediaMetadata,\n  MediaReference,\n  MediaUpload,\n} from \"./object/Media.js\";\nexport { isOk } from \"./object/Result.js\";\nexport type { Result } from \"./object/Result.js\";\nexport type { BaseObjectSet } from \"./objectSet/BaseObjectSet.js\";\nexport type { ObjectSet } from \"./objectSet/ObjectSet.js\";\nexport type { ObjectSetSubscription } from \"./objectSet/ObjectSetListener.js\";\nexport type {\n  ActionDefinition,\n  ActionMetadata,\n} from \"./ontology/ActionDefinition.js\";\nexport type {\n  InterfaceDefinition,\n  InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nexport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nexport type { ObjectSpecifier } from \"./ontology/ObjectSpecifier.js\";\nexport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n  ObjectTypeDefinition,\n  PropertyDef,\n  VersionBound,\n} from \"./ontology/ObjectTypeDefinition.js\";\nexport type { OntologyMetadata } from \"./ontology/OntologyMetadata.js\";\nexport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nexport type {\n  ObjectQueryDataType,\n  ObjectSetQueryDataType,\n  QueryDataTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  QueryParameterDefinition,\n  ThreeDimensionalQueryAggregationDefinition,\n  TwoDimensionalQueryAggregationDefinition,\n} from \"./ontology/QueryDefinition.js\";\nexport type {\n  BaseWirePropertyTypes,\n  WirePropertyTypes,\n} from \"./ontology/WirePropertyTypes.js\";\nexport type {\n  ObjectIdentifiers,\n  OsdkBase,\n  PrimaryKeyType,\n} from \"./OsdkBase.js\";\nexport type { OsdkObject } from \"./OsdkObject.js\";\nexport type { ConvertProps, Osdk } from \"./OsdkObjectFrom.js\";\nexport type { PageResult } from \"./PageResult.js\";\nexport type {\n  Range,\n  ThreeDimensionalAggregation,\n  TwoDimensionalAggregation,\n} from \"./queries/Aggregations.js\";\nexport type { QueryParam, QueryResult } from \"./queries/Queries.js\";\nexport { TimeseriesDurationMapping } from \"./timeseries/timeseries.js\";\nexport type {\n  GeotimeSeriesProperty,\n  TimeSeriesPoint,\n  TimeSeriesProperty,\n  TimeSeriesQuery,\n} from \"./timeseries/timeseries.js\";\nexport type { LinkedType, LinkNames } from \"./util/LinkUtils.js\";\nexport {};\nexport type { Logger } from \"./Logger.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,SAASA,UAAU,QAAQ,wBAAwB;AASnD,SAASC,mBAAmB,QAAQ,4BAA4B;AAgBhE,SAASC,eAAe,QAAQ,4BAA4B;AAoC5D,SAASC,IAAI,QAAQ,oBAAoB;AAuDzC,SAASC,yBAAyB,QAAQ,4BAA4B;AAQtE","ignoreList":[]}

package/build/browser/mapping/PropertyValueMapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyValueMapping.js","names":[],"sources":["PropertyValueMapping.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Attachment, AttachmentUpload } from \"../object/Attachment.js\";\nimport type { Media } from \"../object/Media.js\";\nimport type {\n  GeotimeSeriesProperty,\n  TimeSeriesProperty,\n} from \"../timeseries/timeseries.js\";\n\n/**\n * Map from the PropertyDefinition type to the typescript type that we return\n */\nexport interface PropertyValueWireToClient {\n  attachment: Attachment;\n  boolean: boolean;\n  byte: number;\n  datetime: string;\n  decimal: string;\n  double: number;\n  float: number;\n  geopoint: GeoJSON.Point;\n  geoshape: GeoJSON.GeoJSON;\n  integer: number;\n  long: string;\n  marking: string;\n  mediaReference: Media;\n  short: number;\n  string: string;\n  timestamp: string;\n  numericTimeseries: TimeSeriesProperty<number>;\n  stringTimeseries: TimeSeriesProperty<string>;\n  sensorTimeseries: TimeSeriesProperty<string | number>;\n  geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n}\n\nexport type GetClientPropertyValueFromWire<\n  T extends\n    | keyof PropertyValueWireToClient\n    | Record<string, keyof PropertyValueWireToClient>,\n> = T extends keyof PropertyValueWireToClient ? PropertyValueWireToClient[T]\n  : T extends Record<string, keyof PropertyValueWireToClient>\n    ? { [K in keyof T]: PropertyValueWireToClient[T[K]] }\n  : never;\n\n/**\n * Map from the PropertyDefinition type to the typescript type that we accept\n */\nexport interface PropertyValueClientToWire {\n  attachment: string | AttachmentUpload | Blob & { readonly name: string };\n  boolean: boolean;\n  byte: number;\n  datetime: string;\n  decimal: string | number;\n  double: number;\n  float: number;\n  geopoint: GeoJSON.Point;\n  geoshape: GeoJSON.GeoJSON;\n  integer: number;\n  long: string | number;\n  marking: string;\n  short: number;\n  string: string;\n  timestamp: string;\n  mediaReference: Media;\n  numericTimeseries: TimeSeriesProperty<number>;\n  stringTimeseries: TimeSeriesProperty<string>;\n  sensorTimeseries: TimeSeriesProperty<string | number>;\n  geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n}\nexport type GetWirePropertyValueFromClient<\n  T extends\n    | keyof PropertyValueClientToWire\n    | Record<string, keyof PropertyValueClientToWire>,\n> = T extends keyof PropertyValueClientToWire ? PropertyValueClientToWire[T]\n  : T extends Record<string, keyof PropertyValueClientToWire>\n    ? { [K in keyof T]: PropertyValueClientToWire[T[K]] }\n  : never;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"PropertyValueMapping.js","names":[],"sources":["PropertyValueMapping.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Attachment, AttachmentUpload } from \"../object/Attachment.js\";\nimport type { Media } from \"../object/Media.js\";\nimport type {\n  GeotimeSeriesProperty,\n  TimeSeriesProperty,\n} from \"../timeseries/timeseries.js\";\n\n/**\n * Map from the PropertyDefinition type to the typescript type that we return\n */\nexport interface PropertyValueWireToClient {\n  attachment: Attachment;\n  boolean: boolean;\n  byte: number;\n  datetime: string;\n  decimal: string;\n  double: number;\n  float: number;\n  geopoint: GeoJSON.Point;\n  geoshape: GeoJSON.GeoJSON;\n  integer: number;\n  long: string;\n  marking: string;\n  mediaReference: Media;\n  short: number;\n  string: string;\n  timestamp: string;\n  numericTimeseries: TimeSeriesProperty<number>;\n  stringTimeseries: TimeSeriesProperty<string>;\n  sensorTimeseries: TimeSeriesProperty<string | number>;\n  geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n  vector: number[];\n}\n\nexport type GetClientPropertyValueFromWire<\n  T extends\n    | keyof PropertyValueWireToClient\n    | Record<string, keyof PropertyValueWireToClient>,\n> = T extends keyof PropertyValueWireToClient ? PropertyValueWireToClient[T]\n  : T extends Record<string, keyof PropertyValueWireToClient>\n    ? { [K in keyof T]: PropertyValueWireToClient[T[K]] }\n  : never;\n\n/**\n * Map from the PropertyDefinition type to the typescript type that we accept\n */\nexport interface PropertyValueClientToWire {\n  attachment: string | AttachmentUpload | Blob & { readonly name: string };\n  boolean: boolean;\n  byte: number;\n  datetime: string;\n  decimal: string | number;\n  double: number;\n  float: number;\n  geopoint: GeoJSON.Point;\n  geoshape: GeoJSON.GeoJSON;\n  integer: number;\n  long: string | number;\n  marking: string;\n  short: number;\n  string: string;\n  timestamp: string;\n  mediaReference: Media;\n  numericTimeseries: TimeSeriesProperty<number>;\n  stringTimeseries: TimeSeriesProperty<string>;\n  sensorTimeseries: TimeSeriesProperty<string | number>;\n  geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n  vector: number[];\n}\nexport type GetWirePropertyValueFromClient<\n  T extends\n    | keyof PropertyValueClientToWire\n    | Record<string, keyof PropertyValueClientToWire>,\n> = T extends keyof PropertyValueClientToWire ? PropertyValueClientToWire[T]\n  : T extends Record<string, keyof PropertyValueClientToWire>\n    ? { [K in keyof T]: PropertyValueClientToWire[T[K]] }\n  : never;\n\nexport interface PropertyValueWireToCreate {\n  attachment: Attachment | string;\n  boolean: boolean;\n  byte: number;\n  datetime: string;\n  decimal: string;\n  double: number;\n  float: number;\n  geopoint: GeoJSON.Point;\n  geoshape: GeoJSON.GeoJSON;\n  integer: number;\n  long: string;\n  marking: string;\n  mediaReference: Media;\n  short: number;\n  string: string;\n  timestamp: string;\n  numericTimeseries: TimeSeriesProperty<number>;\n  stringTimeseries: TimeSeriesProperty<string>;\n  sensorTimeseries: TimeSeriesProperty<string | number>;\n  geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;\n  vector: number[];\n}\n\nexport type GetCreatePropertyValueFromWire<\n  T extends\n    | keyof PropertyValueWireToCreate\n    | Record<string, keyof PropertyValueWireToCreate>,\n> = T extends keyof PropertyValueWireToCreate ? PropertyValueWireToCreate[T]\n  : T extends Record<string, keyof PropertyValueWireToCreate>\n    ? { [K in keyof T]: PropertyValueWireToCreate[T[K]] }\n  : never;\n"],"mappings":"","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 { DerivedPropertyCreator } from \"../derivedProperties/DerivedProperty.js\";\nimport type {\n  AsyncIterArgs,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  ObjectSetArgs,\n  SelectArg,\n} from \"../object/FetchPageArgs.js\";\nimport type { Result } from \"../object/Result.js\";\nimport type {\n  DerivedObjectOrInterfaceDefinition,\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectTypeDefinition,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { PrimaryKeyType } from \"../OsdkBase.js\";\nimport type {\n  ExtractAllPropertiesOption,\n  ExtractOptions,\n  ExtractRidOption,\n  Osdk,\n} from \"../OsdkObjectFrom.js\";\nimport type { PageResult } from \"../PageResult.js\";\nimport type { LinkedType, LinkNames } from \"../util/LinkUtils.js\";\nimport type { BaseObjectSet } from \"./BaseObjectSet.js\";\nimport type { ObjectSetSubscription } from \"./ObjectSetListener.js\";\n\ntype MergeObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n  D extends Record<string, SimplePropertyDef> = {},\n> = DerivedObjectOrInterfaceDefinition.WithDerivedProperties<Q, D>;\n\ntype ExtractRdp<\n  D extends\n    | BaseObjectSet<any>\n    | Record<string, SimplePropertyDef>,\n> = [D] extends [never] ? {}\n  : D extends BaseObjectSet<any> ? {}\n  : D extends Record<string, SimplePropertyDef> ? D\n  : {};\n\ntype MaybeSimplifyPropertyKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends PropertyKeys<Q>,\n> = PropertyKeys<Q> extends L ? PropertyKeys<Q> : L & PropertyKeys<Q>;\n\ntype SubSelectKeysHelper<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends string,\n> = [L] extends [never] ? PropertyKeys<Q>\n  : PropertyKeys<Q> extends L ? PropertyKeys<Q>\n  : L & PropertyKeys<Q>;\n\ntype SubSelectKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  X extends SelectArg<Q, PropertyKeys<Q>, any, any> = never,\n> = SubSelectKeysHelper<Q, Extract$Select<X>>;\n\ntype NOOP<T> = T extends (...args: any[]) => any ? T\n  : T extends abstract new(...args: any[]) => any ? T\n  : { [K in keyof T]: T[K] };\n\ntype SubSelectRDPsHelper<\n  X extends ValidFetchPageArgs<any, any> | 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> | 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> extends\n  BaseObjectSet<Q>,\n  FetchPage<Q, RDPs>,\n  AsyncIter<Q, RDPs>,\n  Where<Q, RDPs>\n{\n}\n\nexport type ExtractOptions2<\n  X extends FetchPageArgs<any, any, any, any, any, any, any>,\n> = [X] extends [never] ? never\n  :\n    | ExtractRidOption<X[\"$includeRid\"] extends true ? true : false>\n    | ExtractAllPropertiesOption<\n      X[\"$includeAllBaseObjectProperties\"] extends true ? true : false\n    >;\n\ntype Extract$Select<X extends FetchPageArgs<any, any>> = NonNullable<\n  X[\"$select\"]\n>[number];\n\ninterface FetchPage<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  readonly fetchPage: FetchPageSignature<Q, RDPs>;\n  readonly fetchPageWithErrors: FetchPageWithErrorsSignature<Q, RDPs>;\n}\n\ntype ValidFetchPageArgs<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> = ObjectSetArgs.FetchPage<\n  Q,\n  PropertyKeys<Q>,\n  boolean,\n  string & keyof RDPs\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  >(\n    args?: FetchPageArgs<Q, L, R, A, S, T>,\n  ): Promise<\n    PageResult<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, T>,\n        NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n        SubSelectRDPs<RDPs, NonNullable<typeof args>>\n      >\n    >\n  >;\n}\n\ninterface FetchPageWithErrorsSignature<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Gets a page of objects of this type, with a result wrapper\n   * @param args - Args to specify next page token and page size, if applicable\n   * @example\n   *  const myObjs = await objectSet.fetchPage({\n      $pageSize: 10,\n      $nextPageToken: \"nextPage\"\n    });\n\n     if(isOk(myObjs)){\n     const myObjsResult = myObjs.value.data;\n    }\n   * @returns a page of objects, wrapped in a result wrapper\n   */\n  <\n    L extends PropertyKeys<Q> | (string & keyof RDPs),\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n    T extends boolean = false,\n  >(\n    args?: FetchPageArgs<Q, L, R, A, S, T>,\n  ): Promise<\n    Result<\n      PageResult<\n        Osdk.Instance<\n          Q,\n          ExtractOptions<R, S, T>,\n          NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n          SubSelectRDPs<RDPs, NonNullable<typeof args>>\n        >\n      >\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> {\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  >(\n    args?: AsyncIterArgs<Q, L, R, A, S, T>,\n  ): AsyncIterableIterator<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S, T>,\n      NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n      SubSelectRDPs<RDPs, NonNullable<typeof args>>\n    >\n  >;\n}\n\ninterface AsyncIter<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  asyncIter: AsyncIterSignature<Q, RDPs>;\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]: DerivedPropertyCreator<Q, NEW[K]> },\n  ) => ObjectSet<\n    Q,\n    {\n      [NN in keyof NEW | keyof RDPs]: NN extends keyof NEW ? NEW[NN]\n        : NN extends keyof RDPs ? RDPs[NN]\n        : never;\n    }\n  >;\n}\n\nexport interface ObjectSet<\n  Q extends ObjectOrInterfaceDefinition = any,\n  // Generated code has what is basically ObjectSet<Q> set in here\n  // but we never used it so I am repurposing it for RDP\n  UNUSED_OR_RDP extends\n    | BaseObjectSet<Q>\n    | Record<string, SimplePropertyDef> = never,\n> extends\n  ObjectSetCleanedTypes<\n    Q,\n    ExtractRdp<UNUSED_OR_RDP>,\n    MergeObjectSet<Q, ExtractRdp<UNUSED_OR_RDP>>\n  >\n{\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface Aggregate<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Aggregate on a field in an object type\n   * @param req - an aggregation request where you can select fields and choose how to aggregate, e.g., max, min, avg, and also choose\n   * whether or not you order your results. You can also specify a groupBy field to group your aggregations\n   * @example\n   * const testAggregateCountWithGroups = await client(BoundariesUsState)\n    .aggregate({\n      $select: {\n        $count: \"unordered\",\n        \"latitude:max\": \"unordered\",\n        \"latitude:min\": \"unordered\",\n        \"latitude:avg\": \"unordered\",\n      },\n      $groupBy: {\n        usState: \"exact\",\n        longitude: {\n          $fixedWidth: 10,\n        },\n      },\n    });\n\n   * @returns aggregation results, sorted in the groups based on the groupBy clause (if applicable)\n   */\n  readonly aggregate: <AO extends AggregateOpts<Q>>(\n    req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>,\n  ) => Promise<AggregationsResults<Q, AO>>;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface SetArithmetic<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Unions object sets together\n   * @param objectSets - objectSets you want to union with\n   * @example\n   * const unionObjectSet = complexFilteredEmployeeObjectSet.union(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the unioned object set\n   */\n  readonly union: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n\n  /**\n   * Computes the intersection of object sets\n   * @param objectSets - objectSets you want to intersect with\n   * @example\n   * const intersectedObjectSet = complexFilteredEmployeeObjectSet.intersect(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the intersected object set\n   */\n  readonly intersect: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n\n  /**\n   * Computes the subtraction of object sets\n   * @param objectSets - objectSets you want to subtract from\n   * @example\n   * const subtractObjectSet = complexFilteredEmployeeObjectSet.subtract(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the subtract object set\n   */\n  readonly subtract: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface PivotTo<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Pivots the object set over to all its linked objects of the specified type\n   * @param type - The linked object type you want to pivot to\n   * @returns an object set of the specified linked type\n   */\n  readonly pivotTo: <L extends LinkNames<Q>>(\n    type: L,\n  ) => ObjectSet<LinkedType<Q, L>>;\n}\n\ninterface FetchOneSignature<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  /**\n   * Fetches one object with the specified primary key, without a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q> | (string & keyof RDPs),\n    const R extends boolean,\n    const S extends false | \"throw\" = NullabilityAdherence.Default,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S>,\n  ): Promise<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S>,\n      NoInfer<SubSelectKeys<Q, { $select: Array<L> }>>,\n      SubSelectRDPs<RDPs, { $select: Array<L> }>\n    >\n  >;\n}\n\ninterface FetchOneWithErrorsSignature<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  /**\n   * Fetches one object with the specified primary key, with a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q> | (string & keyof RDPs),\n    const R extends boolean,\n    const S extends false | \"throw\" = NullabilityAdherence.Default,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S>,\n  ): Promise<\n    Result<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S>,\n        NoInfer<SubSelectKeys<Q, { $select: Array<L> }>>,\n        SubSelectRDPs<RDPs, { $select: Array<L> }>\n      >\n    >\n  >;\n}\n\ninterface FetchOne<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  fetchOne: Q extends ObjectTypeDefinition ? FetchOneSignature<Q, RDPs> : never;\n  fetchOneWithErrors: Q extends ObjectTypeDefinition\n    ? FetchOneWithErrorsSignature<Q, RDPs>\n    : never;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface Subscribe<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Request updates when the objects in an object set are added, updated, or removed.\n   * @param listener - The handlers to be executed during the lifecycle of the subscription.\n   * @param opts - Options to modify what properties are returned on subscription updates.\n   * @returns an object containing a function to unsubscribe.\n   */\n  readonly subscribe: <\n    const P extends PropertyKeys<Q>,\n  >(\n    listener: ObjectSetSubscription.Listener<Q, P>,\n    opts?: ObjectSetSubscription.Options<Q, P>,\n  ) => { unsubscribe: () => void };\n}\n\ninterface ObjectSetCleanedTypes<\n  Q extends ObjectOrInterfaceDefinition,\n  D extends Record<string, SimplePropertyDef>,\n  MERGED extends ObjectOrInterfaceDefinition & Q,\n> extends\n  MinimalObjectSet<Q, D>,\n  WithProperties<Q, D>,\n  Aggregate<MERGED>,\n  SetArithmetic<MERGED>,\n  PivotTo<Q>,\n  FetchOne<Q, D>,\n  Subscribe<MERGED>\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 { DerivedPropertyCreator } from \"../derivedProperties/DerivedProperty.js\";\nimport type {\n  AsyncIterArgs,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  ObjectSetArgs,\n  SelectArg,\n} from \"../object/FetchPageArgs.js\";\nimport type { Result } from \"../object/Result.js\";\nimport type {\n  DerivedObjectOrInterfaceDefinition,\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectTypeDefinition,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { PrimaryKeyType } from \"../OsdkBase.js\";\nimport type {\n  ExtractAllPropertiesOption,\n  ExtractOptions,\n  ExtractRidOption,\n  Osdk,\n} from \"../OsdkObjectFrom.js\";\nimport type { PageResult } from \"../PageResult.js\";\nimport type { LinkedType, LinkNames } from \"../util/LinkUtils.js\";\nimport type { BaseObjectSet } from \"./BaseObjectSet.js\";\nimport type { ObjectSetSubscription } from \"./ObjectSetListener.js\";\n\ntype MergeObjectSet<\n  Q extends ObjectOrInterfaceDefinition,\n  D extends Record<string, SimplePropertyDef> = {},\n> = DerivedObjectOrInterfaceDefinition.WithDerivedProperties<Q, D>;\n\ntype ExtractRdp<\n  D extends\n    | BaseObjectSet<any>\n    | Record<string, SimplePropertyDef>,\n> = [D] extends [never] ? {}\n  : D extends BaseObjectSet<any> ? {}\n  : D extends Record<string, SimplePropertyDef> ? D\n  : {};\n\ntype MaybeSimplifyPropertyKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends PropertyKeys<Q>,\n> = PropertyKeys<Q> extends L ? PropertyKeys<Q> : L & PropertyKeys<Q>;\n\ntype SubSelectKeysHelper<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends string,\n> = [L] extends [never] ? PropertyKeys<Q>\n  : PropertyKeys<Q> extends L ? PropertyKeys<Q>\n  : L & PropertyKeys<Q>;\n\ntype SubSelectKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  X extends SelectArg<Q, PropertyKeys<Q>, any, any> = never,\n> = SubSelectKeysHelper<Q, Extract$Select<X>>;\n\ntype NOOP<T> = T extends (...args: any[]) => any ? T\n  : T extends abstract new(...args: any[]) => any ? T\n  : { [K in keyof T]: T[K] };\n\ntype SubSelectRDPsHelper<\n  X extends ValidFetchPageArgs<any, any> | 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> | 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> extends\n  BaseObjectSet<Q>,\n  FetchPage<Q, RDPs>,\n  AsyncIter<Q, RDPs>,\n  Where<Q, RDPs>\n{\n}\n\nexport type ExtractOptions2<\n  X extends FetchPageArgs<any, any, any, any, any, any, any>,\n> = [X] extends [never] ? never\n  :\n    | ExtractRidOption<X[\"$includeRid\"] extends true ? true : false>\n    | ExtractAllPropertiesOption<\n      X[\"$includeAllBaseObjectProperties\"] extends true ? true : false\n    >;\n\ntype Extract$Select<X extends FetchPageArgs<any, any>> = NonNullable<\n  X[\"$select\"]\n>[number];\n\ninterface FetchPage<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  readonly fetchPage: FetchPageSignature<Q, RDPs>;\n  readonly fetchPageWithErrors: FetchPageWithErrorsSignature<Q, RDPs>;\n}\n\ntype ValidFetchPageArgs<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> = ObjectSetArgs.FetchPage<\n  Q,\n  PropertyKeys<Q>,\n  boolean,\n  string & keyof RDPs\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  >(\n    args?: FetchPageArgs<Q, L, R, A, S, T>,\n  ): Promise<\n    PageResult<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S, T>,\n        NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n        SubSelectRDPs<RDPs, NonNullable<typeof args>>\n      >\n    >\n  >;\n}\n\ninterface NearestNeighbors<Q extends ObjectOrInterfaceDefinition> {\n  /**\n   * Finds the nearest neighbors for a given text or vector within the object set.\n   *\n   * @param query - Queries support either a vector matching the embedding model defined on the property, or text that is\n        automatically embedded.\n   * @param numNeighbors - The number of objects to return. If the number of documents in the objectType is less than the provided\n            value, all objects will be returned. This value is limited to 1 &le; numNeighbors &ge; 500.\n   * @param property - The property key with a defined embedding model to search over.\n   *\n   * @returns An object set containing the `numNeighbors` nearest neighbors. To return the objects ordered by relevance and each\n   * objects associated score, specify \"relevance\" in the orderBy.\n */\n\n  readonly nearestNeighbors: (\n    query: string | number[],\n    numNeighbors: number,\n    property: PropertyKeys.Filtered<Q, \"vector\">,\n  ) => this;\n}\n\ninterface FetchPageWithErrorsSignature<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  /**\n   * Gets a page of objects of this type, with a result wrapper\n   * @param args - Args to specify next page token and page size, if applicable\n   * @example\n   *  const myObjs = await objectSet.fetchPage({\n      $pageSize: 10,\n      $nextPageToken: \"nextPage\"\n    });\n\n     if(isOk(myObjs)){\n     const myObjsResult = myObjs.value.data;\n    }\n   * @returns a page of objects, wrapped in a result wrapper\n   */\n  <\n    L extends PropertyKeys<Q> | (string & keyof RDPs),\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n    T extends boolean = false,\n  >(\n    args?: FetchPageArgs<Q, L, R, A, S, T>,\n  ): Promise<\n    Result<\n      PageResult<\n        Osdk.Instance<\n          Q,\n          ExtractOptions<R, S, T>,\n          NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n          SubSelectRDPs<RDPs, NonNullable<typeof args>>\n        >\n      >\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> {\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  >(\n    args?: AsyncIterArgs<Q, L, R, A, S, T>,\n  ): AsyncIterableIterator<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S, T>,\n      NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>,\n      SubSelectRDPs<RDPs, NonNullable<typeof args>>\n    >\n  >;\n}\n\ninterface AsyncIter<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  asyncIter: AsyncIterSignature<Q, RDPs>;\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]: DerivedPropertyCreator<Q, NEW[K]> },\n  ) => ObjectSet<\n    Q,\n    {\n      [NN in keyof NEW | keyof RDPs]: NN extends keyof NEW ? NEW[NN]\n        : NN extends keyof RDPs ? RDPs[NN]\n        : never;\n    }\n  >;\n}\n\nexport interface ObjectSet<\n  Q extends ObjectOrInterfaceDefinition = any,\n  // Generated code has what is basically ObjectSet<Q> set in here\n  // but we never used it so I am repurposing it for RDP\n  UNUSED_OR_RDP extends\n    | BaseObjectSet<Q>\n    | Record<string, SimplePropertyDef> = never,\n> extends\n  ObjectSetCleanedTypes<\n    Q,\n    ExtractRdp<UNUSED_OR_RDP>,\n    MergeObjectSet<Q, ExtractRdp<UNUSED_OR_RDP>>\n  >\n{\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface Aggregate<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Aggregate on a field in an object type\n   * @param req - an aggregation request where you can select fields and choose how to aggregate, e.g., max, min, avg, and also choose\n   * whether or not you order your results. You can also specify a groupBy field to group your aggregations\n   * @example\n   * const testAggregateCountWithGroups = await client(BoundariesUsState)\n    .aggregate({\n      $select: {\n        $count: \"unordered\",\n        \"latitude:max\": \"unordered\",\n        \"latitude:min\": \"unordered\",\n        \"latitude:avg\": \"unordered\",\n      },\n      $groupBy: {\n        usState: \"exact\",\n        longitude: {\n          $fixedWidth: 10,\n        },\n      },\n    });\n\n   * @returns aggregation results, sorted in the groups based on the groupBy clause (if applicable)\n   */\n  readonly aggregate: <AO extends AggregateOpts<Q>>(\n    req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>,\n  ) => Promise<AggregationsResults<Q, AO>>;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface SetArithmetic<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Unions object sets together\n   * @param objectSets - objectSets you want to union with\n   * @example\n   * const unionObjectSet = complexFilteredEmployeeObjectSet.union(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the unioned object set\n   */\n  readonly union: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n\n  /**\n   * Computes the intersection of object sets\n   * @param objectSets - objectSets you want to intersect with\n   * @example\n   * const intersectedObjectSet = complexFilteredEmployeeObjectSet.intersect(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the intersected object set\n   */\n  readonly intersect: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n\n  /**\n   * Computes the subtraction of object sets\n   * @param objectSets - objectSets you want to subtract from\n   * @example\n   * const subtractObjectSet = complexFilteredEmployeeObjectSet.subtract(\n    simpleFilteredEmployeeObjectSet,\n  );\n   * @returns the subtract object set\n   */\n  readonly subtract: (\n    ...objectSets: ReadonlyArray<CompileTimeMetadata<Q>[\"objectSet\"]>\n  ) => this;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface PivotTo<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Pivots the object set over to all its linked objects of the specified type\n   * @param type - The linked object type you want to pivot to\n   * @returns an object set of the specified linked type\n   */\n  readonly pivotTo: <L extends LinkNames<Q>>(\n    type: L,\n  ) => ObjectSet<LinkedType<Q, L>>;\n}\n\ninterface FetchOneSignature<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  /**\n   * Fetches one object with the specified primary key, without a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q> | (string & keyof RDPs),\n    const R extends boolean,\n    const S extends false | \"throw\" = NullabilityAdherence.Default,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S>,\n  ): Promise<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S>,\n      NoInfer<SubSelectKeys<Q, { $select: Array<L> }>>,\n      SubSelectRDPs<RDPs, { $select: Array<L> }>\n    >\n  >;\n}\n\ninterface FetchOneWithErrorsSignature<\n  Q extends ObjectTypeDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  /**\n   * Fetches one object with the specified primary key, with a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q> | (string & keyof RDPs),\n    const R extends boolean,\n    const S extends false | \"throw\" = NullabilityAdherence.Default,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: SelectArg<Q, L, R, S>,\n  ): Promise<\n    Result<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S>,\n        NoInfer<SubSelectKeys<Q, { $select: Array<L> }>>,\n        SubSelectRDPs<RDPs, { $select: Array<L> }>\n      >\n    >\n  >;\n}\n\ninterface FetchOne<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  fetchOne: Q extends ObjectTypeDefinition ? FetchOneSignature<Q, RDPs> : never;\n  fetchOneWithErrors: Q extends ObjectTypeDefinition\n    ? FetchOneWithErrorsSignature<Q, RDPs>\n    : never;\n}\n\n// Q is the merged type here! Not renaming to keep diff small. Rename in follow up\ninterface Subscribe<\n  Q extends ObjectOrInterfaceDefinition,\n> {\n  /**\n   * Request updates when the objects in an object set are added, updated, or removed.\n   * @param listener - The handlers to be executed during the lifecycle of the subscription.\n   * @param opts - Options to modify what properties are returned on subscription updates.\n   * @returns an object containing a function to unsubscribe.\n   */\n  readonly subscribe: <\n    const P extends PropertyKeys<Q>,\n  >(\n    listener: ObjectSetSubscription.Listener<Q, P>,\n    opts?: ObjectSetSubscription.Options<Q, P>,\n  ) => { unsubscribe: () => void };\n}\n\ninterface ObjectSetCleanedTypes<\n  Q extends ObjectOrInterfaceDefinition,\n  D extends Record<string, SimplePropertyDef>,\n  MERGED extends ObjectOrInterfaceDefinition & Q,\n> extends\n  MinimalObjectSet<Q, D>,\n  WithProperties<Q, D>,\n  Aggregate<MERGED>,\n  SetArithmetic<MERGED>,\n  PivotTo<Q>,\n  FetchOne<Q, D>,\n  Subscribe<MERGED>,\n  NearestNeighbors<Q>\n{\n}\n"],"mappings":"","ignoreList":[]}

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

@@ -48,6 +48,9 @@ export function createMockObjectSet() {
     }),
     pivotTo: vi.fn(() => {
       return fauxObjectSet;
+    }),
+    nearestNeighbors: vi.fn(() => {
+      return fauxObjectSet;
     })
   };
   return fauxObjectSet;
@@ -109,7 +112,7 @@ describe("ObjectSet", () => {
         // this select list is intended to represent all properties on `EmployeeApiTest`,
         // so if you get an error here later and you added properties to that object,
         // be sure to add them here too.
-        $select: ["attachment", "class", "employeeId", "fullName", "geopoint", "geotimeSeriesReference", "isActive", "mediaReference", "timeseries", "dateOfJoining", "hourlyRate", "yearsOfExperience", "rank", "performanceScore", "mediaReference", "lastUpdated"]
+        $select: ["attachment", "class", "employeeId", "fullName", "geopoint", "geotimeSeriesReference", "isActive", "mediaReference", "timeseries", "dateOfJoining", "hourlyRate", "yearsOfExperience", "rank", "performanceScore", "mediaReference", "lastUpdated", "skillSet", "skillSetEmbedding"]
       });
       await fauxObjectSet.where({
         class: "idk"
@@ -118,7 +121,7 @@ describe("ObjectSet", () => {
         // this select list is intended to represent all properties on `EmployeeApiTest`,
         // so if you get an error here later and you added properties to that object,
         // be sure to add them here too.
-        $select: ["attachment", "class", "employeeId", "fullName", "geopoint", "geotimeSeriesReference", "isActive", "mediaReference", "timeseries", "dateOfJoining", "hourlyRate", "yearsOfExperience", "rank", "performanceScore", "mediaReference", "lastUpdated"]
+        $select: ["attachment", "class", "employeeId", "fullName", "geopoint", "geotimeSeriesReference", "isActive", "mediaReference", "timeseries", "dateOfJoining", "hourlyRate", "yearsOfExperience", "rank", "performanceScore", "mediaReference", "lastUpdated", "skillSet", "skillSetEmbedding"]
       });
     });
   });
@@ -191,7 +194,7 @@ describe("ObjectSet", () => {
         await withFamily.fetchPage();
         expectTypeOf().toEqualTypeOf();
       });
-      it("collectToSet, collectToList, selectProperty, and numeric aggregations are nullable", async () => {
+      it("collectSet, collectList, selectProperty, and numeric aggregations are nullable", async () => {
         const withAggregations = fauxObjectSet.withProperties({
           "collectSet": base => base.pivotTo("lead").aggregate("class:collectSet"),
           "select": base => base.pivotTo("lead").selectProperty("fullName"),
@@ -257,7 +260,7 @@ describe("ObjectSet", () => {
       });
       it("Works with selecting all non-RDP's", async () => {
         await withFamily.fetchPage({
-          $select: ["employeeId", "fullName", "class", "attachment", "geopoint", "timeseries", "mediaReference", "geotimeSeriesReference", "isActive", "yearsOfExperience", "rank", "performanceScore", "hourlyRate", "dateOfJoining", "lastUpdated"]
+          $select: ["employeeId", "fullName", "class", "attachment", "geopoint", "timeseries", "mediaReference", "geotimeSeriesReference", "isActive", "yearsOfExperience", "rank", "performanceScore", "hourlyRate", "dateOfJoining", "lastUpdated", "skillSet", "skillSetEmbedding"]
         });
         expectTypeOf().toEqualTypeOf();
         expectTypeOf().toEqualTypeOf();
@@ -571,5 +574,33 @@ describe("ObjectSet", () => {
       // it("allows correctly typed property keys off the base OT", () => {});
     });
   });
+  describe("nearestNeighbors", () => {
+    it("has correct nearest neighbors object set query return type", () => {
+      const nearestNeighborsObjectSet = fauxObjectSet.nearestNeighbors("textQuery", 3, "skillSetEmbedding");
+      expectTypeOf(nearestNeighborsObjectSet).toEqualTypeOf();
+    });
+    it("allows text queries", async () => {
+      const nearestNeighborsObjectSet = fauxObjectSet.nearestNeighbors("textQuery", 3, "skillSetEmbedding");
+      const {
+        data: employees
+      } = await nearestNeighborsObjectSet.fetchPage();
+      expectTypeOf(employees).toEqualTypeOf();
+    });
+    it("allows vector queries", async () => {
+      const vectorQuery = Array.from({
+        length: 1536
+      }, () => 0.3);
+      const nearestNeighborsObjectSet = fauxObjectSet.nearestNeighbors(vectorQuery, 3, "skillSetEmbedding");
+      const {
+        data: employees
+      } = await nearestNeighborsObjectSet.fetchPage();
+      expectTypeOf(employees).toEqualTypeOf();
+    });
+    it("only supports queries on vector properties", () => {
+      fauxObjectSet.nearestNeighbors("textQuery", 3,
+      // @ts-expect-error
+      "skillSet");
+    });
+  });
 });
 //# sourceMappingURL=ObjectSet.test.js.map