@osdk/client 0.0.11 → 0.1.1

package/build/types/index.d.ts

@@ -1,6 +1,7 @@
 export type { Client } from "./Client.js";
 export { createClient } from "./createClient.js";
 export type { ObjectSet } from "./objectSet/ObjectSet.js";
+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";

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

@@ -5,14 +5,14 @@ import type { PageResult } from "../PageResult.js";
 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 "./ObjectSetWatcher.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>>>;
     aggregateOrThrow: <const AO extends AggregateOpts<O, K, any>>(req: AO) => Promise<AggregationsResults<O, K, AO>>;
     where: (clause: WhereClause<ObjectTypeDefinitionFrom<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>) => Promise<() => void>;
+    subscribe: (listener: ObjectSetListener<O, K>) => () => void;
 }
 export interface ObjectSetOptions<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> {
     $where?: WhereClause<ObjectTypeDefinitionFrom<O, K>>;

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

@@ -0,0 +1,17 @@
+import type { ObjectTypeKeysFrom, OntologyDefinition } from "@osdk/api";
+import type { OsdkObjectFrom } from "../OsdkObjectFrom.js";
+export type ObjectSetListener<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = Partial<{
+    /**
+     * Specific objects have changed and can be immediately updated
+     */
+    onChange: (objects: Array<OsdkObjectFrom<K, O>>) => void;
+    /**
+     * The ObjectSet has become outdated and should be re-fetched in its entirety.
+     * This is also sent when the subscription is first initialized.
+     */
+    onOutOfDate: () => void;
+    /**
+     * There was a fatal error with the subscription process
+     */
+    onError: (error: unknown) => void;
+}>;

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

@@ -0,0 +1,16 @@
+import type { InterfaceKeysFrom, ObjectTypeKeysFrom, 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";
+export declare class ObjectSetListenerWebsocket<O extends OntologyDefinition<any, any, 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;
+}
+export type ObjectPropertyMapping = {
+    apiName: string;
+    id: string;
+    propertyIdToApiNameMapping: Record<string, string>;
+    propertyApiNameToIdMapping: Record<string, string>;
+};

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

@@ -1,6 +1,6 @@
 import type { ObjectTypeKeysFrom, OntologyDefinition } from "@osdk/api";
 import type { ObjectSet as OssObjectSet } from "../generated/object-set-service/api/index.js";
 import type { Wire } from "../internal/net/index.js";
-import type { ObjectPropertyMapping } from "./ObjectSetWatcherWebsocket.js";
+import type { ObjectPropertyMapping } from "./ObjectSetListenerWebsocket.js";
 export declare function toConjureObjectSet<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>>(objectSet: Wire.ObjectSet, objectPropertyMapping: ObjectPropertyMapping): OssObjectSet;
 export declare function getObjectSetBaseType(objectSet: Wire.ObjectSet): Promise<string>;

package/build/types/util/NullableProps.d.ts

@@ -0,0 +1,5 @@
+export type NullableProps<T extends Record<string, {
+    nullable?: boolean;
+}>> = keyof {
+    [K in keyof T as T[K]["nullable"] extends true ? K : never]: "";
+};

package/build/types/util/PartialBy.d.ts

@@ -0,0 +1,2 @@
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type PartialByNotStrict<T, K> = K extends keyof T ? PartialBy<T, K> : "never";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/client",
-  "version": "0.0.11",
+  "version": "0.1.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.0",
-    "@osdk/shared.net": "1.0.0",
-    "@osdk/gateway": "1.0.0"
+    "@osdk/api": "1.0.1",
+    "@osdk/gateway": "1.0.1",
+    "@osdk/shared.net": "1.0.1"
   },
   "devDependencies": {
     "@types/ws": "^8.5.10",

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

@@ -1,6 +0,0 @@
-export declare class Deferred<T> {
-    resolve: (value: T | PromiseLike<T>) => void;
-    reject: (reason?: any) => void;
-    promise: Promise<T>;
-    constructor();
-}

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

@@ -1,10 +0,0 @@
-import type { ObjectTypeKeysFrom, OntologyDefinition } from "@osdk/api";
-import type { OsdkObject } from "../OsdkObject.js";
-export interface ObjectSetWatcherEvents<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> {
-    change: Array<OsdkObject<K & string>>;
-    refresh: never;
-    cancelled: never;
-}
-export type ObjectSetListener<O extends OntologyDefinition<any>, K extends ObjectTypeKeysFrom<O>> = Partial<{
-    [E in keyof ObjectSetWatcherEvents<O, K>]: ObjectSetWatcherEvents<O, K>[E] extends never ? () => void : (data: ObjectSetWatcherEvents<O, K>[E]) => void;
-}>;

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

@@ -1,16 +0,0 @@
-import type { ObjectTypeKeysFrom, OntologyDefinition } from "@osdk/api";
-import { type ClientContext } from "@osdk/shared.net";
-import type { Wire } from "../internal/net/index.js";
-import type { ObjectSetListener } from "./ObjectSetWatcher.js";
-export declare class ObjectSetWatcherWebsocket<O extends OntologyDefinition<any, any, any>> {
-    #private;
-    static getInstance<O extends OntologyDefinition<any, any, any>>(client: ClientContext<O>): ObjectSetWatcherWebsocket<any>;
-    private constructor();
-    subscribe<K extends ObjectTypeKeysFrom<O>>(objectSet: Wire.ObjectSet, listener: ObjectSetListener<O, K>): Promise<() => void>;
-}
-export type ObjectPropertyMapping = {
-    apiName: string;
-    id: string;
-    propertyIdToApiNameMapping: Record<string, string>;
-    propertyApiNameToIdMapping: Record<string, string>;
-};