openmct/openmct.js
Jesse Mazzella 4ee68cccd6
docs: better docs and types for the API ()
* docs: fix type imports in openmct.js

* docs: fix type imports

* docs: fix types for eventHelpers

* docs: types for TypeRegistry

* docs: types for StatusAPI

* docs: fix ObjectAPI types and docs

* docs: more types

* docs: improved types for main entry

* docs: improved types

* fix: unbreak the linting

* chore: remove EventEmitter webpack alias as it hide types

* fix: return type

* fix: parameter type

* fix: types for composables

* chore: add webpack consts to eslintrc

* fix: remove usage of deprecated timeAPI methods and add a ton of docs and types

* docs: update README.md

* lint: clean up API.md

* chore: upgrade eventemitter to v5.0.2

* refactor: update imports for EventEmitter to remove alias

* format: lint

* docs: update types for Views and ViewProviders

* docs: expose common types at the base import level

* docs(types): remove unnecessary tsconfig options

* docs: ActionAPI

* docs: AnnotationAPI

* docs: import common types from the same origin

* docs: FormsAPI & TelemetryAPI types

* docs: FormController, IndicatorAPI

* docs: MenuAPI, ActionsAPI

* docs: `@memberof` is not supported by `tsc` and JSDoc generation so remove it

* docs: RootRegistry and RootObjectProvider

* docs: Transaction + Overlay

* lint: words for the word god

* fix: review comments
2024-07-31 10:46:16 -07:00

64 lines
2.6 KiB
JavaScript

/*****************************************************************************
* Open MCT, Copyright (c) 2014-2024, United States Government
* as represented by the Administrator of the National Aeronautics and Space
* Administration. All rights reserved.
*
* Open MCT is licensed under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
* Open MCT includes source code licensed under additional open source
* licenses. See the Open Source Licenses file (LICENSES.md) included with
* this source code distribution or the Licensing information page available
* at runtime from the About dialog for additional information.
*****************************************************************************/
const matcher = /\/openmct.js$/;
if (document.currentScript) {
// @ts-ignore
let src = document.currentScript.src;
if (src && matcher.test(src)) {
// @ts-ignore
__webpack_public_path__ = src.replace(matcher, '') + '/';
}
}
import { MCT } from './src/MCT.js';
const openmct = new MCT();
export default openmct;
/**
* @typedef {MCT} OpenMCT
* @typedef {import('./src/api/objects/ObjectAPI.js').DomainObject} DomainObject
* @typedef {import('./src/api/objects/ObjectAPI.js').Identifier} Identifier
* @typedef {import('./src/api/objects/Transaction.js').default} Transaction
* @typedef {import('./src/api/actions/ActionsAPI.js').Action} Action
* @typedef {import('./src/api/actions/ActionCollection.js').default} ActionCollection
* @typedef {import('./src/api/composition/CompositionCollection.js').default} CompositionCollection
* @typedef {import('./src/api/composition/CompositionProvider.js').default} CompositionProvider
* @typedef {import('./src/ui/registries/ViewRegistry.js').ViewProvider} ViewProvider
* @typedef {import('./src/ui/registries/ViewRegistry.js').View} View
*
* @typedef {DomainObject[]} ObjectPath
* @typedef {(...args: any[]) => (openmct: OpenMCT) => void} OpenMCTPlugin
* An OpenMCT Plugin returns a function that receives an instance of
* the OpenMCT API and uses it to install itself.
*/
/**
* @typedef {Object} BuildInfo
* @property {string} version
* @property {string} buildDate
* @property {string} revision
* @property {string} branch
*/