@oronts/vendure-data-hub-plugin 0.1.1 → 0.1.2

package/dist/dashboard/constants/index.ts

@@ -0,0 +1,24 @@
+export * from './navigation';
+export * from './steps';
+export * from './triggers';
+export * from './run-status';
+export * from './editor';
+export * from './ui-config';
+export * from './step-mappings';
+export * from './enum-maps';
+export * from './ui-dimensions';
+export * from './colors';
+export * from './step-configs';
+export * from './routes';
+export * from './permissions';
+export * from './connection-defaults';
+export * from './defaults';
+export * from './validation-patterns';
+export * from './sentinel-values';
+export * from './ui-types';
+export * from './connection-types';
+export * from './ui-states';
+export * from './toast-messages';
+export * from './placeholders';
+export * from './fallbacks';
+export * from './file-format-registry';

package/dist/dashboard/constants/navigation.ts

@@ -0,0 +1,29 @@
+/**
+ * Navigation constants for DataHub admin UI.
+ *
+ * Note: These values must match the backend constants in src/constants/core.ts
+ * to ensure proper navigation and routing. The dashboard maintains its own copy
+ * to avoid layer violations between dashboard and backend code.
+ */
+
+/** Navigation section identifier for DataHub */
+export const DATAHUB_NAV_SECTION = 'data-hub';
+
+/** Navigation item ID for pipelines */
+export const DATAHUB_NAV_ID = 'data-hub-pipelines';
+
+/** Base route for pipeline pages */
+export const DATAHUB_ROUTE_BASE = '/data-hub/pipelines';
+
+/** Base path for DataHub REST API endpoints */
+export const DATAHUB_API_BASE = '/data-hub';
+
+/** File upload API endpoint */
+export const DATAHUB_API_UPLOAD = `${DATAHUB_API_BASE}/upload`;
+
+/**
+ * Generate webhook URL for a pipeline.
+ * @param code - The pipeline code
+ */
+export const DATAHUB_API_WEBHOOK = (code: string) =>
+    `${DATAHUB_API_BASE}/webhook/${code}`;

package/dist/dashboard/constants/permissions.ts

@@ -0,0 +1,41 @@
+export const DATAHUB_PERMISSIONS = {
+    // Pipeline CRUD permissions
+    CREATE_PIPELINE: 'CreateDataHubPipeline',
+    READ_PIPELINE: 'ReadDataHubPipeline',
+    UPDATE_PIPELINE: 'UpdateDataHubPipeline',
+    DELETE_PIPELINE: 'DeleteDataHubPipeline',
+
+    // Secret CRUD permissions
+    CREATE_SECRET: 'CreateDataHubSecret',
+    READ_SECRET: 'ReadDataHubSecret',
+    UPDATE_SECRET: 'UpdateDataHubSecret',
+    DELETE_SECRET: 'DeleteDataHubSecret',
+
+    // Pipeline execution permissions
+    RUN_PIPELINE: 'RunDataHubPipeline',
+    VIEW_RUNS: 'ViewDataHubRuns',
+    PUBLISH_PIPELINE: 'PublishDataHubPipeline',
+    REVIEW_PIPELINE: 'ReviewDataHubPipeline',
+
+    // Configuration management permissions
+    MANAGE_ADAPTERS: 'ManageDataHubAdapters',
+    MANAGE_CONNECTIONS: 'ManageDataHubConnections',
+    UPDATE_SETTINGS: 'UpdateDataHubSettings',
+
+    // Quarantine/error handling permissions (using consistent naming)
+    VIEW_QUARANTINE: 'ViewDataHubQuarantine',
+    EDIT_QUARANTINE: 'EditDataHubQuarantine',
+    REPLAY_RECORD: 'ReplayDataHubRecord',
+
+    // Analytics and monitoring permissions
+    VIEW_ANALYTICS: 'ViewDataHubAnalytics',
+    MANAGE_WEBHOOKS: 'ManageDataHubWebhooks',
+    MANAGE_DESTINATIONS: 'ManageDataHubDestinations',
+    MANAGE_FEEDS: 'ManageDataHubFeeds',
+    VIEW_ENTITY_SCHEMAS: 'ViewDataHubEntitySchemas',
+    SUBSCRIBE_EVENTS: 'SubscribeDataHubEvents',
+
+    // File management permissions
+    MANAGE_FILES: 'ManageDataHubFiles',
+    READ_FILES: 'ReadDataHubFiles',
+} as const;

