node-opcua-alias-name-server 2.176.0

package/dist/address_space_alias_store.js

@@ -0,0 +1,360 @@
+"use strict";
+/**
+ * @module node-opcua-alias-name-server
+ *
+ * An {@link IAliasStore} backed directly by the address space.
+ *
+ * This is the default store, and the reason `installAliasNames(server)` needs no
+ * application code: a Server whose NodeSet2.xml already models `AliasNameType`
+ * instances answers `FindAlias` correctly with nothing else configured. The
+ * address space *is* the database.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressSpaceAliasStore = void 0;
+const node_opcua_alias_name_common_1 = require("node-opcua-alias-name-common");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const add_alias_js_1 = require("./add_alias.js");
+const alias_hierarchy_js_1 = require("./alias_hierarchy.js");
+const well_known_js_1 = require("./well_known.js");
+/**
+ * An ExpandedNodeId as a NodeId on this Server, dropping the ServerIndex.
+ *
+ * Clause 6.3.4 Table 9: *"The ServerIndex in the ExpandedNodeId shall be ignored
+ * and the TargetServers Uri shall be used."*
+ *
+ * Built from the identifier's own parts rather than by re-parsing its string
+ * form, which would have to cope with `svr=`, `nsu=` and quoting. When the
+ * ExpandedNodeId carries a namespace URI, that URI decides the index — the
+ * numeric index travelling beside it belongs to the *sending* Server's namespace
+ * table, not ours.
+ */
+function toLocalNodeId(addressSpace, nodeId) {
+    let namespaceIndex = nodeId.namespace ?? 0;
+    if (nodeId.namespaceUri) {
+        const resolved = addressSpace.getNamespaceIndex(nodeId.namespaceUri);
+        if (resolved < 0) {
+            // a namespace this Server does not know: the Node cannot be here
+            return null;
+        }
+        namespaceIndex = resolved;
+    }
+    return new node_opcua_nodeid_1.NodeId(nodeId.identifierType, nodeId.value, namespaceIndex);
+}
+/** Turn a local NodeId into an ExpandedNodeId with the namespace URI filled in. */
+function toExpandedNodeId(addressSpace, nodeId) {
+    const namespaceUri = nodeId.namespace === 0 ? null : addressSpace.getNamespaceUri(nodeId.namespace);
+    return new node_opcua_nodeid_1.ExpandedNodeId(nodeId.identifierType, nodeId.value, nodeId.namespace, namespaceUri, 
+    // clause 7.3: the ServerIndex is carried separately in ServerUris, and
+    // clause 6.3.4 Table 9 says an incoming ServerIndex is ignored anyway
+    0);
+}
+class AddressSpaceAliasStore {
+    addressSpace;
+    likeOptions;
+    /** Per-category `LastChange`, as a VersionTime (clause 6.3.1). */
+    lastChangeByCategory = new Map();
+    allowRemoteTargets;
+    constructor(addressSpace, options) {
+        this.addressSpace = addressSpace;
+        this.likeOptions = options?.likeOptions;
+        this.allowRemoteTargets = options?.allowRemoteTargets ?? false;
+    }
+    /**
+     * Every alias at or below `query.categoryNodeId` matching the pattern.
+     *
+     * The search is recursive from the category the Method was called on
+     * (clause 6.3.1), so a call on `Aliases` also covers `TagVariables`,
+     * `Topics` and anything nested below them.
+     *
+     * One entry is produced per (AliasName, category) pair: `FindAliasVerbose`
+     * has to name the category that actually held the alias, which for a nested
+     * hit is the nested one, not the one that was called.
+     */
+    async find(query) {
+        const root = this.addressSpace.findNode(query.categoryNodeId);
+        if (!root || root.nodeClass !== node_opcua_data_model_1.NodeClass.Object) {
+            return [];
+        }
+        // an invalid pattern throws InvalidLikePatternError, which the Method
+        // binding turns into Bad_InvalidArgument (clause 6.3.2 Table 4)
+        const pattern = new node_opcua_alias_name_common_1.LikePattern(query.pattern, this.likeOptions);
+        const referenceTypeFilter = this.resolveReferenceTypeFilter(query.referenceTypeFilter);
+        const entries = [];
+        // Stop one past the cap. The caller only needs to know that the cap was
+        // exceeded, so collecting the whole hierarchy first would be wasted work
+        // -- and on a Server with a large tag set, a `%` pattern would build the
+        // entire result set purely to throw it away with Bad_ResponseTooLarge.
+        const collectLimit = query.maxResults === undefined ? Number.POSITIVE_INFINITY : query.maxResults + 1;
+        for (const category of (0, alias_hierarchy_js_1.collectCategories)(this.addressSpace, root)) {
+            if (entries.length >= collectLimit) {
+                break;
+            }
+            // Skipped before its aliases are walked, so the cap is spent only on
+            // entries the caller may see - and the scan does less work. Only
+            // this category is skipped, not its descendants: the gate is
+            // per-category, and a denied parent does not imply a denied child.
+            if (query.isVisible && !(await query.isVisible(category.nodeId))) {
+                continue;
+            }
+            for (const alias of (0, alias_hierarchy_js_1.aliasesOf)(this.addressSpace, category)) {
+                if (entries.length >= collectLimit) {
+                    break;
+                }
+                const aliasName = alias.browseName.name;
+                if (!aliasName || !pattern.test(aliasName)) {
+                    continue;
+                }
+                const targets = this.targetsOf(alias, referenceTypeFilter);
+                if (targets.length === 0) {
+                    // clause 6.3.2 Table 3: an alias with no Reference of the
+                    // requested type is simply not a match
+                    continue;
+                }
+                entries.push({
+                    aliasName,
+                    // the namespace the alias Object was actually published in,
+                    // not the category's - Aliases and friends live in
+                    // namespace 0, which clause 6.2 never intends for an alias
+                    aliasNameNamespaceUri: this.namespaceUriOf(alias.browseName.namespaceIndex),
+                    referencedNodes: targets.map((t) => t.expandedNodeId),
+                    // every target is on this Server; aggregating other Servers
+                    // is out of scope for this package (Annex B / Annex C)
+                    serverUris: targets.map(() => null),
+                    categoryNodeId: category.nodeId,
+                    referenceTypeIds: targets.map((t) => t.referenceTypeId)
+                });
+            }
+        }
+        return entries;
+    }
+    /** `LastChange` for a category, rolled up from its descendants (clause 6.3.1). */
+    lastChange(categoryNodeId) {
+        const root = this.addressSpace.findNode(categoryNodeId);
+        if (!root || root.nodeClass !== node_opcua_data_model_1.NodeClass.Object) {
+            return this.lastChangeByCategory.get(categoryNodeId.toString()) ?? 0;
+        }
+        let latest = 0;
+        for (const category of (0, alias_hierarchy_js_1.collectCategories)(this.addressSpace, root)) {
+            latest = (0, node_opcua_alias_name_common_1.maxVersionTime)(latest, this.lastChangeByCategory.get(category.nodeId.toString()) ?? 0);
+        }
+        return latest;
+    }
+    /**
+     * Record that a category changed, at `versionTime` (defaulting to now).
+     *
+     * Only the category itself is stored; the rollup to ancestors happens on
+     * read, so a category that is later re-parented reports correctly without
+     * anything having to be recomputed.
+     */
+    touch(categoryNodeId, versionTime) {
+        const value = versionTime ?? (0, node_opcua_alias_name_common_1.nowVersionTime)();
+        const key = categoryNodeId.toString();
+        this.lastChangeByCategory.set(key, (0, node_opcua_alias_name_common_1.maxVersionTime)(this.lastChangeByCategory.get(key) ?? 0, value));
+        return value;
+    }
+    /** Restore persisted `LastChange` values (clause 6.3.1: "shall be persisted"). */
+    restoreLastChange(values) {
+        for (const [key, value] of values) {
+            this.lastChangeByCategory.set(key, value);
+        }
+    }
+    /** Snapshot the per-category `LastChange` values for persistence. */
+    snapshotLastChange() {
+        return [...this.lastChangeByCategory.entries()];
+    }
+    /**
+     * Add aliases to a category (clause 6.3.4), one StatusCode per entry.
+     *
+     * The per-item codes of Table 10:
+     *
+     * - `Bad_NodeIdInvalid` — the NodeId is syntactically unusable.
+     * - `Bad_NodeIdUnknown` — the target is on this Server and does not exist.
+     * - `Uncertain_ReferenceOutOfServer` — the target is on another Server. The
+     *   clause is explicit that this is returned **whether or not** a check was
+     *   performed: *"If the Server does not check for the external Node's
+     *   existence, it shall return Uncertain_ReferenceOutOfServer."* This Server
+     *   does not check, because checking means being a Client of the other
+     *   Server, which is the aggregation these packages exclude by design.
+     * - `Bad_NotSupported` — when {@link AddressSpaceAliasStoreOptions.allowRemoteTargets}
+     *   is off, which Table 10 explicitly permits.
+     *
+     * An exact duplicate of (AliasName, target, target Server) is `Good` and
+     * ignored, whether it was already stored or repeated within this call.
+     */
+    add(categoryNodeId, entries) {
+        const category = this.addressSpace.findNode(categoryNodeId);
+        if (!category || category.nodeClass !== node_opcua_data_model_1.NodeClass.Object) {
+            return entries.map(() => node_opcua_status_code_1.StatusCodes.BadNodeIdUnknown);
+        }
+        const categoryNode = category;
+        // duplicates repeated *within* this call are ignored too, so the set
+        // has to grow as we go rather than being a snapshot of the start state
+        const seenInThisCall = new Set();
+        return entries.map((entry) => {
+            const target = entry.referencedNodes[0];
+            const serverUri = entry.serverUris[0] ?? null;
+            if (!target) {
+                return node_opcua_status_code_1.StatusCodes.BadNodeIdInvalid;
+            }
+            if (!entry.aliasName) {
+                return node_opcua_status_code_1.StatusCodes.BadNodeIdInvalid;
+            }
+            const key = `${entry.aliasName}${target.toString()}${serverUri ?? ""}`;
+            if (seenInThisCall.has(key)) {
+                return node_opcua_status_code_1.StatusCodes.Good;
+            }
+            seenInThisCall.add(key);
+            // Table 9: the ServerIndex inside the ExpandedNodeId is ignored;
+            // TargetServers is authoritative
+            if (serverUri !== null) {
+                if (!this.allowRemoteTargets) {
+                    return node_opcua_status_code_1.StatusCodes.BadNotSupported;
+                }
+                return this.addRemote(categoryNode, entry, target, serverUri);
+            }
+            return this.addLocal(categoryNode, entry, target);
+        });
+    }
+    /**
+     * Remove aliases from a category (clause 6.3.5), one StatusCode per entry.
+     *
+     * `Bad_NotFound` when the name is not in the category, `Bad_InvalidState`
+     * when it is there but not owned by this Server — clause 6.3.5 opens by
+     * saying a Server "shall only delete AliasName instances that are defined on
+     * the Server exposing this Method".
+     *
+     * An entry with no target removes every target of that name. Removal is
+     * all-or-nothing per name: if any target cannot go, none of that name's do.
+     */
+    delete(categoryNodeId, entries) {
+        const category = this.addressSpace.findNode(categoryNodeId);
+        if (!category || category.nodeClass !== node_opcua_data_model_1.NodeClass.Object) {
+            return entries.map(() => node_opcua_status_code_1.StatusCodes.BadNotFound);
+        }
+        const categoryNode = category;
+        return entries.map((entry) => {
+            const alias = (0, add_alias_js_1.findAlias)(this.addressSpace, categoryNode, entry.aliasName);
+            if (!alias) {
+                return node_opcua_status_code_1.StatusCodes.BadNotFound;
+            }
+            // an alias whose targets all live on other Servers was learned from
+            // elsewhere and is not ours to delete
+            if (this.isForeign(alias)) {
+                return node_opcua_status_code_1.StatusCodes.BadInvalidState;
+            }
+            const requested = entry.referencedNodes ?? [];
+            if (requested.length === 0) {
+                // "all AliasNames with the provided name are deleted"
+                (0, add_alias_js_1.removeAlias)(this.addressSpace, categoryNode, entry.aliasName);
+                return node_opcua_status_code_1.StatusCodes.Good;
+            }
+            // all or nothing: check every requested target is present first
+            const references = alias.findReferencesEx(well_known_js_1.ALIAS_FOR, node_opcua_data_model_1.BrowseDirection.Forward);
+            const present = new Set(references.map((r) => r.nodeId.toString()));
+            const wanted = [];
+            for (const target of requested) {
+                const local = toLocalNodeId(this.addressSpace, target);
+                if (!local || !present.has(local.toString())) {
+                    return node_opcua_status_code_1.StatusCodes.BadNotFound;
+                }
+                wanted.push(local);
+            }
+            for (const target of wanted) {
+                (0, add_alias_js_1.removeAlias)(this.addressSpace, categoryNode, entry.aliasName, target);
+            }
+            return node_opcua_status_code_1.StatusCodes.Good;
+        });
+    }
+    /** Add an alias whose target is on this Server. */
+    addLocal(category, entry, target) {
+        const localNodeId = toLocalNodeId(this.addressSpace, target);
+        if (!localNodeId) {
+            return node_opcua_status_code_1.StatusCodes.BadNodeIdInvalid;
+        }
+        if (!this.addressSpace.findNode(localNodeId)) {
+            // Table 10: "The TargetNode does not exist in the AliasName Server
+            // and the TargetServer is the local server"
+            return node_opcua_status_code_1.StatusCodes.BadNodeIdUnknown;
+        }
+        try {
+            (0, add_alias_js_1.addAlias)(this.addressSpace, category, entry.aliasName, localNodeId, {
+                referenceType: entry.referenceTypeIds[0]
+            });
+        }
+        catch {
+            // a category restriction (clause 9.3 / 9.4) refused the target
+            return node_opcua_status_code_1.StatusCodes.BadNodeIdInvalid;
+        }
+        return node_opcua_status_code_1.StatusCodes.Good;
+    }
+    /**
+     * Add an alias whose target is on another Server.
+     *
+     * Always `Uncertain_ReferenceOutOfServer`: this Server does not verify
+     * Nodes on other Servers, and clause 6.3.4 says that case returns the
+     * uncertain code rather than success.
+     */
+    addRemote(category, entry, target, _serverUri) {
+        try {
+            (0, add_alias_js_1.addAlias)(this.addressSpace, category, entry.aliasName, target, {
+                referenceType: entry.referenceTypeIds[0],
+                allowUnresolvedTarget: true
+            });
+        }
+        catch {
+            return node_opcua_status_code_1.StatusCodes.BadNodeIdInvalid;
+        }
+        return node_opcua_status_code_1.StatusCodes.UncertainReferenceOutOfServer;
+    }
+    /** True when none of the alias's targets are on this Server. */
+    isForeign(alias) {
+        const references = alias.findReferencesEx(well_known_js_1.ALIAS_FOR, node_opcua_data_model_1.BrowseDirection.Forward);
+        if (references.length === 0) {
+            return false;
+        }
+        return references.every((reference) => this.addressSpace.findNode(reference.nodeId) === null);
+    }
+    /** The URI of a namespace index, or undefined for namespace 0. */
+    namespaceUriOf(namespaceIndex) {
+        // namespace 0 is the OPC Foundation's and is never a legitimate alias
+        // namespace; reporting it would be worse than reporting nothing
+        return namespaceIndex === 0 ? undefined : this.addressSpace.getNamespaceUri(namespaceIndex);
+    }
+    /**
+     * Resolve the `ReferenceTypeFilter` argument.
+     *
+     * A null or absent NodeId means any ReferenceType (clause 6.3.2 Table 3).
+     */
+    resolveReferenceTypeFilter(filter) {
+        if (!filter || filter.isEmpty()) {
+            return null;
+        }
+        return filter;
+    }
+    /**
+     * The Nodes an alias points at.
+     *
+     * `findReferencesEx` already includes subtypes of the ReferenceType, which
+     * is what clause 6.3.2 Table 3 asks for: "Any ReferenceType includes all
+     * subtypes of that ReferenceType".
+     *
+     * An absent filter falls back to `AliasFor` rather than to *every*
+     * ReferenceType. Table 3 describes the filter as "AliasFor or one of its
+     * subtypes", and clause 8.2 makes `AliasFor` the ReferenceType that links an
+     * AliasName to what it names; taking "any" literally would return the
+     * alias's `HasTypeDefinition` target and its Organizes back-reference, which
+     * are not things the alias names.
+     */
+    targetsOf(alias, referenceTypeFilter) {
+        const referenceType = referenceTypeFilter ?? well_known_js_1.ALIAS_FOR;
+        const references = alias.findReferencesEx(referenceType, node_opcua_data_model_1.BrowseDirection.Forward);
+        return references.map((reference) => ({
+            expandedNodeId: toExpandedNodeId(this.addressSpace, reference.nodeId),
+            referenceTypeId: reference.referenceType
+        }));
+    }
+}
+exports.AddressSpaceAliasStore = AddressSpaceAliasStore;
+//# sourceMappingURL=address_space_alias_store.js.map

