@osdk/react 0.3.0-beta.3 → 0.3.0

package/build/types/new/OsdkContext2.d.ts

@@ -0,0 +1,9 @@
+import type { Client } from "@osdk/client";
+import type { ObservableClient } from "@osdk/client/unstable-do-not-use";
+import React from "react";
+interface OsdkContextContents {
+	client: Client;
+	store: ObservableClient;
+}
+export declare const OsdkContext2: React.Context<OsdkContextContents>;
+export {};

package/build/types/new/OsdkContext2.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,cAAc,cAAe;AAC3C,cAAc,wBAAwB,kCAAmC;AACzE,OAAO,WAAW,OAAQ;UAYhB,oBAAoB;CAC5B,QAAQ;CAKR,OAAO;AACR;AAED,OAAO,cAAMA,cAAc,MAAM,QAAQ","names":["OsdkContext2: React.Context<OsdkContextContents>"],"sources":["../../../src/new/OsdkContext2.ts"],"version":3,"file":"OsdkContext2.d.ts"}

package/build/types/new/OsdkProvider2.d.ts

@@ -0,0 +1,10 @@
+import type { Client } from "@osdk/client";
+import type { ObservableClient } from "@osdk/client/unstable-do-not-use";
+import React from "react";
+interface OsdkProviderOptions {
+	children: React.ReactNode;
+	client: Client;
+	store: ObservableClient;
+}
+export declare function OsdkProvider2({ children, client, store }: OsdkProviderOptions): React.JSX.Element;
+export {};

package/build/types/new/OsdkProvider2.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,cAAc,cAAe;AAC3C,cAAc,wBAAwB,kCAAmC;AACzE,OAAO,WAAW,OAAQ;UAGhB,oBAAoB;CAC5B,UAAU,MAAM;CAChB,QAAQ;CACR,OAAO;AACR;AAED,OAAO,iBAAS,cAAc,EAC5B,UACA,QACA,OACoB,EAAnB,sBAAsB,MAAM,IAAI","names":[],"sources":["../../../src/new/OsdkProvider2.tsx"],"version":3,"file":"OsdkProvider2.d.ts"}

package/build/types/new/makeExternalStore.d.ts

@@ -0,0 +1,5 @@
+import type { Unsubscribable } from "@osdk/client/unstable-do-not-use";
+export declare function makeExternalStore<X>(createObservation: (callback: (x: X | undefined) => void) => Unsubscribable, name?: string): {
+	subscribe: (notifyUpdate: () => void) => () => void
+	getSnapShot: () => X | undefined
+};

package/build/types/new/makeExternalStore.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,sBAAsB,kCAAmC;AAEvE,OAAO,iBAAS,kBAAkB,GAChCA,oBAAoBC,WAAWC,GAAG,2BAA2B,gBAC7DC,gBACC;CACD,YAAYC;CACZ,mBAAmB;AACpB","names":["createObservation: (callback: (x: X | undefined) => void) => Unsubscribable","callback: (x: X | undefined) => void","x: X | undefined","name?: string","notifyUpdate: () => void"],"sources":["../../../src/new/makeExternalStore.ts"],"version":3,"file":"makeExternalStore.d.ts"}

package/build/types/new/useOsdkAction.d.ts

@@ -0,0 +1,12 @@
+import type { ActionDefinition } from "@osdk/client";
+import { ActionValidationError } from "@osdk/client";
+import type { ActionSignatureFromDef, ObservableClient } from "@osdk/client/unstable-do-not-use";
+export interface UseOsdkActionResult<Q extends ActionDefinition<any>> {
+	applyAction: (args: Parameters<ActionSignatureFromDef<Q>["applyAction"]>[0], opts: ObservableClient.ApplyActionOptions) => Promise<unknown>;
+	error: undefined | Partial<{
+		actionValidation: ActionValidationError
+		unknown: unknown
+	}>;
+	data: unknown;
+}
+export declare function useOsdkAction<Q extends ActionDefinition<any>>(actionDef: Q): UseOsdkActionResult<Q>;