package/dist/dashboard/constants/placeholders.ts

@@ -0,0 +1,77 @@
+/**
+ * Placeholder Text Constants
+ *
+ * Centralized placeholder text for form inputs and sample data.
+ * Eliminates hardcoded strings scattered across components.
+ */
+
+export const PLACEHOLDERS = {
+    // Field inputs
+    FIELD_NAME: 'Field name (e.g., sku, price)',
+    REGEX_PATTERN: 'Regex pattern (e.g., ^[A-Z]{3}-\\d+$)',
+    ERROR_MESSAGE: 'Error message (optional)',
+
+    // JSON inputs
+    JSON_SAMPLE: '{"key": "value"}',
+    JSON_ARRAY_SAMPLE: '[{"id": 1}, {"id": 2}]',
+    SAMPLE_RECORDS: '[{ "id": "1", "name": "Example" }]',
+
+    // Authentication
+    API_KEY: 'your-api-key',
+    BEARER_TOKEN: 'your-bearer-token',
+    BASIC_USERNAME: 'username',
+    BASIC_PASSWORD: 'password',
+    API_KEY_SECRET: 'api-key-secret',
+    PASSWORD_SECRET: 'password-secret',
+    API_KEY_HEADER: 'X-API-Key',
+    SERVICE_USER: 'service-user',
+
+    // Connection
+    HOST: 'localhost',
+    PORT: '5432',
+    DATABASE_NAME: 'my_database',
+    TABLE_NAME: 'my_table',
+
+    // URLs
+    API_URL: 'https://api.example.com/v1',
+    WEBHOOK_URL: 'https://example.com/webhook',
+
+    // Headers
+    HEADER_NAME: 'X-Custom-Header',
+    HEADER_VALUE: 'header-value',
+
+    // Codes and identifiers
+    PIPELINE_NAME: 'My Pipeline',
+    PIPELINE_CODE: 'my-pipeline-code',
+    SECRET_CODE: 'my-secret',
+    CONNECTION_CODE: 'my-connection',
+
+    // Query inputs
+    SQL_QUERY: 'SELECT * FROM table WHERE status = $1',
+    GRAPHQL_QUERY: '{ products { id name } }',
+
+    // File paths
+    FILE_PATH: '/path/to/file.csv',
+    OUTPUT_DIRECTORY: '/output',
+
+    // Cron
+    CRON_EXPRESSION: '0 */6 * * *',
+} as const;
+
+/**
+ * Default sample data for testing
+ */
+export const DEFAULT_SAMPLE_DATA = `[
+  { "id": "1", "sku": "SKU-001", "name": "Product One", "price": 99.99 },
+  { "id": "2", "sku": "SKU-002", "name": "Product Two", "price": 149.99 }
+]`;
+
+/**
+ * Step test descriptions
+ */
+export const STEP_TEST_DESCRIPTIONS = {
+    EXTRACT: 'Extracts data using the configured adapter and returns sample records.',
+    TRANSFORM: 'Applies configured transformations to these records.',
+    VALIDATE: 'Runs validation rules on these records.',
+    LOAD: 'Loads records into the target system.',
+} as const;

package/dist/dashboard/constants/routes.ts

@@ -0,0 +1,12 @@
+import { DATAHUB_ROUTE_BASE, DATAHUB_API_BASE } from './navigation';
+
+export const ROUTES = {
+    PIPELINES: DATAHUB_ROUTE_BASE,
+    HOOKS: `${DATAHUB_API_BASE}/hooks`,
+    SETTINGS: `${DATAHUB_API_BASE}/settings`,
+    ADAPTERS: `${DATAHUB_API_BASE}/adapters`,
+    LOGS: `${DATAHUB_API_BASE}/logs`,
+    QUEUES: `${DATAHUB_API_BASE}/queues`,
+    SECRETS: `${DATAHUB_API_BASE}/secrets`,
+    CONNECTIONS: `${DATAHUB_API_BASE}/connections`,
+} as const;

