@fcannizzaro/streamdeck-react 0.1.9 → 0.1.11

package/dist/hooks/touchstrip.d.ts

@@ -0,0 +1,6 @@
+import { TouchStripInfo, TouchStripTapPayload, TouchStripDialRotatePayload, TouchStripDialPressPayload } from '../types';
+export declare function useTouchStrip(): TouchStripInfo;
+export declare function useTouchStripTap(callback: (payload: TouchStripTapPayload) => void): void;
+export declare function useTouchStripDialRotate(callback: (payload: TouchStripDialRotatePayload) => void): void;
+export declare function useTouchStripDialDown(callback: (payload: TouchStripDialPressPayload) => void): void;
+export declare function useTouchStripDialUp(callback: (payload: TouchStripDialPressPayload) => void): void;

package/dist/hooks/touchstrip.js

@@ -0,0 +1,37 @@
+import { EventBusContext } from "../context/providers.js";
+import { TouchStripContext } from "../context/touchstrip-context.js";
+import { useCallbackRef } from "./internal/useCallbackRef.js";
+import { useContext, useEffect } from "react";
+//#region src/hooks/touchstrip.ts
+function useTouchStripEvent(event, callback) {
+	const bus = useContext(EventBusContext);
+	const callbackRef = useCallbackRef(callback);
+	useEffect(() => {
+		const handler = (payload) => {
+			callbackRef.current(payload);
+		};
+		bus.on(event, handler);
+		return () => bus.off(event, handler);
+	}, [
+		bus,
+		callbackRef,
+		event
+	]);
+}
+function useTouchStrip() {
+	return useContext(TouchStripContext);
+}
+function useTouchStripTap(callback) {
+	useTouchStripEvent("touchStripTap", callback);
+}
+function useTouchStripDialRotate(callback) {
+	useTouchStripEvent("touchStripDialRotate", callback);
+}
+function useTouchStripDialDown(callback) {
+	useTouchStripEvent("touchStripDialDown", callback);
+}
+function useTouchStripDialUp(callback) {
+	useTouchStripEvent("touchStripDialUp", callback);
+}
+//#endregion
+export { useTouchStrip, useTouchStripDialDown, useTouchStripDialRotate, useTouchStripDialUp, useTouchStripTap };

package/dist/index.d.ts

@@ -1,13 +1,18 @@
 export { createPlugin } from './plugin';
 export { defineAction } from './action';
+export type { RenderProfile } from './render/pipeline';
+export type { CacheStats } from './render/image-cache';
+export type { RenderMetrics } from './render/metrics';
 export { useKeyDown, useKeyUp, useDialRotate, useDialDown, useDialUp, useTouchTap, useDialHint, } from './hooks/events';
 export { useTap, useLongPress, useDoubleTap } from './hooks/gestures';
 export { useSettings, useGlobalSettings } from './hooks/settings';
 export { useDevice, useAction, useCanvas, useStreamDeck } from './hooks/context';
 export { useWillAppear, useWillDisappear } from './hooks/lifecycle';
 export { useInterval, useTimeout, usePrevious, useTick } from './hooks/utility';
+export { useSpring, useTween, SpringPresets, Easings } from './hooks/animation';
+export type { SpringConfig, SpringResult, TweenConfig, TweenResult, EasingName, EasingFn, AnimationTarget, AnimatedValue, } from './hooks/animation';
 export { useOpenUrl, useSwitchProfile, useSendToPI, usePropertyInspector, useShowAlert, useShowOk, useTitle, } from './hooks/sdk';
-export { useTouchBar, useTouchBarTap, useTouchBarDialRotate, useTouchBarDialDown, useTouchBarDialUp, } from './hooks/touchbar';
+export { useTouchStrip, useTouchStripTap, useTouchStripDialRotate, useTouchStripDialDown, useTouchStripDialUp, } from './hooks/touchstrip';
 export { Box } from './components/Box';
 export { Text } from './components/Text';
 export { Image } from './components/Image';
@@ -16,7 +21,7 @@ export { ProgressBar } from './components/ProgressBar';
 export { CircularGauge } from './components/CircularGauge';
 export { ErrorBoundary } from './components/ErrorBoundary';
 export { tw } from './tw/index';
-export type { PluginConfig, FontConfig, ActionConfig, ActionDefinition, EncoderLayout, WrapperComponent, DeviceInfo, ActionInfo, CanvasInfo, TouchStripLayout, TouchStripLayoutItem, KeyDownPayload, KeyUpPayload, DialRotatePayload, DialPressPayload, TouchTapPayload, DialHints, StreamDeckAccess, TouchBarInfo, TouchBarTapPayload, TouchBarDialRotatePayload, TouchBarDialPressPayload, } from './types';
+export type { PluginConfig, FontConfig, ActionConfig, ActionConfigInput, ActionDefinition, ActionUUID, ManifestActions, EncoderLayout, WrapperComponent, DeviceInfo, ActionInfo, CanvasInfo, TouchStripLayout, TouchStripLayoutItem, KeyDownPayload, KeyUpPayload, DialRotatePayload, DialPressPayload, TouchTapPayload, DialHints, StreamDeckAccess, TouchStripInfo, TouchStripTapPayload, TouchStripDialRotatePayload, TouchStripDialPressPayload, } from './types';
 export type { TapOptions, LongPressOptions, DoubleTapOptions } from './hooks/gestures';
 export type { BoxProps } from './components/Box';
 export type { TextProps } from './components/Text';

