@tiesen/effect-tanstack-query 0.0.12 → 0.0.14

package/dist/index.d.mts

@@ -1,7 +1,6 @@
-import { r as TanstackQueryOptionsProxy } from "./types-MoWlEtTb.mjs";
+import { r as TanstackQueryOptionsProxy } from "./types-A-WfeH_j.mjs";
 import { Service } from "effect/Context";
 import { ManagedRuntime } from "effect/ManagedRuntime";
-import { NodeInspectSymbol } from "effect/Inspectable";
 //#region src/create-proxy.d.ts
 /**
  * Creates a type-safe proxy that bridges Effect `HttpApiClient` endpoints
@@ -44,4 +43,4 @@ import { NodeInspectSymbol } from "effect/Inspectable";
  */
 declare function createTanstackQueryOptionsProxy<TServiceTag, TService>(tag: Service<TServiceTag, TService>, runtime: ManagedRuntime<TServiceTag, never>): TanstackQueryOptionsProxy<TService>;
 //#endregion
-export { type NodeInspectSymbol, type TanstackQueryOptionsProxy, createTanstackQueryOptionsProxy };
+export { type TanstackQueryOptionsProxy, createTanstackQueryOptionsProxy };

package/dist/index.mjs

@@ -1 +1 @@
-import*as e from"effect/Effect";import*as t from"effect/Fiber";import*as n from"effect/Schedule";import*as r from"effect/Stream";function i(i,a){let o=new Map,s=c=>{let l=c.join(`.`);if(o.has(l))return o.get(l);let u=new Proxy(()=>{},{get(e,t){if(typeof t!=`symbol`&&t!==`then`)return s([...c,String(t)])},apply(o,s,l){let u=c.at(-1),d=c.slice(0,-1),[f,p]=l,m=e.fn(function*(e){let t=yield*i;for(let e of d)t=t[e];return yield*t(e)}),h=(e,t)=>a.runPromise(m(e),{signal:t}),g=(e,t)=>[{type:e},...d,...t?[t]:[]];if(u===`queryOptions`)return{...p,queryKey:g(`query`,f),queryFn:({signal:e})=>h(f,e)};if(u===`getQueryKey`)return g(`query`,f);if(u===`mutationOptions`)return{...p,mutationKey:g(`mutation`,f),mutationFn:e=>h({payload:e})};if(u===`subscriptionOptions`){let{onData:i,onError:o,keepAliveTimeout:s=`10 seconds`}=p;return{...p,subcriptionKey:g(`subscription`,f),subscriptionFn:({signal:c}={})=>{let l=e.gen(function*(){let t=yield*(yield*m({...f,responseMode:`response-only`})).stream.pipe(r.decodeText,r.splitLines,r.filter(e=>e.length>0),r.share({capacity:`unbounded`})),n=t.pipe(r.filter(e=>e.startsWith(`:keep-alive`)),r.timeout(s),r.tapError(()=>e.logError(`Keep-alive timeout, reconnecting...`))),a=yield*t.pipe(r.filter(e=>e.startsWith(`data:`)),r.map(e=>e.slice(5).trim()),r.filter(e=>e.length>0),r.tap(t=>e.sync(()=>i(t))),r.share({capacity:`unbounded`})),o=r.merge(n,a);yield*r.runDrain(o),yield*e.fail(`restart`)}).pipe(e.catchTag(`HttpClientError`,t=>t.reason._tag===`DecodeError`?e.void:(o&&o(t),e.fail(t))),e.scoped,e.retry(n.exponential(`3 seconds`))),u=a.runFork(l),d=()=>t.interrupt(u);return c&&(c.aborted?d():c.addEventListener(`abort`,d,{once:!0})),d}}}}});return o.set(l,u),u};return s([])}export{i as createTanstackQueryOptionsProxy};
+import*as e from"effect/Effect";import*as t from"effect/Fiber";import*as n from"effect/Schedule";import*as r from"effect/Stream";function i(i,a){let o=new Map,s=c=>{let l=c.join(`.`);if(o.has(l))return o.get(l);let u=new Proxy(()=>{},{get(e,t){if(typeof t!=`symbol`&&t!==`then`)return s([...c,String(t)])},apply(o,s,l){let u=c.at(-1),d=c.slice(0,-1),[f,p]=l,m=e.fn(function*(e){let t=yield*i;for(let e of d)t=t[e];return yield*t(e)}),h=(e,t)=>a.runPromise(m(e),{signal:t}),g=(e,t)=>[{type:e},...d,...t?[t]:[]];if(u===`queryOptions`)return{...p,queryKey:g(`query`,f),queryFn:({signal:e})=>h(f,e)};if(u===`getQueryKey`)return g(`query`,f);if(u===`mutationOptions`)return{...p,mutationKey:g(`mutation`,f),mutationFn:e=>h({payload:e})};if(u===`subscriptionOptions`)return{...p,enabled:p?.enabled??!0,subcriptionKey:g(`subscription`,f),subscriptionFn:({autoReconnect:i,keepAlive:o,...s})=>{let{onStarted:c,onData:l,onError:u,onConnectionChange:d}=s,p=n.max([n.exponential(i??0),n.spaced(`30 seconds`),n.recurs(3)]).pipe(n.jittered),h=e.gen(function*(){d?.({status:`connecting`}),c?.();let t=yield*m({...f,responseMode:`response-only`});d?.({status:`pending`});let n=yield*t.stream.pipe(r.decodeText,r.splitLines,r.filter(e=>e.length>0),r.share({capacity:`unbounded`})),a=n.pipe(r.filter(e=>e.startsWith(o?.message??`:keep-alive`)),r.timeout(o?.timeout??`10 seconds`)),s=yield*n.pipe(r.filter(e=>e.startsWith(`data:`)),r.map(e=>e.slice(5).trim()),r.filter(e=>e.length>0),r.tap(t=>e.sync(()=>l?.(t))),r.share({capacity:`unbounded`})),u=r.merge(a,s);yield*r.runDrain(u),i&&(yield*e.fail(`restart`))}).pipe(e.tapError(t=>t===`restart`||typeof t==`object`&&t._tag===`HttpClientError`&&t.reason?._tag===`DecodeError`?e.void:e.sync(()=>u?.(t)))),g=(i?h.pipe(e.retry(p)):h).pipe(e.ensuring(e.sync(()=>d?.({status:`idle`}))),e.scoped),_=a.runFork(g);return()=>a.runPromise(t.interrupt(_))}}}});return o.set(l,u),u};return s([])}export{i as createTanstackQueryOptionsProxy};

