@neovici/cosmoz-queue 1.0.0

package/dist/util/fetch/fetch.js

@@ -0,0 +1,74 @@
+export class RequestError extends Error {
+    response;
+    data;
+    constructor(message, response, data) {
+        super(message);
+        this.name = 'RequestError';
+        this.response = response;
+        this.data = data;
+    }
+}
+export const notice = (data) => {
+    if (data && typeof data === 'object') {
+        const obj = data, message = obj.message ??
+            obj.Message ??
+            obj.friendlyMessage ??
+            obj.error?.httpMessage ??
+            obj.errors?.map((err) => err.message).join(' ');
+        if (message)
+            return message;
+    }
+    return 'Unknown error';
+};
+const baseInit = {};
+export const setBaseInit = (init) => {
+    const mergedObject = {
+        ...baseInit,
+        ...init,
+        headers: { ...baseInit.headers, ...init.headers },
+    };
+    return Object.assign(baseInit, mergedObject);
+};
+export const fetch = (url, opts) => window.fetch(url, {
+    ...baseInit,
+    mode: 'cors',
+    credentials: 'include',
+    ...opts,
+    headers: {
+        ...baseInit?.headers,
+        ...opts?.headers,
+    },
+});
+export const handleJSON = (res) => {
+    if (res.status === 204) {
+        return '';
+    }
+    const json = res.json();
+    return res.ok
+        ? json.catch(() => '')
+        : json.then((data) => Promise.reject(new RequestError(notice(data), res, data)), (error) => {
+            if (res.status === 404) {
+                return Promise.reject(new RequestError('URL not found: ' + res.url, res));
+            }
+            return Promise.reject(error);
+        });
+};
+/**
+ * @deprecated
+ */
+export const json = (url, { fetch: _fetch = fetch, handleJSON: _handleJSON = handleJSON, ...opts } = {}) => _fetch(url, opts).then(_handleJSON);
+/**
+ * @deprecated
+ */
+export const jsonPost = (url, body, opts) => json(url, {
+    method: 'POST',
+    ...(body ? { body: JSON.stringify(body) } : {}),
+    ...opts,
+    headers: {
+        'Content-Type': 'application/json',
+        ...opts?.headers,
+    },
+});
+export const jsonPut = (url, body, opts) => jsonPost(url, body, { method: 'PUT', ...opts });
+export const jsonPatch = (url, body, opts) => jsonPost(url, body, { method: 'PATCH', ...opts });
+export const jsonDelete = (url, body, opts) => jsonPost(url, body, { method: 'DELETE', ...opts });

package/dist/util/fetch/url.d.ts

@@ -0,0 +1,30 @@
+export type ParamValue = string | string[] | boolean | number | null | undefined;
+export declare const toURLSearchParams: <T extends Record<string, ParamValue>>(obj: T) => URLSearchParams;
+declare global {
+    interface Cz {
+        options: {
+            backendBaseUri: string;
+            googleClientId?: string;
+            idp?: string;
+        };
+        state: {
+            currentLocationPath: string;
+        };
+    }
+    interface Window {
+        cz: Cz;
+    }
+}
+/**
+ * @deprecated
+ */
+export declare function apiUrl(api: string): string;
+/**
+ * @deprecated
+ */
+export declare function apiUrl(api: string, params?: Record<string, ParamValue>): string;
+/**
+ * @deprecated This is a bad pattern to use and it's present only for legacy purposes.
+ */
+export declare function guardUrl(url: string, deps?: unknown[]): string | undefined;
+//# sourceMappingURL=url.d.ts.map

