@enonic-types/lib-app 7.11.0-B1

package/README.md

@@ -0,0 +1,97 @@
+# Enonic XP lib-app TS types
+
+> TypeScript definitions for `lib-app` library of Enonic XP
+
+## Install
+
+```bash
+npm i --save-dev @enonic/lib-app
+```
+
+## 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-app"
+    ]
+  }
+}
+```
+
+### 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-app"
+    ]
+  }
+}
+```
+
+`example.ts`
+
+```ts
+const {
+    createVirtualApplication,
+    deleteVirtualApplication,
+    get,
+    list,
+    getDescriptor,
+    hasVirtual,
+    hasReal
+} = require('/lib/xp/app');
+```
+
+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-app"
+    ]
++   "baseUrl": "./",
++   "paths": {
++     "/lib/xp/app": ["node_modules/@enonic-types/lib-app"],
++   }
+  }
+}
+```
+
+`example.ts`
+
+```ts
+import {
+    createVirtualApplication,
+    deleteVirtualApplication,
+    get,
+    list,
+    getDescriptor,
+    hasVirtual,
+    hasReal
+} from '/lib/xp/app';
+```
+
+Setting `baseUrl` and `paths` will allow the `tsc` to keep the valid paths in the resulting JavaScript files.

package/app.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Application related functions.
+ *
+ * @example
+ * var schema = require('/lib/xp/app');
+ *
+ * @module app
+ */
+declare global {
+    interface XpLibraries {
+        '/lib/xp/app': typeof import('./app');
+    }
+}
+export interface CreateVirtualApplicationParams {
+    key: string;
+}
+export interface Application {
+    key: string;
+    displayName: string | null;
+    vendorName: string | null;
+    vendorUrl: string | null;
+    url: string | null;
+    version: string | null;
+    systemVersion: string | null;
+    minSystemVersion: string | null;
+    maxSystemVersion: string | null;
+    modifiedTime: string | null;
+    started: boolean | null;
+    system: boolean | null;
+}
+/**
+ * Creates virtual application.
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Application key.
+ *
+ * @returns {object} created application.
+ */
+export declare function createVirtualApplication(params: CreateVirtualApplicationParams): Application;
+export interface DeleteVirtualApplicationParams {
+    key: string;
+}
+/**
+ * Deletes virtual application.
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Application key.
+ *
+ * @returns {boolean} deletion result.
+ */
+export declare function deleteVirtualApplication(params: DeleteVirtualApplicationParams): boolean;
+export interface GetApplicationParams {
+    key: string;
+}
+/**
+ * Fetches application by key.
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Application key.
+ *
+ * @returns {Application} fetched application.
+ */
+export declare function get(params: GetApplicationParams): Application;
+/**
+ * Fetches both static and virtual applications.
+ *
+ * @returns {object[]} applications list.
+ */
+export declare function list(): Application[];
+export interface GetApplicationDescriptorParams {
+    key: string;
+}
+export interface Icon {
+    data: unknown;
+    mimeType: string;
+    modifiedTime: string;
+}
+export interface ApplicationDescriptor {
+    key: string;
+    description: string | null;
+    icon?: Icon;
+}
+/**
+ * Fetches application descriptor by key.
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Application key.
+ *
+ * @returns {object} fetched application descriptor.
+ */
+export declare function getDescriptor(params: GetApplicationDescriptorParams): ApplicationDescriptor;
+export interface HasVirtualApplicationParams {
+    key: string;
+}
+/**
+ * Checks if there is a virtual app with the app key.
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Application key.
+ *
+ * @returns {boolean} result.
+ */
+export declare function hasVirtual(params: HasVirtualApplicationParams): boolean;
+export interface HasRealApplicationParams {
+    key: string;
+}
+/**
+ * Checks if there is a real app with the app key.
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.key Application key.
+ *
+ * @returns {boolean} result.
+ */
+export declare function hasReal(params: HasRealApplicationParams): boolean;

package/package.json

@@ -0,0 +1,32 @@
+{
+    "name": "@enonic-types/lib-app",
+    "version": "7.11.0-B1",
+    "description": "Type definitions for lib-app.",
+    "types": "app.d.ts",
+    "files": [
+        "app.d.ts"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/enonic/xp.git#master"
+    },
+    "keywords": [
+        "enonic",
+        "enonic-xp",
+        "lib-app",
+        "app",
+        "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"
+    }
+}