@messagevisor/core 0.0.1 → 0.1.0

package/lib/promoter/index.d.ts

@@ -0,0 +1,65 @@
+import type { ProjectConfig } from "../config";
+import type { Datasource } from "../datasource";
+type EntityType = "locale" | "attribute" | "segment" | "target" | "message" | "test";
+type ConflictPolicy = "source" | "destination" | "fail";
+type PromotionAuditFormat = "json" | "markdown";
+interface PromotionConflict {
+    type: EntityType;
+    key: string;
+    path: string;
+    source: unknown;
+    destination: unknown;
+}
+export interface PromoteProjectSetsOptions {
+    from?: string;
+    to?: string;
+    target?: string | string[];
+    locale?: string | string[];
+    includeMessages?: string | string[];
+    excludeMessages?: string | string[];
+    excludeOverrides?: boolean;
+    conflicts?: ConflictPolicy;
+    allowEmpty?: boolean;
+    apply?: boolean;
+    audit?: boolean | PromotionAuditFormat;
+    showUnchanged?: boolean;
+}
+export interface PromoteProjectSetsResult {
+    from: string;
+    to: string;
+    apply: boolean;
+    duration: number;
+    filters: {
+        targets: string[];
+        locales: string[];
+        includeMessages: string[];
+        excludeMessages: string[];
+        excludeOverrides: boolean;
+        conflicts: ConflictPolicy;
+    };
+    dependencies: {
+        locales: number;
+        attributes: number;
+        segments: number;
+        targets: number;
+        messages: number;
+        tests: number;
+    };
+    files: {
+        created: string[];
+        updated: string[];
+        unchanged: string[];
+    };
+    conflicts: PromotionConflict[];
+    auditFilePath?: string;
+}
+export declare function promoteProjectSets(projectConfig: ProjectConfig, datasource: Datasource, options: PromoteProjectSetsOptions): Promise<PromoteProjectSetsResult>;
+export declare const promotePlugin: {
+    command: string;
+    handler: ({ projectConfig, datasource, parsed }: any) => Promise<boolean>;
+    examples: {
+        command: string;
+        description: string;
+    }[];
+};
+export {};