@affordant/react 0.2.0 → 0.3.0

package/README.md

@@ -1,8 +1,14 @@
 # @affordant/react
 
-React adapter for [Affordant](https://leroy-florian.github.io/Affordant/). Gate your UI on what the server offers, and invoke affordances with **either invoker** — the vanilla Promise one or the Effect one. The framework axis (React) and the effect-system axis (Promise / Effect) stay orthogonal and composable.
+React adapter for [Affordant](https://leroy-florian.github.io/Affordant/). Gate your UI on what the server offers, and follow affordances with hooks. No runtime dependency beyond React.
 
-## Gating (pure, invoker-agnostic)
+## Install
+
+```sh
+npm install @affordant/react react
+```
+
+## Gating
 
 ```tsx
 import { useAffordance } from '@affordant/react'
@@ -14,7 +20,7 @@ function CancelButton({ order }) {
 }
 ```
 
-## Vanilla (Promise) invoker
+## Following
 
 ```tsx
 import { useAffordance, useFollow } from '@affordant/react'
@@ -27,20 +33,20 @@ const { run, running } = useFollow()
 </button>
 ```
 
-## Effect invoker
+`run` resolves with the raw `Response` and re-throws on failure, with `error` set.
 
-The Effect path composes [`@affordant/effect`](https://www.npmjs.com/package/@affordant/effect) with the [`effect-react-bridge`](https://www.npmjs.com/package/effect-react-bridge) runtime — no Effect coupling leaks into the vanilla path.
+## Using Effect
 
-```ts
-import { makeEffectHooks } from 'effect-react-bridge'
-import { makeAffordanceHooks } from '@affordant/react/effect'
+There is no Effect entry point, and none is needed: `run` (and the underlying `follow`) return a `Promise<Response>`, which drops into Effect with a one-line wrap — `Effect.tryPromise(() => follow(action, init))`. Affordant stays Effect-compatible without shipping an Effect dependency.
 
-const bridge = makeEffectHooks({ runtime })
-const { useFollow } = makeAffordanceHooks(bridge)
-// useFollow().run(action, init) is now an interruptible Effect with a typed error
-```
+## API
+
+| Export | Description |
+|---|---|
+| `useAffordance(resource, rel)` | `{ can, action }` — memoised, null-safe gating over `can` / `actionFor`. |
+| `useFollow()` | `{ running, error, run }` — follow an action, tracking request state. |
 
-`react` is a peer dependency; `effect`, `effect-react-bridge` and `@affordant/effect` are optional peers, needed only for `@affordant/react/effect`.
+`react` is a peer dependency.
 
 ## License
 

package/dist/index.d.ts

@@ -27,9 +27,9 @@ export interface UseFollowResult extends FollowState {
     readonly run: (action: HateoasAction, init?: FollowInit) => Promise<Response>;
 }
 /**
- * The vanilla (Promise) invoker as a hook: tracks `running` / `error` around
- * the client's `follow`. This is one of Affordant's two interchangeable
- * invokers; for the Effect one, see `@affordant/react/effect`.
+ * Follow an affordance from a hook: tracks `running` / `error` around the
+ * client's `follow`. `run` resolves with the raw `Response` and re-throws on
+ * failure (with `error` set).
  */
 export declare function useFollow(): UseFollowResult;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -13,9 +13,9 @@ export function useAffordance(resource, rel) {
     return useMemo(() => ({ can: can(resource, rel), action: actionFor(resource, rel) }), [resource, rel]);
 }
 /**
- * The vanilla (Promise) invoker as a hook: tracks `running` / `error` around
- * the client's `follow`. This is one of Affordant's two interchangeable
- * invokers; for the Effect one, see `@affordant/react/effect`.
+ * Follow an affordance from a hook: tracks `running` / `error` around the
+ * client's `follow`. `run` resolves with the raw `Response` and re-throws on
+ * failure (with `error` set).
  */
 export function useFollow() {
     const [state, setState] = useState({ running: false, error: null });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@affordant/react",
-  "version": "0.2.0",
-  "description": "React adapter for Affordant: gate UI on the server's affordances and invoke them with either invoker — the vanilla Promise one or the Effect one.",
+  "version": "0.3.0",
+  "description": "React adapter for Affordant: gate UI on the server's affordances and follow them with hooks. Zero runtime dependencies beyond React.",
   "license": "MIT",
   "author": "Florian Leroy",
   "repository": {
@@ -26,10 +26,6 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
-    },
-    "./effect": {
-      "types": "./dist/effect.d.ts",
-      "import": "./dist/effect.js"
     }
   },
   "files": [
@@ -43,25 +39,7 @@
     "@affordant/contract": "^0.2.0"
   },
   "peerDependencies": {
-    "react": ">=18",
-    "effect": "^3.21.0",
-    "effect-react-bridge": ">=0.1.0",
-    "@affordant/effect": ">=0.1.0"
-  },
-  "peerDependenciesMeta": {
-    "effect": {
-      "optional": true
-    },
-    "effect-react-bridge": {
-      "optional": true
-    },
-    "@affordant/effect": {
-      "optional": true
-    }
-  },
-  "devDependencies": {
-    "@affordant/effect": "*",
-    "effect-react-bridge": "*"
+    "react": ">=18"
   },
   "scripts": {
     "build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.build.json",

package/dist/effect.d.ts

@@ -1,29 +0,0 @@
-import type { EffectHooks } from 'effect-react-bridge';
-import { type FollowError } from '@affordant/effect';
-import type { FollowInit } from 'affordant';
-import type { HateoasAction } from '@affordant/contract';
-export interface EffectFollowResult {
-    readonly running: boolean;
-    readonly error: FollowError | null;
-    readonly run: (action: HateoasAction, init?: FollowInit) => Promise<Response>;
-}
-export interface AffordanceEffectHooks {
-    /**
-     * The Effect invoker as a hook, run through the supplied
-     * `effect-react-bridge` runtime: tracks `running` / `error` and interrupts
-     * the request when the component unmounts.
-     */
-    useFollow(): EffectFollowResult;
-}
-/**
- * Compose the Effect invoker (`@affordant/effect`) with an
- * `effect-react-bridge` runtime to get React hooks. The bridge stays
- * domain-agnostic; this is the thin Affordant-specific glue.
- *
- * ```ts
- * const { useEffectFn } = makeEffectHooks({ runtime })
- * const affordances = makeAffordanceHooks({ useEffectFn } as EffectHooks<never>)
- * ```
- */
-export declare function makeAffordanceHooks<R>(hooks: EffectHooks<R>): AffordanceEffectHooks;
-//# sourceMappingURL=effect.d.ts.map

package/dist/effect.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"effect.d.ts","sourceRoot":"","sources":["../src/effect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,EAA0B,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAExD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,CAAA;IAClC,QAAQ,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,UAAU,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC9E;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,SAAS,IAAI,kBAAkB,CAAA;CAChC;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,qBAAqB,CASnF"}

package/dist/effect.js

@@ -1,20 +0,0 @@
-import { follow as effectFollow } from '@affordant/effect';
-/**
- * Compose the Effect invoker (`@affordant/effect`) with an
- * `effect-react-bridge` runtime to get React hooks. The bridge stays
- * domain-agnostic; this is the thin Affordant-specific glue.
- *
- * ```ts
- * const { useEffectFn } = makeEffectHooks({ runtime })
- * const affordances = makeAffordanceHooks({ useEffectFn } as EffectHooks<never>)
- * ```
- */
-export function makeAffordanceHooks(hooks) {
-    return {
-        useFollow() {
-            const { running, error, run } = hooks.useEffectFn((action, init) => effectFollow(action, init));
-            return { running, error, run };
-        },
-    };
-}
-//# sourceMappingURL=effect.js.map

package/dist/effect.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"effect.js","sourceRoot":"","sources":["../src/effect.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,YAAY,EAAoB,MAAM,mBAAmB,CAAA;AAmB5E;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CAAI,KAAqB;IAC1D,OAAO;QACL,SAAS;YACP,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,WAAW,CAC/C,CAAC,MAAqB,EAAE,IAAiB,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CACzE,CAAA;YACD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;QAChC,CAAC;KACF,CAAA;AACH,CAAC"}