@bunworks/inngest-realtime 0.1.0 → 0.1.5

package/util.cjs

@@ -0,0 +1,72 @@
+
+//#region src/util.ts
+/**
+* Creates and returns Promise that can be resolved or rejected with the
+* returned `resolve` and `reject` functions.
+*
+* Resolving or rejecting the function will return a new set of Promise control
+* functions. These can be ignored if the original Promise is all that's needed.
+*/
+const createDeferredPromise = () => {
+	let resolve;
+	let reject;
+	return {
+		promise: new Promise((_resolve, _reject) => {
+			resolve = (value) => {
+				_resolve(value);
+				return createDeferredPromise();
+			};
+			reject = (reason) => {
+				_reject(reason);
+				return createDeferredPromise();
+			};
+		}),
+		resolve,
+		reject
+	};
+};
+/**
+* Send an HTTP request with the given signing key. If the response is a 401 or
+* 403, then try again with the fallback signing key
+*/
+async function fetchWithAuthFallback({ authToken, authTokenFallback, fetch, options, url }) {
+	let res = await fetch(url, {
+		...options,
+		headers: {
+			...options?.headers,
+			...authToken ? { Authorization: `Bearer ${authToken}` } : {}
+		}
+	});
+	if ([401, 403].includes(res.status) && authTokenFallback) res = await fetch(url, {
+		...options,
+		headers: {
+			...options?.headers,
+			Authorization: `Bearer ${authTokenFallback}`
+		}
+	});
+	return res;
+}
+/**
+* Given an unknown value, try to parse it as a `boolean`. Useful for parsing
+* environment variables that could be a selection of different values such as
+* `"true"`, `"1"`.
+*
+* If the value could not be confidently parsed as a `boolean` or was seen to be
+* `undefined`, this function returns `undefined`.
+*/
+const parseAsBoolean = (value) => {
+	if (typeof value === "boolean") return value;
+	if (typeof value === "number") return Boolean(value);
+	if (typeof value === "string") {
+		const trimmed = value.trim().toLowerCase();
+		if (trimmed === "undefined") return;
+		if (["true", "1"].includes(trimmed)) return true;
+		return false;
+	}
+};
+
+//#endregion
+exports.createDeferredPromise = createDeferredPromise;
+exports.fetchWithAuthFallback = fetchWithAuthFallback;
+exports.parseAsBoolean = parseAsBoolean;
+//# sourceMappingURL=util.cjs.map