package/dist/address_space_alias_store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address_space_alias_store.js","sourceRoot":"","sources":["../source/address_space_alias_store.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAGH,+EAQsC;AACtC,iEAAmE;AACnE,yDAAwG;AACxG,mEAAsE;AACtE,iDAAkE;AAClE,6DAAoE;AACpE,mDAA4C;AAE5C;;;;;;;;;;;GAWG;AACH,SAAS,aAAa,CAAC,YAA2B,EAAE,MAAsB;IACtE,IAAI,cAAc,GAAG,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC;IAC3C,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QACtB,MAAM,QAAQ,GAAG,YAAY,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACrE,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;YACf,iEAAiE;YACjE,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,cAAc,GAAG,QAAQ,CAAC;IAC9B,CAAC;IACD,OAAO,IAAI,0BAAW,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;AAChF,CAAC;AAkBD,mFAAmF;AACnF,SAAS,gBAAgB,CAAC,YAA2B,EAAE,MAAc;IACjE,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpG,OAAO,IAAI,kCAAc,CACrB,MAAM,CAAC,cAAuC,EAC9C,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,SAAS,EAChB,YAAY;IACZ,uEAAuE;IACvE,sEAAsE;IACtE,CAAC,CACJ,CAAC;AACN,CAAC;AAED,MAAa,sBAAsB;IACd,YAAY,CAAgB;IAC5B,WAAW,CAAe;IAC3C,kEAAkE;IACjD,oBAAoB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEjD,kBAAkB,CAAU;IAE7C,YAAY,YAA2B,EAAE,OAAuC;QAC5E,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,WAAW,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,OAAO,EAAE,kBAAkB,IAAI,KAAK,CAAC;IACnE,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,IAAI,CAAC,KAAiB;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACd,CAAC;QACD,sEAAsE;QACtE,gEAAgE;QAChE,MAAM,OAAO,GAAG,IAAI,0CAAW,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAEjE,MAAM,mBAAmB,GAAG,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvF,MAAM,OAAO,GAAiB,EAAE,CAAC;QAEjC,wEAAwE;QACxE,yEAAyE;QACzE,yEAAyE;QACzE,uEAAuE;QACvE,MAAM,YAAY,GAAG,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC;QAEtG,KAAK,MAAM,QAAQ,IAAI,IAAA,sCAAiB,EAAC,IAAI,CAAC,YAAY,EAAE,IAAgB,CAAC,EAAE,CAAC;YAC5E,IAAI,OAAO,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC;gBACjC,MAAM;YACV,CAAC;YACD,qEAAqE;YACrE,iEAAiE;YACjE,6DAA6D;YAC7D,mEAAmE;YACnE,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBAC/D,SAAS;YACb,CAAC;YACD,KAAK,MAAM,KAAK,IAAI,IAAA,8BAAS,EAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACzD,IAAI,OAAO,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC;oBACjC,MAAM;gBACV,CAAC;gBACD,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;gBACxC,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;oBACzC,SAAS;gBACb,CAAC;gBACD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;gBAC3D,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACvB,0DAA0D;oBAC1D,uCAAuC;oBACvC,SAAS;gBACb,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC;oBACT,SAAS;oBACT,4DAA4D;oBAC5D,mDAAmD;oBACnD,2DAA2D;oBAC3D,qBAAqB,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC;oBAC3E,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;oBACrD,4DAA4D;oBAC5D,uDAAuD;oBACvD,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;oBACnC,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC;iBAC1D,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,kFAAkF;IAC3E,UAAU,CAAC,cAAsB;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,QAAQ,IAAI,IAAA,sCAAiB,EAAC,IAAI,CAAC,YAAY,EAAE,IAAgB,CAAC,EAAE,CAAC;YAC5E,MAAM,GAAG,IAAA,6CAAc,EAAC,MAAM,EAAE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QACpG,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAsB,EAAE,WAAoB;QACrD,MAAM,KAAK,GAAG,WAAW,IAAI,IAAA,6CAAc,GAAE,CAAC;QAC9C,MAAM,GAAG,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC;QACtC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAA,6CAAc,EAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACnG,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,kFAAkF;IAC3E,iBAAiB,CAAC,MAA2C;QAChE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;YAChC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IAED,qEAAqE;IAC9D,kBAAkB;QACrB,OAAO,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,GAAG,CAAC,cAAsB,EAAE,OAAqB;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC5D,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;YACvD,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,oCAAW,CAAC,gBAAgB,CAAC,CAAC;QAC3D,CAAC;QACD,MAAM,YAAY,GAAG,QAAoB,CAAC;QAE1C,qEAAqE;QACrE,uEAAuE;QACvE,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;QAEzC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACxC,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;YAE9C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACV,OAAO,oCAAW,CAAC,gBAAgB,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;gBACnB,OAAO,oCAAW,CAAC,gBAAgB,CAAC;YACxC,CAAC;YAED,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,SAAS,IAAI,MAAM,CAAC,QAAQ,EAAE,IAAI,SAAS,IAAI,EAAE,EAAE,CAAC;YACzE,IAAI,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,OAAO,oCAAW,CAAC,IAAI,CAAC;YAC5B,CAAC;YACD,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAExB,iEAAiE;YACjE,iCAAiC;YACjC,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBACrB,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC3B,OAAO,oCAAW,CAAC,eAAe,CAAC;gBACvC,CAAC;gBACD,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;YAClE,CAAC;YAED,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,cAAsB,EAAE,OAA4D;QAC9F,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC5D,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;YACvD,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,oCAAW,CAAC,WAAW,CAAC,CAAC;QACtD,CAAC;QACD,MAAM,YAAY,GAAG,QAAoB,CAAC;QAE1C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,KAAK,GAAG,IAAA,wBAAS,EAAC,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;YAC1E,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,OAAO,oCAAW,CAAC,WAAW,CAAC;YACnC,CAAC;YACD,oEAAoE;YACpE,sCAAsC;YACtC,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxB,OAAO,oCAAW,CAAC,eAAe,CAAC;YACvC,CAAC;YAED,MAAM,SAAS,GAAG,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC;YAC9C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,sDAAsD;gBACtD,IAAA,0BAAW,EAAC,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;gBAC9D,OAAO,oCAAW,CAAC,IAAI,CAAC;YAC5B,CAAC;YAED,gEAAgE;YAChE,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,CAAC,yBAAS,EAAE,uCAAe,CAAC,OAAO,CAAC,CAAC;YAC9E,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YACpE,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,MAAM,IAAI,SAAS,EAAE,CAAC;gBAC7B,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;gBACvD,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;oBAC3C,OAAO,oCAAW,CAAC,WAAW,CAAC;gBACnC,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YACD,KAAK,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;gBAC1B,IAAA,0BAAW,EAAC,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAC1E,CAAC;YACD,OAAO,oCAAW,CAAC,IAAI,CAAC;QAC5B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,mDAAmD;IAC3C,QAAQ,CAAC,QAAkB,EAAE,KAAiB,EAAE,MAAsB;QAC1E,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,EAAE,CAAC;YACf,OAAO,oCAAW,CAAC,gBAAgB,CAAC;QACxC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,mEAAmE;YACnE,4CAA4C;YAC5C,OAAO,oCAAW,CAAC,gBAAgB,CAAC;QACxC,CAAC;QACD,IAAI,CAAC;YACD,IAAA,uBAAQ,EAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,EAAE,WAAW,EAAE;gBAChE,aAAa,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;aAC3C,CAAC,CAAC;QACP,CAAC;QAAC,MAAM,CAAC;YACL,+DAA+D;YAC/D,OAAO,oCAAW,CAAC,gBAAgB,CAAC;QACxC,CAAC;QACD,OAAO,oCAAW,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACK,SAAS,CAAC,QAAkB,EAAE,KAAiB,EAAE,MAAsB,EAAE,UAAkB;QAC/F,IAAI,CAAC;YACD,IAAA,uBAAQ,EAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE;gBAC3D,aAAa,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;gBACxC,qBAAqB,EAAE,IAAI;aAC9B,CAAC,CAAC;QACP,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,oCAAW,CAAC,gBAAgB,CAAC;QACxC,CAAC;QACD,OAAO,oCAAW,CAAC,6BAA6B,CAAC;IACrD,CAAC;IAED,gEAAgE;IACxD,SAAS,CAAC,KAAe;QAC7B,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,CAAC,yBAAS,EAAE,uCAAe,CAAC,OAAO,CAAC,CAAC;QAC9E,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC;IAClG,CAAC;IAED,kEAAkE;IAC1D,cAAc,CAAC,cAAsB;QACzC,sEAAsE;QACtE,gEAAgE;QAChE,OAAO,cAAc,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAChG,CAAC;IAED;;;;OAIG;IACK,0BAA0B,CAAC,MAA0B;QACzD,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,SAAS,CACb,KAAe,EACf,mBAAkC;QAElC,MAAM,aAAa,GAAG,mBAAmB,IAAI,yBAAS,CAAC;QACvD,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,CAAC,aAAa,EAAE,uCAAe,CAAC,OAAO,CAAC,CAAC;QAClF,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAClC,cAAc,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,MAAM,CAAC;YACrE,eAAe,EAAE,SAAS,CAAC,aAAa;SAC3C,CAAC,CAAC,CAAC;IACR,CAAC;CACJ;AA7UD,wDA6UC"}

