@enonic-types/lib-admin 7.16.2 → 8.0.0-A3

package/README.md

@@ -30,7 +30,7 @@ global objects, e.g. `log`, `app`, `__`, etc, requiring a library by the default
 `example.ts`
 
 ```ts
-const {getBaseUri, getAssetsUri, getHomeToolUrl, HomeToolUrlType} = require('/lib/xp/admin');
+const {getBaseUri, getHomeToolUrl, HomeToolUrlType} = require('/lib/xp/admin');
 ```
 
 More detailed explanation on how it works and how to type custom import function can be
@@ -57,7 +57,7 @@ types mapping to your configuration.
 `example.ts`
 
 ```ts
-import {getBaseUri, getAssetsUri, getHomeToolUrl, HomeToolUrlType} from '/lib/xp/admin';
+import {getBaseUri, getHomeToolUrl, HomeToolUrlType} from '/lib/xp/admin';
 ```
 
 Setting `baseUrl` and `paths` will allow the `tsc` to keep the valid paths in the resulting JavaScript files.

package/admin.d.ts

@@ -3,48 +3,6 @@ declare global {
         '/lib/xp/admin': typeof import('./admin');
     }
 }
-/**
- * Returns the admin base uri.
- *
- * @returns {string} Admin base uri.
- */
-export declare function getBaseUri(): string;
-/**
- * Returns the admin assets uri.
- *
- * @returns {string} Assets uri.
- */
-export declare function getAssetsUri(): string;
-/**
- * Returns the preferred locale based on the current HTTP request, or the server default locale if none is specified.
- *
- * @returns {string} Current locale.
- */
-export declare function getLocale(): string;
-/**
- * Returns the list of preferred locales based on the current HTTP request, or the server default locale if none is specified.
- *
- * @returns {string[]} Current locales in order of preference.
- */
-export declare function getLocales(): string[];
-/**
- * Returns all i18n phrases.
- *
- * @returns {object} JSON object with phrases.
- */
-export declare function getPhrases(): string;
-/**
- * Returns the URL for launcher panel.
- *
- * @returns {string} URL.
- */
-export declare function getLauncherUrl(): string;
-/**
- * Returns the URL for launcher javascript.
- *
- * @returns {string} Path.
- */
-export declare function getLauncherPath(): string;
 /**
  * Returns the URL for an admin tool of specific application.
  * @param {string} application Full application name (f.ex, 'com.enonic.app')
@@ -60,11 +18,11 @@ export declare function getToolUrl(application: string, tool: string): string;
  *
  * @returns {string} URL.
  */
-export declare function getHomeToolUrl(params: GetHomeToolUrlParams): string;
+export declare function getHomeToolUrl(params?: GetHomeToolUrlParams): string;
 export interface GetHomeToolUrlParams {
     type: HomeToolUrlType;
 }
-export declare type HomeToolUrlType = 'server' | 'absolute';
+export type HomeToolUrlType = 'server' | 'absolute';
 /**
  * Returns installation name.
  *
@@ -77,3 +35,41 @@ export declare function getInstallation(): string;
  * @returns {string} Version.
  */
 export declare function getVersion(): string;
+export interface WidgetUrlParams {
+    application: string;
+    widget: string;
+    type?: 'server' | 'absolute';
+    params?: object;
+}
+/**
+ * @deprecated Use `extensionUrl` instead. This function will be removed in future versions.
+ *
+ * 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 query parameters to append to the URL.
+ *
+ * @returns {string} URL.
+ */
+export declare function widgetUrl(params: WidgetUrlParams): string;
+export interface ExtensionUrlParams {
+    application: string;
+    extension: string;
+    type?: 'server' | 'absolute';
+    params?: object;
+}
+/**
+ * Returns the URL for an extension.
+ *
+ * @param {object} [params] Parameter object
+ * @param {string} params.application Application to reference to an extension.
+ * @param {string} params.extension Name of the extension.
+ * @param {string} [params.type=server] URL type. Either `server` (server-relative URL) or `absolute`.
+ * @param {object} [params.params] Custom query parameters to append to the URL.
+ *
+ * @returns {string} URL.
+ */
+export declare function extensionUrl(params: ExtensionUrlParams): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-admin",
-    "version": "7.16.2",
+    "version": "8.0.0-A3",
     "description": "Type definitions for lib-admin.",
     "types": "admin.d.ts",
     "files": [
@@ -26,7 +26,9 @@
         "url": "https://github.com/enonic/xp/issues"
     },
     "homepage": "https://github.com/enonic/xp/tree/master#readme",
-    "dependencies": {},
+    "dependencies": {
+        "@enonic-types/core": "8.0.0-A3"
+    },
     "publishConfig": {
         "access": "public"
     }