@zaflun/lumio-extension-types

Shared TypeScript types for the Lumio Extension Platform. Used by @zaflun/lumio-sdk and @zaflun/lumio-cli for type-safe extension development.

Installation

npm install @zaflun/lumio-extension-types

What's included

Extension Types

import type { Extension, ExtensionVersion, ExtensionInstall } from "@zaflun/lumio-extension-types";
import { extensionSchema, extensionCategorySchema } from "@zaflun/lumio-extension-types";

• Extension — Store listing (name, slug, category, pricing, ratings)
• ExtensionVersion — Version metadata (status, manifest, bundle hash)
• ExtensionInstall — Per-account installation (config, auto-update)
• ExtensionReview — User review (rating 1-5, comment)

Config Types

import type { LumioExtensionConfig } from "@zaflun/lumio-extension-types";
import { lumioExtensionConfigSchema } from "@zaflun/lumio-extension-types";

// Validate a lumio.config.json file
const result = lumioExtensionConfigSchema.safeParse(configData);

Developer Types

import type { DeveloperProfile, DeveloperTeam } from "@zaflun/lumio-extension-types";

Enums

import {
  EXTENSION_CATEGORIES,    // widget, extension, overlay, bot_module, integration, theme
  EXTENSION_VISIBILITIES,  // private, unlisted, public, paid
  EXTENSION_STATUSES,      // draft, published, deprecated, ...
  VERSION_STATUSES,        // draft, pending_review, testing, published, ...
  DEVELOPER_TYPES,         // individual, company
  DEVELOPER_TEAM_ROLES,    // owner, admin, member
} from "@zaflun/lumio-extension-types";

All types include Zod schemas for runtime validation.

Documentation

• Type Reference
• Full Docs

License

MIT © zaflun