@harborclient/sdk 0.6.16 → 0.7.0

package/dist/runtime/index.d.ts

@@ -1,4 +1,5 @@
 import type * as React from 'react';
+import type { Disposable, PluginContext, ThemeContribution } from '../types';
 
 /**
  * Installs the HarborClient renderer React instance for plugin JSX and hooks.
@@ -18,3 +19,20 @@ export function installReact(react: typeof React): void;
 export function createPluginComponent<P extends Record<string, unknown>>(
   factory: (react: typeof React) => React.ComponentType<P>
 ): React.ComponentType<P>;
+
+/**
+ * Registers a custom appearance theme and tracks its disposable for cleanup.
+ *
+ * @param hc - Renderer plugin context.
+ * @param theme - Theme definition; `theme.id` must match `contributes.themes`.
+ * @returns Disposable that unregisters the theme.
+ */
+export function registerTheme(hc: PluginContext, theme: ThemeContribution): Disposable;
+
+/**
+ * Identity helper that applies `ThemeContribution` typing to a theme literal.
+ *
+ * @param theme - Theme definition.
+ * @returns The same theme, typed.
+ */
+export function defineTheme(theme: ThemeContribution): ThemeContribution;

package/dist/runtime/index.js

@@ -41,3 +41,26 @@ export function createPluginComponent(factory) {
 
   return PluginComponent;
 }
+
+/**
+ * Registers a custom appearance theme and tracks its disposable for cleanup.
+ *
+ * @param {import('../types').PluginContext} hc - Renderer plugin context.
+ * @param {import('../types').ThemeContribution} theme - Theme definition; `theme.id` must match `contributes.themes`.
+ * @returns {import('../types').Disposable} Disposable that unregisters the theme.
+ */
+export function registerTheme(hc, theme) {
+  const disposable = hc.themes.register(theme);
+  hc.subscriptions.push(disposable);
+  return disposable;
+}
+
+/**
+ * Identity helper that applies `ThemeContribution` typing to a theme literal.
+ *
+ * @param {import('../types').ThemeContribution} theme - Theme definition.
+ * @returns {import('../types').ThemeContribution} The same theme, typed.
+ */
+export function defineTheme(theme) {
+  return theme;
+}

package/dist/runtime/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/runtime/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/runtime/index.test.ts"],"names":[],"mappings":""}

package/dist/runtime/index.test.js

@@ -0,0 +1,41 @@
+import { describe, expect, it, jest } from '@jest/globals';
+import { defineTheme, registerTheme } from './index.js';
+/**
+ * Builds a minimal plugin context mock for registerTheme tests.
+ */
+function createMockPluginContext() {
+    const disposable = { dispose: jest.fn() };
+    const registerMock = jest.fn(() => disposable);
+    const subscriptions = [];
+    return {
+        subscriptions,
+        themes: { register: registerMock },
+        registerMock
+    };
+}
+describe('registerTheme', () => {
+    it('registers the theme, pushes the disposable onto subscriptions, and returns it', () => {
+        const hc = createMockPluginContext();
+        const theme = {
+            id: 'solarized',
+            title: 'Solarized Dark',
+            type: 'dark',
+            colors: { surface: '#002b36' }
+        };
+        const disposable = registerTheme(hc, theme);
+        expect(hc.registerMock).toHaveBeenCalledWith(theme);
+        expect(hc.subscriptions).toHaveLength(1);
+        expect(hc.subscriptions[0]).toBe(disposable);
+    });
+});
+describe('defineTheme', () => {
+    it('returns the theme argument unchanged', () => {
+        const theme = {
+            id: 'nord',
+            title: 'Nord',
+            type: 'dark',
+            stylesheet: 'dist/theme.css'
+        };
+        expect(defineTheme(theme)).toBe(theme);
+    });
+});

package/dist/runtime/index.test.ts

@@ -0,0 +1,53 @@
+import { describe, expect, it, jest } from '@jest/globals';
+import type { PluginContext, ThemeContribution } from '../types';
+import { defineTheme, registerTheme } from './index.js';
+
+/**
+ * Builds a minimal plugin context mock for registerTheme tests.
+ */
+function createMockPluginContext(): PluginContext & {
+  registerMock: jest.MockedFunction<PluginContext['themes']['register']>;
+} {
+  const disposable = { dispose: jest.fn() };
+  const registerMock = jest.fn(() => disposable);
+  const subscriptions: PluginContext['subscriptions'] = [];
+
+  return {
+    subscriptions,
+    themes: { register: registerMock },
+    registerMock
+  } as unknown as PluginContext & {
+    registerMock: jest.MockedFunction<PluginContext['themes']['register']>;
+  };
+}
+
+describe('registerTheme', () => {
+  it('registers the theme, pushes the disposable onto subscriptions, and returns it', () => {
+    const hc = createMockPluginContext();
+    const theme: ThemeContribution = {
+      id: 'solarized',
+      title: 'Solarized Dark',
+      type: 'dark',
+      colors: { surface: '#002b36' }
+    };
+
+    const disposable = registerTheme(hc, theme);
+
+    expect(hc.registerMock).toHaveBeenCalledWith(theme);
+    expect(hc.subscriptions).toHaveLength(1);
+    expect(hc.subscriptions[0]).toBe(disposable);
+  });
+});
+
+describe('defineTheme', () => {
+  it('returns the theme argument unchanged', () => {
+    const theme: ThemeContribution = {
+      id: 'nord',
+      title: 'Nord',
+      type: 'dark',
+      stylesheet: 'dist/theme.css'
+    };
+
+    expect(defineTheme(theme)).toBe(theme);
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harborclient/sdk",
-  "version": "0.6.16",
+  "version": "0.7.0",
   "description": "TypeScript SDK for HarborClient plugin development.",
   "keywords": [
     "harborclient",