package/dist/index.js

@@ -6,8 +6,9 @@ import { useGlobalSettings, useSettings } from "./hooks/settings.js";
 import { useAction, useCanvas, useDevice, useStreamDeck } from "./hooks/context.js";
 import { useWillAppear, useWillDisappear } from "./hooks/lifecycle.js";
 import { useInterval, usePrevious, useTick, useTimeout } from "./hooks/utility.js";
+import { Easings, SpringPresets, useSpring, useTween } from "./hooks/animation.js";
 import { useOpenUrl, usePropertyInspector, useSendToPI, useShowAlert, useShowOk, useSwitchProfile, useTitle } from "./hooks/sdk.js";
-import { useTouchBar, useTouchBarDialDown, useTouchBarDialRotate, useTouchBarDialUp, useTouchBarTap } from "./hooks/touchbar.js";
+import { useTouchStrip, useTouchStripDialDown, useTouchStripDialRotate, useTouchStripDialUp, useTouchStripTap } from "./hooks/touchstrip.js";
 import { Box } from "./components/Box.js";
 import { Text } from "./components/Text.js";
 import { Image } from "./components/Image.js";
@@ -16,4 +17,4 @@ import { ProgressBar } from "./components/ProgressBar.js";
 import { CircularGauge } from "./components/CircularGauge.js";
 import { ErrorBoundary } from "./components/ErrorBoundary.js";
 import { tw } from "./tw/index.js";
-export { Box, CircularGauge, ErrorBoundary, Icon, Image, ProgressBar, Text, createPlugin, defineAction, tw, useAction, useCanvas, useDevice, useDialDown, useDialHint, useDialRotate, useDialUp, useDoubleTap, useGlobalSettings, useInterval, useKeyDown, useKeyUp, useLongPress, useOpenUrl, usePrevious, usePropertyInspector, useSendToPI, useSettings, useShowAlert, useShowOk, useStreamDeck, useSwitchProfile, useTap, useTick, useTimeout, useTitle, useTouchBar, useTouchBarDialDown, useTouchBarDialRotate, useTouchBarDialUp, useTouchBarTap, useTouchTap, useWillAppear, useWillDisappear };
+export { Box, CircularGauge, Easings, ErrorBoundary, Icon, Image, ProgressBar, SpringPresets, Text, createPlugin, defineAction, tw, useAction, useCanvas, useDevice, useDialDown, useDialHint, useDialRotate, useDialUp, useDoubleTap, useGlobalSettings, useInterval, useKeyDown, useKeyUp, useLongPress, useOpenUrl, usePrevious, usePropertyInspector, useSendToPI, useSettings, useShowAlert, useShowOk, useSpring, useStreamDeck, useSwitchProfile, useTap, useTick, useTimeout, useTitle, useTouchStrip, useTouchStripDialDown, useTouchStripDialRotate, useTouchStripDialUp, useTouchStripTap, useTouchTap, useTween, useWillAppear, useWillDisappear };

package/dist/manifest-codegen.d.ts

@@ -0,0 +1,38 @@
+export interface ParsedAction {
+    uuid: string;
+    controllers: readonly ("Keypad" | "Encoder")[];
+}
+/**
+ * Find the manifest.json inside a `*.sdPlugin` directory.
+ *
+ * - If `explicit` is a string, it is resolved against `root`.
+ * - If `explicit` is `false`, codegen is disabled (returns `null`).
+ * - Otherwise, auto-detects by scanning `root` for `*.sdPlugin/manifest.json`.
+ */
+export declare function findManifestPath(root: string, explicit?: string | false, warn?: (msg: string) => void): string | null;
+/**
+ * Parse a Stream Deck plugin manifest and extract action metadata.
+ * Returns an empty array on failure (with a warning).
+ */
+export declare function parseManifest(path: string, warn?: (msg: string) => void): ParsedAction[];
+/**
+ * Generate the `declare module` augmentation string from parsed actions.
+ * Returns an empty string when there are no actions.
+ */
+export declare function generateManifestDts(actions: ParsedAction[]): string;
+/**
+ * Write the generated `.d.ts` file only when the content has changed.
+ * Creates the parent directory if it does not exist.
+ *
+ * @returns `true` if the file was written, `false` if content was unchanged.
+ */
+export declare function writeManifestDtsIfChanged(outPath: string, content: string): boolean;
+/**
+ * High-level helper: find, parse, generate, and write manifest types.
+ *
+ * @returns The resolved manifest path (for watch registration), or `null`.
+ */
+export declare function generateManifestTypes(root: string, manifestOption: string | false | undefined, warn?: (msg: string) => void): {
+    manifestPath: string;
+    written: boolean;
+} | null;

