@osdk/api 2.2.0-beta.8 → 2.3.0-beta.1

package/build/browser/object/FetchPageResult.js.map

@@ -1 +1 @@
-{"version":3,"file":"FetchPageResult.js","names":[],"sources":["FetchPageResult.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { ExtractOptions, IsNever, Osdk } from \"../OsdkObjectFrom.js\";\nimport type { PageResult } from \"../PageResult.js\";\nimport type { NullabilityAdherence } from \"./FetchPageArgs.js\";\n\n/** exposed for a test */\nexport type RespectNullability<S extends NullabilityAdherence> = S extends false\n  ? false\n  : true;\n\n/** exposed for a test */\nexport type UnionIfFalse<S extends string, JUST_S_IF_TRUE extends boolean, E> =\n  IsNever<S> extends true ? never\n    : JUST_S_IF_TRUE extends true ? S\n    : S | E;\n\n/** exposed for a test */\nexport type UnionIfTrue<\n  S extends string,\n  UNION_IF_TRUE extends boolean,\n  E extends string,\n> = IsNever<S> extends true ? never\n  : UNION_IF_TRUE extends true ? S | E\n  : S;\n\n/**\n * Helper type for converting fetch options into an Osdk object\n */\nexport type FetchPageResult<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends PropertyKeys<Q>,\n  R extends boolean,\n  S extends NullabilityAdherence,\n> = PageResult<\n  PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S>>\n    : Osdk.Instance<Q, ExtractOptions<R, S>, L>\n>;\n\n/**\n * Helper type for converting fetch options into an Osdk object\n */\nexport type SingleOsdkResult<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends PropertyKeys<Q> | (keyof RDPs & string),\n  R extends boolean,\n  S extends NullabilityAdherence,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> = Osdk.Instance<\n  Q,\n  ExtractOptions<R, S>,\n  PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L,\n  { [K in Extract<keyof RDPs, L>]: RDPs[K] }\n>;\n\nexport type IsAny<T> = unknown extends T\n  ? [keyof T] extends [never] ? false : true\n  : false;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"FetchPageResult.js","names":[],"sources":["FetchPageResult.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { ExtractOptions, IsNever, Osdk } from \"../OsdkObjectFrom.js\";\nimport type { PageResult } from \"../PageResult.js\";\nimport type { NullabilityAdherence } from \"./FetchPageArgs.js\";\n\n/** exposed for a test */\nexport type RespectNullability<S extends NullabilityAdherence> = S extends false\n  ? false\n  : true;\n\n/** exposed for a test */\nexport type UnionIfFalse<S extends string, JUST_S_IF_TRUE extends boolean, E> =\n  IsNever<S> extends true ? never\n    : JUST_S_IF_TRUE extends true ? S\n    : S | E;\n\n/** exposed for a test */\nexport type UnionIfTrue<\n  S extends string,\n  UNION_IF_TRUE extends boolean,\n  E extends string,\n> = IsNever<S> extends true ? never\n  : UNION_IF_TRUE extends true ? S | E\n  : S;\n\n/**\n * Helper type for converting fetch options into an Osdk object\n */\nexport type FetchPageResult<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends PropertyKeys<Q>,\n  R extends boolean,\n  S extends NullabilityAdherence,\n  T extends boolean = false,\n> = PageResult<\n  PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S, T>>\n    : Osdk.Instance<Q, ExtractOptions<R, S, T>, L>\n>;\n\n/**\n * Helper type for converting fetch options into an Osdk object\n */\nexport type SingleOsdkResult<\n  Q extends ObjectOrInterfaceDefinition,\n  L extends PropertyKeys<Q> | (keyof RDPs & string),\n  R extends boolean,\n  S extends NullabilityAdherence,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n  T extends boolean = false,\n> = Osdk.Instance<\n  Q,\n  ExtractOptions<R, S, T>,\n  PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L,\n  { [K in Extract<keyof RDPs, L>]: RDPs[K] }\n>;\n\nexport type IsAny<T> = unknown extends T\n  ? [keyof T] extends [never] ? false : true\n  : false;\n"],"mappings":"","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"BulkLinkResult.js","names":[],"sources":["BulkLinkResult.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 { OsdkBase } from \"../OsdkBase.js\";\n\nexport interface EXPERIMENTAL_BulkLinkResult {\n  object: OsdkBase<any>;\n  linkApiName: string;\n  otherObjectApiName: string | undefined;\n  otherObjectPk: unknown;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"BulkLinkResult.js","names":[],"sources":["BulkLinkResult.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 { OsdkBase } from \"../OsdkBase.js\";\n\nexport interface EXPERIMENTAL_BulkLinkResult {\n  object: OsdkBase<any>;\n  linkApiName: string;\n  otherObjectApiName: string | null | undefined;\n  otherObjectPk: unknown;\n}\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 { DerivedProperty } from \"../derivedProperties/DerivedProperty.js\";\nimport type {\n  AsyncIterArgs,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  SelectArg,\n} from \"../object/FetchPageArgs.js\";\nimport type { Result } from \"../object/Result.js\";\nimport type { InterfaceDefinition } from \"../ontology/InterfaceDefinition.js\";\nimport type {\n  DerivedObjectOrInterfaceDefinition,\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectTypeDefinition,\n} from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { PrimaryKeyType } from \"../OsdkBase.js\";\nimport type { ExtractOptions, Osdk } 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 ObjectSet<Q> | Record<string, SimplePropertyDef> = {},\n> = D extends Record<string, SimplePropertyDef>\n  ? DerivedObjectOrInterfaceDefinition.WithDerivedProperties<Q, D>\n  : Q;\n\ntype ExtractRdp<\n  D extends ObjectSet<any, any> | Record<string, SimplePropertyDef>,\n> = D extends Record<string, SimplePropertyDef> ? D : {};\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\n// TODO MOVE THIS\ninterface FetchPage<\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  readonly fetchPage: <\n    L extends PropertyKeys<Q, RDPs>,\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n  >(\n    args?: FetchPageArgs<Q, L, R, A, S>,\n  ) => Promise<\n    PageResult<\n      Osdk.Instance<\n        Q,\n        ExtractOptions<R, S>,\n        PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L,\n        { [K in Extract<keyof RDPs, L>]: RDPs[K] }\n      >\n    >\n  >;\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  readonly fetchPageWithErrors: <\n    L extends PropertyKeys<Q, RDPs>,\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n  >(\n    args?: FetchPageArgs<Q, L, R, A, S>,\n  ) => Promise<\n    Result<\n      PageResult<\n        Osdk.Instance<\n          Q,\n          ExtractOptions<R, S>,\n          PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L,\n          { [K in Extract<keyof RDPs, L>]: RDPs[K] }\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 AsyncIter<\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  readonly asyncIter: <\n    L extends PropertyKeys<Q, RDPs>,\n    R extends boolean,\n    const A extends Augments,\n    S extends NullabilityAdherence = NullabilityAdherence.Default,\n  >(\n    args?: AsyncIterArgs<Q, L, R, A, S>,\n  ) => AsyncIterableIterator<\n    Osdk.Instance<\n      Q,\n      ExtractOptions<R, S>,\n      PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L,\n      { [K in Extract<keyof RDPs, L>]: RDPs[K] }\n    >\n  >;\n}\n\ninterface InterfaceObjectSet<\n  Q extends InterfaceDefinition,\n> extends MinimalObjectSet<Q> {\n}\n\ninterface WithProperties<\n  Q extends ObjectOrInterfaceDefinition = any,\n  RDPs extends Record<string, SimplePropertyDef> = {},\n> {\n  readonly withProperties: <\n    NEW extends Record<string, SimplePropertyDef>,\n  >(\n    clause: { [K in keyof NEW]: DerivedProperty.Selector<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 ObjectSet<Q, any> | Record<string, SimplePropertyDef> =\n    ObjectSet<Q, any>,\n> extends\n  ObjectSetCleanedTypes<\n    Q,\n    ExtractRdp<UNUSED_OR_RDP>,\n    MergeObjectSet<Q, 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  ) => CompileTimeMetadata<LinkedType<Q, L>>[\"objectSet\"]; // ObjectSet<LinkedType<Q, L>>;\n}\n\ninterface FetchOne<\n  Q extends ObjectOrInterfaceDefinition,\n  RDPs extends Record<string, SimplePropertyDef>,\n> {\n  /**\n   * Fetches one object with the specified primary key, without a result wrapper\n   */\n  readonly fetchOne: Q extends ObjectTypeDefinition ? <\n      const L extends PropertyKeys<Q, 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        PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L,\n        { [K in Extract<keyof RDPs, L>]: RDPs[K] }\n      >\n    >\n    : never;\n\n  /**\n   * Fetches one object with the specified primary key, with a result wrapper\n   */\n  readonly fetchOneWithErrors: Q extends ObjectTypeDefinition ? <\n      L extends PropertyKeys<Q, RDPs>,\n      R extends boolean,\n      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          PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L,\n          { [K in Extract<keyof RDPs, L>]: RDPs[K] }\n        >\n      >\n    >\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,\n> extends\n  MinimalObjectSet<Q, D>,\n  WithProperties<Q, D>,\n  Aggregate<MERGED>,\n  SetArithmetic<MERGED>,\n  PivotTo<MERGED>,\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;\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> =\n  | ObjectSetArgs.FetchPage<\n    Q,\n    PropertyKeys<Q>,\n    false,\n    string & keyof RDPs\n  >\n  | ObjectSetArgs.FetchPage<\n    Q,\n    never,\n    true,\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  <const X extends ValidFetchPageArgs<Q, RDPs> = never>(\n    args?: X,\n  ): Promise<\n    PageResult<\n      Osdk.Instance<\n        Q,\n        ExtractOptions2<X>,\n        SubSelectKeys<Q, X>,\n        SubSelectRDPs<RDPs, X>\n      >\n    >\n  >;\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>,\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        MaybeSimplifyPropertyKeys<Q, L>\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  <X extends ValidFetchPageArgs<Q, RDPs> = never>(\n    args?: X,\n  ): Promise<\n    Result<\n      PageResult<\n        Osdk.Instance<\n          Q,\n          ExtractOptions2<X>,\n          SubSelectKeys<Q, X>,\n          SubSelectRDPs<RDPs, X>\n        >\n      >\n    >\n  >;\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>,\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          MaybeSimplifyPropertyKeys<Q, L>\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>,\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      MaybeSimplifyPropertyKeys<Q, L>\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    X extends ObjectSetArgs.Select<PropertyKeys<Q>, string & keyof RDPs> =\n      never,\n  >(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: X,\n  ): Promise<\n    Osdk.Instance<\n      Q,\n      ExtractOptions2<X>,\n      SubSelectKeys<Q, X>,\n      SubSelectRDPs<RDPs, X>\n    >\n  >;\n\n  /**\n   * Fetches one object with the specified primary key, without a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q>,\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      MaybeSimplifyPropertyKeys<Q, 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  <X extends ObjectSetArgs.Select<PropertyKeys<Q>, string & keyof RDPs>>(\n    primaryKey: PrimaryKeyType<Q>,\n    options?: X,\n  ): Promise<\n    Result<\n      Osdk.Instance<\n        Q,\n        ExtractOptions2<X>,\n        SubSelectKeys<Q, X>,\n        SubSelectRDPs<RDPs, X>\n      >\n    >\n  >;\n\n  /**\n   * Fetches one object with the specified primary key, with a result wrapper\n   */\n  <\n    const L extends PropertyKeys<Q>,\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        MaybeSimplifyPropertyKeys<Q, 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":[]}

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

