feat: getExecution(id)

.changeset/beige-worms-smoke.md

@@ -0,0 +1,23 @@
+---
+"@defer/client": minor
+---
+
+expose `getExecution(id)` to poll for an execution status and result:
+
+```ts
+import { type FetchExecutionResponse, getExecution } from "@defer/client";
+import type { NextApiRequest, NextApiResponse } from "next";
+
+type Response = {
+  res: FetchExecutionResponse;
+};
+
+export default async function handler(
+  req: NextApiRequest,
+  res: NextApiResponse<Response>
+) {
+  const executionId = req.query.id;
+  const ret = await getExecution(executionId as string);
+  res.status(200).json({ res: ret });
+}
+```

src/index.ts

@@ -7,11 +7,14 @@ const FakeID = "00000000000000000000000000000000";
 import {
   enqueueExecution,
   EnqueueExecutionResponse,
+  fetchExecution,
   waitExecutionResult,
 } from "./client.js";
 import { DeferError } from "./errors.js";
 import { HTTPClient, makeHTTPClient } from "./httpClient.js";
 
+export type { FetchExecutionResponse } from "./client";
+
 interface Options {
   accessToken?: string;
   endpoint?: string;
@@ -37,6 +40,17 @@ export function configure(opts = {} as Options): void {
   return;
 }
 
+export const deferEnabled = () => !!__accessToken;
+
+export const getExecution = (id: string) => {
+  if (!__httpClient) {
+    throw new DeferError(
+      "getExecution() is not yet supported in development mode; Please rely on deferEnabled() to conditionally use it."
+    );
+  }
+  return fetchExecution(__httpClient, { id });
+};
+
 export type UnPromise<F> = F extends Promise<infer R> ? R : F;
 
 export type DelayString = `${string}${Units}`;