@colixsystems/widget-sdk 0.13.0 → 0.15.0

package/dist/toast.js

@@ -0,0 +1,73 @@
+// REQ-WSDK-PLATFORM §6 — `useToast()` hook (web implementation).
+//
+// Surfaces a short auto-dismissing notification. Widget API:
+//
+//   const { showToast } = useToast();
+//   showToast({ kind: "success" | "error" | "info" | "warning", message: "Saved" });
+//
+// Renderer resolution order:
+//   1. If the host provided `ctx.toast.showToast`, call that. The host
+//      owns positioning + theming.
+//   2. Otherwise: dispatch a CustomEvent named "appstudio:widget-toast"
+//      on the window with detail `{ kind, message }`. Hosts that want a
+//      central toast renderer install a `window.addEventListener` for it.
+//   3. As a last resort, `console.log` the toast so dev work surfaces
+//      something even before either of the above is wired.
+//
+// The SDK does NOT render any DOM itself — that responsibility belongs
+// to the host so a single workspace-themed toast component shows the
+// notifications across all widgets.
+
+import { useCallback } from "react";
+import { useWidgetContextOrThrow } from "./hooks.js";
+
+function _normalizeKind(kind) {
+  return kind === "success" || kind === "error" || kind === "warning"
+    ? kind
+    : "info";
+}
+
+export function useToast() {
+  const ctx = useWidgetContextOrThrow("useToast");
+  const hostToast =
+    ctx && ctx.toast && typeof ctx.toast.showToast === "function"
+      ? ctx.toast.showToast
+      : null;
+  const showToast = useCallback(
+    (payload) => {
+      const opts = payload && typeof payload === "object" ? payload : {};
+      const kind = _normalizeKind(opts.kind);
+      const message = typeof opts.message === "string" ? opts.message : "";
+      if (!message) return;
+      if (hostToast) {
+        try {
+          hostToast({ kind, message });
+          return;
+        } catch (err) {
+          // Fall through to the event + console fallback rather than
+          // crashing the widget.
+          if (typeof console !== "undefined" && console.warn) {
+            console.warn("[useToast] host toast handler threw:", err);
+          }
+        }
+      }
+      if (
+        typeof window !== "undefined" &&
+        typeof window.dispatchEvent === "function" &&
+        typeof CustomEvent === "function"
+      ) {
+        window.dispatchEvent(
+          new CustomEvent("appstudio:widget-toast", {
+            detail: { kind, message },
+          }),
+        );
+        return;
+      }
+      if (typeof console !== "undefined" && console.log) {
+        console.log(`[toast:${kind}] ${message}`);
+      }
+    },
+    [hostToast],
+  );
+  return { showToast };
+}

package/dist/toast.native.js

@@ -0,0 +1,46 @@
+// REQ-WSDK-PLATFORM §6 — `useToast()` hook (native implementation).
+//
+// Same API as the web counterpart (./toast.js). Native has no
+// `window.dispatchEvent` fallback — if the host doesn't provide
+// `ctx.toast.showToast`, the hook falls back to `console.log` so the
+// widget at least surfaces something during dev.
+
+import { useCallback } from "react";
+import { useWidgetContextOrThrow } from "./hooks.js";
+
+function _normalizeKind(kind) {
+  return kind === "success" || kind === "error" || kind === "warning"
+    ? kind
+    : "info";
+}
+
+export function useToast() {
+  const ctx = useWidgetContextOrThrow("useToast");
+  const hostToast =
+    ctx && ctx.toast && typeof ctx.toast.showToast === "function"
+      ? ctx.toast.showToast
+      : null;
+  const showToast = useCallback(
+    (payload) => {
+      const opts = payload && typeof payload === "object" ? payload : {};
+      const kind = _normalizeKind(opts.kind);
+      const message = typeof opts.message === "string" ? opts.message : "";
+      if (!message) return;
+      if (hostToast) {
+        try {
+          hostToast({ kind, message });
+          return;
+        } catch (err) {
+          if (typeof console !== "undefined" && console.warn) {
+            console.warn("[useToast] host toast handler threw:", err);
+          }
+        }
+      }
+      if (typeof console !== "undefined" && console.log) {
+        console.log(`[toast:${kind}] ${message}`);
+      }
+    },
+    [hostToast],
+  );
+  return { showToast };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colixsystems/widget-sdk",
-  "version": "0.13.0",
+  "version": "0.15.0",
   "description": "Common widget interface for AppStudio. Implements WidgetManifest, WidgetContext, property schema, and helper hooks.",
   "type": "module",
   "main": "./dist/index.js",
@@ -35,7 +35,7 @@
   ],
   "scripts": {
     "build": "node scripts/build.js",
-    "test": "node --test src/__tests__/contract.test.js"
+    "test": "node --test src/__tests__/contract.test.js src/__tests__/hooks-users.test.js src/__tests__/hooks-groups.test.js src/__tests__/linter-users-scope.test.js"
   },
   "engines": {
     "node": ">=18"