@triplit/svelte 1.0.47 → 1.0.49

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @triplit/svelte
 
+## 1.0.49
+
+### Patch Changes
+
+- @triplit/client@1.0.49
+
+## 1.0.48
+
+### Patch Changes
+
+- 0c92a165: Add enabled parameter to subscriptions
+- Updated dependencies [0c92a165]
+  - @triplit/client@1.0.48
+
 ## 1.0.47
 
 ### Patch Changes

package/dist/index.svelte.d.ts

@@ -1,4 +1,4 @@
-import type { CollectionNameFromModels, FetchResult, Models, SchemaQuery, SubscriptionOptions, SubscriptionSignalPayload, TriplitClient } from '@triplit/client';
+import type { CollectionNameFromModels, FetchResult, Models, SchemaQuery, SubscriptionSignalPayload, TriplitClient, EnabledSubscriptionOptions } from '@triplit/client';
 import { WorkerClient } from '@triplit/client/worker-client';
 /**
  * A hook that subscribes to a query
@@ -10,7 +10,7 @@ import { WorkerClient } from '@triplit/client/worker-client';
  * @param options.onRemoteFulfilled - An optional callback that is called when the remote query has been fulfilled.
  * @returns An object containing the fetching state, the result of the query, any error that occurred, and a function to update the query
  */
-export declare function useQuery<M extends Models<M>, Q extends SchemaQuery<M>>(client: TriplitClient<M> | WorkerClient<M>, query: Q, options?: Partial<SubscriptionOptions>): SubscriptionSignalPayload<M, Q>;
+export declare function useQuery<M extends Models<M>, Q extends SchemaQuery<M>>(client: TriplitClient<M> | WorkerClient<M>, query: Q, options?: Partial<EnabledSubscriptionOptions>): SubscriptionSignalPayload<M, Q>;
 /**
  * A hook that subscribes to the connection status of a client with the server
  *
@@ -28,7 +28,7 @@ export declare function useConnectionStatus(client: TriplitClient<any> | WorkerC
  * @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'> & {
+export declare function useQueryOne<M extends Models<M>, Q extends SchemaQuery<M>>(client: TriplitClient<M> | WorkerClient<M>, query: Q, options?: Partial<EnabledSubscriptionOptions>): Omit<SubscriptionSignalPayload<M, Q>, 'results'> & {
     result: FetchResult<M, Q, 'one'>;
 };
 /**
@@ -40,6 +40,6 @@ export declare function useQueryOne<M extends Models<M>, Q extends SchemaQuery<M
  * @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"> & {
+export declare function useEntity<M extends Models<M>, CN extends CollectionNameFromModels<M>>(client: TriplitClient<M> | WorkerClient<M>, collectionName: CN, id: string, options?: Partial<EnabledSubscriptionOptions>): 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

@@ -1,4 +1,5 @@
 /// <reference types="svelte" />
+import { getInitialState, getDisabledSubscriptionState, isSubscriptionEnabled, } from '@triplit/client';
 /**
  * A hook that subscribes to a query
  *
@@ -10,12 +11,22 @@
  * @returns An object containing the fetching state, the result of the query, any error that occurred, and a function to update the query
  */
 export function useQuery(client, query, options) {
-    let results = $state(undefined);
-    let fetching = $state(true);
-    let fetchingLocal = $state(true);
-    let fetchingRemote = $state(false);
-    let error = $state(undefined);
+    const initialState = getInitialState(options);
+    let results = $state(initialState.results);
+    let fetching = $state(initialState.fetching);
+    let fetchingLocal = $state(initialState.fetchingLocal);
+    let fetchingRemote = $state(initialState.fetchingRemote);
+    let error = $state(initialState.error);
     $effect(() => {
+        if (!isSubscriptionEnabled(options)) {
+            const disabledState = getDisabledSubscriptionState();
+            results = disabledState.results;
+            fetching = disabledState.fetching;
+            fetchingLocal = disabledState.fetchingLocal;
+            fetchingRemote = disabledState.fetchingRemote;
+            error = disabledState.error;
+            return;
+        }
         const unsub = client.subscribeWithStatus(query, (newVal) => {
             results = newVal.results;
             fetching = newVal.fetching;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@triplit/svelte",
   "packageManager": "yarn@3.4.1",
-  "version": "1.0.47",
+  "version": "1.0.49",
   "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.47"
+    "@triplit/client": "^1.0.49"
   },
   "devDependencies": {
     "@sveltejs/package": "^2.3.10",