@stackwright-pro/cli-data-explorer 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,157 @@
+/**
+ * CLI plugin types for the Data Explorer plugin.
+ */
+/**
+ * Plugin registrar function signature.
+ * The OSS CLI calls this to register plugin commands.
+ */
+interface PluginRegistrar {
+    (program: Command): void;
+}
+/**
+ * Placeholder import for Commander - actual type used at runtime.
+ * This is a simplified type definition for the CLI plugin interface.
+ */
+interface Command {
+    command(name?: string): Command;
+    description(text: string): Command;
+    option(flags: string, description?: string, defaultValue?: unknown): Command;
+    requiredOption(flags: string, description?: string): Command;
+    action(handler: (options: Record<string, unknown>, cmd?: Command) => void | Promise<void>): Command;
+    hook(event: string, handler: (thisCommand: Command) => void | Promise<void>): Command;
+    addHelpText(after: string, text: string): Command;
+}
+/**
+ * Represents a single entity (schema) discovered from OpenAPI or Zod schemas.
+ */
+interface EntityInfo {
+    /** Display name, e.g. "Equipment" */
+    name: string;
+    /** URL-safe slug, e.g. "equipment" */
+    slug: string;
+    /** Primary endpoint path, e.g. "/equipment" */
+    endpoint: string;
+    /** Number of fields in this entity */
+    fieldCount: number;
+    /** Detailed field information */
+    fields: FieldInfo[];
+    /** Source file containing this schema */
+    sourceFile: string;
+}
+/**
+ * Represents a single field within an entity.
+ */
+interface FieldInfo {
+    /** Field name, e.g. "status" */
+    name: string;
+    /** Type as string, e.g. "string", "enum" */
+    type: string;
+    /** Whether this field is required */
+    required: boolean;
+    /** Optional description from schema */
+    description?: string;
+}
+/**
+ * Result of listing entities.
+ */
+interface ListEntitiesResult {
+    success: boolean;
+    entities: EntityInfo[];
+    errors?: string[];
+}
+/**
+ * Options for listing entities.
+ */
+interface ListEntitiesOptions {
+    /** Path to OpenAPI spec file */
+    specPath?: string;
+    /** Path to compiled Zod schema module (e.g., ./dist/schemas.js) */
+    schemaPath?: string;
+    /** Project root for resolving paths */
+    projectRoot?: string;
+}
+/**
+ * Endpoint filter configuration.
+ */
+interface EndpointFilter {
+    /** Endpoints to include */
+    include: string[];
+    /** Patterns to exclude */
+    exclude: string[];
+}
+/**
+ * Result of generating a filter.
+ */
+interface GenerateFilterResult {
+    success: boolean;
+    filter: EndpointFilter;
+    warnings?: string[];
+    outputPath?: string;
+}
+/**
+ * Options for generating a filter.
+ */
+interface GenerateFilterOptions {
+    /** Path to OpenAPI spec file */
+    specPath?: string;
+    /** Path to compiled Zod schema module */
+    schemaPath?: string;
+    /** Entity slugs to include */
+    selectedEntities: string[];
+    /** Glob patterns to exclude */
+    excludePatterns?: string[];
+    /** Path to write stackwright.yml */
+    outputPath?: string;
+    /** Project root */
+    projectRoot?: string;
+}
+
+/**
+ * Discover available entities from Zod schemas or OpenAPI spec.
+ *
+ * Priority:
+ * 1. schemaPath (explicit Zod schemas)
+ * 2. specPath (explicit OpenAPI spec)
+ * 3. Auto-detect (look for compiled schemas or OpenAPI spec)
+ *
+ * Pure function: same inputs → same outputs, no side effects.
+ */
+declare function listEntities(options?: ListEntitiesOptions): ListEntitiesResult;
+
+/**
+ * Generates endpoint filter configuration from selected entities.
+ *
+ * Pure function: same inputs → same outputs.
+ *
+ * Logic:
+ * 1. For each selected entity, include: /entity and /entity/{id}
+ * 2. Apply default exclusions (admin, reports, delete)
+ * 3. Return filter config
+ */
+declare function generateFilter(options: GenerateFilterOptions): GenerateFilterResult;
+/**
+ * Discover entities from an OpenAPI spec and generate filter.
+ * Single function for the common workflow.
+ */
+declare function discoverAndFilter(options: {
+    specPath: string;
+    selectedEntities: string[];
+    excludePatterns?: string[];
+    outputPath?: string;
+    projectRoot?: string;
+}): GenerateFilterResult;
+
+/**
+ * CLI plugin registration.
+ * Called by the OSS CLI when this package is installed.
+ *
+ * Usage in OSS CLI:
+ * ```ts
+ * // In cli-plugin-loader.ts
+ * import { registerCommands } from '@stackwright-pro/cli-data-explorer';
+ * registerCommands(program);
+ * ```
+ */
+declare const registerCommands: PluginRegistrar;
+
+export { type EndpointFilter, type EntityInfo, type FieldInfo, type GenerateFilterOptions, type GenerateFilterResult, type ListEntitiesOptions, type ListEntitiesResult, registerCommands as default, discoverAndFilter, generateFilter, listEntities, registerCommands };

