statocysts 0.3.0 → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-PRESENT Ming Lin <https://github.com/enpitsuLin>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/browser.d.ts

@@ -1,4 +1,4 @@
-import { a as SenderUrl, c as DefineProviderContext, d as defineProvider, i as SenderRegistry, l as DefineProviderOptions, n as slack, o as buildSenderRegistry, r as Sender, s as DEFAULT_EXTRACTOR, t as json, u as ServiceProvider } from "./index-CK1eOwNP.js";
+import { a as Sender, c as buildSenderRegistry, d as ServiceProvider, f as defineProvider, i as http, l as DefineProviderContext, m as defineTransport, n as slack, o as SenderRegistry, p as Transport, r as HttpPayload, s as SenderUrl, t as json, u as DefineProviderOptions } from "./index-I_frtEQ-.js";
 import { FetchOptions } from "ofetch";
 
 //#region src/browser.d.ts
@@ -6,4 +6,4 @@ declare const senderRegistry: SenderRegistry;
 declare function createSender(urls: SenderUrl[]): Sender;
 declare function send(url: string | URL, message: string, options?: FetchOptions): Promise<void>;
 //#endregion
-export { DEFAULT_EXTRACTOR, DefineProviderContext, DefineProviderOptions, Sender, SenderRegistry, SenderUrl, ServiceProvider, buildSenderRegistry, createSender, defineProvider, json, send, senderRegistry, slack };
+export { DefineProviderContext, DefineProviderOptions, HttpPayload, Sender, SenderRegistry, SenderUrl, ServiceProvider, Transport, buildSenderRegistry, createSender, defineProvider, defineTransport, http, json, send, senderRegistry, slack };

package/dist/browser.js

@@ -1,4 +1,4 @@
-import { a as defineProvider, i as DEFAULT_EXTRACTOR, n as json, o as assert, r as slack, t as buildSenderRegistry } from "./shared-BiiZsNzb.js";
+import { a as defineTransport, i as http, n as json, o as defineProvider, r as slack, s as assert, t as buildSenderRegistry } from "./shared-DsBK2dP_.js";
 import { ofetch } from "ofetch";
 
 //#region src/browser.ts
@@ -14,4 +14,4 @@ async function send(url, message, options) {
 }
 
 //#endregion
-export { DEFAULT_EXTRACTOR, buildSenderRegistry, createSender, defineProvider, json, send, senderRegistry, slack };
+export { buildSenderRegistry, createSender, defineProvider, defineTransport, http, json, send, senderRegistry, slack };

package/dist/index-I_frtEQ-.d.ts

@@ -0,0 +1,95 @@
+import * as ofetch0 from "ofetch";
+import { FetchOptions } from "ofetch";
+
+//#region src/core/transport.d.ts
+/**
+ * Transport interface for protocol-specific network communication
+ * Each transport handles the actual sending of data over a specific protocol
+ */
+interface Transport<Payload = unknown> {
+  /**
+   * Send data using the transport's protocol
+   * @param payload Protocol-specific payload to send
+   */
+  send: (payload: Payload) => Promise<void>;
+}
+declare function defineTransport<Payload>(transport: Transport<Payload>): Transport<Payload>;
+//#endregion
+//#region src/core/provider.d.ts
+type InferTransportPayload<T> = T extends Transport<infer P> ? P : never;
+interface ServiceProvider<Protocol extends string, Payload, Options = void> {
+  readonly $transport: Transport<Payload>;
+  readonly protocol: Protocol;
+  defaultOptions: Options | undefined;
+  send: (url: string, message: {
+    title: string;
+    body?: string;
+  }, options?: Options) => Promise<void>;
+}
+interface DefineProviderContext {
+  url: URL;
+  message: {
+    title: string;
+    body?: string;
+  };
+}
+interface DefineProviderOptions<T extends Transport, Options> {
+  defaultOptions?: Options;
+  transport: T;
+  prepare: (this: DefineProviderContext, ctx: DefineProviderContext, options: Options) => Promise<InferTransportPayload<T>>;
+}
+declare function defineProvider<const Protocol extends string, T extends Transport<any>, Options = void>(protocol: Protocol, createOptions: DefineProviderOptions<T, Options>): ServiceProvider<Protocol, InferTransportPayload<T>, Options>;
+//#endregion
+//#region src/core/sender.d.ts
+interface Sender {
+  send: (message: string, options?: FetchOptions) => Promise<void>;
+}
+type SenderUrl = string | URL;
+interface SenderRegistry {
+  (urls: SenderUrl[]): Sender;
+  resolveProvider: (url: string | URL) => ServiceProvider<string, any, any> | undefined;
+}
+declare function buildSenderRegistry(providers: ServiceProvider<string, any, any>[]): SenderRegistry;
+//#endregion
+//#region src/core/transports/http.d.ts
+/**
+ * HTTP payload for HTTP transport
+ */
+interface HttpPayload {
+  request: Request;
+  fetchOptions?: FetchOptions;
+}
+/**
+ * HTTP transport implementation
+ * Handles sending data over HTTP/HTTPS protocols
+ */
+declare const http: Transport<HttpPayload>;
+//#endregion
+//#region src/services/chat/slack/index.d.ts
+interface SlackOptions {
+  /**
+   * The base URL for webhook services
+   *
+   * @default `https://hooks.slack.com/services`
+   */
+  hookBaseUrl?: string;
+  /**
+   * The base URL for bot API services
+   *
+   * @default `https://slack.com/api`
+   */
+  botApiBaseUrl?: string;
+  /**
+   * The body of the request
+   *
+   * NOTICE*: This will override the body of the request. You should known what you are doing.
+   */
+  body?: Record<string, any>;
+  fetchOptions?: FetchOptions;
+}
+declare const slack: ServiceProvider<"slack:", HttpPayload, SlackOptions>;
+//#endregion
+//#region src/services/specialized/json/index.d.ts
+declare const json: ServiceProvider<"json:", HttpPayload, FetchOptions<ofetch0.ResponseType, any>>;
+//#endregion
+export { Sender as a, buildSenderRegistry as c, ServiceProvider as d, defineProvider as f, http as i, DefineProviderContext as l, defineTransport as m, slack as n, SenderRegistry as o, Transport as p, HttpPayload as r, SenderUrl as s, json as t, DefineProviderOptions as u };