package/dist/dashboard/constants/run-status.ts

@@ -0,0 +1 @@
+export { RUN_STATUS } from '../../shared/constants';

package/dist/dashboard/constants/sentinel-values.ts

@@ -0,0 +1,12 @@
+/**
+ * Sentinel values used for Select components that need to represent
+ * empty/unselected states. HTML select elements require non-empty values,
+ * so we use these sentinel strings to represent "no selection".
+ */
+export const SENTINEL_VALUES = {
+    /** Represents an empty/unmapped field - use when a field should be cleared */
+    EMPTY: '__empty__',
+    /** Represents no selection - use for optional select dropdowns */
+    NONE: '__none__',
+} as const;
+

package/dist/dashboard/constants/step-configs.ts

@@ -0,0 +1,9 @@
+/**
+ * Default values for route step branch configuration.
+ */
+export const ROUTE_BRANCH_DEFAULTS = {
+    /** Prefix for auto-generated branch names */
+    namePrefix: 'branch-',
+    /** Maximum number of branches allowed per route step */
+    maxBranches: 10,
+} as const;

package/dist/dashboard/constants/step-mappings.ts

@@ -0,0 +1,170 @@
+import type { StepType } from '../../shared/types';
+import type { VisualNodeCategory } from '../types/pipeline';
+import type { LucideIcon } from 'lucide-react';
+import type { StepConfig } from './steps';
+import { DEFAULT_STEP_CONFIGS } from './steps';
+import { resolveIconName } from '../utils/icon-resolver';
+
+export const NODE_CATEGORIES = {
+    TRIGGER: 'trigger',
+    SOURCE: 'source',
+    TRANSFORM: 'transform',
+    VALIDATE: 'validate',
+    CONDITION: 'condition',
+    ENRICH: 'enrich',
+    LOAD: 'load',
+    EXPORT: 'export',
+    FEED: 'feed',
+    SINK: 'sink',
+    FILTER: 'filter',
+    GATE: 'gate',
+} as const satisfies Record<string, VisualNodeCategory>;
+
+export const ADAPTER_TYPES = {
+    TRIGGER: 'TRIGGER',
+    EXTRACTOR: 'EXTRACTOR',
+    OPERATOR: 'OPERATOR',
+    VALIDATOR: 'VALIDATOR',
+    ENRICHER: 'ENRICHER',
+    ROUTER: 'ROUTER',
+    LOADER: 'LOADER',
+    EXPORTER: 'EXPORTER',
+    FEED: 'FEED',
+    SINK: 'SINK',
+} as const;
+
+// ---------------------------------------------------------------------------
+// Step mapping result type
+// ---------------------------------------------------------------------------
+
+export interface StepMappings {
+    stepTypeToCategory: Record<string, VisualNodeCategory>;
+    categoryToStepType: Record<string, StepType>;
+    categoryToAdapterType: Record<string, string>;
+    adapterTypeToNodeType: Record<string, string>;
+    adapterTypeToCategory: Record<string, string>;
+    categoryColors: Record<VisualNodeCategory, string>;
+}
+
+// ---------------------------------------------------------------------------
+// Dynamic builder: derives all maps from step config data
+// ---------------------------------------------------------------------------
+
+/**
+ * Maps backend adapter type to UI category label for adapter catalog grouping.
+ * This is the only map not derivable from step configs, so it stays hand-maintained.
+ */
+const ADAPTER_TYPE_CATEGORY_LABELS: Record<string, string> = {
+    EXTRACTOR: 'SOURCES',
+    OPERATOR: 'TRANSFORMS',
+    VALIDATOR: 'VALIDATION',
+    ENRICHER: 'TRANSFORMS',
+    ROUTER: 'ROUTING',
+    LOADER: 'DESTINATIONS',
+    EXPORTER: 'EXPORTS',
+    FEED: 'FEEDS',
+    SINK: 'SINKS',
+};
+
+/**
+ * Internal builder used by both the static fallback derivation and the public
+ * `buildStepMappings` function.
+ *
+ * `adapterTypeToCategory` (UI labels like SOURCES, TRANSFORMS) is not derivable from
+ * step configs alone, so it must be provided as a parameter.
+ */
+function buildStepMappingsInternal(
+    stepConfigs: Record<string, StepConfig>,
+    adapterTypeCategoryLabels: Record<string, string>,
+): StepMappings {
+    const stepTypeToCategory: Record<string, VisualNodeCategory> = {};
+    const categoryToStepType: Record<string, StepType> = {};
+    const categoryToAdapterType: Record<string, string> = { filter: 'OPERATOR' };
+    const adapterTypeToNodeType: Record<string, string> = {};
+    const categoryColors: Record<string, string> = {};
+
+    for (const config of Object.values(stepConfigs)) {
+        const stepType = config.type;
+        const category = config.nodeType as VisualNodeCategory;
+
+        // stepType -> category
+        stepTypeToCategory[stepType] = category;
+
+        // category -> stepType (first wins for shared categories)
+        if (!(category in categoryToStepType)) {
+            categoryToStepType[category] = stepType;
+        }
+
+        // category -> adapterType
+        if (config.adapterType) {
+            categoryToAdapterType[category] = config.adapterType;
+            // adapterType -> nodeType (first wins for shared adapter types like OPERATOR)
+            if (!(config.adapterType in adapterTypeToNodeType)) {
+                adapterTypeToNodeType[config.adapterType] = category;
+            }
+        }
+
+        // category -> color
+        categoryColors[category] = config.color;
+    }
+
+    // filter category shares transform's color
+    if (!categoryColors.filter && categoryColors.transform) {
+        categoryColors.filter = categoryColors.transform;
+    }
+
+    return {
+        stepTypeToCategory,
+        categoryToStepType,
+        categoryToAdapterType,
+        adapterTypeToNodeType,
+        adapterTypeToCategory: { ...adapterTypeCategoryLabels },
+        categoryColors: categoryColors as Record<VisualNodeCategory, string>,
+    };
+}
+
+/**
+ * Builds all step mapping tables from backend step config data.
+ *
+ * The `adapterType` field on each config drives `categoryToAdapterType` and `adapterTypeToNodeType`.
+ * The `nodeType` field (equal to the visual node category) drives `adapterTypeToNodeType`.
+ * The `category` field drives `stepTypeToCategory` and `categoryToStepType`.
+ */
+export function buildStepMappings(stepConfigs: Record<string, StepConfig>): StepMappings {
+    return buildStepMappingsInternal(stepConfigs, ADAPTER_TYPE_CATEGORY_LABELS);
+}
+
+// ---------------------------------------------------------------------------
+// Auto-derived fallback maps from DEFAULT_STEP_CONFIGS
+// ---------------------------------------------------------------------------
+
+const _derived = buildStepMappingsInternal(DEFAULT_STEP_CONFIGS, ADAPTER_TYPE_CATEGORY_LABELS);
+
+export const STEP_TYPE_TO_CATEGORY = _derived.stepTypeToCategory;
+export const CATEGORY_TO_STEP_TYPE = _derived.categoryToStepType;
+export const CATEGORY_TO_ADAPTER_TYPE = _derived.categoryToAdapterType;
+export const ADAPTER_TYPE_TO_NODE_TYPE = _derived.adapterTypeToNodeType;
+export const ADAPTER_TYPE_TO_CATEGORY = _derived.adapterTypeToCategory;
+export const CATEGORY_COLORS = _derived.categoryColors;
+
+/** Static fallback mappings used during loading before backend data arrives. */
+export const FALLBACK_STEP_MAPPINGS: StepMappings = _derived;
+
+// ---------------------------------------------------------------------------
+// Helper functions
+// ---------------------------------------------------------------------------
+
+export function mapStepTypeToCategory(stepType: string): VisualNodeCategory {
+    const type = String(stepType).toUpperCase();
+    return STEP_TYPE_TO_CATEGORY[type] ?? 'transform';
+}
+
+export function mapCategoryToStepType(category: string): StepType {
+    return CATEGORY_TO_STEP_TYPE[category] ?? 'TRANSFORM';
+}
+
+export function getStepTypeIcon(stepType: string): LucideIcon | undefined {
+    const type = String(stepType).toUpperCase();
+    const config = DEFAULT_STEP_CONFIGS[type as StepType];
+    return config ? resolveIconName(config.icon) : undefined;
+}

