@onecx/integration-interface 8.0.0-rc.10 → 8.0.0-rc.11

package/src/lib/utils/workspace.utils.js

@@ -0,0 +1,199 @@
+const aliasStart = '[[';
+const aliasEnd = ']]';
+const paramStart = '{';
+const paramEnd = '}';
+/**
+ * Joins base and path segments with a single slash.
+ *
+ * @param base - Base URL segment.
+ * @param path - Path segment to append.
+ * @returns Joined URL string.
+ */
+const joinWithSlash = (base, path) => {
+    let normalizedBase = base;
+    let normalizedPath = path;
+    if (!normalizedBase.endsWith('/')) {
+        normalizedBase += '/';
+    }
+    if (normalizedPath.startsWith('/')) {
+        normalizedPath = normalizedPath.slice(1);
+    }
+    return normalizedBase + normalizedPath;
+};
+/**
+ * Builds the base URL from the workspace, with warnings on missing values.
+ *
+ * @param workspace - Workspace definition.
+ * @returns Base URL string or empty string if missing.
+ */
+const constructBaseUrlFromWorkspace = (workspace, warn) => {
+    if (workspace.baseUrl === undefined) {
+        warn('There was no baseUrl for received workspace.');
+        return '';
+    }
+    return workspace.baseUrl;
+};
+/**
+ * Finds a route entry for a product/app pair.
+ *
+ * @param routes - Available route definitions.
+ * @param appId - Application identifier.
+ * @param productName - Product name identifier.
+ * @returns Matched route or undefined.
+ */
+const filterRouteFromList = (routes, appId, productName, warn) => {
+    if (!routes) {
+        return undefined;
+    }
+    const productRoutes = routes.filter((route) => route.appId === appId && route.productName === productName);
+    if (productRoutes.length === 0) {
+        return undefined;
+    }
+    if (productRoutes.length > 1) {
+        warn('There were more than one route. First route has been used.');
+    }
+    return productRoutes[0];
+};
+/**
+ * Resolves endpoint aliases to the final endpoint definition.
+ *
+ * @param endpointName - Endpoint name or alias.
+ * @param endpoints - Available endpoint definitions.
+ * @returns Resolved endpoint or undefined.
+ */
+const dissolveEndpoint = (endpointName, endpoints) => {
+    let endpoint = endpoints.find((ep) => ep.name === endpointName);
+    if (!endpoint) {
+        return undefined;
+    }
+    while (endpoint.path?.includes(aliasStart)) {
+        const path = endpoint.path;
+        const startIdx = path.indexOf(aliasStart) + aliasStart.length;
+        const endIdx = path.lastIndexOf(aliasEnd);
+        if (endIdx <= startIdx) {
+            return undefined;
+        }
+        const aliasName = path.substring(startIdx, endIdx);
+        endpoint = endpoints.find((ep) => ep.name === aliasName);
+        if (!endpoint) {
+            return undefined;
+        }
+    }
+    return endpoint;
+};
+/**
+ * Normalizes parameter values into strings for URL interpolation.
+ *
+ * @param value - Parameter value to normalize.
+ * @returns Normalized string value.
+ */
+const getStringFromUnknown = (value) => {
+    if (value === null || value === undefined) {
+        return '';
+    }
+    if (typeof value === 'string') {
+        return value;
+    }
+    return String(value);
+};
+/**
+ * Replaces path parameters with the provided endpoint parameter values.
+ *
+ * @param path - Endpoint path template.
+ * @param endpointParameters - Parameters to inject.
+ * @returns Path with parameters resolved, or empty string on failure.
+ */
+const fillParamsForPath = (path, endpointParameters, warn) => {
+    while (path.includes(paramStart)) {
+        const paramName = path.substring(path.indexOf(paramStart) + paramStart.length, path.indexOf(paramEnd));
+        const paramValue = getStringFromUnknown(endpointParameters[paramName]);
+        if (paramValue && paramValue.length > 0) {
+            path = path.replace(paramStart.concat(paramName).concat(paramEnd), paramValue);
+        }
+        else {
+            warn(`Searched param "${paramName}" was not found in given param list `);
+            return '';
+        }
+    }
+    return path;
+};
+/**
+ * Constructs a URL path for a concrete endpoint, resolving aliases and params.
+ *
+ * @param route - Route definition.
+ * @param endpointName - Endpoint name or alias.
+ * @param endpointParameters - Endpoint parameters for interpolation.
+ * @returns Endpoint URL path string.
+ */
+const constructEndpointUrl = (route, endpointName, endpointParameters, warn = console.warn) => {
+    if (!route.endpoints) {
+        return '';
+    }
+    const finalEndpoint = dissolveEndpoint(endpointName, route.endpoints);
+    if (!finalEndpoint?.path) {
+        warn('No endpoint or endpoint.path could be found');
+        return '';
+    }
+    const paramsFilled = fillParamsForPath(finalEndpoint.path, endpointParameters ?? {}, warn);
+    if (paramsFilled === undefined) {
+        warn('Params could not be filled correctly');
+        return '';
+    }
+    return paramsFilled;
+};
+/**
+ * Constructs a full route URL for a workspace, app, and optional endpoint.
+ *
+ * @param workspace - Workspace definition.
+ * @param appId - Application identifier.
+ * @param productName - Product name identifier.
+ * @param endpointName - Optional endpoint name.
+ * @param endpointParameters - Optional endpoint parameters.
+ * @returns Resolved route URL string.
+ */
+const constructRouteUrl = (workspace, appId, productName, endpointName, endpointParameters, warn = console.warn) => {
+    const route = filterRouteFromList(workspace.routes, appId, productName, warn);
+    let url = constructBaseUrlFromWorkspace(workspace, warn);
+    if (!route) {
+        warn(`No route.baseUrl could be found for given appId "${appId}" and productName "${productName}"`);
+        return url;
+    }
+    if (route.baseUrl?.length) {
+        url = route.baseUrl;
+    }
+    if (endpointName == undefined) {
+        return url;
+    }
+    const endpointPath = constructEndpointUrl(route, endpointName, endpointParameters, warn);
+    if (!endpointPath.length) {
+        return url;
+    }
+    url = joinWithSlash(url, endpointPath);
+    return url;
+};
+/**
+ * Checks whether a route or endpoint URL exists for the given identifiers.
+ *
+ * @param workspace - Workspace definition.
+ * @param productName - Product name identifier.
+ * @param appId - Application identifier.
+ * @param endpointName - Optional endpoint name to validate.
+ * @returns True if the URL exists.
+ */
+const doesUrlExistForWorkspace = (workspace, productName, appId, endpointName, warn = console.warn) => {
+    const checkEndpoint = endpointName !== undefined && endpointName.length > 0;
+    if (!workspace.routes) {
+        return false;
+    }
+    const route = filterRouteFromList(workspace.routes, appId, productName, warn);
+    if (checkEndpoint) {
+        if (!route?.endpoints?.length) {
+            return false;
+        }
+        const endpoint = route.endpoints.find((ep) => ep.name === endpointName);
+        return !!endpoint?.path?.length;
+    }
+    return !!route?.baseUrl?.length;
+};
+export { constructBaseUrlFromWorkspace, constructEndpointUrl, constructRouteUrl, doesUrlExistForWorkspace, dissolveEndpoint, fillParamsForPath, filterRouteFromList, getStringFromUnknown, };
+//# sourceMappingURL=workspace.utils.js.map

