feat(standalone variant actions): update publish and unpublish action handling

Author: ddouglasz

packages/sync-actions/src/standalone-variants/standalone-variant-actions.ts

@@ -11,6 +11,7 @@ import {
 export type StandaloneVariant = {
   id?: string | number;
   key?: string;
+  published?: boolean;
   sku?: string;
   attributes?: Attribute[];
   images?: Image[];
@@ -96,16 +97,33 @@ function _buildSkuAction(
   return null;
 }
 
+function _buildPublishAction(
+  oldVariant: StandaloneVariant,
+  newVariant: StandaloneVariant
+): StandaloneVariantUpdateAction | null {
+  // publish: oldObj.published is not true AND newObj.published is true
+  if (oldVariant.published !== true && newVariant.published === true) {
+    return { action: 'publish' };
+  }
+
+  // unpublish: oldObj.published is true AND newObj.published is not true
+  if (oldVariant.published === true && newVariant.published !== true) {
+    return { action: 'unpublish' };
+  }
+
+  return null;
+}
+
 /**
- * Maps base actions (setKey, setSku) for standalone variants.
+ * Maps base actions (setKey, setSku, publish, unpublish) for standalone variants.
  * Analyzes the diff between old and new variant and generates appropriate actions.
  *
  * Accepts flat variant objects directly (not wrapped in a variants array).
  */
 export function actionsMapBase(
   diff: Delta,
   oldVariant: StandaloneVariant,
-  _newVariant: StandaloneVariant,
+  newVariant: StandaloneVariant,
   config: SyncActionConfig = {}
 ): Array<StandaloneVariantUpdateAction> {
   const actions: Array<StandaloneVariantUpdateAction> = [];
@@ -124,6 +142,11 @@ export function actionsMapBase(
     actions.push(skuAction);
   }
 
+  const publishAction = _buildPublishAction(oldVariant, newVariant);
+  if (publishAction) {
+    actions.push(publishAction);
+  }
+
   return actions;
 }
 
@@ -183,23 +206,3 @@ export function actionsMapAssets(
   return [_buildStagedAction('setAssets', { assets }, config)];
 }
 
-/**
- * Builds a publish action for standalone variants.
- */
-export function buildPublishAction(): StandaloneVariantUpdateAction {
-  return { action: 'publish' };
-}
-
-/**
- * Builds an unpublish action for standalone variants.
- */
-export function buildUnpublishAction(): StandaloneVariantUpdateAction {
-  return { action: 'unpublish' };
-}
-
-/**
- * Builds a removeStagedChanges action for standalone variants.
- */
-export function buildRemoveStagedChangesAction(): StandaloneVariantUpdateAction {
-  return { action: 'removeStagedChanges' };
-}

packages/sync-actions/test/standalone-variants-sync.spec.ts

@@ -4,9 +4,6 @@ import createStandaloneVariantsSync, {
 } from '../src/standalone-variants/standalone-variants';
 import {
   convertAttributeToUpdateActionShape,
-  buildPublishAction,
-  buildUnpublishAction,
-  buildRemoveStagedChangesAction,
   StandaloneVariant,
 } from '../src/standalone-variants/standalone-variant-actions';
 import { SyncAction } from '../src/utils/types';
@@ -1197,25 +1194,149 @@ describe('Actions', () => {
   });
 });
 
-describe('Lifecycle actions', () => {
-  describe('buildPublishAction', () => {
-    test('should build publish action', () => {
-      const action = buildPublishAction();
-      expect(action).toEqual({ action: 'publish' });
-    });
+describe('Publish/Unpublish actions', () => {
+  let standaloneVariantSync: SyncAction<
+    StandaloneVariant,
+    StandaloneVariantUpdateAction
+  >;
+
+  beforeEach(() => {
+    standaloneVariantSync = createStandaloneVariantsSync();
   });
 
-  describe('buildUnpublishAction', () => {
-    test('should build unpublish action', () => {
-      const action = buildUnpublishAction();
-      expect(action).toEqual({ action: 'unpublish' });
-    });
+  test('should build `publish` action when published changes from false to true', () => {
+    const before: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: false,
+    };
+    const now: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: true,
+    };
+
+    const actual = standaloneVariantSync.buildActions(now, before);
+
+    expect(actual).toEqual([{ action: 'publish' }]);
   });
 
-  describe('buildRemoveStagedChangesAction', () => {
-    test('should build removeStagedChanges action', () => {
-      const action = buildRemoveStagedChangesAction();
-      expect(action).toEqual({ action: 'removeStagedChanges' });
-    });
+  test('should build `publish` action when published changes from undefined to true', () => {
+    const before: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+    };
+    const now: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: true,
+    };
+
+    const actual = standaloneVariantSync.buildActions(now, before);
+
+    expect(actual).toEqual([{ action: 'publish' }]);
+  });
+
+  test('should build `unpublish` action when published changes from true to false', () => {
+    const before: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: true,
+    };
+    const now: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: false,
+    };
+
+    const actual = standaloneVariantSync.buildActions(now, before);
+
+    expect(actual).toEqual([{ action: 'unpublish' }]);
+  });
+
+  test('should build `unpublish` action when published changes from true to undefined', () => {
+    const before: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: true,
+    };
+    const now: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+    };
+
+    const actual = standaloneVariantSync.buildActions(now, before);
+
+    expect(actual).toEqual([{ action: 'unpublish' }]);
+  });
+
+  test('should not build publish/unpublish action when published is unchanged (both true)', () => {
+    const before: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: true,
+    };
+    const now: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: true,
+    };
+
+    const actual = standaloneVariantSync.buildActions(now, before);
+
+    expect(actual).toEqual([]);
+  });
+
+  test('should not build publish/unpublish action when published is unchanged (both false)', () => {
+    const before: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: false,
+    };
+    const now: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'sku-1',
+      published: false,
+    };
+
+    const actual = standaloneVariantSync.buildActions(now, before);
+
+    expect(actual).toEqual([]);
+  });
+
+  test('should build publish action along with other changes', () => {
+    const before: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'old-sku',
+      published: false,
+    };
+    const now: StandaloneVariant = {
+      id: '123',
+      key: 'key-1',
+      sku: 'new-sku',
+      published: true,
+    };
+
+    const actual = standaloneVariantSync.buildActions(now, before);
+
+    expect(actual).toEqual(
+      expect.arrayContaining([
+        { action: 'setSku', sku: 'new-sku', staged: true },
+        { action: 'publish' },
+      ])
+    );
   });
 });