@qilin-agent/client-ui-sidebar 0.0.0-stage → 3.1.4

package/lib/index.js

@@ -0,0 +1,6 @@
+//#region lib/types/index.js
+/** Host loader entry for the browser-only sidebar plugin. */
+/** Provides no host-side behavior. */
+function apply() {}
+//#endregion
+export { apply };

package/lib/types/client/HeaderLeadingControls.d.ts

@@ -0,0 +1,17 @@
+import type { InjectFace, PropsLocale, PropsRuntime } from '@qilin-agent/client-ui-slots';
+import type { SidebarRootInjected } from './contract/slots.ts';
+/** Full props of the conversation-header leading occupant. */
+export type HeaderLeadingControlsProps = PropsRuntime<'conversation.header.leading'> & InjectFace<SidebarRootInjected> & PropsLocale<'sidebar'>;
+/**
+ * Sidebar-open and New Session controls in the conversation header's
+ * root-scoped leading seat, which the resident header renders with or without
+ * a selected Session. On macOS desktop a collapsed sidebar hides entirely (no
+ * rail), taking both controls off screen; this occupant puts them back beside
+ * the traffic lights. Mounted whenever the platform matches; visibility rides the
+ * AppFrame-published `data-sidebar-collapsed` attribute in CSS, so no
+ * collapse-state pipe is added here.
+ * @param props - Injected sidebar actions plus the sidebar locale seat.
+ * @returns the two header controls, or null off macOS desktop.
+ */
+export declare function HeaderLeadingControls({ toggleSidebar, startSession, useShortcuts, t }: HeaderLeadingControlsProps): import("react").JSX.Element | null;
+//# sourceMappingURL=HeaderLeadingControls.d.ts.map

package/lib/types/client/SidebarRoot.d.ts

@@ -0,0 +1,8 @@
+import type { SidebarRootComponentProps } from './contract/slots.ts';
+/**
+ * Render the sidebar column shell.
+ * @param props - composed slot props (runtime share + injected callbacks, contract/slots.ts).
+ * @returns the sidebar element tree.
+ */
+export declare function SidebarRoot({ collapsed, width, startSession, toggleSidebar, selectPanel, usePanels, useShortcuts, usePanelInfo, t, renderSlot, }: SidebarRootComponentProps): import("react").JSX.Element;
+//# sourceMappingURL=SidebarRoot.d.ts.map

package/lib/types/client/contract/slots.d.ts

