pryv 3.0.4 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pryv",
-  "version": "3.0.4",
+  "version": "3.1.0",
   "description": "Pryv JavaScript library",
   "keywords": [
     "Pryv",

package/src/Connection.js

@@ -6,6 +6,7 @@ const utils = require('./utils.js');
 const jsonParser = require('./lib/json-parser');
 const libGetEventStreamed = require('./lib/getEventStreamed');
 const PryvError = require('./lib/PryvError');
+const StaleAccessIdError = require('./lib/StaleAccessIdError');
 const buildSearchParams = require('./lib/buildSearchParams');
 
 /**
@@ -71,11 +72,22 @@ class Connection {
 
   /**
    * Get access info for this connection.
-   * It's async as it is fetched from the API.
+   *
+   * Memoized per-Connection: the first call fetches from the server and
+   * caches the result; subsequent calls return the cached copy in O(1).
+   * Pass `forceRefresh: true` to invalidate the cache and fetch a fresh
+   * copy from the server — used internally by `connection.socket` to
+   * react to Plan 66 `accessUpdated` server-push events. A failed
+   * server fetch leaves any prior cached value intact.
+   *
+   * @param {boolean} [forceRefresh=false] - bypass + refresh the cache
    * @returns {Promise<AccessInfo>} Promise resolving to the access info
    */
-  async accessInfo () {
-    return this.get('access-info', null);
+  async accessInfo (forceRefresh = false) {
+    if (!forceRefresh && this._accessInfoCache != null) return this._accessInfoCache;
+    const fresh = await this.get('access-info', null);
+    this._accessInfoCache = fresh;
+    return fresh;
   }
 
   /**
@@ -416,6 +428,48 @@ class Connection {
     return utils.buildAPIEndpoint(this);
   }
 
+  /**
+   * Plan 66 (open-pryv.io ≥ 2.0.0-pre.X): update an access by composite id.
+   * Wraps `accesses.update` and translates the 409 `stale-resource` response
+   * into a typed `StaleAccessIdError` so callers can `instanceof`-test and
+   * refetch + retry without re-parsing the inner error.
+   *
+   * Pass `id` as the wire-format reference returned by the server — bare
+   * cuid on a never-updated access, composite `<base>:<serial>` otherwise.
+   * `changes` is the body of mutable fields (name, deviceName, permissions,
+   * expireAfter, expires:null, clientData).
+   *
+   * @param {string} id
+   * @param {Object} changes
+   * @returns {Promise<Object>} the updated access (with new composite id)
+   * @throws {StaleAccessIdError} if the server reports the id is stale
+   */
+  async updateAccess (id, changes) {
+    try {
+      return await this.apiOne('accesses.update', { id, update: changes }, 'access');
+    } catch (e) {
+      if (e && e.innerObject && e.innerObject.id === 'stale-resource') {
+        throw new StaleAccessIdError(e.message, e.innerObject.data || {});
+      }
+      throw e;
+    }
+  }
+
+  /**
+   * Plan 66: fetch an access by composite id including its full version
+   * history (oldest first). Server: `accesses.getOne ?includeHistory=true`.
+   *
+   * Useful for audit views. Pass the composite `<base>:<serial>` to
+   * inspect a specific past version (the result's `current` field then
+   * points at the live head's composite id).
+   *
+   * @param {string} id
+   * @returns {Promise<{ access: Object, current?: string, history?: Object[] }>}
+   */
+  async getAccessWithHistory (id) {
+    return await this.apiOne('accesses.getOne', { id, includeHistory: true });
+  }
+
   // private method that handle meta data parsing
   _handleMeta (res, requestLocalTimestamp) {
     if (!res.meta) throw new Error('Cannot find .meta in response.');

package/src/index.d.ts

@@ -723,7 +723,12 @@ declare module 'pryv' {
       fields: string[],
       points: Array<Array<number | string>>,
     ): Promise<HFSeriesAddResult>;
-    accessInfo(): Promise<AccessInfo>;
+    /** Memoized; pass `forceRefresh: true` to bypass + refresh the cache. */
+    accessInfo(forceRefresh?: boolean): Promise<AccessInfo>;
+    /** Plan 66: update an access by composite id. */
+    updateAccess(id: string, changes: object): Promise<object>;
+    /** Plan 66: fetch an access including its full version history. */
+    getAccessWithHistory(id: string): Promise<{ access: object, current?: string, history?: object[] }>;
     revoke(throwOnFail?: boolean, usingConnection?: Connection): Promise<any>;
     readonly deltaTime: number;
     readonly apiEndpoint: string;

package/src/index.js

@@ -10,6 +10,8 @@
  * @property {pryv.Browser} Browser - Browser Tools - Access request helpers and visuals (button)
  * @property {pryv.utils} utils - Exposes some utils for HTTP calls and tools to manipulate Pryv's API endpoints
  * @property {pryv.PryvError} PryvError - Custom error class with innerObject + structured API-error fields
+ * @property {pryv.MfaRequiredError} MfaRequiredError - Thrown by Service.login when the platform returns an mfaToken instead of a token. Carries `.mfaToken`.
+ * @property {pryv.StaleAccessIdError} StaleAccessIdError - Plan 66: thrown when a Pryv.io server rejects an `accesses.update` / `accesses.delete` with a 409 stale-resource. Refetch + retry.
  * @property {Object} ERRORS - Catalogue of Pryv API error ids (mirrors open-pryv.io/components/errors)
  */
 module.exports = {
@@ -20,6 +22,7 @@ module.exports = {
   utils: require('./utils'),
   PryvError: require('./lib/PryvError'),
   MfaRequiredError: require('./lib/MfaRequiredError'),
+  StaleAccessIdError: require('./lib/StaleAccessIdError'),
   ERRORS: require('./lib/errorIds'),
   version: require('../package.json').version
 };

package/src/lib/StaleAccessIdError.js

@@ -0,0 +1,40 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+
+const PryvError = require('./PryvError');
+
+/**
+ * Plan 66: typed error surfaced when a Pryv.io server (≥ 2.0.0-pre.X)
+ * rejects an `accesses.update` or `accesses.delete` call with a
+ * 409 `stale-resource` response.
+ *
+ * The composite access id `<base>:<serial>` carries the version the
+ * caller last observed. If the access has since been updated, the
+ * server rejects the call so the caller refetches the current head
+ * (`connection.api('accesses.getOne', { id: base })`) and retries
+ * with the fresh composite id.
+ *
+ * Reach for `.data.provided` to see what the caller sent and
+ * `.data.currentSerial` to see what the server currently has.
+ *
+ * @extends PryvError
+ */
+class StaleAccessIdError extends PryvError {
+  /**
+   * @param {string} message
+   * @param {{ provided?: string, currentSerial?: number | null }} data
+   */
+  constructor (message, data) {
+    super(message);
+    this.name = 'StaleAccessIdError';
+    /** @type {{ provided?: string, currentSerial?: number | null }} */
+    this.data = data || {};
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, StaleAccessIdError);
+    }
+  }
+}
+
+module.exports = StaleAccessIdError;

package/src/utils.js

@@ -155,6 +155,56 @@ const utils = module.exports = {
     return url.replace(PRYV_REGEXP, '');
   },
 
+  /**
+   * Plan 66 (open-pryv.io ≥ 2.0.0-pre.X): parse a wire-format access
+   * reference into `{ base, serial }`. Accepts both bare cuid
+   * (`"abc123"` → `{ base: 'abc123', serial: null }`) and composite
+   * (`"abc123:3"` → `{ base: 'abc123', serial: 3 }`). Throws on
+   * malformed input. Apply this to `access.id`, `access.createdBy`,
+   * `access.modifiedBy`, and `streamIds` entries of the form
+   * `access-<base>:<serial>` from audit events.
+   * @memberof pryv.utils
+   * @param {string} ref - Access reference string
+   * @returns {{ base: string, serial: number | null }}
+   */
+  parseAccessRef: function (ref) {
+    if (typeof ref !== 'string' || ref.length === 0) {
+      throw new Error('parseAccessRef: expected a non-empty string, got ' + JSON.stringify(ref));
+    }
+    const colonIdx = ref.indexOf(':');
+    if (colonIdx === -1) return { base: ref, serial: null };
+    const base = ref.slice(0, colonIdx);
+    const tail = ref.slice(colonIdx + 1);
+    if (base.length === 0) {
+      throw new Error('parseAccessRef: empty base in ' + JSON.stringify(ref));
+    }
+    const serial = Number(tail);
+    if (!Number.isInteger(serial) || serial < 1) {
+      throw new Error('parseAccessRef: serial must be a positive integer, got ' + JSON.stringify(tail));
+    }
+    return { base, serial };
+  },
+
+  /**
+   * Plan 66: render an `{ base, serial }` pair back to the wire
+   * format. Bare cuid when serial is null/undefined; `<base>:<serial>`
+   * otherwise. Mostly used to construct the composite id when calling
+   * `connection.api()` for `accesses.update` / `accesses.delete`.
+   * @memberof pryv.utils
+   * @param {{ base: string, serial?: number | null }} ref
+   * @returns {string}
+   */
+  serializeAccessRef: function (ref) {
+    if (ref == null || typeof ref.base !== 'string' || ref.base.length === 0) {
+      throw new Error('serializeAccessRef: ref.base must be a non-empty string');
+    }
+    if (ref.serial == null) return ref.base;
+    if (!Number.isInteger(ref.serial) || ref.serial < 1) {
+      throw new Error('serializeAccessRef: serial must be a positive integer, got ' + JSON.stringify(ref.serial));
+    }
+    return ref.base + ':' + ref.serial;
+  },
+
   /**
    * Extract query parameters from a URL
    * @memberof pryv.utils

package/test/Connection.test.js

@@ -499,5 +499,31 @@ describe('[CONX] Connection', () => {
       expect(accessInfoUser.token).to.exist;
       expect(newUser.access.token).to.equal(accessInfoUser.token);
     });
+
+    // Plan 66 — accessInfo caching + forceRefresh.
+
+    it('[CAIC] accessInfo() memoizes — second call returns the same object reference', async () => {
+      const regexAPIandToken = /(.+):\/\/(.+)/gm;
+      const res = regexAPIandToken.exec(testData.apiEndpoint);
+      const apiEndpointWithToken = res[1] + '://' + newUser.access.token + '@' + res[2];
+      const cachingConn = new pryv.Connection(apiEndpointWithToken);
+      const first = await cachingConn.accessInfo();
+      const second = await cachingConn.accessInfo();
+      expect(second).to.equal(first); // same reference — served from cache
+    });
+
+    it('[CAID] accessInfo(true) forces a refresh and replaces the cached object', async () => {
+      const regexAPIandToken = /(.+):\/\/(.+)/gm;
+      const res = regexAPIandToken.exec(testData.apiEndpoint);
+      const apiEndpointWithToken = res[1] + '://' + newUser.access.token + '@' + res[2];
+      const cachingConn = new pryv.Connection(apiEndpointWithToken);
+      const first = await cachingConn.accessInfo();
+      const refreshed = await cachingConn.accessInfo(true);
+      expect(refreshed).to.not.equal(first); // distinct object — re-fetched
+      expect(refreshed.token).to.equal(first.token); // same content
+      // Next non-forced call returns the refreshed copy from cache.
+      const cached = await cachingConn.accessInfo();
+      expect(cached).to.equal(refreshed);
+    });
   });
 });

package/test/utils.test.js

@@ -59,4 +59,48 @@ describe('[UTLX] utils', function () {
     expect(apiEndpoint).to.equal(testData.apiEndpoint);
     done();
   });
+
+  // Plan 66 — composite access references.
+
+  it('[UTLF] parseAccessRef on a bare cuid returns { base, serial: null }', function () {
+    const ref = pryv.utils.parseAccessRef('abc123def456');
+    expect(ref).to.eql({ base: 'abc123def456', serial: null });
+  });
+
+  it('[UTLG] parseAccessRef on a composite returns { base, serial }', function () {
+    const ref = pryv.utils.parseAccessRef('abc123:7');
+    expect(ref).to.eql({ base: 'abc123', serial: 7 });
+  });
+
+  it('[UTLH] parseAccessRef on garbage throws', function () {
+    expect(() => pryv.utils.parseAccessRef('')).to.throw();
+    expect(() => pryv.utils.parseAccessRef(':1')).to.throw();
+    expect(() => pryv.utils.parseAccessRef('abc:notanumber')).to.throw();
+    expect(() => pryv.utils.parseAccessRef('abc:0')).to.throw();
+    expect(() => pryv.utils.parseAccessRef('abc:-1')).to.throw();
+    expect(() => pryv.utils.parseAccessRef(null)).to.throw();
+  });
+
+  it('[UTLI] serializeAccessRef round-trips parseAccessRef', function () {
+    const samples = ['plainCuid', 'plainCuid:1', 'plainCuid:42'];
+    for (const s of samples) {
+      expect(pryv.utils.serializeAccessRef(pryv.utils.parseAccessRef(s))).to.equal(s);
+    }
+  });
+
+  it('[UTLJ] serializeAccessRef rejects bad inputs', function () {
+    expect(() => pryv.utils.serializeAccessRef(null)).to.throw();
+    expect(() => pryv.utils.serializeAccessRef({ base: '' })).to.throw();
+    expect(() => pryv.utils.serializeAccessRef({ base: 'abc', serial: 0 })).to.throw();
+    expect(() => pryv.utils.serializeAccessRef({ base: 'abc', serial: 1.5 })).to.throw();
+  });
+
+  it('[UTLK] StaleAccessIdError extends PryvError', function () {
+    const err = new pryv.StaleAccessIdError('stale!', { provided: 'abc:1', currentSerial: 2 });
+    expect(err).to.be.instanceOf(pryv.StaleAccessIdError);
+    expect(err).to.be.instanceOf(pryv.PryvError);
+    expect(err.data.provided).to.equal('abc:1');
+    expect(err.data.currentSerial).to.equal(2);
+    expect(err.name).to.equal('StaleAccessIdError');
+  });
 });