@ndustrial/contxt-sdk 4.3.6 → 5.1.0

package/src/health/index.js

@@ -1,200 +0,0 @@
-import { formatPaginatedDataFromServer } from '../utils/pagination';
-
-/**
- * @typedef {Object} HealthStatus
- * @property {string} status A health status of value 'healthy' or 'unhealthy'
- * @property {string} timestamp  ISO 8601 Extended Format date/time string
- */
-
-/**
- * @typedef {Object} HealthAsset
- * @augments Asset
- * @property {HealthStatus} health
- */
-
-/**
- * @interface PaginatedResponse
- * @template RecordType
- * @typedef {Object} PaginatedResponse
- * @property {Object} _metadata Metadata about the pagination settings
- * @property {number} _metadata.offset Offset of records in subsequent queries
- * @property {number} _metadata.totalRecords Total number of asset types found
- * @property {Array.<RecordType>} records
- */
-
-/**
- * @typedef {PaginatedResponse.<HealthAsset>} HealthAssetPaginatedResponse
- */
-
-/**
- * @typedef {PaginatedResponse.<HealthStatus>} HealthStatusPaginatedResponse
- */
-
-/**
- * Module that provides access to the Contxt Health Service
- *
- * @typicalname contxtSdk.health
- */
-class Health {
-  /**
-   * @param {Object} sdk An instance of the SDK so the module can communicate with other modules
-   * @param {Object} request An instance of the request module tied to this module's audience.
-   * @param {string} [organizationId] The organization ID to be used in tenant url requests
-   */
-  constructor(sdk, request, organizationId = null) {
-    const baseUrl = `${sdk.config.audiences.health.host}/v1`;
-
-    this._baseUrl = baseUrl;
-    this._request = request;
-    this._sdk = sdk;
-
-    this._organizationId = organizationId;
-  }
-
-  /**
-   * The health status option constants
-   * @enum {string}
-   * @static
-   * @example
-   * console.log(Health.GOOD) //healthy
-   * console.log(Health.BAD) //unhealthy
-   */
-  static status = {
-    GOOD: 'healthy',
-    BAD: 'unhealthy'
-  };
-
-  /**
-   * Gets all of an organization's assets and their most recent health status
-   *
-   * API Endpoint: '/:organizationId/assets'
-   * Method: GET
-   *
-   * @param {Object} options
-   * @param {string} [options.organizationId] The organization id that owns the assets. Required if an organization id isn't set on the module instance.
-   * @param {PaginationOptions} [paginationOptions]
-   * @returns {Promise}
-   * @fulfill {HealthAssetPaginatedResponse} Information about all contxt applications
-   * @reject {Error}
-   *
-   * @example
-   * contxtSdk.health
-   *   .getAll({
-   *      organizationId: 'bd900b6e-a319-492f-aa95-9715891b9a83'
-   *    }, {
-   *      limit: 50,
-   *      offset: 100
-   *   })
-   *   .then((healthAssetRecords) => console.log(healthAssetRecords))
-   *   .catch((err) => console.log(err));
-   */
-  getAll({ organizationId = this._organizationId }, paginationOptions) {
-    if (!organizationId) {
-      return Promise.reject(new Error('An organization ID is required'));
-    }
-
-    return this._request
-      .get(`${this._baseUrl}/${organizationId}/assets`, {
-        params: paginationOptions
-      })
-      .then((response) => formatPaginatedDataFromServer(response));
-  }
-
-  /**
-   * Gets a list of health statuses for a single asset
-   *
-   * API Endpoint: '/:organizationId/assets/:assetId'
-   * Method: GET
-   *
-   * @param {Object} options
-   * @param {string} options.assetId The asset id to get the health for
-   * @param {string} [options.organizationId] The organization id that owns the assets. Required if an organization id isn't set on the module instance.
-   * @param {PaginationOptions} [paginationOptions]
-   * @returns {Promise}
-   * @fulfill {HealthStatusPaginatedResponse} Information about all contxt applications
-   * @reject {Error}
-   *
-   * @example
-   * contxtSdk.health
-   *   .getByAssetId({
-   *      assetId: '9859f22d-cc45-4015-8674-1671f54d1888',
-   *      organizationId: 'bd900b6e-a319-492f-aa95-9715891b9a83'
-   *   }, {
-   *      limit: 50,
-   *      offset: 100
-   *   })
-   *   .then((healthStatusRecords) => console.log(healthStatusRecords))
-   *   .catch((err) => console.log(err));
-   */
-  getByAssetId(
-    { assetId, organizationId = this._organizationId },
-    paginationOptions
-  ) {
-    if (!assetId) {
-      return Promise.reject(new Error('An asset ID is required'));
-    }
-
-    if (!organizationId) {
-      return Promise.reject(new Error('An organization ID is required'));
-    }
-
-    return this._request
-      .get(`${this._baseUrl}/${organizationId}/assets/${assetId}`, {
-        params: paginationOptions
-      })
-      .then((response) => formatPaginatedDataFromServer(response));
-  }
-
-  /**
-   * Creates a new health status entry for an asset
-   *
-   * API Endpoint: '/:organizationId/assets/:assetId'
-   * Method: POST
-   *
-   * @param {Object} options
-   * @param {string} options.assetId The asset id to get the health for
-   * @param {string} [options.organizationId] The organization id that owns the assets. Required if an organization id isn't set on the module instance.
-   * @param {string} options.status The health of the asset. One of type Health.status.GOOD or Health.status.BAD
-   * @param {string} [options.timestamp] Defaults to now. ISO 8601 Extended Format date/time string
-   * @returns {Promise}
-   * @fulfill {HealthStatusPaginatedResponse} Information about all contxt applications
-   * @reject {Error}
-   *
-   * @example
-   * contxtSdk.health
-   *   .post({
-   *      assetId: '9859f22d-cc45-4015-8674-1671f54d1888',
-   *      organizationId: 'bd900b6e-a319-492f-aa95-9715891b9a83',
-   *      status: contxtSdk.health.status.GOOD
-   *   })
-   *   .then((healthStatus) => console.log(healthStatus))
-   *   .catch((err) => console.log(err));
-   */
-  post({ assetId, organizationId = this._organizationId, status, timestamp }) {
-    if (!assetId) {
-      return Promise.reject(new Error('An asset ID is required'));
-    }
-
-    if (!organizationId) {
-      return Promise.reject(new Error('An organization ID is required'));
-    }
-
-    if (!Object.values(Health.status).includes(status)) {
-      return Promise.reject(
-        new Error(
-          `Status must equal one of: ${Object.values(Health.status).join(', ')}`
-        )
-      );
-    }
-
-    return this._request.post(
-      `${this._baseUrl}/${organizationId}/assets/${assetId}`,
-      {
-        status,
-        timestamp
-      }
-    );
-  }
-}
-
-export default Health;

