@enonic-types/global 7.14.4-RC1 → 7.15.0-A1

package/global.d.ts

@@ -1,210 +1,100 @@
-interface XpLibraries {}
+import type {
+    App,
+    DoubleUnderscore,
+    Log,
+    Resolve,
+    XpRequire,
+} from '@enonic-types/core';
 
-interface XpBeans {}
 
-/**
- * The globally available app object holds information about the contextual application.
- * @example
- * var nameVersion = app.name + ' v' + app.version;
- *
- * @global
- * @namespace
- */
-declare const app: {
+declare global {
     /**
-     * The name of the application.
+     * The globally available app object holds information about the contextual application.
+     * @example
+     * var nameVersion = app.name + ' v' + app.version;
      *
-     * @type string
+     * @global
+     * @namespace
      */
-    name: string;
+    declare const app: App;
+
     /**
-     * Version of the application.
+     * Logging functions.
      *
-     * @type string
-     */
-    version: string;
-    /**
-     * Values from the application’s configuration file.
-     * This can be set using $XP_HOME/config/<app.name>.cfg.
-     * Every time the configuration is changed the app is restarted.
+     * @example
+     * // Log with simple message
+     * log.debug('My log message');
      *
-     * @type Object
-     */
-    config: Record<string, string | undefined>;
-};
-
-/**
- * Logging functions.
- *
- * @example
- * // Log with simple message
- * log.debug('My log message');
- *
- * @example
- * // Log with placeholders
- * log.info('My %s message with %s', 'log', 'placeholders');
- *
- * @example
- * // Log a JSON object
- * log.warning('My JSON: %s', {a: 1});
- *
- * @example
- * // Log JSON object using string
- * log.error('My JSON: %s', JSON.stringify({a: 1}, null, 2));
- *
- * @global
- * @namespace
- */
-declare const log: {
-    /**
-     * Log debug message.
+     * @example
+     * // Log with placeholders
+     * log.info('My %s message with %s', 'log', 'placeholders');
      *
-     * @param {Array} args... logging arguments.
-     */
-    debug: (...args: unknown[]) => void;
-
-    /**
-     * Log info message.
+     * @example
+     * // Log a JSON object
+     * log.warning('My JSON: %s', {a: 1});
      *
-     * @param {Array} args... logging arguments.
-     */
-    info: (...args: unknown[]) => void;
-
-    /**
-     * Log warning message.
+     * @example
+     * // Log JSON object using string
+     * log.error('My JSON: %s', JSON.stringify({a: 1}, null, 2));
      *
-     * @param {Array} args... logging arguments.
+     * @global
+     * @namespace
      */
-    warning: (...args: unknown[]) => void;
+    declare const log: Log;
 
     /**
-     * Log error message.
+     * Javascript to Java bridge functions.
+     *
+     * @example
+     * var bean = __.newBean('com.enonic.xp.MyJavaUtils');
+     *
+     * @example
+     * return __.toNativeObject(bean.findArray(arrayName));
      *
-     * @param {Array} args... logging arguments.
+     * @global
+     * @namespace
      */
-    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;
+    declare const __: DoubleUnderscore;
 
-    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;
-
-/**
- * Javascript to Java bridge functions.
- *
- * @example
- * var bean = __.newBean('com.enonic.xp.MyJavaUtils');
- *
- * @example
- * return __.toNativeObject(bean.findArray(arrayName));
- *
- * @global
- * @namespace
- */
-declare const __: {
-    /**
-     * Creates a new JavaScript bean that wraps the given Java class and makes its methods available to be called from JavaScript.
-     */
-    newBean: NewBean;
-    /**
-     * Converts arrays or complex Java objects to JSON.
-     * @param value Value to convert
-     */
-    toNativeObject: <T = unknown>(value: T) => T;
-    /**
-     * Converts JSON to a Java Map structure that can be used as parameters to a Java method on a bean created with newBean.
-     * @param value Value to convert
-     */
-    toScriptValue: <T = object>(value: T) => ScriptValue;
     /**
-     * Add a disposer that is called when the app is stopped.
-     * @param callback Function to call
-     */
-    disposer: (callback: (...args: unknown[]) => unknown) => void;
-    /**
-     * Converts a JavaScript variable that is undefined to a Java <code>null</code> object.
-     * If the JavaScript variable is defined, it is returned as is.
-     * @param value Value to convert
+     * This globally available function will load a JavaScript file and return the exports as objects.
+     * The function implements parts of the `CommonJS Modules Specification`.
+     *
+     * @example
+     * // Require relative to this
+     * var other = require('./other.js');
+     *
+     * @example
+     * // Require absolute
+     * var other = require('/path/to/other.js');
+     *
+     * @example
+     * // Require without .js extension
+     * var other = require('./other');
+     *
+     * @param {string} path Path for javascript file (relative or absolute and .js ending is optional).
+     * @returns {object} Exports from loaded javascript.
+     * @global
      */
-    nullOrValue: <T = object>(value: T) => T | null | undefined;
+    declare const require: XpRequire;
 
     /**
-     * Doc registerMock.
+     * Resolves a path to another file. Can use relative or absolute path.
      *
-     * @param name Name of mock.
-     * @param value Value to register.
+     * @example
+     * // Resolve relative to this
+     * var path = resolve('./other.html');
+     *
+     * @example
+     * // Resolve absolute
+     * var path = resolve('/path/to/other.html');
+     *
+     * @param {string} path Path to resolve.
+     * @returns {*} Reference to an object.
+     * @global
      */
-    registerMock: (name: string, value: object) => void
-};
-
-declare type XpRequire = <Key extends keyof XpLibraries | string = string>(path: Key) =>
-    Key extends keyof XpLibraries ? XpLibraries[Key] : unknown;
-
-/**
- * This globally available function will load a JavaScript file and return the exports as objects.
- * The function implements parts of the `CommonJS Modules Specification`.
- *
- * @example
- * // Require relative to this
- * var other = require('./other.js');
- *
- * @example
- * // Require absolute
- * var other = require('/path/to/other.js');
- *
- * @example
- * // Require without .js extension
- * var other = require('./other');
- *
- * @param {string} path Path for javascript file (relative or absolute and .js ending is optional).
- * @returns {object} Exports from loaded javascript.
- * @global
- */
-declare const require: XpRequire;
+    declare const resolve: Resolve;
+}
 
-/**
- * Resolves a path to another file. Can use relative or absolute path.
- *
- * @example
- * // Resolve relative to this
- * var path = resolve('./other.html');
- *
- * @example
- * // Resolve absolute
- * var path = resolve('/path/to/other.html');
- *
- * @param {string} path Path to resolve.
- * @returns {*} Reference to an object.
- * @global
- */
-declare const resolve: (path: string) => {
-    getApplicationKey(): string;
-    getPath(): string;
-    getUri(): string;
-    isRoot(): boolean;
-    getName(): string;
-    getExtension(): string;
-};
+// Making sure the file is a module
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/global",
-    "version": "7.14.4-RC1",
+    "version": "7.15.0-A1",
     "description": "Global variables and functions type definition.",
     "types": "global.d.ts",
     "files": [
@@ -26,7 +26,9 @@
         "url": "https://github.com/enonic/xp/issues"
     },
     "homepage": "https://github.com/enonic/xp/tree/master#readme",
-    "dependencies": {},
+    "dependencies": {
+        "@enonic-types/core": "7.15.0-A1"
+    },
     "publishConfig": {
         "access": "public"
     }