package/build/types/new/useOsdkAction.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,wBAAwB,cAAe;AACrD,SAAS,6BAA6B,cAAe;AACrD,cACE,wBACA,wBACK,kCAAmC;AAI1C,iBAAiB,oBAAoB,UAAU,uBAAuB;CACpE,cACEA,MAAM,WAAW,uBAAuB,GAAG,gBAAgB,IAC3DC,MAAM,iBAAiB,uBACpB;CAEL,mBAEI,QAAQ;EACR,kBAAkB;EAClB;CACD;CACH;AACD;AAED,OAAO,iBAAS,cAAc,UAAU,uBACtCC,WAAW,IACV,oBAAoB","names":["args: Parameters<ActionSignatureFromDef<Q>[\"applyAction\"]>[0]","opts: ObservableClient.ApplyActionOptions","actionDef: Q"],"sources":["../../../src/new/useOsdkAction.ts"],"version":3,"file":"useOsdkAction.d.ts"}

package/build/types/new/useOsdkList.d.ts

@@ -0,0 +1,26 @@
+import type { ObjectTypeDefinition, Osdk, WhereClause } from "@osdk/client";
+export interface UseOsdkListOptions<T extends ObjectTypeDefinition> {
+	where: WhereClause<T>;
+	/**
+	* The number of milliseconds to wait after the last observed list change.
+	*
+	* Two uses of `useOsdkList` with the where clause will only trigger one
+	* network request if the second is within `dedupeIntervalMs`.
+	*/
+	dedupeIntervalMs?: number;
+}
+export interface UseOsdkListResult<T extends ObjectTypeDefinition> {
+	fetchMore: (() => Promise<unknown>) | undefined;
+	data: Osdk.Instance<T>[];
+	isLoading: boolean;
+	error: undefined;
+	/**
+	* Refers to whether the ordered list of objects (only considering the $primaryKey)
+	* is optimistic or not.
+	*
+	* If you need to know if the contents of the list are optimistic you can
+	* do that on a per object basis with useOsdkObject
+	*/
+	isOptimistic: boolean;
+}
+export declare function useOsdkList<T extends ObjectTypeDefinition>(type: T, opts: UseOsdkListOptions<T>): UseOsdkListResult<T>;

package/build/types/new/useOsdkList.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,sBAAsB,MAAM,mBAAmB,cAAe;AAM5E,iBAAiB,mBAAmB,UAAU,sBAAsB;CAClE,OAAO,YAAY;;;;;;;CAQnB;AACD;AACD,iBAAiB,kBAAkB,UAAU,sBAAsB;CACjE,kBAAkB;CAClB,MAAM,KAAK,SAAS;CACpB;CAGA;;;;;;;;CASA;AACD;AAED,OAAO,iBAAS,YAAY,UAAU,sBACpCA,MAAM,GACNC,MAAM,mBAAmB,KACxB,kBAAkB","names":["type: T","opts: UseOsdkListOptions<T>"],"sources":["../../../src/new/useOsdkList.ts"],"version":3,"file":"useOsdkList.d.ts"}

package/build/types/new/useOsdkObject.d.ts

@@ -0,0 +1,21 @@
+import type { ObjectTypeDefinition, Osdk, PrimaryKeyType } from "@osdk/api";
+export interface UseOsdkObjectResult<Q extends ObjectTypeDefinition> {
+	object: Osdk.Instance<Q> | undefined;
+	isLoading: boolean;
+	/**
+	* Refers to whether the object is optimistic or not.
+	*/
+	isOptimistic: boolean;
+	forceUpdate: () => void;
+}
+/**
+* @param obj an existing `Osdk.Instance` object to get metadata for.
+*/
+export declare function useOsdkObject<Q extends ObjectTypeDefinition>(obj: Osdk.Instance<Q>): UseOsdkObjectResult<Q>;
+/**
+* Loads an object by type and primary key.
+*
+* @param type
+* @param primaryKey
+*/
+export declare function useOsdkObject<Q extends ObjectTypeDefinition>(type: Q, primaryKey: PrimaryKeyType<Q>): UseOsdkObjectResult<Q>;

package/build/types/new/useOsdkObject.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,sBAAsB,MAAM,sBAAsB,WAAY;AAM5E,iBAAiB,oBAAoB,UAAU,sBAAsB;CACnE,QAAQ,KAAK,SAAS;CACtB;;;;CAKA;CACA;AACD;;;;AAKD,OAAO,iBAAS,cAAc,UAAU,sBACtCA,KAAK,KAAK,SAAS,KAClB,oBAAoB;;;;;;;AAOvB,OAAO,iBAAS,cAAc,UAAU,sBACtCC,MAAM,GACNC,YAAY,eAAe,KAC1B,oBAAoB","names":["obj: Osdk.Instance<Q>","type: Q","primaryKey: PrimaryKeyType<Q>"],"sources":["../../../src/new/useOsdkObject.ts"],"version":3,"file":"useOsdkObject.d.ts"}

