pryv 3.1.0 → 3.3.0

package/README.md

@@ -57,6 +57,7 @@ Other distributions available:
 
 - Socket.IO: [NPM package](https://www.npmjs.com/package/@pryv/socket.io), [README](https://github.com/pryv/lib-js/tree/master/components/pryv-socket.io#readme)
 - Monitor: [NPM package](https://www.npmjs.com/package/@pryv/monitor), [README](https://github.com/pryv/lib-js/tree/master/components/pryv-monitor#readme)
+- CMC (Cross-account Messaging & Consent) client helpers: [NPM package](https://www.npmjs.com/package/@pryv/cmc), [README](https://github.com/pryv/lib-js/tree/master/components/pryv-cmc#readme)
 
 
 ### Quick example
@@ -677,6 +678,7 @@ The project is structured as a monorepo with components (a.k.a. workspaces in NP
 - `pryv`: the library
 - `pryv-socket.io`: Socket.IO add-on
 - `pryv-monitor`: Monitor add-on
+- `pryv-cmc`: CMC (Cross-account Messaging & Consent) client helpers
 
 
 

package/package.json

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

package/src/index.d.ts

@@ -1069,10 +1069,24 @@ declare module 'pryv' {
     token: string | null;
   };
 
+  /**
+   * Decomposed form of an APIEndpoint, returned by
+   * `pryv.utils.decomposeAPIEndpoint`. `host` is the canonical platform
+   * host (no `<username>.` subdomain prefix in subdomain-style
+   * deployments) — the same identity cross-account features (CMC
+   * counterparty slugs, etc.) key on.
+   */
+  export type DecomposedAPIEndpoint = {
+    token: string | null;
+    username: string | null;
+    host: string;
+  };
+
   export const utils: {
     isBrowser(): boolean;
     extractTokenAndAPIEndpoint(apiEndpoint: string): TokenAndAPIEndpoint;
     buildAPIEndpoint(tokenAndAPI: TokenAndAPIEndpoint): string;
+    decomposeAPIEndpoint(apiEndpoint: string, serviceInfoApi: string): DecomposedAPIEndpoint;
     browserIsMobileOrTablet(navigator?: string | Navigator): boolean;
     cleanURLFromPrYvParams(url: string): string;
     getQueryParamsFromURL(url: string): KeyValue;
@@ -1107,6 +1121,7 @@ declare module 'pryv' {
       isBrowser(): boolean;
       extractTokenAndAPIEndpoint(apiEndpoint: string): TokenAndAPIEndpoint;
       buildAPIEndpoint(tokenAndAPI: TokenAndAPIEndpoint): string;
+      decomposeAPIEndpoint(apiEndpoint: string, serviceInfoApi: string): DecomposedAPIEndpoint;
       browserIsMobileOrTablet(navigator?: string | Navigator): boolean;
       cleanURLFromPrYvParams(url: string): string;
       getQueryParamsFromURL(url: string): KeyValue;

package/src/utils.js

@@ -127,6 +127,76 @@ const utils = module.exports = {
     return res[1] + '://' + tokenAndAPI.token + '@' + res[2];
   },
 
+  /**
+   * Decompose a Pryv apiEndpoint into `{ token, username, host }` using
+   * the platform's `service.info.api` URL template to invert whichever
+   * username placement the platform uses (subdomain vs path-style).
+   *
+   * Pryv apiEndpoints follow one of two URL shapes (the difference is
+   * platform-defined, encoded in `service.info.api`):
+   *
+   *   subdomain  template `https://{username}.<domain>/`
+   *              endpoint `https://<token>@<username>.<domain>/`
+   *   path-style template `https://<host>/{username}/`
+   *              endpoint `https://<token>@<host>/<username>/`
+   *
+   * Returns the **canonical platform host** (no `<username>.` subdomain
+   * prefix in subdomain mode) — the identity cross-account features
+   * (e.g. CMC counterparty slugs) key on, regardless of which user the
+   * endpoint belongs to.
+   *
+   * `token` and `username` are null when the endpoint carries no token /
+   * when the endpoint shape doesn't match the template; `host` is
+   * best-effort in that case.
+   *
+   * @memberof pryv.utils
+   * @param {APIEndpoint} apiEndpoint  e.g. 'https://t0k3n@alice.pryv.me/'
+   * @param {string} serviceInfoApi    e.g. 'https://{username}.pryv.me/'
+   *                                   from /service/info → field `api`.
+   * @returns {DecomposedAPIEndpoint}
+   *
+   * @example
+   *   const conn = new pryv.Connection(apiEndpoint);
+   *   const info = await conn.service.info();
+   *   const me = pryv.utils.decomposeAPIEndpoint(apiEndpoint, info.api);
+   *   // → { token: 't0k3n', username: 'alice', host: 'pryv.me' }
+   */
+  decomposeAPIEndpoint: function (apiEndpoint, serviceInfoApi) {
+    const { token, endpoint } = utils.extractTokenAndAPIEndpoint(apiEndpoint);
+    const tplIdx = serviceInfoApi.indexOf('{username}');
+    if (tplIdx < 0) {
+      // Template doesn't carry {username} — operator-defined, can't decompose.
+      let host = '';
+      try { host = new URL(endpoint).host; } catch (_e) {}
+      return { token, username: null, host };
+    }
+    const tplPrefix = serviceInfoApi.slice(0, tplIdx);
+    const tplSuffix = serviceInfoApi.slice(tplIdx + '{username}'.length);
+    if (!endpoint.startsWith(tplPrefix) || !endpoint.endsWith(tplSuffix)) {
+      let host = '';
+      try { host = new URL(endpoint).host; } catch (_e) {}
+      return { token, username: null, host };
+    }
+    const username = endpoint.slice(tplPrefix.length, endpoint.length - tplSuffix.length);
+    // Disambiguate by where {username} sits in the template:
+    //   - subdomain  → prefix ends with `://` (username right after scheme)
+    //   - path-style → prefix has more after `://` (host already in prefix)
+    const isSubdomainTemplate = /:\/\/$/.test(tplPrefix);
+    let host;
+    if (isSubdomainTemplate) {
+      // tplSuffix starts with the domain (e.g. '.pryv.me/')
+      host = tplSuffix.replace(/^\.+/, '').replace(/\/+$/, '');
+    } else {
+      // path-style — host is in the prefix's URL
+      try {
+        host = new URL(tplPrefix).host;
+      } catch (_e) {
+        host = '';
+      }
+    }
+    return { token, username, host };
+  },
+
   /**
    * Check if the browser is running on a mobile device or tablet
    * @memberof pryv.utils
@@ -251,6 +321,18 @@ utils.buildPryvApiEndpoint = utils.buildAPIEndpoint;
  * @typedef {string} APIEndpoint
  */
 
+/**
+ * Decomposed form of an APIEndpoint, returned by `decomposeAPIEndpoint`.
+ * `token` and `username` are `null` when the endpoint doesn't carry a
+ * token / doesn't match the `service.info.api` template. `host` is the
+ * canonical platform host (no `<username>.` subdomain prefix in
+ * subdomain-style deployments).
+ * @typedef {Object} DecomposedAPIEndpoint
+ * @property {string|null} token
+ * @property {string|null} username
+ * @property {string} host
+ */
+
 /**
  * Common Meta are returned by each standard call on the API https://api.pryv.com/reference/#in-method-results
  * @typedef {Object} CommonMeta

package/test/utils.test.js

@@ -103,4 +103,41 @@ describe('[UTLX] utils', function () {
     expect(err.data.currentSerial).to.equal(2);
     expect(err.name).to.equal('StaleAccessIdError');
   });
+
+  describe('[UTLM] decomposeAPIEndpoint', function () {
+    it('[UTLMA] subdomain template — host strips the {username}. prefix', function () {
+      const r = pryv.utils.decomposeAPIEndpoint(
+        'https://t0k3n@alice.pryv.me/',
+        'https://{username}.pryv.me/'
+      );
+      expect(r).to.eql({ token: 't0k3n', username: 'alice', host: 'pryv.me' });
+    });
+
+    it('[UTLMB] path-style template — host is the literal hostname[:port]', function () {
+      const r = pryv.utils.decomposeAPIEndpoint(
+        'http://t0k3n@127.0.0.1:3000/alice/',
+        'http://127.0.0.1:3000/{username}/'
+      );
+      expect(r).to.eql({ token: 't0k3n', username: 'alice', host: '127.0.0.1:3000' });
+    });
+
+    it('[UTLMC] returns username:null when the endpoint doesn\'t match the template', function () {
+      const r = pryv.utils.decomposeAPIEndpoint(
+        'https://t0k3n@somewhere.else.com/',
+        'https://{username}.pryv.me/'
+      );
+      expect(r.username).to.equal(null);
+      expect(r.token).to.equal('t0k3n');
+    });
+
+    it('[UTLMD] returns token:null when endpoint carries no token', function () {
+      const r = pryv.utils.decomposeAPIEndpoint(
+        'https://alice.pryv.me/',
+        'https://{username}.pryv.me/'
+      );
+      expect(r.token).to.equal(null);
+      expect(r.username).to.equal('alice');
+      expect(r.host).to.equal('pryv.me');
+    });
+  });
 });