@enonic-types/lib-app 8.0.0-B4 → 8.0.0-RC1

package/README.md

@@ -50,8 +50,7 @@ const {
     get,
     list,
     getDescriptor,
-    hasVirtual,
-    hasReal
+    getApplicationMode
 } = require('/lib/xp/app');
 ```
 
@@ -85,8 +84,7 @@ import {
     get,
     list,
     getDescriptor,
-    hasVirtual,
-    hasReal
+    getApplicationMode
 } from '/lib/xp/app';
 ```
 

package/app.d.ts

@@ -23,8 +23,8 @@ export interface Application {
     minSystemVersion: string | null;
     maxSystemVersion: string | null;
     modifiedTime: string | null;
-    started: boolean | null;
-    system: boolean | null;
+    started: boolean;
+    system: boolean;
 }
 /**
  * Creates virtual application.
@@ -32,7 +32,7 @@ export interface Application {
  * @param {object} params JSON with the parameters.
  * @param {string} params.key Application key.
  *
- * @returns {object} created application.
+ * @returns {Application} created application.
  */
 export declare function createVirtualApplication(params: CreateVirtualApplicationParams): Application;
 export interface DeleteVirtualApplicationParams {
@@ -56,13 +56,13 @@ export interface GetApplicationParams {
  * @param {object} params JSON with the parameters.
  * @param {string} params.key Application key.
  *
- * @returns {Application} fetched application.
+ * @returns {Application | null} fetched application, or null if not found.
  */
-export declare function get(params: GetApplicationParams): Application;
+export declare function get(params: GetApplicationParams): Application | null;
 /**
  * Fetches both static and virtual applications.
  *
- * @returns {object[]} applications list.
+ * @returns {Application[]} applications list.
  */
 export declare function list(): Application[];
 export interface GetApplicationDescriptorParams {
@@ -75,7 +75,8 @@ export interface Icon {
 }
 export interface ApplicationDescriptor {
     key: string;
-    description: string | null;
+    description: string;
+    descriptionI18nKey: string | null;
     title: string | null;
     titleI18nKey: string | null;
     vendorName: string | null;
@@ -89,21 +90,9 @@ export interface ApplicationDescriptor {
  * @param {object} params JSON with the parameters.
  * @param {string} params.key Application key.
  *
- * @returns {object} fetched application descriptor.
+ * @returns {ApplicationDescriptor | null} fetched application descriptor, or null if not found.
  */
-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 declare function getDescriptor(params: GetApplicationDescriptorParams): ApplicationDescriptor | null;
 export interface GetApplicationModeParams {
     key: string;
 }
@@ -113,6 +102,6 @@ export interface GetApplicationModeParams {
  * @param {object} params JSON with the parameters.
  * @param {string} params.key Application key.
  *
- * @returns {string} application mode.
+ * @returns {string | null} application mode, or null if the application is not installed.
  */
 export declare function getApplicationMode(params: GetApplicationModeParams): string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-app",
-    "version": "8.0.0-B4",
+    "version": "8.0.0-RC1",
     "description": "Type definitions for lib-app.",
     "types": "app.d.ts",
     "files": [
@@ -27,7 +27,7 @@
     },
     "homepage": "https://github.com/enonic/xp/tree/master#readme",
     "dependencies": {
-        "@enonic-types/core": "8.0.0-B4"
+        "@enonic-types/core": "8.0.0-RC1"
     },
     "publishConfig": {
         "access": "public"