@revoengine/cli 1.0.10 → 1.0.11

package/dist/src/resource-syncs/database-view-sync.d.ts

@@ -0,0 +1,124 @@
+import type { RevoClient } from '../client.ts';
+export declare const DATABASE_VIEWS_DIRECTORY = "DatabaseViews";
+export declare const DATABASE_VIEW_MANIFEST_FILE = "database-view.json";
+export type DatabaseViewSourceColumn = {
+    stableKey: string;
+    name: string;
+    type: string;
+    isArray: boolean;
+};
+export type DatabaseViewSource = {
+    databaseStableKey: string;
+    name: string;
+    columns: DatabaseViewSourceColumn[];
+};
+export type DatabaseViewRawSqlSource = {
+    databaseStableKey: string;
+    name: string;
+};
+export type DatabaseViewOutputField = {
+    name: string;
+    type: string;
+    isArray: boolean;
+};
+export type DatabaseViewIndex = {
+    columns: string[];
+    unique?: boolean;
+};
+type DatabaseViewManifestBase = {
+    kind: 'database-view';
+    stableKey: string;
+    name: string;
+    category?: string | null;
+    description?: string;
+    metadata: Record<string, unknown>;
+    type: 'VIEW' | 'MATERIALIZED_VIEW';
+    sources: DatabaseViewSource[] | DatabaseViewRawSqlSource[];
+    output: DatabaseViewOutputField[];
+    uniqueKey?: string[];
+    indexes?: DatabaseViewIndex[];
+};
+export type StructuredDatabaseViewManifest = DatabaseViewManifestBase & {
+    definitionMode: 'STRUCTURED';
+    request: Record<string, unknown>;
+    sources: DatabaseViewSource[];
+};
+export type RawSqlDatabaseViewManifest = DatabaseViewManifestBase & {
+    definitionMode: 'RAW_SQL';
+    rawQuery: string;
+    sources: DatabaseViewRawSqlSource[];
+};
+export type DatabaseViewManifest = StructuredDatabaseViewManifest | RawSqlDatabaseViewManifest;
+export type DatabaseViewPullSkip = {
+    stableKey?: string;
+    name: string;
+    reason: string;
+};
+export type DatabaseViewPullResult = {
+    pulled: Array<{
+        manifest: DatabaseViewManifest;
+        targetPath: string;
+    }>;
+    skipped: DatabaseViewPullSkip[];
+};
+export type DatabaseViewPlanStatus = 'clean' | 'create' | 'safe-update' | 'remote-changed' | 'conflict' | 'missing-lock' | 'orphan' | 'collision' | 'skipped';
+export type DatabaseViewPlanItem = {
+    status: DatabaseViewPlanStatus;
+    stableKey?: string;
+    name: string;
+    reason?: string;
+    changedFields?: string[];
+    risks?: string[];
+    scheduleDependencies?: string[];
+    desiredHash?: string;
+    currentHash?: string;
+    baselineHash?: string;
+};
+export type DatabaseViewsPlan = {
+    resourceType: 'database-view';
+    env: string;
+    counts: Record<DatabaseViewPlanStatus, number>;
+    warnings: string[];
+    blockers: string[];
+    globalBlockers: string[];
+    exclusions: string[];
+    items: DatabaseViewPlanItem[];
+};
+export type DatabaseViewPushResult = {
+    stableKey: string;
+    action: 'create' | 'update' | 'reconcile' | 'skipped';
+    status: 'deployed' | 'skipped' | 'failed' | 'write-unverified';
+    targetPath: string;
+    reason?: string;
+    error?: string;
+    accessPolicyRequired?: boolean;
+};
+export declare function hashPortableDatabaseView(manifest: DatabaseViewManifest): string;
+export declare function hashDatabaseViewManifest(manifest: DatabaseViewManifest): string;
+export declare function buildDatabaseViewsPlan(input: {
+    client: RevoClient;
+    cwd: string;
+    envName: string;
+    stableKeyName: string;
+}): Promise<DatabaseViewsPlan>;
+export declare function pushDatabaseViews(input: {
+    client: RevoClient;
+    cwd: string;
+    envName: string;
+    stableKeyName: string;
+    stableKey?: string;
+    force?: boolean;
+    allowMaterializedWrites?: boolean;
+}): Promise<{
+    plan: DatabaseViewsPlan;
+    results: DatabaseViewPushResult[];
+}>;
+export declare function pullDatabaseViewsToWorkspace(input: {
+    client: RevoClient;
+    cwd: string;
+    envName: string;
+    stableKeyName: string;
+    force?: boolean;
+    strict?: boolean;
+}): Promise<DatabaseViewPullResult>;
+export {};