@sirenodeck/sirenodeck 0.1.1-alpha.0

package/src/addon/spec.ts

@@ -0,0 +1,69 @@
+import { existsSync } from "node:fs"
+import { isAbsolute, resolve as resolvePath } from "node:path"
+
+export const isLocalAddonSpec = (spec: string): boolean => {
+  if (spec.startsWith("./") || spec.startsWith("../") || spec.startsWith("/"))
+    return true
+  if (spec.startsWith("~/") || spec.startsWith("~\\")) return true
+  if (
+    spec.startsWith("@") &&
+    !spec.startsWith("@/") &&
+    !spec.startsWith("@\\")
+  ) {
+    return false
+  }
+  if (/[\\/]/.test(spec)) return true
+  return false
+}
+
+const NPM_PACKAGE_NAME_RE =
+  /^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*(@[\^~]?[a-z0-9.*_-]+)?$/
+
+export const isNpmAddonSpec = (spec: string): boolean => {
+  if (isLocalAddonSpec(spec)) return false
+  return NPM_PACKAGE_NAME_RE.test(spec)
+}
+
+export const expandHome = (spec: string, homeDir: string): string => {
+  if (spec === "~") return homeDir
+  if (spec.startsWith("~/") || spec.startsWith("~\\"))
+    return homeDir + spec.slice(1)
+  return spec
+}
+
+export interface NormalizeAddonEntry {
+  enabled: boolean
+  source: string
+  isLocal: boolean
+  global: boolean
+}
+
+export const normalizeAddonEntry = (
+  entry: string | { src: string; enabled?: boolean; global?: boolean },
+): NormalizeAddonEntry => {
+  if (typeof entry === "string") {
+    return {
+      enabled: true,
+      source: entry,
+      isLocal: isLocalAddonSpec(entry),
+      global: false,
+    }
+  }
+  return {
+    enabled: entry.enabled ?? true,
+    source: entry.src,
+    isLocal: isLocalAddonSpec(entry.src),
+    global: entry.global ?? false,
+  }
+}
+
+export const resolveLocalAddonRoot = (
+  source: string,
+  configDir: string,
+  homeDir: string,
+): string => {
+  const expanded = expandHome(source, homeDir)
+  return isAbsolute(expanded) ? expanded : resolvePath(configDir, expanded)
+}
+
+export const addonRootExists = (root: string): boolean => existsSync(root)

package/src/api/addon.ts

@@ -0,0 +1,33 @@
+import type { Methods } from "@/deck/methods"
+import type { GestureKind } from "@/core/gesture-state"
+
+export type { Methods } from "@/deck/methods"
+export type { GestureKind } from "@/core/gesture-state"
+
+export interface ChannelPayload {
+  [key: string]: unknown
+}
+
+export type Unsubscribe = () => void
+
+export interface AddonButtonRenderContext {
+  config: unknown
+  pressed: boolean
+  addonName: string
+  frameState: unknown
+}
+
+export interface AddonButtonActionContext {
+  config: unknown
+  buttonId: string
+  deckId: string
+  gesture: GestureKind
+  methods: Methods
+}
+
+export type AddonMethods = Methods
+
+export interface UseAddonChannelReturn<T = unknown> {
+  value: T | undefined
+  snapshot: () => T | undefined
+}

package/src/api/asset-url.ts

@@ -0,0 +1,24 @@
+/**
+ * Browser-safe `addon://` asset URL rewriting.
+ *
+ * Deck/icon data flowing over the WS bridge references addon assets as
+ * `addon://<name>/<subPath>`. The daemon embeds those files into the
+ * `assets` WS message for device rendering, but SPA `<img src>` needs a
+ * fetchable URL. The sirenoDeck2 vite plugin serves them at
+ * `/@sireno/addon-asset/<name>/<subPath>` during dev; this helper
+ * rewrites known-scheme strings and passes everything else through.
+ */
+
+export const ADDON_ASSET_URL_PREFIX = "/@sireno/addon-asset/"
+
+// ponytail: single scheme today; extend here if more browser-invisible
+// schemes appear (e.g. builtin:// when a core surface wants its own SVG).
+export const resolveAddonAssetSrc = (src: string): string => {
+  if (!src.startsWith("addon://")) return src
+  const rest = src.slice("addon://".length)
+  const slash = rest.indexOf("/")
+  if (slash <= 0 || slash >= rest.length - 1) return src
+  const name = rest.slice(0, slash)
+  const subPath = rest.slice(slash + 1)
+  return `${ADDON_ASSET_URL_PREFIX}${name}/${subPath}`
+}

package/src/api/index.ts

@@ -0,0 +1,50 @@
+export {
+  helloMessageSchema,
+  helloAckMessageSchema,
+  deckConfigMessageSchema,
+  stateMessageSchema,
+  decksListMessageSchema,
+  showOverlayMessageSchema,
+  buttonErrorMessageSchema,
+  buttonActionMessageSchema,
+  methodCallMessageSchema,
+  methodCallResultMessageSchema,
+  selectDeckMessageSchema,
+  deckActiveMessageSchema,
+  dismissOverlayMessageSchema,
+  wsMessageSchema,
+  subscribeChannelsMessageSchema,
+  editorStateMessageSchema,
+  editorSourceValidationRequestMessageSchema,
+  editorSourceValidationResultMessageSchema,
+  editorMutationMessageSchema,
+  editorUndoMessageSchema,
+  editorMutationResultMessageSchema,
+  PROTOCOL_VERSION,
+} from "./protocol-internal"
+
+export type {
+  HelloMessage,
+  HelloAckMessage,
+  DeckConfigMessage,
+  StateMessage,
+  DecksListMessage,
+  ShowOverlayMessage,
+  ButtonErrorMessage,
+  ButtonActionMessage,
+  MethodCallMessage,
+  MethodCallResultMessage,
+  SelectDeckMessage,
+  DeckActiveMessage,
+  DismissOverlayMessage,
+  WsMessage,
+  SubscribeChannelsMessage,
+  EditorStateMessage,
+  EditorSourceValidationRequestMessage,
+  EditorSourceValidationResultMessage,
+  EditorMutationMessage,
+  EditorUndoMessage,
+  EditorMutationResultMessage,
+  RootButtonMutation,
+} from "./protocol-internal"
+export { resolveAddonAssetSrc, ADDON_ASSET_URL_PREFIX } from "./asset-url"