Class AbstractMdmAdapter`Abstract`

Abstract Adapter for MDM Providers. Declares contracts for object CRUD, archetype specs, specifications read/write, and vendor relationships.

Hierarchy (View Summary)

Core
- AbstractMdmAdapter
  - MockMdmAdapter

Constructors

constructor

new AbstractMdmAdapter(alias?: string): AbstractMdmAdapter
Parameters
- alias: string = 'default'
Returns AbstractMdmAdapter
Overrides Core.constructor
- Defined in mdm/src/AbstractMdmAdapter.ts:23

Properties

`Protected`_alias

_alias: string = 'default'

`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

alias

get alias(): string
Returns string
- Defined in mdm/src/AbstractMdmAdapter.ts:28

`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

`Abstract`attachVendor

attachVendor(
    object: AbstractMdmObject,
    vendor: Vendor,
    vendorSku?: string,
    role?: string,
    isPrimary?: boolean,
): Promise<ObjectVendor>
Associates a Vendor entity to an MDM Object via an ObjectVendor relationship record.
Parameters
- object: AbstractMdmObject
- vendor: Vendor
- OptionalvendorSku: string
- Optionalrole: string
- OptionalisPrimary: boolean
Returns Promise<ObjectVendor>
- Defined in mdm/src/AbstractMdmAdapter.ts:65

`Abstract`createObject

createObject<T extends AbstractMdmObject>(
modelClass: MdmObjectConstructor<T>,
data: Record<string, unknown>,
): Promise<T>
Type Parameters
- T extends AbstractMdmObject
Parameters
- modelClass: MdmObjectConstructor<T>
- data: Record<string, unknown>
Returns Promise<T>
- Defined in mdm/src/AbstractMdmAdapter.ts:34

`Abstract`getArchetype

getArchetype(archetypeId: string): Promise<MdmArchetypeSpec | null>
Parameters
- archetypeId: string
Returns Promise<MdmArchetypeSpec | null>
- Defined in mdm/src/AbstractMdmAdapter.ts:33

`Abstract`getObject

getObject<T extends AbstractMdmObject>(
modelClass: MdmObjectConstructor<T>,
uid: string,
): Promise<T | null>
Type Parameters
- T extends AbstractMdmObject
Parameters
- modelClass: MdmObjectConstructor<T>
- uid: string
Returns Promise<T | null>
- Defined in mdm/src/AbstractMdmAdapter.ts:35

`Abstract`getObjectVendors

getObjectVendors(object: AbstractMdmObject): Promise<ObjectVendor[]>
Reads all ObjectVendor relationship instances attached to an MDM Object.
Parameters
- object: AbstractMdmObject
Returns Promise<ObjectVendor[]>
- Defined in mdm/src/AbstractMdmAdapter.ts:70

`Abstract`getSpecifications

getSpecifications(object: AbstractMdmObject): Promise<Specification[]>
Reads all attached Specification instances for an MDM Object.
Parameters
- object: AbstractMdmObject
Returns Promise<Specification[]>
- Defined in mdm/src/AbstractMdmAdapter.ts:50

`Abstract`getVendor

getVendor(vendorId: string): Promise<Vendor | null>
Reads a Vendor entity by identifier.
Parameters
- vendorId: string
Returns Promise<Vendor | null>
- Defined in mdm/src/AbstractMdmAdapter.ts:60

`Abstract`getVendors

getVendors(object: AbstractMdmObject): Promise<Vendor[]>
Reads all Vendor entities attached to an MDM Object.
Parameters
- object: AbstractMdmObject
Returns Promise<Vendor[]>
- Defined in mdm/src/AbstractMdmAdapter.ts:75

`Abstract`registerArchetype

registerArchetype(archetype: MdmArchetypeSpec): Promise<void>
Parameters
- archetype: MdmArchetypeSpec
Returns Promise<void>
- Defined in mdm/src/AbstractMdmAdapter.ts:32

`Abstract`saveSpecification

saveSpecification(
object: AbstractMdmObject,
spec: Specification,
): Promise<Specification>
Persists or updates an individual Specification instance for an MDM Object.
Parameters
- object: AbstractMdmObject
- spec: Specification
Returns Promise<Specification>
- Defined in mdm/src/AbstractMdmAdapter.ts:40

`Abstract`saveSpecifications

saveSpecifications(
object: AbstractMdmObject,
specs: Specification[],
): Promise<Specification[]>
Persists or updates an array of Specification instances for an MDM Object.
Parameters
- object: AbstractMdmObject
- specs: Specification[]
Returns Promise<Specification[]>
- Defined in mdm/src/AbstractMdmAdapter.ts:45

`Abstract`saveVendor

saveVendor(vendor: Vendor): Promise<Vendor>
Persists or updates a Vendor entity.
Parameters
- vendor: Vendor
Returns Promise<Vendor>
- Defined in mdm/src/AbstractMdmAdapter.ts:55

`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`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`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` `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`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`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 AbstractMdmAdapterAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AbstractMdmAdapter

Properties

Protected_alias

Static ReadonlyclassRegistry

Static Readonlylogger

Static ReadonlylogLevel

Static Readonlyme

Static Readonlystorage

Static ReadonlystoragePrefix

Accessors

alias

Returns string

StaticuserClass

Returns any

Parameters

Returns void

Methods

AbstractattachVendor

Parameters

Returns Promise<ObjectVendor>

AbstractcreateObject

Type Parameters

Parameters

Returns Promise<T>

AbstractgetArchetype

Parameters

Returns Promise<MdmArchetypeSpec | null>

AbstractgetObject

Type Parameters

Parameters

Returns Promise<T | null>

AbstractgetObjectVendors

Parameters

Returns Promise<ObjectVendor[]>

AbstractgetSpecifications

Parameters

Returns Promise<Specification[]>

AbstractgetVendor

Parameters

Returns Promise<Vendor | null>

AbstractgetVendors

Parameters

Returns Promise<Vendor[]>

AbstractregisterArchetype

Parameters

Returns Promise<void>

AbstractsaveSpecification

Parameters

Returns Promise<Specification>

AbstractsaveSpecifications

Parameters

Returns Promise<Specification[]>

AbstractsaveVendor

Parameters

Returns Promise<Vendor>

StaticaddClass

Parameters

Returns void

StaticaddConfig

Parameters

Returns Promise<void>

StaticaddLogger

Parameters

Returns any

Staticdebug

Parameters

Returns void

Staticdefinition

Parameters

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

Class AbstractMdmAdapter`Abstract`

`Protected`_alias

`Static` `Readonly`classRegistry

`Static` `Readonly`logger

`Static` `Readonly`logLevel

`Static` `Readonly`me

`Static` `Readonly`storage

`Static` `Readonly`storagePrefix

`Static`userClass

`Abstract`attachVendor

`Abstract`createObject

`Abstract`getArchetype

`Abstract`getObject

`Abstract`getObjectVendors

`Abstract`getSpecifications

`Abstract`getVendor

`Abstract`getVendors

`Abstract`registerArchetype

`Abstract`saveSpecification

`Abstract`saveSpecifications

`Abstract`saveVendor

`Static`addClass

`Static`addConfig

`Static`addLogger

`Static`debug

`Static`definition

`Static`error

`Static` `Readonly`execPromise

`Static`getClass

`Static`getConfig

`Static` `Readonly`getSystemCommandPath

`Static`info

`Static`log

`Static`setLogLevel

`Static`sleep

`Static` `Readonly`timestamp

`Static`trace

`Static`warn