@teqfw/di 0.12.1 → 0.20.1

package/src/Shared/Resolver/FilepathNs.mjs

@@ -1,51 +0,0 @@
-// MODULE'S IMPORT
-import IdParser from '../IdParser.mjs';
-
-// MODULE'S VARS
-const $parser = new IdParser();
-
-/**
- * Map codebase file path namespaces to files/URLs.
- */
-export default class TeqFw_Di_Shared_Resolver_FilepathNs {
-    /** @type {Object.<string, TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload>} */
-    packages = {}
-
-    /**
-     * Register 'package to sources root' mapping.
-     *
-     * @param {TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload} details namespace resolving details
-     */
-    addNamespaceRoot(details) {
-        this.packages[details.ns] = details;
-    }
-
-    /**
-     * List all registered packages with resolving details.
-     *
-     * @returns {Object.<string, TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload>}
-     */
-    list() {
-        return this.packages;
-    }
-
-    /**
-     * Resolve module id to module source path.
-     * @param {string} moduleId '@vendor/package!path/to/module'
-     * @returns {string} './@vendor/package/dist/path/to/module.mjs'
-     */
-    resolveModuleId(moduleId) {
-        let result;
-        /** @type {TeqFw_Di_Shared_IdParser_Dto} */
-        const parsed = $parser.parse(moduleId);
-        const pkg = parsed.namePackage;
-        if (this.packages[pkg]) {
-            /** @type {TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload} */
-            const details = this.packages[pkg];
-            result = `${details.path}/${parsed.nameModule}.${details.ext}`;
-        } else {
-            throw new Error(`Cannot resolve path for id '${moduleId}'.`);
-        }
-        return result;
-    }
-}

package/src/Shared/Resolver/LogicalNs.mjs

@@ -1,136 +0,0 @@
-/**
- * Tree-like structure of namespaces registry entry.
- *
- * @typedef {Object<string, NamespaceDetails|TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload>} NamespaceDetails
- */
-
-// MODULE'S VARS
-/**
- * Namespace parts separator.
- *
- * @type {string}
- */
-const NSS = '_';
-/**
- * Key to save sources data in namespaces registry.
- *
- * @type {string}
- */
-const KEY_DATA = '.data';
-
-// MODULE'S CLASSES
-/**
- * Map codebase logical namespaces to files/URLs.
- */
-export default class TeqFw_Di_Shared_Resolver_LogicalNs {
-    /**
-     * Registry for logical namespaces. Tree-like structure to save root paths (relative or absolute) to sources
-     * by namespaces.
-     *
-     * TeqFw_Prj_App => ./path/to/app/files
-     * TeqFw_Prj_App_Mod => ./another/path/to/mod/files
-     * TeqFw_Prj_App_Mod_Rewrite => ./rewrite/path/to/part/of/mod/files
-     *
-     * @type {Object<string, NamespaceDetails>}
-     * @private
-     */
-    namespaces = {};
-
-    /**
-     * Register sources path mapping details for namespace.
-     *
-     * @param {TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload} details namespace resolving details
-     */
-    addNamespaceRoot(details) {
-        const spaces = details.ns.split(NSS);
-        let pointer = this.namespaces;
-        for (const one of spaces) {
-            if (!pointer[one]) {
-                pointer[one] = {};
-                pointer = pointer[one];
-            } else {
-                pointer = pointer[one];
-            }
-        }
-        // add source folder to the namespaces map
-        pointer[KEY_DATA] = details;
-    }
-
-    /**
-     * List all namespaces with resolving details.
-     *
-     * @returns {Object.<string, TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload>}
-     */
-    list() {
-        const result = {};
-
-        /**
-         * Scan one level of mapping tree and save mapping data into results (if found) and/or dive deeper.
-
-         * @param {string} curPath
-         * @param level
-         */
-        function scanLevel(curPath, level) {
-            for (const key of Object.keys(level)) {
-                if (key === KEY_DATA) {
-                    result[curPath] = level[KEY_DATA];
-                } else {
-                    const subPath = (curPath) ? curPath + NSS + key : key;
-                    const sub = level[key];
-                    scanLevel(subPath, sub);
-                }
-            }
-        }
-
-        scanLevel('', this.namespaces);
-        return result;
-    }
-
-    /**
-     * Resolve path to module's source using `moduleId`:
-     *  - Vendor_Project_Module => './relative/path/to/vendor/Project/Module.mjs'
-     *  - Vendor_Project_Module => '/absolute/path/to/project/Module.js'
-     *  - Vendor_Project_Module => 'https://vendor.com/lib/Project/Module.js'
-     *
-     * @param {string} moduleId
-     * @returns {*}
-     */
-    resolveModuleId(moduleId) {
-        let result;
-        const parts = moduleId.split(NSS);
-        let nsExplored = ''; // explored part of the object's full name
-        let pointer = this.namespaces;
-        for (const part of parts) {
-            if (pointer[part]) {
-                pointer = pointer[part];
-                if (pointer[KEY_DATA]) {
-                    // compose path to root module of the current namespace (`index.[js|mjs]`)
-                    /** @type {TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload} */
-                    const entry = pointer[KEY_DATA];
-                    // compose path to NS default root
-                    result = `${entry.path}/../index.${entry.ext}`;
-                    if (!entry.isAbsolute) result = `./${result}`;
-                }
-            } else {
-                // compose path to requested module starting from namespace root
-                if (pointer[KEY_DATA]) {
-                    /** @type {TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload} */
-                    const entry = pointer[KEY_DATA];
-                    const nsModule = nsExplored.substring(1);
-                    const nsObject = moduleId.substring(nsModule.length + 1);
-                    const pathObject = nsObject.replace(new RegExp(NSS, 'g'), '/') + '.' + entry.ext;
-                    result = `${entry.path}/${pathObject}`;
-                    if (!entry.isAbsolute) result = `./${result}`;
-                    break;
-                }
-            }
-            nsExplored += NSS + part;
-        }
-        if (result === undefined) throw new Error(`Cannot resolve path for id '${moduleId}'.`);
-        // strip '././' from result
-        result = result.replace('././', './');
-        return result;
-    }
-
-}
-

