@effect-app/vue 2.88.2 → 2.89.0

package/src/makeClient.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import * as Result from "@effect-atom/atom/Result"
-import { type InitialDataFunction, type InvalidateOptions, type InvalidateQueryFilters, isCancelledError, type QueryObserverResult, type RefetchOptions, type UseQueryReturnType } from "@tanstack/vue-query"
+import { type InvalidateOptions, type InvalidateQueryFilters, isCancelledError, type QueryObserverResult, type RefetchOptions, type UseQueryReturnType } from "@tanstack/vue-query"
 import { camelCase } from "change-case"
 import { Cause, Effect, Exit, type ManagedRuntime, Match, Option, Runtime, S, Struct } from "effect-app"
 import { type ApiClientFactory, type Req } from "effect-app/client"
@@ -20,7 +20,7 @@ import { Toast } from "./experimental/toast.js"
 import { buildFieldInfoFromFieldsRoot } from "./form.js"
 import { reportRuntimeError } from "./lib.js"
 import { asResult, makeMutation, type MutationOptions, type MutationOptionsBase, mutationResultToVue, type Res, useMakeMutation } from "./mutate.js"
-import { type CustomDefinedInitialQueryOptions, type CustomUndefinedInitialQueryOptions, type KnownFiberFailure, makeQuery } from "./query.js"
+import { type CustomUndefinedInitialQueryOptions, type KnownFiberFailure, makeQuery } from "./query.js"
 
 const mapHandler = <A, E, R, I = void, A2 = A, E2 = E, R2 = R>(
   handler: Effect.Effect<A, E, R> | ((i: I) => Effect.Effect<A, E, R>),
@@ -1120,25 +1120,6 @@ export class QueryImpl<R> {
           UseQueryReturnType<any, any>
         ]
       >
-      /**
-       * The difference with useQuery is that this function will return a Promise you can await in the Setup,
-       * which ensures that either there always is a latest value, or an error occurs on load.
-       * So that Suspense and error boundaries can be used.
-       */
-      <TData = A>(
-        options?: CustomDefinedInitialQueryOptions<A, E, TData> & {
-          initialData: TData | InitialDataFunction<TData>
-        }
-      ): Promise<
-        readonly [
-          ComputedRef<Result.Result<TData, E>>,
-          ComputedRef<TData>,
-          (
-            options?: RefetchOptions
-          ) => Effect.Effect<QueryObserverResult<TData, KnownFiberFailure<E>>>,
-          UseQueryReturnType<any, any>
-        ]
-      >
     }
     /**
      * The difference with useQuery is that this function will return a Promise you can await in the Setup,
@@ -1154,24 +1135,6 @@ export class QueryImpl<R> {
     >(
       self: RequestHandlerWithInput<Arg, A, E, R, Request, Name>
     ): {
-      /**
-       * The difference with useQuery is that this function will return a Promise you can await in the Setup,
-       * which ensures that either there always is a latest value, or an error occurs on load.
-       * So that Suspense and error boundaries can be used.
-       */
-      <TData = A>(
-        arg: Arg | WatchSource<Arg>,
-        options?: CustomDefinedInitialQueryOptions<A, E, TData>
-      ): Promise<
-        readonly [
-          ComputedRef<Result.Result<TData, E>>,
-          ComputedRef<TData>,
-          (
-            options?: RefetchOptions
-          ) => Effect.Effect<QueryObserverResult<TData, KnownFiberFailure<E>>>,
-          UseQueryReturnType<any, any>
-        ]
-      >
       /**
        * The difference with useQuery is that this function will return a Promise you can await in the Setup,
        * which ensures that either there always is a latest value, or an error occurs on load.
@@ -1518,6 +1481,8 @@ export type ToCamel<S extends string | number | symbol> = S extends string
 export interface CommandBase<I = void, A = void> {
   handle: (input: I) => A
   waiting: boolean
+  blocked: boolean
+  allowed: boolean
   action: string
   label: string
 }

package/src/query.ts

@@ -55,6 +55,11 @@ export interface CustomDefinedInitialQueryOptions<
   TQueryKey extends QueryKey = QueryKey
 > extends CustomUseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
   initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>)
+  placeholderData?:
+    | undefined
+    | NonFunctionGuard<TQueryData>
+    | PlaceholderDataFunction<NonFunctionGuard<TQueryData>, TError, NonFunctionGuard<TQueryData>, TQueryKey>
+    | undefined
 }
 
 export interface CustomDefinedPlaceholderQueryOptions<
@@ -64,6 +69,7 @@ export interface CustomDefinedPlaceholderQueryOptions<
   TQueryData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey
 > extends CustomUseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
+  initialData?: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>) | undefined
   placeholderData:
     | NonFunctionGuard<TQueryData>
     | PlaceholderDataFunction<NonFunctionGuard<TQueryData>, TError, NonFunctionGuard<TQueryData>, TQueryKey>
@@ -81,7 +87,7 @@ export const makeQuery = <R>(getRuntime: () => Runtime.Runtime<R>) => {
         | RequestHandler<A, E, R, Request, Name>
     ): {
       <TData = A>(
-        arg?: I | WatchSource<I>,
+        arg: I | WatchSource<I> | undefined,
         options?: CustomUndefinedInitialQueryOptions<A, E, TData>
       ): readonly [
         ComputedRef<Result.Result<TData, E>>,
@@ -91,8 +97,8 @@ export const makeQuery = <R>(getRuntime: () => Runtime.Runtime<R>) => {
       ]
 
       <TData = A>(
-        arg?: I | WatchSource<I>,
-        options?: CustomDefinedInitialQueryOptions<A, E, TData>
+        arg: I | WatchSource<I> | undefined,
+        options: CustomDefinedInitialQueryOptions<A, E, TData>
       ): readonly [
         ComputedRef<Result.Result<TData, E>>,
         ComputedRef<TData>,
@@ -101,18 +107,8 @@ export const makeQuery = <R>(getRuntime: () => Runtime.Runtime<R>) => {
       ]
 
       <TData = A>(
-        arg?: I | WatchSource<I>,
-        options?: CustomDefinedPlaceholderQueryOptions<A, E, TData>
-      ): readonly [
-        ComputedRef<Result.Result<TData, E>>,
-        ComputedRef<TData>,
-        (options?: RefetchOptions) => Effect.Effect<QueryObserverResult<TData, KnownFiberFailure<E>>, never, never>,
-        UseQueryDefinedReturnType<TData, KnownFiberFailure<E>>
-      ]
-
-      <TData = A>(
-        arg?: I | WatchSource<I>,
-        options?: CustomUseQueryOptions<A, E, TData>
+        arg: I | WatchSource<I> | undefined,
+        options: CustomDefinedPlaceholderQueryOptions<A, E, TData>
       ): readonly [
         ComputedRef<Result.Result<TData, E>>,
         ComputedRef<TData>,
@@ -126,7 +122,7 @@ export const makeQuery = <R>(getRuntime: () => Runtime.Runtime<R>) => {
       | RequestHandler<A, E, R, Request, Name>
   ) =>
   <TData = A>(
-    arg?: I | WatchSource<I>,
+    arg: I | WatchSource<I> | undefined,
     // todo QueryKey type would be [string, ...string[]], but with I it would be [string, ...string[], I]
     options?: any
     // TODO
@@ -267,7 +263,7 @@ export const makeQuery = <R>(getRuntime: () => Runtime.Runtime<R>) => {
         UseQueryReturnType<any, any>
       ]
       <TData = A>(
-        options?: CustomDefinedPlaceholderQueryOptions<A, E, TData>
+        options: CustomDefinedPlaceholderQueryOptions<A, E, TData>
       ): readonly [
         ComputedRef<Result.Result<TData, E>>,
         ComputedRef<TData>,
@@ -326,8 +322,8 @@ export const makeQuery = <R>(getRuntime: () => Runtime.Runtime<R>) => {
         arg: Arg | WatchSource<Arg>,
         options?: CustomUndefinedInitialQueryOptions<A, KnownFiberFailure<E>, TData>
       ): readonly [
-        ComputedRef<Result.Result<A, E>>,
-        ComputedRef<A | undefined>,
+        ComputedRef<Result.Result<TData, E>>,
+        ComputedRef<TData | undefined>,
         (options?: RefetchOptions) => Effect.Effect<QueryObserverResult<TData, KnownFiberFailure<E>>>,
         UseQueryReturnType<any, any>
       ]

package/test/makeClient.test.ts

@@ -2,6 +2,39 @@
 import { type Effect } from "effect-app"
 import { Something, useClient, useExperimental } from "./stubs.js"
 
+it.skip("works2", () => {
+  const { legacy } = useClient()
+  const n = legacy.useQuery({
+    Request: null as any,
+    handler: null as any as (a: string) => Effect.Effect<number>,
+    id: "id"
+  })
+
+  const [, z] = n("a")
+  const valz = z.value
+  expectTypeOf(valz).toEqualTypeOf<number | undefined>()
+
+  const [, a] = n("a", { placeholderData: () => 123 })
+  const val1 = a.value
+  expectTypeOf(val1).toEqualTypeOf<number>()
+
+  const [, bbbb] = n("a", { select: (data) => data.toString() })
+  const val = bbbb.value
+  expectTypeOf(val).toEqualTypeOf<string | undefined>()
+
+  const [, ccc] = n("a", { placeholderData: () => 123, select: (data) => data.toString() })
+  const val2 = ccc.value
+  expectTypeOf(val2).toEqualTypeOf<string>()
+
+  const [, ddd] = n("a", { initialData: 123, select: (data) => data.toString() })
+  const val3 = ddd.value
+  expectTypeOf(val3).toEqualTypeOf<string>()
+
+  const [, eee] = n("a", { initialData: 123, placeholderData: () => 123, select: (data) => data.toString() })
+  const val4 = eee.value
+  expectTypeOf(val4).toEqualTypeOf<string>()
+})
+
 it.skip("works", () => {
   const { clientFor, legacy } = useClient()
   const client = clientFor(Something)