@triplit/svelte 1.0.29 → 1.0.31

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @triplit/svelte
 
+## 1.0.31
+
+### Patch Changes
+
+- @triplit/client@1.0.31
+
+## 1.0.30
+
+### Patch Changes
+
+- a3b6a4e4: add useQueryOne and useEntity hooks
+- Updated dependencies [d8023d03]
+- Updated dependencies [461d1813]
+  - @triplit/client@1.0.30
+
 ## 1.0.29
 
 ### Patch Changes

package/dist/index.svelte.d.ts

@@ -1,4 +1,4 @@
-import type { Models, SchemaQuery, SubscriptionOptions, SubscriptionSignalPayload, TriplitClient } from '@triplit/client';
+import type { CollectionNameFromModels, FetchResult, Models, SchemaQuery, SubscriptionOptions, SubscriptionSignalPayload, TriplitClient } from '@triplit/client';
 import { WorkerClient } from '@triplit/client/worker-client';
 /**
  * A hook that subscribes to a query
@@ -17,6 +17,29 @@ export declare function useQuery<M extends Models<M>, Q extends SchemaQuery<M>>(
  * @param client - The client instance to get the connection status of
  * @returns An object containing `status`, the current connection status of the client with the server
  */
-export declare function useConnectionStatus(client: TriplitClient<any>): {
+export declare function useConnectionStatus(client: TriplitClient<any> | WorkerClient<any>): {
     readonly status: import("@triplit/client").ConnectionStatus;
 };
+/**
+ * A hook that subscribes to a query and fetches only one result
+ *
+ * @param client - The client instance to query with
+ * @param query - The query to subscribe to
+ * @param options - Additional options for the subscription
+ * @returns An object containing the fetching state, the result of the query, and any error that occurred
+ */
+export declare function useQueryOne<M extends Models<M>, Q extends SchemaQuery<M>>(client: TriplitClient<M> | WorkerClient<M>, query: Q, options?: Partial<SubscriptionOptions>): Omit<SubscriptionSignalPayload<M, Q>, 'results'> & {
+    result: FetchResult<M, Q, 'one'>;
+};
+/**
+ * A hook that subscribes to an entity
+ *
+ * @param client - The client instance to query with
+ * @param collectionName - The name of the collection to query
+ * @param id - The id of the entity to query
+ * @param options - Additional options for the subscription
+ * @returns - An object containing the fetching state, the result of the query, and any error that occurred
+ */
+export declare function useEntity<M extends Models<M>, CN extends CollectionNameFromModels<M>>(client: TriplitClient<M> | WorkerClient<M>, collectionName: CN, id: string, options?: Partial<SubscriptionOptions>): Omit<SubscriptionSignalPayload<M, import("@triplit/client").QueryBuilder<M, CN, import("@triplit/client").WithInclusion<import("@triplit/client").CollectionQuery<M, CN>, {}>>>, "results"> & {
+    result: FetchResult<M, import("@triplit/client").QueryBuilder<M, CN, import("@triplit/client").WithInclusion<import("@triplit/client").CollectionQuery<M, CN>, {}>>, "one">;
+};

package/dist/index.svelte.js

@@ -65,3 +65,43 @@ export function useConnectionStatus(client) {
         },
     };
 }
+/**
+ * A hook that subscribes to a query and fetches only one result
+ *
+ * @param client - The client instance to query with
+ * @param query - The query to subscribe to
+ * @param options - Additional options for the subscription
+ * @returns An object containing the fetching state, the result of the query, and any error that occurred
+ */
+export function useQueryOne(client, query, options) {
+    const queryPayload = useQuery(client, { ...query, limit: 1 }, options);
+    return {
+        get fetching() {
+            return queryPayload.fetching;
+        },
+        get fetchingLocal() {
+            return queryPayload.fetchingLocal;
+        },
+        get fetchingRemote() {
+            return queryPayload.fetchingRemote;
+        },
+        get result() {
+            return queryPayload.results?.[0] ?? null;
+        },
+        get error() {
+            return queryPayload.error;
+        },
+    };
+}
+/**
+ * A hook that subscribes to an entity
+ *
+ * @param client - The client instance to query with
+ * @param collectionName - The name of the collection to query
+ * @param id - The id of the entity to query
+ * @param options - Additional options for the subscription
+ * @returns - An object containing the fetching state, the result of the query, and any error that occurred
+ */
+export function useEntity(client, collectionName, id, options) {
+    return useQueryOne(client, client.query(collectionName).Id(id), options);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@triplit/svelte",
   "packageManager": "yarn@3.4.1",
-  "version": "1.0.29",
+  "version": "1.0.31",
   "source": "./src/index.svelte.ts",
   "main": "./dist/index.svelte.js",
   "module": "./dist/index.svelte.js",
@@ -29,7 +29,7 @@
     "/dist"
   ],
   "dependencies": {
-    "@triplit/client": "^1.0.29"
+    "@triplit/client": "^1.0.31"
   },
   "devDependencies": {
     "@sveltejs/package": "^2.3.10",