@finsemble/finsemble-electron-adapter 1.0.0-beta-1

package/types/server/SmartDesktop.d.ts

@@ -0,0 +1,36 @@
+export declare type DeployInfo = {
+    manifestURL: string;
+    installerURL: string;
+    uuid: string;
+    buildID?: string;
+};
+export declare type ProjectPointer = {
+    name: string;
+    path: string;
+};
+export declare type ProjectConfig = {
+    name: string;
+    deployInfo: DeployInfo | null;
+};
+declare const smartDesktopsJSONLocation: () => string;
+declare const setProjectPath: (name: string, _path: string) => void;
+export declare const getProjectConfig: (name: string) => [Error | null, ProjectConfig | null];
+declare const getSmartDesktopConfig: () => Promise<any>;
+declare const getCurrentWorkingProject: () => Promise<ProjectPointer>;
+export declare const getCurrentWorkingProjectConfig: () => Promise<[Error | null, ProjectConfig | null]>;
+declare const saveDeployInfo: (deployInfo: DeployInfo) => Promise<void>;
+declare const updateProjectName: (currentName: string, newName: string) => [Error | null];
+declare const resetProject: (name: string) => Error | null;
+declare const start: ({ appDataPath, reset, update }: {
+    appDataPath: string;
+    reset?: boolean | undefined;
+    update?: boolean | undefined;
+}) => Promise<string>;
+declare const enabled: () => boolean;
+interface SDServerInfo {
+    enabled: boolean;
+    applicationRoot: string | null;
+    projectConfig?: ProjectConfig | null;
+}
+declare const info: () => Promise<SDServerInfo>;
+export { enabled, start, getCurrentWorkingProject, getSmartDesktopConfig, smartDesktopsJSONLocation, saveDeployInfo, updateProjectName, info, resetProject, setProjectPath, };

package/types/server/SmartDesktopEndpoints.d.ts

@@ -0,0 +1,99 @@
+import express from "express";
+import { UploadedFile } from "express-fileupload";
+import { ConsoleLogger } from "../logger/types";
+import { DeployInfo } from "./SmartDesktop";
+import { Progress } from "./Progress";
+export interface CSSVariables {
+    [index: string]: string;
+}
+export declare type AssetMeta = {
+    key: string;
+    name: string;
+    type: string;
+    size: number;
+    targetPath: string | null;
+};
+export declare type Asset = {
+    meta: AssetMeta;
+    file: UploadedFile;
+};
+export declare enum AuthenticationType {
+    OAUTH2 = "OAUTH2",
+    PASSWORD = "PASSWORD"
+}
+export declare type AuthenticationProvider = {
+    name: string;
+    type: AuthenticationType;
+    client_id: string | null;
+    secret: string | null;
+    enabled: boolean;
+    redirect_uri: string;
+    authorization_endpoint?: string;
+    scope?: string;
+    nonce: boolean;
+};
+export declare type MenuObjType = {
+    displayName: string;
+    applications: string[];
+    position: number;
+};
+export declare type MenuType = {
+    [key: string]: MenuObjType;
+};
+export declare type CopiedFile = {
+    source: string;
+    target: string;
+};
+export declare type ProjectSettings = {
+    name: string;
+    path?: string;
+    version?: string;
+    authors?: string;
+    description?: string;
+};
+export declare type Preload = {
+    url: string;
+    alias: string;
+};
+export declare type PreloadUsage = {
+    all?: boolean;
+    launchable?: boolean;
+    apps?: string[];
+};
+export declare type preloadUsageType = "launchable" | "all" | "selection";
+export declare type PreloadDetail = {
+    url: string;
+    autoload: preloadUsageType;
+};
+export declare type PreloadMap = {
+    [alias: string]: PreloadDetail;
+};
+export declare type SmartDesktopPlugin = {
+    saveTheme: (cssVariables: CSSVariables) => Promise<void>;
+    getTheme: (filename: string) => Promise<CSSVariables>;
+    getProjectSettings: (projectName: string) => Promise<ProjectSettings>;
+    updateProjectSettings: (projectName: string, settings: ProjectSettings) => Promise<void>;
+    updateInstallerConfig: (projectName: string, settings: any) => Promise<void>;
+    createProjectZip: (projectName: string, targetPath: string) => Promise<string>;
+    copyProjectFiles: (projectName: string, targetPath: string) => Promise<CopiedFile[]>;
+    saveAssets: (files: Asset[]) => Promise<string[]>;
+    publishToCosaicCloud: (uuid: string | null) => Promise<DeployInfo>;
+    getProgress: () => Promise<Progress>;
+    resetProject: (projectName: string) => Promise<void>;
+    getMenus: () => Promise<MenuType>;
+    addMenu: (definition: MenuObjType) => Promise<void>;
+    updateMenu: (menuId: any, definition: MenuObjType) => Promise<void>;
+    deleteMenu: (menuId: any) => Promise<void>;
+    getAuthenticationProviders: () => Promise<AuthenticationProvider[]>;
+    putAuthenticationProviders: (providers: AuthenticationProvider[]) => Promise<void>;
+    getPreloads: () => Promise<PreloadMap>;
+    savePreload: (oldAlias: string, newAlias: string, detail: PreloadDetail) => Promise<void>;
+    deletePreload: (alias: string) => Promise<void>;
+};
+declare type UseEndpointParams = {
+    app: express.Application;
+    plugin: SmartDesktopPlugin;
+    logger?: ConsoleLogger;
+};
+declare const useEndpoints: ({ app, plugin, logger }: UseEndpointParams) => void;
+export { useEndpoints };

