@clevercloud/client - npm Package Compare versions

Comparing version 7.0.0 to 7.1.0

CHANGELOG.md

 # Clever Client changelog
 
-## Unreleased (2020-10-05)
+## 7.1.0 (2020-11-26)
 
+* Expose app statuses
+
+## 7.0.0 (2020-10-05)
+
 * replace jest by [@web/test-runner](https://modern-web.dev/guides/test-runner/getting-started/)
@@ -6,0 +10,0 @@ * Add new zones API `GET /v4/product/zones` in `api/v4/product.js` with `getAllZones()`.

cjs/api/v2/oauth.js

@@ -54,2 +54,3 @@ "use strict";
  * @param {Object} params
+ * @param {String} params.clever_flavor
  * @param {Object} body
@@ -68,3 +69,3 @@ */
     },
-    // no query params
+    queryParams: (0, _pickNonNull.pickNonNull)(params, ['clever_flavor']),
     body
@@ -71,0 +72,0 @@ });

cjs/api/v2/unknown.js

@@ -297,2 +297,3 @@ "use strict";
  * @param {Object} params
+ * @param {String} params.clever_flavor
  * @param {String} params.oauth_consumer_key
@@ -320,3 +321,3 @@ * @param {String} params.oauth_token
     },
-    queryParams: (0, _pickNonNull.pickNonNull)(params, ['oauth_consumer_key', 'oauth_token', 'oauth_signature_method', 'oauth_signature', 'oauth_timestamp', 'oauth_nonce', 'oauth_version', 'oauth_verifier', 'oauth_callback', 'oauth_token_secret', 'oauth_callback_confirmed']) // no body
+    queryParams: (0, _pickNonNull.pickNonNull)(params, ['clever_flavor', 'oauth_consumer_key', 'oauth_token', 'oauth_signature_method', 'oauth_signature', 'oauth_timestamp', 'oauth_nonce', 'oauth_version', 'oauth_verifier', 'oauth_callback', 'oauth_token_secret', 'oauth_callback_confirmed']) // no body
 
@@ -408,6 +409,7 @@ });
  * @param {Object} params
+ * @param {String} params.clever_flavor
  */
 
 
-function todo_getPasswordForgottenForm() {
+function todo_getPasswordForgottenForm(params) {
   // no multipath for /self or /organisations/{id}
@@ -419,4 +421,4 @@ return Promise.resolve({
       Accept: 'text/html'
-    } // no query params
-    // no body
+    },
+    queryParams: (0, _pickNonNull.pickNonNull)(params, ['clever_flavor']) // no body
 
@@ -449,2 +451,3 @@ });
  * @param {String} params.key
+ * @param {String} params.clever_flavor
  */
@@ -460,4 +463,4 @@
       Accept: 'text/html'
-    } // no query params
-    // no body
+    },
+    queryParams: (0, _pickNonNull.pickNonNull)(params, ['clever_flavor']) // no body
 
@@ -785,2 +788,3 @@ });
  * @param {String} params.cli_token
+ * @param {String} params.clever_flavor
  */
@@ -797,3 +801,3 @@
     },
-    queryParams: (0, _pickNonNull.pickNonNull)(params, ['secondaryEmailKey', 'deletionKey', 'fromAuthorize', 'cli_token']) // no body
+    queryParams: (0, _pickNonNull.pickNonNull)(params, ['secondaryEmailKey', 'deletionKey', 'fromAuthorize', 'cli_token', 'clever_flavor']) // no body
 
@@ -847,2 +851,3 @@ });
  * @param {String} params.url_next
+ * @param {String} params.clever_flavor
  */
@@ -859,3 +864,3 @@
     },
-    queryParams: (0, _pickNonNull.pickNonNull)(params, ['invitationKey', 'url_next']) // no body
+    queryParams: (0, _pickNonNull.pickNonNull)(params, ['invitationKey', 'url_next', 'clever_flavor']) // no body
 
@@ -871,2 +876,3 @@ });
  * @param {String} params.cli_token
+ * @param {String} params.clever_flavor
  */
@@ -883,3 +889,3 @@
     },
-    queryParams: (0, _pickNonNull.pickNonNull)(params, ['secondaryEmailKey', 'deletionKey', 'fromAuthorize', 'cli_token']) // no body
+    queryParams: (0, _pickNonNull.pickNonNull)(params, ['secondaryEmailKey', 'deletionKey', 'fromAuthorize', 'cli_token', 'clever_flavor']) // no body
 
