Rest api url builder

Author: bartoszkubicki

.gitignore

@@ -0,0 +1 @@
+.idea

CHANGELOG.md

@@ -0,0 +1,3 @@
+1.0.0
+* module initialization
+* rest api js url builder

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bartosz Kubicki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,42 @@
+# BKubicki Magento 2 Ui #
+
+
+## Overview ##
+Module extending module Magento_Ui and adding new components and utils
+
+
+## Features ## 
+* rest api js url builder
+
+
+## Prerequisites
+* Magento 2.3/2.4+
+* PHP 7.3/7.4
+
+
+## Installation ###
+
+To install the extension use the following commands:
+
+```bash
+ composer require bkubicki/module-magento2-ui
+```
+
+## Versioning ##
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/bartoszkubicki/magento2-polish-noun-numeral-declension-adapter/tags).
+
+
+## Changelog
+
+See changelog [here](CHANGELOG.md).
+
+
+## Authors ##
+
+* [Bartosz Kubicki](https://github.com/bartoszkubicki)
+
+
+## License ##
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.

composer.json

@@ -0,0 +1,20 @@
+{
+  "name": "bkubicki/module-magento2-ui",
+  "description": "Module extending module Magento_Ui and adding new components and utils",
+  "require": {
+    "php": "~7.2.0||~7.3.0||~7.4.0",
+    "magento/framework": "102.0.*||103.0.*",
+    "magento/module-ui": ">=101.0.0"
+  },
+  "type": "magento2-module",
+  "version": "1.0.0",
+  "license": "MIT",
+  "autoload": {
+    "files": [
+      "registration.php"
+    ],
+    "psr-4": {
+      "BKubicki\\Magento2Ui\\": ""
+    }
+  }
+}

etc/module.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * @author Bartosz Kubicki <b.w.kubicki@gmail.com>
+ * Github https://github.com/bartoszkubicki
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
+    <module name="BKubicki_Magento2Ui">
+        <sequence>
+            <module name="Magento_Ui"/>
+        </sequence>
+    </module>
+</config>

registration.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * File: registration.php
+ *
+ * @author Bartosz Kubicki b.w.kubicki@gmail.com>
+ * Github: https://github.com/bartoszkubicki
+ */
+use Magento\Framework\Component\ComponentRegistrar;
+
+ComponentRegistrar::register(
+    ComponentRegistrar::MODULE,
+    'BKubicki_Magento2Ui',
+    __DIR__
+);

view/base/web/js/action/rest-api-url-builder.js

@@ -0,0 +1,54 @@
+/**
+ * File: rest-api-url-builder.js
+ *
+ * @author Bartosz Kubicki b.w.kubicki@gmail.com>
+ * Github: https://github.com/bartoszkubicki
+ */
+
+'use strict';
+
+define([], function () {
+    return {
+        method: 'rest',
+        version: 'V1',
+        serviceUrl: ':method/:storeCode/:version',
+
+        /**
+         * @param {String} url
+         * @param {String} storeCode
+         * @param {Object} params
+         * @return {String}
+         */
+        createUrl: function (url, storeCode, params) {
+            let completeUrl = this.serviceUrl + url;
+            return this.bindParams(completeUrl, storeCode, params);
+        },
+
+        /**
+         * @param {String} url
+         * @param {String} storeCode
+         * @param {Object} params
+         * @return {String}
+         */
+        bindParams: function (url, storeCode, params) {
+            let urlParts;
+
+            params.method = String(this.method);
+            params.storeCode = String(storeCode);
+            params.version = String(this.version);
+
+            urlParts = url.split('/');
+            urlParts = urlParts.filter(Boolean);
+
+            urlParts.forEach(function (part, key) {
+                part = part.replace(':', '');
+
+                if (params[part] !== undefined) { //eslint-disable-line eqeqeq
+                    urlParts[key] = params[part];
+                }
+            });
+
+            return urlParts.join('/');
+        }
+    };
+});