@osdk/client 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @osdk/client
 
+## 0.2.1
+
+### Patch Changes
+
+- Updated dependencies [25dd12ae]
+  - @osdk/shared.net@1.0.2
+  - @osdk/gateway@1.0.2
+  - @osdk/api@1.0.2
+
 ## 0.2.0
 
 ### Minor Changes

package/build/types/Client.d.ts

@@ -1,10 +1,10 @@
-import type { InterfaceKeysFrom, ObjectTypeKeysFrom, OntologyDefinition } from "@osdk/api";
+import type { ObjectOrInterfaceKeysFrom, ObjectTypeKeysFrom, OntologyDefinition } from "@osdk/api";
 import type { Actions } from "./actions/Actions.js";
 import type { ObjectSet, ObjectSetOptions } from "./objectSet/ObjectSet.js";
 import type { ObjectSetCreator } from "./ObjectSetCreator.js";
 export type ConcreteObjectType<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = O["objects"][K];
 export interface Client<O extends OntologyDefinition<any>> {
-    objectSet: <const K extends ObjectTypeKeysFrom<O> | InterfaceKeysFrom<O>>(type: K, opts?: ObjectSetOptions<O, K>) => ObjectSet<O, K>;
+    objectSet: <const K extends ObjectOrInterfaceKeysFrom<O>>(type: K, opts?: ObjectSetOptions<O, K>) => ObjectSet<O, K>;
     objects: ObjectSetCreator<O>;
     actions: Actions<O>;
     __UNSTABLE_preexistingObjectSet<const K extends ObjectTypeKeysFrom<O>>(type: K, rid: string): ObjectSet<O, K>;

package/build/types/ObjectSetCreator.d.ts

@@ -1,11 +1,11 @@
-import type { InterfaceKeysFrom, ObjectTypeKeysFrom, OntologyDefinition } from "@osdk/api";
+import type { ObjectOrInterfaceKeysFrom, OntologyDefinition } from "@osdk/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.
  */
 export type ObjectSetCreator<D extends OntologyDefinition<any>> = {
-    [T in ObjectTypeKeysFrom<D> | InterfaceKeysFrom<D>]: ObjectSet<D, T>;
+    [T in ObjectOrInterfaceKeysFrom<D>]: ObjectSet<D, T>;
 };
 /**
  * Create a proxy for the object set creator.

package/build/types/index.d.ts

@@ -5,7 +5,7 @@ export type { ObjectSetListener } from "./objectSet/ObjectSetListener.js";
 export type { PageResult } from "./PageResult.js";
 export * as Objects from "./object/index.js";
 export type { OsdkObject } from "./OsdkObject.js";
-export type { OsdkObjectFrom } from "./OsdkObjectFrom.js";
+export type { OsdkInterfaceFrom, OsdkObjectFrom } from "./OsdkObjectFrom.js";
 export { createClientContext } from "@osdk/shared.net";
 export { isOk } from "@osdk/shared.net";
 export type { ResultOrError } from "@osdk/shared.net";

package/build/types/internal/conversions/modernToLegacyWhereClause.d.ts

@@ -1,4 +1,4 @@
-import type { ObjectTypeDefinition } from "@osdk/api";
+import type { ObjectOrInterfaceDefinition } from "@osdk/api";
 import type { WhereClause } from "../../query/index.js";
 import type { Wire } from "../net/index.js";
-export declare function modernToLegacyWhereClause<T extends ObjectTypeDefinition<any, any>>(whereClause: WhereClause<T>): Wire.SearchJsonQueryV2;
+export declare function modernToLegacyWhereClause<T extends ObjectOrInterfaceDefinition<any, any>>(whereClause: WhereClause<T>): Wire.SearchJsonQueryV2;

package/build/types/object/fetchPageOrThrow.d.ts

@@ -1,11 +1,11 @@
-import type { ObjectTypeKeysFrom, ObjectTypePropertyKeysFrom, OntologyDefinition } from "@osdk/api";
+import type { ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, OntologyDefinition } from "@osdk/api";
 import type { ClientContext } from "@osdk/shared.net";
 import type { Wire } from "../internal/net/index.js";
 import type { OsdkObjectFrom } from "../OsdkObjectFrom.js";
 import type { PageResult } from "../PageResult.js";
 import type { NOOP } from "../util/NOOP.js";
-export interface FetchPageOrThrowArgs<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>, L extends ObjectTypePropertyKeysFrom<O, K>> {
+export interface FetchPageOrThrowArgs<O extends OntologyDefinition<any>, K extends ObjectOrInterfaceKeysFrom<O>, L extends ObjectOrInterfacePropertyKeysFrom<O, K>> {
     select?: readonly L[];
     nextPageToken?: string;
 }
-export declare function fetchPageOrThrow<O extends OntologyDefinition<any>, T extends ObjectTypeKeysFrom<O>, const A extends FetchPageOrThrowArgs<O, T, ObjectTypePropertyKeysFrom<O, T>>>(client: ClientContext<O>, objectType: T & string, args: A, objectSet?: Wire.ObjectSet): Promise<PageResult<NOOP<OsdkObjectFrom<T, O, A["select"] extends readonly string[] ? A["select"][number] : ObjectTypePropertyKeysFrom<O, T>>>>>;
+export declare function fetchPageOrThrow<O extends OntologyDefinition<any>, T extends ObjectOrInterfaceKeysFrom<O>, const A extends FetchPageOrThrowArgs<O, T, ObjectOrInterfacePropertyKeysFrom<O, T>>>(client: ClientContext<O>, objectType: T & string, args: A, objectSet?: Wire.ObjectSet): Promise<PageResult<NOOP<OsdkObjectFrom<T, O, A["select"] extends readonly string[] ? A["select"][number] : ObjectOrInterfacePropertyKeysFrom<O, T>>>>>;

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

@@ -1,4 +1,4 @@
-import type { InterfaceKeysFrom, InterfacePropertyKeysFrom, ObjectTypeDefinitionFrom, ObjectTypeKeysFrom, ObjectTypePropertyKeysFrom, OntologyDefinition } from "@osdk/api";
+import type { InterfaceKeysFrom, ObjectOrInterfaceDefinitionFrom, ObjectOrInterfaceKeysFrom, ObjectOrInterfacePropertyKeysFrom, OntologyDefinition } from "@osdk/api";
 import type { FetchPageOrThrowArgs } from "../object/fetchPageOrThrow.js";
 import type { OsdkInterfaceFrom, OsdkObjectFrom } from "../OsdkObjectFrom.js";
 import type { PageResult } from "../PageResult.js";
@@ -6,15 +6,15 @@ import type { AggregateOpts } from "../query/aggregations/AggregateOpts.js";
 import type { AggregationsResults, WhereClause } from "../query/index.js";
 import type { LinkTypesFrom } from "./LinkTypesFrom.js";
 import type { ObjectSetListener } from "./ObjectSetListener.js";
-export type ObjectSet<O extends OntologyDefinition<string>, K extends ObjectTypeKeysFrom<O> | InterfaceKeysFrom<O>> = BaseObjectSet<O, K>;
-export interface BaseObjectSet<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O> | InterfaceKeysFrom<O>> {
-    fetchPageOrThrow: <L extends (K extends InterfaceKeysFrom<O> ? InterfacePropertyKeysFrom<O, K> : ObjectTypePropertyKeysFrom<O, K>)>(args?: FetchPageOrThrowArgs<O, K, L>) => Promise<PageResult<K extends InterfaceKeysFrom<O> ? OsdkInterfaceFrom<K, O, L> : OsdkObjectFrom<K, O, L>>>;
+export type ObjectSet<O extends OntologyDefinition<string>, K extends ObjectOrInterfaceKeysFrom<O>> = BaseObjectSet<O, K>;
+export interface BaseObjectSet<O extends OntologyDefinition<any>, K extends ObjectOrInterfaceKeysFrom<O>> {
+    fetchPageOrThrow: <L extends ObjectOrInterfacePropertyKeysFrom<O, K>>(args?: FetchPageOrThrowArgs<O, K, L>) => Promise<PageResult<K extends InterfaceKeysFrom<O> ? OsdkInterfaceFrom<K, O, L> : OsdkObjectFrom<K, O, L>>>;
     aggregateOrThrow: <const AO extends AggregateOpts<O, K, any>>(req: AO) => Promise<AggregationsResults<O, K, AO>>;
-    where: (clause: WhereClause<ObjectTypeDefinitionFrom<O, K>>) => ObjectSet<O, K>;
+    where: (clause: WhereClause<ObjectOrInterfaceDefinitionFrom<O, K>>) => ObjectSet<O, K>;
     pivotTo: <T extends LinkTypesFrom<O, K>>(type: T & string, opts?: ObjectSetOptions<O, O["objects"][K]["links"][T]["targetType"]>) => ObjectSet<O, O["objects"][K]["links"][T]["targetType"]>;
     subscribe: (listener: ObjectSetListener<O, K>) => () => void;
 }
-export interface ObjectSetOptions<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> {
-    $where?: WhereClause<ObjectTypeDefinitionFrom<O, K>>;
+export interface ObjectSetOptions<O extends OntologyDefinition<any>, K extends ObjectOrInterfaceKeysFrom<O>> {
+    $where?: WhereClause<ObjectOrInterfaceDefinitionFrom<O, K>>;
 }
-export type ObjectSetFactory<O extends OntologyDefinition<any>> = <K extends ObjectTypeKeysFrom<O>>(type: K & string, opts?: ObjectSetOptions<O, K>) => ObjectSet<O, K>;
+export type ObjectSetFactory<O extends OntologyDefinition<any>> = <K extends ObjectOrInterfaceKeysFrom<O>>(type: K & string, opts?: ObjectSetOptions<O, K>) => ObjectSet<O, K>;

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

@@ -1,4 +1,4 @@
-import type { InterfaceKeysFrom, ObjectTypeKeysFrom, OntologyDefinition } from "@osdk/api";
+import type { ObjectOrInterfaceKeysFrom, OntologyDefinition } from "@osdk/api";
 import { type ClientContext } from "@osdk/shared.net";
 import type { Wire } from "../internal/net/index.js";
 import type { ObjectSetListener } from "./ObjectSetListener.js";
@@ -6,7 +6,7 @@ export declare class ObjectSetListenerWebsocket<O extends OntologyDefinition<any
     #private;
     static getInstance<O extends OntologyDefinition<any, any, any>>(client: ClientContext<O>): ObjectSetListenerWebsocket<O>;
     private constructor();
-    subscribe<K extends ObjectTypeKeysFrom<O> | InterfaceKeysFrom<O>>(objectSet: Wire.ObjectSet, listener: ObjectSetListener<O, K>): () => void;
+    subscribe<K extends ObjectOrInterfaceKeysFrom<O>>(objectSet: Wire.ObjectSet, listener: ObjectSetListener<O, K>): () => void;
 }
 export type ObjectPropertyMapping = {
     apiName: string;

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

@@ -1,5 +1,5 @@
-import type { ObjectTypeKeysFrom, OntologyDefinition } from "@osdk/api";
+import type { ObjectOrInterfaceKeysFrom, OntologyDefinition } from "@osdk/api";
 import type { ClientContext } from "@osdk/shared.net";
 import type { Wire } from "../internal/net/index.js";
 import type { ObjectSet, ObjectSetOptions } from "./ObjectSet.js";
-export declare function createObjectSet<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>>(objectType: K & string, clientCtx: ClientContext<O>, opts: ObjectSetOptions<O, K> | undefined, objectSet?: Wire.ObjectSet): ObjectSet<O, K>;
+export declare function createObjectSet<O extends OntologyDefinition<any>, K extends ObjectOrInterfaceKeysFrom<O>>(objectType: K & string, clientCtx: ClientContext<O>, opts: ObjectSetOptions<O, K> | undefined, objectSet?: Wire.ObjectSet): ObjectSet<O, K>;

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

@@ -1,4 +1,4 @@
-import type { ObjectTypeDefinition, ObjectTypePropertyDefinition } from "@osdk/api";
+import type { ObjectOrInterfaceDefinition, ObjectTypePropertyDefinition } from "@osdk/api";
 export type PossibleWhereClauseFilters = "gt" | "eq" | "ne" | "isNull" | "gte" | "lt" | "lte";
 type MakeFilter<K extends PossibleWhereClauseFilters, V> = K extends string ? Omit<{
     [k in PossibleWhereClauseFilters]?: undefined;
@@ -9,16 +9,16 @@ type BaseFilter<T> = T | MakeFilter<"eq" | "ne", T> | MakeFilter<"isNull", boole
 type StringFilter = BaseFilter<string>;
 type NumberFilter = BaseFilter<number> | MakeFilter<"gt" | "gte" | "lt" | "lte", number>;
 type FilterFor<PD extends ObjectTypePropertyDefinition> = PD["type"] extends "string" ? StringFilter : NumberFilter;
-export interface AndWhereClause<T extends ObjectTypeDefinition<any, any>> {
+export interface AndWhereClause<T extends ObjectOrInterfaceDefinition<any, any>> {
     $and: WhereClause<T>[];
 }
-export interface OrWhereClause<T extends ObjectTypeDefinition<any, any>> {
+export interface OrWhereClause<T extends ObjectOrInterfaceDefinition<any, any>> {
     $or: WhereClause<T>[];
 }
-export interface NotWhereClause<T extends ObjectTypeDefinition<any, any>> {
+export interface NotWhereClause<T extends ObjectOrInterfaceDefinition<any, any>> {
     $not: WhereClause<T>;
 }
-export type WhereClause<T extends ObjectTypeDefinition<any, any>> = OrWhereClause<T> | AndWhereClause<T> | NotWhereClause<T> | {
+export type WhereClause<T extends ObjectOrInterfaceDefinition<any, any>> = OrWhereClause<T> | AndWhereClause<T> | NotWhereClause<T> | {
     [P in keyof T["properties"]]?: FilterFor<T["properties"][P]>;
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/client",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "",
   "access": "public",
   "license": "Apache-2.0",
@@ -22,9 +22,9 @@
     "isomorphic-ws": "^5.0.0",
     "tiny-invariant": "^1.3.1",
     "ws": "^8.14.2",
-    "@osdk/api": "1.0.1",
-    "@osdk/gateway": "1.0.1",
-    "@osdk/shared.net": "1.0.1"
+    "@osdk/api": "1.0.2",
+    "@osdk/gateway": "1.0.2",
+    "@osdk/shared.net": "1.0.2"
   },
   "devDependencies": {
     "@types/ws": "^8.5.10",
@@ -42,7 +42,7 @@
     "package.json",
     "*.d.ts"
   ],
-  "main": "./build/js/index.js",
+  "main": "./build/js/index.cjs",
   "module": "./build/js/index.mjs",
   "types": "./build/types/index.d.ts",
   "type": "module",