package/dist/index.d.ts

@@ -1,9 +1,8 @@
-import { a as SenderUrl, c as DefineProviderContext, d as defineProvider, i as SenderRegistry, l as DefineProviderOptions, n as slack, o as buildSenderRegistry, r as Sender, s as DEFAULT_EXTRACTOR, t as json, u as ServiceProvider } from "./index-CK1eOwNP.js";
-import { FetchOptions } from "ofetch";
+import { a as Sender, c as buildSenderRegistry, d as ServiceProvider, f as defineProvider, i as http, l as DefineProviderContext, m as defineTransport, n as slack, o as SenderRegistry, p as Transport, r as HttpPayload, s as SenderUrl, t as json, u as DefineProviderOptions } from "./index-I_frtEQ-.js";
 
 //#region src/index.d.ts
 declare const senderRegistry: SenderRegistry;
 declare function createSender(urls: SenderUrl[]): Sender;
-declare function send(url: string | URL, message: string, options?: FetchOptions): Promise<void>;
+declare function send(url: string | URL, message: string): Promise<void>;
 //#endregion
-export { DEFAULT_EXTRACTOR, DefineProviderContext, DefineProviderOptions, Sender, SenderRegistry, SenderUrl, ServiceProvider, buildSenderRegistry, createSender, defineProvider, json, send, senderRegistry, slack };
+export { DefineProviderContext, DefineProviderOptions, HttpPayload, Sender, SenderRegistry, SenderUrl, ServiceProvider, Transport, buildSenderRegistry, createSender, defineProvider, defineTransport, http, json, send, senderRegistry, slack };

package/dist/index.js

@@ -1,17 +1,17 @@
-import { a as defineProvider, i as DEFAULT_EXTRACTOR, n as json, o as assert, r as slack, t as buildSenderRegistry } from "./shared-BiiZsNzb.js";
-import { ofetch } from "ofetch";
+import { a as defineTransport, i as http, n as json, o as defineProvider, r as slack, s as assert, t as buildSenderRegistry } from "./shared-DsBK2dP_.js";
 
 //#region src/index.ts
 const senderRegistry = buildSenderRegistry([json, slack]);
 function createSender(urls) {
 	return senderRegistry(urls);
 }
