@enonic-types/global 0.1.0 → 0.1.1

package/README.md

@@ -23,7 +23,7 @@ Add the corresponding types to your `tsconfig.json` file that is used for applic
 }
 ```
 
-> The paths to the `node_mosules` assume that your `tsconfig.json` is placed under your project root.
+> The paths to the `node_modules` assume that your `tsconfig.json` is placed under your project root.
 
 After that, all the global XP variables will be typed.
 
@@ -36,7 +36,8 @@ libraries are also added to your `tsconfig.json`.
 
 ### Require
 
-To add support for type resolution for the custom libraries via `require`, you can redeclare the `XpLibraries` interface in global scope, wich will lead to declaration merging:
+To add support for type resolution for the custom libraries via `require`, you can redeclare the `XpLibraries` interface in global scope,
+which will lead to declaration merging:
 
 ```ts
 declare global {

package/global.d.ts

@@ -1,18 +1,56 @@
-/**
- * This project don't include XP libraries definitions and need this interface
- * to properly map imports via require.
- *
- * Warning: this interface is empty. If you want type definitions for various
- * libraries, you need to redefine this interface in your library in global
- * path and add a new property with library path.
- *
- * @example
- * declare global {
- *     interface XpLibraries {
- *         '/lib/xp/event': typeof import('./event');
- *     }
- * }
-*/
 interface XpLibraries {}
 
 interface XpBeans {}
+
+declare const app: {
+    name: string;
+    version: string;
+    config: Record<string, string | undefined>;
+};
+
+declare const log: {
+    debug: (...args: unknown[]) => void;
+    info: (...args: unknown[]) => void;
+    warning: (...args: unknown[]) => void;
+    error: (...args: unknown[]) => void;
+};
+
+declare interface ScriptValue {
+    isArray(): boolean;
+
+    isObject(): boolean;
+
+    isValue(): boolean;
+
+    isFunction(): boolean;
+
+    getValue(): unknown;
+
+    getKeys(): string[];
+
+    hasMember(key: string): boolean;
+
+    getMember(key: string): ScriptValue;
+
+    getArray(): ScriptValue[];
+
+    getMap(): Record<string, unknown>;
+
+    getList(): object[];
+}
+
+type NewBean = <T = unknown, Bean extends keyof XpBeans | string = string>(bean: Bean) =>
+    Bean extends keyof XpBeans ? XpBeans[Bean] : T;
+
+declare const __: {
+    newBean: NewBean;
+    toNativeObject: <T = unknown>(beanResult: T) => T;
+    toScriptValue: <T = object>(value: T) => ScriptValue;
+    disposer: (callback: (...args: unknown[]) => unknown) => void;
+    nullOrValue: <T = object>(value: T) => T | null | undefined;
+};
+
+declare type XpRequire = <Key extends keyof XpLibraries | string = string>(path: Key) =>
+    Key extends keyof XpLibraries ? XpLibraries[Key] : unknown;
+
+declare const require: XpRequire;

package/package.json

@@ -1,32 +1,32 @@
-{
-    "name": "@enonic-types/global",
-    "version": "0.1.0",
-    "description": "Type definitions for XP JavaScript global object properties.",
-    "types": "index.d.ts",
-    "files": [
-        "index.d.ts",
-        "global.d.ts"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/enonic/xp.git#master"
-    },
-    "keywords": [
-        "enonic",
-        "enonic-xp",
-        "global",
-        "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"
-    }
-}
+{
+    "name": "@enonic-types/global",
+    "version": "0.1.1",
+    "description": "Type definitions for global.",
+    "types": "global.d.ts",
+    "files": [
+        "global.d.ts"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/enonic/xp.git#master"
+    },
+    "keywords": [
+        "enonic",
+        "enonic-xp",
+        "global",
+        "common",
+        "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"
+    }
+}

package/index.d.ts

@@ -1,54 +0,0 @@
-/// <reference path='global.d.ts' />
-
-declare const app: {
-    name: string;
-    version: string;
-    config: Record<string, string | undefined>;
-};
-
-declare const log: {
-    debug: (...args: unknown[]) => void;
-    info: (...args: unknown[]) => void;
-    warning: (...args: unknown[]) => void;
-    error: (...args: unknown[]) => void;
-};
-
-declare interface ScriptValue {
-    isArray(): boolean;
-
-    isObject(): boolean;
-
-    isValue(): boolean;
-
-    isFunction(): boolean;
-
-    getValue(): unknown;
-
-    getKeys(): string[];
-
-    hasMember(key: string): boolean;
-
-    getMember(key: string): ScriptValue;
-
-    getArray(): ScriptValue[];
-
-    getMap(): Record<String, unknown>;
-
-    getList(): object[];
-}
-
-type NewBean = <T = unknown, Bean extends keyof XpBeans | string = string>(bean: Bean) =>
-    Bean extends keyof XpBeans ? XpBeans[Bean] : T;
-
-declare const __: {
-    newBean: NewBean;
-    toNativeObject: <T = unknown>(beanResult: T) => T;
-    toScriptValue: <T = object>(value: T) => ScriptValue;
-    disposer: (callback: (...args: unknown[]) => unknown) => void;
-    nullOrValue: <T = object>(value: T) => T | null | undefined;
-};
-
-declare type XpRequire = <Key extends keyof XpLibraries | string = string>(path: Key) =>
-    Key extends keyof XpLibraries ? XpLibraries[Key] : unknown;
-
-declare const require: XpRequire;