@@ -0,0 +1,200 @@
+/**
+ * Sidebar slot contract: the registrant-side props composition for the
+ * layout-owned `sidebar` slot, plus the holes this shell declares. The shell
+ * owns column geometry, the brand row, New Session,
+ * and global panel rows; everything between the workspace section header and
+ * the list bottom is the `sidebar.workspaces` registrant's (ui-workspace), and
+ * the foot is the `sidebar.settings` registrant's (ui-settings), followed by
+ * optional footer actions in `sidebar.footer.action`.
+ */
+import type { InjectFace, PropsLocale, PropsRenderSlots, PropsRuntime } from '@qilin-agent/client-ui-slots';
+import type { ObservableSnapshot } from '@qilin-agent/client-store';
+import type { WorkspaceId } from '@qilin-agent/api-workspace-controller/client';
+import type { MainPanelId } from '@qilin-agent/client-ui-layout/client';
+import type { ShortcutCatalogEntry } from '@qilin-agent/client-shortcuts/client';
+declare module '@qilin-agent/client-ui-slots' {
+    interface SlotMap {
+        /** Non-interactive notification inside the collapsed sidebar expand button. */
+        'sidebar.toggle.badge': {
+            kind: 'single';
+            scope: 'root';
+            owner: Record<never, never>;
+        };
+        /**
+         * Brand mark rendered in the expanded brand row and collapsed rail.
+         * Declared by this package's `sidebar` entry; deployments may replace
+         * the shell's fish fallback without replacing the surrounding controls.
+         */
+        'sidebar.brand.mark': {
+            kind: 'single';
+            scope: 'root';
+            owner: SidebarBrandMarkOwnerProps;
+        };
+        /**
+         * Brand name rendered beside the expanded mark. Declared by this
+         * package's `sidebar` entry; the shell supplies a generic text fallback.
+         */
+        'sidebar.brand.name': {
+            kind: 'single';
+            scope: 'root';
+            owner: SidebarBrandNameOwnerProps;
+        };
+        /**
+         * Global panel icons. Each list id addresses the matching main panel;
+         * the sidebar owns the button and resolves its label from list metadata.
+         */
+        'sidebar.panellist': {
+            kind: 'list';
+            scope: 'root';
+            owner: SidebarPanelIconOwnerProps;
+        };
+        /**
+         * Deployment-side section assignment for panel rows. Each occupant's
+         * inject face contributes a row-id → section-label map applied over the
+         * panel list before grouping, so a deployment can join rows it does not
+         * register itself (engine panels) into sections of its naming. An
+         * assignment wins over the row's own `section`. Declared by this
+         * package's `sidebar` entry.
+         */
+        'sidebar.section.assignments': {
+            kind: 'list';
+            scope: 'root';
+            owner: SidebarSectionAssignmentsOwnerProps;
+        };
+        /**
+         * The workspace/session browsing region: section header, search, the
+         * grouped/flat session list, and every workspace dialog. Declared by this
+         * package's 'sidebar' entry (declaring is claiming); ui-workspace
+         * registers the browser.
+         */
+        'sidebar.workspaces': {
+            kind: 'single';
+            scope: 'root';
+            owner: SidebarSectionOwnerProps;
+        };
+        /**
+         * The settings seat at the sidebar foot. Declared by this package's
+         * 'sidebar' entry; ui-settings registers its panel and the connection
+         * recovery row it reports while closed. The sidebar passes only its
+         * column state — it holds no settings state, and the account menu owns
+         * the visible Settings entry point.
+         */
+        'sidebar.settings': {
+            kind: 'single';
+            scope: 'root';
+            owner: SidebarSettingsOwnerProps;
+        };
+        /**
+         * The sidebar foot's account row, declared by this package's 'sidebar'
+         * entry and occupied by the account menu. It stacks below the footer
+         * actions and receives only the column state.
+         */
+        'sidebar.account': {
+            kind: 'single';
+            scope: 'root';
+            owner: SidebarFooterActionOwnerProps;
+        };
+        /**
+         * Optional additive actions at the sidebar foot, stacked above the account
+         * row. Declared by this package's 'sidebar' entry; each action receives
+         * only the column state.
+         */
+        'sidebar.footer.action': {
+            kind: 'list';
+            scope: 'root';
+            owner: SidebarFooterActionOwnerProps;
+        };
+    }
+}
+/** Geometry supplied to the sidebar brand-mark occupant. */
+export interface SidebarBrandMarkOwnerProps {
+    /** Requested square edge in pixels. */
+    size: number;
+}
+/** Empty owner share for the sidebar brand-name occupant. */
+export interface SidebarBrandNameOwnerProps {
+    /** Marker field: the occupant owns its own content and width. */
+    children?: never;
+}
+/** Icon presentation supplied by the global panel row. */
+export interface SidebarPanelIconOwnerProps {
+    /** Requested square edge in pixels. */
+    size: number;
+    /** Whether this panel is selected in the main column. */
+    active: boolean;
+}
+/** Owner share of a section-assignments seat: row-id → section label. */
+export interface SidebarSectionAssignmentsOwnerProps {
+    /** Applied over every panel row; an assignment wins over the row's own section. */
+    assignments: Readonly<Record<string, string>>;
+}
+/** Serializable metadata for one active global panel list registration. */
+export interface SidebarPanelMetadata {
+    /** List id and matching main panel key. */
+    id: MainPanelId;
+    /** Ascending row order; ties retain registration order. */
+    order: number;
+    /** Row title and accessible name: resolved label, or the id when omitted. */
+    label: string;
+    /**
+     * Optional grouping label. Consecutive rows sharing a section render under
+     * one header; `undefined` rows render header-less. The sidebar owns the
+     * header because it owns the list.
+     *
+     * Spelled `| undefined` on purpose: this value is copied out of the
+     * type-erased registration options (which admit undefined under
+     * exactOptionalPropertyTypes), so the projection must accept it.
+     */
+    section?: string | undefined;
+}
+/**
+ * Owner share of the browser hole — the only facts crossing the shell/region
+ * boundary. Business data and actions arrive through the region's own inject.
+ */
+export interface SidebarSectionOwnerProps {
+    /** Shell fold-state output: wide renders the full browser, rail the icon column. */
+    wide: boolean;
+    /** Rail icons request expansion; the browser rides the wide flip for focus. */
+    expandSidebar: () => void;
+}
+/**
+ * Owner share of the sidebar settings seat: the column display state the
+ * occupant renders against (wide row vs 56px rail).
+ */
+export interface SidebarSettingsOwnerProps {
+    /** Whether the sidebar renders wide content (false = 56px rail). */
+    wide: boolean;
+}
+/** Owner share of an action rendered at the sidebar foot. */
+export interface SidebarFooterActionOwnerProps {
+    /** Whether the sidebar renders wide content (false = 56px rail). */
+    wide: boolean;
+}
+/**
+ * Registrant-private injected share (arrives via the register inject
+ * factory). The renderer binds the panel metadata source to usePanels.
+ */
+export type SidebarRootInjected = {
+    /**
+     * Start a New Session: with a workspace, reuse-or-create its blank session
+     * and open it; without one, inherit the current Session Workspace, then the
+     * recent Workspace, or clear into the New Session pure view when none exist.
+     */
+    startSession: (workspaceId?: WorkspaceId) => void;
+    /** Toggle the sidebar column through the layout service. */
+    toggleSidebar: () => void;
+    /** Select the global panel addressed by a sidebar row. */
+    selectPanel: (id: MainPanelId) => void;
+    /** Private reactive sources bound to framework selector hooks. */
+    hooks: {
+        panels: ObservableSnapshot<readonly SidebarPanelMetadata[]>;
+        shortcuts: ObservableSnapshot<readonly ShortcutCatalogEntry[]>;
+    };
+};
+/**
+ * Full component props: layout owner state/actions plus the declared holes'
+ * render shares, this package's injected callbacks, and the standard locale
+ * seat. Panel metadata arrives through an injected observable.
+ */
+export type SidebarRootComponentProps = PropsRuntime<'sidebar'> & PropsRenderSlots<'sidebar.brand.mark' | 'sidebar.brand.name' | 'sidebar.toggle.badge' | 'sidebar.panellist' | 'sidebar.workspaces' | 'sidebar.settings' | 'sidebar.account' | 'sidebar.footer.action'> & InjectFace<SidebarRootInjected> & PropsLocale<'sidebar'>;
+//# sourceMappingURL=slots.d.ts.map

