glimpse-custom-applet-sdk 0.1.0

package/dist/src/widgets.js

@@ -0,0 +1,626 @@
+function applyCommonProps(payload, props) {
+    if (props.id !== undefined)
+        payload.id = props.id;
+    if (props.visible !== undefined)
+        payload.visible = props.visible;
+    if (props.hexpand !== undefined)
+        payload.hexpand = props.hexpand;
+    if (props.vexpand !== undefined)
+        payload.vexpand = props.vexpand;
+    if (props.halign !== undefined)
+        payload.halign = props.halign;
+    if (props.valign !== undefined)
+        payload.valign = props.valign;
+    if (props.tooltip !== undefined)
+        payload.tooltip = props.tooltip;
+    if (props.variant !== undefined)
+        payload.variant = props.variant;
+    return payload;
+}
+class WidgetBase {
+    common;
+    constructor(common = {}) {
+        this.common = common;
+    }
+    withCommon(payload) {
+        return applyCommonProps(payload, this.common);
+    }
+}
+export class Label extends WidgetBase {
+    text;
+    options;
+    constructor(text, options = {}) {
+        super(options);
+        this.text = text;
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({ text: this.text });
+        if (this.options.wrap !== undefined)
+            payload.wrap = this.options.wrap;
+        if (this.options.xalign !== undefined)
+            payload.xalign = this.options.xalign;
+        if (this.options.selectable !== undefined)
+            payload.selectable = this.options.selectable;
+        return { type: "label", data: payload };
+    }
+}
+export class Image extends WidgetBase {
+    icon;
+    options;
+    constructor(icon, options = {}) {
+        super(options);
+        this.icon = icon;
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({ icon: this.icon.toProtocol() });
+        if (this.options.pixel_size !== undefined)
+            payload.pixel_size = this.options.pixel_size;
+        return { type: "image", data: payload };
+    }
+}
+export class IconWidget extends WidgetBase {
+    icon;
+    options;
+    constructor(icon, options = {}) {
+        super(options);
+        this.icon = icon;
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({ icon: this.icon.toProtocol() });
+        if (this.options.pixel_size !== undefined)
+            payload.pixel_size = this.options.pixel_size;
+        return { type: "icon", data: payload };
+    }
+}
+export class Progress extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            value: this.options.value,
+            max: this.options.max ?? 1,
+        });
+        if (this.options.show_text !== undefined)
+            payload.show_text = this.options.show_text;
+        if (this.options.text !== undefined)
+            payload.text = this.options.text;
+        return { type: "progress", data: payload };
+    }
+}
+export class Button extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({});
+        if (this.options.label !== undefined)
+            payload.label = this.options.label;
+        if (this.options.icon !== undefined)
+            payload.icon = this.options.icon.toProtocol();
+        if (this.options.child !== undefined)
+            payload.child = this.options.child.toProtocol();
+        return { type: "button", data: payload };
+    }
+}
+export class Switch extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({ active: this.options.active ?? false });
+        if (this.options.label !== undefined)
+            payload.label = this.options.label;
+        return { type: "switch", data: payload };
+    }
+}
+export class Scale extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            min: this.options.min ?? 0,
+            max: this.options.max ?? 1,
+            step: this.options.step ?? 0.1,
+            value: this.options.value ?? 0,
+        });
+        if (this.options.orientation !== undefined)
+            payload.orientation = this.options.orientation;
+        if (this.options.draw_value !== undefined)
+            payload.draw_value = this.options.draw_value;
+        return { type: "scale", data: payload };
+    }
+}
+export class Checkbox extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({ active: this.options.active ?? false });
+        if (this.options.label !== undefined)
+            payload.label = this.options.label;
+        return { type: "checkbox", data: payload };
+    }
+}
+export class DropdownItem {
+    id;
+    label;
+    constructor(id, label) {
+        this.id = id;
+        this.label = label;
+    }
+    toProtocol() {
+        return { id: this.id, label: this.label };
+    }
+}
+export class Dropdown extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            items: (this.options.items ?? []).map((item) => item.toProtocol()),
+        });
+        if (this.options.selected !== undefined)
+            payload.selected = this.options.selected;
+        return { type: "dropdown", data: payload };
+    }
+}
+export class Separator extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({});
+        if (this.options.orientation !== undefined)
+            payload.orientation = this.options.orientation;
+        return { type: "separator", data: payload };
+    }
+}
+export class Scroll extends WidgetBase {
+    child;
+    constructor(child, options = {}) {
+        super(options);
+        this.child = child;
+    }
+    toProtocol() {
+        return { type: "scroll", data: this.withCommon({ child: this.child.toProtocol() }) };
+    }
+}
+export class GridChild {
+    row;
+    column;
+    child;
+    width;
+    height;
+    constructor(row, column, child, width = 1, height = 1) {
+        this.row = row;
+        this.column = column;
+        this.child = child;
+        this.width = width;
+        this.height = height;
+    }
+    toProtocol() {
+        return {
+            row: this.row,
+            column: this.column,
+            width: this.width,
+            height: this.height,
+            child: this.child.toProtocol(),
+        };
+    }
+}
+export class Grid extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        return {
+            type: "grid",
+            data: this.withCommon({
+                row_spacing: this.options.row_spacing ?? 0,
+                column_spacing: this.options.column_spacing ?? 0,
+                children: (this.options.children ?? []).map((child) => child.toProtocol()),
+            }),
+        };
+    }
+}
+export class Hero extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            title: this.options.title,
+            subtitle: this.options.subtitle,
+        });
+        if (this.options.icon !== undefined)
+            payload.icon = this.options.icon.toProtocol();
+        return { type: "hero", data: payload };
+    }
+}
+export class Card extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        return {
+            type: "card",
+            data: this.withCommon({
+                children: (this.options.children ?? []).map((child) => child.toProtocol()),
+            }),
+        };
+    }
+}
+export class Header {
+    title;
+    subtitle;
+    constructor(title, subtitle = "") {
+        this.title = title;
+        this.subtitle = subtitle;
+    }
+    toProtocol() {
+        const payload = { title: this.title };
+        if (this.subtitle !== "")
+            payload.subtitle = this.subtitle;
+        return payload;
+    }
+}
+export class Section extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const header = this.options.header ??
+            (this.options.title === undefined
+                ? undefined
+                : new Header(this.options.title, this.options.subtitle ?? ""));
+        const body = this.options.body ?? this.options.children ?? [];
+        return {
+            type: "section",
+            data: this.withCommon({
+                ...(header === undefined ? {} : { header: header.toProtocol() }),
+                body: body.map((child) => child.toProtocol()),
+            }),
+        };
+    }
+}
+export class Collapsible extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const header = this.options.header ??
+            (this.options.title === undefined
+                ? undefined
+                : new Header(this.options.title, this.options.subtitle ?? ""));
+        const body = this.options.body ?? this.options.children ?? [];
+        return {
+            type: "collapsible",
+            data: this.withCommon({
+                ...(header === undefined ? {} : { header: header.toProtocol() }),
+                expanded: this.options.expanded ?? false,
+                body: body.map((child) => child.toProtocol()),
+            }),
+        };
+    }
+}
+export class Item extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            label: this.options.label ?? "",
+            clickable: this.options.clickable ?? false,
+            menu: (this.options.menu ?? []).map((item) => item.toProtocol()),
+        });
+        if (this.options.left !== undefined)
+            payload.left = this.options.left.toProtocol();
+        if (this.options.right !== undefined)
+            payload.right = this.options.right.toProtocol();
+        return { type: "item", data: payload };
+    }
+}
+export class CollapsibleItem extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            label: this.options.label ?? "",
+            expanded: this.options.expanded ?? false,
+            body: (this.options.body ?? this.options.children ?? []).map((child) => child.toProtocol()),
+        });
+        if (this.options.left !== undefined)
+            payload.left = this.options.left.toProtocol();
+        if (this.options.right !== undefined)
+            payload.right = this.options.right.toProtocol();
+        return { type: "collapsible_item", data: payload };
+    }
+}
+export class Meter extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            label: this.options.label ?? "",
+            value: this.options.value,
+            min: this.options.min ?? 0,
+            max: this.options.max ?? 1,
+            step: this.options.step ?? 0.01,
+            interactive: this.options.interactive ?? false,
+        });
+        if (this.options.icon !== undefined)
+            payload.icon = this.options.icon.toProtocol();
+        if (this.options.text !== undefined)
+            payload.text = this.options.text;
+        return { type: "meter", data: payload };
+    }
+}
+export class Copyable extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        return {
+            type: "copyable",
+            data: this.withCommon({
+                label: this.options.label ?? "",
+                value: this.options.value,
+            }),
+        };
+    }
+}
+export class ToastAction {
+    id;
+    label;
+    constructor(id, label) {
+        this.id = id;
+        this.label = label;
+    }
+    toProtocol() {
+        return { id: this.id, label: this.label };
+    }
+}
+export class Toast extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            title: this.options.title,
+            message: this.options.message ?? "",
+        });
+        if (this.options.icon !== undefined)
+            payload.icon = this.options.icon.toProtocol();
+        if (this.options.action !== undefined)
+            payload.action = this.options.action.toProtocol();
+        return { type: "toast", data: payload };
+    }
+}
+export class ActionRow extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            title: this.options.title,
+            subtitle: this.options.subtitle ?? "",
+            meta: this.options.meta ?? "",
+        });
+        if (this.options.icon !== undefined)
+            payload.icon = this.options.icon.toProtocol();
+        return { type: "action_row", data: payload };
+    }
+}
+export class Row extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        return {
+            type: "row",
+            data: this.withCommon({
+                spacing: this.options.spacing ?? 0,
+                children: (this.options.children ?? []).map((child) => child.toProtocol()),
+            }),
+        };
+    }
+}
+export class Column extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        return {
+            type: "column",
+            data: this.withCommon({
+                spacing: this.options.spacing ?? 0,
+                children: (this.options.children ?? []).map((child) => child.toProtocol()),
+            }),
+        };
+    }
+}
+export class ActionMenuItem {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = {
+            id: this.options.id,
+            label: this.options.label,
+        };
+        if (this.options.icon !== undefined)
+            payload.icon = this.options.icon.toProtocol();
+        if (this.options.visible !== undefined)
+            payload.visible = this.options.visible;
+        if (this.options.checked !== undefined)
+            payload.checked = this.options.checked;
+        if (this.options.selectable !== undefined)
+            payload.selectable = this.options.selectable;
+        return payload;
+    }
+}
+export class ActionMenu extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        const payload = this.withCommon({
+            items: (this.options.items ?? []).map((item) => item.toProtocol()),
+        });
+        if (this.options.header !== undefined)
+            payload.header = this.options.header;
+        return { type: "action_menu", data: payload };
+    }
+}
+export class Spinner extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        return {
+            type: "spinner",
+            data: this.withCommon({ spinning: this.options.spinning ?? true }),
+        };
+    }
+}
+export class DetailGridItem {
+    key;
+    value;
+    constructor(key, value) {
+        this.key = key;
+        this.value = value;
+    }
+    toProtocol() {
+        return { key: this.key, value: this.value };
+    }
+}
+export class DetailGrid extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        return {
+            type: "detail_grid",
+            data: this.withCommon({
+                rows: (this.options.rows ?? []).map((row) => row.toProtocol()),
+            }),
+        };
+    }
+}
+export class EmptyState extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        return {
+            type: "empty_state",
+            data: this.withCommon({
+                title: this.options.title,
+                subtitle: this.options.subtitle ?? "",
+            }),
+        };
+    }
+}
+export class Badge extends WidgetBase {
+    options;
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    toProtocol() {
+        return {
+            type: "badge",
+            data: this.withCommon({
+                label: this.options.label,
+            }),
+        };
+    }
+}
+export class StatusDot extends WidgetBase {
+    constructor(options = {}) {
+        super(options);
+    }
+    toProtocol() {
+        return { type: "status", data: this.withCommon({}) };
+    }
+}
+export class Box extends WidgetBase {
+    options;
+    constructor(options = {}) {
+        super(options);
+        this.options = options;
+    }
+    static vertical(children, spacing = 0, options = {}) {
+        return new Box({ ...options, orientation: "vertical", spacing, children });
+    }
+    static horizontal(children, spacing = 0, options = {}) {
+        return new Box({ ...options, orientation: "horizontal", spacing, children });
+    }
+    toProtocol() {
+        return {
+            type: "box",
+            data: this.withCommon({
+                orientation: this.options.orientation ?? "vertical",
+                spacing: this.options.spacing ?? 0,
+                children: (this.options.children ?? []).map((child) => child.toProtocol()),
+            }),
+        };
+    }
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "glimpse-custom-applet-sdk",
+  "version": "0.1.0",
+  "description": "Typed async framework for building Glimpse exec applets",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "dist/src",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "npm run build && node --test dist/tests/*.test.js",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "glimpse",
+    "applet",
+    "panel",
+    "desktop",
+    "sdk"
+  ],
+  "license": "MIT",
+  "author": "Alex Oleshkevich <alex.oleshkevich@gmail.com>",
+  "homepage": "https://alex-oleshkevich.github.io/glimpse/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alex-oleshkevich/glimpse.git",
+    "directory": "sdk/sdk-ts"
+  },
+  "bugs": {
+    "url": "https://github.com/alex-oleshkevich/glimpse/issues"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.0",
+    "typescript": "^5.6.0"
+  }
+}