@metamask/name-controller 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0]
+### Added
+- Initial Release ([#1647](https://github.com/MetaMask/core/pull/1647))
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/name-controller@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/name-controller@1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2023 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/name-controller`
+
+Stores and suggests names for values such as Ethereum addresses.
+
+## Installation
+
+`yarn add @metamask/name-controller`
+
+or
+
+`npm install @metamask/name-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/NameController.d.ts

@@ -0,0 +1,91 @@
+import type { RestrictedControllerMessenger } from '@metamask/base-controller';
+import { BaseControllerV2 } from '@metamask/base-controller';
+import type { Patch } from 'immer';
+import type { NameProvider } from './types';
+import { NameType } from './types';
+declare const controllerName = "NameController";
+export declare type NameEntry = {
+    name: string | null;
+    sourceId: string | null;
+    proposedNames: Record<string, string[] | null>;
+    proposedNamesLastUpdated: number | null;
+};
+export declare type SourceEntry = {
+    label: string;
+};
+export declare type NameControllerState = {
+    names: Record<NameType, Record<string, Record<string, NameEntry>>>;
+    nameSources: Record<string, SourceEntry>;
+};
+export declare type GetNameState = {
+    type: `${typeof controllerName}:getState`;
+    handler: () => NameControllerState;
+};
+export declare type NameStateChange = {
+    type: `${typeof controllerName}:stateChange`;
+    payload: [NameControllerState, Patch[]];
+};
+export declare type NameControllerActions = GetNameState;
+export declare type NameControllerEvents = NameStateChange;
+export declare type NameControllerMessenger = RestrictedControllerMessenger<typeof controllerName, NameControllerActions, NameControllerEvents, never, never>;
+export declare type NameControllerOptions = {
+    getChainId: () => string;
+    messenger: NameControllerMessenger;
+    providers: NameProvider[];
+    state?: Partial<NameControllerState>;
+};
+export declare type UpdateProposedNamesRequest = {
+    value: string;
+    type: NameType;
+    sourceIds?: string[];
+};
+export declare type UpdateProposedNamesResult = {
+    results: Record<string, {
+        proposedNames?: string[];
+        error?: unknown;
+    }>;
+};
+export declare type SetNameRequest = {
+    value: string;
+    type: NameType;
+    name: string;
+    sourceId?: string;
+};
+/**
+ * Controller for storing and deriving names for values such as Ethereum addresses.
+ */
+export declare class NameController extends BaseControllerV2<typeof controllerName, NameControllerState, NameControllerMessenger> {
+    #private;
+    /**
+     * Construct a Name controller.
+     *
+     * @param options - Controller options.
+     * @param options.getChainId - Callback that returns the chain ID of the current network.
+     * @param options.messenger - Restricted controller messenger for the name controller.
+     * @param options.providers - Array of name provider instances to propose names.
+     * @param options.state - Initial state to set on the controller.
+     */
+    constructor({ getChainId, messenger, providers, state, }: NameControllerOptions);
+    /**
+     * Set the user specified name for a value.
+     *
+     * @param request - Request object.
+     * @param request.name - Name to set.
+     * @param request.sourceId - Optional ID of the source of the proposed name.
+     * @param request.type - Type of value to set the name for.
+     * @param request.value - Value to set the name for.
+     */
+    setName(request: SetNameRequest): void;
+    /**
+     * Generate the proposed names for a value using the name providers and store them in the state.
+     *
+     * @param request - Request object.
+     * @param request.value - Value to update the proposed names for.
+     * @param request.type - Type of value to update the proposed names for.
+     * @param request.sourceIds - Optional array of source IDs to limit which sources are used by the providers. If not provided, all sources in all providers will be used.
+     * @returns The updated proposed names for the value.
+     */
+    updateProposedNames(request: UpdateProposedNamesRequest): Promise<UpdateProposedNamesResult>;
+}
+export {};
+//# sourceMappingURL=NameController.d.ts.map

package/dist/NameController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NameController.d.ts","sourceRoot":"","sources":["../src/NameController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,KAAK,EACV,YAAY,EAGb,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,QAAA,MAAM,cAAc,mBAAmB,CAAC;AAcxC,oBAAY,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC/C,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAEhC,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACnE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;CAC1C,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB,IAAI,EAAE,GAAG,OAAO,cAAc,WAAW,CAAC;IAC1C,OAAO,EAAE,MAAM,mBAAmB,CAAC;CACpC,CAAC;AAEF,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,OAAO,cAAc,cAAc,CAAC;IAC7C,OAAO,EAAE,CAAC,mBAAmB,EAAE,KAAK,EAAE,CAAC,CAAC;CACzC,CAAC;AAEF,oBAAY,qBAAqB,GAAG,YAAY,CAAC;AAEjD,oBAAY,oBAAoB,GAAG,eAAe,CAAC;AAEnD,oBAAY,uBAAuB,GAAG,6BAA6B,CACjE,OAAO,cAAc,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,KAAK,EACL,KAAK,CACN,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAClC,UAAU,EAAE,MAAM,MAAM,CAAC;IACzB,SAAS,EAAE,uBAAuB,CAAC;IACnC,SAAS,EAAE,YAAY,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACtC,CAAC;AAEF,oBAAY,0BAA0B,GAAG;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,oBAAY,yBAAyB,GAAG;IACtC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACxE,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,qBAAa,cAAe,SAAQ,gBAAgB,CAClD,OAAO,cAAc,EACrB,mBAAmB,EACnB,uBAAuB,CACxB;;IAKC;;;;;;;;OAQG;gBACS,EACV,UAAU,EACV,SAAS,EACT,SAAS,EACT,KAAK,GACN,EAAE,qBAAqB;IAYxB;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,EAAE,cAAc;IAQ/B;;;;;;;;OAQG;IACG,mBAAmB,CACvB,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,yBAAyB,CAAC;CAgVtC"}

package/dist/NameController.js

@@ -0,0 +1,293 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _NameController_instances, _NameController_getChainId, _NameController_providers, _NameController_updateProposedNameState, _NameController_updateSourceState, _NameController_getUpdateProposedNamesResult, _NameController_getProviderResponse, _NameController_updateEntry, _NameController_getTypeVariationKey, _NameController_getCurrentTimeSeconds, _NameController_validateSetNameRequest, _NameController_validateUpdateProposedNamesRequest, _NameController_validateValue, _NameController_validateType, _NameController_validateName, _NameController_validateSourceIds, _NameController_validateSourceId, _NameController_validateDuplicateSourceIds, _NameController_getAllSourceIds, _NameController_getSourceIds;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NameController = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const types_1 = require("./types");
+const controllerName = 'NameController';
+const stateMetadata = {
+    names: { persist: true, anonymous: false },
+    nameSources: { persist: true, anonymous: false },
+};
+const getDefaultState = () => ({
+    names: {
+        [types_1.NameType.ETHEREUM_ADDRESS]: {},
+    },
+    nameSources: {},
+});
+/**
+ * Controller for storing and deriving names for values such as Ethereum addresses.
+ */
+class NameController extends base_controller_1.BaseControllerV2 {
+    /**
+     * Construct a Name controller.
+     *
+     * @param options - Controller options.
+     * @param options.getChainId - Callback that returns the chain ID of the current network.
+     * @param options.messenger - Restricted controller messenger for the name controller.
+     * @param options.providers - Array of name provider instances to propose names.
+     * @param options.state - Initial state to set on the controller.
+     */
+    constructor({ getChainId, messenger, providers, state, }) {
+        super({
+            name: controllerName,
+            metadata: stateMetadata,
+            messenger,
+            state: Object.assign(Object.assign({}, getDefaultState()), state),
+        });
+        _NameController_instances.add(this);
+        _NameController_getChainId.set(this, void 0);
+        _NameController_providers.set(this, void 0);
+        __classPrivateFieldSet(this, _NameController_getChainId, getChainId, "f");
+        __classPrivateFieldSet(this, _NameController_providers, providers, "f");
+    }
+    /**
+     * Set the user specified name for a value.
+     *
+     * @param request - Request object.
+     * @param request.name - Name to set.
+     * @param request.sourceId - Optional ID of the source of the proposed name.
+     * @param request.type - Type of value to set the name for.
+     * @param request.value - Value to set the name for.
+     */
+    setName(request) {
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateSetNameRequest).call(this, request);
+        const { value, type, name, sourceId } = request;
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateEntry).call(this, value, type, { name, sourceId: sourceId !== null && sourceId !== void 0 ? sourceId : null });
+    }
+    /**
+     * Generate the proposed names for a value using the name providers and store them in the state.
+     *
+     * @param request - Request object.
+     * @param request.value - Value to update the proposed names for.
+     * @param request.type - Type of value to update the proposed names for.
+     * @param request.sourceIds - Optional array of source IDs to limit which sources are used by the providers. If not provided, all sources in all providers will be used.
+     * @returns The updated proposed names for the value.
+     */
+    updateProposedNames(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateUpdateProposedNamesRequest).call(this, request);
+            const chainId = __classPrivateFieldGet(this, _NameController_getChainId, "f").call(this);
+            const providerResponses = (yield Promise.all(__classPrivateFieldGet(this, _NameController_providers, "f").map((provider) => __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getProviderResponse).call(this, request, chainId, provider)))).filter((response) => Boolean(response));
+            __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateProposedNameState).call(this, request, providerResponses);
+            __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateSourceState).call(this, __classPrivateFieldGet(this, _NameController_providers, "f"));
+            return __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getUpdateProposedNamesResult).call(this, providerResponses);
+        });
+    }
+}
+exports.NameController = NameController;
+_NameController_getChainId = new WeakMap(), _NameController_providers = new WeakMap(), _NameController_instances = new WeakSet(), _NameController_updateProposedNameState = function _NameController_updateProposedNameState(request, providerResponses) {
+    var _a, _b, _c;
+    const { value, type } = request;
+    const newProposedNames = {};
+    for (const providerResponse of providerResponses) {
+        const { results, error: responseError } = providerResponse;
+        if (responseError) {
+            continue;
+        }
+        for (const sourceId of Object.keys(providerResponse.results)) {
+            const result = results[sourceId];
+            const { proposedNames } = result;
+            let finalProposedNames = result.error ? null : proposedNames !== null && proposedNames !== void 0 ? proposedNames : [];
+            if (finalProposedNames) {
+                finalProposedNames = finalProposedNames.filter((proposedName) => proposedName === null || proposedName === void 0 ? void 0 : proposedName.length);
+            }
+            newProposedNames[sourceId] = finalProposedNames;
+        }
+    }
+    const variationKey = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getTypeVariationKey).call(this, type);
+    const existingProposedNames = (_c = (_b = (_a = this.state.names[type]) === null || _a === void 0 ? void 0 : _a[value]) === null || _b === void 0 ? void 0 : _b[variationKey]) === null || _c === void 0 ? void 0 : _c.proposedNames;
+    const proposedNames = Object.assign(Object.assign({}, existingProposedNames), newProposedNames);
+    const proposedNamesLastUpdated = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getCurrentTimeSeconds).call(this);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateEntry).call(this, value, type, { proposedNames, proposedNamesLastUpdated });
+}, _NameController_updateSourceState = function _NameController_updateSourceState(providers) {
+    const newNameSources = Object.assign({}, this.state.nameSources);
+    for (const provider of providers) {
+        const { sourceLabels } = provider.getMetadata();
+        for (const sourceId of Object.keys(sourceLabels)) {
+            newNameSources[sourceId] = {
+                label: sourceLabels[sourceId],
+            };
+        }
+    }
+    this.update((state) => {
+        state.nameSources = newNameSources;
+    });
+}, _NameController_getUpdateProposedNamesResult = function _NameController_getUpdateProposedNamesResult(providerResponses) {
+    return providerResponses.reduce((acc, providerResponse) => {
+        const { results } = providerResponse;
+        for (const sourceId of Object.keys(results)) {
+            const { proposedNames: resultProposedNames, error: resultError } = results[sourceId];
+            let proposedNames = resultError
+                ? undefined
+                : resultProposedNames !== null && resultProposedNames !== void 0 ? resultProposedNames : [];
+            if (proposedNames) {
+                proposedNames = proposedNames.filter((proposedName) => proposedName === null || proposedName === void 0 ? void 0 : proposedName.length);
+            }
+            acc.results[sourceId] = {
+                proposedNames,
+                error: resultError,
+            };
+        }
+        return acc;
+    }, { results: {} });
+}, _NameController_getProviderResponse = function _NameController_getProviderResponse(request, chainId, provider) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const { value, type, sourceIds: requestedSourceIds } = request;
+        const supportedSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getSourceIds).call(this, provider, type);
+        const matchingSourceIds = (_a = requestedSourceIds === null || requestedSourceIds === void 0 ? void 0 : requestedSourceIds.filter((sourceId) => supportedSourceIds.includes(sourceId))) !== null && _a !== void 0 ? _a : supportedSourceIds;
+        if (requestedSourceIds && !matchingSourceIds.length) {
+            return undefined;
+        }
+        const providerRequest = {
+            chainId,
+            value,
+            type,
+            sourceIds: requestedSourceIds ? matchingSourceIds : undefined,
+        };
+        let responseError;
+        let response;
+        try {
+            response = yield provider.getProposedNames(providerRequest);
+            responseError = response.error;
+        }
+        catch (error) {
+            responseError = error;
+        }
+        let results = {};
+        if (response === null || response === void 0 ? void 0 : response.results) {
+            results = Object.keys(response.results).reduce((acc, sourceId) => {
+                if (!requestedSourceIds || requestedSourceIds.includes(sourceId)) {
+                    acc[sourceId] = response.results[sourceId];
+                }
+                return acc;
+            }, {});
+        }
+        if (responseError) {
+            results = supportedSourceIds.reduce((acc, sourceId) => {
+                acc[sourceId] = { proposedNames: [], error: responseError };
+                return acc;
+            }, {});
+        }
+        return { results, error: responseError };
+    });
+}, _NameController_updateEntry = function _NameController_updateEntry(value, type, data) {
+    const variationKey = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getTypeVariationKey).call(this, type);
+    this.update((state) => {
+        var _a;
+        const typeEntries = state.names[type] || {};
+        state.names[type] = typeEntries;
+        const variationEntries = typeEntries[value] || {};
+        typeEntries[value] = variationEntries;
+        const currentEntry = (_a = variationEntries[variationKey]) !== null && _a !== void 0 ? _a : {
+            proposedNames: {},
+            proposedNamesLastUpdated: null,
+            name: null,
+            sourceId: null,
+        };
+        const updatedEntry = Object.assign(Object.assign({}, currentEntry), data);
+        variationEntries[variationKey] = updatedEntry;
+    });
+}, _NameController_getTypeVariationKey = function _NameController_getTypeVariationKey(type) {
+    switch (type) {
+        default: {
+            return __classPrivateFieldGet(this, _NameController_getChainId, "f").call(this);
+        }
+    }
+}, _NameController_getCurrentTimeSeconds = function _NameController_getCurrentTimeSeconds() {
+    return Math.round(Date.now() / 1000);
+}, _NameController_validateSetNameRequest = function _NameController_validateSetNameRequest(request) {
+    const { name, value, type, sourceId } = request;
+    const errorMessages = [];
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateValue).call(this, value, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateType).call(this, type, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateName).call(this, name, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateSourceId).call(this, sourceId, type, errorMessages);
+    if (errorMessages.length) {
+        throw new Error(errorMessages.join(' '));
+    }
+}, _NameController_validateUpdateProposedNamesRequest = function _NameController_validateUpdateProposedNamesRequest(request) {
+    const { value, type, sourceIds } = request;
+    const errorMessages = [];
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateValue).call(this, value, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateType).call(this, type, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateSourceIds).call(this, sourceIds, type, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateDuplicateSourceIds).call(this, type, errorMessages);
+    if (errorMessages.length) {
+        throw new Error(errorMessages.join(' '));
+    }
+}, _NameController_validateValue = function _NameController_validateValue(value, errorMessages) {
+    if (!(value === null || value === void 0 ? void 0 : value.length) || typeof value !== 'string') {
+        errorMessages.push('Must specify a non-empty string for value.');
+    }
+}, _NameController_validateType = function _NameController_validateType(type, errorMessages) {
+    if (!Object.values(types_1.NameType).includes(type)) {
+        errorMessages.push(`Must specify one of the following types: ${Object.values(types_1.NameType).join(', ')}`);
+    }
+}, _NameController_validateName = function _NameController_validateName(name, errorMessages) {
+    if (!(name === null || name === void 0 ? void 0 : name.length) || typeof name !== 'string') {
+        errorMessages.push('Must specify a non-empty string for name.');
+    }
+}, _NameController_validateSourceIds = function _NameController_validateSourceIds(sourceIds, type, errorMessages) {
+    if (!sourceIds) {
+        return;
+    }
+    const allSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getAllSourceIds).call(this, type);
+    const missingSourceIds = [];
+    for (const sourceId of sourceIds) {
+        if (!allSourceIds.includes(sourceId)) {
+            missingSourceIds.push(sourceId);
+            continue;
+        }
+    }
+    if (missingSourceIds.length) {
+        errorMessages.push(`Unknown source IDs for type '${type}': ${missingSourceIds.join(', ')}`);
+    }
+}, _NameController_validateSourceId = function _NameController_validateSourceId(sourceId, type, errorMessages) {
+    if (sourceId === null || sourceId === undefined) {
+        return;
+    }
+    const allSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getAllSourceIds).call(this, type);
+    if (!sourceId.length || typeof sourceId !== 'string') {
+        errorMessages.push('Must specify a non-empty string for sourceId.');
+        return;
+    }
+    if (!allSourceIds.includes(sourceId)) {
+        errorMessages.push(`Unknown source ID for type '${type}': ${sourceId}`);
+    }
+}, _NameController_validateDuplicateSourceIds = function _NameController_validateDuplicateSourceIds(type, errorMessages) {
+    const allSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getAllSourceIds).call(this, type);
+    const duplicateSourceIds = allSourceIds.filter((sourceId, index) => allSourceIds.indexOf(sourceId) !== index);
+    if (duplicateSourceIds.length) {
+        errorMessages.push(`Duplicate source IDs found for type '${type}': ${duplicateSourceIds.join(', ')}`);
+    }
+}, _NameController_getAllSourceIds = function _NameController_getAllSourceIds(type) {
+    return (__classPrivateFieldGet(this, _NameController_providers, "f")
+        /* istanbul ignore next */
+        .map((provider) => __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getSourceIds).call(this, provider, type))
+        .flat());
+}, _NameController_getSourceIds = function _NameController_getSourceIds(provider, type) {
+    return provider.getMetadata().sourceIds[type];
+};
+//# sourceMappingURL=NameController.js.map