package/dist/manifest-codegen.js

@@ -0,0 +1,110 @@
+import { dirname, join, resolve } from "node:path";
+import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from "node:fs";
+//#region src/manifest-codegen.ts
+/**
+* Find the manifest.json inside a `*.sdPlugin` directory.
+*
+* - If `explicit` is a string, it is resolved against `root`.
+* - If `explicit` is `false`, codegen is disabled (returns `null`).
+* - Otherwise, auto-detects by scanning `root` for `*.sdPlugin/manifest.json`.
+*/
+function findManifestPath(root, explicit, warn) {
+	if (explicit === false) return null;
+	if (typeof explicit === "string") {
+		const resolved = resolve(root, explicit);
+		if (!existsSync(resolved)) {
+			warn?.(`[@fcannizzaro/streamdeck-react] Manifest not found at ${resolved}`);
+			return null;
+		}
+		return resolved;
+	}
+	const sdPluginDirs = readdirSync(root, { withFileTypes: true }).filter((entry) => entry.isDirectory() && entry.name.endsWith(".sdPlugin"));
+	if (sdPluginDirs.length === 0) return null;
+	if (sdPluginDirs.length > 1) warn?.(`[@fcannizzaro/streamdeck-react] Multiple .sdPlugin directories found. Using "${sdPluginDirs[0].name}". Set the \`manifest\` option to specify one explicitly.`);
+	const manifestPath = join(root, sdPluginDirs[0].name, "manifest.json");
+	return existsSync(manifestPath) ? manifestPath : null;
+}
+/**
+* Parse a Stream Deck plugin manifest and extract action metadata.
+* Returns an empty array on failure (with a warning).
+*/
+function parseManifest(path, warn) {
+	try {
+		const content = readFileSync(path, "utf-8");
+		const manifest = JSON.parse(content);
+		if (!Array.isArray(manifest.Actions)) {
+			warn?.(`[@fcannizzaro/streamdeck-react] manifest.json has no Actions array`);
+			return [];
+		}
+		const actions = [];
+		for (const action of manifest.Actions) {
+			if (!action.UUID) {
+				warn?.(`[@fcannizzaro/streamdeck-react] Skipping manifest action with missing UUID`);
+				continue;
+			}
+			actions.push({
+				uuid: action.UUID,
+				controllers: action.Controllers ?? ["Keypad"]
+			});
+		}
+		return actions;
+	} catch (err) {
+		warn?.(`[@fcannizzaro/streamdeck-react] Failed to parse manifest: ${err instanceof Error ? err.message : String(err)}`);
+		return [];
+	}
+}
+var HEADER = ["// This file is auto-generated by @fcannizzaro/streamdeck-react", "// Do not edit this file manually. It is regenerated from the plugin manifest."].join("\n");
+/**
+* Generate the `declare module` augmentation string from parsed actions.
+* Returns an empty string when there are no actions.
+*/
+function generateManifestDts(actions) {
+	if (actions.length === 0) return "";
+	return [
+		HEADER,
+		"",
+		"import \"@fcannizzaro/streamdeck-react\";",
+		"",
+		"declare module \"@fcannizzaro/streamdeck-react\" {",
+		"  interface ManifestActions {",
+		...actions.map((action) => {
+			const controllers = action.controllers.map((c) => `"${c}"`).join(", ");
+			return `    "${action.uuid}": {\n      controllers: readonly [${controllers}];\n    };`;
+		}),
+		"  }",
+		"}",
+		""
+	].join("\n");
+}
+/**
+* Write the generated `.d.ts` file only when the content has changed.
+* Creates the parent directory if it does not exist.
+*
+* @returns `true` if the file was written, `false` if content was unchanged.
+*/
+function writeManifestDtsIfChanged(outPath, content) {
+	if (content === "") return false;
+	if (existsSync(outPath)) {
+		if (readFileSync(outPath, "utf-8") === content) return false;
+	}
+	const dir = dirname(outPath);
+	if (!existsSync(dir)) mkdirSync(dir, { recursive: true });
+	writeFileSync(outPath, content);
+	return true;
+}
+/**
+* High-level helper: find, parse, generate, and write manifest types.
+*
+* @returns The resolved manifest path (for watch registration), or `null`.
+*/
+function generateManifestTypes(root, manifestOption, warn) {
+	const manifestPath = findManifestPath(root, manifestOption, warn);
+	if (!manifestPath) return null;
+	const content = generateManifestDts(parseManifest(manifestPath, warn));
+	return {
+		manifestPath,
+		written: writeManifestDtsIfChanged(resolve(root, "src/streamdeck-env.d.ts"), content)
+	};
+}
+//#endregion
+export { generateManifestTypes };