-async function send(url, message, options) {
+async function send(url, message) {
 	const _url = typeof url === "string" ? new URL(url) : url;
 	const provider = senderRegistry.resolveProvider(_url);
 	assert(provider, `Unsupported protocol ${_url.protocol}`);
-	await ofetch(provider.buildRequest(_url.toString(), message, options), options);
+	const messageObj = { title: message };
+	await provider.send(_url.toString(), messageObj);
 }
 
 //#endregion
-export { DEFAULT_EXTRACTOR, buildSenderRegistry, createSender, defineProvider, json, send, senderRegistry, slack };
+export { buildSenderRegistry, createSender, defineProvider, defineTransport, http, json, send, senderRegistry, slack };

package/dist/shared-DsBK2dP_.js

@@ -0,0 +1,164 @@
+import defu from "defu";
+import { ofetch } from "ofetch";
+import { withProtocol, withoutLeadingSlash } from "ufo";
+
+//#region src/utils/assert.ts
+function assert(condition, message) {
+	if (!condition) throw typeof message === "string" ? new Error(message) : message;
+}
+
+//#endregion
+//#region src/core/provider.ts
+function defineProvider(protocol, createOptions) {
+	const send = async (protocolUrl, message, options) => {
+		const url = new URL(protocolUrl);
+		assert(url.protocol === protocol, `Unexpected protocol "${url.protocol}"`);
+		const ctx = {
+			url,
+			message
+		};
+		const opts = defu(createOptions.defaultOptions ?? {}, options ?? {});
+		const payload = await createOptions.prepare.call(ctx, ctx, opts);
+		await createOptions.transport.send(payload);
+	};
+	return {
+		get protocol() {
+			return protocol;
+		},
+		get defaultOptions() {
+			return createOptions.defaultOptions;
+		},
+		get $transport() {
+			return createOptions.transport;
+		},
+		send
+	};
+}
+
+//#endregion
+//#region src/core/transport.ts
+function defineTransport(transport) {
+	return transport;
+}
+
+//#endregion
+//#region src/core/transports/http.ts
+/**
+* HTTP transport implementation
+* Handles sending data over HTTP/HTTPS protocols
+*/
+const http = defineTransport({ async send(payload) {
+	await ofetch(payload.request, payload.fetchOptions);
+} });
+
+//#endregion
+//#region src/services/chat/slack/index.ts
+const slack = defineProvider("slack:", {
+	transport: http,
+	defaultOptions: {
+		hookBaseUrl: "https://hooks.slack.com/",
+		botApiBaseUrl: "https://slack.com/"
+	},
+	async prepare(_, options) {
+		const { url } = this;
+		assert(url.hostname === "bot" || url.hostname === "webhook", `Invalid slack URL: ${url.toString()}`);
+		const type = url.hostname;
+		if (type === "bot") {
+			assert(url.username, "Channel ID is required");
+			assert(url.password, "Bot token is required");
+		} else assert(url.pathname.split("/").filter(Boolean).length === 3, "Webhook URL is invalid");
+		let requestUrl;
+		const headers = new Headers([["Content-Type", "application/json"]]);
+		const body = { text: this.message.title };
+		if (type === "bot") {
+			const { username: channel, password: token, searchParams } = url;
+			requestUrl = new URL("/api/chat.postMessage", options.botApiBaseUrl);
+			searchParams.forEach((value, key) => {
+				requestUrl.searchParams.set(key, value);
+			});
+			headers.set("Authorization", `Bearer ${token}`);
+			body.channel = channel;
+		} else {
+			const { searchParams } = url;
+			requestUrl = new URL(`/services/${withoutLeadingSlash(url.pathname)}`, options.hookBaseUrl);
+			searchParams.forEach((value, key) => {
+				requestUrl.searchParams.set(key, value);
+			});
+		}
+		return {
+			request: new Request(requestUrl, {
+				method: "POST",
+				headers,
+				body: JSON.stringify(options.body ?? body)
+			}),
+			fetchOptions: options.fetchOptions
+		};
+	}
+});
+
+//#endregion
+//#region src/services/specialized/json/index.ts
+const json = defineProvider("json:", {
+	transport: http,
+	defaultOptions: {},
+	async prepare(_, options) {
+		const url = new URL(this.url);
+		const headers = new Headers([["Content-Type", "application/json"]]);
+		const body = { title: this.message.title };
+		if (this.message.body) body.body = this.message.body;
+		Array.from(url.searchParams.entries()).forEach(([key, value]) => {
+			if (key.startsWith(" ")) {
+				url.searchParams.delete(key);
+				const headerKey = key.slice(1);
+				if (headers.has(headerKey)) headers.set(headerKey, value);
+				else headers.append(headerKey, value);
+			} else if (key.startsWith(":")) {
+				url.searchParams.delete(key);
+				const propertyKey = key.slice(1);
+				body[propertyKey] = value;
+			}
+		});
+		const requestUrl = withProtocol(url.toString(), "https:");
+		return {
+			request: new Request(requestUrl, {
+				method: "POST",
+				body: JSON.stringify(body),
+				headers
+			}),
+			fetchOptions: options
+		};
+	}
+});
+
+//#endregion
+//#region src/core/sender.ts
+function buildSenderRegistry(providers) {
+	const providersRegistry = /* @__PURE__ */ new Map();
+	providers.forEach((provider) => {
+		providersRegistry.set(provider.protocol, provider);
+	});
+	function resolveProvider(url) {
+		const _url = typeof url === "string" ? new URL(url) : url;
+		return providersRegistry.get(_url.protocol);
+	}
+	function createSender(urls) {
+		const registries = urls.map((url) => {
+			const provider = resolveProvider(url);
+			if (!provider) return;
+			return {
+				provider,
+				url
+			};
+		}).filter((p) => !!p);
+		return { async send(message, options) {
+			for (const registry of registries) {
+				const messageObj = { title: message };
+				await registry.provider.send(registry.url.toString(), messageObj, options);
+			}
+		} };
+	}
+	return Object.assign(createSender, { resolveProvider });
+}
+
+//#endregion
+export { defineTransport as a, http as i, json as n, defineProvider as o, slack as r, assert as s, buildSenderRegistry as t };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "statocysts",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Notification library for JavaScript",
   "license": "MIT",
   "homepage": "https://github.com/octoplorer/statocysts",
@@ -52,7 +52,7 @@
   },
   "devDependencies": {
     "@types/node": "^25.0.2",
-    "@vitest/coverage-v8": "4.0.15",
+    "@vitest/coverage-v8": "4.0.16",
     "tsdown": "^0.18.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.15"

package/dist/index-CK1eOwNP.d.ts

@@ -1,63 +0,0 @@
-import { FetchOptions } from "ofetch";
-
-//#region src/core/provider.d.ts
-interface ServiceProvider<Protocol extends string, Data = unknown, Options = unknown> {
-  readonly protocol: Protocol;
-  $infer: Data;
-  defaultOptions: Options | undefined;
-  buildRequest: (url: string, message: string, options?: Options) => Request;
-}
-interface DefineProviderContext<Data = unknown> {
-  url: URL;
-  message: string;
-  data: Data;
-}
-interface DefineProviderOptions<Data = unknown, Options = unknown> {
-  defaultOptions?: Options;
-  extractor?: (url: URL) => Data;
-  createRequest: (this: DefineProviderContext<Data>, ctx: DefineProviderContext<Data>, Options: Options) => Request;
-}
-declare const DEFAULT_EXTRACTOR: (url: URL) => unknown;
-declare function defineProvider<const Protocol extends string, Data = unknown, Options = unknown>(protocol: Protocol, createOptions: DefineProviderOptions<Data, Options>): ServiceProvider<Protocol, Data, Options>;
-//#endregion
-//#region src/core/sender.d.ts
-interface Sender {
-  send: (message: string, options?: FetchOptions) => Promise<void>;
-}
-type SenderUrl = string | URL;
-interface SenderRegistry {
-  (urls: SenderUrl[]): Sender;
-  resolveProvider: (url: string | URL) => ServiceProvider<string> | undefined;
-}
-declare function buildSenderRegistry(providers: ServiceProvider<string, any, any>[]): SenderRegistry;
-//#endregion
-//#region src/services/chat/slack/index.d.ts
-interface SlackData {
-  type: 'bot' | 'webhook';
-}
-interface SlackOptions {
-  /**
-   * The base URL for webhook services
-   *
-   * @default `https://hooks.slack.com/services`
-   */
-  hookBaseUrl?: string;
-  /**
-   * The base URL for bot API services
-   *
-   * @default `https://slack.com/api`
-   */
-  botApiBaseUrl?: string;
-  /**
-   * The body of the request
-   *
-   * NOTICE*: This will override the body of the request. You should known what you are doing.
-   */
-  body?: Record<string, any>;
-}
-declare const slack: ServiceProvider<"slack:", SlackData, SlackOptions>;
-//#endregion
-//#region src/services/specialized/json/index.d.ts
-declare const json: ServiceProvider<"json:", unknown, unknown>;
-//#endregion
-export { SenderUrl as a, DefineProviderContext as c, defineProvider as d, SenderRegistry as i, DefineProviderOptions as l, slack as n, buildSenderRegistry as o, Sender as r, DEFAULT_EXTRACTOR as s, json as t, ServiceProvider as u };

package/dist/shared-BiiZsNzb.js

@@ -1,135 +0,0 @@
-import defu from "defu";
-import { withProtocol, withoutLeadingSlash } from "ufo";
-import { ofetch } from "ofetch";
-
-//#region src/utils/assert.ts
-function assert(condition, message) {
-	if (!condition) throw typeof message === "string" ? new Error(message) : message;
-}
-
-//#endregion
-//#region src/core/provider.ts
-const DEFAULT_EXTRACTOR = (url) => Object.fromEntries(url.searchParams.entries());
-function defineProvider(protocol, createOptions) {
-	const createOpt = defu(createOptions, { extractor: DEFAULT_EXTRACTOR });
-	const buildRequest = (protocolUrl, message, options) => {
-		const url = new URL(protocolUrl);
-		assert(url.protocol === protocol, `Unexpected protocol "${url.protocol}"`);
-		const ctx = {
-			data: createOpt.extractor(url),
-			url,
-			message
-		};
-		const opts = defu(createOptions.defaultOptions ?? {}, options ?? {});
-		return createOptions.createRequest.call(ctx, ctx, opts);
-	};
-	return {
-		get protocol() {
-			return protocol;
-		},
-		buildRequest,
-		get defaultOptions() {
-			return createOptions.defaultOptions;
-		},
-		$infer: {}
-	};
-}
-
-//#endregion
-//#region src/services/chat/slack/index.ts
-const slack = defineProvider("slack:", {
-	extractor: (url) => {
-		assert(url.hostname === "bot" || url.hostname === "webhook", `Invalid slack URL: ${url.toString()}`);
-		if (url.hostname === "bot") {
-			assert(url.username, "Channel ID is required");
-			assert(url.password, "Bot token is required");
-		} else assert(url.pathname.split("/").filter(Boolean).length === 3, "Webhook URL is invalid");
-		return { type: url.hostname };
-	},
-	defaultOptions: {
-		hookBaseUrl: "https://hooks.slack.com/",
-		botApiBaseUrl: "https://slack.com/"
-	},
-	createRequest(_, options) {
-		const { type } = this.data;
-		let url;
-		const headers = new Headers([["Content-Type", "application/json"]]);
-		const body = { text: this.message };
-		if (type === "bot") {
-			const { username: channel, password: token, searchParams } = this.url;
-			url = new URL("/api/chat.postMessage", options.botApiBaseUrl);
-			searchParams.forEach((value, key) => {
-				url.searchParams.set(key, value);
-			});
-			headers.set("Authorization", `Bearer ${token}`);
-			body.channel = channel;
-		} else {
-			const { searchParams } = this.url;
-			url = new URL(`/services/${withoutLeadingSlash(this.url.pathname)}`, options.hookBaseUrl);
-			searchParams.forEach((value, key) => {
-				url.searchParams.set(key, value);
-			});
-		}
-		return new Request(url, {
-			method: "POST",
-			headers,
-			body: JSON.stringify(options.body ?? body)
-		});
-	}
-});
-
-//#endregion
-//#region src/services/specialized/json/index.ts
-const json = defineProvider("json:", { createRequest() {
-	const url = new URL(this.url);
-	const headers = new Headers([["Content-Type", "application/json"]]);
-	const body = { message: this.message };
-	Array.from(url.searchParams.entries()).forEach(([key, value]) => {
-		if (key.startsWith(" ")) {
-			url.searchParams.delete(key);
-			const headerKey = key.slice(1);
-			if (headers.has(headerKey)) headers.set(headerKey, value);
-			else headers.append(headerKey, value);
-		} else if (key.startsWith(":")) {
-			url.searchParams.delete(key);
-			const propertyKey = key.slice(1);
-			body[propertyKey] = value;
-		}
-	});
-	const requestUrl = withProtocol(url.toString(), "https:");
-	return new Request(requestUrl, {
-		method: "POST",
-		body: JSON.stringify(body),
-		headers
-	});
-} });
-
-//#endregion
-//#region src/core/sender.ts
-function buildSenderRegistry(providers) {
-	const providersRegistry = /* @__PURE__ */ new Map();
-	providers.forEach((provider) => {
-		providersRegistry.set(provider.protocol, provider);
-	});
-	function resolveProvider(url) {
-		const _url = typeof url === "string" ? new URL(url) : url;
-		return providersRegistry.get(_url.protocol);
-	}
-	function createSender(urls) {
-		const registries = urls.map((url) => {
-			const provider = resolveProvider(url);
-			if (!provider) return;
-			return {
-				provider,
-				url
-			};
-		}).filter((p) => !!p);
-		return { async send(message, options) {
-			for (const registry of registries) await ofetch(registry.provider.buildRequest(registry.url.toString(), message), options);
-		} };
-	}
-	return Object.assign(createSender, { resolveProvider });
-}
-
-//#endregion
-export { defineProvider as a, DEFAULT_EXTRACTOR as i, json as n, assert as o, slack as r, buildSenderRegistry as t };