Class Mdm

MDM Core Pivot Class. Manages global provider adapters, archetypes registry, and custom domain model mappings.

Hierarchy (View Summary)

Core
- Mdm

Constructors

constructor

new Mdm(): Mdm
Returns Mdm
Inherited from Core.constructor

Properties

`Static` `Readonly`classRegistry

classRegistry: { [key: string]: any } = {}

Dictionary holding registered active Quatrain models/components.

`Static` `Readonly`logger

logger: AbstractLoggerAdapter = ...

Active logger instance for the Core domain.

`Static` `Readonly`logLevel

logLevel: DEBUG = LogLevel.DEBUG

System-wide base log verbosity.

`Static` `Readonly`me

me: string = ...

Identifying namespace for this core component.

`Static` `Readonly`storage

storage: typeof NodePersist = persist

Persistent key-value storage engine reference.

`Static` `Readonly`storagePrefix

storagePrefix: "core" = 'core'

Context prefix string for scoped storage keys.

Accessors

`Static`userClass

get userClass(): any
Returns any
Inherited from Core.userClass
- Defined in core/src/Core.ts:181
set userClass(cls: any): void
Parameters
- cls: any
Returns void
Inherited from Core.userClass
- Defined in core/src/Core.ts:185

Methods

`Static`addAdapter

addAdapter(
    adapter: AbstractMdmAdapter,
    alias?: string,
    isDefault?: boolean,
): void
Register an MDM Provider Adapter under a given alias.
Parameters
- adapter: AbstractMdmAdapter
- alias: string = 'default'
- isDefault: boolean = false
Returns void
- Defined in mdm/src/Mdm.ts:22

`Static`addClass

addClass(name: string, obj: any): void
Maps a specific entity class to an active name so the factory reflection can locate it.
Parameters
- name: string
  Semantic registry name.
- obj: any
  Class constructor.
Returns void
Inherited from Core.addClass
- Defined in core/src/Core.ts:105

`Static`addConfig

addConfig(key: string, value: any): Promise<void>
Stores a primitive value durably in the core storage instance.
Parameters
- key: string
  Identification string.
- value: any
  Value.
Returns Promise<void>
Inherited from Core.addConfig
- Defined in core/src/Core.ts:79

`Static`addLogger

addLogger(alias?: string): any
Injects a new logger block under a specific namespace alias.
Parameters
- alias: string = ...
  The logging context name.
Returns any
Instantiated LoggerAdapter.
Inherited from Core.addLogger
- Defined in core/src/Core.ts:35

`Static`attachVendor

attachVendor(
    object: AbstractMdmObject,
    vendor: Vendor,
    vendorSku?: string,
    role?: string,
    isPrimary?: boolean,
    alias?: string,
): Promise<ObjectVendor>
Parameters
- object: AbstractMdmObject
- vendor: Vendor
- OptionalvendorSku: string
- Optionalrole: string
- OptionalisPrimary: boolean
- Optionalalias: string
Returns Promise<ObjectVendor>
- Defined in mdm/src/Mdm.ts:96

`Static`debug

debug(...message: any): void
Triggers a debug log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.debug
- Defined in core/src/Core.ts:203

`Static`definition

definition(
key: string,
): { manifest: { mandatory: boolean; type: StringConstructor } }
Deprecated: Reserved schema definition hook.
Parameters
- key: string
  The property block to generate.
Returns { manifest: { mandatory: boolean; type: StringConstructor } }
Field definitions block.
Inherited from Core.definition
- Defined in core/src/Core.ts:64

`Static`error

error(...message: any): void
Triggers an error log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.error
- Defined in core/src/Core.ts:230

`Static` `Readonly`execPromise

execPromise(command: string, args?: any[], cwd?: string): Promise<any>
Execute an external command in a promise
Parameters
- command: string
- args: any[] = []
- cwd: string = ...
Returns Promise<any>
Promise
See
- https://stackoverflow.com/questions/46289682/how-to-wait-for-child-process-spawn-execution-with-async-await
- https://dzone.com/articles/understanding-execfile-spawn-exec-and-fork-in-node
Inherited from Core.execPromise
- Defined in core/src/Core.ts:127

