@fleetbase/ember-core 0.2.17 → 0.2.19

package/addon/services/url-search-params.js

@@ -1,35 +1,35 @@
 import Service from '@ember/service';
-import { tracked } from '@glimmer/tracking';
+import { debounce } from '@ember/runloop';
 import hasJsonStructure from '../utils/has-json-structure';
 
+/**
+ * Service for manipulating URL search parameters.
+ *
+ * This service provides methods to get, set, remove, and check URL query parameters.
+ * It also allows updating the browser's URL without reloading the page.
+ *
+ * @extends Service
+ */
 export default class UrlSearchParamsService extends Service {
     /**
-     * The active URL params
+     * Getter for `urlParams` that ensures it's always up-to-date with the current URL.
      *
-     * @var {Array}
+     * @type {URLSearchParams}
+     * @private
      */
-    @tracked urlParams;
-
-    /**
-     * Update the URL params
-     *
-     * @void
-     */
-    setSearchParams() {
-        this.urlParams = new URLSearchParams(window.location.search);
-
-        return this;
+    get urlParams() {
+        return new URLSearchParams(window.location.search);
     }
 
     /**
-     * Get a param
+     * Retrieves the value of a specific query parameter.
      *
-     * @param {String} key the url param
-     * @return mixed
+     * If the parameter value is a JSON string, it will be parsed into an object or array.
+     *
+     * @param {string} key - The name of the query parameter to retrieve.
+     * @returns {*} The value of the query parameter, parsed from JSON if applicable, or null if not found.
      */
     getParam(key) {
-        this.setSearchParams();
-
         let value = this.urlParams.get(key);
 
         if (hasJsonStructure(value)) {
@@ -40,47 +40,102 @@ export default class UrlSearchParamsService extends Service {
     }
 
     /**
-     * Get a param
+     * Sets or updates a query parameter in the URL search parameters.
+     *
+     * If the value is an object or array, it will be stringified to JSON.
+     *
+     * @param {string} key - The name of the query parameter to set.
+     * @param {*} value - The value of the query parameter.
+     * @returns {this} Returns the service instance for chaining.
+     */
+    setParam(key, value) {
+        if (typeof value === 'object') {
+            value = JSON.stringify(value);
+        } else {
+            value = encodeURIComponent(value);
+        }
+
+        this.urlParams.set(key, value);
+
+        return this;
+    }
+
+    /**
+     * Alias for `getParam`.
      *
-     * @param {String} key the url param
-     * @return mixed
+     * @param {string} key - The name of the query parameter to retrieve.
+     * @returns {*} The value of the query parameter.
      */
     get(key) {
         return this.getParam(key);
     }
 
     /**
-     * Determines if a queryParam exists
+     * Sets or updates a query parameter with multiple values.
      *
-     * @param {String} key the url param
-     * @var {Boolean}
+     * @param {string} key - The name of the query parameter to set.
+     * @param {Array} values - An array of values for the parameter.
+     * @returns {this} Returns the service instance for chaining.
+     */
+    setParamArray(key, values) {
+        this.urlParams.delete(key);
+        values.forEach((value) => {
+            this.urlParams.append(key, value);
+        });
+
+        return this;
+    }
+
+    /**
+     * Retrieves all values of a specific query parameter.
+     *
+     * @param {string} key - The name of the query parameter.
+     * @returns {Array} An array of values for the parameter.
+     */
+    getParamArray(key) {
+        return this.urlParams.getAll(key);
+    }
+
+    /**
+     * Checks if a specific query parameter exists in the URL.
+     *
+     * @param {string} key - The name of the query parameter to check.
+     * @returns {boolean} True if the parameter exists, false otherwise.
      */
     exists(key) {
-        this.setSearchParams();
+        return this.urlParams.has(key);
+    }
 
+    /**
+     * Checks if a specific query parameter has in the URL.
+     *
+     * @param {string} key - The name of the query parameter to check.
+     * @returns {boolean} True if the parameter exists, false otherwise.
+     */
+    has(key) {
         return this.urlParams.has(key);
     }
 
     /**
-     * Remove a queryparam
+     * Removes a specific query parameter from the URL search parameters.
      *
-     * @param {String} key the url param
-     * @void
+     * @param {string} key - The name of the query parameter to remove.
+     * @returns {this} Returns the service instance for chaining.
      */
     remove(key) {
-        this.setSearchParams();
+        this.urlParams.delete(key);
 
-        return this.urlParams.delete(key);
+        return this;
     }
 
     /**
-     * Returns object of all params
+     * Retrieves all query parameters as an object.
      *
-     * @return {Array}
+     * Each parameter value is processed by `getParam`, which parses JSON values if applicable.
+     *
+     * @returns {Object} An object containing all query parameters and their values.
      */
     all() {
-        this.setSearchParams();
-
         const all = {};
 
         for (let key of this.urlParams.keys()) {
@@ -89,4 +144,103 @@ export default class UrlSearchParamsService extends Service {
 
         return all;
     }
+
+    /**
+     * Updates the browser's URL with the current `urlParams` without reloading the page.
+     *
+     * @returns {void}
+     */
+    updateUrl() {
+        const url = new URL(window.location.href);
+        url.search = this.urlParams.toString();
+        window.history.pushState({ path: url.href }, '', url.href);
+    }
+
+    /**
+     * Updates the browser's URL with the current `urlParams`, debounced to prevent excessive calls.
+     *
+     * @returns {void}
+     */
+    updateUrlDebounced() {
+        debounce(this, this.updateUrl, 100);
+    }
+
+    /**
+     * Clears all query parameters from the URL search parameters.
+     *
+     * @returns {this} Returns the service instance for chaining.
+     */
+    clear() {
+        this.urlParams = new URLSearchParams();
+
+        return this;
+    }
+
+    /**
+     * Returns the full URL as a string with the current `urlParams`.
+     *
+     * @returns {string} The full URL with updated query parameters.
+     */
+    getFullUrl() {
+        const url = new URL(window.location.href);
+        url.search = this.urlParams.toString();
+
+        return url.toString();
+    }
+
+    /**
+     * Returns the current path with the updated query parameters.
+     *
+     * @returns {string} The path and search portion of the URL.
+     */
+    getPathWithParams() {
+        return `${window.location.pathname}?${this.urlParams.toString()}`;
+    }
+
+    /**
+     * Removes a query parameter from the current URL and updates the browser history.
+     *
+     * This method modifies the browser's URL by removing the specified parameter and uses the History API
+     * to update the URL without reloading the page.
+     *
+     * @param {string} paramToRemove - The name of the query parameter to remove from the URL.
+     * @returns {void}
+     */
+    removeParamFromCurrentUrl(paramToRemove) {
+        const url = new URL(window.location.href);
+        url.searchParams.delete(paramToRemove);
+        window.history.pushState({ path: url.href }, '', url.href);
+    }
+
+    /**
+     * Adds or updates a query parameter in the current URL and updates the browser history.
+     *
+     * This method modifies the browser's URL by adding or updating the specified parameter and uses the History API
+     * to update the URL without reloading the page.
+     *
+     * @param {string} paramName - The name of the query parameter to add or update.
+     * @param {string} paramValue - The value of the query parameter.
+     * @returns {void}
+     */
+    addParamToCurrentUrl(paramName, paramValue) {
+        const url = new URL(window.location.href);
+        url.searchParams.set(paramName, paramValue);
+        window.history.pushState({ path: url.href }, '', url.href);
+    }
+
+    /**
+     * Adds or updates a query parameters from a provided object into the current URL and updates the browser history.
+     *
+     * This method modifies the browser's URL by adding or updating the specified parameters and uses the History API
+     * to update the URL without reloading the page.
+     *
+     * @param {Object} params - The query parameters to add or update.
+     * @returns {void}
+     */
+    setParamsToCurrentUrl(params = {}) {
+        for (let param in params) {
+            const value = params[param];
+            this.addParamToCurrentUrl(param, value);
+        }
+    }
 }

package/addon/utils/inject-engine-service.js

@@ -1,10 +1,11 @@
 import { getOwner } from '@ember/application';
 import { isArray } from '@ember/array';
+import Service from '@ember/service';
 import isObject from './is-object';
 
 function findService(owner, target, serviceName) {
     let service = target[serviceName];
-    if (!service) {
+    if (!(service instanceof Service)) {
         service = owner.lookup(`service:${serviceName}`);
     }
 
@@ -33,8 +34,12 @@ function automaticServiceResolution(service, target, owner) {
     }
 }
 
+function _getOwner(target) {
+    return window.Fleetbase ?? getOwner(target);
+}
+
 export default function injectEngineService(target, engineName, serviceName, options = {}) {
-    const owner = getOwner(target);
+    const owner = _getOwner(target);
     const universe = owner.lookup('service:universe');
     const service = universe.getServiceFromEngine(engineName, serviceName);
     const key = options.key || null;

package/addon/utils/is-empty-object.js

@@ -1,3 +1,9 @@
+import { isBlank } from '@ember/utils';
+
 export default function isEmptyObject(obj) {
-    return Object.keys(obj).length === 0 && obj.constructor === Object;
+    if (isBlank(obj)) {
+        return true;
+    }
+
+    return obj.constructor === Object && Object.keys(obj).length === 0;
 }

package/addon/utils/register-component.js

@@ -0,0 +1,8 @@
+import { dasherize } from '@ember/string';
+
+export default function registerComponent(owner, componentClass, options = {}) {
+    const registrationName = options && options.as ? `component:${options.as}` : `component:${dasherize(componentClass.name).replace('-component', '')}`;
+    if (!owner.hasRegistration(registrationName)) {
+        owner.register(registrationName, componentClass);
+    }
+}

package/addon/utils/register-helper.js

@@ -0,0 +1,8 @@
+import { dasherize } from '@ember/string';
+
+export default function registerHelper(owner, name, helperFn) {
+    const registrationName = `helper:${dasherize(name)}`;
+    if (!owner.hasRegistration(registrationName)) {
+        owner.register(registrationName, helperFn);
+    }
+}

package/addon/utils/serialize/normalize-relations-with-hash.js

@@ -8,17 +8,12 @@ export default function serializeNormalizeRelationsWithinHash(hash, primaryKey =
 
     for (let attr in hash) {
         if (typeof attr === 'string' && attr.includes('_uuid')) {
-            // console.log(attr, hash[attr]);
             if (typeof hash[attr] === 'object' && !isBlank(hash[attr])) {
                 // the relation has loaded back into `_uuid` - change this to the proper `uuid` string value and set the relationship
                 const relation = hash[attr];
                 const id = get(relation, primaryKey);
                 const relationAttr = attr.replace('_uuid', '');
 
-                // console.log(`normalizing relation ${relationAttr} from ${attr}`);
-                // console.log(relationAttr, relation);
-                // console.log(attr, id);
-
                 setProperties(hash, {
                     [relationAttr]: relation,
                     [attr]: id,

package/app/utils/register-component.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/ember-core/utils/register-component';

package/app/utils/register-helper.js

@@ -0,0 +1 @@
+export { default } from '@fleetbase/ember-core/utils/register-helper';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fleetbase/ember-core",
-    "version": "0.2.17",
+    "version": "0.2.19",
     "description": "Provides all the core services, decorators and utilities for building a Fleetbase extension for the Console.",
     "keywords": [
         "fleetbase-core",