Implement widgetUrl in admin lib #10697

Author: anatol-sialitski

modules/lib/lib-admin/src/main/resources/lib/xp/admin.ts

@@ -16,6 +16,12 @@ declare global {
 const i18n = require('/lib/xp/i18n');
 const portal = require('/lib/xp/portal');
 
+function checkRequired<T extends object>(obj: T, name: keyof T): void {
+    if (obj == null || obj[name] == null) {
+        throw `Parameter '${String(name)}' is required`;
+    }
+}
+
 const helper = __.newBean<AdminLibHelper>('com.enonic.xp.lib.admin.AdminLibHelper');
 
 interface AdminLibHelper {
@@ -160,3 +166,32 @@ export function getInstallation(): string {
 export function getVersion(): string {
     return helper.getVersion();
 }
+
+export interface WidgetUrlParams {
+    application: string;
+    widget: string;
+    type?: 'server' | 'absolute';
+    params?: object;
+}
+
+/**
+ * Returns the URL for a widget.
+ *
+ * @param {object} [params] Parameter object
+ * @param {string} params.application Application to reference to a widget.
+ * @param {string} params.widget Name of the widget.
+ * @param {string} [params.type=server] URL type. Either `server` (server-relative URL) or `absolute`.
+ * @param {object} [params.params] Custom parameters to append to the url.
+ *
+ * @returns {string} URL.
+ */
+export function widgetUrl(params: WidgetUrlParams): string {
+    checkRequired(params, 'application');
+    checkRequired(params, 'widget');
+
+    return portal.apiUrl({
+        application: 'admin',
+        api: `widget/${params.application}/${params.widget}`,
+        params: params.params || {},
+    });
+}

modules/lib/lib-admin/src/test/java/com/enonic/xp/lib/admin/LibAdminTest.java

@@ -0,0 +1,15 @@
+package com.enonic.xp.lib.admin;
+
+import org.junit.jupiter.api.Test;
+
+import com.enonic.xp.testing.ScriptTestSupport;
+
+public class LibAdminTest
+    extends ScriptTestSupport
+{
+    @Test
+    void testWidgetUrl()
+    {
+        runFunction( "/test/admin-test.js", "testWidgetUrl" );
+    }
+}

modules/lib/lib-admin/src/test/resources/test/admin-test.js

@@ -0,0 +1,18 @@
+const t = require('/lib/xp/testing');
+
+t.mock('/lib/xp/admin', {
+    widgetUrl(params) {
+        return 'generated_url';
+    }
+});
+
+exports.testWidgetUrl = function () {
+    const adminLib = require('/lib/xp/admin');
+
+    const result = adminLib.widgetUrl({
+        application: 'app',
+        widget: 'widget',
+    });
+
+    t.assertEquals("generated_url", result);
+};