package/util.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.cjs","names":[],"sources":["../src/util.ts"],"sourcesContent":["type DeferredPromiseReturn<T> = {\r\n  promise: Promise<T>;\r\n  resolve: (value: T) => DeferredPromiseReturn<T>;\r\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n  reject: (reason: any) => DeferredPromiseReturn<T>;\r\n};\r\n\r\n/**\r\n * Creates and returns Promise that can be resolved or rejected with the\r\n * returned `resolve` and `reject` functions.\r\n *\r\n * Resolving or rejecting the function will return a new set of Promise control\r\n * functions. These can be ignored if the original Promise is all that's needed.\r\n */\r\nexport const createDeferredPromise = <T>(): DeferredPromiseReturn<T> => {\r\n  let resolve: DeferredPromiseReturn<T>[\"resolve\"];\r\n  let reject: DeferredPromiseReturn<T>[\"reject\"];\r\n\r\n  const promise = new Promise<T>((_resolve, _reject) => {\r\n    resolve = (value: T) => {\r\n      _resolve(value);\r\n      return createDeferredPromise<T>();\r\n    };\r\n\r\n    reject = (reason) => {\r\n      _reject(reason);\r\n      return createDeferredPromise<T>();\r\n    };\r\n  });\r\n\r\n  return { promise, resolve: resolve!, reject: reject! };\r\n};\r\n\r\n/**\r\n * Send an HTTP request with the given signing key. If the response is a 401 or\r\n * 403, then try again with the fallback signing key\r\n */\r\nexport async function fetchWithAuthFallback<TFetch extends typeof fetch>({\r\n  authToken,\r\n  authTokenFallback,\r\n  fetch,\r\n  options,\r\n  url,\r\n}: {\r\n  authToken: string | undefined;\r\n  authTokenFallback: string | undefined;\r\n  fetch: TFetch;\r\n  options?: Parameters<TFetch>[1];\r\n  url: URL | string;\r\n}): Promise<Response> {\r\n  let res = await fetch(url, {\r\n    ...options,\r\n    headers: {\r\n      ...options?.headers,\r\n      ...(authToken ? { Authorization: `Bearer ${authToken}` } : {}),\r\n    },\r\n  });\r\n\r\n  if ([401, 403].includes(res.status) && authTokenFallback) {\r\n    res = await fetch(url, {\r\n      ...options,\r\n      headers: {\r\n        ...options?.headers,\r\n        Authorization: `Bearer ${authTokenFallback}`,\r\n      },\r\n    });\r\n  }\r\n\r\n  return res;\r\n}\r\n\r\n/**\r\n * Given an unknown value, try to parse it as a `boolean`. Useful for parsing\r\n * environment variables that could be a selection of different values such as\r\n * `\"true\"`, `\"1\"`.\r\n *\r\n * If the value could not be confidently parsed as a `boolean` or was seen to be\r\n * `undefined`, this function returns `undefined`.\r\n */\r\nexport const parseAsBoolean = (value: unknown): boolean | undefined => {\r\n  if (typeof value === \"boolean\") {\r\n    return value;\r\n  }\r\n\r\n  if (typeof value === \"number\") {\r\n    return Boolean(value);\r\n  }\r\n\r\n  if (typeof value === \"string\") {\r\n    const trimmed = value.trim().toLowerCase();\r\n\r\n    if (trimmed === \"undefined\") {\r\n      return undefined;\r\n    }\r\n\r\n    if ([\"true\", \"1\"].includes(trimmed)) {\r\n      return true;\r\n    }\r\n\r\n    return false;\r\n  }\r\n\r\n  return undefined;\r\n};\r\n"],"mappings":";;;;;;;;;AAcA,MAAa,8BAA2D;CACtE,IAAI;CACJ,IAAI;AAcJ,QAAO;EAAE,SAZO,IAAI,SAAY,UAAU,YAAY;AACpD,cAAW,UAAa;AACtB,aAAS,MAAM;AACf,WAAO,uBAA0B;;AAGnC,aAAU,WAAW;AACnB,YAAQ,OAAO;AACf,WAAO,uBAA0B;;IAEnC;EAEyB;EAAkB;EAAS;;;;;;AAOxD,eAAsB,sBAAmD,EACvE,WACA,mBACA,OACA,SACA,OAOoB;CACpB,IAAI,MAAM,MAAM,MAAM,KAAK;EACzB,GAAG;EACH,SAAS;GACP,GAAG,SAAS;GACZ,GAAI,YAAY,EAAE,eAAe,UAAU,aAAa,GAAG,EAAE;GAC9D;EACF,CAAC;AAEF,KAAI,CAAC,KAAK,IAAI,CAAC,SAAS,IAAI,OAAO,IAAI,kBACrC,OAAM,MAAM,MAAM,KAAK;EACrB,GAAG;EACH,SAAS;GACP,GAAG,SAAS;GACZ,eAAe,UAAU;GAC1B;EACF,CAAC;AAGJ,QAAO;;;;;;;;;;AAWT,MAAa,kBAAkB,UAAwC;AACrE,KAAI,OAAO,UAAU,UACnB,QAAO;AAGT,KAAI,OAAO,UAAU,SACnB,QAAO,QAAQ,MAAM;AAGvB,KAAI,OAAO,UAAU,UAAU;EAC7B,MAAM,UAAU,MAAM,MAAM,CAAC,aAAa;AAE1C,MAAI,YAAY,YACd;AAGF,MAAI,CAAC,QAAQ,IAAI,CAAC,SAAS,QAAQ,CACjC,QAAO;AAGT,SAAO"}

package/util.mjs

