iobroker.javascript 10.0.0 → 10.1.1

package/build/lib/secrets.js

@@ -0,0 +1,220 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecretsManager = exports.SECRETS_PREFIX = void 0;
+exports.isSecretId = isSecretId;
+exports.getSecretName = getSecretName;
+/**
+ * Access to the central ioBroker credential store (`system.credentials.*`) from scripts.
+ *
+ * The admin UI manages the credentials under "Basic settings" → "Credentials". Every credential
+ * has an ID like `system.credentials.CameraPassword` and holds either a single `key` (API keys)
+ * or a `login`/`password` pair. The secret fields are stored encrypted with the system secret.
+ *
+ * This manager keeps all credentials decrypted in memory and exposes them to the scripts as the
+ * global `SECRETS` object, so a script can simply write:
+ *
+ * ```js
+ * const password = SECRETS.CameraPassword.key;
+ * ```
+ *
+ * The cache is kept up to date while the adapter is running, so editing a credential in the admin
+ * UI takes effect immediately - without restarting the adapter or the scripts.
+ */
+// Imported from its own entry point on purpose: the package index of `@iobroker/adapter-core`
+// looks for js-controller while it is being loaded and terminates the process with exit code 10
+// when it is missing. This module is required by the unit tests, which run without a controller,
+// so it must stay clear of that side effect. `@iobroker/adapter-core/credentials` is free of it -
+// it is written to be usable in browser builds as well.
+const Credentials = __importStar(require("@iobroker/adapter-core/credentials"));
+/** Prefix of all credential object IDs */
+exports.SECRETS_PREFIX = 'system.credentials.';
+/**
+ * Checks if the given object ID belongs to the central credential store.
+ *
+ * @param id Object ID, e.g. `system.credentials.CameraPassword`
+ */
+function isSecretId(id) {
+    return id.startsWith(exports.SECRETS_PREFIX) && id.length > exports.SECRETS_PREFIX.length;
+}
+/**
+ * Extracts the name a credential is exposed under in `SECRETS`.
+ *
+ * @param id Object ID, e.g. `system.credentials.CameraPassword`
+ */
+function getSecretName(id) {
+    return id.substring(exports.SECRETS_PREFIX.length);
+}
+class SecretsManager {
+    adapter;
+    /** Decrypted credentials, keyed by name (the credential ID without the `system.credentials.` prefix) */
+    cache = new Map();
+    /** If the scripts may read the credentials at all (adapter option `enableSecrets`) */
+    enabled = false;
+    /** Warn only once per script run that the feature is disabled */
+    disabledWarningShown = false;
+    /**
+     * The object handed to the scripts as the global `SECRETS`.
+     *
+     * It is a read-only view on the cache, so the values stay up to date without the scripts
+     * having to re-read anything, and a script cannot modify the credentials of another script.
+     */
+    secrets;
+    constructor(adapter) {
+        this.adapter = adapter;
+        this.secrets = new Proxy(Object.create(null), {
+            get: (_target, prop) => typeof prop === 'string' ? this.get(prop) : undefined,
+            has: (_target, prop) => typeof prop === 'string' && this.cache.has(prop),
+            ownKeys: () => (this.enabled ? Array.from(this.cache.keys()) : []),
+            getOwnPropertyDescriptor: (_target, prop) => {
+                const value = typeof prop === 'string' ? this.get(prop) : undefined;
+                return value === undefined
+                    ? undefined
+                    : { value, enumerable: true, configurable: true, writable: false };
+            },
+            // The credentials belong to the system - scripts may read them, but never change them
+            set: () => false,
+            defineProperty: () => false,
+            deleteProperty: () => false,
+        });
+    }
+    /** Reads one credential from the cache and warns if the whole feature is switched off */
+    get(name) {
+        if (!this.enabled) {
+            if (!this.disabledWarningShown) {
+                this.disabledWarningShown = true;
+                this.adapter.log.warn(`A script tried to read the secret "${name}", but the access to the credentials is disabled. Enable "Allow scripts to read the credentials" in the instance settings.`);
+            }
+            return undefined;
+        }
+        return this.cache.get(name);
+    }
+    /**
+     * Reads all credentials of the central store and decrypts them.
+     *
+     * @param enabled Value of the adapter option `enableSecrets`
+     */
+    async load(enabled) {
+        this.cache.clear();
+        this.disabledWarningShown = false;
+        this.enabled = enabled;
+        if (!enabled) {
+            return;
+        }
+        if (!Credentials?.listCredentials) {
+            this.adapter.log.warn('Cannot read the credentials for "SECRETS": the credentials API is only available with js-controller 7.2 or newer');
+            this.enabled = false;
+            return;
+        }
+        try {
+            const list = await Credentials.listCredentials(this.adapter);
+            for (const entry of list) {
+                await this.update(entry.id);
+            }
+            this.adapter.log.debug(`${this.cache.size} secret(s) available in the scripts as "SECRETS"`);
+        }
+        catch (e) {
+            this.adapter.log.warn(`Cannot read the credentials: ${e instanceof Error ? e.message : String(e)}`);
+        }
+    }
+    /**
+     * Reads one credential and decrypts it. Called for every change of a `system.credentials.*`
+     * object, so edits in the admin UI are visible in the scripts immediately.
+     *
+     * @param id Object ID, e.g. `system.credentials.CameraPassword`
+     */
+    async update(id) {
+        if (!this.enabled || !isSecretId(id)) {
+            return;
+        }
+        const name = getSecretName(id);
+        try {
+            const credentials = await Credentials.getCredentials(this.adapter, id);
+            this.cache.set(name, Object.freeze({ ...credentials.values }));
+        }
+        catch (e) {
+            this.cache.delete(name);
+            this.adapter.log.warn(`Cannot read the secret "${name}": ${e instanceof Error ? e.message : String(e)}`);
+        }
+    }
+    /**
+     * Forgets one credential because its object was deleted.
+     *
+     * @param id Object ID, e.g. `system.credentials.CameraPassword`
+     */
+    remove(id) {
+        if (isSecretId(id) && this.cache.delete(getSecretName(id))) {
+            this.adapter.log.debug(`Secret "${getSecretName(id)}" was deleted`);
+        }
+    }
+    /**
+     * The structure of the credential store without any secret value: which credentials exist and
+     * which fields each of them has. Used by the instance settings and the Blockly editor to show
+     * the user what `SECRETS.<name>.<field>` expressions are available.
+     */
+    getStructure() {
+        return Array.from(this.cache.entries())
+            .map(([name, values]) => ({ name, fields: Object.keys(values).sort() }))
+            .sort((a, b) => a.name.localeCompare(b.name));
+    }
+    /**
+     * Builds the ambient TypeScript declarations for the credentials that currently exist, so the
+     * editor can suggest their names after typing `SECRETS.` and their fields after the next dot.
+     * The names are merged into the `iobJS.Secrets` interface, which has an index signature for
+     * all other names.
+     */
+    getDeclarations() {
+        const lines = [
+            '// Generated by ioBroker.javascript from the central credential store - do not edit',
+            'declare namespace iobJS {',
+            '    interface Secrets {',
+        ];
+        for (const { name, fields } of this.getStructure()) {
+            const values = this.cache.get(name);
+            // Declare the fields this credential really has, so the editor suggests exactly those
+            const members = fields.map(field => `${JSON.stringify(field)}: ${typeof values[field]}`).join('; ');
+            lines.push(`        ${JSON.stringify(name)}: { ${members} };`);
+        }
+        lines.push('    }', '}', '');
+        return lines.join('\n');
+    }
+    /** Forgets all decrypted credentials */
+    destroy() {
+        this.cache.clear();
+        this.enabled = false;
+    }
+}
+exports.SecretsManager = SecretsManager;
+//# sourceMappingURL=secrets.js.map