package/types/server/SmartDesktopStaticConfigPlugin.d.ts

@@ -0,0 +1,9 @@
+import { SmartDesktopPlugin } from "./SmartDesktopEndpoints";
+import { ConsoleLogger } from "../logger/types";
+export declare type SmartDesktopStaticConfigPluginParams = {
+    projectRoot: string;
+    logger?: ConsoleLogger;
+    appDataPath: string;
+};
+declare const initialize: ({ logger, projectRoot, appDataPath }: SmartDesktopStaticConfigPluginParams) => Promise<SmartDesktopPlugin>;
+export { initialize };

package/types/server/cssUtilities.d.ts

@@ -0,0 +1,6 @@
+export interface CSSVariables {
+    [index: string]: string;
+}
+export declare const fileToCssVariables: (path: string) => CSSVariables;
+export declare const jsonToCssVariables: (cssVariables: CSSVariables) => string;
+export declare const addCssVariablesToFile: (cssVariables: CSSVariables, path: string) => void;

package/types/server/writeJSON.d.ts

@@ -0,0 +1 @@
+export default function (targetPath: string, json: any): void;

package/types/startup/e2oLauncher.d.ts

@@ -0,0 +1 @@
+export default function startFEA({ onElectronClose, manifest, socketCertificatePath, breakpointOnStart, args, chromiumFlags }: any, cb?: Function): void;

package/types/startup/runScriptInElectron.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+import { ChildProcessWithoutNullStreams } from "child_process";
+export declare function runScriptInElectron(params: {
+    script: string;
+    done?: (exitCode: number | null) => void;
+}): ChildProcessWithoutNullStreams;

package/types/types/types.d.ts