package/dist/alias_hierarchy.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @module node-opcua-alias-name-server
+ *
+ * Walking the AliasName hierarchy in the address space (OPC 10000-17
+ * clause 6.3.1).
+ */
+import type { BaseNode, IAddressSpace, UAObject, UAObjectType } from "node-opcua-address-space-base";
+import type { NodeId } from "node-opcua-nodeid";
+/** Resolve `AliasNameCategoryType`, or null on an address space without Part 17. */
+export declare function findAliasNameCategoryType(addressSpace: IAddressSpace): UAObjectType | null;
+/** Resolve `AliasNameType`, or null on an address space without Part 17. */
+export declare function findAliasNameType(addressSpace: IAddressSpace): UAObjectType | null;
+/** True when `node` is an instance of `AliasNameCategoryType` (or a subtype). */
+export declare function isAliasNameCategory(addressSpace: IAddressSpace, node: BaseNode): boolean;
+/** True when `node` is an instance of `AliasNameType` (or a subtype). */
+export declare function isAliasName(addressSpace: IAddressSpace, node: BaseNode): boolean;
+/**
+ * Every `AliasNameCategoryType` instance at or below `root`, depth first.
+ *
+ * A category may legitimately be reached more than once — clause 6.3.1 allows an
+ * `<Alias>` (and by extension a subtree) to appear in more than one place — so
+ * `seen` both de-duplicates and makes a cyclic hierarchy terminate rather than
+ * hang the Method call.
+ */
+export declare function collectCategories(addressSpace: IAddressSpace, root: UAObject): UAObject[];
+/** The `AliasNameType` instances Organized directly by `category`. */
+export declare function aliasesOf(addressSpace: IAddressSpace, category: UAObject): UAObject[];
+/**
+ * Every `AliasNameCategoryType` instance reachable from `Aliases`, plus any
+ * roots named explicitly.
+ *
+ * Discovery walks the hierarchy below `Aliases` rather than sweeping the whole
+ * address space, because that is where clause 9.1 puts categories: vendors "are
+ * free to add additional instances of AliasNameCategoryType under this
+ * hierarchy". There is also no way to sweep — the address space keeps no inverse
+ * `HasTypeDefinition` reference from an ObjectType to its instances, so a type
+ * cannot be asked for them.
+ *
+ * `additionalRoots` is the escape hatch for a Server that models a category
+ * somewhere else: without it that category's MANDATORY `FindAlias` would stay
+ * unbound, which is the very defect this package exists to fix.
+ */
+export declare function collectAllCategories(addressSpace: IAddressSpace, additionalRoots?: Array<NodeId | UAObject>): UAObject[];
+/** The NodeIds of the well-known categories present in this address space. */
+export declare function presentWellKnownCategories(addressSpace: IAddressSpace): NodeId[];