package/build/lib/secrets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secrets.js","sourceRoot":"","sources":["../../src/lib/secrets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CA,gCAEC;AAOD,sCAEC;AAzDD;;;;;;;;;;;;;;;;GAgBG;AACH,8FAA8F;AAC9F,gGAAgG;AAChG,iGAAiG;AACjG,kGAAkG;AAClG,wDAAwD;AACxD,gFAAkE;AAElE,0CAA0C;AAC7B,QAAA,cAAc,GAAG,qBAAqB,CAAC;AAgBpD;;;;GAIG;AACH,SAAgB,UAAU,CAAC,EAAU;IACjC,OAAO,EAAE,CAAC,UAAU,CAAC,sBAAc,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,sBAAc,CAAC,MAAM,CAAC;AAC9E,CAAC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,EAAU;IACpC,OAAO,EAAE,CAAC,SAAS,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED,MAAa,cAAc;IACN,OAAO,CAAmB;IAE3C,wGAAwG;IACvF,KAAK,GAAwC,IAAI,GAAG,EAAE,CAAC;IAExE,sFAAsF;IAC9E,OAAO,GAAG,KAAK,CAAC;IAExB,iEAAiE;IACzD,oBAAoB,GAAG,KAAK,CAAC;IAErC;;;;;OAKG;IACa,OAAO,CAAU;IAEjC,YAAY,OAAyB;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,OAAO,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAY,EAAE;YACrD,GAAG,EAAE,CAAC,OAAgB,EAAE,IAAqB,EAA4B,EAAE,CACvE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YACzD,GAAG,EAAE,CAAC,OAAgB,EAAE,IAAqB,EAAW,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3G,OAAO,EAAE,GAAa,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5E,wBAAwB,EAAE,CAAC,OAAgB,EAAE,IAAqB,EAAkC,EAAE;gBAClG,MAAM,KAAK,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBACpE,OAAO,KAAK,KAAK,SAAS;oBACtB,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;YAC3E,CAAC;YACD,sFAAsF;YACtF,GAAG,EAAE,GAAY,EAAE,CAAC,KAAK;YACzB,cAAc,EAAE,GAAY,EAAE,CAAC,KAAK;YACpC,cAAc,EAAE,GAAY,EAAE,CAAC,KAAK;SACvC,CAAC,CAAC;IACP,CAAC;IAED,yFAAyF;IACjF,GAAG,CAAC,IAAY;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC7B,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;gBACjC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CACjB,sCAAsC,IAAI,4HAA4H,CACzK,CAAC;YACN,CAAC;YACD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,OAAgB;QACvB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO;QACX,CAAC;QAED,IAAI,CAAC,WAAW,EAAE,eAAe,EAAE,CAAC;YAChC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CACjB,kHAAkH,CACrH,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,OAAO;QACX,CAAC;QAED,IAAI,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC7D,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAChC,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,kDAAkD,CAAC,CAAC;QACjG,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,gCAAgC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACxG,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;YACnC,OAAO;QACX,CAAC;QACD,MAAM,IAAI,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC;QAE/B,IAAI,CAAC;YACD,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACvE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACnE,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YAClB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACxB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,2BAA2B,IAAI,MAAM,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7G,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,EAAU;QACb,IAAI,UAAU,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,aAAa,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,YAAY;QACR,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;aAClC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aACvE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,eAAe;QACX,MAAM,KAAK,GAAG;YACV,qFAAqF;YACrF,2BAA2B;YAC3B,yBAAyB;SAC5B,CAAC;QACF,KAAK,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;YACjD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;YACrC,sFAAsF;YACtF,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,OAAO,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpG,KAAK,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,OAAO,KAAK,CAAC,CAAC;QACnE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,wCAAwC;IACxC,OAAO;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACzB,CAAC;CACJ;AA9JD,wCA8JC","sourcesContent":["/**\n * Access to the central ioBroker credential store (`system.credentials.*`) from scripts.\n *\n * The admin UI manages the credentials under \"Basic settings\" → \"Credentials\". Every credential\n * has an ID like `system.credentials.CameraPassword` and holds either a single `key` (API keys)\n * or a `login`/`password` pair. The secret fields are stored encrypted with the system secret.\n *\n * This manager keeps all credentials decrypted in memory and exposes them to the scripts as the\n * global `SECRETS` object, so a script can simply write:\n *\n * ```js\n * const password = SECRETS.CameraPassword.key;\n * ```\n *\n * The cache is kept up to date while the adapter is running, so editing a credential in the admin\n * UI takes effect immediately - without restarting the adapter or the scripts.\n */\n// Imported from its own entry point on purpose: the package index of `@iobroker/adapter-core`\n// looks for js-controller while it is being loaded and terminates the process with exit code 10\n// when it is missing. This module is required by the unit tests, which run without a controller,\n// so it must stay clear of that side effect. `@iobroker/adapter-core/credentials` is free of it -\n// it is written to be usable in browser builds as well.\nimport * as Credentials from '@iobroker/adapter-core/credentials';\n\n/** Prefix of all credential object IDs */\nexport const SECRETS_PREFIX = 'system.credentials.';\n\n/** Decrypted fields of one credential, e.g. `{ key: 'abc' }` or `{ login: 'user', password: 'pass' }` */\nexport type SecretValues = Record<string, string | number | boolean>;\n\n/** The global `SECRETS` object: credential name (ID without the prefix) => decrypted fields */\nexport type Secrets = Record<string, SecretValues>;\n\n/** One credential without its values: only the name and the names of its fields */\nexport interface SecretStructure {\n    /** Credential name, i.e. the object ID without the `system.credentials.` prefix */\n    name: string;\n    /** Names of the fields this credential has, e.g. `['key']` or `['login', 'password']` */\n    fields: string[];\n}\n\n/**\n * Checks if the given object ID belongs to the central credential store.\n *\n * @param id Object ID, e.g. `system.credentials.CameraPassword`\n */\nexport function isSecretId(id: string): boolean {\n    return id.startsWith(SECRETS_PREFIX) && id.length > SECRETS_PREFIX.length;\n}\n\n/**\n * Extracts the name a credential is exposed under in `SECRETS`.\n *\n * @param id Object ID, e.g. `system.credentials.CameraPassword`\n */\nexport function getSecretName(id: string): string {\n    return id.substring(SECRETS_PREFIX.length);\n}\n\nexport class SecretsManager {\n    private readonly adapter: ioBroker.Adapter;\n\n    /** Decrypted credentials, keyed by name (the credential ID without the `system.credentials.` prefix) */\n    private readonly cache: Map<string, Readonly<SecretValues>> = new Map();\n\n    /** If the scripts may read the credentials at all (adapter option `enableSecrets`) */\n    private enabled = false;\n\n    /** Warn only once per script run that the feature is disabled */\n    private disabledWarningShown = false;\n\n    /**\n     * The object handed to the scripts as the global `SECRETS`.\n     *\n     * It is a read-only view on the cache, so the values stay up to date without the scripts\n     * having to re-read anything, and a script cannot modify the credentials of another script.\n     */\n    public readonly secrets: Secrets;\n\n    constructor(adapter: ioBroker.Adapter) {\n        this.adapter = adapter;\n\n        this.secrets = new Proxy(Object.create(null) as Secrets, {\n            get: (_target: Secrets, prop: string | symbol): SecretValues | undefined =>\n                typeof prop === 'string' ? this.get(prop) : undefined,\n            has: (_target: Secrets, prop: string | symbol): boolean => typeof prop === 'string' && this.cache.has(prop),\n            ownKeys: (): string[] => (this.enabled ? Array.from(this.cache.keys()) : []),\n            getOwnPropertyDescriptor: (_target: Secrets, prop: string | symbol): PropertyDescriptor | undefined => {\n                const value = typeof prop === 'string' ? this.get(prop) : undefined;\n                return value === undefined\n                    ? undefined\n                    : { value, enumerable: true, configurable: true, writable: false };\n            },\n            // The credentials belong to the system - scripts may read them, but never change them\n            set: (): boolean => false,\n            defineProperty: (): boolean => false,\n            deleteProperty: (): boolean => false,\n        });\n    }\n\n    /** Reads one credential from the cache and warns if the whole feature is switched off */\n    private get(name: string): SecretValues | undefined {\n        if (!this.enabled) {\n            if (!this.disabledWarningShown) {\n                this.disabledWarningShown = true;\n                this.adapter.log.warn(\n                    `A script tried to read the secret \"${name}\", but the access to the credentials is disabled. Enable \"Allow scripts to read the credentials\" in the instance settings.`,\n                );\n            }\n            return undefined;\n        }\n        return this.cache.get(name);\n    }\n\n    /**\n     * Reads all credentials of the central store and decrypts them.\n     *\n     * @param enabled Value of the adapter option `enableSecrets`\n     */\n    async load(enabled: boolean): Promise<void> {\n        this.cache.clear();\n        this.disabledWarningShown = false;\n        this.enabled = enabled;\n\n        if (!enabled) {\n            return;\n        }\n\n        if (!Credentials?.listCredentials) {\n            this.adapter.log.warn(\n                'Cannot read the credentials for \"SECRETS\": the credentials API is only available with js-controller 7.2 or newer',\n            );\n            this.enabled = false;\n            return;\n        }\n\n        try {\n            const list = await Credentials.listCredentials(this.adapter);\n            for (const entry of list) {\n                await this.update(entry.id);\n            }\n            this.adapter.log.debug(`${this.cache.size} secret(s) available in the scripts as \"SECRETS\"`);\n        } catch (e: unknown) {\n            this.adapter.log.warn(`Cannot read the credentials: ${e instanceof Error ? e.message : String(e)}`);\n        }\n    }\n\n    /**\n     * Reads one credential and decrypts it. Called for every change of a `system.credentials.*`\n     * object, so edits in the admin UI are visible in the scripts immediately.\n     *\n     * @param id Object ID, e.g. `system.credentials.CameraPassword`\n     */\n    async update(id: string): Promise<void> {\n        if (!this.enabled || !isSecretId(id)) {\n            return;\n        }\n        const name = getSecretName(id);\n\n        try {\n            const credentials = await Credentials.getCredentials(this.adapter, id);\n            this.cache.set(name, Object.freeze({ ...credentials.values }));\n        } catch (e: unknown) {\n            this.cache.delete(name);\n            this.adapter.log.warn(`Cannot read the secret \"${name}\": ${e instanceof Error ? e.message : String(e)}`);\n        }\n    }\n\n    /**\n     * Forgets one credential because its object was deleted.\n     *\n     * @param id Object ID, e.g. `system.credentials.CameraPassword`\n     */\n    remove(id: string): void {\n        if (isSecretId(id) && this.cache.delete(getSecretName(id))) {\n            this.adapter.log.debug(`Secret \"${getSecretName(id)}\" was deleted`);\n        }\n    }\n\n    /**\n     * The structure of the credential store without any secret value: which credentials exist and\n     * which fields each of them has. Used by the instance settings and the Blockly editor to show\n     * the user what `SECRETS.<name>.<field>` expressions are available.\n     */\n    getStructure(): SecretStructure[] {\n        return Array.from(this.cache.entries())\n            .map(([name, values]) => ({ name, fields: Object.keys(values).sort() }))\n            .sort((a, b) => a.name.localeCompare(b.name));\n    }\n\n    /**\n     * Builds the ambient TypeScript declarations for the credentials that currently exist, so the\n     * editor can suggest their names after typing `SECRETS.` and their fields after the next dot.\n     * The names are merged into the `iobJS.Secrets` interface, which has an index signature for\n     * all other names.\n     */\n    getDeclarations(): string {\n        const lines = [\n            '// Generated by ioBroker.javascript from the central credential store - do not edit',\n            'declare namespace iobJS {',\n            '    interface Secrets {',\n        ];\n        for (const { name, fields } of this.getStructure()) {\n            const values = this.cache.get(name)!;\n            // Declare the fields this credential really has, so the editor suggests exactly those\n            const members = fields.map(field => `${JSON.stringify(field)}: ${typeof values[field]}`).join('; ');\n            lines.push(`        ${JSON.stringify(name)}: { ${members} };`);\n        }\n        lines.push('    }', '}', '');\n        return lines.join('\\n');\n    }\n\n    /** Forgets all decrypted credentials */\n    destroy(): void {\n        this.cache.clear();\n        this.enabled = false;\n    }\n}\n"]}