`Static`getAdapter

getAdapter(alias?: string): AbstractMdmAdapter
Retrieve a registered MDM Provider Adapter.
Parameters
- Optionalalias: string
Returns AbstractMdmAdapter
- Defined in mdm/src/Mdm.ts:33

`Static`getArchetype

getArchetype(archetypeId: string): MdmArchetypeSpec | undefined
Retrieve a registered Archetype Specification schema by ID.
Parameters
- archetypeId: string
Returns MdmArchetypeSpec | undefined
- Defined in mdm/src/Mdm.ts:53

`Static`getClass

getClass(name: string): any
Returns an injected class constructor by its registry identifier.
Parameters
- name: string
  The semantic name to resolve.
Returns any
Class definition.
Inherited from Core.getClass
- Defined in core/src/Core.ts:115

`Static`getConfig

getConfig(key: string): Promise<any>
Recovers a durably persisted value from the storage layer.
Parameters
- key: string
  The target identifier.
Returns Promise<any>
The recovered value.
Inherited from Core.getConfig
- Defined in core/src/Core.ts:92

`Static`getModel

getModel<T extends AbstractMdmObject>(
archetypeId: string,
): MdmObjectConstructor<T> | undefined
Retrieve a registered custom AbstractMdmObject child model class by archetype ID.
Type Parameters
- T extends AbstractMdmObject
Parameters
- archetypeId: string
Returns MdmObjectConstructor<T> | undefined
- Defined in mdm/src/Mdm.ts:68

`Static`getObjectVendors

getObjectVendors(
object: AbstractMdmObject,
alias?: string,
): Promise<ObjectVendor[]>
Parameters
- object: AbstractMdmObject
- Optionalalias: string
Returns Promise<ObjectVendor[]>
- Defined in mdm/src/Mdm.ts:107

`Static`getSpecifications

getSpecifications(
object: AbstractMdmObject,
alias?: string,
): Promise<Specification[]>
Parameters
- object: AbstractMdmObject
- Optionalalias: string
Returns Promise<Specification[]>
- Defined in mdm/src/Mdm.ts:82

`Static` `Readonly`getSystemCommandPath

getSystemCommandPath(command: string): Promise<string>
Utility lookup to find executable paths in the system using which.
Parameters
- command: string
  The executable.
Returns Promise<string>
The resolved system path.
Inherited from Core.getSystemCommandPath
- Defined in core/src/Core.ts:168

`Static`getVendor

getVendor(vendorId: string, alias?: string): Promise<Vendor | null>
Parameters
- vendorId: string
- Optionalalias: string
Returns Promise<Vendor | null>
- Defined in mdm/src/Mdm.ts:92

`Static`getVendors

getVendors(object: AbstractMdmObject, alias?: string): Promise<Vendor[]>
Parameters
- object: AbstractMdmObject
- Optionalalias: string
Returns Promise<Vendor[]>
- Defined in mdm/src/Mdm.ts:111

`Static`info

info(...message: any): void
Triggers an info log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.info
- Defined in core/src/Core.ts:221

`Static`log

log(...message: any): void
Triggers a standard log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.log
- Defined in core/src/Core.ts:194

`Static`registerArchetype

registerArchetype(archetype: MdmArchetypeSpec): void
Register an Archetype Specification schema in the central MDM registry.
Parameters
- archetype: MdmArchetypeSpec
Returns void
- Defined in mdm/src/Mdm.ts:45

`Static`registerModel

registerModel<T extends AbstractMdmObject>(
archetypeId: string,
modelClass: MdmObjectConstructor<T>,
): void
Register a custom AbstractMdmObject child model class for a given archetype ID.
Type Parameters
- T extends AbstractMdmObject
Parameters
- archetypeId: string
- modelClass: MdmObjectConstructor<T>
Returns void
- Defined in mdm/src/Mdm.ts:60

`Static`saveSpecification

saveSpecification(
    object: AbstractMdmObject,
    spec: Specification,
    alias?: string,
): Promise<Specification>
Parameters
- object: AbstractMdmObject
- spec: Specification
- Optionalalias: string
Returns Promise<Specification>
- Defined in mdm/src/Mdm.ts:74

