diff --git a/README.md b/README.md index 9cb5f46..8b9ceaf 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,9 @@ import JavaScript modules - _extensions_ - that add new features and capabilities to the application. ExtendIt.js has been designed to efficiently work with -[React](https://react.dev/), for this purpose it provides a number of -reactive [hooks](). However, the library can be used without +[React](https://react.dev/), for this purpose it provides a number of reactive +[React hooks](https://react.dev/reference/react/hooks). +However, the library can be used without React too. It's only a peer dependency. # Installation @@ -104,16 +105,24 @@ export function activate(ctx: ExtensionContext) { ``` The host application registers extensions using the +[`readExtensionManifest`](https://forman.github.io/extendit/functions/core.readExtensionManifest.html) +and [`registerExtension`](https://forman.github.io/extendit/functions/core.registerExtension.html) -function: +functions: ```ts -import { registerExtension } from "@forman2/extendit"; +import { readExtensionManifest, registerExtension } from "@forman2/extendit"; export function initApp() { const extensionsUrls = getAppExtensionUrls(); extensionUrls.forEach((extensionUrl) => { - void registerExtension(extensionUrl); + readExtensionManifest(extensionUrl) + .then((manifest) => + registerExtension(manifest) + ) + .catch((error) => { + // ... + }); }); } @@ -277,7 +286,7 @@ async function getCommand(commandId: string): Promise { ``` There is also a corresponding React hook -[`useLoadCodeContribution`](https://forman.github.io/extendit/functions/react.useCodeContributions.html) +[`useLoadCodeContribution`](https://forman.github.io/extendit/functions/react.useLoadCodeContribution.html) that is used for implementing React components: ```tsx @@ -306,21 +315,6 @@ export default function CommandButton({ command }: CommandButtonProps) { We currently only have this file and the [API docs](https://forman.github.io/extendit/), sorry. -# Acknowledgements - -ExtendIt.js currently uses the awesome libraries - -* [Ajv](https://ajv.js.org/) for JSON validation (may be turned into peer dependency later) -* [memoize-one](https://github.com/alexreardon/memoize-one) for implementing state selector functions -* [zustand](https://github.com/pmndrs/zustand) for state management - -# License - -Copyright © 2023 Norman Fomferra - -Permissions are hereby granted under the terms of the MIT License: -https://opensource.org/licenses/MIT. - # Development ## Source Code @@ -377,3 +371,18 @@ stick to the following order: If we also have resource dependencies (`*.css`, `*.json`, `*.svg`, ...), we first import TypeScript source dependencies, then separated by a newline, insert resource dependencies in the same order as source dependencies. + +# Acknowledgements + +ExtendIt.js currently uses the awesome libraries + +* [Ajv](https://ajv.js.org/) for JSON validation (may be turned into peer dependency later) +* [memoize-one](https://github.com/alexreardon/memoize-one) for implementing state selector functions +* [zustand](https://github.com/pmndrs/zustand) for state management + +# License + +Copyright © 2023 Norman Fomferra + +Permissions are hereby granted under the terms of the MIT License: +https://opensource.org/licenses/MIT. diff --git a/docs/classes/util.AssertionError.html b/docs/classes/util.AssertionError.html index 72695f1..6174733 100644 --- a/docs/classes/util.AssertionError.html +++ b/docs/classes/util.AssertionError.html @@ -27,7 +27,7 @@

Hierarchy

+
  • Defined in src/framework/util/assert.ts:10
    • @@ -156,7 +156,7 @@
    message: Returns AssertionError
    +
  • Defined in src/framework/util/assert.ts:15
    • diff --git a/docs/classes/util.Disposable.html b/docs/classes/util.Disposable.html index bfe9e20..b537640 100644 --- a/docs/classes/util.Disposable.html +++ b/docs/classes/util.Disposable.html @@ -35,7 +35,7 @@

    Implements

    +
  • Defined in src/framework/util/disposable.ts:21
    • @@ -81,7 +81,7 @@

    Returns voidReturns Disposable

    +
  • Defined in src/framework/util/disposable.ts:50

    • Properties

    @@ -96,7 +96,7 @@

    Type declaration

  • Returns void

    • +
  • Defined in src/framework/util/disposable.ts:40

    • Methods

    @@ -110,7 +110,7 @@

    Returns void

    +
  • Defined in src/framework/util/disposable.ts:57

    • Static from

      @@ -135,7 +135,7 @@

      Returns

    +
  • Defined in src/framework/util/disposable.ts:32
    • diff --git a/docs/classes/util.JsonValidationError.html b/docs/classes/util.JsonValidationError.html index b51cc4d..095197a 100644 --- a/docs/classes/util.JsonValidationError.html +++ b/docs/classes/util.JsonValidationError.html @@ -27,7 +27,7 @@

    Hierarchy

    • JsonValidationError
    +
  • Defined in src/framework/util/json/validate-json.ts:15
    • @@ -67,14 +67,14 @@
    Optional Returns JsonValidationError
    +
  • Defined in src/framework/util/json/validate-json.ts:16

    • Properties

    Optional Readonly errors

    errors?: unknown[]
    +
  • Defined in src/framework/util/json/validate-json.ts:18

    • message

    message: string
    +
  • Defined in src/framework/util/expr/node.ts:208
    • @@ -67,19 +67,19 @@
    value: Returns Assign
    +
  • Defined in src/framework/util/expr/node.ts:209

    • Properties

    Readonly target

    target: NameRef | PropertyRef | IndexRef
    +
  • Defined in src/framework/util/expr/node.ts:210

    • Readonly value

    value: Node<unknown>
    +
  • Defined in src/framework/util/expr/node.ts:211

    • Methods

    @@ -100,7 +100,7 @@

    Returns unknown

    +
  • Defined in src/framework/util/expr/node.ts:216

    • toString

      @@ -113,7 +113,7 @@

      Returns string

    +
  • Defined in src/framework/util/expr/node.ts:243
    • diff --git a/docs/classes/util.expr.Node.html b/docs/classes/util.expr.Node.html index dd139d4..5080cff 100644 --- a/docs/classes/util.expr.Node.html +++ b/docs/classes/util.expr.Node.html @@ -36,7 +36,7 @@

    Hierarchy

    +
  • Defined in src/framework/util/expr/node.ts:23
    • @@ -83,7 +83,7 @@
    ctx: Returns T
    +
  • Defined in src/framework/util/expr/node.ts:28

    • Abstract toString

    +
  • Defined in src/framework/util/expr/node.ts:34
    • diff --git a/docs/classes/util.expr.Parser.html b/docs/classes/util.expr.Parser.html index 8ba6a7e..589a3c1 100644 --- a/docs/classes/util.expr.Parser.html +++ b/docs/classes/util.expr.Parser.html @@ -26,7 +26,7 @@

    Hierarchy

    • Parser
    +
  • Defined in src/framework/util/expr/parser.ts:46
    • @@ -86,29 +86,29 @@
    expression: Optional options: ParserOptions
    Optional

    Returns Parser

    +
  • Defined in src/framework/util/expr/parser.ts:59

    • Properties

    Private Readonly expression

    expression: string
    +
  • Defined in src/framework/util/expr/parser.ts:60

    • Private Optional Readonly options

    options?: ParserOptions
    +
  • Defined in src/framework/util/expr/parser.ts:61

    • Private pos

    pos: number
    +
  • Defined in src/framework/util/expr/parser.ts:48

    • Private Readonly tokens

    tokens: Token[]
    +
  • Defined in src/framework/util/expr/parser.ts:47

    • Methods

    @@ -123,7 +123,7 @@

    Parameters

    message: string

    Returns ParserError

    +
  • Defined in src/framework/util/expr/parser.ts:358

    • Private moveOn

    +
  • Defined in src/framework/util/expr/parser.ts:352

    • Private parseAdditive

    +
  • Defined in src/framework/util/expr/parser.ts:146

    • Private parseArgList

    +
  • Defined in src/framework/util/expr/parser.ts:286

    • Private parseBinaryOp

      @@ -160,7 +160,7 @@

      Parameters

      Rest ...opIds: string[]
      Rest

    Returns undefined | BinaryOp

    +
  • Defined in src/framework/util/expr/parser.ts:319

    • Private parseComparison

    +
  • Defined in src/framework/util/expr/parser.ts:118

    • Private parseConditional

    +
  • Defined in src/framework/util/expr/parser.ts:80

    • Private parseExpr

    +
  • Defined in src/framework/util/expr/parser.ts:76

    • Private parseFunctionCall

      @@ -197,7 +197,7 @@

      Parameters

      func: Node<unknown>

    Returns FunctionCall

    +
  • Defined in src/framework/util/expr/parser.ts:252

    • Private parseIn

    +
  • Defined in src/framework/util/expr/parser.ts:128

    • Private parseIndexAccess

    Returns IndexRef

    +
  • Defined in src/framework/util/expr/parser.ts:275

    • Private parseLogicalAnd

    +
  • Defined in src/framework/util/expr/parser.ts:108

    • Private parseLogicalOr

    +
  • Defined in src/framework/util/expr/parser.ts:98

    • Private parseMultiplicative

    +
  • Defined in src/framework/util/expr/parser.ts:162

    • Private parseOp

    Returns undefined | T

    +
  • Defined in src/framework/util/expr/parser.ts:323

    • Private parsePostfix

    +
  • Defined in src/framework/util/expr/parser.ts:187

    • Private parsePrimary

    +
  • Defined in src/framework/util/expr/parser.ts:208

    • Private parsePropertyAccess

    Returns PropertyRef

    +
  • Defined in src/framework/util/expr/parser.ts:263

    • Private parseRootExpr

    +
  • Defined in src/framework/util/expr/parser.ts:67

    • Private parseToken

    Returns boolean

    +
  • Defined in src/framework/util/expr/parser.ts:306

    • Private parseUnary

    +
  • Defined in src/framework/util/expr/parser.ts:178

    • Private parseUnaryOp

    Returns undefined | UnaryOp

    +
  • Defined in src/framework/util/expr/parser.ts:315

    • Private token

    +
  • Defined in src/framework/util/expr/parser.ts:344

    • Static parse

    +
  • Defined in src/framework/util/expr/parser.ts:55
    • diff --git a/docs/classes/util.expr.ParserError.html b/docs/classes/util.expr.ParserError.html index d86edde..bc3124d 100644 --- a/docs/classes/util.expr.ParserError.html +++ b/docs/classes/util.expr.ParserError.html @@ -28,7 +28,7 @@

    Hierarchy

    • ParserError
    +
  • Defined in src/framework/util/expr/error.ts:10
    • @@ -85,7 +85,7 @@

    Returns

    +
  • Defined in src/framework/util/expr/error.ts:32

    • Properties

    @@ -95,7 +95,7 @@

    Readonly

    +
  • Defined in src/framework/util/expr/error.ts:18

    • Readonly expression

    expression: string
    @@ -103,7 +103,7 @@

    Readonly

    +
  • Defined in src/framework/util/expr/error.ts:14

    • Readonly line

    line: number
    @@ -111,7 +111,7 @@

    Readonly

    +
  • Defined in src/framework/util/expr/error.ts:22

    • message

    message: string
    +
  • Defined in src/framework/util/log/level.ts:10
    • @@ -97,7 +97,7 @@

    Returns voidReturns LogLevel

    +
  • Defined in src/framework/util/log/level.ts:78

    • Properties

    @@ -107,7 +107,7 @@

    Readonly

    +
  • Defined in src/framework/util/log/level.ts:79

    • Optional Readonly logFn

    logFn?: ((...data) => void)
    @@ -128,7 +128,7 @@
    Rest Returns void
    +
  • Defined in src/framework/util/log/level.ts:82

    • Optional Readonly style

    style?: string
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in src/framework/util/log/level.ts:81

    • Readonly value

    value: number
    @@ -144,7 +144,7 @@

    Readonly

    +
  • Defined in src/framework/util/log/level.ts:80

    • Static Readonly ALL

    ALL: LogLevel = ...
    @@ -152,7 +152,7 @@

    Static

    +
  • Defined in src/framework/util/log/level.ts:18

    • Static Readonly DEBUG

    DEBUG: LogLevel = ...
    @@ -160,12 +160,12 @@

    Static

    +
  • Defined in src/framework/util/log/level.ts:22

    • Static Private Readonly DEFAULT

    DEFAULT: LogLevel = LogLevel.OFF
    +
  • Defined in src/framework/util/log/level.ts:56

    • Static Readonly ERROR

    ERROR: LogLevel = ...
    @@ -173,7 +173,7 @@

    Static

    +
  • Defined in src/framework/util/log/level.ts:49

    • Static Readonly INFO

    INFO: LogLevel = ...
    @@ -181,12 +181,12 @@

    Static

    +
  • Defined in src/framework/util/log/level.ts:31

    • Static Private Readonly LEVELS

    LEVELS: Map<string, LogLevel> = ...
    +
  • Defined in src/framework/util/log/level.ts:58

    • Static Readonly OFF

    OFF: LogLevel = ...
    @@ -194,7 +194,7 @@

    Static

    +
  • Defined in src/framework/util/log/level.ts:14

    • Static Readonly WARN

    WARN: LogLevel = ...
    @@ -202,7 +202,7 @@

    Static

    +
  • Defined in src/framework/util/log/level.ts:40

    • Methods

    @@ -217,7 +217,7 @@

    Parameters

    label: string

    Returns undefined | LogLevel

    +
  • Defined in src/framework/util/log/level.ts:85
  • @@ -229,7 +229,7 @@
    label: defaultLevel: LogLevel

    • Returns LogLevel

    +
  • Defined in src/framework/util/log/level.ts:86
    • diff --git a/docs/classes/util.log.Logger.html b/docs/classes/util.log.Logger.html index ed991c1..ad037e1 100644 --- a/docs/classes/util.log.Logger.html +++ b/docs/classes/util.log.Logger.html @@ -26,7 +26,7 @@

    Hierarchy

    • Logger
    +
  • Defined in src/framework/util/log/logger.ts:13
    • @@ -98,7 +98,7 @@

    Returns voidReturns Logger

    +
  • Defined in src/framework/util/log/logger.ts:41

    • Properties

    @@ -108,7 +108,7 @@

    Private

    +
  • Defined in src/framework/util/log/logger.ts:43

    • Private Optional logFn

    logFn?: ((...data) => void)
    @@ -129,7 +129,7 @@
    Rest Returns void
    +
  • Defined in src/framework/util/log/logger.ts:44

    • Private Readonly name

    name: string
    @@ -137,17 +137,17 @@

    Private

    +
  • Defined in src/framework/util/log/logger.ts:42

    • Private seenWarnings

    seenWarnings: Set<string> = ...
    +
  • Defined in src/framework/util/log/logger.ts:15

    • Static Private globalLevel

    globalLevel: LogLevel = ...
    +
  • Defined in src/framework/util/log/logger.ts:14

    • Methods

    @@ -167,7 +167,7 @@
    Rest Returns void
    +
  • Defined in src/framework/util/log/logger.ts:92

    • error

    +
  • Defined in src/framework/util/log/logger.ts:128

    • getLevel

    +
  • Defined in src/framework/util/log/logger.ts:57

    • getName

    +
  • Defined in src/framework/util/log/logger.ts:50

    • info

    +
  • Defined in src/framework/util/log/logger.ts:100

    • isEnabled

    +
  • Defined in src/framework/util/log/logger.ts:72

    • isLevelEnabled

    +
  • Defined in src/framework/util/log/logger.ts:80

    • log

  • Log data with given level.

    @@ -291,7 +291,7 @@
    Rest Returns void
    • +
  • Defined in src/framework/util/log/logger.ts:142

    • setLevel

    +
  • Defined in src/framework/util/log/logger.ts:65

    • warn

    +
  • Defined in src/framework/util/log/logger.ts:108

    • warnOnce

    +
  • Defined in src/framework/util/log/logger.ts:116

    • Static getGlobalLevel

    +
  • Defined in src/framework/util/log/logger.ts:20

    • Static setGlobalLevel

    +
  • Defined in src/framework/util/log/logger.ts:29
    • diff --git a/docs/functions/contrib.ToolViewComponent.html b/docs/functions/contrib.ToolViewComponent.html index 4137daa..d9803df 100644 --- a/docs/functions/contrib.ToolViewComponent.html +++ b/docs/functions/contrib.ToolViewComponent.html @@ -27,7 +27,7 @@

    Parameters

    __namedParameters: ToolViewComponentProps

    Returns undefined | Element

    +
  • Defined in src/framework/contrib/tool-views.ts:120
    • diff --git a/docs/functions/contrib.executeCommand.html b/docs/functions/contrib.executeCommand.html index fc564ba..bb3f2c1 100644 --- a/docs/functions/contrib.executeCommand.html +++ b/docs/functions/contrib.executeCommand.html @@ -36,7 +36,7 @@
    commandId: Rest ...args: A
    Rest

    Returns Promise<T>

    +
  • Defined in src/framework/contrib/commands.ts:118
    • diff --git a/docs/functions/contrib.getConfigurationDefaultValue.html b/docs/functions/contrib.getConfigurationDefaultValue.html index b103563..6c3b59d 100644 --- a/docs/functions/contrib.getConfigurationDefaultValue.html +++ b/docs/functions/contrib.getConfigurationDefaultValue.html @@ -27,7 +27,7 @@

    Parameters

    propertyName: string

    Returns UiValue

    +
  • Defined in src/framework/contrib/configuration.ts:107
    • diff --git a/docs/functions/contrib.getConfigurationSchema.html b/docs/functions/contrib.getConfigurationSchema.html index 405e602..2722df3 100644 --- a/docs/functions/contrib.getConfigurationSchema.html +++ b/docs/functions/contrib.getConfigurationSchema.html @@ -27,7 +27,7 @@

    Parameters

    propertyName: string

    Returns UiSchema

    +
  • Defined in src/framework/contrib/configuration.ts:111
    • diff --git a/docs/functions/contrib.getConfigurationSchemas.html b/docs/functions/contrib.getConfigurationSchemas.html index 1efb6e5..4720f8a 100644 --- a/docs/functions/contrib.getConfigurationSchemas.html +++ b/docs/functions/contrib.getConfigurationSchemas.html @@ -22,7 +22,7 @@

    Function getConfigurationSchemas

  • Returns ReadonlyMap<string, UiSchema>

    • +
  • Defined in src/framework/contrib/configuration.ts:119
    • diff --git a/docs/functions/contrib.getDataViewProvider.html b/docs/functions/contrib.getDataViewProvider.html index 8c5ea29..16532bd 100644 --- a/docs/functions/contrib.getDataViewProvider.html +++ b/docs/functions/contrib.getDataViewProvider.html @@ -27,7 +27,7 @@

    Parameters

    viewType: string

    Returns Promise<DataViewProvider>

    +
  • Defined in src/framework/contrib/data-views.ts:104
    • diff --git a/docs/functions/contrib.getExtensionConfigurations.html b/docs/functions/contrib.getExtensionConfigurations.html index ddcc403..92c18eb 100644 --- a/docs/functions/contrib.getExtensionConfigurations.html +++ b/docs/functions/contrib.getExtensionConfigurations.html @@ -26,7 +26,7 @@

    Function getExtensionConfigurations

    Returns ReadonlyMap<string, Configuration>

    +
  • Defined in src/framework/contrib/configuration.ts:100
    • diff --git a/docs/functions/contrib.registerCommand.html b/docs/functions/contrib.registerCommand.html index 1fb8fb9..261cda4 100644 --- a/docs/functions/contrib.registerCommand.html +++ b/docs/functions/contrib.registerCommand.html @@ -36,7 +36,7 @@
    commandId: commandFn: CommandFn<T, A>

    Returns Disposable

    +
  • Defined in src/framework/contrib/commands.ts:111
    • diff --git a/docs/functions/contrib.registerContributionPoints.html b/docs/functions/contrib.registerContributionPoints.html index 0aa1c61..eab1171 100644 --- a/docs/functions/contrib.registerContributionPoints.html +++ b/docs/functions/contrib.registerContributionPoints.html @@ -36,7 +36,7 @@

    Returns

    +
  • Defined in src/framework/contrib/register.ts:36
    • diff --git a/docs/functions/contrib.registerDataViewProvider.html b/docs/functions/contrib.registerDataViewProvider.html index 549a081..a379224 100644 --- a/docs/functions/contrib.registerDataViewProvider.html +++ b/docs/functions/contrib.registerDataViewProvider.html @@ -29,7 +29,7 @@
    viewType: dataViewProvider: DataViewProvider

    Returns Disposable

    +
  • Defined in src/framework/contrib/data-views.ts:93
    • diff --git a/docs/functions/contrib.registerStatusBarItem.html b/docs/functions/contrib.registerStatusBarItem.html index ba33f5d..d8f718e 100644 --- a/docs/functions/contrib.registerStatusBarItem.html +++ b/docs/functions/contrib.registerStatusBarItem.html @@ -27,7 +27,7 @@

    Parameters

    statusBarItem: StatusBarItem

    Returns Disposable

    +
  • Defined in src/framework/contrib/status-bar-items.ts:33
    • diff --git a/docs/functions/contrib.registerStoreProvider.html b/docs/functions/contrib.registerStoreProvider.html index 74ea5c0..4317662 100644 --- a/docs/functions/contrib.registerStoreProvider.html +++ b/docs/functions/contrib.registerStoreProvider.html @@ -27,7 +27,7 @@

    Parameters

    storeProvider: StoreProvider<unknown>

    Returns Disposable

    +
  • Defined in src/framework/contrib/stores.ts:22
    • diff --git a/docs/functions/contrib.registerToolViewComponent.html b/docs/functions/contrib.registerToolViewComponent.html index d0194d8..9400d51 100644 --- a/docs/functions/contrib.registerToolViewComponent.html +++ b/docs/functions/contrib.registerToolViewComponent.html @@ -29,7 +29,7 @@
    viewId: component: Element

    Returns Disposable

    +
  • Defined in src/framework/contrib/tool-views.ts:99
    • diff --git a/docs/functions/contrib.useCommandPalette.html b/docs/functions/contrib.useCommandPalette.html index 7efc62c..f76bf45 100644 --- a/docs/functions/contrib.useCommandPalette.html +++ b/docs/functions/contrib.useCommandPalette.html @@ -27,7 +27,7 @@

    Parameters

    ctx: Record<string, unknown>

    Returns CommandMenuItem[]

    +
  • Defined in src/framework/contrib/command-palette.ts:25
    • diff --git a/docs/functions/contrib.useCommands.html b/docs/functions/contrib.useCommands.html index 5d4a16b..8ef7c59 100644 --- a/docs/functions/contrib.useCommands.html +++ b/docs/functions/contrib.useCommands.html @@ -22,7 +22,7 @@

    Function useCommands

  • Returns Command[]

    • +
  • Defined in src/framework/contrib/commands.ts:99
    • diff --git a/docs/functions/contrib.useConfigurationItems.html b/docs/functions/contrib.useConfigurationItems.html index 233cee1..548f55b 100644 --- a/docs/functions/contrib.useConfigurationItems.html +++ b/docs/functions/contrib.useConfigurationItems.html @@ -27,7 +27,7 @@

    Parameters

    configurationNodes: ConfigurationNode[]

    Returns ConfigurationItem[]

    +
  • Defined in src/framework/contrib/configuration.ts:370
    • diff --git a/docs/functions/contrib.useConfigurationNodes.html b/docs/functions/contrib.useConfigurationNodes.html index 68828db..62a3e41 100644 --- a/docs/functions/contrib.useConfigurationNodes.html +++ b/docs/functions/contrib.useConfigurationNodes.html @@ -29,7 +29,7 @@
    familyTitles: Optional searchPattern: string
    Optional

    Returns ConfigurationNode[]

    +
  • Defined in src/framework/contrib/configuration.ts:169
    • diff --git a/docs/functions/contrib.useConfigurationSchemas.html b/docs/functions/contrib.useConfigurationSchemas.html index 0753070..ae4da7b 100644 --- a/docs/functions/contrib.useConfigurationSchemas.html +++ b/docs/functions/contrib.useConfigurationSchemas.html @@ -26,7 +26,7 @@

    Function useConfigurationSchemas

    Returns ReadonlyMap<string, UiSchema>

    +
  • Defined in src/framework/contrib/configuration.ts:128
    • diff --git a/docs/functions/contrib.useDataViewType.html b/docs/functions/contrib.useDataViewType.html index f85fc60..c605268 100644 --- a/docs/functions/contrib.useDataViewType.html +++ b/docs/functions/contrib.useDataViewType.html @@ -27,7 +27,7 @@

    Parameters

    viewType: string

    Returns DataViewType

    +
  • Defined in src/framework/contrib/data-views.ts:84
    • diff --git a/docs/functions/contrib.useDataViewTypes.html b/docs/functions/contrib.useDataViewTypes.html index f938339..df48804 100644 --- a/docs/functions/contrib.useDataViewTypes.html +++ b/docs/functions/contrib.useDataViewTypes.html @@ -22,7 +22,7 @@

    Function useDataViewTypes

  • Returns DataViewType[]

    • +
  • Defined in src/framework/contrib/data-views.ts:80
    • diff --git a/docs/functions/contrib.useExtensionConfigurations.html b/docs/functions/contrib.useExtensionConfigurations.html index c9dc30b..995e241 100644 --- a/docs/functions/contrib.useExtensionConfigurations.html +++ b/docs/functions/contrib.useExtensionConfigurations.html @@ -26,7 +26,7 @@

    Function useExtensionConfigurations

    Returns ReadonlyMap<string, Configuration>

    +
  • Defined in src/framework/contrib/configuration.ts:89
    • diff --git a/docs/functions/contrib.useKeybindings.html b/docs/functions/contrib.useKeybindings.html index 7af36ea..f2f0253 100644 --- a/docs/functions/contrib.useKeybindings.html +++ b/docs/functions/contrib.useKeybindings.html @@ -29,7 +29,7 @@
    ctx: Optional disabled: boolean
    Optional

    Returns void

    +
  • Defined in src/framework/contrib/keybindings.ts:94
    • diff --git a/docs/functions/contrib.useMenu.html b/docs/functions/contrib.useMenu.html index f0af8e2..edc2557 100644 --- a/docs/functions/contrib.useMenu.html +++ b/docs/functions/contrib.useMenu.html @@ -29,7 +29,7 @@
    menuId: ctx: Record<string, unknown>

    Returns MenuItem[]

    +
  • Defined in src/framework/contrib/menus.ts:127
    • diff --git a/docs/functions/contrib.useStatusBarItems.html b/docs/functions/contrib.useStatusBarItems.html index 76d8eb5..3ccef25 100644 --- a/docs/functions/contrib.useStatusBarItems.html +++ b/docs/functions/contrib.useStatusBarItems.html @@ -22,7 +22,7 @@

    Function useStatusBarItems

  • Returns StatusBarItem[][]

    • +
  • Defined in src/framework/contrib/status-bar-items.ts:43
    • diff --git a/docs/functions/contrib.useStores.html b/docs/functions/contrib.useStores.html index 0b20bb8..087e4f6 100644 --- a/docs/functions/contrib.useStores.html +++ b/docs/functions/contrib.useStores.html @@ -22,7 +22,7 @@

    Function useStores

  • Returns Record<string, unknown>

    • +
  • Defined in src/framework/contrib/stores.ts:35
    • diff --git a/docs/functions/contrib.useSubmenus.html b/docs/functions/contrib.useSubmenus.html index 88ab341..57faf03 100644 --- a/docs/functions/contrib.useSubmenus.html +++ b/docs/functions/contrib.useSubmenus.html @@ -22,7 +22,7 @@

    Function useSubmenus

  • Returns Submenu[]

    • +
  • Defined in src/framework/contrib/submenus.ts:53
    • diff --git a/docs/functions/contrib.useToolViewComponent.html b/docs/functions/contrib.useToolViewComponent.html index d28c5b9..3b9976e 100644 --- a/docs/functions/contrib.useToolViewComponent.html +++ b/docs/functions/contrib.useToolViewComponent.html @@ -27,7 +27,7 @@

    Parameters

    viewId: string

    Returns React.JSX.Element | undefined

    +
  • Defined in src/framework/contrib/tool-views.ts:106
    • diff --git a/docs/functions/contrib.useToolViews.html b/docs/functions/contrib.useToolViews.html index ac35f42..186a95a 100644 --- a/docs/functions/contrib.useToolViews.html +++ b/docs/functions/contrib.useToolViews.html @@ -29,7 +29,7 @@
    containerId: ctx: Record<string, unknown>

    Returns ToolView[]

    +
  • Defined in src/framework/contrib/tool-views.ts:88
    • diff --git a/docs/functions/core.activateExtension.html b/docs/functions/core.activateExtension.html index dfcb44c..c65cf88 100644 --- a/docs/functions/core.activateExtension.html +++ b/docs/functions/core.activateExtension.html @@ -34,7 +34,7 @@
    extensionId: Returns Promise<Extension<unknown>>
    +
  • Defined in src/framework/core/extension/activate.ts:23
    • diff --git a/docs/functions/core.addExtensionListener.html b/docs/functions/core.addExtensionListener.html index 4aafd7d..b86d0e3 100644 --- a/docs/functions/core.addExtensionListener.html +++ b/docs/functions/core.addExtensionListener.html @@ -39,7 +39,7 @@

    Returns (Returns void

    +
  • Defined in src/framework/core/extension/listeners.ts:32
    • diff --git a/docs/functions/core.compileWhenClause.html b/docs/functions/core.compileWhenClause.html index 3dfd444..f269e92 100644 --- a/docs/functions/core.compileWhenClause.html +++ b/docs/functions/core.compileWhenClause.html @@ -38,7 +38,7 @@

    Returns

    +
  • Defined in src/framework/core/contrib-point/when.ts:61
    • diff --git a/docs/functions/core.deactivateExtension.html b/docs/functions/core.deactivateExtension.html index ff128fd..dd00233 100644 --- a/docs/functions/core.deactivateExtension.html +++ b/docs/functions/core.deactivateExtension.html @@ -35,7 +35,7 @@

    Returns Promise<

    +
  • Defined in src/framework/core/extension/deactivate.ts:23
    • diff --git a/docs/functions/core.getCodeContributions.html b/docs/functions/core.getCodeContributions.html index 4ae9abf..26742fb 100644 --- a/docs/functions/core.getCodeContributions.html +++ b/docs/functions/core.getCodeContributions.html @@ -41,7 +41,7 @@

    Returns Readonly

    +
  • Defined in src/framework/core/code-contrib/get.ts:19
    • diff --git a/docs/functions/core.getContributionPoint.html b/docs/functions/core.getContributionPoint.html index da418be..0979d1d 100644 --- a/docs/functions/core.getContributionPoint.html +++ b/docs/functions/core.getContributionPoint.html @@ -41,7 +41,7 @@

    Returns

    +
  • Defined in src/framework/core/contrib-point/get.ts:21

  • Gets the contribution point for the given contribution point identifier.

    @@ -69,7 +69,7 @@

    Returns

    • +
  • Defined in src/framework/core/contrib-point/get.ts:33
    • diff --git a/docs/functions/core.getContributionPoints.html b/docs/functions/core.getContributionPoints.html index 79ddf5e..e82ff71 100644 --- a/docs/functions/core.getContributionPoints.html +++ b/docs/functions/core.getContributionPoints.html @@ -25,7 +25,7 @@

    Function getContributionPoints

    Returns ContributionPoint[]

    +
  • Defined in src/framework/core/contrib-point/get.ts:55
    • diff --git a/docs/functions/core.getContributions.html b/docs/functions/core.getContributions.html index ed9c810..7d14b60 100644 --- a/docs/functions/core.getContributions.html +++ b/docs/functions/core.getContributions.html @@ -48,7 +48,7 @@

    Returns

    +
  • Defined in src/framework/core/contrib-point/get.ts:88
    • diff --git a/docs/functions/core.getExtension.html b/docs/functions/core.getExtension.html index df5e488..fd26f47 100644 --- a/docs/functions/core.getExtension.html +++ b/docs/functions/core.getExtension.html @@ -33,7 +33,7 @@

    Returns

    +
  • Defined in src/framework/core/extension/get.ts:19

  • Gets the extension for the given extension identifier.

    @@ -54,7 +54,7 @@

    Returns

    • +
  • Defined in src/framework/core/extension/get.ts:29
    • diff --git a/docs/functions/core.getExtensionContributions.html b/docs/functions/core.getExtensionContributions.html index 7224ec3..ddfe0b7 100644 --- a/docs/functions/core.getExtensionContributions.html +++ b/docs/functions/core.getExtensionContributions.html @@ -47,7 +47,7 @@

    Returns Readonly

    +
  • Defined in src/framework/core/contrib-point/get.ts:142
    • diff --git a/docs/functions/core.getExtensionDisplayName.html b/docs/functions/core.getExtensionDisplayName.html index 9b640f4..5e72ea2 100644 --- a/docs/functions/core.getExtensionDisplayName.html +++ b/docs/functions/core.getExtensionDisplayName.html @@ -32,7 +32,7 @@
    manifest: Returns string
    +
  • Defined in src/framework/core/extension/manifest.ts:88
    • diff --git a/docs/functions/core.getExtensionId.html b/docs/functions/core.getExtensionId.html index f06d8d4..ea311af 100644 --- a/docs/functions/core.getExtensionId.html +++ b/docs/functions/core.getExtensionId.html @@ -32,7 +32,7 @@
    manifest: Returns string
    +
  • Defined in src/framework/core/extension/manifest.ts:78
    • diff --git a/docs/functions/core.getExtensions.html b/docs/functions/core.getExtensions.html index 4ae672b..49c2d13 100644 --- a/docs/functions/core.getExtensions.html +++ b/docs/functions/core.getExtensions.html @@ -27,7 +27,7 @@

    Returns

    +
  • Defined in src/framework/core/extension/get.ts:48
    • diff --git a/docs/functions/core.loadCodeContribution.html b/docs/functions/core.loadCodeContribution.html index f2b5096..62b6b83 100644 --- a/docs/functions/core.loadCodeContribution.html +++ b/docs/functions/core.loadCodeContribution.html @@ -48,7 +48,7 @@

    Throws

    Error - If the contribution point is unknown or if the contribution identifier is not registered

    +
  • Defined in src/framework/core/code-contrib/load.ts:24
    • diff --git a/docs/functions/core.readExtensionManifest.html b/docs/functions/core.readExtensionManifest.html index 8626098..4cfa1dc 100644 --- a/docs/functions/core.readExtensionManifest.html +++ b/docs/functions/core.readExtensionManifest.html @@ -35,7 +35,7 @@

    Returns Promise<

    +
  • Defined in src/framework/core/extension/manifest.ts:45
    • diff --git a/docs/functions/core.registerCodeContribution.html b/docs/functions/core.registerCodeContribution.html index fad0125..b939bc0 100644 --- a/docs/functions/core.registerCodeContribution.html +++ b/docs/functions/core.registerCodeContribution.html @@ -49,7 +49,7 @@

    Returns

    +
  • Defined in src/framework/core/code-contrib/register.ts:26
    • diff --git a/docs/functions/core.registerContributionPoint.html b/docs/functions/core.registerContributionPoint.html index e479c45..50660f1 100644 --- a/docs/functions/core.registerContributionPoint.html +++ b/docs/functions/core.registerContributionPoint.html @@ -40,7 +40,7 @@

    Returns

    +
  • Defined in src/framework/core/contrib-point/register.ts:18
    • diff --git a/docs/functions/core.registerExtension.html b/docs/functions/core.registerExtension.html index f67a744..c454dbc 100644 --- a/docs/functions/core.registerExtension.html +++ b/docs/functions/core.registerExtension.html @@ -42,7 +42,7 @@

    Returns

    +
  • Defined in src/framework/core/extension/register.ts:39
    • diff --git a/docs/functions/core.updateFrameworkConfig.html b/docs/functions/core.updateFrameworkConfig.html index 282e5fc..32cc825 100644 --- a/docs/functions/core.updateFrameworkConfig.html +++ b/docs/functions/core.updateFrameworkConfig.html @@ -33,7 +33,7 @@

    Returns

    +
  • Defined in src/framework/core/config.ts:24
    • diff --git a/docs/functions/react.useCodeContributions.html b/docs/functions/react.useCodeContributions.html index e23c5f6..e5507e0 100644 --- a/docs/functions/react.useCodeContributions.html +++ b/docs/functions/react.useCodeContributions.html @@ -40,7 +40,7 @@

    Returns Readonly

    +
  • Defined in src/framework/react/hooks.ts:167
    • diff --git a/docs/functions/react.useContributionPoints.html b/docs/functions/react.useContributionPoints.html index 2f927be..e34a32e 100644 --- a/docs/functions/react.useContributionPoints.html +++ b/docs/functions/react.useContributionPoints.html @@ -26,7 +26,7 @@

    Returns

    +
  • Defined in src/framework/react/hooks.ts:106
    • diff --git a/docs/functions/react.useContributions.html b/docs/functions/react.useContributions.html index 7f38b5a..7c0778c 100644 --- a/docs/functions/react.useContributions.html +++ b/docs/functions/react.useContributions.html @@ -45,7 +45,7 @@

    Returns

    +
  • Defined in src/framework/react/hooks.ts:69
    • diff --git a/docs/functions/react.useExtensionContributions.html b/docs/functions/react.useExtensionContributions.html index a2b1f84..8ee9c67 100644 --- a/docs/functions/react.useExtensionContributions.html +++ b/docs/functions/react.useExtensionContributions.html @@ -45,7 +45,7 @@

    Returns Readonly

    +
  • Defined in src/framework/react/hooks.ts:89
    • diff --git a/docs/functions/react.useExtensions.html b/docs/functions/react.useExtensions.html index 0a972d1..51f683c 100644 --- a/docs/functions/react.useExtensions.html +++ b/docs/functions/react.useExtensions.html @@ -26,7 +26,7 @@

    Returns

    +
  • Defined in src/framework/react/hooks.ts:53
    • diff --git a/docs/functions/react.useLoadCodeContribution.html b/docs/functions/react.useLoadCodeContribution.html index b2716b9..28b76f3 100644 --- a/docs/functions/react.useLoadCodeContribution.html +++ b/docs/functions/react.useLoadCodeContribution.html @@ -40,7 +40,7 @@

    Returns

    +
  • Defined in src/framework/react/hooks.ts:119
    • diff --git a/docs/functions/util.assert.html b/docs/functions/util.assert.html index 1307ddf..d295d7b 100644 --- a/docs/functions/util.assert.html +++ b/docs/functions/util.assert.html @@ -37,7 +37,7 @@
    Optional Returns asserts condition
    +
  • Defined in src/framework/util/assert.ts:32
    • diff --git a/docs/functions/util.assertDefined.html b/docs/functions/util.assertDefined.html index 6c5e82e..60eadb3 100644 --- a/docs/functions/util.assertDefined.html +++ b/docs/functions/util.assertDefined.html @@ -42,7 +42,7 @@
    Optional Returns asserts value is NonNullable<T>
    +
  • Defined in src/framework/util/assert.ts:48
    • diff --git a/docs/functions/util.capitalize.html b/docs/functions/util.capitalize.html index 9aa08fa..47bba15 100644 --- a/docs/functions/util.capitalize.html +++ b/docs/functions/util.capitalize.html @@ -32,7 +32,7 @@
    text: Returns string
    +
  • Defined in src/framework/util/capitalize.ts:11
    • diff --git a/docs/functions/util.createSelector.html b/docs/functions/util.createSelector.html index f89942a..1c79b12 100644 --- a/docs/functions/util.createSelector.html +++ b/docs/functions/util.createSelector.html @@ -77,7 +77,7 @@

    Returns

    +
  • Defined in src/framework/util/selector.ts:41
  • @@ -115,7 +115,7 @@
    x2: Returns Result

    • Returns Selector<State, Result>

    +
  • Defined in src/framework/util/selector.ts:45
  • @@ -159,7 +159,7 @@
    x3: Returns Result

    • Returns Selector<State, Result>

    +
  • Defined in src/framework/util/selector.ts:50
  • @@ -209,7 +209,7 @@
    x4: Returns Result

    • Returns Selector<State, Result>

    +
  • Defined in src/framework/util/selector.ts:56
  • @@ -265,7 +265,7 @@
    x5: Returns Result

    • Returns Selector<State, Result>

    +
  • Defined in src/framework/util/selector.ts:63
  • @@ -327,7 +327,7 @@
    x6: Returns Result

    • Returns Selector<State, Result>

    +
  • Defined in src/framework/util/selector.ts:71
  • @@ -395,7 +395,7 @@
    x7: Returns Result

    • Returns Selector<State, Result>

    +
  • Defined in src/framework/util/selector.ts:80
  • @@ -469,7 +469,7 @@
    x8: Returns Result

    • Returns Selector<State, Result>

    +
  • Defined in src/framework/util/selector.ts:98
    • diff --git a/docs/functions/util.getDefaultUiValue.html b/docs/functions/util.getDefaultUiValue.html index 014872e..13145c1 100644 --- a/docs/functions/util.getDefaultUiValue.html +++ b/docs/functions/util.getDefaultUiValue.html @@ -27,7 +27,7 @@

    Parameters

    schema: BooleanUiSchema

    Returns boolean

    +
  • Defined in src/framework/util/json/ui-schema.ts:153
  • @@ -37,7 +37,7 @@

    Parameters

    schema: NumberUiSchema

    • Returns number

    +
  • Defined in src/framework/util/json/ui-schema.ts:154
  • @@ -47,7 +47,7 @@

    Parameters

    schema: StringUiSchema

    • Returns string

    +
  • Defined in src/framework/util/json/ui-schema.ts:155
  • @@ -57,7 +57,7 @@

    Parameters

    schema: TupleUiSchema

    • Returns TupleUiValue

    +
  • Defined in src/framework/util/json/ui-schema.ts:156
  • @@ -67,7 +67,7 @@

    Parameters

    schema: ListUiSchema

    • Returns ListUiValue

    +
  • Defined in src/framework/util/json/ui-schema.ts:157
  • @@ -77,7 +77,7 @@

    Parameters

    schema: ObjectUiSchema

    • Returns ObjectUiValue

    +
  • Defined in src/framework/util/json/ui-schema.ts:158
  • @@ -87,7 +87,7 @@

    Parameters

    schema: UiSchema

    • Returns UiValue

    +
  • Defined in src/framework/util/json/ui-schema.ts:159
    • diff --git a/docs/functions/util.isBooleanUiSchema.html b/docs/functions/util.isBooleanUiSchema.html index 4ddd168..2887b8d 100644 --- a/docs/functions/util.isBooleanUiSchema.html +++ b/docs/functions/util.isBooleanUiSchema.html @@ -27,7 +27,7 @@

    Parameters

    schema: UiSchema

    Returns schema is BooleanUiSchema

    +
  • Defined in src/framework/util/json/ui-schema.ts:131
    • diff --git a/docs/functions/util.isIntegerUiSchema.html b/docs/functions/util.isIntegerUiSchema.html index a271bc2..5d6b72d 100644 --- a/docs/functions/util.isIntegerUiSchema.html +++ b/docs/functions/util.isIntegerUiSchema.html @@ -27,7 +27,7 @@

    Parameters

    schema: UiSchema

    Returns schema is NumberUiSchema

    +
  • Defined in src/framework/util/json/ui-schema.ts:134
    • diff --git a/docs/functions/util.isListUiSchema.html b/docs/functions/util.isListUiSchema.html index 84a83ab..8248c23 100644 --- a/docs/functions/util.isListUiSchema.html +++ b/docs/functions/util.isListUiSchema.html @@ -27,7 +27,7 @@

    Parameters

    schema: UiSchema

    Returns schema is ListUiSchema

    +
  • Defined in src/framework/util/json/ui-schema.ts:146
    • diff --git a/docs/functions/util.isNumberUiSchema.html b/docs/functions/util.isNumberUiSchema.html index 6fb92ac..c04f372 100644 --- a/docs/functions/util.isNumberUiSchema.html +++ b/docs/functions/util.isNumberUiSchema.html @@ -27,7 +27,7 @@

    Parameters

    schema: UiSchema

    Returns schema is NumberUiSchema

    +
  • Defined in src/framework/util/json/ui-schema.ts:137
    • diff --git a/docs/functions/util.isObjectUiSchema.html b/docs/functions/util.isObjectUiSchema.html index 9929478..92619c8 100644 --- a/docs/functions/util.isObjectUiSchema.html +++ b/docs/functions/util.isObjectUiSchema.html @@ -27,7 +27,7 @@

    Parameters

    schema: UiSchema

    Returns schema is ObjectUiSchema

    +
  • Defined in src/framework/util/json/ui-schema.ts:149
    • diff --git a/docs/functions/util.isStringUiSchema.html b/docs/functions/util.isStringUiSchema.html index a1399af..2850c65 100644 --- a/docs/functions/util.isStringUiSchema.html +++ b/docs/functions/util.isStringUiSchema.html @@ -27,7 +27,7 @@

    Parameters

    schema: UiSchema

    Returns schema is StringUiSchema

    +
  • Defined in src/framework/util/json/ui-schema.ts:140
    • diff --git a/docs/functions/util.isTupleUiSchema.html b/docs/functions/util.isTupleUiSchema.html index 2fcc0a9..1d3cbad 100644 --- a/docs/functions/util.isTupleUiSchema.html +++ b/docs/functions/util.isTupleUiSchema.html @@ -27,7 +27,7 @@

    Parameters

    schema: UiSchema

    Returns schema is TupleUiSchema

    +
  • Defined in src/framework/util/json/ui-schema.ts:143
    • diff --git a/docs/functions/util.keyFromArray.html b/docs/functions/util.keyFromArray.html index 23efb82..9d247b1 100644 --- a/docs/functions/util.keyFromArray.html +++ b/docs/functions/util.keyFromArray.html @@ -32,7 +32,7 @@
    array: Returns string
    +
  • Defined in src/framework/util/key.ts:25
    • diff --git a/docs/functions/util.keyFromObject.html b/docs/functions/util.keyFromObject.html index db77e6c..c40437a 100644 --- a/docs/functions/util.keyFromObject.html +++ b/docs/functions/util.keyFromObject.html @@ -32,7 +32,7 @@
    obj: Returns string
    +
  • Defined in src/framework/util/key.ts:33
    • diff --git a/docs/functions/util.keyFromValue.html b/docs/functions/util.keyFromValue.html index e5ec327..d485e16 100644 --- a/docs/functions/util.keyFromValue.html +++ b/docs/functions/util.keyFromValue.html @@ -32,7 +32,7 @@
    value: Returns string
    +
  • Defined in src/framework/util/key.ts:11
    • diff --git a/docs/functions/util.newId.html b/docs/functions/util.newId.html index 0a10682..fc4d6e0 100644 --- a/docs/functions/util.newId.html +++ b/docs/functions/util.newId.html @@ -38,7 +38,7 @@
    abc: Returns string
    +
  • Defined in src/framework/util/id.ts:18
    • diff --git a/docs/functions/util.toTitle.html b/docs/functions/util.toTitle.html index 1870df9..58d8f34 100644 --- a/docs/functions/util.toTitle.html +++ b/docs/functions/util.toTitle.html @@ -34,7 +34,7 @@
    text: Returns string
    +
  • Defined in src/framework/util/to-title.ts:13
    • diff --git a/docs/functions/util.validateJson.html b/docs/functions/util.validateJson.html index 362a644..df66c80 100644 --- a/docs/functions/util.validateJson.html +++ b/docs/functions/util.validateJson.html @@ -47,7 +47,7 @@

    Returns

    +
  • Defined in src/framework/util/json/validate-json.ts:32
    • diff --git a/docs/index.html b/docs/index.html index 277900d..c5be788 100644 --- a/docs/index.html +++ b/docs/index.html @@ -28,8 +28,9 @@

    @forman2/extendit

    import JavaScript modules - extensions - that add new features and capabilities to the application.

    ExtendIt.js has been designed to efficiently work with -React, for this purpose it provides a number of -reactive hooks. However, the library can be used without +React, for this purpose it provides a number of reactive +React hooks. +However, the library can be used without React too. It's only a peer dependency.

    Installation

    npm install @forman2/extendit
    @@ -60,9 +61,11 @@

    @forman2/extendit

    import { type ExtensionContext, getExtension } from "@forman2/extendit";
    import { type MyApi } from "@my-company/my-extension";

    export function activate(ctx: ExtensionContext) {
      const myExtension = getExtension("my-company.my-extension");
      const myApi = myExtension.exports as MyApi;
      // Use imported extension API here, e.g., to add some contribution
      myApi.registerViewProvider({ ... });
    }

    The host application registers extensions using the +readExtensionManifest +and registerExtension -function:

    -
    import { registerExtension } from "@forman2/extendit";

    export function initApp() {
       const extensionsUrls = getAppExtensionUrls();
       extensionUrls.forEach((extensionUrl) => {
          void registerExtension(extensionUrl);
       });
    }

    function getAppExtensionUrls(): URL[] {
      // ...
    }
+functions:
    
+
    import { readExtensionManifest, registerExtension } from "@forman2/extendit";

    export function initApp() {
       const extensionsUrls = getAppExtensionUrls();
       extensionUrls.forEach((extensionUrl) => {
         readExtensionManifest(extensionUrl)
         .then((manifest) => 
           registerExtension(manifest)
         )
         .catch((error) => {
           // ...
         });
       });
    }

    function getAppExtensionUrls(): URL[] {
      // ...
    }
 
    
 
    The host application (or an extension) can also define handy 
 contribution points:
    
@@ -118,21 +121,12 @@ 
    @forman2/extendit
    import { loadCodeContribution } from "@forman2/extendit";
    import { type Command } from "./command";

    async function getCommand(commandId: string): Promise<Command> {
      return await loadCodeContribution<Command>("commands", commandId);
    }

    There is also a corresponding React hook -useLoadCodeContribution +useLoadCodeContribution that is used for implementing React components:

    import { useLoadCodeContribution } from "@forman2/extendit/react";
    import { type Command } from "./command";

    interface CommandButtonProps {
      command: Command;  
    }

    export default function CommandButton({ command }: CommandButtonProps) {
      const commandCode = useLoadCodeContribution("commands", command.id);
      return (
        <button
          onClick={commandCode.data}
          disabled={commandCode.loading || commandCode.error}      
        >
          {command.title} 
        </button>
      );    
    }

    Documentation

    We currently only have this file and the API docs, sorry.

    -

    Acknowledgements

    ExtendIt.js currently uses the awesome libraries

    -
      -
    • Ajv for JSON validation (may be turned into peer dependency later)
      • -
    • memoize-one for implementing state selector functions
      • -
    • zustand for state management
      • -
    -

    License

    Copyright © 2023 Norman Fomferra

    -

    Permissions are hereby granted under the terms of the MIT License: -https://opensource.org/licenses/MIT.

    Development

    Source Code

    Get sources and install dependencies first:

    $ git clone https://github.com/forman/extendit
    $ cd extendit
    $ npm install
    @@ -164,6 +158,15 @@

    @forman2/extendit

    If we also have resource dependencies (*.css, *.json, *.svg, ...), we first import TypeScript source dependencies, then separated by a newline, insert resource dependencies in the same order as source dependencies.

    +

    Acknowledgements

    ExtendIt.js currently uses the awesome libraries

    +
      +
    • Ajv for JSON validation (may be turned into peer dependency later)
      • +
    • memoize-one for implementing state selector functions
      • +
    • zustand for state management
      • +
    +

    License

    Copyright © 2023 Norman Fomferra

    +

    Permissions are hereby granted under the terms of the MIT License: +https://opensource.org/licenses/MIT.

    @@ -189,15 +192,15 @@

    Installation
  • Getting Started
  • Documentation
    • -
  • Acknowledgements
    • -
  • License
  • Development

    • +
  • Coding style
    • +
  • Acknowledgements
    • +
  • License
    • +
  • Defined in src/framework/contrib/commands.ts:25

    • Optional checked

    checked?: When
    +
  • Defined in src/framework/contrib/commands.ts:37

    • command

    command: string
    +
  • Defined in src/framework/contrib/commands.ts:23

    • Optional enablement

    enablement?: When
    +
  • Defined in src/framework/contrib/commands.ts:36

    • Optional icon

    icon?: string
    +
  • Defined in src/framework/contrib/commands.ts:27

    • Optional title

    title?: string
    +
  • Defined in src/framework/contrib/commands.ts:24

    • Optional tooltip

    tooltip?: string
    +
  • Defined in src/framework/contrib/commands.ts:26
    • diff --git a/docs/interfaces/contrib.CommandManifestEntry.html b/docs/interfaces/contrib.CommandManifestEntry.html index 6a95027..b071a12 100644 --- a/docs/interfaces/contrib.CommandManifestEntry.html +++ b/docs/interfaces/contrib.CommandManifestEntry.html @@ -23,7 +23,7 @@

    Hierarchy

    • CommandManifestEntry
    +
  • Defined in src/framework/contrib/commands.ts:30
    • @@ -46,41 +46,41 @@

    Optionalcategory?: string

    +
  • Defined in src/framework/contrib/commands.ts:25

    • Optional checked

    checked?: string
    +
  • Defined in src/framework/contrib/commands.ts:32

    • command

    command: string
    +
  • Defined in src/framework/contrib/commands.ts:23

    • Optional enablement

    enablement?: string
    +
  • Defined in src/framework/contrib/commands.ts:31

    • Optional icon

    icon?: string
    +
  • Defined in src/framework/contrib/commands.ts:27

    • Optional title

    title?: string
    +
  • Defined in src/framework/contrib/commands.ts:24

    • Optional tooltip

    tooltip?: string
    +
  • Defined in src/framework/contrib/commands.ts:26
    • diff --git a/docs/interfaces/contrib.CommandMenuItem.html b/docs/interfaces/contrib.CommandMenuItem.html index b4480ab..8688b4d 100644 --- a/docs/interfaces/contrib.CommandMenuItem.html +++ b/docs/interfaces/contrib.CommandMenuItem.html @@ -23,7 +23,7 @@

    Hierarchy

    • CommandMenuItem
    +
  • Defined in src/framework/contrib/command-palette.ts:21
    • @@ -49,61 +49,61 @@

    Optionalargs?: (null | string | number | boolean)[]

    +
  • Defined in src/framework/contrib/menus.ts:30

    • Optional checked

    checked?: boolean
    +
  • Defined in src/framework/contrib/menus.ts:55

    • command

    command: string
    +
  • Defined in src/framework/contrib/command-palette.ts:22

    • Optional disabled

    disabled?: boolean
    +
  • Defined in src/framework/contrib/menus.ts:54

    • group

    group: string
    +
  • Defined in src/framework/contrib/menus.ts:43

    • Optional icon

    icon?: string
    +
  • Defined in src/framework/contrib/menus.ts:33

    • id

    id: string
    +
  • Defined in src/framework/contrib/menus.ts:41

    • Optional keybinding

    keybinding?: Keybinding
    +
  • Defined in src/framework/contrib/menus.ts:56

    • label

    label: string
    +
  • Defined in src/framework/contrib/menus.ts:42

    • order

    order: number
    +
  • Defined in src/framework/contrib/menus.ts:44
    • diff --git a/docs/interfaces/contrib.ConfigurationCategory.html b/docs/interfaces/contrib.ConfigurationCategory.html index 8fa2e20..ea9f86e 100644 --- a/docs/interfaces/contrib.ConfigurationCategory.html +++ b/docs/interfaces/contrib.ConfigurationCategory.html @@ -21,7 +21,7 @@

    Hierarchy

    • ConfigurationCategory
    +
  • Defined in src/framework/contrib/configuration.ts:25
    • @@ -40,22 +40,22 @@

    Properties

    Optional familyTitle

    familyTitle?: string
    +
  • Defined in src/framework/contrib/configuration.ts:27

    • Optional order

    order?: number
    +
  • Defined in src/framework/contrib/configuration.ts:28

    • properties

    properties: Record<string, UiSchema>
    +
  • Defined in src/framework/contrib/configuration.ts:29

    • title

    title: string
    +
  • Defined in src/framework/contrib/configuration.ts:26
    • diff --git a/docs/interfaces/contrib.ConfigurationHeaderItem.html b/docs/interfaces/contrib.ConfigurationHeaderItem.html index d752ad8..666114b 100644 --- a/docs/interfaces/contrib.ConfigurationHeaderItem.html +++ b/docs/interfaces/contrib.ConfigurationHeaderItem.html @@ -23,7 +23,7 @@

    Hierarchy

    • ConfigurationHeaderItem
    +
  • Defined in src/framework/contrib/configuration.ts:357
    • @@ -42,19 +42,19 @@

    idid: string

    +
  • Defined in src/framework/contrib/configuration.ts:353

    • titlePath

    titlePath: string[]
    +
  • Defined in src/framework/contrib/configuration.ts:354

    • type

    type: "header"
    +
  • Defined in src/framework/contrib/configuration.ts:358
    • diff --git a/docs/interfaces/contrib.ConfigurationNode.html b/docs/interfaces/contrib.ConfigurationNode.html index 9208e02..0a86974 100644 --- a/docs/interfaces/contrib.ConfigurationNode.html +++ b/docs/interfaces/contrib.ConfigurationNode.html @@ -21,7 +21,7 @@

    Hierarchy

    • ConfigurationNode
    +
  • Defined in src/framework/contrib/configuration.ts:35
    • @@ -42,32 +42,32 @@

    Properties

    Optional category

    category?: ConfigurationCategory
    +
  • Defined in src/framework/contrib/configuration.ts:39

    • Optional children

    children?: ConfigurationNode[]
    +
  • Defined in src/framework/contrib/configuration.ts:40

    • id

    id: string
    +
  • Defined in src/framework/contrib/configuration.ts:36

    • numProperties

    numProperties: number
    +
  • Defined in src/framework/contrib/configuration.ts:41

    • order

    order: number
    +
  • Defined in src/framework/contrib/configuration.ts:38

    • title

    title: string
    +
  • Defined in src/framework/contrib/configuration.ts:37
    • diff --git a/docs/interfaces/contrib.ConfigurationPropertyItem.html b/docs/interfaces/contrib.ConfigurationPropertyItem.html index ba23d95..9e4ad38 100644 --- a/docs/interfaces/contrib.ConfigurationPropertyItem.html +++ b/docs/interfaces/contrib.ConfigurationPropertyItem.html @@ -23,7 +23,7 @@

    Hierarchy

    • ConfigurationPropertyItem
    +
  • Defined in src/framework/contrib/configuration.ts:361
    • @@ -43,24 +43,24 @@

    idid: string

    +
  • Defined in src/framework/contrib/configuration.ts:353

    • schema

    schema: UiSchema
    +
  • Defined in src/framework/contrib/configuration.ts:363

    • titlePath

    titlePath: string[]
    +
  • Defined in src/framework/contrib/configuration.ts:354

    • type

    type: "property"
    +
  • Defined in src/framework/contrib/configuration.ts:362
    • diff --git a/docs/interfaces/contrib.DataView.html b/docs/interfaces/contrib.DataView.html index d8270d2..37e2fe1 100644 --- a/docs/interfaces/contrib.DataView.html +++ b/docs/interfaces/contrib.DataView.html @@ -28,7 +28,7 @@

    Hierarchy

    • DataView
    +
  • Defined in src/framework/contrib/data-views.ts:34
    • @@ -49,7 +49,7 @@

    Properties

    component

    component: Element
    +
  • Defined in src/framework/contrib/data-views.ts:36

    • dispose

    dispose: (() => void)
    @@ -63,30 +63,30 @@

    Type declaration

    Returns void

    +
  • Defined in src/framework/util/disposable.ts:11

    • Optional icon

    icon?: string
    +
  • Defined in src/framework/contrib/data-views.ts:23

    • id

    id: string
    +
  • Defined in src/framework/contrib/data-views.ts:35

    • title

    title: string
    +
  • Defined in src/framework/contrib/data-views.ts:22

    • viewType

    viewType: string
    +
  • Defined in src/framework/contrib/data-views.ts:21
    • diff --git a/docs/interfaces/contrib.DataViewManifestEntry.html b/docs/interfaces/contrib.DataViewManifestEntry.html index 3f8470c..c77d37e 100644 --- a/docs/interfaces/contrib.DataViewManifestEntry.html +++ b/docs/interfaces/contrib.DataViewManifestEntry.html @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in src/framework/contrib/data-views.ts:20
    • @@ -45,17 +45,17 @@

    Properties

    Optional icon

    icon?: string
    +
  • Defined in src/framework/contrib/data-views.ts:23

    • title

    title: string
    +
  • Defined in src/framework/contrib/data-views.ts:22

    • viewType

    viewType: string
    +
  • Defined in src/framework/contrib/data-views.ts:21
    • diff --git a/docs/interfaces/contrib.DataViewProvider.html b/docs/interfaces/contrib.DataViewProvider.html index e25774d..ef1cb40 100644 --- a/docs/interfaces/contrib.DataViewProvider.html +++ b/docs/interfaces/contrib.DataViewProvider.html @@ -25,7 +25,7 @@

    Hierarchy

    • DataViewProvider
    +
  • Defined in src/framework/contrib/data-views.ts:42
    • @@ -49,7 +49,7 @@

    Parameters

    dataViewType: DataViewType

    Returns DataView

    +
  • Defined in src/framework/contrib/data-views.ts:43
    • diff --git a/docs/interfaces/contrib.DataViewType.html b/docs/interfaces/contrib.DataViewType.html index 2ab5d4c..b00066e 100644 --- a/docs/interfaces/contrib.DataViewType.html +++ b/docs/interfaces/contrib.DataViewType.html @@ -29,7 +29,7 @@

    Hierarchy

    +
  • Defined in src/framework/contrib/data-views.ts:29
    • @@ -48,19 +48,19 @@

    Optionalicon?: string

    +
  • Defined in src/framework/contrib/data-views.ts:23

    • title

    title: string
    +
  • Defined in src/framework/contrib/data-views.ts:22

    • viewType

    viewType: string
    +
  • Defined in src/framework/contrib/data-views.ts:21
    • diff --git a/docs/interfaces/contrib.Keybinding.html b/docs/interfaces/contrib.Keybinding.html index de6b4a1..d626248 100644 --- a/docs/interfaces/contrib.Keybinding.html +++ b/docs/interfaces/contrib.Keybinding.html @@ -23,7 +23,7 @@

    Hierarchy

    • Keybinding
    +
  • Defined in src/framework/contrib/keybindings.ts:29
    • @@ -44,30 +44,30 @@

    Optionalargs?: (null | string | number | boolean)[]

    +
  • Defined in src/framework/contrib/keybindings.ts:20

    • command

    command: string
    +
  • Defined in src/framework/contrib/keybindings.ts:17

    • key

    key: string
    +
  • Defined in src/framework/contrib/keybindings.ts:21

    • Optional mac

    mac?: string
    +
  • Defined in src/framework/contrib/keybindings.ts:22

    • Optional when

    when?: When
    +
  • Defined in src/framework/contrib/keybindings.ts:30
    • diff --git a/docs/interfaces/contrib.KeybindingManifestEntry.html b/docs/interfaces/contrib.KeybindingManifestEntry.html index c3bfd67..f579f4b 100644 --- a/docs/interfaces/contrib.KeybindingManifestEntry.html +++ b/docs/interfaces/contrib.KeybindingManifestEntry.html @@ -23,7 +23,7 @@

    Hierarchy

    • KeybindingManifestEntry
    +
  • Defined in src/framework/contrib/keybindings.ts:25
    • @@ -44,30 +44,30 @@

    Optionalargs?: (null | string | number | boolean)[]

    +
  • Defined in src/framework/contrib/keybindings.ts:20

    • command

    command: string
    +
  • Defined in src/framework/contrib/keybindings.ts:17

    • key

    key: string
    +
  • Defined in src/framework/contrib/keybindings.ts:21

    • Optional mac

    mac?: string
    +
  • Defined in src/framework/contrib/keybindings.ts:22

    • Optional when

    when?: string
    +
  • Defined in src/framework/contrib/keybindings.ts:26
    • diff --git a/docs/interfaces/contrib.MenuItem.html b/docs/interfaces/contrib.MenuItem.html index 9dcc7af..975c12d 100644 --- a/docs/interfaces/contrib.MenuItem.html +++ b/docs/interfaces/contrib.MenuItem.html @@ -23,7 +23,7 @@

    Hierarchy

    • MenuItem
    +
  • Defined in src/framework/contrib/menus.ts:53
    • @@ -50,64 +50,64 @@

    Optionalargs?: (null | string | number | boolean)[]

    +
  • Defined in src/framework/contrib/menus.ts:30

    • Optional checked

    checked?: boolean
    +
  • Defined in src/framework/contrib/menus.ts:55

    • Optional command

    command?: string
    +
  • Defined in src/framework/contrib/menus.ts:27

    • Optional disabled

    disabled?: boolean
    +
  • Defined in src/framework/contrib/menus.ts:54

    • group

    group: string
    +
  • Defined in src/framework/contrib/menus.ts:43

    • Optional icon

    icon?: string
    +
  • Defined in src/framework/contrib/menus.ts:33

    • id

    id: string
    +
  • Defined in src/framework/contrib/menus.ts:41

    • Optional keybinding

    keybinding?: Keybinding
    +
  • Defined in src/framework/contrib/menus.ts:56

    • label

    label: string
    +
  • Defined in src/framework/contrib/menus.ts:42

    • order

    order: number
    +
  • Defined in src/framework/contrib/menus.ts:44

    • Optional submenu

    submenu?: string
    +
  • Defined in src/framework/contrib/menus.ts:26
    • diff --git a/docs/interfaces/contrib.MenuItemManifestEntry.html b/docs/interfaces/contrib.MenuItemManifestEntry.html index 1bfd5fa..a194253 100644 --- a/docs/interfaces/contrib.MenuItemManifestEntry.html +++ b/docs/interfaces/contrib.MenuItemManifestEntry.html @@ -23,7 +23,7 @@

    Hierarchy

    • MenuItemManifestEntry
    +
  • Defined in src/framework/contrib/menus.ts:36
    • @@ -46,42 +46,42 @@

    Optionalargs?: (null | string | number | boolean)[]

    +
  • Defined in src/framework/contrib/menus.ts:30

    • Optional command

    command?: string
    +
  • Defined in src/framework/contrib/menus.ts:27

    • Optional group

    group?: string
    +
  • Defined in src/framework/contrib/menus.ts:32

    • Optional icon

    icon?: string
    +
  • Defined in src/framework/contrib/menus.ts:33

    • Optional label

    label?: string
    +
  • Defined in src/framework/contrib/menus.ts:31

    • Optional submenu

    submenu?: string
    +
  • Defined in src/framework/contrib/menus.ts:26

    • Optional when

    when?: string
    +
  • Defined in src/framework/contrib/menus.ts:37
    • diff --git a/docs/interfaces/contrib.StatusBarItem.html b/docs/interfaces/contrib.StatusBarItem.html index 327f828..00df54f 100644 --- a/docs/interfaces/contrib.StatusBarItem.html +++ b/docs/interfaces/contrib.StatusBarItem.html @@ -21,7 +21,7 @@

    Hierarchy

    • StatusBarItem
    +
  • Defined in src/framework/contrib/status-bar-items.ts:12
    • @@ -40,22 +40,22 @@

    Properties

    component

    component: Element
    +
  • Defined in src/framework/contrib/status-bar-items.ts:16

    • id

    id: string
    +
  • Defined in src/framework/contrib/status-bar-items.ts:13

    • Optional order

    order?: number
    +
  • Defined in src/framework/contrib/status-bar-items.ts:15

    • position

    position: "right" | "left"
    +
  • Defined in src/framework/contrib/status-bar-items.ts:14
    • diff --git a/docs/interfaces/contrib.StoreProvider.html b/docs/interfaces/contrib.StoreProvider.html index 2e2081c..22b4b45 100644 --- a/docs/interfaces/contrib.StoreProvider.html +++ b/docs/interfaces/contrib.StoreProvider.html @@ -26,7 +26,7 @@

    Hierarchy

    • StoreProvider
    +
  • Defined in src/framework/contrib/stores.ts:11
    • @@ -47,7 +47,7 @@

    Properties

    id

    id: string
    +
  • Defined in src/framework/contrib/stores.ts:12

    • Methods

    @@ -57,7 +57,7 @@

    getSnapshot

    Returns T

    +
  • Defined in src/framework/contrib/stores.ts:14

    • subscribe

      @@ -82,7 +82,7 @@

      Returns (

      Returns void

    +
  • Defined in src/framework/contrib/stores.ts:13
    • diff --git a/docs/interfaces/contrib.Submenu.html b/docs/interfaces/contrib.Submenu.html index 32699ba..36f4e58 100644 --- a/docs/interfaces/contrib.Submenu.html +++ b/docs/interfaces/contrib.Submenu.html @@ -23,7 +23,7 @@

    Hierarchy

    • Submenu
    +
  • Defined in src/framework/contrib/submenus.ts:20
    • @@ -41,13 +41,13 @@

    idid: string

    +
  • Defined in src/framework/contrib/submenus.ts:16

    • label

    label: string
    +
  • Defined in src/framework/contrib/submenus.ts:17
    • diff --git a/docs/interfaces/contrib.SubmenuManifestEntry.html b/docs/interfaces/contrib.SubmenuManifestEntry.html index 09d128f..027655d 100644 --- a/docs/interfaces/contrib.SubmenuManifestEntry.html +++ b/docs/interfaces/contrib.SubmenuManifestEntry.html @@ -23,7 +23,7 @@

    Hierarchy

    +
  • Defined in src/framework/contrib/submenus.ts:15
    • @@ -40,12 +40,12 @@

    Properties

    id

    id: string
    +
  • Defined in src/framework/contrib/submenus.ts:16

    • label

    label: string
    +
  • Defined in src/framework/contrib/submenus.ts:17
    • diff --git a/docs/interfaces/contrib.ToolView.html b/docs/interfaces/contrib.ToolView.html index 71e85cf..c321d95 100644 --- a/docs/interfaces/contrib.ToolView.html +++ b/docs/interfaces/contrib.ToolView.html @@ -23,7 +23,7 @@

    Hierarchy

    +
  • Defined in src/framework/contrib/tool-views.ts:21
    • @@ -41,17 +41,17 @@

    Properties

    Optional icon

    icon?: string
    +
  • Defined in src/framework/contrib/tool-views.ts:24

    • id

    id: string
    +
  • Defined in src/framework/contrib/tool-views.ts:22

    • Optional title

    title?: string
    +
  • Defined in src/framework/contrib/tool-views.ts:23
    • diff --git a/docs/interfaces/contrib.ToolViewComponentProps.html b/docs/interfaces/contrib.ToolViewComponentProps.html index 270dabe..6e293bf 100644 --- a/docs/interfaces/contrib.ToolViewComponentProps.html +++ b/docs/interfaces/contrib.ToolViewComponentProps.html @@ -21,7 +21,7 @@

    Hierarchy

    • ToolViewComponentProps
    +
  • Defined in src/framework/contrib/tool-views.ts:116
    • @@ -37,7 +37,7 @@

    Properties

    viewId

    viewId: string
    +
  • Defined in src/framework/contrib/tool-views.ts:117
    • diff --git a/docs/interfaces/contrib.ToolViewManifestEntry.html b/docs/interfaces/contrib.ToolViewManifestEntry.html index 5c985b6..4ca5499 100644 --- a/docs/interfaces/contrib.ToolViewManifestEntry.html +++ b/docs/interfaces/contrib.ToolViewManifestEntry.html @@ -23,7 +23,7 @@

    Hierarchy

    • ToolViewManifestEntry
    +
  • Defined in src/framework/contrib/tool-views.ts:27
    • @@ -43,24 +43,24 @@

    Optionalicon?: string

    +
  • Defined in src/framework/contrib/tool-views.ts:24

    • id

    id: string
    +
  • Defined in src/framework/contrib/tool-views.ts:22

    • Optional title

    title?: string
    +
  • Defined in src/framework/contrib/tool-views.ts:23

    • Optional when

    when?: string
    +
  • Defined in src/framework/contrib/tool-views.ts:28
    • diff --git a/docs/interfaces/core.CodeContribution.html b/docs/interfaces/core.CodeContribution.html index f85aaf8..1bc21fb 100644 --- a/docs/interfaces/core.CodeContribution.html +++ b/docs/interfaces/core.CodeContribution.html @@ -34,7 +34,7 @@

    Hierarchy

    • CodeContribution
    +
  • Defined in src/framework/core/types.ts:283
    • @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:294

    • Optional error

    error?: unknown
    @@ -64,7 +64,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:298

    • loading

    loading: boolean
    @@ -74,7 +74,7 @@

    loading

    +
  • Defined in src/framework/core/types.ts:289
    • diff --git a/docs/interfaces/core.CodeContributionInfo.html b/docs/interfaces/core.CodeContributionInfo.html index 83bb558..6a23c70 100644 --- a/docs/interfaces/core.CodeContributionInfo.html +++ b/docs/interfaces/core.CodeContributionInfo.html @@ -35,7 +35,7 @@

    Hierarchy

    • CodeContributionInfo
    +
  • Defined in src/framework/core/types.ts:247
    • @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:273

    • Optional idKey

    idKey?: KeyOfObjOrArrayItem<TS>
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:256
    • diff --git a/docs/interfaces/core.ContributionPoint.html b/docs/interfaces/core.ContributionPoint.html index 71cba85..51d5ffe 100644 --- a/docs/interfaces/core.ContributionPoint.html +++ b/docs/interfaces/core.ContributionPoint.html @@ -42,7 +42,7 @@

    Hierarchy

    • ContributionPoint
    +
  • Defined in src/framework/core/types.ts:184
    • @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:205

    • Optional description

    description?: string
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:192

    • id

    id: string
    @@ -82,7 +82,7 @@

    id

    +
  • Defined in src/framework/core/types.ts:188

    • Optional manifestInfo

    manifestInfo?: ManifestContributionInfo<TM, TS>
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:199
    • diff --git a/docs/interfaces/core.Extension.html b/docs/interfaces/core.Extension.html index 76cf486..1aa2bc8 100644 --- a/docs/interfaces/core.Extension.html +++ b/docs/interfaces/core.Extension.html @@ -35,7 +35,7 @@

    Hierarchy

    • Extension
    +
  • Defined in src/framework/core/types.ts:59
    • @@ -61,7 +61,7 @@

    Readonly

    +
  • Defined in src/framework/core/types.ts:76

    • Readonly id

    id: string
    @@ -69,7 +69,7 @@

    Readonly

    +
  • Defined in src/framework/core/types.ts:63

    • Readonly manifest

    manifest: ExtensionManifest
    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in src/framework/core/types.ts:68

    • Optional Readonly reasons

    reasons?: Error[]
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:87

    • Readonly status

    status: ExtensionStatus
    @@ -94,7 +94,7 @@

    Readonly

    +
  • Defined in src/framework/core/types.ts:81
    • diff --git a/docs/interfaces/core.ExtensionContext.html b/docs/interfaces/core.ExtensionContext.html index d70d01b..d6a0725 100644 --- a/docs/interfaces/core.ExtensionContext.html +++ b/docs/interfaces/core.ExtensionContext.html @@ -28,7 +28,7 @@

    Hierarchy

    • ExtensionContext
    +
  • Defined in src/framework/core/types.ts:99
    • @@ -49,7 +49,7 @@

    Readonly

    +
  • Defined in src/framework/core/types.ts:111

    • Readonly modulePath

    modulePath: string
    @@ -57,7 +57,7 @@

    Readonly

    +
  • Defined in src/framework/core/types.ts:116

    • Readonly subscriptions

    subscriptions: DisposableLike[]
    @@ -67,7 +67,7 @@

    Readonly

    +
  • Defined in src/framework/core/types.ts:106
    • diff --git a/docs/interfaces/core.ExtensionListener.html b/docs/interfaces/core.ExtensionListener.html index b0a09d5..25f4f02 100644 --- a/docs/interfaces/core.ExtensionListener.html +++ b/docs/interfaces/core.ExtensionListener.html @@ -26,7 +26,7 @@

    Hierarchy

    • ExtensionListener
    +
  • Defined in src/framework/core/types.ts:147
    • @@ -57,7 +57,7 @@
    extension: Returns void
    +
  • Defined in src/framework/core/types.ts:152

    • Optional onExtensionUnregistered

    +
  • Defined in src/framework/core/types.ts:164

    • Optional onExtensionWillUnregister

    +
  • Defined in src/framework/core/types.ts:158
    • diff --git a/docs/interfaces/core.ExtensionManifest.html b/docs/interfaces/core.ExtensionManifest.html index 447cc9a..d3537f4 100644 --- a/docs/interfaces/core.ExtensionManifest.html +++ b/docs/interfaces/core.ExtensionManifest.html @@ -25,7 +25,7 @@

    Hierarchy

    • ExtensionManifest
    +
  • Defined in src/framework/core/types.ts:14
    • @@ -49,47 +49,47 @@

    Properties

    Optional activationEvents

    activationEvents?: string[]
    +
  • Defined in src/framework/core/types.ts:24

    • Optional contributes

    contributes?: Record<string, unknown>
    +
  • Defined in src/framework/core/types.ts:27

    • Optional description

    description?: string
    +
  • Defined in src/framework/core/types.ts:21

    • Optional displayName

    displayName?: string
    +
  • Defined in src/framework/core/types.ts:20

    • Optional extensionDependencies

    extensionDependencies?: string[]
    +
  • Defined in src/framework/core/types.ts:25

    • Optional main

    main?: string
    +
  • Defined in src/framework/core/types.ts:18

    • name

    name: string
    +
  • Defined in src/framework/core/types.ts:17

    • provider

    provider: string
    +
  • Defined in src/framework/core/types.ts:16

    • Optional version

    version?: string
    +
  • Defined in src/framework/core/types.ts:19
    • diff --git a/docs/interfaces/core.ExtensionModule.html b/docs/interfaces/core.ExtensionModule.html index dfdb57f..b56450b 100644 --- a/docs/interfaces/core.ExtensionModule.html +++ b/docs/interfaces/core.ExtensionModule.html @@ -40,7 +40,7 @@

    Hierarchy

    • ExtensionModule
    +
  • Defined in src/framework/core/types.ts:132
    • @@ -72,7 +72,7 @@
    extensionContext: Rest ...dependencies: unknown[]
    Rest

    Returns ExportedApi

    +
  • Defined in src/framework/core/types.ts:133

    • Optional deactivate

    deactivate?: ((extensionContext) => void | Promise<void>)
    @@ -90,7 +90,7 @@

    Parameters

    extensionContext: ExtensionContext

    Returns void | Promise<void>

    +
  • Defined in src/framework/core/types.ts:138
    • diff --git a/docs/interfaces/core.ExtensionOptions.html b/docs/interfaces/core.ExtensionOptions.html index d59232d..493440d 100644 --- a/docs/interfaces/core.ExtensionOptions.html +++ b/docs/interfaces/core.ExtensionOptions.html @@ -25,7 +25,7 @@

    Hierarchy

    • ExtensionOptions
    +
  • Defined in src/framework/core/types.ts:330
    • @@ -47,7 +47,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:341

    • Optional pathResolver

    pathResolver?: ExtensionPathResolver
    @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:335
    • diff --git a/docs/interfaces/core.FrameworkOptions.html b/docs/interfaces/core.FrameworkOptions.html index 807d3cb..8d67aac 100644 --- a/docs/interfaces/core.FrameworkOptions.html +++ b/docs/interfaces/core.FrameworkOptions.html @@ -25,7 +25,7 @@

    Hierarchy

    • FrameworkOptions
    +
  • Defined in src/framework/core/types.ts:348
    • @@ -44,7 +44,7 @@

    Optional

    +
  • Defined in src/framework/core/types.ts:353
    • diff --git a/docs/interfaces/core.ManifestContributionInfo.html b/docs/interfaces/core.ManifestContributionInfo.html index a57a1e2..042f4b6 100644 --- a/docs/interfaces/core.ManifestContributionInfo.html +++ b/docs/interfaces/core.ManifestContributionInfo.html @@ -43,7 +43,7 @@

    Hierarchy

    • ManifestContributionInfo
    +
  • Defined in src/framework/core/types.ts:222
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in src/framework/core/types.ts:235

    • schema

    schema: AnySchema | JsonTypedSchema<TM>
    @@ -89,7 +89,7 @@

    schema

    +
  • Defined in src/framework/core/types.ts:226
    • diff --git a/docs/interfaces/core.When.html b/docs/interfaces/core.When.html index b316405..2e7f397 100644 --- a/docs/interfaces/core.When.html +++ b/docs/interfaces/core.When.html @@ -44,7 +44,7 @@

    Parameters

    ctx: Record<string, unknown>

    Returns undefined | boolean

    +
  • Defined in src/framework/core/types.ts:315
    • @@ -63,7 +63,7 @@

    clause

    +
  • Defined in src/framework/core/types.ts:317
    • diff --git a/docs/interfaces/util.BooleanUiSchema.html b/docs/interfaces/util.BooleanUiSchema.html index 083e106..48c3db8 100644 --- a/docs/interfaces/util.BooleanUiSchema.html +++ b/docs/interfaces/util.BooleanUiSchema.html @@ -23,7 +23,7 @@

    Hierarchy

    • BooleanUiSchema
    +
  • Defined in src/framework/util/json/ui-schema.ts:64
    • @@ -50,66 +50,66 @@

    Optionalconst?: boolean

    +
  • Defined in src/framework/util/json/ui-schema.ts:48

    • Optional default

    default?: boolean
    +
  • Defined in src/framework/util/json/ui-schema.ts:47

    • Optional description

    description?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:50

    • Optional enum

    enum?: boolean[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:49

    • Optional enumDescriptions

    enumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:54

    • Optional enumItemLabels

    enumItemLabels?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:53

    • Optional hidden

    hidden?: boolean
    +
  • Defined in src/framework/util/json/ui-schema.ts:57

    • Optional markdownDescription

    markdownDescription?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:52

    • Optional markdownEnumDescriptions

    markdownEnumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:55

    • Optional order

    order?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:56

    • type

    type: "boolean"
    +
  • Defined in src/framework/util/json/ui-schema.ts:65
    • diff --git a/docs/interfaces/util.DisposableLike.html b/docs/interfaces/util.DisposableLike.html index 3d838a0..101b959 100644 --- a/docs/interfaces/util.DisposableLike.html +++ b/docs/interfaces/util.DisposableLike.html @@ -31,7 +31,7 @@

    Implemented by

    +
  • Defined in src/framework/util/disposable.ts:10
    • @@ -55,7 +55,7 @@

    Type declaration

  • Returns void

    • +
  • Defined in src/framework/util/disposable.ts:11
    • diff --git a/docs/interfaces/util.JsonObject.html b/docs/interfaces/util.JsonObject.html index 122f3b1..b0b6192 100644 --- a/docs/interfaces/util.JsonObject.html +++ b/docs/interfaces/util.JsonObject.html @@ -28,7 +28,7 @@

    Hierarchy

    Indexable

    [propertyName: string]: JsonValue | undefined
    +
  • Defined in src/framework/util/json/json.ts:24
    • diff --git a/docs/interfaces/util.ListUiSchema.html b/docs/interfaces/util.ListUiSchema.html index 9a88c73..8efaf03 100644 --- a/docs/interfaces/util.ListUiSchema.html +++ b/docs/interfaces/util.ListUiSchema.html @@ -23,7 +23,7 @@

    Hierarchy

    • ListUiSchema
    +
  • Defined in src/framework/util/json/ui-schema.ts:116
    • @@ -53,87 +53,87 @@

    Properties

    Optional additionalItems

    additionalItems?: false
    +
  • Defined in src/framework/util/json/ui-schema.ts:122

    • Optional const

    const?: ListUiValue
    +
  • Defined in src/framework/util/json/ui-schema.ts:48

    • Optional default

    default?: ListUiValue
    +
  • Defined in src/framework/util/json/ui-schema.ts:47

    • Optional description

    description?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:50

    • Optional enum

    enum?: ListUiValue[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:49

    • Optional enumDescriptions

    enumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:54

    • Optional enumItemLabels

    enumItemLabels?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:53

    • Optional hidden

    hidden?: boolean
    +
  • Defined in src/framework/util/json/ui-schema.ts:57

    • items

    items: PrimitiveUiSchema | ObjectUiSchema | TupleUiSchema
    +
  • Defined in src/framework/util/json/ui-schema.ts:118

    • Optional markdownDescription

    markdownDescription?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:52

    • Optional markdownEnumDescriptions

    markdownEnumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:55

    • Optional maxItems

    maxItems?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:120

    • Optional minItems

    minItems?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:119

    • Optional order

    order?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:56

    • type

    type: "array"
    +
  • Defined in src/framework/util/json/ui-schema.ts:117
    • diff --git a/docs/interfaces/util.NumberUiSchema.html b/docs/interfaces/util.NumberUiSchema.html index 976dca2..a0fbb37 100644 --- a/docs/interfaces/util.NumberUiSchema.html +++ b/docs/interfaces/util.NumberUiSchema.html @@ -23,7 +23,7 @@

    Hierarchy

    • NumberUiSchema
    +
  • Defined in src/framework/util/json/ui-schema.ts:68
    • @@ -56,96 +56,96 @@

    Optionalconst?: number

    +
  • Defined in src/framework/util/json/ui-schema.ts:48

    • Optional default

    default?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:47

    • Optional description

    description?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:50

    • Optional enum

    enum?: number[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:49

    • Optional enumDescriptions

    enumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:54

    • Optional enumItemLabels

    enumItemLabels?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:53

    • Optional exclusiveMaximum

    exclusiveMaximum?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:73

    • Optional exclusiveMinimum

    exclusiveMinimum?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:72

    • Optional format

    format?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:75

    • Optional hidden

    hidden?: boolean
    +
  • Defined in src/framework/util/json/ui-schema.ts:57

    • Optional markdownDescription

    markdownDescription?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:52

    • Optional markdownEnumDescriptions

    markdownEnumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:55

    • Optional maximum

    maximum?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:71

    • Optional minimum

    minimum?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:70

    • Optional multipleOf

    multipleOf?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:74

    • Optional order

    order?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:56

    • type

    type: "number" | "integer"
    +
  • Defined in src/framework/util/json/ui-schema.ts:69
    • diff --git a/docs/interfaces/util.ObjectUiSchema.html b/docs/interfaces/util.ObjectUiSchema.html index 118efa6..1ccfd7b 100644 --- a/docs/interfaces/util.ObjectUiSchema.html +++ b/docs/interfaces/util.ObjectUiSchema.html @@ -23,7 +23,7 @@

    Hierarchy

    • ObjectUiSchema
    +
  • Defined in src/framework/util/json/ui-schema.ts:93
    • @@ -52,82 +52,82 @@

    Properties

    additionalProperties

    additionalProperties: false
    +
  • Defined in src/framework/util/json/ui-schema.ts:100

    • Optional const

    const?: Record<string, PrimitiveUiValue | TupleUiValue>
    +
  • Defined in src/framework/util/json/ui-schema.ts:48

    • Optional default

    default?: Record<string, PrimitiveUiValue | TupleUiValue>
    +
  • Defined in src/framework/util/json/ui-schema.ts:47

    • Optional description

    description?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:50

    • Optional enum

    enum?: Record<string, PrimitiveUiValue | TupleUiValue>[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:49

    • Optional enumDescriptions

    enumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:54

    • Optional enumItemLabels

    enumItemLabels?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:53

    • Optional hidden

    hidden?: boolean
    +
  • Defined in src/framework/util/json/ui-schema.ts:57

    • Optional markdownDescription

    markdownDescription?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:52

    • Optional markdownEnumDescriptions

    markdownEnumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:55

    • Optional order

    order?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:56

    • properties

    properties: Record<string, PrimitiveUiSchema | TupleUiSchema>
    +
  • Defined in src/framework/util/json/ui-schema.ts:96

    • Optional required

    required?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:97

    • type

    type: "object"
    +
  • Defined in src/framework/util/json/ui-schema.ts:95
    • diff --git a/docs/interfaces/util.StringUiSchema.html b/docs/interfaces/util.StringUiSchema.html index 49a0090..3d23e89 100644 --- a/docs/interfaces/util.StringUiSchema.html +++ b/docs/interfaces/util.StringUiSchema.html @@ -23,7 +23,7 @@

    Hierarchy

    • StringUiSchema
    +
  • Defined in src/framework/util/json/ui-schema.ts:78
    • @@ -55,91 +55,91 @@

    Optionalconst?: string

    +
  • Defined in src/framework/util/json/ui-schema.ts:48

    • Optional default

    default?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:47

    • Optional description

    description?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:50

    • Optional editPresentation

    editPresentation?: "singlelineText" | "multilineText"
    +
  • Defined in src/framework/util/json/ui-schema.ts:85

    • Optional enum

    enum?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:49

    • Optional enumDescriptions

    enumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:54

    • Optional enumItemLabels

    enumItemLabels?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:53

    • Optional format

    format?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:83

    • Optional hidden

    hidden?: boolean
    +
  • Defined in src/framework/util/json/ui-schema.ts:57

    • Optional markdownDescription

    markdownDescription?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:52

    • Optional markdownEnumDescriptions

    markdownEnumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:55

    • Optional maxLength

    maxLength?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:81

    • Optional minLength

    minLength?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:80

    • Optional order

    order?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:56

    • Optional pattern

    pattern?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:82

    • type

    type: "string"
    +
  • Defined in src/framework/util/json/ui-schema.ts:79
    • diff --git a/docs/interfaces/util.TupleUiSchema.html b/docs/interfaces/util.TupleUiSchema.html index 16b169c..2d6e6be 100644 --- a/docs/interfaces/util.TupleUiSchema.html +++ b/docs/interfaces/util.TupleUiSchema.html @@ -23,7 +23,7 @@

    Hierarchy

    • TupleUiSchema
    +
  • Defined in src/framework/util/json/ui-schema.ts:103
    • @@ -52,82 +52,82 @@

    Properties

    Optional additionalItems

    additionalItems?: false
    +
  • Defined in src/framework/util/json/ui-schema.ts:111

    • Optional const

    const?: TupleUiValue
    +
  • Defined in src/framework/util/json/ui-schema.ts:48

    • Optional default

    default?: TupleUiValue
    +
  • Defined in src/framework/util/json/ui-schema.ts:47

    • Optional description

    description?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:50

    • Optional enum

    enum?: TupleUiValue[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:49

    • Optional enumDescriptions

    enumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:54

    • Optional enumItemLabels

    enumItemLabels?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:53

    • Optional hidden

    hidden?: boolean
    +
  • Defined in src/framework/util/json/ui-schema.ts:57

    • items

    items: [PrimitiveUiSchema, ...PrimitiveUiSchema[]]
    +
  • Defined in src/framework/util/json/ui-schema.ts:107

    • Optional markdownDescription

    markdownDescription?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:52

    • Optional markdownEnumDescriptions

    markdownEnumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:55

    • Optional order

    order?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:56

    • Optional tupleItemLabels

    tupleItemLabels?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:113

    • type

    type: "array"
    +
  • Defined in src/framework/util/json/ui-schema.ts:104
    • diff --git a/docs/interfaces/util.UiSchemaBase.html b/docs/interfaces/util.UiSchemaBase.html index deae09d..c873ee9 100644 --- a/docs/interfaces/util.UiSchemaBase.html +++ b/docs/interfaces/util.UiSchemaBase.html @@ -33,7 +33,7 @@

    Hierarchy

  • TupleUiSchema
  • ListUiSchema
    • +
  • Defined in src/framework/util/json/ui-schema.ts:44
    • @@ -58,52 +58,52 @@

    Properties

    Optional const

    const?: Value
    +
  • Defined in src/framework/util/json/ui-schema.ts:48

    • Optional default

    default?: Value
    +
  • Defined in src/framework/util/json/ui-schema.ts:47

    • Optional description

    description?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:50

    • Optional enum

    enum?: Value[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:49

    • Optional enumDescriptions

    enumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:54

    • Optional enumItemLabels

    enumItemLabels?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:53

    • Optional hidden

    hidden?: boolean
    +
  • Defined in src/framework/util/json/ui-schema.ts:57

    • Optional markdownDescription

    markdownDescription?: string
    +
  • Defined in src/framework/util/json/ui-schema.ts:52

    • Optional markdownEnumDescriptions

    markdownEnumDescriptions?: string[]
    +
  • Defined in src/framework/util/json/ui-schema.ts:55

    • Optional order

    order?: number
    +
  • Defined in src/framework/util/json/ui-schema.ts:56
    • diff --git a/docs/interfaces/util.expr.ParserOptions.html b/docs/interfaces/util.expr.ParserOptions.html index 96c0af6..5e2a3ae 100644 --- a/docs/interfaces/util.expr.ParserOptions.html +++ b/docs/interfaces/util.expr.ParserOptions.html @@ -26,7 +26,7 @@

    Hierarchy

    • ParserOptions
    +
  • Defined in src/framework/util/expr/parser.ts:32
    • @@ -51,7 +51,7 @@

    Optional

    +
  • Defined in src/framework/util/expr/parser.ts:40
    • diff --git a/docs/modules/contrib.html b/docs/modules/contrib.html index 9f0a693..9a1cb80 100644 --- a/docs/modules/contrib.html +++ b/docs/modules/contrib.html @@ -16,7 +16,7 @@
  • contrib

    • Module contrib

    +
  • Defined in src/framework/contrib/index.ts:1

    • Index

    diff --git a/docs/modules/core.html b/docs/modules/core.html index e3d4473..275f77f 100644 --- a/docs/modules/core.html +++ b/docs/modules/core.html @@ -16,7 +16,7 @@
  • core

    • Module core

    +
  • Defined in src/framework/core/index.ts:1

    • Index

    diff --git a/docs/modules/react.html b/docs/modules/react.html index b0b7cb0..f896826 100644 --- a/docs/modules/react.html +++ b/docs/modules/react.html @@ -16,7 +16,7 @@
  • react

    • Module react

    +
  • Defined in src/framework/react/index.ts:1

    • Index

    diff --git a/docs/modules/util.expr.html b/docs/modules/util.expr.html index 5f2b40c..0c6dd03 100644 --- a/docs/modules/util.expr.html +++ b/docs/modules/util.expr.html @@ -17,7 +17,7 @@
  • expr

    • Namespace expr

    +
  • Defined in src/framework/util/expr/index.ts:1

    • Index

    diff --git a/docs/modules/util.html b/docs/modules/util.html index 35feef4..366b629 100644 --- a/docs/modules/util.html +++ b/docs/modules/util.html @@ -16,7 +16,7 @@
  • util

    • Module util

    +
  • Defined in src/framework/util/index.ts:1

    • Index

    diff --git a/docs/modules/util.log.html b/docs/modules/util.log.html index d39e4e0..86d9f13 100644 --- a/docs/modules/util.log.html +++ b/docs/modules/util.log.html @@ -17,7 +17,7 @@
  • log

    • Namespace log

    +
  • Defined in src/framework/util/log/index.ts:1

    • Index

    diff --git a/docs/types/contrib.CommandFn.html b/docs/types/contrib.CommandFn.html index 4e60451..5a0203b 100644 --- a/docs/types/contrib.CommandFn.html +++ b/docs/types/contrib.CommandFn.html @@ -38,7 +38,7 @@

    Parameters

    Rest ...args: A
    Rest

    Returns T

    +
  • Defined in src/framework/contrib/commands.ts:95
    • diff --git a/docs/types/contrib.Configuration.html b/docs/types/contrib.Configuration.html index 7f80266..ed0ebf0 100644 --- a/docs/types/contrib.Configuration.html +++ b/docs/types/contrib.Configuration.html @@ -18,7 +18,7 @@

    Type alias Configuration

    Configuration: ConfigurationCategory | ConfigurationCategory[]
    +
  • Defined in src/framework/contrib/configuration.ts:32
    • diff --git a/docs/types/contrib.ConfigurationItem.html b/docs/types/contrib.ConfigurationItem.html index dabf252..7573cc8 100644 --- a/docs/types/contrib.ConfigurationItem.html +++ b/docs/types/contrib.ConfigurationItem.html @@ -18,7 +18,7 @@

    Type alias ConfigurationItem

    ConfigurationItem: ConfigurationHeaderItem | ConfigurationPropertyItem
    +
  • Defined in src/framework/contrib/configuration.ts:366
    • diff --git a/docs/types/contrib.ConfigurationManifestEntry.html b/docs/types/contrib.ConfigurationManifestEntry.html index 940e8df..1aea5df 100644 --- a/docs/types/contrib.ConfigurationManifestEntry.html +++ b/docs/types/contrib.ConfigurationManifestEntry.html @@ -18,7 +18,7 @@

    Type alias ConfigurationManifestEntry

    ConfigurationManifestEntry: Configuration
    +
  • Defined in src/framework/contrib/configuration.ts:33
    • diff --git a/docs/types/core.ExtensionPathResolver.html b/docs/types/core.ExtensionPathResolver.html index 9245052..84cc7b4 100644 --- a/docs/types/core.ExtensionPathResolver.html +++ b/docs/types/core.ExtensionPathResolver.html @@ -34,7 +34,7 @@
    path: Returns string
    +
  • Defined in src/framework/core/types.ts:324
    • diff --git a/docs/types/core.ExtensionStatus.html b/docs/types/core.ExtensionStatus.html index 7217ba6..ee50d07 100644 --- a/docs/types/core.ExtensionStatus.html +++ b/docs/types/core.ExtensionStatus.html @@ -21,7 +21,7 @@

    Type alias ExtensionStatus

    +
  • Defined in src/framework/core/types.ts:42
    • diff --git a/docs/types/util.JsonArray.html b/docs/types/util.JsonArray.html index ebe1aeb..da2de16 100644 --- a/docs/types/util.JsonArray.html +++ b/docs/types/util.JsonArray.html @@ -21,7 +21,7 @@

    Type alias JsonArray

    +
  • Defined in src/framework/util/json/json.ts:38
    • diff --git a/docs/types/util.JsonMetaSchema.html b/docs/types/util.JsonMetaSchema.html index 3ce9425..e9f185e 100644 --- a/docs/types/util.JsonMetaSchema.html +++ b/docs/types/util.JsonMetaSchema.html @@ -18,7 +18,7 @@

    Type alias JsonMetaSchema

    JsonMetaSchema: typeof jsonMetaSchema
    +
  • Defined in src/framework/util/json/json-meta-schema.ts:17
    • diff --git a/docs/types/util.JsonSchema.html b/docs/types/util.JsonSchema.html index a942d98..7882f9c 100644 --- a/docs/types/util.JsonSchema.html +++ b/docs/types/util.JsonSchema.html @@ -18,7 +18,7 @@

    Type alias JsonSchema

    JsonSchema: AnySchema
    +
  • Defined in src/framework/util/json/json-schema.ts:9
    • diff --git a/docs/types/util.JsonTypedSchema.html b/docs/types/util.JsonTypedSchema.html index 610e509..d144e1c 100644 --- a/docs/types/util.JsonTypedSchema.html +++ b/docs/types/util.JsonTypedSchema.html @@ -23,7 +23,7 @@

    Type Parameters

  • T

    • +
  • Defined in src/framework/util/json/json-schema.ts:10
    • diff --git a/docs/types/util.JsonValue.html b/docs/types/util.JsonValue.html index 04055e0..fd48774 100644 --- a/docs/types/util.JsonValue.html +++ b/docs/types/util.JsonValue.html @@ -21,7 +21,7 @@

    Type alias JsonValue

    +
  • Defined in src/framework/util/json/json.ts:13
    • diff --git a/docs/types/util.ListUiValue.html b/docs/types/util.ListUiValue.html index fd8531c..6b56e2f 100644 --- a/docs/types/util.ListUiValue.html +++ b/docs/types/util.ListUiValue.html @@ -22,7 +22,7 @@

    Type alias ListUiValue

    +
  • Defined in src/framework/util/json/ui-schema.ts:28
    • diff --git a/docs/types/util.ObjectUiValue.html b/docs/types/util.ObjectUiValue.html index 214aa42..40b41f9 100644 --- a/docs/types/util.ObjectUiValue.html +++ b/docs/types/util.ObjectUiValue.html @@ -22,7 +22,7 @@

    Type alias ObjectUiValue

    +
  • Defined in src/framework/util/json/ui-schema.ts:16
    • diff --git a/docs/types/util.PrimitiveUiSchema.html b/docs/types/util.PrimitiveUiSchema.html index d133421..7be355d 100644 --- a/docs/types/util.PrimitiveUiSchema.html +++ b/docs/types/util.PrimitiveUiSchema.html @@ -18,7 +18,7 @@

    Type alias PrimitiveUiSchema

    PrimitiveUiSchema: BooleanUiSchema | NumberUiSchema | StringUiSchema
    +
  • Defined in src/framework/util/json/ui-schema.ts:88
    • diff --git a/docs/types/util.PrimitiveUiValue.html b/docs/types/util.PrimitiveUiValue.html index 7158414..faf8146 100644 --- a/docs/types/util.PrimitiveUiValue.html +++ b/docs/types/util.PrimitiveUiValue.html @@ -21,7 +21,7 @@

    Type alias PrimitiveUiValue

    +
  • Defined in src/framework/util/json/ui-schema.ts:10
    • diff --git a/docs/types/util.Selector.html b/docs/types/util.Selector.html index 37586c4..eba6609 100644 --- a/docs/types/util.Selector.html +++ b/docs/types/util.Selector.html @@ -50,7 +50,7 @@

    Returns

    +
  • Defined in src/framework/util/selector.ts:17
    • diff --git a/docs/types/util.TupleUiValue.html b/docs/types/util.TupleUiValue.html index 69a8fdd..4155f8b 100644 --- a/docs/types/util.TupleUiValue.html +++ b/docs/types/util.TupleUiValue.html @@ -22,7 +22,7 @@

    Type alias TupleUiValue

    +
  • Defined in src/framework/util/json/ui-schema.ts:22
    • diff --git a/docs/types/util.UiSchema.html b/docs/types/util.UiSchema.html index e9af44c..9d95fbb 100644 --- a/docs/types/util.UiSchema.html +++ b/docs/types/util.UiSchema.html @@ -18,7 +18,7 @@

    Type alias UiSchema

    UiSchema: PrimitiveUiSchema | ObjectUiSchema | TupleUiSchema | ListUiSchema
    +
  • Defined in src/framework/util/json/ui-schema.ts:125
    • diff --git a/docs/types/util.UiValue.html b/docs/types/util.UiValue.html index 45a5eef..f624916 100644 --- a/docs/types/util.UiValue.html +++ b/docs/types/util.UiValue.html @@ -21,7 +21,7 @@

    Type alias UiValue

    +
  • Defined in src/framework/util/json/ui-schema.ts:38
    • diff --git a/docs/types/util.expr.EvalContext.html b/docs/types/util.expr.EvalContext.html index 997156d..39d8034 100644 --- a/docs/types/util.expr.EvalContext.html +++ b/docs/types/util.expr.EvalContext.html @@ -22,7 +22,7 @@

    Type alias EvalContext

    +
  • Defined in src/framework/util/expr/node.ts:12
    • diff --git a/docs/variables/contrib.commandsPoint.html b/docs/variables/contrib.commandsPoint.html index bf09c97..9f5f0d1 100644 --- a/docs/variables/contrib.commandsPoint.html +++ b/docs/variables/contrib.commandsPoint.html @@ -23,7 +23,7 @@

    Variable commandsPointConst

    <
    +
  • Defined in src/framework/contrib/commands.ts:80
    • diff --git a/docs/variables/contrib.configurationPoint.html b/docs/variables/contrib.configurationPoint.html index 5ef6cb6..6ef9c96 100644 --- a/docs/variables/contrib.configurationPoint.html +++ b/docs/variables/contrib.configurationPoint.html @@ -23,7 +23,7 @@

    Variable configurationPointConst <

    +
  • Defined in src/framework/contrib/configuration.ts:74
    • diff --git a/docs/variables/contrib.dataViewsPoint.html b/docs/variables/contrib.dataViewsPoint.html index 24dc437..e1e798b 100644 --- a/docs/variables/contrib.dataViewsPoint.html +++ b/docs/variables/contrib.dataViewsPoint.html @@ -23,7 +23,7 @@

    Variable dataViewsPointConst

    +
  • Defined in src/framework/contrib/data-views.ts:69
    • diff --git a/docs/variables/contrib.keybindingsPoint.html b/docs/variables/contrib.keybindingsPoint.html index 478b750..d26289e 100644 --- a/docs/variables/contrib.keybindingsPoint.html +++ b/docs/variables/contrib.keybindingsPoint.html @@ -23,7 +23,7 @@

    Variable keybindingsPointConst

    +
  • Defined in src/framework/contrib/keybindings.ts:83
    • diff --git a/docs/variables/contrib.menusPoint.html b/docs/variables/contrib.menusPoint.html index e612d43..dd6b596 100644 --- a/docs/variables/contrib.menusPoint.html +++ b/docs/variables/contrib.menusPoint.html @@ -23,7 +23,7 @@

    Variable menusPointConst

    +
  • Defined in src/framework/contrib/menus.ts:116
    • diff --git a/docs/variables/contrib.statusBarItemsPoint.html b/docs/variables/contrib.statusBarItemsPoint.html index d601448..3761e92 100644 --- a/docs/variables/contrib.statusBarItemsPoint.html +++ b/docs/variables/contrib.statusBarItemsPoint.html @@ -23,7 +23,7 @@

    Variable statusBarItemsPointConst

    +
  • Defined in src/framework/contrib/status-bar-items.ts:26
    • diff --git a/docs/variables/contrib.storesPoint.html b/docs/variables/contrib.storesPoint.html index dbfd13c..a2ecb4c 100644 --- a/docs/variables/contrib.storesPoint.html +++ b/docs/variables/contrib.storesPoint.html @@ -18,7 +18,7 @@

    Variable storesPointConst

    storesPoint: ContributionPoint = ...
    +
  • Defined in src/framework/contrib/stores.ts:17
    • diff --git a/docs/variables/contrib.submenusPoint.html b/docs/variables/contrib.submenusPoint.html index c6ad7f7..7187b4d 100644 --- a/docs/variables/contrib.submenusPoint.html +++ b/docs/variables/contrib.submenusPoint.html @@ -23,7 +23,7 @@

    Variable submenusPointConst

    <
    +
  • Defined in src/framework/contrib/submenus.ts:46
    • diff --git a/docs/variables/contrib.toolViewsPoint.html b/docs/variables/contrib.toolViewsPoint.html index 0ae76ef..7936c2f 100644 --- a/docs/variables/contrib.toolViewsPoint.html +++ b/docs/variables/contrib.toolViewsPoint.html @@ -23,7 +23,7 @@

    Variable toolViewsPointConst

    +
  • Defined in src/framework/contrib/tool-views.ts:63
    • diff --git a/docs/variables/util.jsonMetaSchema-1.html b/docs/variables/util.jsonMetaSchema-1.html index c2fe445..7b66822 100644 --- a/docs/variables/util.jsonMetaSchema-1.html +++ b/docs/variables/util.jsonMetaSchema-1.html @@ -23,7 +23,7 @@

    Type declaration

  • $ref: string
    • +
  • Defined in src/framework/util/json/json-meta-schema.ts:9
    • diff --git a/package-lock.json b/package-lock.json index cc095f9..9c84e0e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@forman2/extendit", - "version": "0.1.0-alpha.0", + "version": "0.1.0-alpha.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@forman2/extendit", - "version": "0.1.0-alpha.0", + "version": "0.1.0-alpha.2", "license": "MIT", "dependencies": { "ajv": "^8.12.0", diff --git a/package.json b/package.json index 572bd6e..6de46c2 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,7 @@ "readme": "README.md", "author": "Norman Fomferra (https://github.com/forman)", "repository": "https://github.com/forman/extendit", + "homepage": "https://forman.github.io/extendit/", "bugs": "https://github.com/forman/extendit/issues", "license": "MIT", "keywords": [