package/lib/types/client/index.d.ts

@@ -0,0 +1,18 @@
+/** Registers the sidebar shell and global panel navigation. */
+import type { Context as ClientContext } from '@qilin-agent/kylin';
+import { type SidebarKey } from './locales.ts';
+export type { SidebarBrandMarkOwnerProps, SidebarBrandNameOwnerProps, SidebarFooterActionOwnerProps, SidebarPanelIconOwnerProps, SidebarPanelMetadata, SidebarRootComponentProps, SidebarRootInjected, SidebarSectionAssignmentsOwnerProps, SidebarSectionOwnerProps, SidebarSettingsOwnerProps, } from './contract/slots.ts';
+export type { SidebarKey } from './locales.ts';
+declare module '@qilin-agent/client-ui-slots' {
+    interface LocaleNamespaceMap {
+        /** Sidebar controls and global panel copy. */
+        sidebar: SidebarKey;
+    }
+}
+/** Services required by the sidebar plugin. */
+export declare const inject: string[];
+/** Registers the sidebar shell and its service callbacks.
+ * @param ctx - Client root context.
+ */
+export declare function apply(ctx: ClientContext): void;
+//# sourceMappingURL=index.d.ts.map

package/lib/types/client/locales.d.ts

@@ -0,0 +1,22 @@
+/** `sidebar` namespace dictionaries for shell controls and global panels. */
+/** Simplified Chinese dictionary (the key-set source of truth). */
+export declare const zh: {
+    'shortcut.hint': string;
+    'session.new': string;
+    'session.new.label': string;
+    'toggle.open': string;
+    'toggle.collapse': string;
+    'panels.label': string;
+};
+/** The sidebar namespace key union. */
+export type SidebarKey = keyof typeof zh;
+/** English dictionary, checked complete against the zh key set. */
+export declare const en: {
+    'shortcut.hint': string;
+    'session.new': string;
+    'session.new.label': string;
+    'toggle.open': string;
+    'toggle.collapse': string;
+    'panels.label': string;
+};
+//# sourceMappingURL=locales.d.ts.map