`Static`saveSpecifications

saveSpecifications(
    object: AbstractMdmObject,
    specs: Specification[],
    alias?: string,
): Promise<Specification[]>
Parameters
- object: AbstractMdmObject
- specs: Specification[]
- Optionalalias: string
Returns Promise<Specification[]>
- Defined in mdm/src/Mdm.ts:78

`Static`saveVendor

saveVendor(vendor: Vendor, alias?: string): Promise<Vendor>
Parameters
- vendor: Vendor
- Optionalalias: string
Returns Promise<Vendor>
- Defined in mdm/src/Mdm.ts:88

`Static`setLogLevel

setLogLevel(level: LogLevel): void
Mutates the underlying verbosity constraints.
Parameters
- level: LogLevel
  Active LogLevel filter.
Returns void
Inherited from Core.setLogLevel
- Defined in core/src/Core.ts:48

`Static`sleep

sleep(seconds?: number): Promise<unknown>
Execution suspension utility blocking the event loop context.
Parameters
- seconds: number = 1
  Duration count.
Returns Promise<unknown>
The promise to await.
Inherited from Core.sleep
- Defined in core/src/Core.ts:177

`Static` `Readonly`timestamp

timestamp(): string
Returns an ISO string representing the current time.

Returns string
Inherited from Core.timestamp
- Defined in core/src/Core.ts:56

`Static`trace

trace(...message: any): void
Triggers a trace log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.trace
- Defined in core/src/Core.ts:239

`Static`warn

warn(...message: any): void
Triggers a warning log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.warn
- Defined in core/src/Core.ts:212

Class Mdm

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Mdm

Properties

Static ReadonlyclassRegistry

Static Readonlylogger

Static ReadonlylogLevel

Static Readonlyme

Static Readonlystorage

Static ReadonlystoragePrefix

Accessors

StaticuserClass

Returns any

Parameters

Returns void

Methods

StaticaddAdapter

Parameters

Returns void

StaticaddClass

Parameters

Returns void

StaticaddConfig

Parameters

Returns Promise<void>

StaticaddLogger

Parameters

Returns any

StaticattachVendor

Parameters

Returns Promise<ObjectVendor>

Staticdebug

Parameters

Returns void

Staticdefinition

Parameters

Returns { manifest: { mandatory: boolean; type: StringConstructor } }

Staticerror

Parameters

Returns void

Static ReadonlyexecPromise

Parameters

Returns Promise<any>

See

StaticgetAdapter

Parameters

Returns AbstractMdmAdapter

StaticgetArchetype

Parameters

Returns MdmArchetypeSpec | undefined

StaticgetClass

Parameters

Returns any

StaticgetConfig

Parameters

Returns Promise<any>

StaticgetModel

Type Parameters

Parameters

Returns MdmObjectConstructor<T> | undefined

StaticgetObjectVendors

Parameters

Returns Promise<ObjectVendor[]>

StaticgetSpecifications

Parameters

Returns Promise<Specification[]>

Static ReadonlygetSystemCommandPath

Parameters

Returns Promise<string>

StaticgetVendor

Parameters

Returns Promise<Vendor | null>

StaticgetVendors

`Static` `Readonly`classRegistry

`Static` `Readonly`logger

`Static` `Readonly`logLevel

`Static` `Readonly`me

`Static` `Readonly`storage

`Static` `Readonly`storagePrefix

`Static`userClass

`Static`addAdapter

`Static`addClass

`Static`addConfig

`Static`addLogger

`Static`attachVendor

`Static`debug

`Static`definition

`Static`error

`Static` `Readonly`execPromise

`Static`getAdapter

`Static`getArchetype

`Static`getClass

`Static`getConfig

`Static`getModel

`Static`getObjectVendors

`Static`getSpecifications

`Static` `Readonly`getSystemCommandPath

`Static`getVendor

`Static`getVendors

`Static`info

`Static`log

`Static`registerArchetype

`Static`registerModel

`Static`saveSpecification

`Static`saveSpecifications

`Static`saveVendor

`Static`setLogLevel

`Static`sleep

`Static` `Readonly`timestamp

`Static`trace

`Static`warn