package/dist/dashboard/constants/steps.ts

@@ -0,0 +1,37 @@
+import type { StepType } from '../../shared/types';
+import { STEP_TYPE, SHARED_STEP_TYPE_CONFIGS } from '../../shared/constants';
+
+export { STEP_TYPE };
+
+export interface StepConfig {
+    readonly type: StepType;
+    readonly label: string;
+    readonly description: string;
+    readonly icon: string;
+    readonly color: string;
+    readonly bgColor: string;
+    readonly borderColor: string;
+    readonly inputs: number;
+    readonly outputs: number;
+    /** Backend adapter type for registry lookup (e.g. EXTRACTOR, OPERATOR). Null for step types without adapters. */
+    readonly adapterType: string | null;
+    /** Visual node type for the pipeline editor (e.g. source, transform, load). */
+    readonly nodeType: string;
+}
+
+/**
+ * Static fallback step configs used during loading before backend data is available.
+ * At runtime, prefer `useStepConfigs()` hook which returns backend-driven data.
+ * Also used by non-React code (visual-node-config, step-mappings) that cannot call hooks.
+ *
+ * Derived from the shared single source of truth (SHARED_STEP_TYPE_CONFIGS).
+ */
+export const DEFAULT_STEP_CONFIGS: Record<StepType, StepConfig> =
+    SHARED_STEP_TYPE_CONFIGS.reduce(
+        (acc, cfg) => {
+            acc[cfg.type] = cfg;
+            return acc;
+        },
+        {} as Record<StepType, StepConfig>,
+    );
+

