bitxu-core-types

Core TypeScript types for the Bitxu platform.

Installation

npm install bitxu-core-types
# or
pnpm add bitxu-core-types
# or
yarn add bitxu-core-types

Usage

import { App, Tenant, MenuItem, TenantApp, User } from 'bitxu-core-types';

const app: App = {
  id: 'my-app',
  slug: 'my-app',
  name: 'My App',
  description: 'A sample application',
  icon: '📱',
  version: '1.0.0',
  entryUrl: '/app',
  category: 'Productivity',
  permissions: ['read:users', 'write:users'],
  developer: 'Bitxu',
  isActive: true,
  createdAt: new Date(),
  updatedAt: new Date(),
};

Types

App

Application in the marketplace.

interface App {
  id: string;
  slug: string;
  name: string;
  description: string;
  icon: string;
  version: string;
  entryUrl: string;
  category?: string;
  permissions: string[];
  developer: string;
  isActive: boolean;
  createdAt: Date;
  updatedAt: Date;
}

Tenant

Workspace/organization.

interface Tenant {
  id: string;
  name: string;
  slug: string;
  logo?: string | null;
  createdAt?: Date;
  updatedAt?: Date;
}

TenantApp

Installed app in a tenant.

interface TenantApp {
  id: string;
  tenantId: string;
  appId: string;
  installedAt: Date;
  installedBy: string;
  status: 'active' | 'inactive' | 'suspended';
  config?: Record<string, unknown>;
}

MenuItem

Navigation menu item.

interface MenuItem {
  id: string;
  appId: string;
  label?: string;
  icon?: string;
  order: number;
  visible: boolean;
}

User

Platform user.

interface User {
  uid: string;
  email: string | null;
  displayName: string | null;
  photoURL: string | null;
  createdAt?: Date;
  lastSignInAt?: Date;
}

Development

# Build
pnpm build

# Type check
pnpm typecheck

License

MIT