@@ -0,0 +1,148 @@
+import { BrowserView, WebContents } from "electron";
+import { MainWindow } from "../main/MainWindow";
+import { IpcMainEvent, ProcessMetric } from "electron";
+export declare type StandardError = string | null | undefined;
+export declare type StandardErrorCallback<R = any> = (err: StandardError, response?: R) => void;
+export declare type StandardPromise<R = any> = Promise<{
+    err?: StandardError;
+    data?: R;
+}>;
+export declare type StandardResponse<R = any> = {
+    err?: StandardError;
+    data?: R;
+};
+export declare type FEALogLevel = "error" | "warn" | "info" | "log" | "verbose" | "debug";
+export declare type Manifest = Record<string, any>;
+export declare type AnnotatedBrowserWindowOptions = Record<string, any>;
+export declare type WebContentsId = WebContents["id"];
+export declare type MainStore = {
+    webContents: {
+        [stringifiedWebContentsId: string]: {
+            id: WebContentsId;
+            isTitlebarWindow: boolean;
+            windowName: string;
+            webContentsName: string;
+            isView: boolean;
+            manifest: Manifest;
+            preloads: {
+                url: string;
+                fileName?: string;
+                src?: string;
+                error?: string | null;
+                trusted?: boolean;
+            }[];
+            contextIsolation: boolean;
+        };
+    };
+    downloads: {
+        [url: string]: {
+            url: string;
+            fileName?: string;
+            error?: string | null;
+        };
+    };
+    browserWindowOptions: {
+        [stringifiedWebContentsId: string]: AnnotatedBrowserWindowOptions;
+    };
+    unattachedChildWindows: {
+        [parentWebContentsId: string]: AnnotatedBrowserWindowOptions;
+    };
+};
+export declare type WebContentsRecord = MainStore["webContents"]["any"];
+export declare type Preload = WebContentsRecord["preloads"][0];
+export declare type Download = MainStore["downloads"]["any"];
+export declare type WindowsIndex = {
+    byWindowName: {
+        [name: string]: MainWindow;
+    };
+    byWebContentsId: {
+        [id: number]: {
+            webContentsName: string;
+            webContents: WebContents;
+            mainWindow: MainWindow;
+            browserView?: BrowserView;
+        };
+    };
+};
+export declare type SocketCertificatePath = {
+    key: string;
+    cert: string;
+};
+export declare type BusEventPayload = {
+    topic: string;
+    data: any;
+};
+export declare type MainProcessBusEvent = {
+    sender: WebContents;
+    topic: string;
+    rawEvent: IpcMainEvent;
+    rawArgs: BusEventPayload;
+    data: any;
+    respondSync: Function;
+    respond: Function;
+};
+export declare type RendererBusResponse = {
+    topic: string;
+    data: any;
+    persistChannel: any;
+    responseUUID: string;
+    functionCB: Function;
+};
+export declare type WindowBounds = {
+    x: number;
+    y: number;
+    height: number;
+    width: number;
+    right: number;
+    bottom: number;
+};
+export declare type Asset = {
+    alias: string;
+    target: string;
+    src: string;
+    path?: string;
+    version: string;
+};
+export declare type Metric = {
+    cpuUsage: number;
+    name: string;
+    type: ProcessMetric["type"];
+    peakWorkingSetSize: number;
+    processId: number;
+    workingSetSize: number;
+    webContents: {
+        [webContentId: number]: {
+            windowName: string;
+            webContentsName: string;
+            type: "window" | "view";
+        };
+    };
+    affinity?: string | boolean;
+};
+export declare type IABSubscribeResponse = {
+    data: any;
+    listenerID: string;
+};
+export declare type IABPublish = {
+    destination: string;
+    data?: any;
+};
+export declare type IABUnsubscribe = {
+    listenerID: string;
+};
+export declare type IABSubscribe = {
+    listenerID: string;
+    source: string;
+};
+export declare type ErrorResponseFSA = {
+    type: "ErrorResponse";
+    payload: {
+        err: string;
+    };
+};
+export declare type SpawnResponseFSA = {
+    type: "SpawnResponse";
+    payload: {
+        windowName: string;
+    };
+};

package/types/util.d.ts

@@ -0,0 +1,13 @@
+import { StandardResponse } from "./types/types";
+export declare const hashFn: (str: string, asString?: boolean, seed?: number | undefined) => string | number;
+export declare const safeStringify: (obj: any, replacer?: null, spaces?: number) => string;
+export declare const deleteFolderRecursive: (_path: string) => void;
+export declare const accessDenied: (methodName: string, cb?: Function | null) => any;
+export declare const isValidURL: (str: string) => boolean;
+export declare const getFilenameFromURL: (url: string) => string;
+export declare const isDevLaunch: () => boolean;
+export declare const isDevMode: () => boolean;
+export declare const objectFlatMap: (obj: Record<string, any>, func: (key: string, value: any) => [key: string, value: any][]) => {
+    [k: string]: any;
+};
+export declare const pathJoinSecureRoot: (rootFolder: string, userProvidedPath: string) => StandardResponse<string>;