package/src/health/index.spec.js

@@ -1,501 +0,0 @@
-import Health from './index';
-import * as paginationUtils from '../utils/pagination';
-
-describe('Health', function() {
-  let baseRequest;
-  let baseSdk;
-
-  beforeEach(function() {
-    baseRequest = {
-      delete: sinon.stub().resolves(),
-      get: sinon.stub().resolves(),
-      post: sinon.stub().resolves(),
-      put: sinon.stub().resolves()
-    };
-
-    baseSdk = {
-      config: {
-        audiences: {
-          health: fixture.build('audience')
-        }
-      }
-    };
-  });
-
-  afterEach(function() {
-    sinon.restore();
-  });
-
-  describe('constructor', function() {
-    let health;
-    let organizationId;
-
-    beforeEach(function() {
-      organizationId = fixture.build('organization').id;
-
-      health = new Health(baseSdk, baseRequest, organizationId);
-    });
-
-    it('sets a base url for the class instance', function() {
-      expect(health._baseUrl).to.equal(
-        `${baseSdk.config.audiences.health.host}/v1`
-      );
-    });
-
-    it('sets an organizationId for the class instance', function() {
-      expect(health._organizationId).to.equal(organizationId);
-    });
-
-    it('appends the supplied request module to the class instance', function() {
-      expect(health._request).to.deep.equal(baseRequest);
-    });
-
-    it('appends the supplied sdk to the class instance', function() {
-      expect(health._sdk).to.deep.equal(baseSdk);
-    });
-  });
-
-  describe('getAll', function() {
-    context(
-      'when the class instance does not have an organizationId',
-      function() {
-        let health;
-
-        beforeEach(function() {
-          health = new Health(baseSdk, baseRequest);
-        });
-
-        context('when getAll is called without an organizationId', function() {
-          it('throws an error', function() {
-            let promise = health.getAll({
-              organizationId: null
-            });
-
-            return expect(promise).to.be.rejectedWith(
-              'An organization ID is required'
-            );
-          });
-        });
-
-        context('when getAll is called with an organizationId', function() {
-          it('does not throw an error', function() {
-            let promise = health.getAll({
-              organizationId: fixture.build('organization').id
-            });
-
-            return expect(promise).to.be.not.throw;
-          });
-        });
-      }
-    );
-
-    context('when the class instance does have an organizationId', function() {
-      let health;
-      let organizationId;
-      let paginationOptions;
-
-      beforeEach(function() {
-        organizationId = fixture.build('organization').id;
-
-        health = new Health(baseSdk, baseRequest, organizationId);
-        paginationOptions = {
-          limit: faker.random.number(),
-          offset: faker.random.number(),
-          orderBy: faker.random.arrayElement(['asc', 'desc']),
-          sortBy: null
-        };
-      });
-
-      context('when getAll is called without an organizationId', function() {
-        it('calls the api with the class instance organizationId', function() {
-          health.getAll({}, paginationOptions);
-
-          expect(baseRequest.get).to.be.calledWith(
-            `${baseSdk.config.audiences.health.host}/v1/${
-              health._organizationId
-            }/assets`
-          );
-        });
-      });
-
-      context('when getAll is called with an organizationId', function() {
-        it('calls the api with the provided organizationId', function() {
-          let organizationId = fixture.build('organization').id;
-          health.getAll({
-            organizationId
-          });
-
-          expect(baseRequest.get).to.be.calledWith(
-            `${
-              baseSdk.config.audiences.health.host
-            }/v1/${organizationId}/assets`
-          );
-        });
-      });
-    });
-
-    context('when all required parameters are supplied', function() {
-      let health;
-      let organizationId;
-      let paginationOptions;
-      let formatPaginatedDataFromServer;
-
-      beforeEach(function() {
-        organizationId = fixture.build('organization').id;
-
-        health = new Health(baseSdk, baseRequest, organizationId);
-
-        paginationOptions = {
-          limit: faker.random.number(),
-          offset: faker.random.number(),
-          orderBy: faker.random.arrayElement(['asc', 'desc']),
-          sortBy: null
-        };
-
-        formatPaginatedDataFromServer = sinon.stub(
-          paginationUtils,
-          'formatPaginatedDataFromServer'
-        );
-      });
-
-      it('calls the api with the requested pagination options', function() {
-        health.getAll({}, paginationOptions);
-
-        expect(baseRequest.get).to.be.calledWith(
-          `${baseSdk.config.audiences.health.host}/v1/${
-            health._organizationId
-          }/assets`,
-          { params: paginationOptions }
-        );
-      });
-
-      it('formats the response with formatPaginatedDataFromServer()', function() {
-        let promise = health.getAll({}, paginationOptions);
-
-        return promise.then(() => {
-          expect(formatPaginatedDataFromServer).to.be.called;
-        });
-      });
-    });
-  });
-
-  describe('getByAssetId', function() {
-    context(
-      'when the class instance does not have an organizationId',
-      function() {
-        let health;
-        let assetId;
-
-        beforeEach(function() {
-          assetId = fixture.build('asset').id;
-          health = new Health(baseSdk, baseRequest);
-        });
-
-        context(
-          'when getByAssetId is called without an organizationId',
-          function() {
-            it('throws an error', function() {
-              let promise = health.getByAssetId({
-                assetId,
-                organizationId: null
-              });
-
-              return expect(promise).to.be.rejectedWith(
-                'An organization ID is required'
-              );
-            });
-          }
-        );
-
-        context(
-          'when getByAssetId is called with an organizationId',
-          function() {
-            it('does not throw an error', function() {
-              let promise = health.getByAssetId({
-                assetId,
-                organizationId: fixture.build('organization').id
-              });
-
-              return expect(promise).to.be.not.throw;
-            });
-          }
-        );
-      }
-    );
-
-    context('when the class instance does have an organizationId', function() {
-      let health;
-      let organizationId;
-      let paginationOptions;
-      let assetId;
-
-      beforeEach(function() {
-        organizationId = fixture.build('organization').id;
-        assetId = fixture.build('asset').id;
-
-        health = new Health(baseSdk, baseRequest, organizationId);
-        paginationOptions = {
-          limit: faker.random.number(),
-          offset: faker.random.number(),
-          orderBy: faker.random.arrayElement(['asc', 'desc']),
-          sortBy: null
-        };
-      });
-
-      context(
-        'when getByAssetId is called without an organizationId',
-        function() {
-          it('calls the api with the class instance organizationId', function() {
-            health.getByAssetId({ assetId }, paginationOptions);
-
-            expect(baseRequest.get).to.be.calledWith(
-              `${baseSdk.config.audiences.health.host}/v1/${
-                health._organizationId
-              }/assets/${assetId}`
-            );
-          });
-        }
-      );
-
-      context('when getByAssetId is called with an organizationId', function() {
-        it('calls the api with the provided organizationId', function() {
-          health.getByAssetId({
-            assetId,
-            organizationId
-          });
-
-          expect(baseRequest.get).to.be.calledWith(
-            `${
-              baseSdk.config.audiences.health.host
-            }/v1/${organizationId}/assets/${assetId}`
-          );
-        });
-      });
-    });
-
-    context('when the assetId is not supplied', function() {
-      let health;
-      let organizationId;
-
-      beforeEach(function() {
-        organizationId = fixture.build('organization').id;
-
-        health = new Health(baseSdk, baseRequest, organizationId);
-      });
-
-      it('throws an error', function() {
-        let promise = health.getByAssetId({
-          organizationId
-        });
-
-        return expect(promise).to.be.rejectedWith('An asset ID is required');
-      });
-    });
-
-    context('when all required parameters are supplied', function() {
-      let health;
-      let assetId;
-      let organizationId;
-      let paginationOptions;
-      let formatPaginatedDataFromServer;
-
-      beforeEach(function() {
-        assetId = fixture.build('asset').id;
-        organizationId = fixture.build('organization').id;
-
-        health = new Health(baseSdk, baseRequest, organizationId);
-
-        paginationOptions = {
-          limit: faker.random.number(),
-          offset: faker.random.number(),
-          orderBy: faker.random.arrayElement(['asc', 'desc']),
-          sortBy: null
-        };
-
-        formatPaginatedDataFromServer = sinon.stub(
-          paginationUtils,
-          'formatPaginatedDataFromServer'
-        );
-      });
-
-      it('calls the api with the requested pagination options', function() {
-        health.getByAssetId({ assetId }, paginationOptions);
-
-        expect(baseRequest.get).to.be.calledWith(
-          `${baseSdk.config.audiences.health.host}/v1/${
-            health._organizationId
-          }/assets/${assetId}`,
-          { params: paginationOptions }
-        );
-      });
-
-      it('formats the response with formatPaginatedDataFromServer()', function() {
-        let promise = health.getByAssetId({ assetId }, paginationOptions);
-
-        return promise.then(() => {
-          expect(formatPaginatedDataFromServer).to.be.called;
-        });
-      });
-    });
-  });
-
-  describe('post', function() {
-    context(
-      'when the class instance does not have an organizationId',
-      function() {
-        let health;
-        let assetId;
-        let status;
-
-        beforeEach(function() {
-          assetId = fixture.build('asset').id;
-          status = faker.random.arrayElement(Object.values(Health.status));
-          health = new Health(baseSdk, baseRequest);
-        });
-
-        context('when post is called without an organizationId', function() {
-          it('throws an error', function() {
-            let promise = health.post({
-              assetId,
-              organizationId: null,
-              status
-            });
-
-            return expect(promise).to.be.rejectedWith(
-              'An organization ID is required'
-            );
-          });
-        });
-
-        context('when post is called with an organizationId', function() {
-          it('does not throw an error', function() {
-            let promise = health.post({
-              assetId,
-              organizationId: fixture.build('organization').id,
-              status
-            });
-
-            return expect(promise).to.be.not.throw;
-          });
-        });
-      }
-    );
-
-    context('when the class instance does have an organizationId', function() {
-      let health;
-      let organizationId;
-      let assetId;
-      let status;
-
-      beforeEach(function() {
-        organizationId = fixture.build('organization').id;
-        assetId = fixture.build('asset').id;
-        status = faker.random.arrayElement(Object.values(Health.status));
-
-        health = new Health(baseSdk, baseRequest, organizationId);
-      });
-
-      context('when post is called without an organizationId', function() {
-        it('calls the api with the class instance organizationId', function() {
-          health.post({ assetId, status });
-
-          expect(baseRequest.post).to.be.calledWith(
-            `${baseSdk.config.audiences.health.host}/v1/${
-              health._organizationId
-            }/assets/${assetId}`
-          );
-        });
-      });
-
-      context('when post is called with an organizationId', function() {
-        it('calls the api with the provided organizationId', function() {
-          health.post({
-            assetId,
-            organizationId,
-            status
-          });
-
-          expect(baseRequest.post).to.be.calledWith(
-            `${
-              baseSdk.config.audiences.health.host
-            }/v1/${organizationId}/assets/${assetId}`
-          );
-        });
-      });
-    });
-
-    context('when the assetId is not supplied', function() {
-      let health;
-      let organizationId;
-      let status;
-
-      beforeEach(function() {
-        organizationId = fixture.build('organization').id;
-        status = faker.random.arrayElement(Object.values(Health.status));
-
-        health = new Health(baseSdk, baseRequest, organizationId);
-      });
-
-      it('throws an error', function() {
-        let promise = health.post({
-          organizationId,
-          status
-        });
-
-        return expect(promise).to.be.rejectedWith('An asset ID is required');
-      });
-    });
-
-    context('when the status is not supplied', function() {
-      let health;
-      let assetId;
-      let organizationId;
-
-      beforeEach(function() {
-        organizationId = fixture.build('organization').id;
-        assetId = fixture.build('asset').id;
-
-        health = new Health(baseSdk, baseRequest, organizationId);
-      });
-
-      it('throws an error', function() {
-        let promise = health.post({
-          organizationId,
-          assetId
-        });
-
-        return expect(promise).to.be.rejectedWith(
-          'Status must equal one of: healthy, unhealthy'
-        );
-      });
-    });
-
-    context('when all required parameters are supplied', function() {
-      let health;
-      let assetId;
-      let organizationId;
-      let status;
-      let timestamp;
-
-      beforeEach(function() {
-        assetId = fixture.build('asset').id;
-        organizationId = fixture.build('organization').id;
-        status = faker.random.arrayElement(Object.values(Health.status));
-        timestamp = new Date();
-
-        health = new Health(baseSdk, baseRequest, organizationId);
-      });
-
-      it('calls the api with the requested pagination options', function() {
-        health.post({ assetId, organizationId, status, timestamp });
-
-        expect(baseRequest.post).to.be.calledWith(
-          `${baseSdk.config.audiences.health.host}/v1/${
-            health._organizationId
-          }/assets/${assetId}`,
-          { status, timestamp }
-        );
-      });
-    });
-  });
-});