package/dist/NameController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NameController.js","sourceRoot":"","sources":["../src/NameController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AACA,+DAA6D;AAQ7D,mCAAmC;AAEnC,MAAM,cAAc,GAAG,gBAAgB,CAAC;AAExC,MAAM,aAAa,GAAG;IACpB,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC1C,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACjD,CAAC;AAEF,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,CAAC;IAC7B,KAAK,EAAE;QACL,CAAC,gBAAQ,CAAC,gBAAgB,CAAC,EAAE,EAAE;KAChC;IACD,WAAW,EAAE,EAAE;CAChB,CAAC,CAAC;AAiEH;;GAEG;AACH,MAAa,cAAe,SAAQ,kCAInC;IAKC;;;;;;;;OAQG;IACH,YAAY,EACV,UAAU,EACV,SAAS,EACT,SAAS,EACT,KAAK,GACiB;QACtB,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,kCAAO,eAAe,EAAE,GAAK,KAAK,CAAE;SAC1C,CAAC,CAAC;;QAxBL,6CAA0B;QAE1B,4CAA2B;QAwBzB,uBAAA,IAAI,8BAAe,UAAU,MAAA,CAAC;QAC9B,uBAAA,IAAI,6BAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAuB;QAC7B,uBAAA,IAAI,yEAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CAAC;QAEtC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAEhD,uBAAA,IAAI,8DAAa,MAAjB,IAAI,EAAc,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,IAAI,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACG,mBAAmB,CACvB,OAAmC;;YAEnC,uBAAA,IAAI,qFAAoC,MAAxC,IAAI,EAAqC,OAAO,CAAC,CAAC;YAElD,MAAM,OAAO,GAAG,uBAAA,IAAI,kCAAY,MAAhB,IAAI,CAAc,CAAC;YAEnC,MAAM,iBAAiB,GAAG,CACxB,MAAM,OAAO,CAAC,GAAG,CACf,uBAAA,IAAI,iCAAW,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC/B,uBAAA,IAAI,sEAAqB,MAAzB,IAAI,EAAsB,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CACtD,CACF,CACF,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAyB,CAAC;YAElE,uBAAA,IAAI,0EAAyB,MAA7B,IAAI,EAA0B,OAAO,EAAE,iBAAiB,CAAC,CAAC;YAC1D,uBAAA,IAAI,oEAAmB,MAAvB,IAAI,EAAoB,uBAAA,IAAI,iCAAW,CAAC,CAAC;YAEzC,OAAO,uBAAA,IAAI,+EAA8B,MAAlC,IAAI,EAA+B,iBAAiB,CAAC,CAAC;QAC/D,CAAC;KAAA;CA+TF;AA/YD,wCA+YC;6NA5TG,OAAmC,EACnC,iBAAuC;;IAEvC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAChC,MAAM,gBAAgB,GAA4C,EAAE,CAAC;IAErE,KAAK,MAAM,gBAAgB,IAAI,iBAAiB,EAAE;QAChD,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,gBAAgB,CAAC;QAE3D,IAAI,aAAa,EAAE;YACjB,SAAS;SACV;QAED,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE;YAC5D,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;YACjC,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;YACjC,IAAI,kBAAkB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAC;YAEnE,IAAI,kBAAkB,EAAE;gBACtB,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAC5C,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,CACvC,CAAC;aACH;YAED,gBAAgB,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC;SACjD;KACF;IAED,MAAM,YAAY,GAAG,uBAAA,IAAI,sEAAqB,MAAzB,IAAI,EAAsB,IAAI,CAAC,CAAC;IAErD,MAAM,qBAAqB,GACzB,MAAA,MAAA,MAAA,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,0CAAG,KAAK,CAAC,0CAAG,YAAY,CAAC,0CAAE,aAAa,CAAC;IAEjE,MAAM,aAAa,mCACd,qBAAqB,GACrB,gBAAgB,CACpB,CAAC;IAEF,MAAM,wBAAwB,GAAG,uBAAA,IAAI,wEAAuB,MAA3B,IAAI,CAAyB,CAAC;IAE/D,uBAAA,IAAI,8DAAa,MAAjB,IAAI,EAAc,KAAK,EAAE,IAAI,EAAE,EAAE,aAAa,EAAE,wBAAwB,EAAE,CAAC,CAAC;AAC9E,CAAC,iFAEkB,SAAyB;IAC1C,MAAM,cAAc,qBAAQ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAE,CAAC;IAErD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,MAAM,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;QAEhD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YAChD,cAAc,CAAC,QAAQ,CAAC,GAAG;gBACzB,KAAK,EAAE,YAAY,CAAC,QAAQ,CAAC;aAC9B,CAAC;SACH;KACF;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,WAAW,GAAG,cAAc,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC,uGAGC,iBAAuC;IAEvC,OAAO,iBAAiB,CAAC,MAAM,CAC7B,CAAC,GAA8B,EAAE,gBAAgB,EAAE,EAAE;QACnD,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAAC;QAErC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YAC3C,MAAM,EAAE,aAAa,EAAE,mBAAmB,EAAE,KAAK,EAAE,WAAW,EAAE,GAC9D,OAAO,CAAC,QAAQ,CAAC,CAAC;YAEpB,IAAI,aAAa,GAAG,WAAW;gBAC7B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,mBAAmB,aAAnB,mBAAmB,cAAnB,mBAAmB,GAAI,EAAE,CAAC;YAE9B,IAAI,aAAa,EAAE;gBACjB,aAAa,GAAG,aAAa,CAAC,MAAM,CAClC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,CACvC,CAAC;aACH;YAED,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG;gBACtB,aAAa;gBACb,KAAK,EAAE,WAAW;aACnB,CAAC;SACH;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,OAAO,EAAE,EAAE,EAAE,CAChB,CAAC;AACJ,CAAC,qFAGC,OAAmC,EACnC,OAAe,EACf,QAAsB;;;QAEtB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC;QAC/D,MAAM,kBAAkB,GAAG,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,QAAQ,EAAE,IAAI,CAAC,CAAC;QAE9D,MAAM,iBAAiB,GACrB,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CACtC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACtC,mCAAI,kBAAkB,CAAC;QAE1B,IAAI,kBAAkB,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE;YACnD,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,eAAe,GAAwB;YAC3C,OAAO;YACP,KAAK;YACL,IAAI;YACJ,SAAS,EAAE,kBAAkB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS;SAC9D,CAAC;QAEF,IAAI,aAAkC,CAAC;QACvC,IAAI,QAAwC,CAAC;QAE7C,IAAI;YACF,QAAQ,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;YAC5D,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC;SAChC;QAAC,OAAO,KAAK,EAAE;YACd,aAAa,GAAG,KAAK,CAAC;SACvB;QAED,IAAI,OAAO,GAAG,EAAE,CAAC;QAEjB,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,EAAE;YACrB,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,CAC5C,CAAC,GAAkC,EAAE,QAAQ,EAAE,EAAE;gBAC/C,IAAI,CAAC,kBAAkB,IAAI,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;oBAChE,GAAG,CAAC,QAAQ,CAAC,GAAI,QAA+B,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;iBACpE;gBAED,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAAE,CACH,CAAC;SACH;QAED,IAAI,aAAa,EAAE;YACjB,OAAO,GAAG,kBAAkB,CAAC,MAAM,CACjC,CAAC,GAAkC,EAAE,QAAQ,EAAE,EAAE;gBAC/C,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;gBAC5D,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAAE,CACH,CAAC;SACH;QAED,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;;sEAG9B,KAAa,EAAE,IAAc,EAAE,IAAwB;IAClE,MAAM,YAAY,GAAG,uBAAA,IAAI,sEAAqB,MAAzB,IAAI,EAAsB,IAAI,CAAC,CAAC;IAErD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;;QACpB,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5C,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;QAEhC,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAClD,WAAW,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC;QAEtC,MAAM,YAAY,GAAG,MAAA,gBAAgB,CAAC,YAAY,CAAC,mCAAI;YACrD,aAAa,EAAE,EAAE;YACjB,wBAAwB,EAAE,IAAI;YAC9B,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,IAAI;SACf,CAAC;QAEF,MAAM,YAAY,mCAAQ,YAAY,GAAK,IAAI,CAAE,CAAC;QAElD,gBAAgB,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC;IAChD,CAAC,CAAC,CAAC;AACL,CAAC,qFAEoB,IAAc;IACjC,QAAQ,IAAI,EAAE;QACZ,OAAO,CAAC,CAAC;YACP,OAAO,uBAAA,IAAI,kCAAY,MAAhB,IAAI,CAAc,CAAC;SAC3B;KACF;AACH,CAAC;IAGC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AACvC,CAAC,2FAEuB,OAAuB;IAC7C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAChD,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,uBAAA,IAAI,gEAAe,MAAnB,IAAI,EAAgB,KAAK,EAAE,aAAa,CAAC,CAAC;IAC1C,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,IAAI,EAAE,aAAa,CAAC,CAAC;IACxC,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,IAAI,EAAE,aAAa,CAAC,CAAC;IACxC,uBAAA,IAAI,mEAAkB,MAAtB,IAAI,EAAmB,QAAQ,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAEtD,IAAI,aAAa,CAAC,MAAM,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;KAC1C;AACH,CAAC,mHAEmC,OAAmC;IACrE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAC3C,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,uBAAA,IAAI,gEAAe,MAAnB,IAAI,EAAgB,KAAK,EAAE,aAAa,CAAC,CAAC;IAC1C,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,IAAI,EAAE,aAAa,CAAC,CAAC;IACxC,uBAAA,IAAI,oEAAmB,MAAvB,IAAI,EAAoB,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACxD,uBAAA,IAAI,6EAA4B,MAAhC,IAAI,EAA6B,IAAI,EAAE,aAAa,CAAC,CAAC;IAEtD,IAAI,aAAa,CAAC,MAAM,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;KAC1C;AACH,CAAC,yEAEc,KAAa,EAAE,aAAuB;IACnD,IAAI,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,CAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC/C,aAAa,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;KAClE;AACH,CAAC,uEAEa,IAAc,EAAE,aAAuB;IACnD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QAC3C,aAAa,CAAC,IAAI,CAChB,4CAA4C,MAAM,CAAC,MAAM,CACvD,gBAAQ,CACT,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;KACH;AACH,CAAC,uEAEa,IAAY,EAAE,aAAuB;IACjD,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAA,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC7C,aAAa,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;KACjE;AACH,CAAC,iFAGC,SAA+B,EAC/B,IAAc,EACd,aAAuB;IAEvB,IAAI,CAAC,SAAS,EAAE;QACd,OAAO;KACR;IAED,MAAM,YAAY,GAAG,uBAAA,IAAI,kEAAiB,MAArB,IAAI,EAAkB,IAAI,CAAC,CAAC;IACjD,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAE5B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACpC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChC,SAAS;SACV;KACF;IAED,IAAI,gBAAgB,CAAC,MAAM,EAAE;QAC3B,aAAa,CAAC,IAAI,CAChB,gCAAgC,IAAI,MAAM,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACxE,CAAC;KACH;AACH,CAAC,+EAGC,QAA4B,EAC5B,IAAc,EACd,aAAuB;IAEvB,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC/C,OAAO;KACR;IAED,MAAM,YAAY,GAAG,uBAAA,IAAI,kEAAiB,MAArB,IAAI,EAAkB,IAAI,CAAC,CAAC;IAEjD,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;QACpD,aAAa,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QACpE,OAAO;KACR;IAED,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACpC,aAAa,CAAC,IAAI,CAAC,+BAA+B,IAAI,MAAM,QAAQ,EAAE,CAAC,CAAC;KACzE;AACH,CAAC,mGAE2B,IAAc,EAAE,aAAuB;IACjE,MAAM,YAAY,GAAG,uBAAA,IAAI,kEAAiB,MAArB,IAAI,EAAkB,IAAI,CAAC,CAAC;IAEjD,MAAM,kBAAkB,GAAG,YAAY,CAAC,MAAM,CAC5C,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,KAAK,CAC9D,CAAC;IAEF,IAAI,kBAAkB,CAAC,MAAM,EAAE;QAC7B,aAAa,CAAC,IAAI,CAChB,wCAAwC,IAAI,MAAM,kBAAkB,CAAC,IAAI,CACvE,IAAI,CACL,EAAE,CACJ,CAAC;KACH;AACH,CAAC,6EAEgB,IAAc;IAC7B,OAAO,CACL,uBAAA,IAAI,iCAAW;QACb,0BAA0B;SACzB,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,QAAQ,EAAE,IAAI,CAAC,CAAC;SACrD,IAAI,EAAE,CACV,CAAC;AACJ,CAAC,uEAEa,QAAsB,EAAE,IAAc;IAClD,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAChD,CAAC","sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseControllerV2 } from '@metamask/base-controller';\nimport type { Patch } from 'immer';\n\nimport type {\n  NameProvider,\n  NameProviderRequest,\n  NameProviderResult,\n} from './types';\nimport { NameType } from './types';\n\nconst controllerName = 'NameController';\n\nconst stateMetadata = {\n  names: { persist: true, anonymous: false },\n  nameSources: { persist: true, anonymous: false },\n};\n\nconst getDefaultState = () => ({\n  names: {\n    [NameType.ETHEREUM_ADDRESS]: {},\n  },\n  nameSources: {},\n});\n\nexport type NameEntry = {\n  name: string | null;\n  sourceId: string | null;\n  proposedNames: Record<string, string[] | null>;\n  proposedNamesLastUpdated: number | null;\n};\n\nexport type SourceEntry = {\n  label: string;\n};\n\nexport type NameControllerState = {\n  // Type > Value > Variation > Entry\n  names: Record<NameType, Record<string, Record<string, NameEntry>>>;\n  nameSources: Record<string, SourceEntry>;\n};\n\nexport type GetNameState = {\n  type: `${typeof controllerName}:getState`;\n  handler: () => NameControllerState;\n};\n\nexport type NameStateChange = {\n  type: `${typeof controllerName}:stateChange`;\n  payload: [NameControllerState, Patch[]];\n};\n\nexport type NameControllerActions = GetNameState;\n\nexport type NameControllerEvents = NameStateChange;\n\nexport type NameControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  NameControllerActions,\n  NameControllerEvents,\n  never,\n  never\n>;\n\nexport type NameControllerOptions = {\n  getChainId: () => string;\n  messenger: NameControllerMessenger;\n  providers: NameProvider[];\n  state?: Partial<NameControllerState>;\n};\n\nexport type UpdateProposedNamesRequest = {\n  value: string;\n  type: NameType;\n  sourceIds?: string[];\n};\n\nexport type UpdateProposedNamesResult = {\n  results: Record<string, { proposedNames?: string[]; error?: unknown }>;\n};\n\nexport type SetNameRequest = {\n  value: string;\n  type: NameType;\n  name: string;\n  sourceId?: string;\n};\n\n/**\n * Controller for storing and deriving names for values such as Ethereum addresses.\n */\nexport class NameController extends BaseControllerV2<\n  typeof controllerName,\n  NameControllerState,\n  NameControllerMessenger\n> {\n  #getChainId: () => string;\n\n  #providers: NameProvider[];\n\n  /**\n   * Construct a Name controller.\n   *\n   * @param options - Controller options.\n   * @param options.getChainId - Callback that returns the chain ID of the current network.\n   * @param options.messenger - Restricted controller messenger for the name controller.\n   * @param options.providers - Array of name provider instances to propose names.\n   * @param options.state - Initial state to set on the controller.\n   */\n  constructor({\n    getChainId,\n    messenger,\n    providers,\n    state,\n  }: NameControllerOptions) {\n    super({\n      name: controllerName,\n      metadata: stateMetadata,\n      messenger,\n      state: { ...getDefaultState(), ...state },\n    });\n\n    this.#getChainId = getChainId;\n    this.#providers = providers;\n  }\n\n  /**\n   * Set the user specified name for a value.\n   *\n   * @param request - Request object.\n   * @param request.name - Name to set.\n   * @param request.sourceId - Optional ID of the source of the proposed name.\n   * @param request.type - Type of value to set the name for.\n   * @param request.value - Value to set the name for.\n   */\n  setName(request: SetNameRequest) {\n    this.#validateSetNameRequest(request);\n\n    const { value, type, name, sourceId } = request;\n\n    this.#updateEntry(value, type, { name, sourceId: sourceId ?? null });\n  }\n\n  /**\n   * Generate the proposed names for a value using the name providers and store them in the state.\n   *\n   * @param request - Request object.\n   * @param request.value - Value to update the proposed names for.\n   * @param request.type - Type of value to update the proposed names for.\n   * @param request.sourceIds - Optional array of source IDs to limit which sources are used by the providers. If not provided, all sources in all providers will be used.\n   * @returns The updated proposed names for the value.\n   */\n  async updateProposedNames(\n    request: UpdateProposedNamesRequest,\n  ): Promise<UpdateProposedNamesResult> {\n    this.#validateUpdateProposedNamesRequest(request);\n\n    const chainId = this.#getChainId();\n\n    const providerResponses = (\n      await Promise.all(\n        this.#providers.map((provider) =>\n          this.#getProviderResponse(request, chainId, provider),\n        ),\n      )\n    ).filter((response) => Boolean(response)) as NameProviderResult[];\n\n    this.#updateProposedNameState(request, providerResponses);\n    this.#updateSourceState(this.#providers);\n\n    return this.#getUpdateProposedNamesResult(providerResponses);\n  }\n\n  #updateProposedNameState(\n    request: UpdateProposedNamesRequest,\n    providerResponses: NameProviderResult[],\n  ) {\n    const { value, type } = request;\n    const newProposedNames: { [sourceId: string]: string[] | null } = {};\n\n    for (const providerResponse of providerResponses) {\n      const { results, error: responseError } = providerResponse;\n\n      if (responseError) {\n        continue;\n      }\n\n      for (const sourceId of Object.keys(providerResponse.results)) {\n        const result = results[sourceId];\n        const { proposedNames } = result;\n        let finalProposedNames = result.error ? null : proposedNames ?? [];\n\n        if (finalProposedNames) {\n          finalProposedNames = finalProposedNames.filter(\n            (proposedName) => proposedName?.length,\n          );\n        }\n\n        newProposedNames[sourceId] = finalProposedNames;\n      }\n    }\n\n    const variationKey = this.#getTypeVariationKey(type);\n\n    const existingProposedNames =\n      this.state.names[type]?.[value]?.[variationKey]?.proposedNames;\n\n    const proposedNames = {\n      ...existingProposedNames,\n      ...newProposedNames,\n    };\n\n    const proposedNamesLastUpdated = this.#getCurrentTimeSeconds();\n\n    this.#updateEntry(value, type, { proposedNames, proposedNamesLastUpdated });\n  }\n\n  #updateSourceState(providers: NameProvider[]) {\n    const newNameSources = { ...this.state.nameSources };\n\n    for (const provider of providers) {\n      const { sourceLabels } = provider.getMetadata();\n\n      for (const sourceId of Object.keys(sourceLabels)) {\n        newNameSources[sourceId] = {\n          label: sourceLabels[sourceId],\n        };\n      }\n    }\n\n    this.update((state) => {\n      state.nameSources = newNameSources;\n    });\n  }\n\n  #getUpdateProposedNamesResult(\n    providerResponses: NameProviderResult[],\n  ): UpdateProposedNamesResult {\n    return providerResponses.reduce(\n      (acc: UpdateProposedNamesResult, providerResponse) => {\n        const { results } = providerResponse;\n\n        for (const sourceId of Object.keys(results)) {\n          const { proposedNames: resultProposedNames, error: resultError } =\n            results[sourceId];\n\n          let proposedNames = resultError\n            ? undefined\n            : resultProposedNames ?? [];\n\n          if (proposedNames) {\n            proposedNames = proposedNames.filter(\n              (proposedName) => proposedName?.length,\n            );\n          }\n\n          acc.results[sourceId] = {\n            proposedNames,\n            error: resultError,\n          };\n        }\n\n        return acc;\n      },\n      { results: {} },\n    );\n  }\n\n  async #getProviderResponse(\n    request: UpdateProposedNamesRequest,\n    chainId: string,\n    provider: NameProvider,\n  ): Promise<NameProviderResult | undefined> {\n    const { value, type, sourceIds: requestedSourceIds } = request;\n    const supportedSourceIds = this.#getSourceIds(provider, type);\n\n    const matchingSourceIds =\n      requestedSourceIds?.filter((sourceId) =>\n        supportedSourceIds.includes(sourceId),\n      ) ?? supportedSourceIds;\n\n    if (requestedSourceIds && !matchingSourceIds.length) {\n      return undefined;\n    }\n\n    const providerRequest: NameProviderRequest = {\n      chainId,\n      value,\n      type,\n      sourceIds: requestedSourceIds ? matchingSourceIds : undefined,\n    };\n\n    let responseError: unknown | undefined;\n    let response: NameProviderResult | undefined;\n\n    try {\n      response = await provider.getProposedNames(providerRequest);\n      responseError = response.error;\n    } catch (error) {\n      responseError = error;\n    }\n\n    let results = {};\n\n    if (response?.results) {\n      results = Object.keys(response.results).reduce(\n        (acc: NameProviderResult['results'], sourceId) => {\n          if (!requestedSourceIds || requestedSourceIds.includes(sourceId)) {\n            acc[sourceId] = (response as NameProviderResult).results[sourceId];\n          }\n\n          return acc;\n        },\n        {},\n      );\n    }\n\n    if (responseError) {\n      results = supportedSourceIds.reduce(\n        (acc: NameProviderResult['results'], sourceId) => {\n          acc[sourceId] = { proposedNames: [], error: responseError };\n          return acc;\n        },\n        {},\n      );\n    }\n\n    return { results, error: responseError };\n  }\n\n  #updateEntry(value: string, type: NameType, data: Partial<NameEntry>) {\n    const variationKey = this.#getTypeVariationKey(type);\n\n    this.update((state) => {\n      const typeEntries = state.names[type] || {};\n      state.names[type] = typeEntries;\n\n      const variationEntries = typeEntries[value] || {};\n      typeEntries[value] = variationEntries;\n\n      const currentEntry = variationEntries[variationKey] ?? {\n        proposedNames: {},\n        proposedNamesLastUpdated: null,\n        name: null,\n        sourceId: null,\n      };\n\n      const updatedEntry = { ...currentEntry, ...data };\n\n      variationEntries[variationKey] = updatedEntry;\n    });\n  }\n\n  #getTypeVariationKey(type: NameType): string {\n    switch (type) {\n      default: {\n        return this.#getChainId();\n      }\n    }\n  }\n\n  #getCurrentTimeSeconds(): number {\n    return Math.round(Date.now() / 1000);\n  }\n\n  #validateSetNameRequest(request: SetNameRequest) {\n    const { name, value, type, sourceId } = request;\n    const errorMessages: string[] = [];\n\n    this.#validateValue(value, errorMessages);\n    this.#validateType(type, errorMessages);\n    this.#validateName(name, errorMessages);\n    this.#validateSourceId(sourceId, type, errorMessages);\n\n    if (errorMessages.length) {\n      throw new Error(errorMessages.join(' '));\n    }\n  }\n\n  #validateUpdateProposedNamesRequest(request: UpdateProposedNamesRequest) {\n    const { value, type, sourceIds } = request;\n    const errorMessages: string[] = [];\n\n    this.#validateValue(value, errorMessages);\n    this.#validateType(type, errorMessages);\n    this.#validateSourceIds(sourceIds, type, errorMessages);\n    this.#validateDuplicateSourceIds(type, errorMessages);\n\n    if (errorMessages.length) {\n      throw new Error(errorMessages.join(' '));\n    }\n  }\n\n  #validateValue(value: string, errorMessages: string[]) {\n    if (!value?.length || typeof value !== 'string') {\n      errorMessages.push('Must specify a non-empty string for value.');\n    }\n  }\n\n  #validateType(type: NameType, errorMessages: string[]) {\n    if (!Object.values(NameType).includes(type)) {\n      errorMessages.push(\n        `Must specify one of the following types: ${Object.values(\n          NameType,\n        ).join(', ')}`,\n      );\n    }\n  }\n\n  #validateName(name: string, errorMessages: string[]) {\n    if (!name?.length || typeof name !== 'string') {\n      errorMessages.push('Must specify a non-empty string for name.');\n    }\n  }\n\n  #validateSourceIds(\n    sourceIds: string[] | undefined,\n    type: NameType,\n    errorMessages: string[],\n  ) {\n    if (!sourceIds) {\n      return;\n    }\n\n    const allSourceIds = this.#getAllSourceIds(type);\n    const missingSourceIds = [];\n\n    for (const sourceId of sourceIds) {\n      if (!allSourceIds.includes(sourceId)) {\n        missingSourceIds.push(sourceId);\n        continue;\n      }\n    }\n\n    if (missingSourceIds.length) {\n      errorMessages.push(\n        `Unknown source IDs for type '${type}': ${missingSourceIds.join(', ')}`,\n      );\n    }\n  }\n\n  #validateSourceId(\n    sourceId: string | undefined,\n    type: NameType,\n    errorMessages: string[],\n  ) {\n    if (sourceId === null || sourceId === undefined) {\n      return;\n    }\n\n    const allSourceIds = this.#getAllSourceIds(type);\n\n    if (!sourceId.length || typeof sourceId !== 'string') {\n      errorMessages.push('Must specify a non-empty string for sourceId.');\n      return;\n    }\n\n    if (!allSourceIds.includes(sourceId)) {\n      errorMessages.push(`Unknown source ID for type '${type}': ${sourceId}`);\n    }\n  }\n\n  #validateDuplicateSourceIds(type: NameType, errorMessages: string[]) {\n    const allSourceIds = this.#getAllSourceIds(type);\n\n    const duplicateSourceIds = allSourceIds.filter(\n      (sourceId, index) => allSourceIds.indexOf(sourceId) !== index,\n    );\n\n    if (duplicateSourceIds.length) {\n      errorMessages.push(\n        `Duplicate source IDs found for type '${type}': ${duplicateSourceIds.join(\n          ', ',\n        )}`,\n      );\n    }\n  }\n\n  #getAllSourceIds(type: NameType): string[] {\n    return (\n      this.#providers\n        /* istanbul ignore next */\n        .map((provider) => this.#getSourceIds(provider, type))\n        .flat()\n    );\n  }\n\n  #getSourceIds(provider: NameProvider, type: NameType): string[] {\n    return provider.getMetadata().sourceIds[type];\n  }\n}\n"]}

package/dist/constants.d.ts

@@ -0,0 +1,100 @@
+export declare const CHAIN_IDS: {
+    readonly MAINNET: "0x1";
+    readonly GOERLI: "0x5";
+    readonly BSC: "0x38";
+    readonly BSC_TESTNET: "0x61";
+    readonly OPTIMISM: "0xa";
+    readonly OPTIMISM_TESTNET: "0x1a4";
+    readonly POLYGON: "0x89";
+    readonly POLYGON_TESTNET: "0x13881";
+    readonly AVALANCHE: "0xa86a";
+    readonly AVALANCHE_TESTNET: "0xa869";
+    readonly FANTOM: "0xfa";
+    readonly FANTOM_TESTNET: "0xfa2";
+    readonly SEPOLIA: "0xaa36a7";
+    readonly LINEA_GOERLI: "0xe704";
+    readonly LINEA_MAINNET: "0xe708";
+    readonly MOONBEAM: "0x504";
+    readonly MOONBEAM_TESTNET: "0x507";
+    readonly MOONRIVER: "0x505";
+    readonly GNOSIS: "0x64";
+};
+export declare const ETHERSCAN_SUPPORTED_NETWORKS: {
+    "0x5": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x1": {
+        domain: string;
+        subdomain: string;
+    };
+    "0xaa36a7": {
+        domain: string;
+        subdomain: string;
+    };
+    "0xe704": {
+        domain: string;
+        subdomain: string;
+    };
+    "0xe708": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x38": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x61": {
+        domain: string;
+        subdomain: string;
+    };
+    "0xa": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x1a4": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x89": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x13881": {
+        domain: string;
+        subdomain: string;
+    };
+    "0xa86a": {
+        domain: string;
+        subdomain: string;
+    };
+    "0xa869": {
+        domain: string;
+        subdomain: string;
+    };
+    "0xfa": {
+        domain: string;
+        subdomain: string;
+    };
+    "0xfa2": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x504": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x507": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x505": {
+        domain: string;
+        subdomain: string;
+    };
+    "0x64": {
+        domain: string;
+        subdomain: string;
+    };
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;CAoBZ,CAAC;AAKX,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6ExC,CAAC"}