@commercetools/sync-actions 7.3.1 → 8.0.0-alpha.1

package/dist/declarations/utils/copy-empty-array-props.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @function copyEmptyArrayProps
+ * @description Create new key with empty array value on `newobj` for the arrays exist on `oldObj` and doesnt exist on `newobj`
+ * One use case is to easily compare two object without generating this error `Cannot read property '0' of undefined`
+ * @param {Object} oldObj
+ * @param {Object} newObj
+ * @returns {Array} Ordered Array [oldObj, newObj]
+ */
+export default function copyEmptyArrayProps(oldObj?: {}, newObj?: {}): {}[];

package/dist/declarations/utils/create-build-actions.d.ts

@@ -0,0 +1,4 @@
+import { Delta, SyncActionConfig, UpdateAction } from './types';
+type Preprocessor<T> = (before: T, now: T) => Array<T>;
+export default function createBuildActions<S extends object, T extends UpdateAction>(differ: (processedBefore: S, processedNow: S) => Delta, doMapActions: (diffed: Delta, processedNow: S, processedBefore: S, options: SyncActionConfig) => Array<T>, onBeforeDiff?: Preprocessor<S>, buildActionsConfig?: SyncActionConfig): (now: S, before: S, options?: SyncActionConfig) => T[];
+export {};

package/dist/declarations/utils/create-build-array-actions.d.ts

@@ -0,0 +1,15 @@
+import { Delta, UpdateAction } from './types';
+export declare const ADD_ACTIONS = "create";
+export declare const REMOVE_ACTIONS = "remove";
+export declare const CHANGE_ACTIONS = "change";
+/**
+ * Generate + configure a function to build actions for nested objects
+ * @param  {string} key    key of the attribute containing the array of
+ *   nested objects
+ * @param  {object} config configuration object that can contain the keys
+ *   [ADD_ACTIONS, REMOVE_ACTIONS, CHANGE_ACTIONS], each of
+ *   which is a function. The function should accept the old + new arrays and
+ *   return an action object.
+ * @return {Array}        The generated array of actions
+ */
+export default function createBuildArrayActions(key: string, config: object): <S, T extends UpdateAction>(diff: Delta, oldObj: S, newObj: S) => T[];

package/dist/declarations/utils/create-map-action-group.d.ts

@@ -0,0 +1,2 @@
+import { ActionGroup, UpdateAction } from './types';
+export default function createMapActionGroup(actionGroups?: Array<ActionGroup>): (type: string, fn: () => Array<UpdateAction>) => UpdateAction[];

package/dist/declarations/utils/diffpatcher.d.ts

@@ -0,0 +1,11 @@
+import { Delta } from './types';
+type U = {
+    id: string;
+    name: string;
+    url: string;
+};
+export declare function objectHash<O extends U, I extends string | number>(obj: O, index: I): string;
+export declare function diff<T>(oldObj: T, newObj: T): Delta;
+export declare function patch<T>(obj: T, delta: Delta): any;
+export declare function getDeltaValue<T extends object = object>(arr: Array<number> | unknown, originalObject?: T): T;
+export {};

package/dist/declarations/utils/extract-matching-pairs.d.ts

@@ -0,0 +1,4 @@
+export default function extractMatchingPairs<T extends object>(hashMap: object, key: string, before: T, now: T): {
+    oldObj: T;
+    newObj: T;
+};

package/dist/declarations/utils/find-matching-pairs.d.ts

@@ -0,0 +1,2 @@
+import { Delta } from './types';
+export default function findMatchingPairs<T extends object>(diff: Delta, before?: Array<T>, now?: Array<T>, identifier?: string): T;

package/dist/declarations/utils/remove-typename.d.ts

@@ -0,0 +1,3 @@
+export default function removeTypename(obj: object & {
+    __typename?: string;
+}): {};

package/dist/declarations/utils/types.d.ts

@@ -0,0 +1,31 @@
+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>;

package/dist/declarations/zones/zones-actions.d.ts

@@ -0,0 +1,7 @@
+import { Delta, SyncActionConfig, UpdateAction, Zone } from '../utils/types';
+export declare const baseActionsList: Array<UpdateAction>;
+export declare function actionsMapBase(diff: Delta, oldObj: Zone, newObj: Zone, config?: SyncActionConfig): {
+    [x: string]: any;
+    action: string;
+}[];
+export declare function actionsMapLocations(diff: Delta, oldObj: Zone, newObj: Zone): UpdateAction[];

package/dist/declarations/zones/zones.d.ts

@@ -0,0 +1,4 @@
+import type { SyncAction, ActionGroup, SyncActionConfig, Zone, ZoneUpdateAction } from '../utils/types';
+export declare const actionGroups: string[];
+declare const _default: (actionGroupList?: Array<ActionGroup>, syncActionConfig?: SyncActionConfig) => SyncAction<Zone, ZoneUpdateAction>;
+export default _default;

package/package.json

@@ -1,43 +1,38 @@
 {
+  "name": "@commercetools/sync-actions",
+  "version": "8.0.0-alpha.1",
   "publishConfig": {
     "access": "public"
   },
   "engines": {
     "node": ">=18"
   },
-  "name": "@commercetools/sync-actions",
-  "version": "7.3.1",
   "description": "Build API update actions for the commercetools platform.",
-  "keywords": [
-    "commercetools",
-    "sync",
-    "actions"
-  ],
-  "homepage": "https://commercetools.github.io/nodejs/",
-  "bugs": "https://github.com/commercetools/nodejs/issues",
-  "license": "MIT",
-  "author": "Nicola Molinari <nicola.molinari@commercetools.com> (https://github.com/emmenko)",
+  "keywords": ["commercetools", "sync", "actions"],
+  "homepage": "https://commercetools.github.io/nodejs",
+  "bugs": "https://github.com/commercetools/typescript-dev-utilities/issues",
+  "author": "",
   "main": "dist/commercetools-sync-actions.cjs.js",
   "module": "dist/commercetools-sync-actions.esm.js",
-  "umd:min": "dist/commercetools-sync-actions.umd.js",
-  "preconstruct": {
-    "entrypoints": [
-      "./index.js"
-    ],
-    "umdName": "commercetoolsSyncActions"
-  },
+  "types": "dist/declarations/index.d.ts",
+  "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/commercetools/nodejs.git"
+    "url": "https://github.com/commercetools/typescript-dev-utilities.git"
+  },
+  "files": ["dist", "CHANGELOG.md"],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "yarn clean;tsc && node esbuild.mjs",
+    "prepublishOnly": "yarn build",
+    "test": "jest --runInBand"
   },
-  "files": [
-    "dist",
-    "lib"
-  ],
   "dependencies": {
+    "@commercetools/platform-sdk": "latest",
+    "esbuild": "^0.25.4",
     "fast-equals": "^2.0.0",
+    "jest": "^29.7.0",
     "jsondiffpatch": "0.5.0",
-    "lodash.flatten": "^4.4.0",
     "lodash.foreach": "^4.5.0",
     "lodash.intersection": "^4.4.0",
     "lodash.isequal": "^4.5.0",
@@ -46,9 +41,5 @@
     "lodash.sortby": "^4.7.0",
     "lodash.uniqwith": "^4.5.0",
     "lodash.without": "^4.4.0"
-  },
-  "scripts": {
-    "prebuild": "rimraf dist/**",
-    "build": "exit 0;"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2018 commercetools GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.