@enonic-types/lib-admin 0.1.0

package/README.md

@@ -0,0 +1,81 @@
+# Enonic XP lib-admin TS types
+
+> TypeScript definitions for `lib-admin` library of Enonic XP
+
+## Install
+
+```bash
+npm i --save-dev @enonic/lib-admin
+```
+
+## Use
+
+Add the corresponding types to your `tsconfig.json` file that is used for application's server-side TypeScript code.
+
+`tsconfig.json`
+
+```json
+{
+  "compilerOptions": {
+    "types": [
+      "@enonic-types/lib-admin"
+    ]
+  }
+}
+```
+
+### Require and custom imports
+
+To make `require` work out of box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP global
+objects, e.g. `log`, `app`, `__`, etc, requiring library by the default path will return typed object.
+
+`tsconfig.json`
+
+```diff
+{
+  "compilerOptions": {
+    "types": [
++     "@enonic-types/global"
+      "@enonic-types/lib-admin"
+    ]
+  }
+}
+```
+
+`example.ts`
+
+```ts
+const {getBaseUri, getAssetsUri, getHomeToolUrl, HomeToolUrlType} = require('/lib/xp/admin');
+```
+
+More detailed explanation on how it works and how to type custom import function can be
+found [here](https://github.com/enonic/xp/tree/master/modules/lib/typescript/README.md).
+
+### ES6-style import
+
+If you are planning to use `import` in your code and transpile it with the default `tsc` TypeScript compiler, you'll need to add proper
+types mapping to your configuration.
+
+`tsconfig.json`
+
+```diff
+{
+  "compilerOptions": {
+    "types": [
+      "@enonic-types/lib-admin"
+    ]
++   "baseUrl": "./",
++   "paths": {
++     "/lib/xp/admin": ["node_modules/@enonic-types/lib-admin"],
++   }
+  }
+}
+```
+
+`example.ts`
+
+```ts
+import {getBaseUri, getAssetsUri, 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

@@ -0,0 +1,79 @@
+declare global {
+    interface XpLibraries {
+        '/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')
+ * @param {string} tool Name of the tool inside an app (f.ex, 'main')
+ *
+ * @returns {string} URL.
+ */
+export declare function getToolUrl(application: string, tool: string): string;
+/**
+ * Returns the URL for the Home admin tool.
+ * @param {object} [params] Parameter object
+ * @param {string} [params.type=server] URL type. Either `server` (server-relative URL) or `absolute`.
+ *
+ * @returns {string} URL.
+ */
+export declare function getHomeToolUrl(params: GetHomeToolUrlParams): string;
+export interface GetHomeToolUrlParams {
+    type: HomeToolUrlType;
+}
+export declare type HomeToolUrlType = 'server' | 'absolute';
+/**
+ * Returns installation name.
+ *
+ * @returns {string} Installation name.
+ */
+export declare function getInstallation(): string;
+/**
+ * Returns version of XP installation.
+ *
+ * @returns {string} Version.
+ */
+export declare function getVersion(): string;

package/package.json

@@ -0,0 +1,36 @@
+{
+    "name": "@enonic-types/lib-admin",
+    "version": "0.1.0",
+    "description": "Type definitions for lib-admin.",
+    "types": "admin.d.ts",
+    "files": [
+        "admin.d.ts"
+    ],
+    "scripts": {
+        "pre": "npm run --prefix ../ pre",
+        "packlist": "npx npm-packlist"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/enonic/xp.git#master"
+    },
+    "keywords": [
+        "enonic",
+        "enonic-xp",
+        "lib-admin",
+        "admin",
+        "types",
+        "typescript"
+    ],
+    "contributors": [
+        "Mikita Taukachou <edloidas@gmail.com> (https://edloidas.github.io/)"
+    ],
+    "license": "Apache-2.0",
+    "bugs": {
+        "url": "https://github.com/enonic/xp/issues"
+    },
+    "homepage": "https://github.com/enonic/xp/tree/master#readme",
+    "publishConfig": {
+        "access": "public"
+    }
+}