package/build/types/public/experimental.d.ts

@@ -0,0 +1,5 @@
+export { OsdkProvider2 } from "../new/OsdkProvider2.js";
+export { useOsdkAction } from "../new/useOsdkAction.js";
+export { useOsdkList } from "../new/useOsdkList.js";
+export { useOsdkObject } from "../new/useOsdkObject.js";
+export { useOsdkClient } from "../useOsdkClient.js";

package/build/types/public/experimental.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,SAAS,qBAAqB;AAC9B,SAAS,qBAAqB;AAC9B,SAAS,mBAAmB;AAC5B,SAAS,qBAAqB;AAC9B,SAAS,qBAAqB","names":[],"sources":["../../../src/public/experimental.ts"],"version":3,"file":"experimental.d.ts"}

package/build/types/useOsdkClient.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,cAAc,cAAe;AAI3C,OAAO,iBAAS,iBAAiB","names":[],"sources":["../../src/useOsdkClient.ts"],"version":3,"file":"useOsdkClient.d.ts"}

package/build/types/useOsdkMetadata.d.ts

@@ -1,7 +1,7 @@
 import type { InterfaceDefinition, InterfaceMetadata, ObjectMetadata, ObjectOrInterfaceDefinition, ObjectTypeDefinition } from "@osdk/api";
 type MetadataFor<T extends ObjectOrInterfaceDefinition> = T extends InterfaceDefinition ? InterfaceMetadata : T extends ObjectTypeDefinition ? ObjectMetadata : never;
 export declare function useOsdkMetadata<T extends ObjectOrInterfaceDefinition>(type: T): {
-	loading: boolean;
-	metadata?: MetadataFor<T>;
+	loading: boolean
+	metadata?: MetadataFor<T>
 };
 export {};

package/build/types/useOsdkMetadata.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACE,qBACA,mBACA,gBACA,6BACA,4BACK,WAAY;KAId,YAAY,UAAU,+BAA+B,UACxD,sBAAsB,oBACpB,UAAU,uBAAuB;AAGrC,OAAO,iBAAS,gBAAgB,UAAU,6BACxCA,MAAM,IACL;CACD;CACA,WAAW,YAAY;AACxB","names":["type: T"],"sources":["../../src/useOsdkMetadata.ts"],"version":3,"file":"useOsdkMetadata.d.ts"}

package/experimental.d.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from "./build/cjs/public/experimental.cjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/react",
-  "version": "0.3.0-beta.3",
+  "version": "0.3.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -16,6 +16,15 @@
       "require": "./build/cjs/index.cjs",
       "default": "./build/browser/index.js"
     },
+    "./experimental": {
+      "browser": "./build/browser/public/experimental.js",
+      "import": {
+        "types": "./build/types/public/experimental.d.ts",
+        "default": "./build/esm/public/experimental.js"
+      },
+      "require": "./build/cjs/public/experimental.cjs",
+      "default": "./build/browser/public/experimental.js"
+    },
     "./*": {
       "browser": "./build/browser/public/*.js",
       "import": {
@@ -36,13 +45,13 @@
   "devDependencies": {
     "@testing-library/react": "^16.0.1",
     "@types/react": "^18.3.12",
-    "happy-dom": "^15.7.4",
+    "happy-dom": "^16.8.1",
     "p-defer": "^4.0.1",
     "react": "^18.0.0",
     "typescript": "~5.5.4",
-    "@osdk/api": "2.1.0-beta.24",
+    "@osdk/api": "2.1.0",
     "@osdk/monorepo.api-extractor": "~0.0.0",
-    "@osdk/client": "2.1.0-beta.24",
+    "@osdk/client": "2.1.0",
     "@osdk/monorepo.tsconfig": "~0.0.0"
   },
   "publishConfig": {
@@ -63,6 +72,7 @@
   "types": "./build/cjs/index.d.cts",
   "type": "module",
   "scripts": {
+    "apiDocs": "npx typedoc ",
     "check-attw": "attw --pack .",
     "check-spelling": "cspell --quiet .",
     "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",