Class XtResolverService

constructor

• new XtResolverService(): XtResolverService

  Returns XtResolverService

listComponents

listPlugins

pluginRegistry

resolver

typeResolver

findBestComponent

• findBestComponent<T>(
      baseContext: XtContext<T>,
      subName?: string,
  ): XtResolvedComponent

  Finds the best matching component for the given context and optional sub-name.

  Type Parameters

  • T

  Parameters

  • baseContext: XtContext<T>

    The context to resolve against

  • OptionalsubName: string

    Optional sub-name for nested resolution

  Returns XtResolvedComponent

  The resolved component descriptor

findComponentInfo

• findComponentInfo<T>(type: Type<XtComponent<T>>): XtResolvedComponent | null

  Finds the resolved component info for a given component type, returning null if not found.

  Type Parameters

  • T

  Parameters

  • type: Type<XtComponent<T>>

    The component type class

  Returns XtResolvedComponent | null

  The resolved component descriptor or null

findPossibleReferences

• findPossibleReferences<T, U>(context: XtContext<T>): Observable<U[]>

  Calculates the values that can be referenced by the reference & value of this context

  Type Parameters

  • T
  • U

  Parameters

  • context: XtContext<T>

  Returns Observable<U[]>

findSubPropertyWithType

• findSubPropertyWithType<T>(
      context: XtContext<T>,
      subPropertyType: string,
      value: T,
  ): any

  Based on the type & value of the element, find which property is on its type and returns it's value

  Type Parameters

  • T

  Parameters

  • context: XtContext<T>
  • subPropertyType: string
  • value: T

  Returns any

findTypeHandlerOf

• findTypeHandlerOf<T>(
      baseContext: XtContext<T>,
      subName?: string,
      value?: T,
  ): { handler?: XtTypeHandler<any>; typeName?: string | null }

  Finds the type handler for the given context, resolving references if necessary.

  Type Parameters

  • T

  Parameters

  • baseContext: XtContext<T>

    The context to query

  • OptionalsubName: string

    Optional sub-name for nested resolution

  • Optionalvalue: T

    Optional value for handler inference

  Returns { handler?: XtTypeHandler<any>; typeName?: string | null }

  An object with the type name and its handler

findTypeOf

• findTypeOf<T>(
      baseContext: XtContext<T>,
      subName?: string,
      value?: T,
  ): string | null | undefined

  Resolves the type name for the given context and optional sub-name.

  Type Parameters

  • T

  Parameters

  • baseContext: XtContext<T>

    The context to query

  • OptionalsubName: string

    Optional sub-name for nested type resolution

  • Optionalvalue: T

    Optional value for type inference

  Returns string | null | undefined

  The type name, or null/undefined

getComponentInfo

• getComponentInfo<T>(type: Type<XtComponent<T>>): XtResolvedComponent

  Gets the resolved component info for a given component type.

  Type Parameters

  • T

  Parameters

  • type: Type<XtComponent<T>>

    The component type class

  Returns XtResolvedComponent

  The resolved component descriptor

listSubNamesOf

• listSubNamesOf<T>(baseContext: XtContext<T>, value?: T): string[]

  Lists the sub-names defined by the type of the given context.

  Type Parameters

  • T

  Parameters

  • baseContext: XtContext<T>

    The context to query

  • Optionalvalue: T

    Optional value for type inference

  Returns string[]

  An array of sub-name strings

listSubNamesOfType

• listSubNamesOfType<T>(valueType: string, value?: T): string[]

  Lists the sub-names defined by a given value type string.

  Type Parameters

  • T

  Parameters

  • valueType: string

    The type string to query

  • Optionalvalue: T

    Optional value for type inference

  Returns string[]

  An array of sub-name strings

loadPluginCss

• loadPluginCss(pluginName: string, baseUrl: string, cssUrls?: string[]): string[]

  Injects the given stylesheets in the current page, so that a plugin's styles get applied. Absolute urls (http/https/protocol-relative) are used as-is, relative ones are resolved against the plugin's base url. Already injected stylesheets are skipped.

  Parameters

  • pluginName: string

    the name of the plugin owning those styles

  • baseUrl: string

    the plugin base url, used to resolve relative css urls

  • OptionalcssUrls: string[]

    the stylesheet urls declared by the plugin

  Returns string[]

  the list of stylesheets actually injected by this call