package/dist/alias_hierarchy.js

@@ -0,0 +1,135 @@
+"use strict";
+/**
+ * @module node-opcua-alias-name-server
+ *
+ * Walking the AliasName hierarchy in the address space (OPC 10000-17
+ * clause 6.3.1).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findAliasNameCategoryType = findAliasNameCategoryType;
+exports.findAliasNameType = findAliasNameType;
+exports.isAliasNameCategory = isAliasNameCategory;
+exports.isAliasName = isAliasName;
+exports.collectCategories = collectCategories;
+exports.aliasesOf = aliasesOf;
+exports.collectAllCategories = collectAllCategories;
+exports.presentWellKnownCategories = presentWellKnownCategories;
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const well_known_js_1 = require("./well_known.js");
+/** True when `node` is an Object whose TypeDefinition is `type` or a subtype. */
+function isInstanceOf(node, type) {
+    if (!type || node.nodeClass !== node_opcua_data_model_1.NodeClass.Object) {
+        return false;
+    }
+    const typeDefinition = node.typeDefinitionObj;
+    if (!typeDefinition) {
+        return false;
+    }
+    return typeDefinition.nodeId.value === type.nodeId.value || typeDefinition.isSubtypeOf(type);
+}
+/** Resolve `AliasNameCategoryType`, or null on an address space without Part 17. */
+function findAliasNameCategoryType(addressSpace) {
+    return addressSpace.findObjectType(well_known_js_1.ALIAS_NAME_CATEGORY_TYPE);
+}
+/** Resolve `AliasNameType`, or null on an address space without Part 17. */
+function findAliasNameType(addressSpace) {
+    return addressSpace.findObjectType(well_known_js_1.ALIAS_NAME_TYPE);
+}
+/** True when `node` is an instance of `AliasNameCategoryType` (or a subtype). */
+function isAliasNameCategory(addressSpace, node) {
+    return isInstanceOf(node, findAliasNameCategoryType(addressSpace));
+}
+/** True when `node` is an instance of `AliasNameType` (or a subtype). */
+function isAliasName(addressSpace, node) {
+    return isInstanceOf(node, findAliasNameType(addressSpace));
+}
+/**
+ * The Organized children of a category.
+ *
+ * `findReferencesExAsObject` follows subtypes of the ReferenceType, so a vendor
+ * subtype of `Organizes` is included, and `HierarchicalReferences` is used as
+ * the base so a Server that nests categories with `HasComponent` is not missed.
+ */
+function organizedChildren(category) {
+    return category.findReferencesExAsObject("HierarchicalReferences", node_opcua_data_model_1.BrowseDirection.Forward);
+}
+/**
+ * Every `AliasNameCategoryType` instance at or below `root`, depth first.
+ *
+ * A category may legitimately be reached more than once — clause 6.3.1 allows an
+ * `<Alias>` (and by extension a subtree) to appear in more than one place — so
+ * `seen` both de-duplicates and makes a cyclic hierarchy terminate rather than
+ * hang the Method call.
+ */
+function collectCategories(addressSpace, root) {
+    const result = [];
+    const seen = new Set();
+    const visit = (category) => {
+        const key = category.nodeId.toString();
+        if (seen.has(key)) {
+            return;
+        }
+        seen.add(key);
+        result.push(category);
+        for (const child of organizedChildren(category)) {
+            if (isAliasNameCategory(addressSpace, child)) {
+                visit(child);
+            }
+        }
+    };
+    visit(root);
+    return result;
+}
+/** The `AliasNameType` instances Organized directly by `category`. */
+function aliasesOf(addressSpace, category) {
+    const result = [];
+    for (const child of organizedChildren(category)) {
+        if (isAliasName(addressSpace, child)) {
+            result.push(child);
+        }
+    }
+    return result;
+}
+/**
+ * Every `AliasNameCategoryType` instance reachable from `Aliases`, plus any
+ * roots named explicitly.
+ *
+ * Discovery walks the hierarchy below `Aliases` rather than sweeping the whole
+ * address space, because that is where clause 9.1 puts categories: vendors "are
+ * free to add additional instances of AliasNameCategoryType under this
+ * hierarchy". There is also no way to sweep — the address space keeps no inverse
+ * `HasTypeDefinition` reference from an ObjectType to its instances, so a type
+ * cannot be asked for them.
+ *
+ * `additionalRoots` is the escape hatch for a Server that models a category
+ * somewhere else: without it that category's MANDATORY `FindAlias` would stay
+ * unbound, which is the very defect this package exists to fix.
+ */
+function collectAllCategories(addressSpace, additionalRoots) {
+    const byId = new Map();
+    const roots = [];
+    const aliasesRoot = addressSpace.findNode(well_known_js_1.WellKnownCategories.Aliases);
+    if (aliasesRoot) {
+        roots.push(aliasesRoot);
+    }
+    for (const extra of additionalRoots ?? []) {
+        const node = "nodeClass" in extra ? extra : addressSpace.findNode(extra);
+        if (node) {
+            roots.push(node);
+        }
+    }
+    for (const root of roots) {
+        if (root.nodeClass !== node_opcua_data_model_1.NodeClass.Object) {
+            continue;
+        }
+        for (const category of collectCategories(addressSpace, root)) {
+            byId.set(category.nodeId.toString(), category);
+        }
+    }
+    return [...byId.values()];
+}
+/** The NodeIds of the well-known categories present in this address space. */
+function presentWellKnownCategories(addressSpace) {
+    return Object.values(well_known_js_1.WellKnownCategories).filter((nodeId) => addressSpace.findNode(nodeId) !== null);
+}
+//# sourceMappingURL=alias_hierarchy.js.map