@@ -0,0 +1,69 @@
+//#region src/util.ts
+/**
+* Creates and returns Promise that can be resolved or rejected with the
+* returned `resolve` and `reject` functions.
+*
+* Resolving or rejecting the function will return a new set of Promise control
+* functions. These can be ignored if the original Promise is all that's needed.
+*/
+const createDeferredPromise = () => {
+	let resolve;
+	let reject;
+	return {
+		promise: new Promise((_resolve, _reject) => {
+			resolve = (value) => {
+				_resolve(value);
+				return createDeferredPromise();
+			};
+			reject = (reason) => {
+				_reject(reason);
+				return createDeferredPromise();
+			};
+		}),
+		resolve,
+		reject
+	};
+};
+/**
+* Send an HTTP request with the given signing key. If the response is a 401 or
+* 403, then try again with the fallback signing key
+*/
+async function fetchWithAuthFallback({ authToken, authTokenFallback, fetch, options, url }) {
+	let res = await fetch(url, {
+		...options,
+		headers: {
+			...options?.headers,
+			...authToken ? { Authorization: `Bearer ${authToken}` } : {}
+		}
+	});
+	if ([401, 403].includes(res.status) && authTokenFallback) res = await fetch(url, {
+		...options,
+		headers: {
+			...options?.headers,
+			Authorization: `Bearer ${authTokenFallback}`
+		}
+	});
+	return res;
+}
+/**
+* Given an unknown value, try to parse it as a `boolean`. Useful for parsing
+* environment variables that could be a selection of different values such as
+* `"true"`, `"1"`.
+*
+* If the value could not be confidently parsed as a `boolean` or was seen to be
+* `undefined`, this function returns `undefined`.
+*/
+const parseAsBoolean = (value) => {
+	if (typeof value === "boolean") return value;
+	if (typeof value === "number") return Boolean(value);
+	if (typeof value === "string") {
+		const trimmed = value.trim().toLowerCase();
+		if (trimmed === "undefined") return;
+		if (["true", "1"].includes(trimmed)) return true;
+		return false;
+	}
+};
+
+//#endregion
+export { createDeferredPromise, fetchWithAuthFallback, parseAsBoolean };
+//# sourceMappingURL=util.mjs.map

package/util.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.mjs","names":[],"sources":["../src/util.ts"],"sourcesContent":["type DeferredPromiseReturn<T> = {\r\n  promise: Promise<T>;\r\n  resolve: (value: T) => DeferredPromiseReturn<T>;\r\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n  reject: (reason: any) => DeferredPromiseReturn<T>;\r\n};\r\n\r\n/**\r\n * Creates and returns Promise that can be resolved or rejected with the\r\n * returned `resolve` and `reject` functions.\r\n *\r\n * Resolving or rejecting the function will return a new set of Promise control\r\n * functions. These can be ignored if the original Promise is all that's needed.\r\n */\r\nexport const createDeferredPromise = <T>(): DeferredPromiseReturn<T> => {\r\n  let resolve: DeferredPromiseReturn<T>[\"resolve\"];\r\n  let reject: DeferredPromiseReturn<T>[\"reject\"];\r\n\r\n  const promise = new Promise<T>((_resolve, _reject) => {\r\n    resolve = (value: T) => {\r\n      _resolve(value);\r\n      return createDeferredPromise<T>();\r\n    };\r\n\r\n    reject = (reason) => {\r\n      _reject(reason);\r\n      return createDeferredPromise<T>();\r\n    };\r\n  });\r\n\r\n  return { promise, resolve: resolve!, reject: reject! };\r\n};\r\n\r\n/**\r\n * Send an HTTP request with the given signing key. If the response is a 401 or\r\n * 403, then try again with the fallback signing key\r\n */\r\nexport async function fetchWithAuthFallback<TFetch extends typeof fetch>({\r\n  authToken,\r\n  authTokenFallback,\r\n  fetch,\r\n  options,\r\n  url,\r\n}: {\r\n  authToken: string | undefined;\r\n  authTokenFallback: string | undefined;\r\n  fetch: TFetch;\r\n  options?: Parameters<TFetch>[1];\r\n  url: URL | string;\r\n}): Promise<Response> {\r\n  let res = await fetch(url, {\r\n    ...options,\r\n    headers: {\r\n      ...options?.headers,\r\n      ...(authToken ? { Authorization: `Bearer ${authToken}` } : {}),\r\n    },\r\n  });\r\n\r\n  if ([401, 403].includes(res.status) && authTokenFallback) {\r\n    res = await fetch(url, {\r\n      ...options,\r\n      headers: {\r\n        ...options?.headers,\r\n        Authorization: `Bearer ${authTokenFallback}`,\r\n      },\r\n    });\r\n  }\r\n\r\n  return res;\r\n}\r\n\r\n/**\r\n * Given an unknown value, try to parse it as a `boolean`. Useful for parsing\r\n * environment variables that could be a selection of different values such as\r\n * `\"true\"`, `\"1\"`.\r\n *\r\n * If the value could not be confidently parsed as a `boolean` or was seen to be\r\n * `undefined`, this function returns `undefined`.\r\n */\r\nexport const parseAsBoolean = (value: unknown): boolean | undefined => {\r\n  if (typeof value === \"boolean\") {\r\n    return value;\r\n  }\r\n\r\n  if (typeof value === \"number\") {\r\n    return Boolean(value);\r\n  }\r\n\r\n  if (typeof value === \"string\") {\r\n    const trimmed = value.trim().toLowerCase();\r\n\r\n    if (trimmed === \"undefined\") {\r\n      return undefined;\r\n    }\r\n\r\n    if ([\"true\", \"1\"].includes(trimmed)) {\r\n      return true;\r\n    }\r\n\r\n    return false;\r\n  }\r\n\r\n  return undefined;\r\n};\r\n"],"mappings":";;;;;;;;AAcA,MAAa,8BAA2D;CACtE,IAAI;CACJ,IAAI;AAcJ,QAAO;EAAE,SAZO,IAAI,SAAY,UAAU,YAAY;AACpD,cAAW,UAAa;AACtB,aAAS,MAAM;AACf,WAAO,uBAA0B;;AAGnC,aAAU,WAAW;AACnB,YAAQ,OAAO;AACf,WAAO,uBAA0B;;IAEnC;EAEyB;EAAkB;EAAS;;;;;;AAOxD,eAAsB,sBAAmD,EACvE,WACA,mBACA,OACA,SACA,OAOoB;CACpB,IAAI,MAAM,MAAM,MAAM,KAAK;EACzB,GAAG;EACH,SAAS;GACP,GAAG,SAAS;GACZ,GAAI,YAAY,EAAE,eAAe,UAAU,aAAa,GAAG,EAAE;GAC9D;EACF,CAAC;AAEF,KAAI,CAAC,KAAK,IAAI,CAAC,SAAS,IAAI,OAAO,IAAI,kBACrC,OAAM,MAAM,MAAM,KAAK;EACrB,GAAG;EACH,SAAS;GACP,GAAG,SAAS;GACZ,eAAe,UAAU;GAC1B;EACF,CAAC;AAGJ,QAAO;;;;;;;;;;AAWT,MAAa,kBAAkB,UAAwC;AACrE,KAAI,OAAO,UAAU,UACnB,QAAO;AAGT,KAAI,OAAO,UAAU,SACnB,QAAO,QAAQ,MAAM;AAGvB,KAAI,OAAO,UAAU,UAAU;EAC7B,MAAM,UAAU,MAAM,MAAM,CAAC,aAAa;AAE1C,MAAI,YAAY,YACd;AAGF,MAAI,CAAC,QAAQ,IAAI,CAAC,SAAS,QAAQ,CACjC,QAAO;AAGT,SAAO"}

