cozy-client 32.4.1 → 32.7.0

package/dist/CozyClient.js

@@ -2571,7 +2571,7 @@ var CozyClient = /*#__PURE__*/function () {
 CozyClient.hooks = CozyClient.hooks || {};
 CozyClient.fetchPolicies = _policies.default; //COZY_CLIENT_VERSION_PACKAGE in replaced by babel. See babel config
 
-CozyClient.version = "32.4.1";
+CozyClient.version = "32.7.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/helpers.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.rootCozyUrl = exports.InvalidCozyUrlError = exports.InvalidProtocolError = exports.generateWebLink = exports.dehydrate = void 0;
+exports.rootCozyUrl = exports.InvalidCozyUrlError = exports.InvalidProtocolError = exports.deconstructCozyWebLinkWithSlug = exports.generateWebLink = exports.dehydrate = void 0;
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
@@ -29,6 +29,8 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 
 var _associations = require("./associations");
 
+var _types = require("./types");
+
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
@@ -124,9 +126,38 @@ var generateWebLink = function generateWebLink(_ref3) {
 
   return url.toString();
 };
+/**
+ * Deconstruct the given link in order to retrieve useful data like Cozy's name, domain, or slug
+ *
+ * The given link MUST contain a slug
+ *
+ * @param {string} webLink - link to deconstruct. It should be a link from a Cozy and containing a slug
+ * @param {SubdomainType} [subDomainType=flat] - whether the cozy is using flat or nested subdomains.
+ * @returns {CozyLinkData} Deconstructed link
+ */
+
 
 exports.generateWebLink = generateWebLink;
 
+var deconstructCozyWebLinkWithSlug = function deconstructCozyWebLinkWithSlug(webLink) {
+  var subDomainType = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'flat';
+  var url = new URL(webLink);
+  var slug = subDomainType === 'nested' ? url.host.split('.')[0] : url.host.split('.')[0].split('-')[1];
+  var cozyName = subDomainType === 'nested' ? url.host.split('.')[1] : url.host.split('.')[0].split('-')[0];
+  var cozyBaseDomain = url.host.split('.').slice(subDomainType === 'nested' ? 2 : 1).join('.');
+  return {
+    cozyBaseDomain: cozyBaseDomain,
+    cozyName: cozyName,
+    pathname: url.pathname,
+    hash: url.hash,
+    protocol: url.protocol,
+    searchParams: url.searchParams.toString(),
+    slug: slug
+  };
+};
+
+exports.deconstructCozyWebLinkWithSlug = deconstructCozyWebLinkWithSlug;
+
 var InvalidProtocolError = /*#__PURE__*/function (_Error) {
   (0, _inherits2.default)(InvalidProtocolError, _Error);
 

package/dist/helpers.spec.js

@@ -1,6 +1,7 @@
 import { enableFetchMocks, disableFetchMocks } from 'jest-fetch-mock'
 
 import {
+  deconstructCozyWebLinkWithSlug,
   dehydrate,
   generateWebLink,
   rootCozyUrl,
@@ -150,6 +151,83 @@ describe('generateWebLink', () => {
   })
 })
 
+describe('deconstructWebLink', () => {
+  it.each([
+    [
+      'https://claude-notes.mycozy.cloud',
+      'flat',
+      {
+        protocol: 'https:',
+        cozyName: 'claude',
+        cozyBaseDomain: 'mycozy.cloud',
+        pathname: '/',
+        hash: '',
+        searchParams: '',
+        slug: 'notes'
+      }
+    ],
+    [
+      'http://alice-drive.cozy.tools:8080',
+      'flat',
+      {
+        protocol: 'http:',
+        cozyName: 'alice',
+        cozyBaseDomain: 'cozy.tools:8080',
+        pathname: '/',
+        hash: '',
+        searchParams: '',
+        slug: 'drive'
+      }
+    ],
+    [
+      'https://photo.claude.custome-domain.fr',
+      'nested',
+      {
+        protocol: 'https:',
+        cozyName: 'claude',
+        cozyBaseDomain: 'custome-domain.fr',
+        pathname: '/',
+        hash: '',
+        searchParams: '',
+        slug: 'photo'
+      }
+    ],
+    [
+      'http://drive.cozy.tools:8080/#/folder/SOME_FOLDER_ID',
+      'nested',
+      {
+        protocol: 'http:',
+        cozyName: 'cozy',
+        cozyBaseDomain: 'tools:8080',
+        pathname: '/',
+        hash: '#/folder/SOME_FOLDER_ID',
+        searchParams: '',
+        slug: 'drive'
+      }
+    ],
+    [
+      'http://notes.cozy.tools:8080/public/?id=SOME_FOLDER_ID&sharecode=SOME_SHARECODE',
+      'nested',
+      {
+        protocol: 'http:',
+        cozyName: 'cozy',
+        cozyBaseDomain: 'tools:8080',
+        pathname: '/public/',
+        hash: '',
+        searchParams: 'id=SOME_FOLDER_ID&sharecode=SOME_SHARECODE',
+        slug: 'notes'
+      }
+    ]
+  ])(
+    'should deconstruct %p link with %p subdomain type',
+    (link, subdomainType, result) => {
+      expect(deconstructCozyWebLinkWithSlug(link, subdomainType)).toEqual(
+        result
+      )
+    }
+  )
+})
+
 describe('rootCozyUrl', () => {
   beforeAll(() => {
     enableFetchMocks()

package/dist/index.js

@@ -26,6 +26,7 @@ var _exportNames = {
   isReferencedById: true,
   getReferencedBy: true,
   getReferencedById: true,
+  deconstructCozyWebLinkWithSlug: true,
   dehydrate: true,
   generateWebLink: true,
   rootCozyUrl: true,
@@ -163,6 +164,12 @@ Object.defineProperty(exports, "getReferencedById", {
     return _helpers.getReferencedById;
   }
 });
+Object.defineProperty(exports, "deconstructCozyWebLinkWithSlug", {
+  enumerable: true,
+  get: function get() {
+    return _helpers2.deconstructCozyWebLinkWithSlug;
+  }
+});
 Object.defineProperty(exports, "dehydrate", {
   enumerable: true,
   get: function get() {

package/dist/types.js

@@ -388,5 +388,27 @@ var _dsl = require("./queries/dsl");
  * @property {string} [codeVerifier]
  * @property {string} [codeChallenge]
  */
+
+/**
+ * Subdomain type for a Cozy. Can be flat or nested subdomains
+ *
+ * Example of 'flat' domain: https://claude-notes.somedomain.fr
+ * Example of 'nested' domain: https://notes.claude.somedomain.fr
+ *
+ * @typedef {'flat'|'nested'} SubdomainType
+ */
+
+/**
+ * Represents the different parts of a deconstructed Cozy link
+ *
+ * @typedef {object} CozyLinkData
+ * @property {string} cozyBaseDomain - The Cozy's domain (i.e. 'mycozy.cloud')
+ * @property {string} cozyName - The Cozy's name (i.e. 'claude')
+ * @property {string} [hash] - The link's path (i.e. '#/folder/SOME_FOLDER_ID')
+ * @property {string} [pathname] - The link's path (i.e. '/public/')
+ * @property {string} protocol - The link's protocol (i.e. 'https')
+ * @property {string} [searchParams] - The link's searchParams (i.e. 'id=SOME_FOLDER_ID&sharecode=SOME_SHARECODE')
+ * @property {string} slug - The link's slug (i.e. 'drive' or 'notes)
+ */
 var _default = {};
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "32.4.1",
+  "version": "32.7.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -18,7 +18,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
-    "cozy-stack-client": "^32.3.3",
+    "cozy-stack-client": "^32.7.0",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "ff39c11d425e4fbc6e30c7bee4578581a7cfce00"
+  "gitHead": "5a537132658593452f3f47fdb517e902a041ad5b"
 }

package/types/helpers.d.ts

@@ -7,6 +7,7 @@ export function generateWebLink({ cozyUrl, searchParams: searchParamsOption, pat
     slug: string;
     subDomainType: string;
 }): string;
+export function deconstructCozyWebLinkWithSlug(webLink: string, subDomainType?: SubdomainType): CozyLinkData;
 export class InvalidProtocolError extends Error {
     constructor(url: any);
     url: any;
@@ -16,3 +17,5 @@ export class InvalidCozyUrlError extends Error {
     url: any;
 }
 export function rootCozyUrl(url: URL): Promise<URL>;
+import { SubdomainType } from "./types";
+import { CozyLinkData } from "./types";

package/types/index.d.ts

@@ -19,6 +19,6 @@ export { manifest, models };
 export { QueryDefinition, Q, Mutations, MutationTypes, getDoctypeFromOperation } from "./queries/dsl";
 export { Association, HasMany, HasOne, HasOneInPlace, HasManyInPlace, HasManyTriggers } from "./associations";
 export { isReferencedBy, isReferencedById, getReferencedBy, getReferencedById } from "./associations/helpers";
-export { dehydrate, generateWebLink, rootCozyUrl, InvalidCozyUrlError, InvalidProtocolError } from "./helpers";
+export { deconstructCozyWebLinkWithSlug, dehydrate, generateWebLink, rootCozyUrl, InvalidCozyUrlError, InvalidProtocolError } from "./helpers";
 export { cancelable, isQueryLoading, hasQueryBeenLoaded } from "./utils";
 export { queryConnect, queryConnectFlat, withClient } from "./hoc";

package/types/types.d.ts

@@ -482,4 +482,44 @@ export type PKCECodes = {
     codeVerifier?: string;
     codeChallenge?: string;
 };
+/**
+ * Subdomain type for a Cozy. Can be flat or nested subdomains
+ *
+ * Example of 'flat' domain: https://claude-notes.somedomain.fr
+ * Example of 'nested' domain: https://notes.claude.somedomain.fr
+ */
+export type SubdomainType = "flat" | "nested";
+/**
+ * Represents the different parts of a deconstructed Cozy link
+ */
+export type CozyLinkData = {
+    /**
+     * - The Cozy's domain (i.e. 'mycozy.cloud')
+     */
+    cozyBaseDomain: string;
+    /**
+     * - The Cozy's name (i.e. 'claude')
+     */
+    cozyName: string;
+    /**
+     * - The link's path (i.e. '#/folder/SOME_FOLDER_ID')
+     */
+    hash?: string;
+    /**
+     * - The link's path (i.e. '/public/')
+     */
+    pathname?: string;
+    /**
+     * - The link's protocol (i.e. 'https')
+     */
+    protocol: string;
+    /**
+     * - The link's searchParams (i.e. 'id=SOME_FOLDER_ID&sharecode=SOME_SHARECODE')
+     */
+    searchParams?: string;
+    /**
+     * - The link's slug (i.e. 'drive' or 'notes)
+     */
+    slug: string;
+};
 import { QueryDefinition } from "./queries/dsl";