@porulle/plugin-channel-connector 0.10.8 → 0.11.0

package/dist/service.d.ts

@@ -1,6 +1,8 @@
-import type { Actor, ChannelConnector, ChannelOrderSlice, PluginDb, PluginResult, PluginTxFn } from "@porulle/core";
+import type { Actor, ChannelConnector, ChannelOrderSlice, ChannelPushCatalogItem, PluginDb, PluginResult, PluginTxFn } from "@porulle/core";
+import type { FieldPath } from "@porulle/core";
 import type { JobsAdapter } from "@porulle/core";
 import { type ChannelOrderExport, type ChannelRefundRequest, type ConnectedStore } from "./schema.js";
+import { type CatalogFieldMapping } from "./catalog-field-mapping.js";
 export type ExportState = ChannelOrderExport["state"];
 export interface ReconcileReport extends Record<string, unknown> {
     imported: number;
@@ -8,11 +10,37 @@ export interface ReconcileReport extends Record<string, unknown> {
     archived: number;
     inventoryUpdated: number;
     driftAlert: boolean;
+    skipped?: CatalogFieldSkip[];
+    conflicts?: CatalogFieldConflict[];
+    warnings?: string[];
+}
+export interface CatalogFieldConflict {
+    entityId: string;
+    storeId: string;
+    fieldPath: FieldPath;
+    localValueSummary: string;
+    remoteValueSummary: string;
+}
+export interface CatalogFieldSkip {
+    entityId: string;
+    fieldPath: FieldPath;
+}
+export type CatalogPushSkipReason = "no_mapping" | "held" | "entity_not_active" | "unmapped_entity";
+export interface CatalogPushFieldSkip {
+    entityId: string;
+    fieldPath: FieldPath;
+    reason: CatalogPushSkipReason;
 }
 export type PublicConnectedStore = Omit<ConnectedStore, "credentials" | "webhookSecret"> & {
     credentials: "[REDACTED]";
     webhookSecret: "[REDACTED]";
 };
+export interface CatalogWriteSettings {
+    enabled: boolean;
+    overrides: CatalogFieldMapping;
+    merged: CatalogFieldMapping;
+    warnings?: string[];
+}
 export interface ChannelComplianceData {
     customer: {
         id?: string;
@@ -47,6 +75,32 @@ export interface ChannelStockLine {
     title?: string;
     quantity: number;
 }
+interface BackfillCounts {
+    entitiesTouched: number;
+    attributesCreated: number;
+    mediaImported: number;
+    variantsGivenOptionValues: number;
+}
+export interface BackfillCatalogReport extends BackfillCounts, Record<string, unknown> {
+    cursor: string | null;
+    complete: boolean;
+    skipped?: CatalogFieldSkip[];
+    conflicts?: CatalogFieldConflict[];
+    warnings?: string[];
+}
+export interface BackfillCatalogOptions {
+    dryRun?: boolean;
+    resume?: boolean;
+    maxPages?: number;
+}
+export interface BuildCatalogPushItemsOptions {
+    recordRevision?: boolean;
+}
+export interface BuildCatalogPushItemsResult {
+    items: ChannelPushCatalogItem[];
+    skipped: CatalogPushFieldSkip[];
+    warnings: string[];
+}
 export declare function canExportTransition(from: ExportState, to: ExportState): boolean;
 export declare class ChannelConnectorService {
     private readonly db;
@@ -58,9 +112,27 @@ export declare class ChannelConnectorService {
     constructor(db: PluginDb, services: Record<string, unknown>, options?: ChannelConnectorPluginOptions, transaction?: PluginTxFn);
     getConnector(providerId: string): ChannelConnector | undefined;
     private get catalog();
+    private get media();
+    private get pricing();
+    private filterOwnedFields;
+    private filterOwnedFieldsAtPaths;
+    private filterConflictingFields;
+    private remoteFieldValue;
+    private localFieldValue;
+    private detectSharedConflicts;
+    private setCatalogAttributes;
+    private upsertOptionAxes;
+    private upsertVariants;
+    private applyTaxonomy;
+    private applyMedia;
     private getStoreRecord;
     getStoreByDomain(shopDomain: string): Promise<ConnectedStore | undefined>;
     getStoresByDomain(shopDomain: string): Promise<ConnectedStore[]>;
+    resolveCatalogFieldMapping(store: Pick<ConnectedStore, "provider" | "catalogFieldMapping">, filterableCustomFields?: ReadonlySet<string> | Readonly<Record<string, boolean>>, warnings?: string[]): CatalogFieldMapping;
+    buildCatalogPushItems(orgId: string, storeId: string, entityIds: string[], options?: BuildCatalogPushItemsOptions): Promise<PluginResult<BuildCatalogPushItemsResult>>;
+    getCatalogWriteSettings(orgId: string, storeId: string): Promise<PluginResult<CatalogWriteSettings>>;
+    updateCatalogWriteEnabled(orgId: string, storeId: string, enabled: boolean): Promise<PluginResult<CatalogWriteSettings>>;
+    updateCatalogFieldMapping(orgId: string, storeId: string, mapping: unknown): Promise<PluginResult<CatalogWriteSettings>>;
     connectStore(orgId: string, input: {
         provider: string;
         credentials: Record<string, unknown>;
@@ -76,7 +148,14 @@ export declare class ChannelConnectorService {
     importCatalog(orgId: string, storeId: string, actor: Actor): Promise<PluginResult<{
         imported: number;
         cursor: string | null;
+        skipped?: CatalogFieldSkip[];
+        conflicts?: CatalogFieldConflict[];
+        warnings?: string[];
     }>>;
+    private promoteLegacyAttributes;
+    private saveBackfillState;
+    backfillCatalog(orgId: string, storeId: string, actor: Actor, options?: BackfillCatalogOptions): Promise<PluginResult<BackfillCatalogReport>>;
+    private estimateCatalogItems;
     private convergeCatalogItems;
     reconcile(orgId: string, storeId: string, actor: Actor): Promise<PluginResult<ReconcileReport>>;
     getReconcileStatus(orgId: string, storeId: string): Promise<PluginResult<{
@@ -130,3 +209,4 @@ export declare class ChannelConnectorService {
     retryExport(orgId: string, exportId: string, changedBy: string): Promise<PluginResult<ChannelOrderExport>>;
     abandonExport(orgId: string, exportId: string, changedBy: string, reason?: string): Promise<PluginResult<ChannelOrderExport>>;
 }
+export {};