package/CLAUDE.md

@@ -1,69 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Package Overview
-
-This is the `@inngest/realtime` package - a React-focused library that provides real-time capabilities for Inngest applications. It enables real-time subscriptions, channel management, and React hooks for building interactive applications with live data updates.
-
-## Development Workflow
-
-### Setup
-```bash
-# From the realtime package directory
-cd packages/realtime/
-pnpm install
-```
-
-### Common Commands
-
-```bash
-pnpm test             # Run Jest tests
-pnpm build            # Build TypeScript to dist/
-pnpm pack             # Create inngest-realtime.tgz for local testing
-```
-
-### Testing Strategy
-
-- **Unit tests**: Jest (`pnpm test`)
-- **React testing**: Tests React hooks and components
-- Uses `ts-jest` for TypeScript support
-
-## Architecture
-
-### Key Concepts
-- **Real-time Subscriptions**: Live data streaming capabilities
-- **Channel Management**: Topic-based message routing
-- **React Integration**: Custom hooks for React applications
-- **Token-based Authentication**: Secure subscription management
-
-### Package Structure
-- `src/index.ts` - Main exports and core functionality
-- `src/hooks.ts` - React hooks for real-time features
-- `src/channel.ts` - Channel management logic
-- `src/topic.ts` - Topic-based messaging
-- `src/api.ts` - API integration layer
-- `src/middleware.ts` - Inngest middleware integration
-- `src/subscribe/` - Subscription management utilities
-
-### Exports
-The package provides two main export paths:
-- `@inngest/realtime` - Core real-time functionality
-- `@inngest/realtime/hooks` - React hooks specifically
-
-## React Integration
-
-This package is designed specifically for React applications (requires React >=18.0.0):
-- Provides React hooks for real-time subscriptions
-- Manages WebSocket connections and state
-- Integrates with React's concurrent features
-
-## Dependencies
-
-- **Peer Dependencies**: React >=18.0.0 (required)
-- **Core Dependencies**: inngest, zod for validation, debug for logging
-- **Schema Validation**: Supports both Zod and Valibot for schema validation
-
-## Integration with Inngest
-
-Works as middleware and extension to the main Inngest package, providing real-time capabilities that complement Inngest's event-driven architecture.