@effect-app/vue 4.0.0-beta.18 → 4.0.0-beta.180

package/test/makeClient.test.ts

@@ -1,95 +1,298 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-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"
+import { S } from "effect-app"
+import { configureInvalidation, makeQueryKey } from "effect-app/client"
+import * as Exit from "effect/Exit"
+import { Something, SomethingElse, SomethingElseReq, SomethingReq, useClient, useExperimental } from "./stubs.js"
+
+const somethingInvalidationResources = {
+  Something: {
+    GetSomething2: Something.GetSomething2,
+    GetSomething2WithDependencies: Something.GetSomething2WithDependencies,
+    GetSomething3: Something.GetSomething3,
+    GetSomething4: Something.GetSomething4
+  }
+}
+
+it("TaggedRequestFor .moduleName and request .id / .moduleName", () => {
+  expectTypeOf(SomethingReq.moduleName).toEqualTypeOf<"Something">()
+  expectTypeOf(SomethingElseReq.moduleName).toEqualTypeOf<"SomethingElse">()
+
+  expectTypeOf(Something.GetSomething2.moduleName).toEqualTypeOf<"Something">()
+  expectTypeOf(Something.GetSomething2.id).toEqualTypeOf<"Something.GetSomething2">()
+  expectTypeOf(Something.GetSomething2.type).toEqualTypeOf<"query">()
+  expectTypeOf(Something.DoSomething.type).toEqualTypeOf<"command">()
+
+  expectTypeOf(SomethingElse.GetSomething2.moduleName).toEqualTypeOf<"SomethingElse">()
+  expectTypeOf(SomethingElse.GetSomething2.id).toEqualTypeOf<"SomethingElse.GetSomething2">()
+
+  const invalidates = configureInvalidation<{
+    Something: typeof Something
+    SomethingElse: typeof SomethingElse
+  }>()((queryKey, { Something, SomethingElse }) => [
+    { filters: { queryKey } },
+    { filters: { queryKey: makeQueryKey(Something.GetSomething2) } },
+    { filters: { queryKey: makeQueryKey(SomethingElse.GetSomething2) } }
+  ])
+
+  expectTypeOf(invalidates.invalidatesQueries).toBeFunction()
+  configureInvalidation<{ Something: typeof Something }>()((_queryKey, { Something }) => {
+    // @ts-expect-error commands are intentionally excluded from configured resources
+    void Something.DoSomething
+    return []
   })
 
-  const [, z] = n("a")
+  const { clientFor } = useClient()
+  const client = clientFor(
+    Something,
+    undefined,
+    somethingInvalidationResources
+  )
+
+  // only queries, no commands, and no commands who require resources; shouldn't require invalidation resources args!
+  clientFor({ GetSomething: Something.GetSomething2 })
+
+  // @ts-expect-error invalidation resources should be required when any command configures them
+  clientFor(Something)
+
+  // @ts-expect-error invalidation resources for this module reject extra top-level resources
+  clientFor(Something, undefined, { ...somethingInvalidationResources, SomethingElse })
+
+  const doSomethingInvalidation = client.DoSomething.Request.config["invalidatesQueries"]
+  if (doSomethingInvalidation) {
+    const entries = doSomethingInvalidation(
+      ["$Something"],
+      somethingInvalidationResources,
+      { id: "abc" },
+      Exit.succeed(123)
+    )
+    expect(Array.isArray(entries)).toBe(true)
+  }
+
+  const SomethingCommand = SomethingReq.Command
+
+  class TypeInferenceWithSuccess extends SomethingCommand<TypeInferenceWithSuccess>()("TypeInferenceWithSuccess", {
+    id: S.String
+  }, {
+    success: S.FiniteFromString
+  }, (_queryKey, _resources, input, result) => {
+    expectTypeOf(input).toEqualTypeOf<{ readonly id: string }>()
+    expectTypeOf(result).toEqualTypeOf<Exit.Exit<number, never>>()
+    return []
+  }) {}
+  void TypeInferenceWithSuccess
+
+  class TypeInferenceWithoutSuccess extends SomethingCommand<TypeInferenceWithoutSuccess>()(
+    "TypeInferenceWithoutSuccess",
+    {
+      id: S.String
+    },
+    {},
+    (_queryKey, _resources, input, result) => {
+      expectTypeOf(input).toEqualTypeOf<{ readonly id: string }>()
+      expectTypeOf(result).toEqualTypeOf<Exit.Exit<void, never>>()
+      return []
+    }
+  ) {}
+  void TypeInferenceWithoutSuccess
+
+  type MixedResources = {
+    Something: typeof Something
+    Misc: {
+      value: number
+      GetSomething2: typeof Something.GetSomething2
+    }
+  }
+
+  class TypeInferenceResourceFiltering extends SomethingCommand<
+    TypeInferenceResourceFiltering,
+    MixedResources
+  >()("TypeInferenceResourceFiltering", {
+    id: S.String
+  }, {
+    success: S.FiniteFromString
+  }, (_queryKey, resources, _input, _result) => {
+    expectTypeOf(resources.Something.GetSomething2).toEqualTypeOf<typeof Something.GetSomething2>()
+    expectTypeOf(resources.Misc.GetSomething2).toEqualTypeOf<typeof Something.GetSomething2>()
+
+    // @ts-expect-error commands must be filtered from invalidation resources
+    void resources.Something.DoSomething
+    // @ts-expect-error non-query values must be filtered from invalidation resources
+    void resources.Misc.value
+
+    return []
+  }) {}
+  void TypeInferenceResourceFiltering
+
+  type WithSuccessInvalidation = NonNullable<typeof TypeInferenceWithSuccess.config.invalidatesQueries> // @ts-expect-error input should be required when command payload is non-empty
+  ;((_queryKey, _resources) => []) satisfies WithSuccessInvalidation
+})
+
+it.skip("query type tests", () => {
+  const { clientFor } = useClient()
+  const client = clientFor(
+    Something,
+    () => ({
+      GetSomething2WithDependencies: (queryKey) => [
+        { filters: { queryKey } },
+        {
+          filters: {
+            queryKey: makeQueryKey(
+              SomethingElse
+                .GetSomething2
+            )
+          }
+        }
+      ]
+    }),
+    somethingInvalidationResources
+  )
+
+  const q = client.GetSomething2.query
+
+  const [, z] = q({ id: "a" })
   const valz = z.value
   expectTypeOf(valz).toEqualTypeOf<number | undefined>()
 
-  const [, a] = n("a", { placeholderData: () => 123 })
+  const [, a] = q({ id: "a" }, { placeholderData: () => 123 })
   const val1 = a.value
   expectTypeOf(val1).toEqualTypeOf<number>()
 
-  const [, bbbb] = n("a", { select: (data) => data.toString() })
+  const [, bbbb] = q({ id: "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 [, ccc] = q({ id: "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 [, ddd] = q({ id: "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 [, eee] = q({ id: "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)
+  const { clientFor } = useClient()
+  const client = clientFor(Something, undefined, somethingInvalidationResources)
   const Command = useExperimental()
 
   // just for jsdoc / type testing.
-  const a0 = client.GetSomething2(null as any)
-  const a00 = client.GetSomething2.mutate(null as any)
+  const a0 = client.GetSomething2.request(null as any)
+  const a00 = client.DoSomething.mutate(null as any)
   const a = client.GetSomething2.suspense(null as any)
   const b = client.GetSomething2.query(null as any)
 
-  const c0 = legacy.useSafeMutation(null as any)
-  const c = legacy.useQuery(null as any)
-  const d = legacy.useSuspenseQuery(null as any)
+  const de = client.GetSomething3.handler(null as any)
+  const de2 = client.GetSomething3.handler({ id: null })
+
+  // @ts-expect-error not callable as it requires no input
+  const de3 = client.GetSomething4.handler(null as any)
+  void client.GetSomething4.handler
 
+  // @ts-expect-error query requests no longer expose command helpers
   const e = client.GetSomething2.wrap(null as any)
+  // @ts-expect-error query requests no longer expose command helpers
   const f = client.GetSomething2.fn(null as any)
 
-  // @ts-expect-error dependencies required that are not provided
-  const e0 = client.GetSomething2WithDependencies.wrap().handle // not available as we require dependencies not provided by the runtime
-  // @ts-expect-error dependencies required that are not provided
-  const e000 = Command.wrap(client.GetSomething2WithDependencies)().handle // not available as we require dependencies not provided by the runtime
-  const e00 = client.GetSomething2WithDependencies.wrap((_) => _ as Effect.Effect<number, never, never>).handle(
-    null as any
-  )
-  const e0000 =
-    Command.wrap(client.GetSomething2WithDependencies)((_) => _ as Effect.Effect<number, never, never>).handle
+  // @ts-expect-error query requests no longer expose command helpers
+  const e0 = client.GetSomething2WithDependencies.wrap
+  // @ts-expect-error query request does not match Command.wrap mutation signature
+  const e000 = Command.wrap(client.GetSomething2WithDependencies)
+  const e00 = client.GetSomething2WithDependencies.request(null as any)
   // @ts-expect-error dependencies required that are not provided
   const e1 = client.GetSomething2WithDependencies.suspense(null as any)
   // @ts-expect-error dependencies required that are not provided
   const e2 = client.GetSomething2WithDependencies.query(null as any)
+  // @ts-expect-error query requests no longer expose command helpers
   const f0 = client.GetSomething2WithDependencies.fn(null as any)
 
-  const g = client.GetSomething2.mutate.wrap(null as any)
-  const h = client.GetSomething2.mutate.fn(null as any)
+  const g0 = client.DoSomething.wrap(null as any)
+  const g = client.DoSomething.mutate.wrap(null as any)
+  const g1 = client.DoSomething.mutate.project(S.String)
+  const g2 = g1(null as any)
+  const g3 = g1.wrap(null as any)
+  const g4 = client.helpers.doSomethingMutation.project(S.String)
+  const g5 = g4(null as any)
+  const g6 = g4.wrap(null as any)
+  // @ts-expect-error mutate no longer exposes fn, use client.DoSomething.fn
+  const h = client.DoSomething.mutate.fn(null as any)
+
+  // projection
+  // GetSomething2 uses FiniteFromString, that means Codec is String -> Number
+  // when we project that to S.String, it should work as the encoded shapes are identical
+  // aka, when we project, we skip decoding with the original codec, and instead use the provided one
+  // we have to make sure the Encoded shape of the provided projection schema matches the Encoded Shape of the original codec.
+  const projected = client.GetSomething2.project(S.String)
+  // @ts-expect-error encoded type mismatch: original encodes to string, S.Number encodes to number
+  client.GetSomething2.project(S.Number)
+  const p0 = projected.request(null as any)
+
+  // struct example: success schema encodes to { a: string | null }
+  // good: projection schema also expects { a: string | null } on the encoded side
+  const projectedStruct = client.GetStructNullable.project(S.Struct({ a: S.NullOr(S.String) }))
+  // bad: { a: S.String } has encoded type { a: string } — does not accept null
+  // @ts-expect-error encoded type mismatch: original encodes to { a: string | null }, projection expects { a: string }
+  client.GetStructNullable.project(S.Struct({ a: S.String }))
+
+  const p00 = projected.query(null as any)
+  const p = projected.suspense(null as any)
 
   expect(true).toBe(true)
   console.log({
     a,
     a0,
     a00,
-    c0,
     b,
-    c,
-    d,
     e,
+    de,
+    de2,
+    de3,
     e0,
     e00,
     e000,
-    e0000,
     e1,
     e2,
     f,
     f0,
+    g0,
     g,
-    h
+    g1,
+    g2,
+    g3,
+    g4,
+    g5,
+    g6,
+    h,
+    p0,
+    p00,
+    p,
+    projectedStruct
   })
 })
+
+it.skip("stream final type tests", () => {
+  const { clientFor } = useClient()
+  const client = clientFor(Something, undefined, somethingInvalidationResources)
+
+  const [_refNoFinal, execNoFinal] = client.StreamWithoutFinal.mutateStream
+  const [_refWithFinal, execWithFinal] = client.StreamWithFinal.mutateStream
+
+  // Without `final`: execute input is {id: string} and resolves with void
+  const _execNoFinalResult: ReturnType<typeof execNoFinal> = execNoFinal({ id: "test" })
+  // @ts-expect-error result of execNoFinal should be void-typed, not ExportComplete
+  const _badAssign: import("effect").Effect.Effect<import("./stubs.js").ExportComplete, never, never> =
+    _execNoFinalResult
+
+  // With `final: ExportComplete`: execute resolves with ExportComplete
+  const _execWithFinalResult: ReturnType<typeof execWithFinal> = execWithFinal({ id: "test" })
+  // Assignment should compile — result IS Effect<ExportComplete, ...>
+  const _goodAssign: import("effect").Effect.Effect<import("./stubs.js").ExportComplete, never, never> =
+    _execWithFinalResult
+  void _execNoFinalResult
+  void _execWithFinalResult
+  void _goodAssign
+  void _badAssign
+})

package/test/streamFinal.test.ts

@@ -0,0 +1,110 @@
+/**
+ * Runtime and type tests for the `final` schema on stream requests.
+ *
+ * The `final` option on a stream request schema lets callers model which type
+ * the last emitted stream element is.  When present, the execute effect returned
+ * by `mutateStream` resolves with that final value instead of `void`.
+ */
+import { it } from "@effect/vitest"
+import { Effect, S } from "effect-app"
+import * as Stream from "effect/Stream"
+import { asStreamResult } from "../src/mutate.js"
+import { ExportComplete, OperationProgress, Something, useClient } from "./stubs.js"
+
+const somethingInvalidationResources = {
+  Something: {
+    GetSomething2: Something.GetSomething2,
+    GetSomething2WithDependencies: Something.GetSomething2WithDependencies,
+    GetSomething3: Something.GetSomething3,
+    GetSomething4: Something.GetSomething4
+  }
+}
+
+// ---------------------------------------------------------------------------
+// asStreamResult — low-level primitive, always returns void
+// ---------------------------------------------------------------------------
+
+it.live("asStreamResult returns void and updates ref with each element", () =>
+  Effect.gen(function*() {
+    const events: number[] = [1, 2, 3]
+    const [ref, execute] = asStreamResult(() => Stream.fromIterable(events))
+
+    yield* execute()
+
+    // ref should hold the last emitted value
+    expect(ref.value._tag).toBe("Success")
+    if (ref.value._tag === "Success") {
+      expect(ref.value.value).toBe(3)
+      expect(ref.value.waiting).toBe(false)
+    }
+  }))
+
+// ---------------------------------------------------------------------------
+// mutateStream with no `final` — execute resolves with void (type-level)
+// ---------------------------------------------------------------------------
+
+it.skip("mutateStream without final: execute resolves void (type-level)", () => {
+  const { clientFor } = useClient()
+  const client = clientFor(Something, undefined, somethingInvalidationResources)
+
+  const [_ref, execute] = client.StreamWithoutFinal.mutateStream
+
+  // execute returns void — assigning to ExportComplete Effect should fail
+  const result = execute({ id: "test" })
+  // @ts-expect-error result should be void-typed, not ExportComplete
+  const _bad: import("effect").Effect.Effect<ExportComplete, never, never> = result
+  void _bad
+})
+
+// ---------------------------------------------------------------------------
+// mutateStream with `final` — execute resolves with Final type (type-level)
+// ---------------------------------------------------------------------------
+
+it.skip("mutateStream with final: execute resolves with ExportComplete (type-level)", () => {
+  const { clientFor } = useClient()
+  const client = clientFor(Something, undefined, somethingInvalidationResources)
+
+  const [_ref, execute] = client.StreamWithFinal.mutateStream
+
+  // execute returns ExportComplete — assignment should compile cleanly
+  const result = execute({ id: "test" })
+  const _ok: import("effect").Effect.Effect<ExportComplete, never, never> = result
+  void _ok
+})
+
+// ---------------------------------------------------------------------------
+// Request class — final schema stored on class
+// ---------------------------------------------------------------------------
+
+it("stream request without final: .final is undefined", () => {
+  const req = Something.StreamWithoutFinal
+  expect((req as any).final).toBeUndefined()
+})
+
+it("stream request with final: .final holds the ExportComplete schema", () => {
+  const req = Something.StreamWithFinal
+  expect((req as any).final).toBeDefined()
+  // Verify the schema decodes correctly
+  const decoded = S.decodeUnknownSync((req as any).final)({ _tag: "ExportComplete", fileUrl: "https://x.com" })
+  expect(decoded).toBeInstanceOf(ExportComplete)
+})
+
+// ---------------------------------------------------------------------------
+// Runtime: last stream value is accessible via the reactive ref after stream ends
+// ---------------------------------------------------------------------------
+
+it.live("last stream value is accessible via reactive ref after stream ends", () =>
+  Effect.gen(function*() {
+    const progress = new OperationProgress({ completed: 1 as S.NonNegativeInt, total: 2 as S.NonNegativeInt })
+    const complete = new ExportComplete({ fileUrl: "https://example.com/file.csv" as S.NonEmptyString })
+
+    const [ref, execute] = asStreamResult(() => Stream.make(progress, complete))
+
+    yield* execute()
+
+    expect(ref.value._tag).toBe("Success")
+    if (ref.value._tag === "Success") {
+      expect(ref.value.value).toBe(complete)
+      expect(ref.value.waiting).toBe(false)
+    }
+  }))