package/dist/util/fetch/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../src/util/fetch/url.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GACnB,MAAM,GACN,MAAM,EAAE,GACR,OAAO,GACP,MAAM,GACN,IAAI,GACJ,SAAS,CAAC;AAEb,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EACrE,KAAK,CAAC,oBAkBN,CAAC;AAEF,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,EAAE;QACX,OAAO,EAAE;YACR,cAAc,EAAE,MAAM,CAAC;YACvB,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,GAAG,CAAC,EAAE,MAAM,CAAC;SACb,CAAC;QACF,KAAK,EAAE;YACN,mBAAmB,EAAE,MAAM,CAAC;SAC5B,CAAC;KACF;IACD,UAAU,MAAM;QACf,EAAE,EAAE,EAAE,CAAC;KACP;CACD;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;AAC5C;;GAEG;AACH,wBAAgB,MAAM,CACrB,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GACjC,MAAM,CAAC;AAmBV;;GAEG;AACH,wBAAgB,QAAQ,CACvB,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,OAAO,EAAO,GAClB,MAAM,GAAG,SAAS,CAMpB"}

package/dist/util/fetch/url.js

@@ -0,0 +1,29 @@
+export const toURLSearchParams = (obj) => {
+    const entries = Object.entries(obj), simpleParams = Object.fromEntries(entries.filter(([, value]) => !Array.isArray(value) && value !== undefined)), allParams = new URLSearchParams(simpleParams);
+    // handle arrays
+    entries
+        .filter((entry) => Array.isArray(entry[1]))
+        .forEach(([key, values]) => values.forEach((value) => allParams.append(key, value)));
+    return allParams;
+};
+/**
+ * @deprecated
+ */
+export function apiUrl(api, params = {}) {
+    const baseUrl = window.cz.options.backendBaseUri, url = new URL(api, baseUrl);
+    url.search = toURLSearchParams({
+        ...Object.fromEntries(url.searchParams),
+        ...params,
+    });
+    return `${url}`;
+}
+/**
+ * @deprecated This is a bad pattern to use and it's present only for legacy purposes.
+ */
+export function guardUrl(url, deps = []) {
+    // bail if any required dependencies are undefined
+    if (deps.some((dep) => dep == null)) {
+        return;
+    }
+    return url;
+}

package/dist/util/path.d.ts

@@ -0,0 +1,42 @@
+type PathMember = string | number;
+type Path = string | PathMember[];
+/**
+ * Converts array-based paths to flattened path.  String-based paths
+ * are returned as-is.
+ *
+ * Example:
+ *
+ * ```
+ * normalize(['foo.bar', 0, 'baz'])  // 'foo.bar.0.baz'
+ * normalize('foo.bar.0.baz')        // 'foo.bar.0.baz'
+ * ```
+ * @param {Path} path Input path
+ * @return {string} Flattened path
+ */
+export declare const normalize: (path: Path) => string;
+/**
+ * Splits a path into an array of property names. Accepts either arrays
+ * of path parts or strings.
+ *
+ * Example:
+ *
+ * ```
+ * split(['foo.bar', 0, 'baz'])  // ['foo', 'bar', '0', 'baz']
+ * split('foo.bar.0.baz')        // ['foo', 'bar', '0', 'baz']
+ * ```
+ * @param {Path} path Input path
+ * @return {string[]} Array of path parts
+ */
+export declare const split: (path: Path) => string[];
+/**
+ * Reads a value from a path.  If any sub-property in the path is `undefined`,
+ * this method returns `undefined` (will never throw.
+ *
+ * @param {Object} root Object from which to dereference path from
+ * @param {Path} path Path to read
+ * @return {*} Value at path, or `undefined` if the path could not be
+ *  fully dereferenced.
+ */
+export declare const get: (root: unknown, path: Path) => unknown;
+export {};
+//# sourceMappingURL=path.d.ts.map

package/dist/util/path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../src/util/path.ts"],"names":[],"mappings":"AAEA,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAClC,KAAK,IAAI,GAAG,MAAM,GAAG,UAAU,EAAE,CAAC;AAElC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,IAAI,KAAG,MAatC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,KAAK,GAAI,MAAM,IAAI,KAAG,MAAM,EAKxC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,GAAG,GAAI,MAAM,OAAO,EAAE,MAAM,IAAI,YAY5C,CAAC"}