loadPluginCssOf

• loadPluginCssOf(pluginName: string, remoteEntryUrl: string | URL): string[]

  Injects in the current page the stylesheets declared by a registered plugin, if any. Relative urls declared by the plugin are resolved against the given remoteEntry url.

  Parameters

  • pluginName: string

    the registered plugin name

  • remoteEntryUrl: string | URL

    the url the plugin has been loaded from

  Returns string[]

possibleActions

• possibleActions<T>(context: XtContext<T>, onlyVisible?: boolean): XtAction<T>[]

  Calculates all the possible actions for a given context

  Type Parameters

  • T

  Parameters

  • context: XtContext<T>
  • onlyVisible: boolean = true

  Returns XtAction<T>[]

registerPlugin

• registerPlugin(info: XtPluginInfo): void

  Registers a full plugin including its types and type handlers.

  Parameters

  • info: XtPluginInfo

    The plugin information to register

  Returns void

registerPluginModule

• registerPluginModule(
      module: { registerPlugin: (resolver: XtResolverService) => string },
      url: string | URL,
  ): string | null

  Dynamically load a register a plugin from the given url The plugin must export at least a Register entrypoint that will be called right after loading.. Any stylesheet declared by the plugin (XtPluginInfo.cssUrls) is loaded in the current page.

  Parameters

  • module: { registerPlugin: (resolver: XtResolverService) => string }
  • url: string | URL

  Returns string | null

  the registered plugin name, or null if registration failed.

registerTypes

• registerTypes(
      types: XtTypeInfo | undefined,
      handlers?: XtTypeHandlerInfo<any>[],
  ): void

  Registers type definitions and optional type handlers with the type resolver.

  Parameters

  • types: XtTypeInfo | undefined

    The type definitions to register

  • Optionalhandlers: XtTypeHandlerInfo<any>[]

    Optional type handler definitions

  Returns void

resolveMappingOf

• resolveMappingOf<U, T>(
      context: XtContext<T>,
      targetType: string,
      value?: T,
  ): MappingHelper<U, T> | undefined

  Resolves a mapping helper from the context's value type to a target type.

  Type Parameters

  • U
  • T

  Parameters

  • context: XtContext<T>

    The source context

  • targetType: string

    The target type to map to

  • Optionalvalue: T

    Optional value for handler inference

  Returns MappingHelper<U, T> | undefined

  A MappingHelper if a mapping exists, otherwise undefined

resolvePendingReferences

• resolvePendingReferences(): void

  Resolves all pending type references in the type resolver.

  Returns void

resolveReferencedValue

• resolveReferencedValue<T, U>(
      context: XtContext<T>,
      storeMgr: IStoreManager,
  ): Promise<U | U[] | null | undefined>

  Resolves the referenced value for a context that holds a type reference, using the provided store manager.

  Type Parameters

  • T
  • U

  Parameters

  • context: XtContext<T>

    The context with a reference to resolve

  • storeMgr: IStoreManager

    The store manager for entity lookup

  Returns Promise<U | U[] | null | undefined>

  The resolved referenced value(s), or null/undefined

runAction

• runAction<T>(
      context: XtContext<T>,
      actionName: string,
      storeMgr?: any,
  ): Promise<XtActionResult<any>>

  Finds the possible action with the given name for the current type, and runs it in the current value. If the action is not possible in this context, try a parent context

  Type Parameters

  • T

  Parameters

  • context: XtContext<T>
  • actionName: string
  • OptionalstoreMgr: any

  Returns Promise<XtActionResult<any>>

safeDuplicate

• safeDuplicate<T>(context: XtContext<T>, value: T): T

  Creates a duplicate of an object, using our knowledge on its type given by the context

  Type Parameters

  • T

  Parameters

  • context: XtContext<T>
  • value: T

  Returns T