@enonic-types/lib-app 7.11.0-B1 → 7.11.0-B4

package/README.md

@@ -5,7 +5,7 @@
 ## Install
 
 ```bash
-npm i --save-dev @enonic/lib-app
+npm i --save-dev @enonic-types/lib-app
 ```
 
 ## Use
@@ -26,17 +26,16 @@ Add the corresponding types to your `tsconfig.json` file that is used for applic
 
 ### 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.
+To make `require` work out of the 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 a library by the default path will return typed object.
 
 `tsconfig.json`
 
-```diff
+```json
 {
   "compilerOptions": {
     "types": [
-+     "@enonic-types/global"
-      "@enonic-types/lib-app"
+      "@enonic-types/global"
     ]
   }
 }
@@ -57,7 +56,7 @@ const {
 ```
 
 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).
+found [here](https://developer.enonic.com/docs/xp/stable/api).
 
 ### ES6-style import
 
@@ -66,16 +65,13 @@ types mapping to your configuration.
 
 `tsconfig.json`
 
-```diff
+```json
 {
   "compilerOptions": {
-    "types": [
-      "@enonic-types/lib-app"
-    ]
-+   "baseUrl": "./",
-+   "paths": {
-+     "/lib/xp/app": ["node_modules/@enonic-types/lib-app"],
-+   }
+    "baseUrl": "./",
+    "paths": {
+      "/lib/xp/app": ["node_modules/@enonic-types/lib-app"]
+    }
   }
 }
 ```

package/app.d.ts

@@ -101,15 +101,15 @@ export interface HasVirtualApplicationParams {
  * @returns {boolean} result.
  */
 export declare function hasVirtual(params: HasVirtualApplicationParams): boolean;
-export interface HasRealApplicationParams {
+export interface GetApplicationModeParams {
     key: string;
 }
 /**
- * Checks if there is a real app with the app key.
+ * Fetches a mode of the app with the app key.
  *
  * @param {object} params JSON with the parameters.
  * @param {string} params.key Application key.
  *
- * @returns {boolean} result.
+ * @returns {string} application mode.
  */
-export declare function hasReal(params: HasRealApplicationParams): boolean;
+export declare function getApplicationMode(params: GetApplicationModeParams): string | null;

package/package.json

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