package/dist/util/path.js

@@ -0,0 +1,68 @@
+// copied from @polymer/polymer/lib/utils/path.js
+/**
+ * Converts array-based paths to flattened path.  String-based paths
+ * are returned as-is.
+ *
+ * Example:
+ *
+ * ```
+ * normalize(['foo.bar', 0, 'baz'])  // 'foo.bar.0.baz'
+ * normalize('foo.bar.0.baz')        // 'foo.bar.0.baz'
+ * ```
+ * @param {Path} path Input path
+ * @return {string} Flattened path
+ */
+export const normalize = (path) => {
+    if (Array.isArray(path)) {
+        const parts = [];
+        for (let i = 0; i < path.length; i++) {
+            const args = path[i].toString().split('.');
+            for (let j = 0; j < args.length; j++) {
+                parts.push(args[j]);
+            }
+        }
+        return parts.join('.');
+    }
+    return path;
+};
+/**
+ * Splits a path into an array of property names. Accepts either arrays
+ * of path parts or strings.
+ *
+ * Example:
+ *
+ * ```
+ * split(['foo.bar', 0, 'baz'])  // ['foo', 'bar', '0', 'baz']
+ * split('foo.bar.0.baz')        // ['foo', 'bar', '0', 'baz']
+ * ```
+ * @param {Path} path Input path
+ * @return {string[]} Array of path parts
+ */
+export const split = (path) => {
+    if (Array.isArray(path)) {
+        return normalize(path).split('.');
+    }
+    return path.toString().split('.');
+};
+/**
+ * Reads a value from a path.  If any sub-property in the path is `undefined`,
+ * this method returns `undefined` (will never throw.
+ *
+ * @param {Object} root Object from which to dereference path from
+ * @param {Path} path Path to read
+ * @return {*} Value at path, or `undefined` if the path could not be
+ *  fully dereferenced.
+ */
+export const get = (root, path) => {
+    let prop = root;
+    const parts = split(path);
+    // Loop over path parts[0..n-1] and dereference
+    for (let i = 0; i < parts.length; i++) {
+        if (!prop) {
+            return;
+        }
+        const part = parts[i];
+        prop = prop[part];
+    }
+    return prop;
+};

package/dist/util/polymer-property-changed-event.d.ts

@@ -0,0 +1,6 @@
+type Setter<T> = (v: T) => void;
+type Handler<T> = (e: CustomEvent<T>) => void;
+export declare function updateWith<T>(setter: Setter<T>): Handler<T>;
+export declare function updateWith<T>(setter?: Setter<T>): Handler<T> | void;
+export {};
+//# sourceMappingURL=polymer-property-changed-event.d.ts.map

package/dist/util/polymer-property-changed-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polymer-property-changed-event.d.ts","sourceRoot":"","sources":["../../src/util/polymer-property-changed-event.ts"],"names":[],"mappings":"AAAA,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;AAChC,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAmB9C,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAC7D,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC"}

package/dist/util/polymer-property-changed-event.js

@@ -0,0 +1,27 @@
+const getPolymerPropertyValueFromUpdateEventDetail = (detail) => {
+    if (detail == null) {
+        return;
+    }
+    const subPath = detail?.path?.split('.')[1];
+    switch (subPath) {
+        case 'length':
+            return;
+        case 'splices':
+            return detail?.value?.indexSplices?.reduce((agg, splice) => {
+                return [...splice.object]; // shallow copy
+            }, []);
+        default:
+            return detail.value;
+    }
+};
+export function updateWith(setter) {
+    if (!setter)
+        return;
+    return (event) => {
+        const newValue = getPolymerPropertyValueFromUpdateEventDetail(event?.detail);
+        if (newValue === undefined) {
+            return;
+        }
+        setter(newValue);
+    };
+}

package/dist/util/test/path.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=path.test.d.ts.map

package/dist/util/test/path.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.test.d.ts","sourceRoot":"","sources":["../../../src/util/test/path.test.ts"],"names":[],"mappings":""}