package/src/Shared/Resolver.mjs

@@ -1,74 +0,0 @@
-// MODULE'S IMPORT
-import FilepathNs from './Resolver/FilepathNs.mjs';
-import LogicalNs from './Resolver/LogicalNs.mjs';
-
-// MODULE'S VARS
-/** @type {RegExp} expression for logical namespace IDs w/o dep. injection fraction (Ns_Module) */
-const LOGICAL_NS = /^((([A-Z])[A-Za-z0-9_]*)?)$/;
-
-// MODULE'S CLASSES
-/**
- * Map codebase namespaces to files/URLs.
- */
-export default class TeqFw_Di_Shared_Resolver {
-    /** @type {TeqFw_Di_Shared_Resolver_LogicalNs} */
-    logicalNs = new LogicalNs();
-    /** @type {TeqFw_Di_Shared_Resolver_FilepathNs} */
-    filepathNs = new FilepathNs();
-    // TODO: this is a hotfix
-    /** @type {boolean} */
-    isWindows = false;
-
-    /**
-     * Registry sources path mapping details for namespace.
-     *
-     * @param {TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload} details namespace resolving details
-     */
-    addNamespaceRoot(details) {
-        const parsed = LOGICAL_NS.exec(details.ns);
-        if (parsed) {
-            // this is logical namespace
-            this.logicalNs.addNamespaceRoot(details);
-        } else {
-            // this is file path based namespace
-            this.filepathNs.addNamespaceRoot(details);
-        }
-    }
-
-    /**
-     * Resolve path to module's source using `moduleId`:
-     *  - '@vendor/package!path/to/module' => './@vendor/package/dist/path/to/module.mjs'
-     *  - 'Vendor_Project_Module' => 'https://vendor.com/lib/Project/Module.js'
-     *
-     * @param {string} moduleId
-     * @returns {string}
-     */
-    resolveModuleId(moduleId) {
-        let result;
-        const parsed = LOGICAL_NS.exec(moduleId);
-        if (parsed) {
-            // this is logical namespace
-            result = this.logicalNs.resolveModuleId(moduleId);
-        } else {
-            // this is file path based namespace
-            result = this.filepathNs.resolveModuleId(moduleId);
-        }
-        // TODO: tmp fix for windows
-        if (this.isWindows) {
-            result = 'file://' + result.replace(/\//g, '\\');
-        }
-        return result;
-    }
-
-    /**
-     * List all namespaces with resolving details.
-     *
-     * @returns {{filepathNs: Object<string, TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload>, logicalNs: Object<string, TeqFw_Di_Shared_Api_Dto_Plugin_Desc_Autoload>}}
-     */
-    list() {
-        const filepathNs = this.filepathNs.list();
-        const logicalNs = this.logicalNs.list();
-        return {filepathNs, logicalNs};
-    }
-
-}

package/src/Shared/SpecProxy.mjs

@@ -1,110 +0,0 @@
-// MODULE'S IMPORT
-import IdParser from './IdParser.mjs';
-import ParsedId from './IdParser/Dto.mjs';
-
-// MODULE'S VARS
-const $parser = new IdParser();
-
-// MODULE'S CLASSES
-/**
- * Proxy object for constructors specification ('spec' argument in constructor) to analyze dependencies and to collect
- * required dependencies. This proxy adds constructed instances into container's `_instances` object.
- *
- * This code is too much coupled to `TeqFw_Di_Shared_Container` and extracted to separate class just for decreasing
- * of nesting levels.
- *
- * @class
- */
-export default class TeqFw_Di_Shared_SpecProxy {
-    /**
-     * @param {string} mainId ID of the constructing object ('Vendor_Module$', 'Vendor_Module$$', 'dbCfg').
-     * @param {string[]} uplineDeps All incomplete dependencies in current construction process
-     * (to prevent circular dependencies).
-     * @param {Map} containerSingletons Container level registry with created singletons (ids: 'dbCfg', 'Module$$').
-     * @param {Function} fnCreate constructing process level registry to save functions that
-     * construct main object & nested dependencies.
-     * @param {Function} fnGetObject `TeqFw_Di_Shared_Container.getObject` function to get/create required dependencies.
-     * construction process on some error (import error or circular dependency, for example).
-     * @param {Function} fnRejectUseFactory 'reject' function from 'TeqFw_Di_Shared_Container.getObject._useFactory' result.
-     * @returns {{}} Proxy object to resolve dependencies as `constructor(spec)`.
-     */
-    constructor(
-        mainId,
-        uplineDeps,
-        containerSingletons,
-        fnCreate,
-        fnGetObject,
-        fnRejectUseFactory
-    ) {
-
-        /**
-         * Resolved dependencies for currently constructing object (with `mainId`).
-         *
-         * @type {Object<string, Object>}
-         */
-        const deps = {};
-
-        return new Proxy({}, {
-            get(target, prop) {
-                // convert property name of the `spec` object in `constructor(spec)` to dependency id string.
-                const depId = String(prop);
-                if (deps[depId]) {
-                    // use dependency from local registry (it is possible on second, third, ... usage
-                    // of the `constructor` after exception on un-existing dependency)
-                    return deps[depId];
-                } else {
-                    // we have no dependency in the local cache yet
-                    // look up dependency in container's registry
-                    const parsed = $parser.parse(depId);
-                    if (
-                        (parsed.typeTarget === ParsedId.TYPE_TARGET_SINGLETON) &&
-                        containerSingletons.has(parsed.mapKey)
-                    ) {
-                        // requested dependency is an instance and is created before
-                        // save dependency to local registry & return
-                        deps[depId] = containerSingletons.get(parsed.mapKey);
-                        return deps[depId];
-                    } else if (
-                        (parsed.typeId === ParsedId.TYPE_ID_MANUAL) &&
-                        (parsed.typeTarget === ParsedId.TYPE_TARGET_SINGLETON) &&
-                        !containerSingletons.has(parsed.mapKey)
-                    ) {
-                        throw new Error(`There is no '${parsed.mapKey}' singleton in the container.`);
-                    } else {
-                        // check stack of incomplete dependencies
-                        if (parsed.nameModule) { // don't process manually inserted singletons
-                            if (uplineDeps.includes(parsed.nameModule)) {
-                                // `dep_id` is already requested to be created, so we report it as 'main'
-                                const err = new Error(`Circular dependencies (main: ${depId}; dep: ${mainId})`);
-                                fnRejectUseFactory(err);  // reject async _useFactory
-                                throw err;                  // break sync object's constructor
-                            }
-                            // ... and register new one
-                            uplineDeps.push(parsed.nameModule);
-                        }
-                        // create new required dependency for this object
-                        fnGetObject(depId, uplineDeps).then((obj) => {
-                            if (obj === undefined) throw new Error(`Cannot resolve dependency '${depId}'.`);
-                            // save created `dep_id` instance to local dependencies registry
-                            deps[depId] = obj;
-                            // remove created dependency from circular registry
-                            uplineDeps.splice(uplineDeps.indexOf(parsed.nameModule), 1);
-                            // re-call main object construction function
-                            fnCreate();
-                        }).catch(err => {
-                            // re-throw error from promise
-                            fnRejectUseFactory(err);  // reject async _useFactory
-                        });
-                    }
-                    // interrupt construction process until new dependency will be created
-                    // and new construction process will be started (see try-catch block in `fnCreate`)
-                    throw TeqFw_Di_Shared_SpecProxy.EXCEPTION_TO_STEALTH;
-                }
-            }
-        });
-    }
-}
-
-// static properties (compatible with Safari "< 14.1", "iOS < 14.5" form)
-/** Marker for construction exceptions that should be stolen. */
-TeqFw_Di_Shared_SpecProxy.EXCEPTION_TO_STEALTH = Symbol('exception_to_stealth')