actly 1.2.0 → 1.3.0

package/dist/core/act.d.ts

@@ -1,97 +1,19 @@
 import type { ActFn, ActOptions, ActResult, AnyStateStore, SyncStateStore, AsyncStateStore } from '../types/index.js';
-/**
- * Execute `fn` with the given reliability policies.
- *
- * @param key     Stable identifier for this action. Scopes dedupe + cache.
- * @param fn      The async work to run. Receives an `AbortSignal` for
- *                cooperative cancellation (legacy `() => Promise<T>` is
- *                still accepted — the signal is simply ignored).
- * @param options Which policies to apply and how. All fields are optional.
- *
- * @returns       `ActResult<T>` — always resolves, never throws.
- *                Check `result.ok` before reading `result.value`.
- *
- * @example
- * // With cooperative cancellation
- * const result = await act('user:42', async (signal) => {
- *   return fetch(`/api/users/42`, { signal })
- * }, {
- *   retry:        { attempts: 3, delayMs: 200, backoff: 'exponential' },
- *   timeout:      { ms: 5_000 },
- *   totalTimeout: { ms: 12_000 },
- *   dedupe:       true,
- *   cache:        { ttl: 60_000 },
- * })
- *
- * if (result.ok) {
- *   console.log(result.value, result.source, result.attempts)
- * } else {
- *   console.error(result.error)
- * }
- */
-export declare function act<T>(key: string, fn: ActFn<T>, options?: ActOptions): Promise<ActResult<T>>;
-/**
- * Invalidate the cached value for `key` on the default module-level store.
- *
- * Only clears the cache slot — does not affect in-flight dedupe entries
- * (those will settle on their own). Returns `true` if a cache entry was
- * removed, `false` otherwise.
- *
- * Useful when you know the underlying data has changed and you want the
- * next `act()` call to re-run `fn` instead of serving stale cache:
- *
- * ```ts
- * await act('user:42', () => fetchUser(42), { cache: { ttl: 60_000 } })
- * // ... user updates their profile ...
- * invalidate('user:42')  // next call will re-fetch
- * ```
- */
+export declare function act<T>(key: string, fn: ActFn<T>, options?: ActOptions<T>): Promise<ActResult<T>>;
+export { HedgeTimeoutError } from '../errors.js';
 export declare function invalidate(key: string): boolean;
-/** Result of `withStore()` for a sync store: `act` + sync `invalidate`. */
 export interface ScopedActSync {
-    <T>(key: string, fn: ActFn<T>, options?: ActOptions): Promise<ActResult<T>>;
+    <T>(key: string, fn: ActFn<T>, options?: ActOptions<T>): Promise<ActResult<T>>;
     invalidate(key: string): boolean;
-    /** The store this scope is bound to. Useful for `store.destroy()` etc. */
     readonly store: AnyStateStore;
+    readonly scope: string;
 }
-/** Result of `withStore()` for an async store: `act` + async `invalidate`. */
 export interface ScopedActAsync {
-    <T>(key: string, fn: ActFn<T>, options?: ActOptions): Promise<ActResult<T>>;
+    <T>(key: string, fn: ActFn<T>, options?: ActOptions<T>): Promise<ActResult<T>>;
     invalidate(key: string): Promise<boolean>;
     readonly store: AnyStateStore;
+    readonly scope: string;
 }
-/**
- * Create a scoped `act` function bound to an explicit store.
- *
- * Use this for:
- *  - **SSR request isolation**: one store per request, no cross-request
- *    cache/dedupe leakage.
- *  - **Multi-tenant scenarios**: one store per tenant, no cross-tenant
- *    data leakage.
- *  - **Test isolation**: each test gets a fresh store, no shared state.
- *
- * The returned function has the same signature as `act()`. It also exposes
- * an `invalidate(key)` method and a `store` reference for cleanup.
- *
- * For sync stores, `invalidate` returns `boolean` synchronously.
- * For async stores, `invalidate` returns `Promise<boolean>`.
- *
- * @example
- * ```ts
- * import { withStore, InMemoryStore } from 'actly'
- *
- * const store = new InMemoryStore({ maxSize: 1000, autoCleanup: true })
- * const act = withStore(store)
- *
- * try {
- *   await act('user:42', () => fetchUser(42), { cache: { ttl: 60_000 } })
- *   // ... user updates their profile ...
- *   act.invalidate('user:42')  // next call re-fetches
- * } finally {
- *   store.destroy()
- * }
- * ```
- */
 export declare function withStore(store: SyncStateStore): ScopedActSync;
 export declare function withStore(store: AsyncStateStore): ScopedActAsync;
 export declare function withStore(store: AnyStateStore): ScopedActSync | ScopedActAsync;

package/dist/core/act.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"act.d.ts","sourceRoot":"","sources":["../../src/core/act.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,KAAK,EACL,UAAU,EACV,SAAS,EAGT,aAAa,EACb,cAAc,EACd,eAAe,EAEhB,MAAM,mBAAmB,CAAA;AA4L1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,GAAG,CAAC,CAAC,EACzB,GAAG,EAAE,MAAM,EACX,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EACZ,OAAO,GAAE,UAAe,GACvB,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CA8JvB;AA+BD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAM/C;AAID,2EAA2E;AAC3E,MAAM,WAAW,aAAa;IAC5B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;IAC3E,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;IAChC,0EAA0E;IAC1E,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;CAC9B;AAED,8EAA8E;AAC9E,MAAM,WAAW,cAAc;IAC7B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;IAC3E,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACzC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,aAAa,CAAA;AAC/D,wBAAgB,SAAS,CAAC,KAAK,EAAE,eAAe,GAAG,cAAc,CAAA;AACjE,wBAAgB,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,aAAa,GAAG,cAAc,CAAA"}
+{"version":3,"file":"act.d.ts","sourceRoot":"","sources":["../../src/core/act.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,KAAK,EACL,UAAU,EACV,SAAS,EAGT,aAAa,EACb,cAAc,EACd,eAAe,EAGhB,MAAM,mBAAmB,CAAA;AA0N1B,wBAAsB,GAAG,CAAC,CAAC,EACzB,GAAG,EAAE,MAAM,EACX,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EACZ,OAAO,GAAE,UAAU,CAAC,CAAC,CAAM,GAC1B,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAgSvB;AAcD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AA4JhD,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAM/C;AAKD,MAAM,WAAW,aAAa;IAC5B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;IAC9E,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;IAEhC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;IAM7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AAGD,MAAM,WAAW,cAAc;IAC7B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;IAC9E,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACzC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;IAE7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AAsBD,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,aAAa,CAAA;AAC/D,wBAAgB,SAAS,CAAC,KAAK,EAAE,eAAe,GAAG,cAAc,CAAA;AACjE,wBAAgB,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,aAAa,GAAG,cAAc,CAAA"}