chkit 0.1.0-beta.10

package/dist/plugins.d.ts

@@ -0,0 +1,142 @@
+import type { ChxInlinePluginRegistration, ChxPluginRegistration, FlagDef, MigrationPlan, ParsedFlags, ResolvedChxConfig, SchemaDefinition } from '@chkit/core';
+import type { PluginRuntime } from './bin/plugin-runtime.js';
+import type { TableScope } from './bin/table-scope.js';
+export { defineFlags, parseFlags, typedFlags, MissingFlagValueError, UnknownFlagError, type FlagDef, type InferFlags, type ParsedFlags, } from '@chkit/core';
+export interface CommandDef {
+    name: string;
+    description: string;
+    flags: readonly FlagDef[];
+    run: (ctx: CommandRunContext) => Promise<void>;
+}
+export interface CommandRunContext {
+    command: string;
+    flags: ParsedFlags;
+    config: ResolvedChxConfig;
+    configPath: string;
+    dirs: {
+        outDir: string;
+        migrationsDir: string;
+        metaDir: string;
+    };
+    pluginRuntime: PluginRuntime;
+}
+export interface CommandExtension {
+    command: string | string[];
+    flags: readonly FlagDef[];
+}
+export interface ChxPluginManifest {
+    name: string;
+    apiVersion: 1;
+    version?: string;
+    compatibility?: {
+        cli?: {
+            minMajor?: number;
+            maxMajor?: number;
+        };
+    };
+}
+export interface ChxPluginHookContextBase {
+    command: string;
+    config: ResolvedChxConfig;
+    tableScope: TableScope;
+    flags: ParsedFlags;
+}
+export interface ChxOnConfigLoadedContext extends ChxPluginHookContextBase {
+    configPath: string;
+    options: Record<string, unknown>;
+}
+export interface ChxOnSchemaLoadedContext extends ChxPluginHookContextBase {
+    definitions: SchemaDefinition[];
+}
+export interface ChxOnPlanCreatedContext extends ChxPluginHookContextBase {
+    plan: MigrationPlan;
+}
+export interface ChxOnBeforeApplyContext extends ChxPluginHookContextBase {
+    migration: string;
+    sql: string;
+    statements: string[];
+}
+export interface ChxOnAfterApplyContext extends ChxPluginHookContextBase {
+    migration: string;
+    statements: string[];
+    appliedAt: string;
+}
+export interface ChxOnInitContext {
+    command: string;
+    isInteractive: boolean;
+    jsonMode: boolean;
+    options: Record<string, unknown>;
+}
+export interface ChxOnCompleteContext {
+    command: string;
+    isInteractive: boolean;
+    jsonMode: boolean;
+    exitCode: number;
+    options: Record<string, unknown>;
+}
+export interface ChxCheckFinding {
+    code: string;
+    message: string;
+    severity: 'info' | 'warn' | 'error';
+    metadata?: Record<string, unknown>;
+}
+export interface ChxOnCheckContext extends ChxPluginHookContextBase {
+    command: 'check';
+    configPath: string;
+    jsonMode: boolean;
+    options: Record<string, unknown>;
+}
+export interface ChxOnCheckResult {
+    plugin: string;
+    evaluated: boolean;
+    ok: boolean;
+    findings: ChxCheckFinding[];
+    metadata?: Record<string, unknown>;
+}
+export interface ChxPluginCommandContext {
+    pluginName: string;
+    config: ResolvedChxConfig;
+    configPath: string;
+    jsonMode: boolean;
+    args: string[];
+    flags: ParsedFlags;
+    options: Record<string, unknown>;
+    tableScope: TableScope;
+    print: (value: unknown) => void;
+}
+export interface ChxPluginCommand {
+    name: string;
+    description?: string;
+    flags?: readonly FlagDef[];
+    run: (context: ChxPluginCommandContext) => undefined | number | Promise<undefined | number>;
+}
+export interface ChxPluginHooks {
+    onInit?: (context: ChxOnInitContext) => void | Promise<void>;
+    onComplete?: (context: ChxOnCompleteContext) => void | Promise<void>;
+    onConfigLoaded?: (context: ChxOnConfigLoadedContext) => void | Promise<void>;
+    onSchemaLoaded?: (context: ChxOnSchemaLoadedContext) => SchemaDefinition[] | undefined | Promise<SchemaDefinition[] | undefined>;
+    onPlanCreated?: (context: ChxOnPlanCreatedContext) => MigrationPlan | undefined | Promise<MigrationPlan | undefined>;
+    onBeforeApply?: (context: ChxOnBeforeApplyContext) => undefined | {
+        statements?: string[];
+    } | Promise<undefined | {
+        statements?: string[];
+    }>;
+    onAfterApply?: (context: ChxOnAfterApplyContext) => void | Promise<void>;
+    onCheck?: (context: ChxOnCheckContext) => ChxOnCheckResult | undefined | Promise<ChxOnCheckResult | undefined>;
+    onCheckReport?: (context: {
+        result: ChxOnCheckResult;
+        print: (line: string) => void;
+    }) => void | Promise<void>;
+}
+export interface ChxPlugin {
+    manifest: ChxPluginManifest;
+    hooks?: ChxPluginHooks;
+    commands?: ChxPluginCommand[];
+    extendCommands?: CommandExtension[];
+}
+export declare function definePlugin(plugin: ChxPlugin): ChxPlugin;
+export declare function definePluginConfig<TOptions extends object = Record<string, unknown>>(registration: Omit<ChxInlinePluginRegistration<ChxPlugin, TOptions>, 'plugin'> & {
+    plugin: ChxPlugin;
+}): ChxInlinePluginRegistration<ChxPlugin, TOptions>;
+export declare function isInlinePluginRegistration(registration: ChxPluginRegistration): registration is ChxInlinePluginRegistration<ChxPlugin>;
+//# sourceMappingURL=plugins.d.ts.map