package/dist/index.d.ts

@@ -0,0 +1,157 @@
+/**
+ * CLI plugin types for the Data Explorer plugin.
+ */
+/**
+ * Plugin registrar function signature.
+ * The OSS CLI calls this to register plugin commands.
+ */
+interface PluginRegistrar {
+    (program: Command): void;
+}
+/**
+ * Placeholder import for Commander - actual type used at runtime.
+ * This is a simplified type definition for the CLI plugin interface.
+ */
+interface Command {
+    command(name?: string): Command;
+    description(text: string): Command;
+    option(flags: string, description?: string, defaultValue?: unknown): Command;
+    requiredOption(flags: string, description?: string): Command;
+    action(handler: (options: Record<string, unknown>, cmd?: Command) => void | Promise<void>): Command;
+    hook(event: string, handler: (thisCommand: Command) => void | Promise<void>): Command;
+    addHelpText(after: string, text: string): Command;
+}
+/**
+ * Represents a single entity (schema) discovered from OpenAPI or Zod schemas.
+ */
+interface EntityInfo {
+    /** Display name, e.g. "Equipment" */
+    name: string;
+    /** URL-safe slug, e.g. "equipment" */
+    slug: string;
+    /** Primary endpoint path, e.g. "/equipment" */
+    endpoint: string;
+    /** Number of fields in this entity */
+    fieldCount: number;
+    /** Detailed field information */
+    fields: FieldInfo[];
+    /** Source file containing this schema */
+    sourceFile: string;
+}
+/**
+ * Represents a single field within an entity.
+ */
+interface FieldInfo {
+    /** Field name, e.g. "status" */
+    name: string;
+    /** Type as string, e.g. "string", "enum" */
+    type: string;
+    /** Whether this field is required */
+    required: boolean;
+    /** Optional description from schema */
+    description?: string;
+}
+/**
+ * Result of listing entities.
+ */
+interface ListEntitiesResult {
+    success: boolean;
+    entities: EntityInfo[];
+    errors?: string[];
+}
+/**
+ * Options for listing entities.
+ */
+interface ListEntitiesOptions {
+    /** Path to OpenAPI spec file */
+    specPath?: string;
+    /** Path to compiled Zod schema module (e.g., ./dist/schemas.js) */
+    schemaPath?: string;
+    /** Project root for resolving paths */
+    projectRoot?: string;
+}
+/**
+ * Endpoint filter configuration.
+ */
+interface EndpointFilter {
+    /** Endpoints to include */
+    include: string[];
+    /** Patterns to exclude */
+    exclude: string[];
+}
+/**
+ * Result of generating a filter.
+ */
+interface GenerateFilterResult {
+    success: boolean;
+    filter: EndpointFilter;
+    warnings?: string[];
+    outputPath?: string;
+}
+/**
+ * Options for generating a filter.
+ */
+interface GenerateFilterOptions {
+    /** Path to OpenAPI spec file */
+    specPath?: string;
+    /** Path to compiled Zod schema module */
+    schemaPath?: string;
+    /** Entity slugs to include */
+    selectedEntities: string[];
+    /** Glob patterns to exclude */
+    excludePatterns?: string[];
+    /** Path to write stackwright.yml */
+    outputPath?: string;
+    /** Project root */
+    projectRoot?: string;
+}
+
+/**
+ * Discover available entities from Zod schemas or OpenAPI spec.
+ *
+ * Priority:
+ * 1. schemaPath (explicit Zod schemas)
+ * 2. specPath (explicit OpenAPI spec)
+ * 3. Auto-detect (look for compiled schemas or OpenAPI spec)
+ *
+ * Pure function: same inputs → same outputs, no side effects.
+ */
+declare function listEntities(options?: ListEntitiesOptions): ListEntitiesResult;
+
+/**
+ * Generates endpoint filter configuration from selected entities.
+ *
+ * Pure function: same inputs → same outputs.
+ *
+ * Logic:
+ * 1. For each selected entity, include: /entity and /entity/{id}
+ * 2. Apply default exclusions (admin, reports, delete)
+ * 3. Return filter config
+ */
+declare function generateFilter(options: GenerateFilterOptions): GenerateFilterResult;
+/**
+ * Discover entities from an OpenAPI spec and generate filter.
+ * Single function for the common workflow.
+ */
+declare function discoverAndFilter(options: {
+    specPath: string;
+    selectedEntities: string[];
+    excludePatterns?: string[];
+    outputPath?: string;
+    projectRoot?: string;
+}): GenerateFilterResult;
+
+/**
+ * CLI plugin registration.
+ * Called by the OSS CLI when this package is installed.
+ *
+ * Usage in OSS CLI:
+ * ```ts
+ * // In cli-plugin-loader.ts
+ * import { registerCommands } from '@stackwright-pro/cli-data-explorer';
+ * registerCommands(program);
+ * ```
+ */
+declare const registerCommands: PluginRegistrar;
+
+export { type EndpointFilter, type EntityInfo, type FieldInfo, type GenerateFilterOptions, type GenerateFilterResult, type ListEntitiesOptions, type ListEntitiesResult, registerCommands as default, discoverAndFilter, generateFilter, listEntities, registerCommands };