@openremote/core 1.0.3 → 1.2.0-snapshot.20240512154942

package/dist/index.d.ts

@@ -1,224 +0,0 @@
-import "url-search-params-polyfill";
-import { Console } from "./console";
-import { EventProvider, EventProviderFactory, EventProviderStatus } from "./event";
-import i18next from "i18next";
-import { AssetDescriptor, AttributeDescriptor, AttributeValueDescriptor, MetaItemDescriptor, Attribute, ConsoleAppConfig } from "@openremote/model";
-import * as Util from "./util";
-export { Util };
-export * from "./asset-mixin";
-export * from "./console";
-export * from "./event";
-export * from "./defaults";
-export declare const DEFAULT_ICONSET: string;
-export declare type KeycloakPromise<T> = {
-    success<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | KeycloakPromise<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | KeycloakPromise<TResult2>) | undefined | null): KeycloakPromise<TResult1 | TResult2>;
-    error<TResult = never>(onrejected?: ((reason: any) => TResult | KeycloakPromise<TResult>) | undefined | null): Promise<T | TResult>;
-};
-export declare type Keycloak = {
-    token: string;
-    refreshToken: string;
-    tokenParsed: any;
-    refreshTokenParsed: any;
-    resourceAccess: any;
-    onAuthSuccess: () => void;
-    onAuthError: () => void;
-    init(options?: any): KeycloakPromise<boolean>;
-    login(options?: any): void;
-    hasRealmRole(role: string): boolean;
-    logout(options?: any): void;
-    updateToken(expiry: number): KeycloakPromise<boolean>;
-    clearToken(): void;
-};
-export declare enum ORError {
-    MANAGER_FAILED_TO_LOAD = "MANAGER_FAILED_TO_LOAD",
-    AUTH_FAILED = "AUTH_FAILED",
-    AUTH_TYPE_UNSUPPORTED = "AUTH_TYPE_UNSUPPORTED",
-    CONSOLE_ERROR = "CONSOLE_INIT_ERROR",
-    EVENTS_CONNECTION_ERROR = "EVENTS_CONNECTION_ERROR",
-    TRANSLATION_ERROR = "TRANSLATION_ERROR"
-}
-export declare enum Auth {
-    KEYCLOAK = "KEYCLOAK",
-    BASIC = "BASIC",
-    NONE = "NONE"
-}
-export declare enum OREvent {
-    ERROR = "ERROR",
-    READY = "READY",
-    CONSOLE_INIT = "CONSOLE_INIT",
-    CONSOLE_READY = "CONSOLE_READY",
-    EVENTS_CONNECTED = "EVENTS_CONNECTED",
-    EVENTS_CONNECTING = "EVENTS_CONNECTING",
-    EVENTS_DISCONNECTED = "EVENTS_DISCONNECTED",
-    TRANSLATE_INIT = "TRANSLATE_INIT",
-    TRANSLATE_LANGUAGE_CHANGED = "TRANSLATE_LANGUAGE_CHANGED",
-    DISPLAY_REALM_CHANGED = "DISPLAY_REALM_CHANGED"
-}
-export declare enum EventProviderType {
-    WEBSOCKET = "WEBSOCKET",
-    POLLING = "POLLING"
-}
-export interface Credentials {
-    username: string;
-    password: string;
-}
-export interface LoginOptions {
-    redirectUrl?: string;
-    credentials?: Credentials;
-}
-export interface BasicLoginResult {
-    username: string;
-    password: string;
-    cancel: boolean;
-    closeCallback: undefined | ((authenticated: boolean) => void);
-}
-export declare enum MapType {
-    VECTOR = "VECTOR",
-    RASTER = "RASTER"
-}
-export interface ManagerConfig {
-    managerUrl: string;
-    keycloakUrl?: string;
-    appVersion?: string;
-    auth?: Auth;
-    realm: string;
-    clientId?: string;
-    autoLogin?: boolean;
-    credentials?: Credentials;
-    consoleAutoEnable?: boolean;
-    eventProviderType?: EventProviderType;
-    pollingIntervalMillis?: number;
-    loadIcons?: boolean;
-    loadDescriptors?: boolean;
-    mapType?: MapType;
-    loadTranslations?: string[];
-    translationsLoadPath?: string;
-    configureTranslationsOptions?: (i18next: i18next.InitOptions) => void;
-    basicLoginProvider?: (username: string | undefined, password: string | undefined) => PromiseLike<BasicLoginResult>;
-}
-export declare class IconSetAddedEvent extends CustomEvent<void> {
-    static readonly NAME = "or-iconset-added";
-    constructor();
-}
-export interface OrManagerEventDetail {
-    event: OREvent;
-    error?: ORError;
-}
-declare global {
-    export interface HTMLElementEventMap {
-        [IconSetAddedEvent.NAME]: IconSetAddedEvent;
-    }
-}
-export interface IconSetSvg {
-    size: number;
-    icons: {
-        [name: string]: string;
-    };
-}
-export declare class ORIconSets {
-    private _icons;
-    addIconSet(name: string, iconset: IconSetSvg): void;
-    getIconSet(name: string): IconSetSvg;
-    getIcon(icon: string | undefined): Element | undefined;
-}
-export declare class AssetModelUtil {
-    static _assetDescriptors: AssetDescriptor[];
-    static _attributeDescriptors: AttributeDescriptor[];
-    static _attributeValueDescriptors: AttributeValueDescriptor[];
-    static _metaItemDescriptors: MetaItemDescriptor[];
-    static getAssetDescriptors(): AssetDescriptor[];
-    static getAttributeDescriptors(): AttributeDescriptor[];
-    static getAttributeValueDescriptors(): AttributeValueDescriptor[];
-    static getMetaItemDescriptors(): MetaItemDescriptor[];
-    static getAssetDescriptor(type?: string): AssetDescriptor | undefined;
-    static getAttributeDescriptor(attributeName?: string, assetTypeOrDescriptor?: string | AssetDescriptor): AttributeDescriptor | undefined;
-    static getAttributeValueDescriptor(name?: string, attributeNameOrDescriptor?: string | AttributeDescriptor, assetTypeOrDescriptor?: string | AssetDescriptor): AttributeValueDescriptor | undefined;
-    static getAttributeAndValueDescriptors(assetType: string | undefined, attributeOrNameOrDescriptor: Attribute | string | AttributeDescriptor | undefined): [AttributeDescriptor | undefined, AttributeValueDescriptor | undefined];
-    static getMetaItemDescriptor(urn?: string, attributeNameOrDescriptor?: string | AttributeDescriptor, assetTypeOrDescriptor?: string | AssetDescriptor): MetaItemDescriptor | undefined;
-    static attributeValueDescriptorsMatch(attributeValueDescriptor1: AttributeValueDescriptor, attributeValueDescriptor2: AttributeValueDescriptor): boolean;
-    static getMetaInitialValueFromMetaDescriptors(metaItemUrn: MetaItemDescriptor | string, metaItemDescriptors: MetaItemDescriptor[] | undefined): any | undefined;
-    static getMetaItemDescriptorInitialValue(metaItemDescriptor: MetaItemDescriptor, initialValue: any): MetaItemDescriptor;
-    static getAssetDescriptorColor(descriptor: AssetDescriptor | undefined, fallbackColor?: string): string | undefined;
-    static getAssetDescriptorIcon(descriptor: AssetDescriptor | undefined, fallbackIcon?: string): string | undefined;
-    static hasMetaItem(descriptor: AttributeDescriptor | undefined, name: string): boolean;
-}
-export declare type EventCallback = (event: OREvent) => any;
-export declare class Manager implements EventProviderFactory {
-    get username(): string;
-    get error(): ORError | undefined;
-    get authenticated(): boolean;
-    get ready(): boolean;
-    get config(): ManagerConfig;
-    get roles(): Map<string, string[]>;
-    get managerVersion(): string;
-    get isManagerAvailable(): boolean | "";
-    get managerUrl(): string;
-    get keycloakUrl(): string | undefined;
-    get isError(): boolean;
-    get connectionStatus(): EventProviderStatus | undefined;
-    get console(): Console;
-    get consoleAppConfig(): ConsoleAppConfig | undefined;
-    get events(): EventProvider | undefined;
-    get rest(): import("@openremote/rest").RestApi;
-    get language(): string;
-    set language(lang: string);
-    get displayRealm(): string;
-    set displayRealm(realm: string);
-    getEventProvider(): EventProvider | undefined;
-    get mapType(): MapType.VECTOR | MapType;
-    protected static normaliseConfig(config: ManagerConfig): ManagerConfig;
-    private _error?;
-    private _config;
-    private _authenticated;
-    private _ready;
-    private _readyCallback?;
-    private _name;
-    private _username;
-    private _keycloak?;
-    private _basicIdentity?;
-    private _keycloakUpdateTokenInterval?;
-    private _managerVersion;
-    private _listeners;
-    private _console;
-    private _consoleAppConfig?;
-    private _events?;
-    private _displayRealm?;
-    isManagerSameOrigin(): boolean;
-    addListener(callback: EventCallback): void;
-    removeListener(callback: EventCallback): void;
-    init(config: ManagerConfig): Promise<boolean>;
-    protected doInit(): Promise<boolean>;
-    protected doTranslateInit(): Promise<boolean>;
-    protected doDescriptorsInit(): Promise<boolean>;
-    protected doAuthInit(): Promise<boolean>;
-    protected doRestApiInit(): boolean;
-    protected doEventsSubscriptionInit(): Promise<boolean>;
-    protected _onEventProviderStatusChanged(status: EventProviderStatus): void;
-    protected doConsoleInit(): Promise<boolean>;
-    protected getConsoleAppConfig(): Promise<void>;
-    logout(redirectUrl?: string): void;
-    login(options?: LoginOptions): void;
-    protected initialiseBasicAuth(): Promise<boolean>;
-    protected doBasicLogin(): Promise<void>;
-    isSuperUser(): boolean | "" | undefined;
-    getApiBaseUrl(): string;
-    getAppName(): string;
-    hasRealmRole(role: string): boolean | undefined;
-    hasRole(role: string, client?: string): boolean;
-    getAuthorizationHeader(): string | undefined;
-    getKeycloakToken(): string | undefined;
-    getBasicToken(): string | undefined;
-    getRealm(): string | undefined;
-    protected isMobile(): boolean;
-    isKeycloak(): boolean;
-    protected _onAuthenticated(): void;
-    protected loadAndInitialiseKeycloak(): Promise<boolean>;
-    protected updateKeycloakAccessToken(): Promise<boolean>;
-    protected _getNativeOfflineRefreshToken(): Promise<string | undefined>;
-    protected _emitEvent(event: OREvent): void;
-    protected _setError(error: ORError): void;
-    protected _setAuthenticated(authenticated: boolean): void;
-}
-export declare const manager: Manager;
-export declare const IconSets: ORIconSets;
-export default manager;