@@ -893,2 +899,3 @@ });
  * @param {String} params.url_next
+ * @param {String} params.clever_flavor
  */
@@ -905,3 +912,3 @@
     },
-    queryParams: (0, _pickNonNull.pickNonNull)(params, ['invitationKey', 'url_next']) // no body
+    queryParams: (0, _pickNonNull.pickNonNull)(params, ['invitationKey', 'url_next', 'clever_flavor']) // no body
 
@@ -908,0 +915,0 @@ });

cjs/utils/app-status.js

@@ -7,2 +7,14 @@ "use strict";
 exports.getStatus = getStatus;
+exports.STATUSES = void 0;
+const STATUSES = {
+  STOPPED: 'stopped',
+  STARTING: 'starting',
+  START_FAILED: 'start-failed',
+  RESTARTING_WITH_DOWNTIME: 'restarting-with-downtime',
+  RESTARTING: 'restarting',
+  RESTART_FAILED: 'restart-failed',
+  RUNNING: 'running',
+  UNKNOWN: 'unknown'
+};
+exports.STATUSES = STATUSES;
 
@@ -16,3 +28,3 @@ function getStatus(app, deployments, instances) {
   if (app.state === 'SHOULD_BE_DOWN') {
-    return 'stopped';
+    return STATUSES.STOPPED;
   }
@@ -22,7 +34,7 @@
     if (lastDeploymentState === 'WIP') {
-      return 'starting';
+      return STATUSES.STARTING;
     }
 
     if (lastDeploymentState === 'FAIL') {
-      return 'start-failed';
+      return STATUSES.START_FAILED;
     }
@@ -34,3 +46,3 @@ }
       if (app.homogeneous === true) {
-        return 'restarting-with-downtime';
+        return STATUSES.RESTARTING_WITH_DOWNTIME;
       }
@@ -40,3 +52,3 @@
         if (upInstancesCount > 0) {
-          return 'restarting';
+          return STATUSES.RESTARTING;
         }
@@ -46,7 +58,7 @@ }
       if (upInstancesCount > 0) {
-        return 'restart-failed';
+        return STATUSES.RESTART_FAILED;
       }
     } else {
       if (upInstancesCount > 0) {
-        return 'running';
+        return STATUSES.RUNNING;
       }
@@ -56,3 +68,3 @@ }
 
-  return 'unknown';
+  return STATUSES.UNKNOWN;
 }

esm/api/v2/oauth.js

@@ -38,2 +38,3 @@ import { pickNonNull } from '../../pick-non-null.js';
  * @param {Object} params
+ * @param {String} params.clever_flavor
  * @param {Object} body
@@ -47,3 +48,3 @@ */
     headers: { Accept: 'application/x-www-form-urlencoded', 'Content-Type': 'application/x-www-form-urlencoded' },
-    // no query params
+    queryParams: pickNonNull(params, ['clever_flavor']),
     body,
@@ -50,0 +51,0 @@ });

esm/api/v2/unknown.js

@@ -214,2 +214,3 @@ import { pickNonNull } from '../../pick-non-null.js';
  * @param {Object} params
+ * @param {String} params.clever_flavor
  * @param {String} params.oauth_consumer_key