package/lib/types/index.d.ts

@@ -0,0 +1,4 @@
+/** Host loader entry for the browser-only sidebar plugin. */
+/** Provides no host-side behavior. */
+export declare function apply(): void;
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,77 @@
 {
   "name": "@qilin-agent/client-ui-sidebar",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "description": "Sidebar plugin: session multi-level tree, search, grouping, state dots",
+  "version": "3.1.4",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kkutysllb/QiLin.git",
+    "directory": "packages/client/ui-sidebar"
+  },
+  "engines": {
+    "node": "^22.19.0 || >=24.0.0"
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./client": {
+      "types": "./lib/types/client/index.d.ts",
+      "default": "./lib/client.js"
+    },
+    "./src/*": "./src/*",
+    "./package.json": "./package.json"
+  },
+  "qilin": {
+    "client": {
+      "inject": [
+        "@qilin-agent/api-workspace-controller",
+        "@qilin-agent/client-locale",
+        "@qilin-agent/client-shortcuts",
+        "@qilin-agent/client-ui-conversation",
+        "@qilin-agent/client-ui-layout",
+        "@qilin-agent/client-ui-renderer",
+        "@qilin-agent/client-ui-session",
+        "@qilin-agent/client-ui-workspace"
+      ],
+      "platform": "web"
+    }
+  },
+  "license": "MIT",
+  "peerDependencies": {
+    "@qilin-agent/kylin": "~4.0.3"
+  },
+  "devDependencies": {
+    "@types/react": "~18.3.1",
+    "clsx": "^2.0.0",
+    "react": "^18.2.0",
+    "@qilin-agent/api-workspace-controller": "3.1.4",
+    "@qilin-agent/client-locale": "3.1.4",
+    "@qilin-agent/client-shortcuts": "3.1.4",
+    "@qilin-agent/client-ui-conversation": "3.1.4",
+    "@qilin-agent/client-test-runtime": "3.1.4",
+    "@qilin-agent/client-store": "3.1.4",
+    "@qilin-agent/client-ui-layout": "3.1.4",
+    "@qilin-agent/client-ui-primitives": "3.1.4",
+    "@qilin-agent/client-ui-renderer": "3.1.4",
+    "@qilin-agent/client-ui-session": "3.1.4",
+    "@qilin-agent/client-ui-slots": "3.1.4",
+    "@qilin-agent/client-ui-workspace": "3.1.4",
+    "@qilin-agent/kylin": "~4.0.3"
+  },
+  "files": [
+    "lib/index.js",
+    "lib/client.js",
+    "lib/types/**/*.d.ts"
+  ],
+  "scripts": {
+    "bundle": "tsdown",
+    "watch": "tsdown --watch"
+  }
 }