@plyaz/types 1.46.0 → 1.46.1

package/dist/core/frontend/types.d.ts

@@ -12,6 +12,7 @@ import type { CoreBaseDomainServiceConfig } from '../domain';
 import type { CoreBaseServiceConfig, CoreBaseMapperInstance, CoreBaseValidatorInstance } from '../domain';
 import type { CoreDomainServiceInstance, CoreObservabilityConfig, CoreServiceEntry } from '../init';
 import type { PackageErrorLike } from '../../errors';
+import type { DevtoolsConfig } from '../../devtools';
 /**
  * Base store interface for frontend services.
  *
@@ -1102,6 +1103,8 @@ export interface CorePlyazConfig {
     observability?: CoreObservabilityConfig;
     /** Enable verbose logging */
     verbose?: boolean;
+    /** DevTools configuration */
+    devtools?: DevtoolsConfig;
 }
 /**
  * Interface for services that can provide feature flags.

package/dist/devtools/index.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/devtools/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}

package/dist/devtools/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * DevTools Types Module
+ *
+ * @module devtools
+ */
+export type * from './types';

package/dist/devtools/index.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/devtools/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/devtools/types.d.ts

@@ -0,0 +1,238 @@
+/**
+ * DevTools Types
+ *
+ * Type definitions for PlyazDevtools configuration and state.
+ * These types are used by @plyaz/core/devtools.
+ *
+ * @module devtools
+ */
+import type { ComponentType, ReactNode } from 'react';
+import type { CorePlyazConfig } from '../core';
+/**
+ * Available devtools tab identifiers
+ */
+export type DevtoolsTab = 'stores' | 'actions' | 'api' | 'streaming' | 'security' | 'compliance' | 'accessibility' | 'services' | 'errors' | 'events' | 'uploads' | 'observability' | 'config' | 'storage' | 'playground' | 'runner' | 'flags' | 'mocking' | 'explorer' | 'ssr' | 'routes' | 'i18n' | 'react' | 'console' | 'shortcuts';
+/**
+ * Tab group configuration
+ */
+export interface TabGroupConfig {
+    /** Group identifier */
+    id: string;
+    /** Display name */
+    name: string;
+    /** Short name for compact displays */
+    shortName: string;
+    /** Icon (emoji or component) */
+    icon: string;
+    /** Color theme for the group */
+    color: string;
+    /** Tabs in this group */
+    tabs: DevtoolsTab[];
+    /** Description for tooltips */
+    description?: string;
+}
+/**
+ * Tab plugin definition for custom tabs
+ */
+export interface TabPlugin {
+    /** Unique identifier for the tab */
+    id: string;
+    /** Tab metadata */
+    metadata: {
+        /** Full display name */
+        name: string;
+        /** Short name for compact displays */
+        shortName: string;
+        /** Icon (emoji or component) */
+        icon: ReactNode;
+        /** Group to place this tab in */
+        group?: string;
+        /** Keywords for search */
+        keywords?: string[];
+        /** Description for tooltips/search */
+        description?: string;
+    };
+    /** Tab component */
+    component: ComponentType;
+    /** Optional lifecycle hooks */
+    onMount?: () => void;
+    onUnmount?: () => void;
+    /** Required adapters for this tab to work */
+    requiredAdapters?: string[];
+}
+/**
+ * Keyboard shortcut configuration
+ */
+export interface ShortcutConfig {
+    /** Shortcut key combination (e.g., 'Ctrl+K') */
+    key: string;
+    /** Action identifier */
+    action: string;
+    /** Description for help */
+    description?: string;
+    /** Whether this shortcut is enabled */
+    enabled?: boolean;
+}
+/**
+ * Storage adapter interface for custom storage implementations
+ */
+export interface DevtoolsStorageAdapter {
+    get<T>(key: string): Promise<T | null>;
+    set<T>(key: string, value: T): Promise<void>;
+    delete(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+/**
+ * Core adapter configuration for @plyaz/core integration
+ */
+export interface CoreAdapterConfig {
+    /** Hook to check if core is ready */
+    useReady?: () => boolean;
+    /** Hook to get core context */
+    useContext?: () => unknown;
+    /** Hook to get event manager */
+    useEvents?: () => unknown;
+}
+/**
+ * Store adapter configuration for @plyaz/store integration
+ */
+export interface StoreAdapterConfig {
+    /** Hook to get root store */
+    useRootStore?: () => unknown;
+    /** Hook to get errors */
+    useErrors?: () => unknown[];
+    /** Hook to check stream connection */
+    useStreamConnected?: () => boolean;
+    /** Hook to get stream messages */
+    useStreamMessages?: () => unknown[];
+    /** Custom store hooks */
+    [key: string]: (() => unknown) | undefined;
+}
+/**
+ * App config adapter for accessing application configuration
+ */
+export interface ConfigAdapterConfig {
+    /** Get frontend configuration */
+    getFrontendConfig?: () => unknown;
+    /** Get environment variables */
+    getEnv?: () => Record<string, unknown>;
+    /** Get feature flags */
+    getFeatureFlags?: () => Record<string, boolean>;
+}
+/**
+ * Package export configuration for ExplorerTab
+ */
+export interface PackageExport {
+    name: string;
+    displayName: string;
+    color: string;
+    exports: Record<string, unknown>;
+}
+/**
+ * App-specific configuration passed to devtools
+ * This allows devtools to work generically across different Plyaz apps
+ *
+ * @template TConfig - The frontend config type (defaults to CorePlyazConfig)
+ */
+export interface DevtoolsAppConfig<TConfig = CorePlyazConfig> {
+    /** Frontend configuration object (from app's plyaz.frontend.ts) */
+    frontendConfig?: TConfig;
+    /** Package exports for ExplorerTab */
+    packageExports?: PackageExport[];
+}
+/**
+ * Main DevTools configuration interface
+ */
+export interface DevtoolsConfig {
+    /** Whether devtools is enabled */
+    enabled?: boolean;
+    /** Panel position */
+    position?: 'bottom' | 'left' | 'right';
+    /** Default panel height (in pixels) */
+    defaultHeight?: number;
+    /** Default panel width (in pixels, for left/right positions) */
+    defaultWidth?: number;
+    /** Color theme */
+    theme?: 'dark' | 'light';
+    /** Tab configuration */
+    tabs?: {
+        /** Which tabs to enable (use ['*'] for all) */
+        enabled?: string[];
+        /** Which tabs to explicitly disable */
+        disabled?: string[];
+        /** Custom tab groups configuration */
+        groups?: TabGroupConfig[];
+        /** Default pinned/favorite tabs */
+        favorites?: string[];
+        /** Custom tabs to register */
+        custom?: TabPlugin[];
+        /** Default active tab */
+        defaultTab?: DevtoolsTab;
+    };
+    /** Storage configuration */
+    storage?: {
+        /** Storage adapter type or custom implementation */
+        adapter?: 'indexeddb' | 'memory' | DevtoolsStorageAdapter;
+        /** How many days to retain data */
+        retentionDays?: number;
+        /** Maximum items to store per category */
+        maxItems?: number;
+    };
+    /** Keyboard shortcuts configuration */
+    shortcuts?: {
+        /** Toggle devtools shortcut */
+        toggle?: string;
+        /** Open search shortcut */
+        search?: string;
+        /** Close shortcut */
+        close?: string;
+        /** Custom shortcuts */
+        custom?: ShortcutConfig[];
+    };
+    /** Adapter configuration for external dependencies */
+    adapters?: {
+        core?: CoreAdapterConfig;
+        store?: StoreAdapterConfig;
+        config?: ConfigAdapterConfig;
+    };
+    /** App-specific configuration (env, frontendConfig, etc.) */
+    appConfig?: DevtoolsAppConfig<CorePlyazConfig>;
+    /** Security configuration */
+    security?: {
+        /** Read-only mode (disable mutations) */
+        readOnly?: boolean;
+        /** Keys to mask in display (e.g., tokens, passwords) */
+        sensitiveKeys?: string[];
+    };
+    /** Event hooks */
+    hooks?: {
+        onOpen?: () => void;
+        onClose?: () => void;
+        onTabChange?: (tab: string) => void;
+        onError?: (error: Error) => void;
+    };
+}
+/**
+ * Date range filter for data queries
+ */
+export interface DateRange {
+    start: number;
+    end: number;
+    label: string;
+}
+/**
+ * Devtools settings persisted to storage
+ */
+export interface DevtoolsSettings {
+    isOpen: boolean;
+    activeTab: DevtoolsTab;
+    position: 'bottom' | 'left' | 'right';
+    height: number;
+    width: number;
+    theme: 'dark' | 'light';
+    maxMessages: number;
+    hideHeartbeats: boolean;
+    pinnedTabs: DevtoolsTab[];
+    recentTabs: DevtoolsTab[];
+    collapsedGroups: Record<string, boolean>;
+}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './auth';
 export type * from './common';
 export * from './core';
+export type * from './devtools';
 export type * from './store';
 export type * from './entities';
 export * from './errors';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.46.0",
+  "version": "1.46.1",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",
@@ -205,6 +205,11 @@
       "import": "./dist/db/index.js",
       "require": "./dist/db/index.cjs"
     },
+    "./devtools": {
+      "types": "./dist/devtools/index.d.ts",
+      "import": "./dist/devtools/index.js",
+      "require": "./dist/devtools/index.cjs"
+    },
     "./user": {
       "types": "./dist/user/index.d.ts",
       "import": "./dist/user/index.js",