@regulaforensics/idv-interfaces 3.2.236-nightly

package/README.md

@@ -0,0 +1,3 @@
+# Interfaces-idv module
+
+Module which exports common types, enums, interfaces

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+export declare class BaseError {
+    errorCode: number | string;
+    errorCodeKey: string;
+    message?: string;
+    underlyingError?: string;
+    underlyingBaseError?: BaseError;
+    domain?: string;
+    module: string;
+    errorEnumName: string;
+    shortDomainCode: string;
+    constructor({ errorCode, errorCodeKey, message, underlyingError, underlyingBaseError, domain, module, errorEnumName, shortDomainCode, }: {
+        errorCode: number | string;
+        errorCodeKey: string;
+        module: string;
+        message?: string;
+        underlyingError?: string;
+        underlyingBaseError?: BaseError;
+        domain?: string;
+        errorEnumName: string;
+        shortDomainCode: string;
+    });
+    static getErrorKey<T extends Record<string, any>>(errorCode: number | string, errorEnum: T): string;
+    get lastUnderlyingError(): string | undefined;
+    toObject(): Record<string, any>;
+    get shortChain(): string;
+    get fullChain(): string;
+}
+
+export declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unknown> extends HTMLElement {
+    abstract props: IdvModuleProps<TModuleProps, TModulesConfig> | null;
+    abstract setProps(config: IdvModuleProps<TModuleProps, TModulesConfig>): void;
+}
+
+export declare function cleanObjectFromUndefined(obj: Record<string, unknown>): Record<string, unknown>;
+
+export declare type IdvModuleProps<TModuleProps, TModulesConfig> = {
+    isProcessing?: (isProcessing: boolean) => void;
+    moduleProps: TModuleProps;
+    modulesConfig?: TModulesConfig;
+    perform: (data: any) => void;
+    idvEventListener: (module: string, data: any) => void;
+};
+
+export declare interface IdvModuleStaticMethods {
+    displayName: string;
+    isReady(): boolean;
+    getSupportedTemplates(): string[];
+    initialize(modulesConfig: Record<string, unknown>): void;
+    deinitialize(): void;
+    getIdentifier(): string;
+}
+
+export declare type ModuleClass<TModuleProps = unknown, TModulesConfig = unknown> = IdvModuleStaticMethods & (new (...args: any[]) => BaseModule<TModuleProps, TModulesConfig>);
+
+export declare function parseClientJSON<T>(json: T): T;
+
+export declare function registerModule<TModuleProps = unknown, TModulesConfig = unknown>(name: string, ModuleClass: ModuleClass<TModuleProps, TModulesConfig>): void;
+
+export { }