package/dist/plugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,2BAA2B,EAC3B,qBAAqB,EACrB,OAAO,EACP,aAAa,EACb,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,OAAO,EACL,WAAW,EACX,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,WAAW,GACjB,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,SAAS,OAAO,EAAE,CAAA;IACzB,GAAG,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAC/C;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,WAAW,CAAA;IAClB,MAAM,EAAE,iBAAiB,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;IAChE,aAAa,EAAE,aAAa,CAAA;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,KAAK,EAAE,SAAS,OAAO,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,CAAC,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE;QACd,GAAG,CAAC,EAAE;YACJ,QAAQ,CAAC,EAAE,MAAM,CAAA;YACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;SAClB,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,iBAAiB,CAAA;IACzB,UAAU,EAAE,UAAU,CAAA;IACtB,KAAK,EAAE,WAAW,CAAA;CACnB;AAED,MAAM,WAAW,wBAAyB,SAAQ,wBAAwB;IACxE,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,wBAAyB,SAAQ,wBAAwB;IACxE,WAAW,EAAE,gBAAgB,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,IAAI,EAAE,aAAa,CAAA;CACpB;AAED,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,MAAM,EAAE,CAAA;CACrB;AAED,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;IACtE,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,OAAO,CAAA;IACtB,QAAQ,EAAE,OAAO,CAAA;IACjB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,OAAO,CAAA;IACtB,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,iBAAkB,SAAQ,wBAAwB;IACjE,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,OAAO,CAAA;IAClB,EAAE,EAAE,OAAO,CAAA;IACX,QAAQ,EAAE,eAAe,EAAE,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,iBAAiB,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,KAAK,EAAE,WAAW,CAAA;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;IACtB,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,SAAS,OAAO,EAAE,CAAA;IAC1B,GAAG,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC,CAAA;CAC5F;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5D,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpE,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,wBAAwB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5E,cAAc,CAAC,EAAE,CACf,OAAO,EAAE,wBAAwB,KAC9B,gBAAgB,EAAE,GAAG,SAAS,GAAG,OAAO,CAAC,gBAAgB,EAAE,GAAG,SAAS,CAAC,CAAA;IAC7E,aAAa,CAAC,EAAE,CACd,OAAO,EAAE,uBAAuB,KAC7B,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAA;IACnE,aAAa,CAAC,EAAE,CACd,OAAO,EAAE,uBAAuB,KAE9B,SAAS,GACT;QAAE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACzB,OAAO,CAAC,SAAS,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAA;IAClD,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACxE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,gBAAgB,GAAG,SAAS,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAA;IAC9G,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE;QACxB,MAAM,EAAE,gBAAgB,CAAA;QACxB,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;KAC9B,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,KAAK,CAAC,EAAE,cAAc,CAAA;IACtB,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC7B,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAA;CACpC;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAEzD;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClF,YAAY,EAAE,IAAI,CAAC,2BAA2B,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,GAAG;IAC/E,MAAM,EAAE,SAAS,CAAA;CAClB,GACA,2BAA2B,CAAC,SAAS,EAAE,QAAQ,CAAC,CAElD;AAED,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,qBAAqB,GAClC,YAAY,IAAI,2BAA2B,CAAC,SAAS,CAAC,CAExD"}

package/dist/plugins.js

@@ -0,0 +1,11 @@
+export { defineFlags, parseFlags, typedFlags, MissingFlagValueError, UnknownFlagError, } from '@chkit/core';
+export function definePlugin(plugin) {
+    return plugin;
+}
+export function definePluginConfig(registration) {
+    return registration;
+}
+export function isInlinePluginRegistration(registration) {
+    return typeof registration === 'object' && registration !== null && 'plugin' in registration;
+}
+//# sourceMappingURL=plugins.js.map

package/dist/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.js","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,WAAW,EACX,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,gBAAgB,GAIjB,MAAM,aAAa,CAAA;AA0JpB,MAAM,UAAU,YAAY,CAAC,MAAiB;IAC5C,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,YAEC;IAED,OAAO,YAAY,CAAA;AACrB,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,YAAmC;IAEnC,OAAO,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,IAAI,QAAQ,IAAI,YAAY,CAAA;AAC9F,CAAC"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "chkit",
+  "version": "0.1.0-beta.10",
+  "homepage": "https://chkit.obsessiondb.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/obsessiondb/chkit.git",
+    "directory": "packages/cli"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "chkit": "./dist/bin/chkit.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "bun run src/bin/chkit.ts",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "biome lint src",
+    "test": "bun test src --concurrent --timeout 15000",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "@chkit/clickhouse": "0.1.0-beta.10",
+    "@chkit/codegen": "0.1.0-beta.10",
+    "@chkit/core": "0.1.0-beta.10",
+    "fast-glob": "^3.3.2"
+  }
+}