package/dist/dashboard/constants/toast-messages.ts

@@ -0,0 +1,149 @@
+import { getErrorMessage } from '../../shared';
+
+/**
+ * Centralized toast message constants for the dashboard
+ *
+ * Follows naming convention:
+ * - Success messages: TOAST_<CATEGORY>_<ACTION>_SUCCESS
+ * - Error messages: TOAST_<CATEGORY>_<ACTION>_ERROR
+ * - Warning messages: TOAST_<CATEGORY>_<ACTION>_WARNING
+ */
+
+/**
+ * Pipeline-related toast messages
+ */
+export const TOAST_PIPELINE = {
+    RUN_STARTED: 'Run started',
+    RUN_START_ERROR: 'Failed to start run',
+    RECORD_RETRY_QUEUED: 'Record retry queued',
+    INVALID_JSON_PATCH: 'Invalid JSON patch',
+    SAVE_SUCCESS: 'Successfully saved pipeline',
+    SAVE_ERROR: 'Failed to save pipeline',
+    SUBMITTED_FOR_REVIEW: 'Submitted for review',
+    SUBMIT_ERROR: 'Submit failed',
+    APPROVED: 'Approved',
+    APPROVE_ERROR: 'Approve failed',
+    REJECTED: 'Rejected',
+    REJECT_ERROR: 'Reject failed',
+    PUBLISHED: 'Published',
+    PUBLISH_ERROR: 'Publish failed',
+    VALIDATION_FIX_REQUIRED: 'Fix validation issues before publishing',
+    ARCHIVED: 'Pipeline archived',
+    ARCHIVE_ERROR: 'Failed to archive pipeline',
+    RESTORED: 'Pipeline restored',
+    DELETED: 'Pipeline deleted',
+    DUPLICATED: 'Pipeline duplicated',
+    DRY_RUN_FAILED: 'Dry run failed',
+    HISTORY_LOAD_ERROR: 'Failed to load version history',
+    GATE_APPROVED: 'Gate approved, resuming pipeline',
+    GATE_APPROVE_ERROR: 'Failed to approve gate',
+    GATE_REJECTED: 'Gate rejected, pipeline cancelled',
+    GATE_REJECT_ERROR: 'Failed to reject gate',
+} as const;
+
+/**
+ * Connection-related toast messages
+ */
+export const TOAST_CONNECTION = {
+    SECRETS_LOAD_ERROR: 'Failed to load available secrets. Some features may be limited.',
+    TEST_SUCCESS: 'Connection successful',
+    TEST_FAILED: 'Connection failed',
+    SAVE_SUCCESS: 'Connection saved successfully',
+    SAVE_ERROR: 'Failed to save connection',
+    DELETE_SUCCESS: 'Connection deleted successfully',
+    DELETE_ERROR: 'Failed to delete connection',
+} as const;
+
+/**
+ * Adapter-related toast messages
+ */
+export const TOAST_ADAPTER = {
+    CONFIG_COPIED: 'Config copied to clipboard',
+    COPY_ERROR: 'Failed to copy',
+} as const;
+
+/**
+ * Hook-related toast messages
+ */
+export const TOAST_HOOK = {
+    SELECT_PIPELINE_FIRST: 'Please select a pipeline first',
+    TEST_SUCCESS: 'Hook test executed successfully',
+} as const;
+
+/**
+ * Log-related toast messages
+ */
+export const TOAST_LOG = {
+    EXPORT_SUCCESS: 'Logs exported successfully',
+    EXPORT_ERROR: 'Failed to export logs',
+} as const;
+
+/**
+ * File-related toast messages
+ */
+export const TOAST_FILE = {
+    UNSUPPORTED_TYPE: 'Unsupported file type',
+    EXCEL_REQUIRES_XLSX: 'Excel parsing requires xlsx library. Please use CSV or JSON.',
+    NO_DATA_FOUND: 'No data found in file',
+    PARSE_ERROR: 'Failed to parse file',
+    PARSE_SUCCESS: 'Parsed {count} records',
+    PARSED_ROWS_COLUMNS: 'Parsed {rows} rows with {columns} columns',
+    MISSING_REQUIRED: 'Missing required fields: {fields}',
+} as const;
+
+/**
+ * Wizard-related toast messages
+ */
+export const TOAST_WIZARD = {
+    NAME_REQUIRED: 'Please provide a name for the configuration',
+    IMPORT_NAME_REQUIRED: 'Please provide a name for the import configuration',
+    EXPORT_NAME_REQUIRED: 'Please provide a name for the export configuration',
+    URL_REQUIRED: 'Please enter a URL first',
+    TEMPLATE_SELECTED: 'Template applied',
+    IMPORT_CREATED: 'Import pipeline created',
+    EXPORT_CREATED: 'Export pipeline created',
+    CREATE_FAILED: 'Failed to create pipeline',
+} as const;
+
+/**
+ * Secret-related toast messages
+ */
+export const TOAST_SECRET = {
+    SAVE_SUCCESS: 'Secret saved successfully',
+    SAVE_ERROR: 'Failed to save secret',
+    DELETE_SUCCESS: 'Secret deleted successfully',
+    DELETE_ERROR: 'Failed to delete secret',
+} as const;
+
+/**
+ * Template-related toast messages
+ */
+export const TOAST_TEMPLATE = {
+    SAMPLE_COPIED: 'Sample data copied to clipboard',
+    SAMPLE_DOWNLOADED: 'Sample file downloaded',
+} as const;
+
+/**
+ * Settings-related toast messages
+ */
+export const TOAST_SETTINGS = {
+    VALIDATION_ERRORS: 'Please fix validation errors before saving',
+    SAVE_SUCCESS: 'Settings saved successfully',
+    SAVE_ERROR: 'Failed to save settings',
+} as const;
+
+/**
+ * Helper to format parsed records toast
+ */
+export const formatParsedRecords = (count: number): string => {
+    return TOAST_FILE.PARSE_SUCCESS.replace('{count}', String(count));
+};
+
+/**
+ * Helper to format error messages with details
+ */
+export const formatParseError = (error: unknown): string => {
+    const message = getErrorMessage(error);
+    return `${TOAST_FILE.PARSE_ERROR}: ${message}`;
+};
+

package/dist/dashboard/constants/triggers.ts

@@ -0,0 +1,5 @@
+import type { TriggerType } from '../../shared/types';
+import { TRIGGER_TYPE } from '../../shared/constants/enums';
+
+export type { TriggerType };
+export { TRIGGER_TYPE };