package/dist/react.d.mts

@@ -1,7 +1,5 @@
-import { n as SubscriptionReturns, t as SubscriptionOptions } from "./types-MoWlEtTb.mjs";
+import { n as SubscriptionReturns, t as SubscriptionOptions } from "./types-A-WfeH_j.mjs";
 //#region src/react.d.ts
-declare function useSubscription<TData, TError>({ enabled, ...subscriptionOptions }: SubscriptionOptions<TData, TError> & {
-  enabled?: boolean;
-}): SubscriptionReturns;
+declare function useSubscription<TData, TError>(opts: SubscriptionOptions<TData, TError>): SubscriptionReturns<TData, TError>;
 //#endregion
 export { type SubscriptionOptions, type SubscriptionReturns, useSubscription };

package/dist/react.mjs

@@ -1 +1 @@
-import*as e from"react";function t({enabled:t=!0,...n}){let[r,i]=e.useState(`disconnected`),[a,o]=e.useState(0),s=e.useCallback(()=>{o(e=>e+1)},[]),c=e.useMemo(()=>JSON.stringify(n.subcriptionKey),[n.subcriptionKey]);return e.useEffect(()=>{if(!t)return i(`disconnected`);i(`connecting`);let e=new AbortController,r=n.subscriptionFn({signal:e.signal});return i(`connected`),()=>{e.abort(),r(),i(`disconnected`)}},[t,c,a]),e.useMemo(()=>({status:r,reconnect:s}),[r,s])}export{t as useSubscription};
+import{hashKey as e}from"@tanstack/query-core";import*as t from"react";function n(n){let i=t.useRef(n);i.current=n;let a=t.useRef(new Set),o=t.useCallback(e=>{a.current.add(e)},[]),s=t.useRef(()=>{}),c=t.useCallback(()=>{if(s.current(),p(l),!n.enabled)return;let e=n.subscriptionFn({autoReconnect:i.current.autoReconnect,keepAlive:i.current.keepAlive,onStarted:()=>{i.current.onStarted?.(),p(e=>({...e,status:`pending`,error:null}))},onData:e=>{i.current.onData?.(e),p(t=>({...t,status:`pending`,data:e,error:null}))},onError:e=>{i.current.onError?.(e),p(t=>({...t,status:`error`,error:e}))},onConnectionChange:e=>{i.current.onConnectionChange?.(e),p(t=>{switch(e.status){case`connecting`:return{...t,status:`connecting`,error:e.error??null};case`pending`:return t;case`idle`:return{...t,status:`idle`,data:null,error:null};default:return t}})}});s.current=()=>e()},[e(n.subcriptionKey),n.enabled]),l=t.useCallback(()=>n.enabled?{data:null,error:null,status:`connecting`,reset:c}:{data:null,error:null,status:`idle`,reset:c},[n.enabled,c]),u=t.useRef(l()),[d,f]=t.useState(r(u,o));d.reset=c;let p=t.useCallback(e=>{let t=u.current,n=u.current=e(t),i=!1;for(let e of a.current)if(t[e]!==n[e]){i=!0;break}i&&f(r(u,o))},[o]);return t.useEffect(()=>{if(n.enabled)return c(),()=>s.current()},[e(n.subcriptionKey),n.enabled]),d}function r(e,t){return new Proxy(e.current,{get(n,r){return t(r),e.current[r]}})}export{n as useSubscription};