package/dist/alias_hierarchy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alias_hierarchy.js","sourceRoot":"","sources":["../source/alias_hierarchy.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAoBH,8DAEC;AAGD,8CAEC;AAGD,kDAEC;AAGD,kCAEC;AAqBD,8CAoBC;AAGD,8BAQC;AAiBD,oDAwBC;AAGD,gEAEC;AApID,iEAAmE;AAEnE,mDAAiG;AAEjG,iFAAiF;AACjF,SAAS,YAAY,CAAC,IAAc,EAAE,IAAyB;IAC3D,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,cAAc,GAAI,IAAiB,CAAC,iBAAiB,CAAC;IAC5D,IAAI,CAAC,cAAc,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,cAAc,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AACjG,CAAC;AAED,oFAAoF;AACpF,SAAgB,yBAAyB,CAAC,YAA2B;IACjE,OAAO,YAAY,CAAC,cAAc,CAAC,wCAAwB,CAAC,CAAC;AACjE,CAAC;AAED,4EAA4E;AAC5E,SAAgB,iBAAiB,CAAC,YAA2B;IACzD,OAAO,YAAY,CAAC,cAAc,CAAC,+BAAe,CAAC,CAAC;AACxD,CAAC;AAED,iFAAiF;AACjF,SAAgB,mBAAmB,CAAC,YAA2B,EAAE,IAAc;IAC3E,OAAO,YAAY,CAAC,IAAI,EAAE,yBAAyB,CAAC,YAAY,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,yEAAyE;AACzE,SAAgB,WAAW,CAAC,YAA2B,EAAE,IAAc;IACnE,OAAO,YAAY,CAAC,IAAI,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iBAAiB,CAAC,QAAkB;IACzC,OAAO,QAAQ,CAAC,wBAAwB,CAAC,wBAAwB,EAAE,uCAAe,CAAC,OAAO,CAAC,CAAC;AAChG,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,YAA2B,EAAE,IAAc;IACzE,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAE/B,MAAM,KAAK,GAAG,CAAC,QAAkB,EAAQ,EAAE;QACvC,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAChB,OAAO;QACX,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtB,KAAK,MAAM,KAAK,IAAI,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9C,IAAI,mBAAmB,CAAC,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC3C,KAAK,CAAC,KAAiB,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC;IACL,CAAC,CAAC;IAEF,KAAK,CAAC,IAAI,CAAC,CAAC;IACZ,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,sEAAsE;AACtE,SAAgB,SAAS,CAAC,YAA2B,EAAE,QAAkB;IACrE,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,KAAK,MAAM,KAAK,IAAI,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,IAAI,WAAW,CAAC,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,KAAiB,CAAC,CAAC;QACnC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,oBAAoB,CAAC,YAA2B,EAAE,eAA0C;IACxG,MAAM,IAAI,GAAG,IAAI,GAAG,EAAoB,CAAC;IAEzC,MAAM,KAAK,GAAe,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC,mCAAmB,CAAC,OAAO,CAAC,CAAC;IACvE,IAAI,WAAW,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5B,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,eAAe,IAAI,EAAE,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzE,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;IACL,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;YACtC,SAAS;QACb,CAAC;QACD,KAAK,MAAM,QAAQ,IAAI,iBAAiB,CAAC,YAAY,EAAE,IAAgB,CAAC,EAAE,CAAC;YACvE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,CAAC;QACnD,CAAC;IACL,CAAC;IACD,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;AAC9B,CAAC;AAED,8EAA8E;AAC9E,SAAgB,0BAA0B,CAAC,YAA2B;IAClE,OAAO,MAAM,CAAC,MAAM,CAAC,mCAAmB,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC;AACzG,CAAC"}

