@usesidekick/react 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,358 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode, ComponentType } from 'react';
+export { configureJsxRuntime, getSeenComponentsFromJsx, isJsxRuntimeConfigured, onConfigChange } from './jsx-runtime.js';
+
+interface SidekickProviderProps {
+    children: ReactNode;
+    /** API endpoint to fetch overrides from (for production/DB-backed overrides) */
+    overridesEndpoint?: string;
+}
+declare function SidekickProvider({ children, overridesEndpoint }: SidekickProviderProps): react_jsx_runtime.JSX.Element;
+
+interface Override {
+    id: string;
+    name: string;
+    description: string;
+    version: string;
+    enabled: boolean;
+}
+interface OverrideManifest {
+    id: string;
+    name: string;
+    description: string;
+    version: string;
+    primitives: string[];
+}
+interface OverrideModule {
+    manifest: OverrideManifest;
+    activate: (sdk: SDK) => void | Promise<void>;
+}
+interface WrappedComponent {
+    id: string;
+    overrideId: string;
+    wrapper: (Component: ComponentType) => ComponentType;
+    priority?: number;
+    where?: (props: Record<string, unknown>) => boolean;
+}
+interface AddedColumn {
+    id: string;
+    overrideId: string;
+    tableId: string;
+    header: string;
+    accessor: string | ((row: Record<string, unknown>) => unknown);
+    render?: (value: unknown, row: Record<string, unknown>) => ReactNode;
+    priority?: number;
+}
+interface ColumnRename {
+    id: string;
+    overrideId: string;
+    tableId: string;
+    originalHeader: string;
+    newHeader: string;
+}
+interface HiddenColumn {
+    id: string;
+    overrideId: string;
+    tableId: string;
+    header: string;
+}
+interface ColumnOrder {
+    id: string;
+    overrideId: string;
+    tableId: string;
+    order: string[];
+}
+interface RowFilter {
+    id: string;
+    overrideId: string;
+    tableId: string;
+    filter: (row: Record<string, unknown>) => boolean;
+}
+interface MenuItem {
+    id: string;
+    overrideId: string;
+    menuId: string;
+    label: string;
+    icon?: string;
+    onClick: () => void;
+    priority?: number;
+}
+interface TabItem {
+    id: string;
+    overrideId: string;
+    tabGroupId: string;
+    label: string;
+    content: ComponentType<Record<string, unknown>>;
+    priority?: number;
+}
+interface PropsModifier {
+    id: string;
+    overrideId: string;
+    componentId: string;
+    modifier: (props: Record<string, unknown>) => Record<string, unknown>;
+}
+interface ActionItem {
+    id: string;
+    overrideId: string;
+    actionBarId: string;
+    label: string;
+    icon?: string;
+    onClick: (context: Record<string, unknown>) => void;
+    variant?: 'primary' | 'secondary' | 'danger';
+    priority?: number;
+}
+interface ValidationRule {
+    id: string;
+    overrideId: string;
+    formId: string;
+    fieldName: string;
+    validate: (value: unknown, formData: Record<string, unknown>) => string | null;
+    priority?: number;
+}
+interface ApiInterceptor {
+    id: string;
+    overrideId: string;
+    pathPattern: string | RegExp;
+    handler: (response: unknown, request: {
+        path: string;
+        method: string;
+    }) => unknown;
+}
+interface SortOption {
+    id: string;
+    overrideId: string;
+    tableId: string;
+    label: string;
+    field: string;
+    comparator: (a: Record<string, unknown>, b: Record<string, unknown>) => number;
+}
+interface GroupByOption {
+    id: string;
+    overrideId: string;
+    tableId: string;
+    label: string;
+    grouper: (item: Record<string, unknown>) => string;
+}
+interface DOMModification {
+    id: string;
+    overrideId: string;
+    selector: string;
+    type: 'setText' | 'setAttribute' | 'setStyle' | 'addClass' | 'removeClass';
+    value: unknown;
+}
+interface InjectionPoint {
+    id: string;
+    overrideId: string;
+    selector: string;
+    position: 'before' | 'after' | 'prepend' | 'append';
+    component: ComponentType<Record<string, unknown>>;
+}
+interface DOMEventListener {
+    id: string;
+    overrideId: string;
+    selector: string;
+    eventType: string;
+    handler: (event: Event, element: Element) => void;
+}
+interface EventHandler {
+    id: string;
+    overrideId: string;
+    eventName: string;
+    handler: (payload: Record<string, unknown>) => void;
+    priority?: number;
+}
+interface KeyboardShortcut {
+    id: string;
+    overrideId: string;
+    keys: string;
+    action: () => void;
+    description?: string;
+}
+interface RouteModifier {
+    id: string;
+    overrideId: string;
+    pathPattern: string | RegExp;
+    handler: (context: {
+        path: string;
+        params: Record<string, string>;
+    }) => void | string;
+}
+interface ComputedField {
+    id: string;
+    overrideId: string;
+    fieldName: string;
+    compute: (data: Record<string, unknown>) => unknown;
+}
+interface DataFilter {
+    id: string;
+    overrideId: string;
+    name: string;
+    filter: (items: unknown[]) => unknown[];
+}
+interface DataTransform {
+    id: string;
+    overrideId: string;
+    dataKey: string;
+    transform: (data: unknown) => unknown;
+}
+interface InjectedStyles {
+    id: string;
+    overrideId: string;
+    css: string;
+}
+interface UIPrimitives {
+    wrap: (componentName: string, wrapper: (Component: ComponentType) => ComponentType, options?: {
+        priority?: number;
+        where?: (props: Record<string, unknown>) => boolean;
+    }) => void;
+    replace: (componentName: string, replacement: ComponentType) => void;
+    addStyles: (css: string) => void;
+    addColumn: (tableId: string, config: Omit<AddedColumn, 'id' | 'overrideId' | 'tableId'>) => void;
+    renameColumn: (tableId: string, originalHeader: string, newHeader: string) => void;
+    hideColumn: (tableId: string, header: string) => void;
+    reorderColumns: (tableId: string, order: string[]) => void;
+    filterRows: (tableId: string, filter: (row: Record<string, unknown>) => boolean) => void;
+    addMenuItem: (menuId: string, config: Omit<MenuItem, 'id' | 'overrideId' | 'menuId'>) => void;
+    addTab: (tabGroupId: string, config: Omit<TabItem, 'id' | 'overrideId' | 'tabGroupId'>) => void;
+    modifyProps: (componentId: string, modifier: (props: Record<string, unknown>) => Record<string, unknown>) => void;
+    addAction: (actionBarId: string, config: Omit<ActionItem, 'id' | 'overrideId' | 'actionBarId'>) => void;
+    addValidation: (formId: string, fieldName: string, validate: (value: unknown, formData: Record<string, unknown>) => string | null) => void;
+    setText: (selector: string, text: string) => void;
+    setAttribute: (selector: string, attr: string, value: string) => void;
+    setStyle: (selector: string, styles: Record<string, string>) => void;
+    addClass: (selector: string, className: string) => void;
+    removeClass: (selector: string, className: string) => void;
+    inject: (selector: string, component: ComponentType<Record<string, unknown>>, position?: 'before' | 'after' | 'prepend' | 'append') => void;
+}
+interface DataPrimitives {
+    computed: (fieldName: string, compute: (data: Record<string, unknown>) => unknown) => void;
+    addFilter: (name: string, filter: (items: unknown[]) => unknown[]) => void;
+    transform: (dataKey: string, transformFn: (data: unknown) => unknown) => void;
+    intercept: (pathPattern: string | RegExp, handler: (response: unknown, request: {
+        path: string;
+        method: string;
+    }) => unknown) => void;
+    addSortOption: (tableId: string, config: Omit<SortOption, 'id' | 'overrideId' | 'tableId'>) => void;
+    addGroupBy: (tableId: string, config: Omit<GroupByOption, 'id' | 'overrideId' | 'tableId'>) => void;
+}
+interface BehaviorPrimitives {
+    onEvent: (eventName: string, handler: (payload: Record<string, unknown>) => void, options?: {
+        priority?: number;
+    }) => void;
+    addKeyboardShortcut: (keys: string, action: () => void, description?: string) => void;
+    modifyRoute: (pathPattern: string | RegExp, handler: (context: {
+        path: string;
+        params: Record<string, string>;
+    }) => void | string) => void;
+    onDOMEvent: (selector: string, eventType: string, handler: (event: Event, element: Element) => void) => void;
+}
+interface SDK {
+    ui: UIPrimitives;
+    data: DataPrimitives;
+    behavior: BehaviorPrimitives;
+}
+interface SidekickState {
+    overrides: Override[];
+    wrappers: Map<string, WrappedComponent[]>;
+    replacements: Map<string, ComponentType>;
+    styles: InjectedStyles[];
+    columns: Map<string, AddedColumn[]>;
+    columnRenames: Map<string, ColumnRename[]>;
+    hiddenColumns: Map<string, HiddenColumn[]>;
+    columnOrders: Map<string, ColumnOrder>;
+    rowFilters: Map<string, RowFilter[]>;
+    menuItems: Map<string, MenuItem[]>;
+    tabs: Map<string, TabItem[]>;
+    propsModifiers: Map<string, PropsModifier[]>;
+    actions: Map<string, ActionItem[]>;
+    validations: Map<string, ValidationRule[]>;
+    computedFields: Map<string, ComputedField>;
+    filters: Map<string, DataFilter>;
+    transforms: Map<string, DataTransform>;
+    interceptors: ApiInterceptor[];
+    sortOptions: Map<string, SortOption[]>;
+    groupByOptions: Map<string, GroupByOption[]>;
+    eventHandlers: Map<string, EventHandler[]>;
+    keyboardShortcuts: KeyboardShortcut[];
+    routeModifiers: RouteModifier[];
+    domModifications: DOMModification[];
+    injections: InjectionPoint[];
+    domEventListeners: DOMEventListener[];
+}
+
+interface SidekickContextValue {
+    state: SidekickState;
+    overrides: Override[];
+    isOverrideEnabled: (id: string) => boolean;
+    toggleOverride: (id: string) => void;
+    getColumns: (tableId: string) => AddedColumn[];
+    getColumnRenames: (tableId: string) => ColumnRename[];
+    getHiddenColumns: (tableId: string) => HiddenColumn[];
+    getColumnOrder: (tableId: string) => ColumnOrder | undefined;
+    getMenuItems: (menuId: string) => MenuItem[];
+    getTabs: (tabGroupId: string) => TabItem[];
+    getActions: (actionBarId: string) => ActionItem[];
+    getValidations: (formId: string) => ValidationRule[];
+    getWrapper: (componentName: string) => ((Component: ComponentType) => ComponentType) | undefined;
+    getReplacement: (componentName: string) => ComponentType | undefined;
+    applyPropsModifiers: (componentId: string, props: Record<string, unknown>) => Record<string, unknown>;
+    getComputedValue: <T>(fieldName: string, data: Record<string, unknown>) => T | undefined;
+    applyFilters: <T>(filterName: string, items: T[]) => T[];
+    applyTransform: <T>(dataKey: string, data: T) => T;
+    getSortOptions: (tableId: string) => SortOption[];
+    getGroupByOptions: (tableId: string) => GroupByOption[];
+    getKeyboardShortcuts: () => KeyboardShortcut[];
+    emitEvent: (eventName: string, payload: Record<string, unknown>) => void;
+}
+declare function useSidekickSafe(): SidekickContextValue | null;
+declare function useSidekick(): SidekickContextValue;
+declare function useAddedColumns(tableId: string): AddedColumn[];
+declare function useColumnRenames(tableId: string): ColumnRename[];
+declare function useHiddenColumns(tableId: string): HiddenColumn[];
+declare function useColumnOrder(tableId: string): ColumnOrder | undefined;
+declare function useMenuItems(menuId: string): MenuItem[];
+declare function useTabs(tabGroupId: string): TabItem[];
+declare function useActions(actionBarId: string): ActionItem[];
+declare function useValidations(formId: string): ValidationRule[];
+declare function usePropsModifier(componentId: string, props: Record<string, unknown>): Record<string, unknown>;
+declare function useComputedField<T>(fieldName: string, data: Record<string, unknown>): T | undefined;
+declare function useFilter<T>(filterName: string, items: T[]): T[];
+declare function useSortOptions(tableId: string): SortOption[];
+declare function useGroupByOptions(tableId: string): GroupByOption[];
+declare function useKeyboardShortcuts(): KeyboardShortcut[];
+declare function useEventEmitter(): (eventName: string, payload: Record<string, unknown>) => void;
+
+interface SidekickPanelProps {
+    apiEndpoint?: string;
+    deleteEndpoint?: string;
+    toggleEndpoint?: string;
+    onGenerate?: (request: string) => Promise<{
+        success: boolean;
+        overrideId?: string;
+        error?: string;
+    }>;
+    onDelete?: (overrideId: string) => Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    onToggle?: (overrideId: string, enabled: boolean) => Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+}
+declare function SidekickPanel({ apiEndpoint, deleteEndpoint, toggleEndpoint, onGenerate, onDelete, onToggle }: SidekickPanelProps): react_jsx_runtime.JSX.Element;
+
+declare function registerOverride(module: OverrideModule): void;
+declare function getRegisteredOverrides(): OverrideModule[];
+declare function createOverride(manifest: OverrideManifest, activate: OverrideModule['activate']): OverrideModule;
+
+interface FlagState {
+    [overrideId: string]: boolean;
+}
+declare function loadFlags(): FlagState;
+declare function saveFlags(flags: FlagState): void;
+declare function getFlag(overrideId: string): boolean;
+declare function setFlag(overrideId: string, enabled: boolean): void;
+declare function toggleFlag(overrideId: string): boolean;
+
+export { type ActionItem, type AddedColumn, type ApiInterceptor, type BehaviorPrimitives, type ColumnOrder, type ColumnRename, type ComputedField, type DOMEventListener, type DOMModification, type DataFilter, type DataPrimitives, type DataTransform, type EventHandler, type GroupByOption, type HiddenColumn, type InjectionPoint, type KeyboardShortcut, type MenuItem, type Override, type OverrideManifest, type OverrideModule, type PropsModifier, type RouteModifier, type RowFilter, type SDK, SidekickPanel, SidekickProvider, type SidekickState, type SortOption, type TabItem, type UIPrimitives, type ValidationRule, type WrappedComponent, createOverride, getFlag, getRegisteredOverrides, loadFlags, registerOverride, saveFlags, setFlag, toggleFlag, useActions, useAddedColumns, useColumnOrder, useColumnRenames, useComputedField, useEventEmitter, useFilter, useGroupByOptions, useHiddenColumns, useKeyboardShortcuts, useMenuItems, usePropsModifier, useSidekick, useSidekickSafe, useSortOptions, useTabs, useValidations };