@ovh-ux/url-builder 1.3.0-alpha.0

package/CHANGELOG.md

@@ -0,0 +1,66 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [1.3.0-alpha.0](https://github.com/ovh/manager/compare/@ovh-ux/url-builder@1.2.0...@ovh-ux/url-builder@1.3.0-alpha.0) (2024-10-24)
+
+
+### Features
+
+* **manager-react-components:** build manager react components lib ([3ffbfea](https://github.com/ovh/manager/commit/3ffbfeac1e0364917ae6c93f90b392bd1ee6603c))
+
+
+
+
+
+# [1.2.0](https://github.com/ovh/manager/compare/@ovh-ux/url-builder@1.1.1...@ovh-ux/url-builder@1.2.0) (2024-08-08)
+
+
+### Features
+
+* clean dependencies versions of react apps ([7969ba7](https://github.com/ovh/manager/commit/7969ba70f9e03033271a48a5bd0021484ea36263))
+
+
+
+
+
+## [1.1.1](https://github.com/ovh/manager/compare/@ovh-ux/url-builder@1.1.0...@ovh-ux/url-builder@1.1.1) (2023-01-30)
+
+
+### Bug Fixes
+
+* **url-builder:** add tests ([45afbb6](https://github.com/ovh/manager/commit/45afbb6bea0a0877c4f5b7652d59a7bbbaff3cca))
+
+
+
+
+
+# [1.1.0](https://github.com/ovh/manager/compare/@ovh-ux/url-builder@1.0.0...@ovh-ux/url-builder@1.1.0) (2022-11-29)
+
+
+### Bug Fixes
+
+* **config:** remove unnecessary module resolutions ([e60d83c](https://github.com/ovh/manager/commit/e60d83c343cc15c2f306c1a748c3c06dfa573608))
+* **ts:** fix ts import errors ([58ad060](https://github.com/ovh/manager/commit/58ad060b9d4b6f9634268b5cf4bde98301bbbc98))
+
+
+### Features
+
+* **chakra:** add chakra theme and components ([a4ce7ad](https://github.com/ovh/manager/commit/a4ce7adc01f59dcea9d0add60cc6c3ed225c13de))
+
+
+
+
+
+# [1.0.0](https://github.com/ovh/manager/compare/@ovh-ux/url-builder@0.0.0...@ovh-ux/url-builder@1.0.0) (2022-09-12)
+
+
+### Features
+
+* **url-builder:** add @ovh-ux/url-builder package ([0ef6d33](https://github.com/ovh/manager/commit/0ef6d339eec41b76523b365db4a9328f7bf0fac8))
+
+
+### BREAKING CHANGES
+
+* **url-builder:** init @ovh-ux/url-builder package

package/README.md

@@ -0,0 +1,64 @@
+# URL Builder
+
+> OVHcloud manager URL Builder
+
+## Installation
+
+```sh
+yarn add @ovh-ux/url-builder
+```
+
+## Usage
+
+URL builder is here to help us to build links between applications.
+When you want to build an URL for an outside application, you will use `url-builder` to build the URL.
+
+### Examples
+
+Build the URL that redirect to `#/catalog` state from the `https://www.ovh.com/manager/` base URL with query parameter (`expand`)
+
+```ts
+import { buildURL } from '@ovh-ux/url-builder';
+
+const url = buildURL('https://www.ovh.com/manager/', '#/catalog', {
+  expand: true,
+});
+// use `url`;
+```
+
+Build multiples routes using an array of `{baseURL, path, params}`
+
+```ts
+import { buildURLs } from '@ovh-ux/url-builder';
+
+const [dashboard, catalog] = buildURLs([
+  {
+    baseURL: 'https://www.ovh.com/manager/',
+    path: '#/',
+    params: { expand: true },
+  },
+  { baseURL: 'https://www.ovh.com/manager/', path: '#/catalog' },
+]);
+// use `dashboard` and `catalog` URLs
+```
+
+Build multiples routes using an object of `{baseURL, path, params}`
+
+```ts
+import { buildURLs } from '@ovh-ux/url-builder';
+
+const { dashboard, catalog } = buildURLs({
+  dashboard: {
+    baseURL: 'https://www.ovh.com/manager/',
+    path: '#/',
+    params: { expand: true },
+  },
+  catalog: { baseURL: 'https://www.ovh.com/manager/', path: '#/catalog' },
+  emailDomainProducts: {
+    baseURL: 'https://www.ovh.com/manager/',
+    path: '#/:product',
+    params: { product: 'email_domain' },
+  },
+});
+// use `dashboard` and `catalog` URLs
+```

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './url-builder';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './url-builder';

package/dist/types/url-builder.d.ts

@@ -0,0 +1,9 @@
+export interface OvhURL {
+    baseURL: string;
+    path: string;
+    params: Record<string, ParamValueType>;
+}
+export type ParamValueType = string | number | boolean;
+export declare const buildURL: (baseURL: string, path: string, params: Record<string, ParamValueType>) => string;
+export declare function buildURLs(routes: Array<OvhURL>): Array<OvhURL>;
+export declare function buildURLs(routes: Record<string, OvhURL>): Record<string, OvhURL>;

package/dist/url-builder.js

@@ -0,0 +1,51 @@
+const buildURLPattern = (pattern, params) => {
+    let url = pattern;
+    let filteredParams = params;
+    if (pattern.includes(':') && params) {
+        const PARAM_REGEXP = /:(\w+)/g;
+        const urlParamTemplates = [...pattern.matchAll(PARAM_REGEXP)].map(([, name]) => name);
+        urlParamTemplates.forEach((urlParam) => {
+            if (params[urlParam]) {
+                url = url.replace(`:${urlParam}`, encodeURIComponent(params[urlParam]));
+            }
+        });
+        filteredParams = Object.keys(params).reduce((queryParams, paramName) => {
+            if (!urlParamTemplates.includes(paramName)) {
+                return Object.assign(Object.assign({}, queryParams), { [paramName]: params[paramName] });
+            }
+            return queryParams;
+        }, {});
+    }
+    return { url, params: filteredParams };
+};
+const buildQueryString = (data) => Object.keys(data)
+    .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(data[key])}`)
+    .join('&');
+export const buildURL = (baseURL, path, params) => {
+    const urlPattern = buildURLPattern(path, params);
+    let { url: buildedPath } = urlPattern;
+    const { params: queryObject } = urlPattern;
+    if (baseURL.includes('#') && buildedPath.includes('#')) {
+        buildedPath = buildedPath.replace('#', '');
+    }
+    if (baseURL.endsWith('/') && buildedPath.startsWith('/')) {
+        buildedPath = buildedPath.substring(1);
+    }
+    let queryString = queryObject ? buildQueryString(queryObject) : '';
+    if (queryString) {
+        queryString = buildedPath.includes('?')
+            ? `&${queryString}`
+            : `?${queryString}`;
+    }
+    return `${baseURL}${buildedPath}${queryString}`;
+};
+export function buildURLs(routes) {
+    if (Array.isArray(routes)) {
+        return routes.map(({ baseURL, path, params }) => buildURL(baseURL, path, params));
+    }
+    return Object.keys(routes).reduce((result, name) => {
+        const { baseURL, path, params } = routes[name];
+        return Object.assign(Object.assign({}, result), { [name]: buildURL(baseURL, path, params) });
+    }, {});
+}
+//# sourceMappingURL=url-builder.js.map

package/dist/url-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-builder.js","sourceRoot":"","sources":["../src/url-builder.ts"],"names":[],"mappings":"AAOA,MAAM,eAAe,GAAG,CACtB,OAAe,EACf,MAAsC,EACtC,EAAE;IACF,IAAI,GAAG,GAAG,OAAO,CAAC;IAClB,IAAI,cAAc,GAAG,MAAM,CAAC;IAE5B,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,MAAM,EAAE,CAAC;QACpC,MAAM,YAAY,GAAG,SAAS,CAAC;QAE/B,MAAM,iBAAiB,GAAG,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAC/D,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CACnB,CAAC;QAEF,iBAAiB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACrC,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrB,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,QAAQ,EAAE,EAAE,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,EAAE;YACrE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3C,uCACK,WAAW,KACd,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,IAC9B;YACJ,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,IAAoC,EAAE,EAAE,CAChE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;KACd,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;KAC3E,IAAI,CAAC,GAAG,CAAC,CAAC;AAEf,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,OAAe,EACf,IAAY,EACZ,MAAsC,EAC9B,EAAE;IACV,MAAM,UAAU,GAAG,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACjD,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;IACtC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;IAE3C,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvD,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACzD,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACnE,IAAI,WAAW,EAAE,CAAC;QAChB,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC;YACrC,CAAC,CAAC,IAAI,WAAW,EAAE;YACnB,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC;IACxB,CAAC;IAED,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC;AAClD,CAAC,CAAC;AAMF,MAAM,UAAU,SAAS,CAAC,MAA8C;IACtE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAC9C,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,CAChC,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;QACjD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/C,uCACK,MAAM,KACT,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IACvC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@ovh-ux/url-builder",
+  "version": "1.3.0-alpha.0",
+  "description": "OVHcloud control panel URL Builder",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ovh/manager.git",
+    "directory": "packages/manager/core/url-builder"
+  },
+  "license": "BSD-3-Clause",
+  "author": "OVH SAS",
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc",
+    "dev:watch": "tsc -w",
+    "prepare": "tsc",
+    "start": "lerna exec --stream --scope='@ovh-ux/url-builder' --include-dependencies -- yarn run build",
+    "start:dev": "lerna exec --stream --scope='@ovh-ux/url-builder' --include-dependencies -- yarn run dev",
+    "start:watch": "lerna exec --stream --parallel --scope='@ovh-ux/url-builder' --include-dependencies -- yarn run dev:watch"
+  },
+  "devDependencies": {
+    "typescript": "^5.1.6"
+  }
+}