@@ -234,2 +235,3 @@ * @param {String} params.oauth_token
     queryParams: pickNonNull(params, [
+      'clever_flavor',
       'oauth_consumer_key',
@@ -321,4 +323,5 @@ 'oauth_token',
  * @param {Object} params
+ * @param {String} params.clever_flavor
  */
-export function todo_getPasswordForgottenForm() {
+export function todo_getPasswordForgottenForm(params) {
   // no multipath for /self or /organisations/{id}
@@ -329,3 +332,3 @@ return Promise.resolve({
     headers: { Accept: 'text/html' },
-    // no query params
+    queryParams: pickNonNull(params, ['clever_flavor']),
     // no body
@@ -355,2 +358,3 @@ });
  * @param {String} params.key
+ * @param {String} params.clever_flavor
  */
@@ -363,3 +367,3 @@ export function todo_confirmPasswordResetRequest(params) {
     headers: { Accept: 'text/html' },
-    // no query params
+    queryParams: pickNonNull(params, ['clever_flavor']),
     // no body
@@ -636,2 +640,3 @@ });
  * @param {String} params.cli_token
+ * @param {String} params.clever_flavor
  */
@@ -644,3 +649,3 @@ export function todo_getLoginForm(params) {
     headers: { Accept: 'text/html' },
-    queryParams: pickNonNull(params, ['secondaryEmailKey', 'deletionKey', 'fromAuthorize', 'cli_token']),
+    queryParams: pickNonNull(params, ['secondaryEmailKey', 'deletionKey', 'fromAuthorize', 'cli_token', 'clever_flavor']),
     // no body
@@ -687,2 +692,3 @@ });
  * @param {String} params.url_next
+ * @param {String} params.clever_flavor
  */
@@ -695,3 +701,3 @@ export function todo_getSignupForm(params) {
     headers: { Accept: 'text/html' },
-    queryParams: pickNonNull(params, ['invitationKey', 'url_next']),
+    queryParams: pickNonNull(params, ['invitationKey', 'url_next', 'clever_flavor']),
     // no body
@@ -708,2 +714,3 @@ });
  * @param {String} params.cli_token
+ * @param {String} params.clever_flavor
  */
@@ -716,3 +723,3 @@ export function todo_getLoginForm_1(params) {
     headers: { Accept: 'text/html' },
-    queryParams: pickNonNull(params, ['secondaryEmailKey', 'deletionKey', 'fromAuthorize', 'cli_token']),
+    queryParams: pickNonNull(params, ['secondaryEmailKey', 'deletionKey', 'fromAuthorize', 'cli_token', 'clever_flavor']),
     // no body
@@ -727,2 +734,3 @@ });
  * @param {String} params.url_next
+ * @param {String} params.clever_flavor
  */
@@ -735,3 +743,3 @@ export function todo_getSignupForm_1(params) {
     headers: { Accept: 'text/html' },
-    queryParams: pickNonNull(params, ['invitationKey', 'url_next']),
+    queryParams: pickNonNull(params, ['invitationKey', 'url_next', 'clever_flavor']),
     // no body
@@ -738,0 +746,0 @@ });

esm/utils/app-status.js

@@ -0,1 +1,12 @@
+export const STATUSES = {
+  STOPPED: 'stopped',
+  STARTING: 'starting',
+  START_FAILED: 'start-failed',
+  RESTARTING_WITH_DOWNTIME: 'restarting-with-downtime',
+  RESTARTING: 'restarting',
+  RESTART_FAILED: 'restart-failed',
+  RUNNING: 'running',
+  UNKNOWN: 'unknown',
+};
+
 export function getStatus (app, deployments, instances) {
@@ -7,3 +18,3 @@
   if (app.state === 'SHOULD_BE_DOWN') {
-    return 'stopped';
+    return STATUSES.STOPPED;
   }
@@ -13,6 +24,6 @@
     if (lastDeploymentState === 'WIP') {
-      return 'starting';
+      return STATUSES.STARTING;
     }
     if (lastDeploymentState === 'FAIL') {
-      return 'start-failed';
+      return STATUSES.START_FAILED;
     }
@@ -24,7 +35,7 @@ }
       if (app.homogeneous === true) {
-        return 'restarting-with-downtime';
+        return STATUSES.RESTARTING_WITH_DOWNTIME;
       }
       if (app.homogeneous === false) {
         if (upInstancesCount > 0) {
-          return 'restarting';
+          return STATUSES.RESTARTING;
         }
@@ -35,3 +46,3 @@ }
       if (upInstancesCount > 0) {
-        return 'restart-failed';
+        return STATUSES.RESTART_FAILED;
       }
@@ -41,3 +52,3 @@ }
       if (upInstancesCount > 0) {
-        return 'running';
+        return STATUSES.RUNNING;
       }
@@ -47,3 +58,3 @@ }
 
-  return 'unknown';
+  return STATUSES.UNKNOWN;
 }

package.json

 {
   "name": "@clevercloud/client",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "JavaScript REST client and utils for Clever Cloud's API",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/CleverCloud/clever-client.js",

No alert changes

Improved metrics

Total package byte prevSize

426992

0.43%

Lines of code

12962

0.3%

No dependency changes