package/dist/util/test/path.test.js

@@ -0,0 +1,99 @@
+import { assert } from '@open-wc/testing';
+import { get, normalize, split } from '../path';
+suite('path', () => {
+    suite('normalize', () => {
+        test('returns string path as-is', () => {
+            assert.equal(normalize('foo.bar.0.baz'), 'foo.bar.0.baz');
+        });
+        test('returns empty string as-is', () => {
+            assert.equal(normalize(''), '');
+        });
+        test('converts array path to flattened string', () => {
+            assert.equal(normalize(['foo.bar', 0, 'baz']), 'foo.bar.0.baz');
+        });
+        test('handles array with single element', () => {
+            assert.equal(normalize(['foo']), 'foo');
+        });
+        test('handles array with dotted strings and numbers', () => {
+            assert.equal(normalize(['a.b', 1, 'c.d', 2]), 'a.b.1.c.d.2');
+        });
+        test('handles empty array', () => {
+            assert.equal(normalize([]), '');
+        });
+    });
+    suite('split', () => {
+        test('splits string path into array', () => {
+            assert.deepEqual(split('foo.bar.0.baz'), ['foo', 'bar', '0', 'baz']);
+        });
+        test('splits array path into flat array', () => {
+            assert.deepEqual(split(['foo.bar', 0, 'baz']), [
+                'foo',
+                'bar',
+                '0',
+                'baz',
+            ]);
+        });
+        test('handles single segment string', () => {
+            assert.deepEqual(split('foo'), ['foo']);
+        });
+        test('handles array with single element', () => {
+            assert.deepEqual(split(['foo']), ['foo']);
+        });
+        test('handles empty string', () => {
+            assert.deepEqual(split(''), ['']);
+        });
+    });
+    suite('get', () => {
+        test('retrieves nested value with string path', () => {
+            const obj = { foo: { bar: { baz: 'value' } } };
+            assert.equal(get(obj, 'foo.bar.baz'), 'value');
+        });
+        test('retrieves nested value with array path', () => {
+            const obj = { foo: { bar: { baz: 'value' } } };
+            assert.equal(get(obj, ['foo', 'bar', 'baz']), 'value');
+        });
+        test('retrieves nested value with dotted string in array path', () => {
+            const obj = { foo: { bar: { baz: 'value' } } };
+            assert.equal(get(obj, ['foo.bar', 'baz']), 'value');
+        });
+        test('retrieves array element by index', () => {
+            const obj = { items: ['a', 'b', 'c'] };
+            assert.equal(get(obj, 'items.1'), 'b');
+        });
+        test('retrieves array element with array path', () => {
+            const obj = { items: ['a', 'b', 'c'] };
+            assert.equal(get(obj, ['items', 0]), 'a');
+        });
+        test('returns undefined for non-existent path', () => {
+            const obj = { foo: { bar: 'value' } };
+            assert.equal(get(obj, 'foo.baz.qux'), undefined);
+        });
+        test('returns undefined when intermediate property is undefined', () => {
+            const obj = { foo: undefined };
+            assert.equal(get(obj, 'foo.bar'), undefined);
+        });
+        test('returns undefined when intermediate property is null', () => {
+            const obj = { foo: null };
+            assert.equal(get(obj, 'foo.bar'), undefined);
+        });
+        test('returns undefined with empty string path', () => {
+            const obj = { foo: 'bar' };
+            assert.equal(get(obj, ''), undefined);
+        });
+        test('handles complex nested structure', () => {
+            const obj = {
+                users: [
+                    { name: 'Alice', address: { city: 'NYC' } },
+                    { name: 'Bob', address: { city: 'LA' } },
+                ],
+            };
+            assert.equal(get(obj, 'users.1.address.city'), 'LA');
+        });
+        test('returns undefined for null root', () => {
+            assert.equal(get(null, 'foo'), undefined);
+        });
+        test('returns undefined for undefined root', () => {
+            assert.equal(get(undefined, 'foo'), undefined);
+        });
+    });
+});

