@kepoai/types

Shared TypeScript types for Kepo plugins and widgets.

Kepo is an AI desktop dashboard for creating, installing, and running widget plugins. This package defines the common plugin contract used by Kepo, including widget metadata, supported widget sizes, configuration types, event types, and plugin manifests.

Website: kepo.ai
Plugin store: kepo.ai/store

What This Package Provides

@kepoai/types is the shared type layer for Kepo plugin development. Use it when defining plugin manifests, dashboard widgets, responsive widget sizes, plugin capabilities, and widget configuration.

Common use cases:

• Define IPlugin and IWidget objects.
• Use the official Kepo widget size names.
• Read the size-to-grid mapping used by Kepo dashboard panels.
• Type widget configuration and event handlers.
• Mark widgets that require Kepo AI capabilities.

Installation

pnpm add @kepoai/types

Import

import type { IPlugin, IWidget, Size } from '@kepoai/types'
import { sizes, sizeScaleMap } from '@kepoai/types'

Example

import type { IPlugin, IWidget } from '@kepoai/types'
import { sizes } from '@kepoai/types'
import Example from './src/viewer/Example'
import { exampleProvider } from './src/provider/example'

const widgets: IWidget[] = [
  {
    name: 'example',
    description: 'Example Kepo dashboard widget',
    component: Example,
    sizes: [sizes.short, sizes.small, sizes.wide, sizes.large],
    configs: [],
    events: {
      onScheduled: exampleProvider.onScheduled,
    },
  },
]

const plugin: IPlugin = {
  name: 'example-plugin',
  description: 'A Kepo plugin for desktop dashboard widgets.',
  version: '0.1.0',
  widgets,
}

export default plugin

Widget Sizes

Kepo widgets use stable size names so plugins can render well across desktop dashboard layouts.

| Size | Grid scale | | --- | --- | | short | 2 x 1 | | small | 2 x 2 | | wide | 4 x 2 | | large | 4 x 4 | | giant | 6 x 6 |

Use sizeScaleMap when a plugin or preview needs to align with Kepo's panel layout.

Related Packages

• @kepoai/provider: provider-side storage, configuration, browser, network, scheduling, and AI APIs.
• @kepoai/ui: React hooks and viewer-side UI helpers for Kepo widgets.

Keywords

Kepo plugin types, Kepo widget types, desktop dashboard widgets, AI dashboard plugin, TypeScript widget SDK, plugin manifest types, dashboard panel layout, widget size types.