package/dist/alias_index.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @module node-opcua-alias-name-server
+ *
+ * A per-category index from AliasName to the `AliasNameType` Object that carries
+ * it.
+ *
+ * ## Why this exists
+ *
+ * Looking an alias up by name means finding a child of the category with a given
+ * BrowseName. The address space has an O(1) index for exactly that — but
+ * `getChildByName` only consults it for `HasChild` subtypes, and an alias is an
+ * `Organizes` child of its category (clause 6.3 Table 2). `getFolderElementByName`
+ * does cover `Organizes`, but scans. So neither route is both correct and fast.
+ *
+ * That matters because `addAlias` has to look for an existing alias of the same
+ * name before creating one, so a Server building N aliases performed N linear
+ * scans of a growing category — quadratic. Measured on a category holding 1500
+ * aliases, 200 lookups cost 97 ms by scanning and 0 ms through this index, and
+ * building 1500 aliases went from 2545 ms to 1686 ms.
+ *
+ * That is not the whole story: the larger remaining cost is inside
+ * `UAObjectType.instantiate`, which is itself superlinear in the number of
+ * children the parent already has. That is an address-space concern rather than
+ * an AliasName one, and is tracked separately.
+ *
+ * ## How it stays correct
+ *
+ * The index is built lazily, from one full scan, so aliases modelled in a
+ * NodeSet2.xml are picked up. After that it is maintained incrementally by
+ * {@link noteAliasAdded} and {@link noteAliasRemoved}, which `addAlias` and
+ * `removeAlias` call.
+ *
+ * A hit is verified against the address space before being returned, so an alias
+ * deleted by other means degrades to a miss rather than a dangling Object. A
+ * miss is trusted: an alias created behind this package's back after the index
+ * was built would not be found, and `addAlias` would then fail loudly on the
+ * duplicate BrowseName rather than corrupting anything. Call
+ * {@link invalidateAliasIndex} if a Server mutates a category by other means.
+ *
+ * Keyed by the node itself in a `WeakMap`, so a disposed address space takes its
+ * indexes with it.
+ */
+import type { IAddressSpace, UAObject } from "node-opcua-address-space-base";
+import type { NodeId } from "node-opcua-nodeid";
+/**
+ * The `AliasNameType` instance with this name in `category`, or null.
+ *
+ * O(1) after the first call on a given category.
+ */
+export declare function lookupAlias(addressSpace: IAddressSpace, category: UAObject, aliasName: string): UAObject | null;
+/** Record a newly created alias. */
+export declare function noteAliasAdded(addressSpace: IAddressSpace, category: UAObject, aliasName: string, nodeId: NodeId): void;
+/** Record a removed alias. */
+export declare function noteAliasRemoved(addressSpace: IAddressSpace, category: UAObject, aliasName: string): void;
+/**
+ * Forget a category's index, so it is rebuilt from the address space on next
+ * use. Needed only if a Server adds or removes aliases without going through
+ * {@link addAlias} / {@link removeAlias}.
+ */
+export declare function invalidateAliasIndex(category: UAObject): void;