package/build/lib/typescriptSettings.js

@@ -1,11 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsDeclarationCompilerOptions = exports.tsCompilerOptions = exports.targetTsLib = void 0;
+exports.jsDeclarationCompilerOptions = exports.tsCompilerOptions = exports.TS_TARGETS = exports.targetTsLib = void 0;
+exports.getTargetTsLib = getTargetTsLib;
+exports.getTsCompilerOptions = getTsCompilerOptions;
 const typescript_1 = require("typescript");
 // Node.js 18+ supports the features of ES2022
 // consider changing this, so we get to support the newest features too
 exports.targetTsLib = 'es2022';
+/** All targets that may be selected in the instance configuration */
+exports.TS_TARGETS = {
+    es2018: typescript_1.ScriptTarget.ES2018,
+    es2019: typescript_1.ScriptTarget.ES2019,
+    es2020: typescript_1.ScriptTarget.ES2020,
+    es2021: typescript_1.ScriptTarget.ES2021,
+    es2022: typescript_1.ScriptTarget.ES2022,
+    es2023: typescript_1.ScriptTarget.ES2023,
+    es2024: typescript_1.ScriptTarget.ES2024,
+    es2025: typescript_1.ScriptTarget.ES2025,
+    esnext: typescript_1.ScriptTarget.ESNext,
+};
 exports.tsCompilerOptions = {
+    // TypeScript 6 enables `strict` by default. That would break virtually every existing user
+    // script (implicit any parameters, strict null checks), so keep the pre-TS6 behavior.
+    // Can be re-enabled per instance in the "TypeScript" tab of the adapter settings.
+    strict: false,
     // don't compile faulty scripts
     noEmitOnError: true,
     // emit declarations for global scripts
@@ -22,7 +40,7 @@ exports.tsCompilerOptions = {
     // Node.js 18+ runs ES2022 natively, so nothing has to be downleveled. This also makes
     // `downlevelIteration` obsolete - QueryResults stays iterable without it
     // (https://github.com/ioBroker/ioBroker.javascript/pull/663#issuecomment-721645705).
-    target: typescript_1.ScriptTarget.ES2022,
+    target: exports.TS_TARGETS[exports.targetTsLib],
     // From ES2022 on, TypeScript would emit class fields as native declarations ([[Define]]
     // semantics). Keep the previous assignment semantics (`this.x = ...` in the constructor),
     // so existing user scripts behave unchanged.
@@ -42,4 +60,96 @@ exports.jsDeclarationCompilerOptions = {
     noImplicitAny: false,
     strict: false,
 };
+/**
+ * Applies a checkbox option from the instance configuration.
+ * An option that is missing (configuration of an older version) keeps the value the adapter ships with.
+ *
+ * @param options The compiler options to modify
+ * @param name Name of the compiler option
+ * @param value Value from the instance configuration
+ */
+function applyBoolean(options, name, value) {
+    if (value === undefined || value === null) {
+        return;
+    }
+    options[name] = !!value;
+}
+/**
+ * Applies a tri-state option from the instance configuration.
+ * An empty selection removes the option, so it follows `strict` (resp. the TypeScript default).
+ * An option that is missing (configuration of an older version) keeps the value the adapter ships with.
+ *
+ * @param options The compiler options to modify
+ * @param name Name of the compiler option
+ * @param value Value from the instance configuration
+ */
+function applyTriState(options, name, value) {
+    if (value === undefined || value === null) {
+        return;
+    }
+    if (value === '') {
+        delete options[name];
+        return;
+    }
+    options[name] = value === 'true';
+}
+/**
+ * Determines the ECMAScript version the user scripts are compiled for
+ *
+ * @param config The instance configuration
+ */
+function getTargetTsLib(config) {
+    const target = config?.tsTarget?.toLowerCase();
+    return target && exports.TS_TARGETS[target] !== undefined ? target : exports.targetTsLib;
+}
+/**
+ * Builds the compiler options for the user scripts out of the instance configuration.
+ * Everything that is not configured stays at the value the adapter ships with.
+ *
+ * @param config The instance configuration
+ */
+function getTsCompilerOptions(config) {
+    const tsLib = getTargetTsLib(config);
+    const options = {
+        ...exports.tsCompilerOptions,
+        target: exports.TS_TARGETS[tsLib],
+        lib: [`lib.${tsLib}.d.ts`],
+    };
+    if (!config) {
+        return options;
+    }
+    // Strict type checking
+    applyBoolean(options, 'strict', config.tsStrict);
+    applyTriState(options, 'noImplicitAny', config.tsNoImplicitAny);
+    applyTriState(options, 'strictNullChecks', config.tsStrictNullChecks);
+    applyTriState(options, 'strictFunctionTypes', config.tsStrictFunctionTypes);
+    applyTriState(options, 'strictBindCallApply', config.tsStrictBindCallApply);
+    applyTriState(options, 'strictPropertyInitialization', config.tsStrictPropertyInitialization);
+    applyTriState(options, 'strictBuiltinIteratorReturn', config.tsStrictBuiltinIteratorReturn);
+    applyTriState(options, 'noImplicitThis', config.tsNoImplicitThis);
+    applyTriState(options, 'alwaysStrict', config.tsAlwaysStrict);
+    applyTriState(options, 'useUnknownInCatchVariables', config.tsUseUnknownInCatchVariables);
+    // Additional checks
+    applyBoolean(options, 'noUnusedLocals', config.tsNoUnusedLocals);
+    applyBoolean(options, 'noUnusedParameters', config.tsNoUnusedParameters);
+    applyBoolean(options, 'noImplicitReturns', config.tsNoImplicitReturns);
+    applyBoolean(options, 'noFallthroughCasesInSwitch', config.tsNoFallthroughCasesInSwitch);
+    applyBoolean(options, 'noImplicitOverride', config.tsNoImplicitOverride);
+    applyBoolean(options, 'noUncheckedIndexedAccess', config.tsNoUncheckedIndexedAccess);
+    applyBoolean(options, 'noPropertyAccessFromIndexSignature', config.tsNoPropertyAccessFromIndexSignature);
+    applyBoolean(options, 'exactOptionalPropertyTypes', config.tsExactOptionalPropertyTypes);
+    applyTriState(options, 'allowUnreachableCode', config.tsAllowUnreachableCode);
+    applyTriState(options, 'allowUnusedLabels', config.tsAllowUnusedLabels);
+    // Language and emit
+    applyBoolean(options, 'noEmitOnError', config.tsNoEmitOnError);
+    applyBoolean(options, 'esModuleInterop', config.tsEsModuleInterop);
+    applyBoolean(options, 'allowSyntheticDefaultImports', config.tsAllowSyntheticDefaultImports);
+    applyBoolean(options, 'useDefineForClassFields', config.tsUseDefineForClassFields);
+    applyBoolean(options, 'downlevelIteration', config.tsDownlevelIteration);
+    applyBoolean(options, 'experimentalDecorators', config.tsExperimentalDecorators);
+    applyBoolean(options, 'emitDecoratorMetadata', config.tsEmitDecoratorMetadata);
+    applyBoolean(options, 'removeComments', config.tsRemoveComments);
+    applyBoolean(options, 'skipLibCheck', config.tsSkipLibCheck);
+    return options;
+}
 //# sourceMappingURL=typescriptSettings.js.map

package/build/lib/typescriptSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"typescriptSettings.js","sourceRoot":"","sources":["../../src/lib/typescriptSettings.ts"],"names":[],"mappings":";;;AAAA,2CAA4E;AAE5E,8CAA8C;AAC9C,uEAAuE;AAC1D,QAAA,WAAW,GAAG,QAAQ,CAAC;AAEvB,QAAA,iBAAiB,GAAoB;IAC9C,+BAA+B;IAC/B,aAAa,EAAE,IAAI;IACnB,uCAAuC;IACvC,WAAW,EAAE,IAAI;IACjB,wEAAwE;IACxE,eAAe,EAAE,IAAI;IACrB,2EAA2E;IAC3E,4BAA4B;IAC5B,0BAA0B,EAAE,KAAK;IACjC,8FAA8F;IAC9F,gGAAgG;IAChG,+FAA+F;IAC/F,MAAM,EAAE,uBAAU,CAAC,QAAQ;IAC3B,sFAAsF;IACtF,yEAAyE;IACzE,qFAAqF;IACrF,MAAM,EAAE,yBAAY,CAAC,MAAM;IAC3B,wFAAwF;IACxF,0FAA0F;IAC1F,6CAA6C;IAC7C,uBAAuB,EAAE,KAAK;IAC9B,6FAA6F;IAC7F,6FAA6F;IAC7F,gCAAgC;IAChC,kBAAkB,EAAE,KAAK;IACzB,GAAG,EAAE,CAAC,OAAO,mBAAW,OAAO,CAAC;CACnC,CAAC;AAEW,QAAA,4BAA4B,GAAoB;IACzD,GAAG,yBAAiB;IACpB,sCAAsC;IACtC,mBAAmB,EAAE,IAAI;IACzB,eAAe;IACf,aAAa,EAAE,KAAK;IACpB,aAAa,EAAE,KAAK;IACpB,MAAM,EAAE,KAAK;CAChB,CAAC","sourcesContent":["import { type CompilerOptions, ModuleKind, ScriptTarget } from 'typescript';\n\n// Node.js 18+ supports the features of ES2022\n// consider changing this, so we get to support the newest features too\nexport const targetTsLib = 'es2022';\n\nexport const tsCompilerOptions: CompilerOptions = {\n    // don't compile faulty scripts\n    noEmitOnError: true,\n    // emit declarations for global scripts\n    declaration: true,\n    // This enables TS users to `import * as ... from` and `import ... from`\n    esModuleInterop: true,\n    // This flag was introduced in TS 4.4 and may break a lot of legacy scripts\n    // Better keep it turned off\n    useUnknownInCatchVariables: false,\n    // Scripts are executed as a Node.js `vm.Script`, which does not support the `import` keyword,\n    // so the emitted code must be CommonJS. This has to be set explicitly: TypeScript only defaults\n    // `module` to CommonJS for the ES5/ES3 targets and would emit ES modules for the target below.\n    module: ModuleKind.CommonJS,\n    // Node.js 18+ runs ES2022 natively, so nothing has to be downleveled. This also makes\n    // `downlevelIteration` obsolete - QueryResults stays iterable without it\n    // (https://github.com/ioBroker/ioBroker.javascript/pull/663#issuecomment-721645705).\n    target: ScriptTarget.ES2022,\n    // From ES2022 on, TypeScript would emit class fields as native declarations ([[Define]]\n    // semantics). Keep the previous assignment semantics (`this.x = ...` in the constructor),\n    // so existing user scripts behave unchanged.\n    useDefineForClassFields: false,\n    // `virtual-tsc` overwrites `moduleResolution` with \"node10\", which TypeScript 6 reports as a\n    // deprecation error. It cannot be configured from here, so deprecations have to be tolerated\n    // until that is fixed upstream.\n    ignoreDeprecations: '6.0',\n    lib: [`lib.${targetTsLib}.d.ts`],\n};\n\nexport const jsDeclarationCompilerOptions: CompilerOptions = {\n    ...tsCompilerOptions,\n    // we only care about the declarations\n    emitDeclarationOnly: true,\n    // allow errors\n    noEmitOnError: false,\n    noImplicitAny: false,\n    strict: false,\n};\n"]}
+{"version":3,"file":"typescriptSettings.js","sourceRoot":"","sources":["../../src/lib/typescriptSettings.ts"],"names":[],"mappings":";;;AAuGA,wCAIC;AAQD,oDAgDC;AAnKD,2CAA4E;AAG5E,8CAA8C;AAC9C,uEAAuE;AAC1D,QAAA,WAAW,GAAa,QAAQ,CAAC;AAE9C,qEAAqE;AACxD,QAAA,UAAU,GAAmC;IACtD,MAAM,EAAE,yBAAY,CAAC,MAAM;IAC3B,MAAM,EAAE,yBAAY,CAAC,MAAM;IAC3B,MAAM,EAAE,yBAAY,CAAC,MAAM;IAC3B,MAAM,EAAE,yBAAY,CAAC,MAAM;IAC3B,MAAM,EAAE,yBAAY,CAAC,MAAM;IAC3B,MAAM,EAAE,yBAAY,CAAC,MAAM;IAC3B,MAAM,EAAE,yBAAY,CAAC,MAAM;IAC3B,MAAM,EAAE,yBAAY,CAAC,MAAM;IAC3B,MAAM,EAAE,yBAAY,CAAC,MAAM;CAC9B,CAAC;AAEW,QAAA,iBAAiB,GAAoB;IAC9C,2FAA2F;IAC3F,sFAAsF;IACtF,kFAAkF;IAClF,MAAM,EAAE,KAAK;IACb,+BAA+B;IAC/B,aAAa,EAAE,IAAI;IACnB,uCAAuC;IACvC,WAAW,EAAE,IAAI;IACjB,wEAAwE;IACxE,eAAe,EAAE,IAAI;IACrB,2EAA2E;IAC3E,4BAA4B;IAC5B,0BAA0B,EAAE,KAAK;IACjC,8FAA8F;IAC9F,gGAAgG;IAChG,+FAA+F;IAC/F,MAAM,EAAE,uBAAU,CAAC,QAAQ;IAC3B,sFAAsF;IACtF,yEAAyE;IACzE,qFAAqF;IACrF,MAAM,EAAE,kBAAU,CAAC,mBAAW,CAAC;IAC/B,wFAAwF;IACxF,0FAA0F;IAC1F,6CAA6C;IAC7C,uBAAuB,EAAE,KAAK;IAC9B,6FAA6F;IAC7F,6FAA6F;IAC7F,gCAAgC;IAChC,kBAAkB,EAAE,KAAK;IACzB,GAAG,EAAE,CAAC,OAAO,mBAAW,OAAO,CAAC;CACnC,CAAC;AAEW,QAAA,4BAA4B,GAAoB;IACzD,GAAG,yBAAiB;IACpB,sCAAsC;IACtC,mBAAmB,EAAE,IAAI;IACzB,eAAe;IACf,aAAa,EAAE,KAAK;IACpB,aAAa,EAAE,KAAK;IACpB,MAAM,EAAE,KAAK;CAChB,CAAC;AAEF;;;;;;;GAOG;AACH,SAAS,YAAY,CAAC,OAAwB,EAAE,IAA2B,EAAE,KAA0B;IACnG,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO;IACX,CAAC;IACA,OAAmC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC;AACzD,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,aAAa,CAAC,OAAwB,EAAE,IAA2B,EAAE,KAA6B;IACvG,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO;IACX,CAAC;IACD,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;QACf,OAAQ,OAAmC,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO;IACX,CAAC;IACA,OAAmC,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,MAAM,CAAC;AAClE,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,MAAyC;IACpE,MAAM,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAc,CAAC;IAE3D,OAAO,MAAM,IAAI,kBAAU,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,mBAAW,CAAC;AAC7E,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,MAAyC;IAC1E,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,OAAO,GAAoB;QAC7B,GAAG,yBAAiB;QACpB,MAAM,EAAE,kBAAU,CAAC,KAAK,CAAC;QACzB,GAAG,EAAE,CAAC,OAAO,KAAK,OAAO,CAAC;KAC7B,CAAC;IAEF,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,uBAAuB;IACvB,YAAY,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IACjD,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IAChE,aAAa,CAAC,OAAO,EAAE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC;IACtE,aAAa,CAAC,OAAO,EAAE,qBAAqB,EAAE,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAC5E,aAAa,CAAC,OAAO,EAAE,qBAAqB,EAAE,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAC5E,aAAa,CAAC,OAAO,EAAE,8BAA8B,EAAE,MAAM,CAAC,8BAA8B,CAAC,CAAC;IAC9F,aAAa,CAAC,OAAO,EAAE,6BAA6B,EAAE,MAAM,CAAC,6BAA6B,CAAC,CAAC;IAC5F,aAAa,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAClE,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;IAC9D,aAAa,CAAC,OAAO,EAAE,4BAA4B,EAAE,MAAM,CAAC,4BAA4B,CAAC,CAAC;IAE1F,oBAAoB;IACpB,YAAY,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACjE,YAAY,CAAC,OAAO,EAAE,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACzE,YAAY,CAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACvE,YAAY,CAAC,OAAO,EAAE,4BAA4B,EAAE,MAAM,CAAC,4BAA4B,CAAC,CAAC;IACzF,YAAY,CAAC,OAAO,EAAE,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACzE,YAAY,CAAC,OAAO,EAAE,0BAA0B,EAAE,MAAM,CAAC,0BAA0B,CAAC,CAAC;IACrF,YAAY,CAAC,OAAO,EAAE,oCAAoC,EAAE,MAAM,CAAC,oCAAoC,CAAC,CAAC;IACzG,YAAY,CAAC,OAAO,EAAE,4BAA4B,EAAE,MAAM,CAAC,4BAA4B,CAAC,CAAC;IACzF,aAAa,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,CAAC,sBAAsB,CAAC,CAAC;IAC9E,aAAa,CAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAC;IAExE,oBAAoB;IACpB,YAAY,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IAC/D,YAAY,CAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACnE,YAAY,CAAC,OAAO,EAAE,8BAA8B,EAAE,MAAM,CAAC,8BAA8B,CAAC,CAAC;IAC7F,YAAY,CAAC,OAAO,EAAE,yBAAyB,EAAE,MAAM,CAAC,yBAAyB,CAAC,CAAC;IACnF,YAAY,CAAC,OAAO,EAAE,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACzE,YAAY,CAAC,OAAO,EAAE,wBAAwB,EAAE,MAAM,CAAC,wBAAwB,CAAC,CAAC;IACjF,YAAY,CAAC,OAAO,EAAE,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,CAAC,CAAC;IAC/E,YAAY,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACjE,YAAY,CAAC,OAAO,EAAE,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;IAE7D,OAAO,OAAO,CAAC;AACnB,CAAC","sourcesContent":["import { type CompilerOptions, ModuleKind, ScriptTarget } from 'typescript';\nimport type { JavaScriptAdapterConfig, TsTarget, TsTriState } from '../types';\n\n// Node.js 18+ supports the features of ES2022\n// consider changing this, so we get to support the newest features too\nexport const targetTsLib: TsTarget = 'es2022';\n\n/** All targets that may be selected in the instance configuration */\nexport const TS_TARGETS: Record<TsTarget, ScriptTarget> = {\n    es2018: ScriptTarget.ES2018,\n    es2019: ScriptTarget.ES2019,\n    es2020: ScriptTarget.ES2020,\n    es2021: ScriptTarget.ES2021,\n    es2022: ScriptTarget.ES2022,\n    es2023: ScriptTarget.ES2023,\n    es2024: ScriptTarget.ES2024,\n    es2025: ScriptTarget.ES2025,\n    esnext: ScriptTarget.ESNext,\n};\n\nexport const tsCompilerOptions: CompilerOptions = {\n    // TypeScript 6 enables `strict` by default. That would break virtually every existing user\n    // script (implicit any parameters, strict null checks), so keep the pre-TS6 behavior.\n    // Can be re-enabled per instance in the \"TypeScript\" tab of the adapter settings.\n    strict: false,\n    // don't compile faulty scripts\n    noEmitOnError: true,\n    // emit declarations for global scripts\n    declaration: true,\n    // This enables TS users to `import * as ... from` and `import ... from`\n    esModuleInterop: true,\n    // This flag was introduced in TS 4.4 and may break a lot of legacy scripts\n    // Better keep it turned off\n    useUnknownInCatchVariables: false,\n    // Scripts are executed as a Node.js `vm.Script`, which does not support the `import` keyword,\n    // so the emitted code must be CommonJS. This has to be set explicitly: TypeScript only defaults\n    // `module` to CommonJS for the ES5/ES3 targets and would emit ES modules for the target below.\n    module: ModuleKind.CommonJS,\n    // Node.js 18+ runs ES2022 natively, so nothing has to be downleveled. This also makes\n    // `downlevelIteration` obsolete - QueryResults stays iterable without it\n    // (https://github.com/ioBroker/ioBroker.javascript/pull/663#issuecomment-721645705).\n    target: TS_TARGETS[targetTsLib],\n    // From ES2022 on, TypeScript would emit class fields as native declarations ([[Define]]\n    // semantics). Keep the previous assignment semantics (`this.x = ...` in the constructor),\n    // so existing user scripts behave unchanged.\n    useDefineForClassFields: false,\n    // `virtual-tsc` overwrites `moduleResolution` with \"node10\", which TypeScript 6 reports as a\n    // deprecation error. It cannot be configured from here, so deprecations have to be tolerated\n    // until that is fixed upstream.\n    ignoreDeprecations: '6.0',\n    lib: [`lib.${targetTsLib}.d.ts`],\n};\n\nexport const jsDeclarationCompilerOptions: CompilerOptions = {\n    ...tsCompilerOptions,\n    // we only care about the declarations\n    emitDeclarationOnly: true,\n    // allow errors\n    noEmitOnError: false,\n    noImplicitAny: false,\n    strict: false,\n};\n\n/**\n * Applies a checkbox option from the instance configuration.\n * An option that is missing (configuration of an older version) keeps the value the adapter ships with.\n *\n * @param options The compiler options to modify\n * @param name Name of the compiler option\n * @param value Value from the instance configuration\n */\nfunction applyBoolean(options: CompilerOptions, name: keyof CompilerOptions, value: boolean | undefined): void {\n    if (value === undefined || value === null) {\n        return;\n    }\n    (options as Record<string, unknown>)[name] = !!value;\n}\n\n/**\n * Applies a tri-state option from the instance configuration.\n * An empty selection removes the option, so it follows `strict` (resp. the TypeScript default).\n * An option that is missing (configuration of an older version) keeps the value the adapter ships with.\n *\n * @param options The compiler options to modify\n * @param name Name of the compiler option\n * @param value Value from the instance configuration\n */\nfunction applyTriState(options: CompilerOptions, name: keyof CompilerOptions, value: TsTriState | undefined): void {\n    if (value === undefined || value === null) {\n        return;\n    }\n    if (value === '') {\n        delete (options as Record<string, unknown>)[name];\n        return;\n    }\n    (options as Record<string, unknown>)[name] = value === 'true';\n}\n\n/**\n * Determines the ECMAScript version the user scripts are compiled for\n *\n * @param config The instance configuration\n */\nexport function getTargetTsLib(config?: Partial<JavaScriptAdapterConfig>): TsTarget {\n    const target = config?.tsTarget?.toLowerCase() as TsTarget;\n\n    return target && TS_TARGETS[target] !== undefined ? target : targetTsLib;\n}\n\n/**\n * Builds the compiler options for the user scripts out of the instance configuration.\n * Everything that is not configured stays at the value the adapter ships with.\n *\n * @param config The instance configuration\n */\nexport function getTsCompilerOptions(config?: Partial<JavaScriptAdapterConfig>): CompilerOptions {\n    const tsLib = getTargetTsLib(config);\n    const options: CompilerOptions = {\n        ...tsCompilerOptions,\n        target: TS_TARGETS[tsLib],\n        lib: [`lib.${tsLib}.d.ts`],\n    };\n\n    if (!config) {\n        return options;\n    }\n\n    // Strict type checking\n    applyBoolean(options, 'strict', config.tsStrict);\n    applyTriState(options, 'noImplicitAny', config.tsNoImplicitAny);\n    applyTriState(options, 'strictNullChecks', config.tsStrictNullChecks);\n    applyTriState(options, 'strictFunctionTypes', config.tsStrictFunctionTypes);\n    applyTriState(options, 'strictBindCallApply', config.tsStrictBindCallApply);\n    applyTriState(options, 'strictPropertyInitialization', config.tsStrictPropertyInitialization);\n    applyTriState(options, 'strictBuiltinIteratorReturn', config.tsStrictBuiltinIteratorReturn);\n    applyTriState(options, 'noImplicitThis', config.tsNoImplicitThis);\n    applyTriState(options, 'alwaysStrict', config.tsAlwaysStrict);\n    applyTriState(options, 'useUnknownInCatchVariables', config.tsUseUnknownInCatchVariables);\n\n    // Additional checks\n    applyBoolean(options, 'noUnusedLocals', config.tsNoUnusedLocals);\n    applyBoolean(options, 'noUnusedParameters', config.tsNoUnusedParameters);\n    applyBoolean(options, 'noImplicitReturns', config.tsNoImplicitReturns);\n    applyBoolean(options, 'noFallthroughCasesInSwitch', config.tsNoFallthroughCasesInSwitch);\n    applyBoolean(options, 'noImplicitOverride', config.tsNoImplicitOverride);\n    applyBoolean(options, 'noUncheckedIndexedAccess', config.tsNoUncheckedIndexedAccess);\n    applyBoolean(options, 'noPropertyAccessFromIndexSignature', config.tsNoPropertyAccessFromIndexSignature);\n    applyBoolean(options, 'exactOptionalPropertyTypes', config.tsExactOptionalPropertyTypes);\n    applyTriState(options, 'allowUnreachableCode', config.tsAllowUnreachableCode);\n    applyTriState(options, 'allowUnusedLabels', config.tsAllowUnusedLabels);\n\n    // Language and emit\n    applyBoolean(options, 'noEmitOnError', config.tsNoEmitOnError);\n    applyBoolean(options, 'esModuleInterop', config.tsEsModuleInterop);\n    applyBoolean(options, 'allowSyntheticDefaultImports', config.tsAllowSyntheticDefaultImports);\n    applyBoolean(options, 'useDefineForClassFields', config.tsUseDefineForClassFields);\n    applyBoolean(options, 'downlevelIteration', config.tsDownlevelIteration);\n    applyBoolean(options, 'experimentalDecorators', config.tsExperimentalDecorators);\n    applyBoolean(options, 'emitDecoratorMetadata', config.tsEmitDecoratorMetadata);\n    applyBoolean(options, 'removeComments', config.tsRemoveComments);\n    applyBoolean(options, 'skipLibCheck', config.tsSkipLibCheck);\n\n    return options;\n}\n"]}