@@ -15,23 +15,53 @@
  */
 
 import { describe, expectTypeOf, it, test, vi } from "vitest";
-describe("ObjectSet", () => {
-  const fauxObjectSet = {
+export function createMockObjectSet() {
+  let fauxObject, fauxResults, fauxObjectSet;
+
+  // eslint-disable-next-line prefer-const
+  fauxObject = {
+    $link: {
+      peeps: {
+        $objectSetInternals: {
+          def: {}
+        }
+      }
+    }
+  };
+  fauxResults = {
+    data: [fauxObject]
+  };
+  fauxObjectSet = {
     where: vi.fn(() => {
       return fauxObjectSet;
     }),
     withProperties: vi.fn(() => {
       return fauxObjectSet;
     }),
-    fetchPage: vi.fn(() => Promise.resolve()),
+    fetchPage: vi.fn(() => Promise.resolve(fauxResults)),
+    fetchOne: vi.fn(() => fauxObject),
     asyncIter: vi.fn(() => {
       return {};
+    }),
+    aggregate: vi.fn(() => {
+      return {};
+    }),
+    pivotTo: vi.fn(() => {
+      return fauxObjectSet;
     })
   };
+  return fauxObjectSet;
+}
+describe("ObjectSet", () => {
+  const fauxObjectSet = createMockObjectSet();
   describe("normal", () => {
     test("select none", async () => {
       await fauxObjectSet.fetchPage();
       expectTypeOf().toEqualTypeOf();
+
+      // Do it again but be explicit about the params to be sure
+      // we don't break them
+      await fauxObjectSet.fetchPage();
     });
     test("select one", async () => {
       await fauxObjectSet.fetchPage({
@@ -40,6 +70,73 @@ describe("ObjectSet", () => {
       expectTypeOf().toEqualTypeOf();
     });
   });
+  describe("includeAllBaseObjectProperties", () => {
+    it("has the right types if you pass true", async () => {
+      const fetchPageResult = await fauxObjectSet.where({
+        class: "idk"
+      }).fetchPage({
+        $includeAllBaseObjectProperties: true
+      });
+      expectTypeOf(fetchPageResult).toEqualTypeOf();
+      const asyncIterResult = fauxObjectSet.where({
+        class: "idk"
+      }).asyncIter({
+        $includeAllBaseObjectProperties: true
+      });
+      expectTypeOf(asyncIterResult).toEqualTypeOf();
+    });
+    it("does not let you pass partial $select and true", async () => {
+      await fauxObjectSet.where({
+        class: "idk"
+      }).fetchPage({
+        // @ts-expect-error
+        $includeAllBaseObjectProperties: true,
+        $select: ["attachment"]
+      });
+      fauxObjectSet.where({
+        class: "idk"
+      }).asyncIter({
+        // @ts-expect-error
+        $includeAllBaseObjectProperties: true,
+        $select: ["attachment"]
+      });
+    });
+    it("does let you pass full select options and false", async () => {
+      await fauxObjectSet.where({
+        class: "idk"
+      }).fetchPage({
+        $includeAllBaseObjectProperties: true,
+        // 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"]
+      });
+      await fauxObjectSet.where({
+        class: "idk"
+      }).fetchPage({
+        $includeAllBaseObjectProperties: true,
+        // 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"]
+      });
+    });
+  });
+  test("includeRid", async () => {
+    const x = await fauxObjectSet.where({
+      class: "idk"
+    }).fetchPage({
+      $includeRid: true
+    });
+    expectTypeOf(x).toEqualTypeOf();
+  });
+  test("pivotTo", async () => {
+    await fauxObjectSet.pivotTo("peeps").fetchPage({});
+    const subselect = await fauxObjectSet.pivotTo("peeps").fetchPage({
+      $select: ["employeeId", "class"]
+    });
+    expectTypeOf(subselect).toEqualTypeOf();
+  });
   describe(".withProperties", () => {
     test("single property", async () => {
       const withA = fauxObjectSet.withProperties({
@@ -52,6 +149,13 @@ describe("ObjectSet", () => {
       expectTypeOf().toEqualTypeOf();
       expectTypeOf().toEqualTypeOf();
     });
+    it("can be sub-selected", () => {
+      fauxObjectSet.withProperties({
+        "derivedPropertyName": base => base.pivotTo("lead").selectProperty("employeeId")
+      }).fetchOne(3, {
+        $select: ["derivedPropertyName"]
+      });
+    });
     test("multiple properties", async () => {
       const withFamily = fauxObjectSet.withProperties({
         "mom": base => base.pivotTo("lead").aggregate("$count"),
@@ -112,9 +216,23 @@ describe("ObjectSet", () => {
         const where = withFamily.where({
           "mom": 1
         });
-        await where.fetchPage();
+        const whereResults = await where.fetchPage();
+
+        // Checks that if you did an `await where.fetchPage()` that you can then
+        // pass/assign it to something explicit.
+        // Checks that if you did an `await where.fetchPage()` that you can then
+        // pass/assign it to something explicit.
+        whereResults.data[0];
+        whereResults.data[0].$link.peeps.$objectSetInternals.def; // same as above but with expectTypeOf
         expectTypeOf().toEqualTypeOf();
         expectTypeOf().toEqualTypeOf();
+
+        // Checks that when you directly assign, it infers correctly.
+        // Sometimes an explicit assignment can affect how typescript infers
+        // types.
+        await where.fetchPage();
+        await withFamily.fetchOne(1);
+        await withFamily.fetchOne(1);
       });
       it("works with .async", () => {
         withFamily.asyncIter();
@@ -139,7 +257,7 @@ describe("ObjectSet", () => {
       });
       it("Works with selecting all non-RDP's", async () => {
         await withFamily.fetchPage({
-          $select: ["class", "fullName", "employeeId"]
+          $select: ["employeeId", "fullName", "class", "attachment", "geopoint", "timeseries", "mediaReference", "geotimeSeriesReference", "isActive", "yearsOfExperience", "rank", "performanceScore", "hourlyRate", "dateOfJoining", "lastUpdated"]
         });
         expectTypeOf().toEqualTypeOf();
         expectTypeOf().toEqualTypeOf();
@@ -171,6 +289,282 @@ describe("ObjectSet", () => {
         "mom": base => base.pivotTo("lead").aggregate("$count")
       });
     });
+    it("has correct aggregation keys", () => {
+      fauxObjectSet.withProperties({
+        "integer": base => base.pivotTo("lead").aggregate("$count"),
+        "integerNumericAgg": base => base.pivotTo("lead").aggregate("employeeId:sum"),
+        "string": base => base.pivotTo("lead").aggregate("class:collectList"),
+        "stringDoesNotHaveNumericAgg": base =>
+        // @ts-expect-error
+        base.pivotTo("lead").aggregate("class:sum"),
+        "isActive": base => base.pivotTo("lead").aggregate("isActive:approximateDistinct"),
+        "attachment": base => base.pivotTo("lead").aggregate("attachment:collectList"),
+        "geopoint": base => base.pivotTo("lead").aggregate("geopoint:collectList"),
+        "numericTimeseries": base =>
+        // @ts-expect-error
+        base.pivotTo("lead").aggregate("timeseries:sum"),
+        "numericTimeseriesExactDistinct": base => base.pivotTo("lead").aggregate("timeseries:exactDistinct"),
+        "mediaReference": base =>
+        // @ts-expect-error
+        base.pivotTo("lead").aggregate("mediaReference:avg"),
+        "mediaReferenceExactDistinct": base => base.pivotTo("lead").aggregate("mediaReference:exactDistinct"),
+        "geotimeSeriesReference": base =>
+        // @ts-expect-error
+        base.pivotTo("lead").aggregate("geotimeSeriesReference:sum"),
+        "geotimeSeriesReferenceExactDistinct": base => base.pivotTo("lead").aggregate("geotimeSeriesReference:exactDistinct"),
+        "lastUpdated": base => {
+          base.pivotTo("lead").aggregate("lastUpdated:approximateDistinct");
+          base.pivotTo("lead").aggregate("lastUpdated:exactDistinct");
+          base.pivotTo("lead").aggregate("lastUpdated:max");
+          base.pivotTo("lead").aggregate("lastUpdated:min");
+          base.pivotTo("lead").aggregate("lastUpdated:collectList");
+          return base.pivotTo("lead").aggregate("lastUpdated:collectSet");
+        },
+        "dateOfJoining": base => {
+          base.pivotTo("lead").aggregate("dateOfJoining:approximateDistinct");
+          base.pivotTo("lead").aggregate("dateOfJoining:exactDistinct");
+          base.pivotTo("lead").aggregate("dateOfJoining:max");
+          base.pivotTo("lead").aggregate("dateOfJoining:min");
+          base.pivotTo("lead").aggregate("dateOfJoining:collectList");
+          return base.pivotTo("lead").aggregate("dateOfJoining:collectSet");
+        }
+      });
+    });
+    it("has correct aggregation return types", async () => {
+      const aggTestObjectSet = fauxObjectSet.withProperties({
+        "maxHasSameType": base => base.pivotTo("lead").aggregate("dateOfJoining:max"),
+        "minHasSameType": base => base.pivotTo("lead").aggregate("dateOfJoining:min"),
+        "approximateDistinctNumberNoUndefined": base => base.pivotTo("lead").aggregate("employeeId:approximateDistinct"),
+        "exactDistinctNumberNoUndefined": base => base.pivotTo("lead").aggregate("employeeId:exactDistinct"),
+        "countNumberNoUndefined": base => base.pivotTo("lead").aggregate("$count"),
+        "sumNumber": base => base.pivotTo("lead").aggregate("employeeId:sum"),
+        "avgNumber": base => base.pivotTo("lead").aggregate("employeeId:avg")
+      }).fetchPage();
+      const result = (await aggTestObjectSet).data[0];
+      expectTypeOf((await aggTestObjectSet).data[0]).toEqualTypeOf();
+      expectTypeOf(result.maxHasSameType).toEqualTypeOf();
+      expectTypeOf(result.minHasSameType).toEqualTypeOf();
+      expectTypeOf(result.approximateDistinctNumberNoUndefined).toEqualTypeOf();
+      expectTypeOf(result.exactDistinctNumberNoUndefined).toEqualTypeOf();
+      expectTypeOf(result.countNumberNoUndefined).toEqualTypeOf();
+      expectTypeOf(result.sumNumber).toEqualTypeOf();
+      expectTypeOf(result.avgNumber).toEqualTypeOf();
+    });
+  });
+  describe("aggregate", () => {
+    it("has correct aggregation keys", () => {
+      void fauxObjectSet.aggregate({
+        "$select": {
+          "lastUpdated:max": "asc",
+          "lastUpdated:min": "desc",
+          "lastUpdated:approximateDistinct": "asc",
+          "lastUpdated:exactDistinct": "desc",
+          "dateOfJoining:max": "desc",
+          "dateOfJoining:min": "asc",
+          "dateOfJoining:approximateDistinct": "asc",
+          "dateOfJoining:exactDistinct": "desc"
+        }
+      });
+    });
+  });
+  describe("expressions", () => {
+    "Test all property types";
+
+    describe("numeric expressions", () => {
+      it("provides correct methods off of selected numeric derived property definitions", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const selectedInteger = base.pivotTo("lead").selectProperty("employeeId");
+            expectTypeOf(selectedInteger).toEqualTypeOf;
+            selectedInteger.add(1);
+            selectedInteger.subtract(1);
+            selectedInteger.multiply(1);
+            selectedInteger.divide(1);
+            selectedInteger.abs();
+            selectedInteger.negate();
+            selectedInteger.max(1);
+            selectedInteger.min(1);
+
+            // @ts-expect-error
+            selectedInteger.extractPart("1");
+            expectTypeOf(base.pivotTo("lead").selectProperty("performanceScore")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("rank")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("yearsOfExperience")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("hourlyRate")).toEqualTypeOf();
+            return selectedInteger;
+          }
+        });
+      });
+      it("provides correct methods off of selection definitions", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const selectedInteger = base.pivotTo("lead").selectProperty("employeeId");
+            expectTypeOf(selectedInteger).toEqualTypeOf;
+            selectedInteger.add(1);
+            selectedInteger.subtract(1);
+            selectedInteger.multiply(1);
+            selectedInteger.divide(1);
+            selectedInteger.abs();
+            selectedInteger.negate();
+            selectedInteger.max(1);
+            selectedInteger.min(1);
+
+            // @ts-expect-error
+            selectedInteger.extractPart("1");
+            expectTypeOf(base.pivotTo("lead").selectProperty("performanceScore")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("rank")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("yearsOfExperience")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("lead").selectProperty("hourlyRate")).toEqualTypeOf();
+            return selectedInteger;
+          }
+        });
+      });
+      it("provides correct methods off of aggregated properties", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const maxAggregation = base.pivotTo("lead").aggregate("employeeId:max");
+            expectTypeOf(maxAggregation).toEqualTypeOf;
+            maxAggregation.add(1);
+            maxAggregation.subtract(1);
+            maxAggregation.multiply(1);
+            maxAggregation.divide(1);
+            maxAggregation.abs();
+            maxAggregation.negate();
+            maxAggregation.max(1);
+            maxAggregation.min(1);
+            expectTypeOf(base.pivotTo("peeps").aggregate("employeeId:sum")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("peeps").aggregate("employeeId:avg")).toEqualTypeOf();
+            expectTypeOf(base.pivotTo("peeps").aggregate("employeeId:min")).toEqualTypeOf();
+            const collectList = base.pivotTo("peeps").aggregate("employeeId:collectList");
+            expectTypeOf(collectList).toEqualTypeOf();
+
+            // @ts-expect-error
+            collectList.plus(1);
+            expectTypeOf(base.pivotTo("peeps").aggregate("employeeId:collectList")).toEqualTypeOf();
+            return maxAggregation;
+          }
+        });
+      });
+      it("correctly coerces numeric types", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const intAndLong = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("yearsOfExperience")).add(base.selectProperty("employeeId"));
+            expectTypeOf(intAndLong).toEqualTypeOf();
+            const intAndDouble = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("performanceScore")).add(base.selectProperty("employeeId"));
+            expectTypeOf(intAndDouble).toEqualTypeOf();
+            const longAndDouble = base.pivotTo("lead").selectProperty("yearsOfExperience").add(base.selectProperty("performanceScore")).add(base.selectProperty("yearsOfExperience"));
+            expectTypeOf(longAndDouble).toEqualTypeOf();
+            const longAndLong = base.pivotTo("lead").selectProperty("yearsOfExperience").add(base.selectProperty("yearsOfExperience"));
+            expectTypeOf(longAndLong).toEqualTypeOf();
+            const intAndInt = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("employeeId"));
+            expectTypeOf(intAndInt).toEqualTypeOf();
+            const intLongDoubleChain = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("yearsOfExperience")).add(base.selectProperty("employeeId")).add(base.selectProperty("performanceScore")).add(base.selectProperty("employeeId"));
+            expectTypeOf(intLongDoubleChain).toEqualTypeOf();
+            const shortAndIntReturnsInt = base.pivotTo("lead").selectProperty("rank").add(base.selectProperty("employeeId"));
+            expectTypeOf(shortAndIntReturnsInt).toEqualTypeOf();
+            const shortAndFloatReturnsDouble = base.pivotTo("lead").selectProperty("rank").add(base.selectProperty("hourlyRate"));
+            expectTypeOf(shortAndFloatReturnsDouble).toEqualTypeOf();
+            return intLongDoubleChain;
+          }
+        });
+      });
+      it("allows adding number literals as a double", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const plus = base.pivotTo("lead").selectProperty("employeeId").add(1);
+            expectTypeOf(plus).toEqualTypeOf();
+            return plus;
+          }
+        });
+      });
+      it("allows adding literals via base.constant", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const plus = base.pivotTo("lead").selectProperty("employeeId").add(base.constant.double(1));
+            expectTypeOf(plus).toEqualTypeOf();
+            const intPlusIntReturnsInt = base.pivotTo("lead").selectProperty("employeeId").add(base.constant.integer(1));
+            expectTypeOf(intPlusIntReturnsInt).toEqualTypeOf();
+            return plus;
+          }
+        });
+      });
+      it("allows correctly typed nested property definitions", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const nested = base.pivotTo("lead").selectProperty("employeeId").add(base.pivotTo("peeps").aggregate("employeeId:sum"));
+            expectTypeOf(nested).toEqualTypeOf();
+            return nested;
+          }
+        });
+      });
+      it("allows correctly types property keys off the linked OT", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const nested = base.pivotTo("lead").selectProperty("employeeId").add(base.selectProperty("performanceScore"));
+            expectTypeOf(nested).toEqualTypeOf();
+            return nested;
+          }
+        });
+      });
+
+      // it("allows correctly types property keys off the base OT", () => {});
+    });
+    describe("datetime expressions", () => {
+      it("provides correct methods off of datetime selections", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const selectedDatetime = base.pivotTo("lead").selectProperty("dateOfJoining");
+            expectTypeOf(selectedDatetime).toEqualTypeOf();
+            selectedDatetime.max(base.selectProperty("dateOfJoining"));
+            selectedDatetime.min(base.selectProperty("lastUpdated"));
+            expectTypeOf(base.pivotTo("lead").selectProperty("lastUpdated")).toEqualTypeOf();
+            return selectedDatetime;
+          }
+        });
+      });
+      it("correctly coerces datetime types", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const max = base.pivotTo("lead").selectProperty("dateOfJoining").max(base.selectProperty("lastUpdated"));
+            expectTypeOf(max).toEqualTypeOf();
+            const min = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.selectProperty("dateOfJoining"));
+            expectTypeOf(min).toEqualTypeOf();
+            return max;
+          }
+        });
+      });
+      it("allows adding literals via base.constant", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const dateAndDateReturnDate = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.constant.datetime("2025-01-01T00:00:00Z"));
+            expectTypeOf(dateAndDateReturnDate).toEqualTypeOf();
+            const dateAndTimeReturnTime = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.constant.timestamp("2025-01-01T00:00:00Z"));
+            expectTypeOf(dateAndTimeReturnTime).toEqualTypeOf();
+            return dateAndTimeReturnTime;
+          }
+        });
+      });
+      it("allows correctly typed nested property definitions", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const nested = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.pivotTo("lead").pivotTo("lead").selectProperty("lastUpdated"));
+            expectTypeOf(nested).toEqualTypeOf();
+            return nested;
+          }
+        });
+      });
+      it("allows correctly typed property keys off the linked OT", () => {
+        fauxObjectSet.withProperties({
+          "myProp1": base => {
+            const nested = base.pivotTo("lead").selectProperty("dateOfJoining").min(base.selectProperty("lastUpdated"));
+            expectTypeOf(nested).toEqualTypeOf();
+            return nested;
+          }
+        });
+      });
+
+      // it("allows correctly typed property keys off the base OT", () => {});
+    });
   });
 });
 //# sourceMappingURL=ObjectSet.test.js.map