Move objectset into client.api (#408)

* refactor objectset

* fix import issue

* reorganize index file

* Add change to prevent semantic merge conflict with my pr

* add changest

---------

Co-authored-by: Eric Anderson <[email protected]>

.changeset/tame-wolves-juggle.md

@@ -0,0 +1,6 @@
+---
+"@osdk/client.api": minor
+"@osdk/client": minor
+---
+
+Refactored packages to move types over to client.api

examples-extra/basic/cli/package.json

@@ -29,6 +29,7 @@
   "dependencies": {
     "@osdk/api": "workspace:^",
     "@osdk/client": "workspace:^",
+    "@osdk/client.api": "workspace:*",
     "@osdk/examples.basic.sdk": "workspace:^",
     "@osdk/foundry": "workspace:^",
     "@osdk/internal.foundry": "workspace:^",

examples-extra/basic/cli/src/demoStrictness.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import type { Osdk } from "@osdk/client";
+import type { Osdk } from "@osdk/client.api";
 import {
   BoundariesUsState,
   Employee,

examples-extra/basic/cli/src/legacy-examples/fetchEmployeePage.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import type { Client, Osdk } from "@osdk/client";
+import type { Client } from "@osdk/client";
+import type { Osdk } from "@osdk/client.api";
 import { Employee } from "@osdk/examples.basic.sdk";
 import { expectType } from "ts-expect";
 

examples-extra/basic/cli/src/runInterfacesTest.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import type { Osdk, PageResult } from "@osdk/client";
+import type { Osdk, PageResult } from "@osdk/client.api";
 import { Employee, FooInterface } from "@osdk/examples.basic.sdk";
 import invariant from "tiny-invariant";
 import type { TypeOf } from "ts-expect";

examples-extra/basic/cli/src/typeChecks.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import type { Client, ObjectSet, Osdk, PageResult } from "@osdk/client";
+import type { Client } from "@osdk/client";
+import type { ObjectSet, Osdk, PageResult } from "@osdk/client.api";
 import type { Employee } from "@osdk/examples.basic.sdk";
 import { Ontology } from "@osdk/examples.basic.sdk";
 import type { TypeOf } from "ts-expect";

examples-extra/todoapp/src/useTodos.tsx

@@ -1,10 +1,11 @@
-import { ActionValidationError, type Osdk } from "@osdk/client";
+import type { ObjectTypeDefinition } from "@osdk/api";
+import { ActionValidationError } from "@osdk/client";
+import type { Osdk } from "@osdk/client.api";
 import { useCallback, useEffect } from "react";
 import type { KeyedMutator } from "swr";
 import useSWR from "swr";
 import { $ } from "./foundryClient";
 import * as MyOsdk from "./generatedNoCheck2";
-import type { ObjectTypeDefinition } from "@osdk/api";
 
 declare global {
   interface ArrayConstructor {
@@ -16,7 +17,7 @@ declare global {
       iterableOrArrayLike:
         | AsyncIterable<T>
         | Iterable<T | PromiseLike<T>>
-        | ArrayLike<T | PromiseLike<T>>
+        | ArrayLike<T | PromiseLike<T>>,
     ): Promise<T[]>;
 
     /**
@@ -30,7 +31,7 @@ declare global {
     fromAsync<T, U>(
       iterableOrArrayLike: AsyncIterable<T> | Iterable<T> | ArrayLike<T>,
       mapFn: (value: Awaited<T>) => U,
-      thisArg?: any
+      thisArg?: any,
     ): Promise<Awaited<U>[]>;
   }
 }
@@ -39,11 +40,11 @@ export function useTodos() {
   const { data, isLoading, error, isValidating, mutate } = useSWR(
     "/todos",
     async () => await Array.fromAsync<SimpleTodo>($(MyOsdk.Todo).asyncIter()),
-    { keepPreviousData: true, revalidateOnFocus: false }
+    { keepPreviousData: true, revalidateOnFocus: false },
   );
 
   const toggleComplete = useCallback(
-    async function (todo: SimpleTodo) {
+    async function(todo: SimpleTodo) {
       const b = !todo.isComplete;
       await mutate(
         async () => {
@@ -57,10 +58,10 @@ export function useTodos() {
         {
           optimisticData: updateTodo.bind(undefined, todo.id!, b),
           rollbackOnError: true,
-        }
+        },
       );
     },
-    [mutate]
+    [mutate],
   );
 
   const createTodoMutator = useCallback(
@@ -87,7 +88,7 @@ export function useTodos() {
                     if (constraint.type === "stringLength") {
                       if (constraint.gte != null && constraint.lte != null) {
                         setError?.(
-                          `Todo must be between ${constraint.gte}-${constraint.lte} characters`
+                          `Todo must be between ${constraint.gte}-${constraint.lte} characters`,
                         );
                       }
                     }
@@ -105,11 +106,11 @@ export function useTodos() {
           optimisticData: (todos = []) => [...todos, createFauxTodo(title)],
           rollbackOnError: true,
           throwOnError: true,
-        }
+        },
       );
       return undefined;
     },
-    [mutate]
+    [mutate],
   );
 
   return {
@@ -122,7 +123,6 @@ export function useTodos() {
   };
 }
 
-
 type OsdkPropsOnly<T extends ObjectTypeDefinition<any>> = Omit<
   Osdk<T>,
   "$as" | "$link"
@@ -146,15 +146,15 @@ function createFauxTodo(title: string): SimpleTodo {
 function updateTodo(
   id: string,
   isComplete: boolean,
-  todos: SimpleTodo[] | undefined
+  todos: SimpleTodo[] | undefined,
 ): SimpleTodo[] {
   return updateOne(todos, id, (todo) => ({ ...todo, isComplete })) ?? [];
 }
 
 function updateOne<T extends { __primaryKey: Q }, Q>(
   things: T[] | undefined,
   primaryKey: Q,
-  update: (thing: T) => T
+  update: (thing: T) => T,
 ) {
   return things?.map((thing) => {
     if (thing.__primaryKey === primaryKey) {
@@ -182,15 +182,15 @@ export function useSubscribe(mutate: KeyedMutator<SimpleTodo[]>) {
           } else {
             byApiNameByPK.set(
               object.$apiName,
-              new Map([[object.$primaryKey, object]])
+              new Map([[object.$primaryKey, object]]),
             );
           }
         }
 
         // get the new version of an object that has changed, removing it from the list of updates
         const getUpdate = (
           apiName: (typeof objects)[0]["$apiName"],
-          primaryKey: (typeof objects)[0]["$primaryKey"]
+          primaryKey: (typeof objects)[0]["$primaryKey"],
         ) => {
           const byPk = byApiNameByPK.get(apiName);
           if (byPk) {
@@ -204,14 +204,13 @@ export function useSubscribe(mutate: KeyedMutator<SimpleTodo[]>) {
 
         mutate((data) => {
           // update any Todos that we got a new version for
-          const updated =
-            data?.map((object) => {
-              const updateObject = getUpdate(
-                object.$apiName,
-                object.$primaryKey
-              );
-              return updateObject ?? object;
-            }) ?? [];
+          const updated = data?.map((object) => {
+            const updateObject = getUpdate(
+              object.$apiName,
+              object.$primaryKey,
+            );
+            return updateObject ?? object;
+          }) ?? [];
 
           // add any new Todos to the bottom
           for (const byPk of byApiNameByPK.values()) {
@@ -235,6 +234,6 @@ export function useSubscribe(mutate: KeyedMutator<SimpleTodo[]>) {
 
     return function() {
       unsubscribe();
-    }
+    };
   }, [mutate]);
 }

packages/client.api/package.json

@@ -24,6 +24,9 @@
     "transpile": "tsup",
     "typecheck": "../../scripts/build_common/typecheck.sh esm"
   },
+  "dependencies": {
+    "@osdk/api": "workspace:^"
+  },
   "peerDependencies": {
     "@osdk/api": "workspace:^",
     "@osdk/internal.foundry": "workspace:^",

packages/client/src/OsdkObjectFrom.ts → packages/client.api/src/OsdkObjectFrom.ts

@@ -19,13 +19,11 @@ import type {
   ObjectOrInterfaceDefinition,
   ObjectTypeDefinition,
 } from "@osdk/api";
-import type {
-  OsdkBase,
-  OsdkObjectPrimaryKeyType,
-  OsdkObjectPropertyType,
-} from "@osdk/client.api";
+import type { OsdkObjectPropertyType } from "./Definitions.js";
 import type { OsdkObjectLinksObject } from "./definitions/LinkDefinitions.js";
 import type { UnionIfTrue } from "./object/FetchPageResult.js";
+import type { OsdkBase } from "./OsdkBase.js";
+import type { OsdkObjectPrimaryKeyType } from "./OsdkObjectPrimaryKeyType.js";
 
 type DropDollarOptions<T extends string> = Exclude<
   T,

packages/client.api/src/aggregate/AggregatableKeys.ts

@@ -15,7 +15,7 @@
  */
 
 import type { ObjectOrInterfaceDefinition } from "@osdk/api";
-import type { PropertyValueClientToWire } from "@osdk/client.api";
+import type { PropertyValueClientToWire } from "../mapping/PropertyValueMapping.js";
 
 export type StringAggregateOption = "approximateDistinct";
 export type NumericAggregateOption =

packages/client/src/definitions/LinkDefinitions.ts → packages/client.api/src/definitions/LinkDefinitions.ts

@@ -20,8 +20,8 @@ import type {
   ObjectTypeLinkDefinition,
   ObjectTypeLinkKeysFrom2,
 } from "@osdk/api";
-import type { Result } from "@osdk/client.api";
 import type { SelectArg, SelectArgToKeys } from "../object/FetchPageArgs.js";
+import type { Result } from "../object/Result.js";
 import type { ObjectSet } from "../objectSet/ObjectSet.js";
 import type { Osdk } from "../OsdkObjectFrom.js";
 

packages/client.api/src/index.ts

@@ -40,6 +40,7 @@ export type {
   UnorderedAggregationClause,
 } from "./aggregate/AggregationsClause.js";
 export type { AggregationsResults } from "./aggregate/AggregationsResults.js";
+export { DistanceUnitMapping } from "./aggregate/WhereClause.js";
 export type {
   AndWhereClause,
   GeoFilter,
@@ -50,14 +51,19 @@ export type {
   PossibleWhereClauseFilters,
   WhereClause,
 } from "./aggregate/WhereClause.js";
-export { DistanceUnitMapping } from "./aggregate/WhereClause.js";
 export type { OsdkObjectPropertyType } from "./Definitions.js";
+export type {
+  DefaultToFalse,
+  OsdkObjectLinksEntry,
+  OsdkObjectLinksObject,
+  SingleLinkAccessor,
+} from "./definitions/LinkDefinitions.js";
+export { DurationMapping } from "./groupby/GroupByClause.js";
 export type {
   AllGroupByValues,
   GroupByClause,
   GroupByRange,
 } from "./groupby/GroupByClause.js";
-export { DurationMapping } from "./groupby/GroupByClause.js";
 export type {
   PropertyValueClientToWire,
   PropertyValueWireToClient,
@@ -67,11 +73,42 @@ export type {
   AttachmentMetadata,
   AttachmentUpload,
 } from "./object/Attachment.js";
-export type { Result } from "./object/Result.js";
+export type {
+  Augment,
+  Augments,
+  FetchInterfacePageArgs,
+  FetchPageArgs,
+  NullabilityAdherence,
+  NullabilityAdherenceDefault,
+  OrderByArg,
+  SelectArg,
+  SelectArgToKeys,
+} from "./object/FetchPageArgs.js";
+export type {
+  FetchPageResult,
+  RespectNullability,
+  SingleOsdkResult,
+  UnionIfFalse,
+  UnionIfTrue,
+} from "./object/FetchPageResult.js";
 export { isOk } from "./object/Result.js";
+export type { Result } from "./object/Result.js";
 export type { BaseObjectSet } from "./objectSet/BaseObjectSet.js";
+export type {
+  InterfaceObjectSet,
+  MinimalObjectSet,
+  ObjectSet,
+} from "./objectSet/ObjectSet.js";
 export type { OsdkBase } from "./OsdkBase.js";
+export type { OsdkObject } from "./OsdkObject.js";
+export type {
+  ConvertProps,
+  Osdk,
+  OsdkObjectOrInterfaceFrom,
+  ValidToFrom,
+} from "./OsdkObjectFrom.js";
 export type { OsdkObjectPrimaryKeyType } from "./OsdkObjectPrimaryKeyType.js";
+export type { PageResult } from "./PageResult.js";
 export type { LinkedType, LinkNames } from "./util/LinkUtils.js";
 export type { NOOP } from "./util/NOOP.js";
 

packages/client/src/objectSet/ObjectSet.ts → packages/client.api/src/objectSet/ObjectSet.ts

@@ -20,17 +20,11 @@ import type {
   ObjectOrInterfacePropertyKeysFrom2,
   ObjectTypeDefinition,
 } from "@osdk/api";
-import type {
-  AggregateOpts,
-  AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy,
-  AggregationsResults,
-  BaseObjectSet,
-  LinkedType,
-  LinkNames,
-  PropertyValueClientToWire,
-  Result,
-  WhereClause,
-} from "@osdk/client.api";
+import type { AggregateOpts } from "../aggregate/AggregateOpts.js";
+import type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from "../aggregate/AggregateOptsThatErrors.js";
+import type { AggregationsResults } from "../aggregate/AggregationsResults.js";
+import type { WhereClause } from "../aggregate/WhereClause.js";
+import type { PropertyValueClientToWire } from "../mapping/PropertyValueMapping.js";
 import type {
   Augments,
   FetchPageArgs,
@@ -42,7 +36,10 @@ import type {
   FetchPageResult,
   SingleOsdkResult,
 } from "../object/FetchPageResult.js";
+import type { Result } from "../object/Result.js";
 import type { Osdk } from "../OsdkObjectFrom.js";
+import type { LinkedType, LinkNames } from "../util/LinkUtils.js";
+import type { BaseObjectSet } from "./BaseObjectSet.js";
 
 export interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition>
   extends BaseObjectSet<Q>

packages/client/src/Client.ts

@@ -19,10 +19,9 @@ import type {
   ObjectTypeDefinition,
   VersionBound,
 } from "@osdk/api";
-import type { ActionSignatureFromDef } from "@osdk/client.api";
+import type { ActionSignatureFromDef, ObjectSet } from "@osdk/client.api";
 import type { SharedClient } from "@osdk/shared.client";
 import type { MinimalClient } from "./MinimalClientContext.js";
-import type { ObjectSet } from "./objectSet/ObjectSet.js";
 import type { SatisfiesSemver } from "./SatisfiesSemver.js";
 
 export type CheckVersionBound<Q> = Q extends VersionBound<infer V> ? (

packages/client/src/ObjectSetCreator.ts

@@ -19,8 +19,8 @@ import type {
   ObjectOrInterfaceKeysFrom,
   OntologyDefinition,
 } from "@osdk/api";
+import type { ObjectSet } from "@osdk/client.api";
 import type { Client } from "./Client.js";
-import type { ObjectSet } from "./objectSet/ObjectSet.js";
 
 /**
  * A type that creates an object set for each object in the ontology.