package/src/lib/utils/workspace.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.utils.js","sourceRoot":"","sources":["../../../../../../libs/integration-interface/src/lib/utils/workspace.utils.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,GAAG,IAAI,CAAA;AACvB,MAAM,QAAQ,GAAG,IAAI,CAAA;AACrB,MAAM,UAAU,GAAG,GAAG,CAAA;AACtB,MAAM,QAAQ,GAAG,GAAG,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,IAAY,EAAU,EAAE;IAC3D,IAAI,cAAc,GAAG,IAAI,CAAA;IACzB,IAAI,cAAc,GAAG,IAAI,CAAA;IAEzB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAClC,cAAc,IAAI,GAAG,CAAA;IACvB,CAAC;IACD,IAAI,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAC1C,CAAC;IACD,OAAO,cAAc,GAAG,cAAc,CAAA;AACxC,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,6BAA6B,GAAG,CAAC,SAAoB,EAAE,IAAiB,EAAU,EAAE;IACxF,IAAI,SAAS,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACpC,IAAI,CAAC,8CAA8C,CAAC,CAAA;QACpD,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,SAAS,CAAC,OAAO,CAAA;AAC1B,CAAC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,mBAAmB,GAAG,CAC1B,MAAgC,EAChC,KAAa,EACb,WAAmB,EACnB,IAAiB,EACE,EAAE;IACrB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,IAAI,KAAK,CAAC,WAAW,KAAK,WAAW,CAAC,CAAA;IAE1G,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,IAAI,CAAC,4DAA4D,CAAC,CAAA;IACpE,CAAC;IAED,OAAO,aAAa,CAAC,CAAC,CAAC,CAAA;AACzB,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,gBAAgB,GAAG,CAAC,YAAoB,EAAE,SAA0B,EAAwB,EAAE;IAClG,IAAI,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,YAAY,CAAC,CAAA;IAE/D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,GAAW,QAAQ,CAAC,IAAI,CAAA;QAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC,MAAM,CAAA;QAC7D,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QACzC,IAAI,MAAM,IAAI,QAAQ,EAAE,CAAC;YACvB,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAClD,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;QAExD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,SAAS,CAAA;QAClB,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAAU,EAAE;IACtD,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAA;IACX,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;AACtB,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,kBAAsC,EAAE,IAAiB,EAAU,EAAE;IAC5G,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAA;QACtG,MAAM,UAAU,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAA;QACtE,IAAI,UAAU,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAA;QAChF,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,mBAAmB,SAAS,sCAAsC,CAAC,CAAA;YACxE,OAAO,EAAE,CAAA;QACX,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAAG,CAC3B,KAAY,EACZ,YAAoB,EACpB,kBAAkD,EAClD,OAAoB,OAAO,CAAC,IAAI,EACxB,EAAE;IACV,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QACrB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,aAAa,GAAG,gBAAgB,CAAC,YAAY,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;IACrE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,6CAA6C,CAAC,CAAA;QACnD,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,YAAY,GAAG,iBAAiB,CAAC,aAAa,CAAC,IAAI,EAAE,kBAAkB,IAAI,EAAE,EAAE,IAAI,CAAC,CAAA;IAC1F,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,CAAC,sCAAsC,CAAC,CAAA;QAC5C,OAAO,EAAE,CAAA;IACX,CAAC;IAED,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,iBAAiB,GAAG,CACxB,SAAoB,EACpB,KAAa,EACb,WAAmB,EACnB,YAAqB,EACrB,kBAAuC,EACvC,OAAoB,OAAO,CAAC,IAAI,EACxB,EAAE;IACV,MAAM,KAAK,GAAG,mBAAmB,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,CAAA;IAC7E,IAAI,GAAG,GAAG,6BAA6B,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;IACxD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,IAAI,CAAC,oDAAoD,KAAK,sBAAsB,WAAW,GAAG,CAAC,CAAA;QAEnG,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAC1B,GAAG,GAAG,KAAK,CAAC,OAAO,CAAA;IACrB,CAAC;IACD,IAAI,YAAY,IAAI,SAAS,EAAE,CAAC;QAC9B,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,MAAM,YAAY,GAAG,oBAAoB,CAAC,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,IAAI,CAAC,CAAA;IACxF,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QACzB,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,GAAG,GAAG,aAAa,CAAC,GAAG,EAAE,YAAY,CAAC,CAAA;IACtC,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,wBAAwB,GAAG,CAC/B,SAAoB,EACpB,WAAmB,EACnB,KAAa,EACb,YAAqB,EACrB,OAAoB,OAAO,CAAC,IAAI,EACvB,EAAE;IACX,MAAM,aAAa,GAAG,YAAY,KAAK,SAAS,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,CAAA;IAE3E,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QACtB,OAAO,KAAK,CAAA;IACd,CAAC;IACD,MAAM,KAAK,GAAG,mBAAmB,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,CAAA;IAE7E,IAAI,aAAa,EAAE,CAAC;QAClB,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,YAAY,CAAC,CAAA;QACvE,OAAO,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAA;IACjC,CAAC;IAED,OAAO,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAA;AACjC,CAAC,CAAA;AAGD,OAAO,EACL,6BAA6B,EAC7B,oBAAoB,EACpB,iBAAiB,EACjB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,GACrB,CAAA"}

package/src/version.d.ts

@@ -1,2 +1,2 @@
 export declare const LIB_NAME = "@onecx/integration-interface";
-export declare const LIB_VERSION = "8.0.0-rc.10";
+export declare const LIB_VERSION = "8.0.0-rc.11";

package/src/version.js

@@ -1,3 +1,3 @@
 export const LIB_NAME = '@onecx/integration-interface';
-export const LIB_VERSION = '8.0.0-rc.10';
+export const LIB_VERSION = '8.0.0-rc.11';
 //# sourceMappingURL=version.js.map