Added Status

Author: perki

src/appTemplates/AppManagingAccount.js

@@ -12,6 +12,7 @@ const collectorIdGenerator = new ShortUniqueId({ dictionary: 'alphanum_lower', l
  * Stream structure
  * - [baseStreamId]  "Root" stream for this app
  *     - [baseStreamId]-[collectorsId] Each "questionnary" or "request for a set of data" has it's own stream
+ *       - [baseStreamId]-[collectorsId]-internal Private stuff not to be shared
  *       - [baseStreamId]-[collectorsId]-public Contains events with the current settings of this app (this stream will be shared in "read" with the request)
  *       - [baseStreamId]-[collectorsId]-pending Contains events with "pending" requests
  *       - [baseStreamId]-[collectorsId]-inbox Contains events with "inbox" requests Will be shared in createOnly
@@ -99,6 +100,7 @@ class AppManagingAccount {
 }
 
 const COLLECTOR_STREAMID_SUFFIXES = {
+  internal: 'internal',
   public: 'public',
   pending: 'pending',
   inbox: 'inbox',
@@ -108,6 +110,12 @@ const COLLECTOR_STREAMID_SUFFIXES = {
 Object.freeze(COLLECTOR_STREAMID_SUFFIXES);
 class Collector {
   static STREAMID_SUFFIXES = COLLECTOR_STREAMID_SUFFIXES;
+  static STATUSES = Object.freeze({
+    draft: 'draft',
+    active: 'active',
+    deactivated: 'deactivated'
+  });
+
   appManaging;
   streamId;
   name;
@@ -126,6 +134,76 @@ class Collector {
     this.#cache = {};
   }
 
+  /**
+   * @property {string} one of 'draft', 'active', 'deactivated'
+   */
+  get statusCode () {
+    if (this.#cache.status == null) throw new Error('Init Collector first');
+    return this.#cache.status.content.status;
+  }
+
+  /**
+   * Fetch online data
+   */
+  async init () {
+    await this.checkStreamStructure();
+    await this.getStatus();
+  }
+
+  /**
+   * @type {StatusEvent} - extends PryvEvent with a specific content
+   * @property {Object} content - content
+   * @property {String} content.status - one of 'draft', 'active', 'deactivated'
+   * @property {Data} content.data - app specific data
+   */
+
+  /**
+   * Get Collector status,
+   * @param {boolean} forceRefresh - if true, forces fetching the status from the server
+   * @returns {StatusEvent}
+   */
+  async getStatus (forceRefresh = false) {
+    if (!forceRefresh && this.#cache.status) return this.#cache.status;
+    const params = { types: ['status/collector-v1'], limit: 1, streams: [this.streamIdFor(Collector.STREAMID_SUFFIXES.internal)] };
+    const statusEvents = await this.appManaging.connection.apiOne('events.get', params, 'events');
+    if (statusEvents.length === 0) { // non exsitent set "draft" status
+      return this.setStatus(Collector.STATUSES.draft, {});
+    }
+    this.#cache.status = statusEvents[0];
+    return this.#cache.status;
+  }
+
+  /**
+   * Change the status
+   * @param {string} status one of of 'draft', 'active', 'deactivated'
+   * @param {object} data - custom data
+   * @returns {StatusEvent}
+   */
+  async setStatus (status, data) {
+    if (!Collector.STATUSES[status]) throw new HDSLibError('Unkown status key', { status, data });
+    const event = {
+      type: 'status/collector-v1',
+      streamIds: [this.streamIdFor(Collector.STREAMID_SUFFIXES.internal)],
+      content: {
+        status,
+        data
+      }
+    };
+    const statusEvent = await this.appManaging.connection.apiOne('events.create', event, 'event');
+    this.#cache.status = statusEvent;
+    return this.#cache.status;
+  }
+
+  /**
+   * Create a "pending" invite to be sent to an app usin AppSharingAccount
+   * @param {string} name a default display name for this request
+   * @param {Object} [options]
+   * @param {Object} [options.customData] any data to be used by the client app
+   */
+  async createInvite (name, options) {
+
+  }
+
   /**
    * Get sharing api endpoint
    */

src/patchedPryv.js

@@ -0,0 +1,21 @@
+/**
+ * While developping this lib some functionnalities should be
+ * added to pyv js-lib in a second step
+ */
+const pryv = require('pryv');
+
+/**
+ * Make one api Api call
+ * @param {string} method - methodId
+ * @param {object} [params] - the method associated with this result
+ * @param {string} [resultKey] - if given, returns the value or throws an error if not present
+ * @throws {Error} if .error is present the response
+ */
+pryv.Connection.prototype.apiOne = async function (method, params = {}, expectedKey) {
+  const result = await this.api([{ method, params }]);
+  if (result[0] == null || result[0].error || (expectedKey != null && result[0][expectedKey] == null)) throw new Error(`Error for api method: "${method}" with params: ${JSON.stringify(params)} >> Result: ${JSON.stringify(result)}"`);
+  if (expectedKey != null) return result[0][expectedKey];
+  return result[0];
+};
+
+module.exports = pryv;

tests/apptemplates.test.js

@@ -1,8 +1,7 @@
 /* eslint-env mocha */
 const assert = require('node:assert/strict');
-const { createUserAndPermissions } = require('./test-utils/pryvService');
+const { createUserAndPermissions, pryv } = require('./test-utils/pryvService');
 const AppManagingAccount = require('../src/appTemplates/AppManagingAccount');
-const pryv = require('pryv');
 
 describe('[APTX] appTemplates', function () {
   this.timeout(10000);
@@ -48,7 +47,7 @@ describe('[APTX] appTemplates', function () {
 
     // check StreamStructure
     const resultCheckStructure = await newCollector.checkStreamStructure();
-    assert.equal(resultCheckStructure.created.length, 5, 'Should create 5 streams');
+    assert.equal(resultCheckStructure.created.length, 6, 'Should create 5 streams');
     for (const created of resultCheckStructure.created) {
       assert.equal(created.parentId, newCollector.streamId, 'Should have collector stream as parentid');
     }
@@ -57,6 +56,24 @@ describe('[APTX] appTemplates', function () {
     const resultCheckStructure2 = await newCollector.checkStreamStructure();
     assert.equal(resultCheckStructure2.created.length, 0, 'Should create 0 streams');
 
+    // Should throw error as status is not yet set
+    try {
+      // eslint-disable-next-line no-unused-expressions
+      newCollector.statusCode;
+      throw new Error('Should throw error');
+    } catch (e) {
+      assert.equal(e.message, 'Init Collector first');
+    }
+
+    // Get status
+    const currentStatus = await newCollector.getStatus();
+    assert.equal(currentStatus.content.status, 'draft');
+    assert.equal(newCollector.statusCode, 'draft');
+
+    // Get status 2nd should retrun the same
+    const currentStatus2 = await newCollector.getStatus();
+    assert.equal(currentStatus2, currentStatus);
+
     // Sharing token creation
     const sharingApiEndpoint = await newCollector.sharingApiEndpoint();
     assert.ok(sharingApiEndpoint.startsWith('https://'));

tests/test-utils/pryvService.js

@@ -1,5 +1,5 @@
 require('./debug');
-const pryv = require('pryv');
+const pryv = require('../../src/patchedPryv');
 const superagent = pryv.utils.superagent;
 
 const ShortUniqueId = require('short-unique-id');
@@ -13,6 +13,7 @@ module.exports = {
   createUser,
   createUserAndPermissions,
   service,
+  pryv,
   config
 };