@tryghost/limit-service 1.3.2 → 1.4.1

package/README.md

@@ -68,8 +68,12 @@ const limits = {
         error: 'Your plan supports uploads of max size up to {{max}}. Please upgrade to reenable uploading.'
     },
     limitStripeConnect: {},
-    limitAnalytics: {},
-    limitSocialWeb: {}
+    limitAnalytics: {
+        disabled: false
+    },
+    limitSocialWeb: {
+        disabled: true
+    }
 };
 
 // This information is needed for the limit service to work with "max periodic" limits
@@ -134,6 +138,16 @@ if (limitService.isLimited('uploads')) {
     await limitService.errorIfIsOverLimit('uploads', {currentCount: frame.file.size});
 }
 
+// Limits expose an async `checkWouldGoOverLimit` method, which can be used to check whether a limit has been reached, but not throw an error:
+if (await limitService.checkWouldGoOverLimit('members')) {
+    console.log('Members limit has been reached!');
+}
+
+// Flag limits additionally expose a `isDisabled` sync check, which can be used instead of the async `checkWouldGoOverLimit`:
+if (limitService.isDisabled('limitSocialWeb')) {
+    console.log('Social web is disabled by config!'));
+}
+
 // check if any of the limits are acceding
 if (limitService.checkIfAnyOverLimit()) {
     console.log('One of the limits has acceded!');

package/lib/LimitService.js

@@ -69,6 +69,27 @@ class LimitService {
         return !!this.limits[camelCase(limitName)];
     }
 
+    /**
+    * Check if a limit is disabled, applicable only to limits that support the disabled flag (e.g. FlagLimit)
+    * @returns {boolean|undefined} undefined if limit is not configured
+    * @throws {IncorrectUsageError} if limit does not support disabled flag
+    */
+    isDisabled(limitName) {
+        if (!this.isLimited(limitName)) {
+            return;
+        }
+
+        const limit = this.limits[camelCase(limitName)];
+
+        if (typeof limit.isDisabled !== 'function') {
+            throw new IncorrectUsageError({
+                message: `Limit ${limitName} does not support .isDisabled()`
+            });
+        }
+
+        return limit.isDisabled();
+    }
+
     /**
      *
      * @param {String} limitName - name of the configured limit

package/lib/limit.js

@@ -303,6 +303,14 @@ class FlagLimit extends Limit {
     async errorIfIsOverLimit() {
         return;
     }
+
+    /**
+     * Checks whether the Flag limit is disabled or not
+     * @returns boolean
+     */
+    isDisabled() {
+        return !!this.disabled;
+    }
 }
 
 class AllowlistLimit extends Limit {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/limit-service",
-  "version": "1.3.2",
+  "version": "1.4.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TryGhost/SDK.git",
@@ -34,5 +34,5 @@
     "lodash": "^4.17.21",
     "luxon": "^1.26.0"
   },
-  "gitHead": "abcb7f69994ec865f1c51184744b2401242713ba"
+  "gitHead": "860707f032864400017b0f176cbabf181f99b764"
 }