package/dist/types-A-WfeH_j.d.mts

@@ -0,0 +1,110 @@
+import { DefaultError, MutationOptions, QueryKey, QueryObserverOptions } from "@tanstack/query-core";
+import { Input } from "effect/Duration";
+import { Schema } from "effect/Schema";
+import { Client } from "effect/unstable/httpapi/HttpApiClient";
+import { HttpApiEndpoint } from "effect/unstable/httpapi/HttpApiEndpoint";
+import { SseEventFromData, StreamSse } from "effect/unstable/httpapi/HttpApiSchema";
+//#region src/types.d.ts
+type TanstackQueryOptionsProxy<T> = T extends Client.Method<HttpApiEndpoint<infer _Identifier, infer Method, infer _Path, infer Params, infer Query, infer Payload, infer Headers, infer Success, infer Error, infer _Middleware, infer _MiddlewareService>, infer _Error, infer _Requires> ? {
+  queryOptions: Method extends 'GET' ? <TQuery = QueryOptions<UnwrapCodec<Success>, UnwrapCodec<Error>>>(input: MakeOptionalInput<([Params] extends [never] ? unknown : {
+    params: UnwrapCodec<Params>;
+  }) & ([Query] extends [never] ? unknown : {
+    query: UnwrapCodec<Query>;
+  }) & ([Headers] extends [never] ? unknown : {
+    headers: UnwrapCodec<Headers>;
+  })>, options?: Omit<TQuery, 'queryKey' | 'queryFn'>) => TQuery : never;
+  subscriptionOptions: Success extends StreamSse<SseEventFromData<infer StreamSuccess>, infer StreamError, infer _StreamValue> ? (input: MakeOptionalInput<([Params] extends [never] ? unknown : {
+    params: UnwrapCodec<Params>;
+  }) & ([Query] extends [never] ? unknown : {
+    query: UnwrapCodec<Query>;
+  }) & ([Headers] extends [never] ? unknown : {
+    headers: UnwrapCodec<Headers>;
+  })>, options?: Omit<SubscriptionOptions<UnwrapCodec<StreamSuccess>, UnwrapCodec<StreamError>>, 'subcriptionKey' | 'subscriptionFn'>) => SubscriptionOptions<UnwrapCodec<StreamSuccess>, UnwrapCodec<StreamError>> : never;
+  mutationOptions: Method extends 'GET' ? never : <TMutation = MutationOptions<UnwrapCodec<Success>, UnwrapCodec<Error>, UnwrapCodec<Payload>>>(input: MakeOptionalInput<([Params] extends [never] ? unknown : {
+    params: UnwrapCodec<Params>;
+  }) & ([Headers] extends [never] ? unknown : {
+    headers: UnwrapCodec<Headers>;
+  })>, options?: Omit<TMutation, 'mutationKey' | 'mutationFn'>) => TMutation;
+  getQueryKey: Method extends 'GET' ? (input?: Partial<MakeOptionalInput<([Params] extends [never] ? unknown : {
+    params: UnwrapCodec<Params>;
+  }) & ([Query] extends [never] ? unknown : {
+    query: UnwrapCodec<Query>;
+  }) & ([Headers] extends [never] ? unknown : {
+    headers: UnwrapCodec<Headers>;
+  })>>) => QueryKey : never;
+} : T extends object ? { readonly [K in keyof T as K extends symbol ? never : K]: TanstackQueryOptionsProxy<T[K]>; } : T;
+interface SubscriptionOptions<TData, TError> {
+  /**
+   * Determines whether the subscription is active. If set to `false`, the subscription will not be initiated.
+   * Default is `true`.
+   */
+  enabled?: boolean;
+  /**
+   * Configuration for the heartbeat keep-alive mechanism to prevent connection timeouts.
+   *
+   * @property{string} message The string payload sent by the server to maintain the connection. Default is `":keep-alive"`.
+   * @property{Input} timeout The maximum duration to wait for a heartbeat or data payload before timing out and reconnecting. Default is `10 seconds`.
+   */
+  keepAlive?: {
+    message?: string;
+    timeout?: Input;
+  };
+  /**
+   * Defines the retry schedule or delay duration before attempting to reconnect when the stream disconnects or fails.
+   * Accepts an `Effect.Duration.Input` (e.g., `"3 seconds"`, `3000`, or `Duration.seconds(3)`).
+   */
+  autoReconnect?: Input;
+  /**
+   * A unique key that identifies the subscription. This key is used for caching and managing the subscription state.
+   */
+  subcriptionKey: readonly unknown[];
+  /**
+   * Initiates the subscription.
+   *
+   * @param options.signal An `AbortSignal` used to cancel the active subscription.
+   * @param options.keepAliveTimeout Maximum duration to wait for data or server `:keep-alive` events before timing out. Default is 10 seconds.
+   */
+  subscriptionFn: (options: Omit<SubscriptionOptions<TData, TError>, 'enabled' | 'subcriptionKey' | 'subscriptionFn'>) => () => void;
+  /**
+   * Callback invoked when the subscription is started.
+   */
+  onStarted?: () => void;
+  /**
+   * Callback invoked when new data is received from the subscription.
+   */
+  onData?: (data: TData) => void;
+  /**
+   * Callback invoked when an error occurs during the subscription.
+   */
+  onError?: (error: TError) => void;
+  /**
+   * Callback invoked when the connection's status changes
+   */
+  onConnectionChange?: (result: Partial<SubscriptionReturns<TData, TError>>) => void;
+}
+type QueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
+  subscribed?: boolean;
+};
+type SubscriptionReturns<TData, TError> = {
+  reset: () => void;
+} & ({
+  status: 'idle';
+  data: null;
+  error: null;
+} | {
+  status: 'connecting';
+  data: TData | null;
+  error: TError | null;
+} | {
+  status: 'pending';
+  data: TData | null;
+  error: null;
+} | {
+  status: 'error';
+  data: TData | null;
+  error: TError;
+});
+type UnwrapCodec<T> = T extends Schema<unknown> ? Schema.Type<T> : T extends object ? { [K in keyof T]: UnwrapCodec<T[K]>; } : T;
+type MakeOptionalInput<T> = keyof T extends never ? void | undefined : T;
+//#endregion
+export { SubscriptionReturns as n, TanstackQueryOptionsProxy as r, SubscriptionOptions as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiesen/effect-tanstack-query",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "private": false,
   "description": "Effortlessly bridge Effect HTTP API clients with TanStack Query. Enjoy end-to-end type safety, zero-boilerplate options, and built-in streaming support out of the box.",
   "keywords": [
@@ -67,11 +67,6 @@
     "effect": ">=4.0.0-beta.100 || >=4.0.0",
     "react": ">=19.2.8"
   },
-  "peerDependenciesMeta": {
-    "react": {
-      "optional": true
-    }
-  },
   "packageManager": "bun@1.3.0",
   "patchedDependencies": {
     "tegami@1.3.1": "patches/tegami@1.3.1.patch"

package/dist/types-MoWlEtTb.d.mts

@@ -1,59 +0,0 @@
-import { DefaultError, MutationOptions, QueryKey, QueryObserverOptions } from "@tanstack/query-core";
-import { Input } from "effect/Duration";
-import { Schema } from "effect/Schema";
-import { Client } from "effect/unstable/httpapi/HttpApiClient";
-import { HttpApiEndpoint } from "effect/unstable/httpapi/HttpApiEndpoint";
-import { SseEventFromData, StreamSse } from "effect/unstable/httpapi/HttpApiSchema";
-//#region src/types.d.ts
-type TanstackQueryOptionsProxy<T> = T extends Client.Method<HttpApiEndpoint<infer _Key, infer Method, infer _Path, infer Params, infer Query, infer Payload, infer Headers, infer Success, infer Error, infer _Middleware>, infer _Error, infer _Requires> ? {
-  queryOptions: Method extends 'GET' ? <TQuery = QueryOptions<UnwrapCodec<Success>, UnwrapCodec<Error>>>(input: MakeOptionalInput<([Params] extends [never] ? {} : {
-    params: UnwrapCodec<Params>;
-  }) & ([Query] extends [never] ? {} : {
-    query: UnwrapCodec<Query>;
-  }) & ([Headers] extends [never] ? {} : {
-    headers: UnwrapCodec<Headers>;
-  })>, options?: Omit<TQuery, 'queryKey' | 'queryFn'>) => TQuery : never;
-  subscriptionOptions: Success extends StreamSse<SseEventFromData<infer StreamSuccess>, infer StreamError, infer _StreamValue> ? (input: MakeOptionalInput<([Params] extends [never] ? {} : {
-    params: UnwrapCodec<Params>;
-  }) & ([Query] extends [never] ? {} : {
-    query: UnwrapCodec<Query>;
-  }) & ([Headers] extends [never] ? {} : {
-    headers: UnwrapCodec<Headers>;
-  })>, options?: {
-    onData: (data: UnwrapCodec<StreamSuccess>) => void;
-    onError?: (error: UnwrapCodec<StreamError>) => void;
-  }) => SubscriptionOptions<UnwrapCodec<StreamSuccess>, UnwrapCodec<StreamError>> : never;
-  mutationOptions: Method extends 'GET' ? never : <TMutation = MutationOptions<UnwrapCodec<Success>, UnwrapCodec<Error>, UnwrapCodec<Payload>>>(input: MakeOptionalInput<([Params] extends [never] ? {} : {
-    params: UnwrapCodec<Params>;
-  }) & ([Headers] extends [never] ? {} : {
-    headers: UnwrapCodec<Headers>;
-  })>, options?: Omit<TMutation, 'mutationKey' | 'mutationFn'>) => TMutation;
-  getQueryKey: Method extends 'GET' ? (input?: Partial<MakeOptionalInput<([Params] extends [never] ? {} : {
-    params: UnwrapCodec<Params>;
-  }) & ([Query] extends [never] ? {} : {
-    query: UnwrapCodec<Query>;
-  }) & ([Headers] extends [never] ? {} : {
-    headers: UnwrapCodec<Headers>;
-  })>>) => readonly unknown[] : never;
-} : T extends object ? { readonly [K in keyof T]: TanstackQueryOptionsProxy<T[K]>; } : T;
-type UnsubscribeFn = () => void;
-interface SubscriptionOptions<TData, TError> {
-  subcriptionKey: readonly unknown[];
-  subscriptionFn: (options: {
-    signal?: AbortSignal;
-  }) => UnsubscribeFn;
-  onData: (data: TData) => void;
-  onError?: (error: TError) => void;
-  keepAliveTimeout?: Input;
-}
-type QueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
-  subscribed?: boolean;
-};
-interface SubscriptionReturns {
-  status: 'connecting' | 'connected' | 'disconnected' | 'error';
-  reconnect: () => void;
-}
-type UnwrapCodec<T> = T extends Schema<unknown> ? Schema.Type<T> : T extends object ? { [K in keyof T]: UnwrapCodec<T[K]>; } : T;
-type MakeOptionalInput<T> = keyof T extends never ? void | undefined : T;
-//#endregion
-export { SubscriptionReturns as n, TanstackQueryOptionsProxy as r, SubscriptionOptions as t };