@commercetools/sync-actions/dist/declarations/utils/types.d.ts

Build API update actions for the commercetools platform.

import type { Delta as DiffDelta } from 'jsondiffpatch/dist/jsondiffpatch.cjs';
export * from '@commercetools/platform-sdk';
export type Delta = DiffDelta | undefined;
export type SyncActionConfig = {
    shouldOmitEmptyString?: boolean;
    shouldUnsetOmittedProperties?: boolean;
    shouldPreventUnsettingRequiredFields?: boolean;
    sameForAllAttributeNames?: unknown[];
    enableDiscounted?: boolean;
    withHints?: boolean;
    [key: string]: unknown;
};
export type SyncAction<R extends object | undefined, S extends UpdateAction | unknown, T extends object = SyncActionConfig> = {
    buildActions: (now: DeepPartial<R>, before: DeepPartial<R>, config?: T) => Array<S>;
};
export type DeepPartial<T> = T extends object ? {
    [P in keyof T]?: DeepPartial<T[P]>;
} : T;
export type UpdateAction = {
    action: string | never;
    key?: string;
    actionKey?: string;
    roles?: Array<unknown>;
    value?: string;
};
export type ActionGroup = {
    type: string;
    group: 'ignore' | 'allow' | string;
};
export type MapActionGroup = (type: string, cb: () => Array<UpdateAction>) => Array<UpdateAction>;
export type MapAction<T> = (mapActionGroup: MapActionGroup, syncActionConfig?: SyncActionConfig) => (diff: Delta, newObj: T, oldObj: T, config?: SyncActionConfig) => Array<UpdateAction>;