package/package.json

@@ -0,0 +1,113 @@
+{
+  "name": "@neovici/cosmoz-queue",
+  "version": "1.0.0",
+  "description": "A reusable queue component for master-detail views with list, split, and queue modes",
+  "keywords": [
+    "web-components",
+    "queue",
+    "master-detail",
+    "split-view",
+    "pion",
+    "lit-html"
+  ],
+  "homepage": "https://github.com/neovici/cosmoz-queue#readme",
+  "bugs": {
+    "url": "https://github.com/neovici/cosmoz-queue/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/neovici/cosmoz-queue.git"
+  },
+  "license": "Apache-2.0",
+  "author": "",
+  "main": "dist/index.js",
+  "type": "module",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "lint": "tsc && eslint --cache .",
+    "build": "tsc -p tsconfig.build.json",
+    "start": "wds",
+    "test": "wtr --coverage",
+    "test:watch": "wtr --watch",
+    "dev": "npm run storybook:start",
+    "storybook:start": "storybook dev -p 8000",
+    "storybook:build": "storybook build",
+    "storybook:deploy": "storybook-to-ghpages",
+    "storybook:preview": "npm run storybook:build && http-server -d ./storybook-static/",
+    "prepare": "husky"
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/github",
+      "@semantic-release/npm",
+      "@semantic-release/git"
+    ],
+    "branch": "master",
+    "preset": "conventionalcommits"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/",
+    "types"
+  ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./use-queue": "./dist/queue/use-queue.js",
+    "./use-tabs": "./dist/queue/use-tabs.js",
+    "./use-split": "./dist/queue/use-split.js",
+    "./use-data-nav": "./dist/queue/use-data-nav.js",
+    "./use-list": "./dist/queue/use-list.js"
+  },
+  "dependencies": {
+    "@neovici/cosmoz-dialog-next": "^1.1.1",
+    "@neovici/cosmoz-form": "^1.0.1",
+    "@neovici/cosmoz-i18next": "^3.5.1",
+    "@neovici/cosmoz-omnitable": "^16.0.3",
+    "@neovici/cosmoz-router": "^11.2.8",
+    "@neovici/cosmoz-slider": "^5.2.1",
+    "@neovici/cosmoz-tabs": "^9.3.2",
+    "@neovici/cosmoz-utils": "^6.14.2",
+    "@neovici/cosmoz-viewinfo": "^4.1.1",
+    "@pionjs/pion": "^2.10.0",
+    "i18next": "^25.7.4",
+    "lit-html": "^3.3.1",
+    "split.js": "^1.6.5"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.2.1",
+    "@commitlint/config-conventional": "^19.1.0",
+    "@eslint/eslintrc": "^2.0.0",
+    "@neovici/cfg": "^2.0.0",
+    "@neovici/testing": "^2.0.0",
+    "@open-wc/testing": "^4.0.0",
+    "@open-wc/testing-helpers": "^3.0.1",
+    "@semantic-release/changelog": "^6.0.0",
+    "@semantic-release/git": "^10.0.0",
+    "@storybook/addon-links": "^10.0.0",
+    "@storybook/web-components": "^10.0.0",
+    "@storybook/web-components-vite": "^10.0.0",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^22.10.2",
+    "@types/split.js": "^1.6.0",
+    "@web/dev-server-esbuild": "^1.0.4",
+    "@web/test-runner-playwright": "^0.11.1",
+    "esbuild": "^0.27.0",
+    "http-server": "^14.1.1",
+    "husky": "^9.0.11",
+    "semantic-release": "^24.0.0",
+    "sinon": "^19.0.0",
+    "storybook": "^10.0.0",
+    "typescript": "^5.4.3"
+  },
+  "overrides": {
+    "conventional-changelog-conventionalcommits": ">= 8.0.0",
+    "@polymer/polymer": "^3.5.2"
+  }
+}