@adobe/spacecat-shared-tier-client 1.3.1 → 1.3.3

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-tier-client-v1.3.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tier-client-v1.3.2...@adobe/spacecat-shared-tier-client-v1.3.3) (2025-11-27)
+
+
+### Bug Fixes
+
+* support for revoke paid entitlement ([#1180](https://github.com/adobe/spacecat-shared/issues/1180)) ([f584c60](https://github.com/adobe/spacecat-shared/commit/f584c600937bb117f60cc6d5cab0dba5dda30d84))
+
+# [@adobe/spacecat-shared-tier-client-v1.3.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tier-client-v1.3.1...@adobe/spacecat-shared-tier-client-v1.3.2) (2025-11-25)
+
+
+### Bug Fixes
+
+* add lib for revoke entitlement ([#1169](https://github.com/adobe/spacecat-shared/issues/1169)) ([d0f2e67](https://github.com/adobe/spacecat-shared/commit/d0f2e67332e52ee23ece5310d484a43bd42146a4))
+
 # [@adobe/spacecat-shared-tier-client-v1.3.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tier-client-v1.3.0...@adobe/spacecat-shared-tier-client-v1.3.1) (2025-11-24)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tier-client",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "Shared modules of the Spacecat Services - Tier Client",
   "type": "module",
   "engines": {

package/src/tier-client.js

@@ -288,6 +288,35 @@ class TierClient {
       throw error;
     }
   }
+
+  /**
+   * Revokes entitlement for the current organization.
+   * @returns {Promise<object>} HTTP response object.
+   */
+  async revokeEntitlement() {
+    const existing = await this.checkValidEntitlement();
+    if (existing.entitlement) {
+      if (existing.entitlement.getTier() === EntitlementModel.TIERS.PAID) {
+        throw new Error('Paid entitlement cannot be revoked');
+      }
+      await existing.entitlement.remove();
+    } else {
+      throw new Error('Entitlement not found');
+    }
+  }
+
+  /**
+   * Revokes PAID/FREE entitlement for the current organization.
+   * @returns {Promise<object>} HTTP response object.
+   */
+  async revokePaidEntitlement() {
+    const existing = await this.checkValidEntitlement();
+    if (existing.entitlement) {
+      await existing.entitlement.remove();
+    } else {
+      throw new Error('Entitlement not found');
+    }
+  }
 }
 
 export default TierClient;

package/test/tier-client.test.js

@@ -186,6 +186,13 @@ describe('TierClient', () => {
         expect(mockDataAccess.Organization.findById).to.have.been.calledWith(orgId);
       });
 
+      it('should throw error when organization not found for site', async () => {
+        mockDataAccess.Organization.findById.resolves(null);
+
+        await expect(TierClient.createForSite(mockContext, testSite, productCode))
+          .to.be.rejectedWith(`[TierClient] Organization not found for organizationId: ${orgId}`);
+      });
+
       it('should throw error when site is not provided', async () => {
         await expect(TierClient.createForSite(mockContext, null, productCode)).to.be.rejectedWith('Entity must be an instance of Site');
       });
@@ -545,6 +552,131 @@ describe('TierClient', () => {
     });
   });
 
+  describe('revokeEntitlement', () => {
+    it('should successfully revoke entitlement when it exists', async () => {
+      const mockEntitlementWithRemove = {
+        ...mockEntitlement,
+        remove: sandbox.stub().resolves(),
+      };
+
+      mockDataAccess.Entitlement
+        .findByOrganizationIdAndProductCode.resolves(mockEntitlementWithRemove);
+      mockDataAccess.SiteEnrollment.allBySiteId.resolves([]);
+
+      await tierClient.revokeEntitlement();
+
+      expect(mockEntitlementWithRemove.remove.calledOnce).to.be.true;
+    });
+
+    it('should throw error when entitlement is PAID tier', async () => {
+      const mockPaidEntitlement = {
+        ...mockEntitlement,
+        getTier: () => 'PAID',
+        remove: sandbox.stub().resolves(),
+      };
+
+      mockDataAccess.Entitlement
+        .findByOrganizationIdAndProductCode.resolves(mockPaidEntitlement);
+      mockDataAccess.SiteEnrollment.allBySiteId.resolves([]);
+
+      await expect(tierClient.revokeEntitlement()).to.be.rejectedWith('Paid entitlement cannot be revoked');
+      expect(mockPaidEntitlement.remove).to.not.have.been.called;
+    });
+
+    it('should throw error when entitlement does not exist', async () => {
+      mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(null);
+      mockDataAccess.SiteEnrollment.allBySiteId.resolves([]);
+
+      await expect(tierClient.revokeEntitlement()).to.be.rejectedWith('Entitlement not found');
+    });
+
+    it('should handle database errors during entitlement removal', async () => {
+      const mockEntitlementWithRemoveError = {
+        ...mockEntitlement,
+        remove: sandbox.stub().rejects(new Error('Database error')),
+      };
+
+      mockDataAccess.Entitlement
+        .findByOrganizationIdAndProductCode.resolves(mockEntitlementWithRemoveError);
+      mockDataAccess.SiteEnrollment.allBySiteId.resolves([]);
+
+      await expect(tierClient.revokeEntitlement()).to.be.rejectedWith('Database error');
+    });
+
+    it('should handle errors when checking valid entitlement', async () => {
+      mockDataAccess.Entitlement
+        .findByOrganizationIdAndProductCode
+        .rejects(new Error('Database error'));
+
+      await expect(tierClient.revokeEntitlement()).to.be.rejectedWith('Database error');
+    });
+
+    it('should work with organization-only client (no site)', async () => {
+      const mockEntitlementWithRemove = {
+        ...mockEntitlement,
+        remove: sandbox.stub().resolves(),
+      };
+
+      const orgOnlyClient = new TierClient(
+        mockContext,
+        organizationInstance,
+        null,
+        productCode,
+      );
+
+      mockDataAccess.Entitlement
+        .findByOrganizationIdAndProductCode.resolves(mockEntitlementWithRemove);
+
+      await orgOnlyClient.revokeEntitlement();
+
+      expect(mockEntitlementWithRemove.remove.calledOnce).to.be.true;
+    });
+  });
+
+  describe('revokePaidEntitlement', () => {
+    it('should successfully revoke entitlement regardless of tier', async () => {
+      const mockPaidEntitlement = {
+        ...mockEntitlement,
+        getTier: () => 'PAID',
+        remove: sandbox.stub().resolves(),
+      };
+
+      mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockPaidEntitlement);
+      mockDataAccess.SiteEnrollment.allBySiteId.resolves([]);
+
+      await tierClient.revokePaidEntitlement();
+
+      expect(mockPaidEntitlement.remove.calledOnce).to.be.true;
+    });
+
+    it('should throw error when entitlement does not exist', async () => {
+      mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(null);
+      mockDataAccess.SiteEnrollment.allBySiteId.resolves([]);
+
+      await expect(tierClient.revokePaidEntitlement()).to.be.rejectedWith('Entitlement not found');
+    });
+
+    it('should handle database errors during entitlement removal', async () => {
+      const mockEntitlementWithRemoveError = {
+        ...mockEntitlement,
+        remove: sandbox.stub().rejects(new Error('Database error')),
+      };
+
+      mockDataAccess.Entitlement
+        .findByOrganizationIdAndProductCode.resolves(mockEntitlementWithRemoveError);
+      mockDataAccess.SiteEnrollment.allBySiteId.resolves([]);
+
+      await expect(tierClient.revokePaidEntitlement()).to.be.rejectedWith('Database error');
+    });
+
+    it('should propagate errors when checking valid entitlement', async () => {
+      mockDataAccess.Entitlement
+        .findByOrganizationIdAndProductCode
+        .rejects(new Error('Database error'));
+
+      await expect(tierClient.revokePaidEntitlement()).to.be.rejectedWith('Database error');
+    });
+  });
   describe('getAllEnrollment', () => {
     beforeEach(() => {
       mockDataAccess.SiteEnrollment.allByEntitlementId = sandbox.stub();