dazscript-framework 0.1.15 → 0.1.17

package/src/helpers/http-helper.ts

@@ -0,0 +1,190 @@
+import * as log from '@dsf/common/log'
+
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD'
+export type HttpConnectionMode = 'http' | 'https'
+export type HttpResponseType = 'json' | 'text' | 'bytes'
+
+export interface HttpAuthOptions {
+    basic?: {
+        username: string
+        password: string
+    }
+    bearerToken?: string
+}
+
+export interface HttpRequestOptions {
+    host: string
+    path: string
+    method?: HttpMethod
+    connectionMode?: HttpConnectionMode
+    timeoutMs?: number
+    responseType?: HttpResponseType
+    queryString?: string
+    headers?: Record<string, string>
+    contentType?: string
+    body?: string | ByteArray | object
+    auth?: HttpAuthOptions
+    transport?: any
+}
+
+export interface HttpResponse<T = any> {
+    ok: boolean
+    bytes: ByteArray
+    text: string
+    data: T | null
+    error: string
+    parseError: string
+}
+
+export const basicAuth = (username: string, password: string): string => {
+    const credentials = new ByteArray(username + ':' + password)
+    const encoded = credentials.toBase64().convertToString()
+    return 'Basic ' + encoded.replace(/\r|\n/g, '')
+}
+
+export const bearerAuth = (token: string): string => {
+    return 'Bearer ' + token
+}
+
+export const request = <T = any>(options: HttpRequestOptions): HttpResponse<T> => {
+    const emptyBytes = new ByteArray()
+    const emptyResponse: HttpResponse<T> = {
+        ok: false,
+        bytes: emptyBytes,
+        text: '',
+        data: null,
+        error: '',
+        parseError: ''
+    }
+
+    if (!options || !options.host || !options.path) {
+        return {
+            ...emptyResponse,
+            error: 'Http request requires host and path.'
+        }
+    }
+
+    // Parse host:port format
+    let hostOnly = options.host
+    let port = 0
+    const colonIdx = options.host.indexOf(':')
+    if (colonIdx > 0) {
+        hostOnly = options.host.substring(0, colonIdx)
+        const portStr = options.host.substring(colonIdx + 1)
+        port = parseInt(portStr)
+    }
+
+    const http = options.transport ?? new DzHttpHelper()
+    http.setConnectionMode(options.connectionMode ?? 'https')
+    http.setHost(hostOnly)
+    if (typeof http.setTimeoutMs === 'function' && options.timeoutMs && options.timeoutMs > 0) {
+        http.setTimeoutMs(options.timeoutMs)
+    }
+    if (port > 0) {
+        http.setPort(port)
+    }
+    http.setPath(options.path)
+    http.setRequestMethod(options.method ?? 'GET')
+
+    if (options.queryString) {
+        http.setQueryString(options.queryString)
+    }
+
+    const headers = buildHeaders(options)
+    const keys = Object.keys(headers)
+    if (keys.length > 0) {
+        const values: string[] = []
+        for (let i = 0; i < keys.length; i++) {
+            values.push(headers[keys[i]])
+        }
+        http.setHeaderValues(keys, values)
+    }
+
+    try {
+        const requestBody = buildRequestBody(options)
+        // buildRequestBody may set options.contentType to 'application/json' as a side
+        // effect when body is an object — so setContentType must come after
+        if (options.contentType) {
+            http.setContentType(options.contentType)
+        }
+        const bytes = requestBody ? http.doSynchronousRequest(requestBody) : http.doSynchronousRequest()
+        const error = http.getError()
+        const text = bytes ? bytes.convertToStringFromUtf8() : ''
+        const responseType = options.responseType ?? 'json'
+
+        let parseError = ''
+        let data: T | null = null
+
+        if (responseType === 'json' && text) {
+            try {
+                data = JSON.parse(text) as T
+            } catch (e) {
+                parseError = 'Json parse error: ' + e
+            }
+        }
+
+        return {
+            ok: !error && !parseError,
+            bytes: bytes,
+            text: text,
+            data: data,
+            error: error,
+            parseError: parseError
+        }
+    } catch (e) {
+        const exceptionText = 'Http request exception: ' + e
+        log.error(exceptionText)
+        return {
+            ...emptyResponse,
+            error: exceptionText
+        }
+    }
+}
+
+export const get = <T = any>(options: Omit<HttpRequestOptions, 'method'>): HttpResponse<T> => {
+    return request({ ...options, method: 'GET' })
+}
+
+export const post = <T = any>(options: Omit<HttpRequestOptions, 'method'>): HttpResponse<T> => {
+    return request({ ...options, method: 'POST' })
+}
+
+export const put = <T = any>(options: Omit<HttpRequestOptions, 'method'>): HttpResponse<T> => {
+    return request({ ...options, method: 'PUT' })
+}
+
+export const patch = <T = any>(options: Omit<HttpRequestOptions, 'method'>): HttpResponse<T> => {
+    return request({ ...options, method: 'PATCH' })
+}
+
+export const del = <T = any>(options: Omit<HttpRequestOptions, 'method'>): HttpResponse<T> => {
+    return request({ ...options, method: 'DELETE' })
+}
+
+export const head = <T = any>(options: Omit<HttpRequestOptions, 'method'>): HttpResponse<T> => {
+    return request({ ...options, method: 'HEAD' })
+}
+
+const buildRequestBody = (options: HttpRequestOptions): ByteArray | undefined => {
+    if (options.body == null) return undefined
+    if (typeof options.body === 'string') return new ByteArray(options.body)
+    if (options.body instanceof ByteArray) return options.body
+
+    if (!options.contentType) {
+        options.contentType = 'application/json'
+    }
+
+    return new ByteArray(JSON.stringify(options.body))
+}
+
+const buildHeaders = (options: HttpRequestOptions): Record<string, string> => {
+    const headers = { ...(options.headers ?? {}) }
+
+    if (options.auth?.bearerToken) {
+        headers.Authorization = bearerAuth(options.auth.bearerToken)
+    } else if (options.auth?.basic && !headers.Authorization) {
+        headers.Authorization = basicAuth(options.auth.basic.username, options.auth.basic.password)
+    }
+
+    return headers
+}

package/src/helpers/input-helper.ts

@@ -1,19 +1,19 @@
-export const getModifierKeys = (): {
-    shift: boolean,
-    ctrl: boolean,
-    command: boolean,
-    win: boolean,
-    control: boolean,
-    alt: boolean
-} => {
-    var nModifierState = App.modifierKeyState();
-
-    return {
-        shift: (nModifierState & 0x02000000) != 0,
-        ctrl: (nModifierState & 0x04000000) != 0,
-        alt: (nModifierState & 0x08000000) != 0,
-        win: (nModifierState & 0x10000000) != 0,
-        command: (nModifierState & 0x04000000) != 0,
-        control: (nModifierState & 0x10000000) != 0
-    };
+export const getModifierKeys = (): {
+    shift: boolean,
+    ctrl: boolean,
+    command: boolean,
+    win: boolean,
+    control: boolean,
+    alt: boolean
+} => {
+    var nModifierState = App.modifierKeyState();
+
+    return {
+        shift: (nModifierState & 0x02000000) != 0,
+        ctrl: (nModifierState & 0x04000000) != 0,
+        alt: (nModifierState & 0x08000000) != 0,
+        win: (nModifierState & 0x10000000) != 0,
+        command: (nModifierState & 0x04000000) != 0,
+        control: (nModifierState & 0x10000000) != 0
+    };
 }

package/src/helpers/list-view-helper.ts

@@ -1,89 +1,105 @@
-import { contains } from './string-helper'
-
-export const clearColumns = (listView: DzListView) => {
-    for (let i = 0; i < listView.columns; i++) {
-        listView.removeColumn(i)
-    }
-}
-
-export const setDataItem = (listItem: DzListViewItem, data: any) => {
-    listItem.addDataItem('data', data)
-}
-
-export const getDataItem = <T>(listItem: DzListViewItem): T | null => {
-    return listItem?.getDataItem('data') ?? null
-}
-
-export const filter = (listView: DzListView, filterOn: (viewItem: DzListViewItem) => string, keywords: string, options?: { selectOnFilter?: boolean, filters?: (viewItem: DzListViewItem) => boolean }) => {
-    listView.clearSelection()
-    listView.getItems(DzListView.All).forEach(item => item.visible = true)
-
-    const matchFilter = (text: string): boolean => {
-        text = text.toLowerCase()
-        var words = keywords?.toLowerCase().split(" ") ?? []
-
-        return !keywords || keywords.trim() == "" ||
-            words.every(w => {
-                return w.length >= 1 || !isNaN(Number(w))
-                    ? contains(text, w)
-                    : text.startsWith(w)
-            });
-    }
-
-    const setListViewItemVisibility = (viewItem: DzListViewItem): boolean => {
-        let keywordMatch = matchFilter(filterOn(viewItem))
-        let filtersMatch = !options?.filters || options.filters?.(viewItem) === true
-        viewItem.visible = keywordMatch && filtersMatch
-
-        if (options?.selectOnFilter === true && viewItem.visible && !listView.selectedItem()) {
-            listView.setSelected(viewItem, true)
-            listView.ensureItemVisible(viewItem)
-        }
-
-        return viewItem.visible;
-    }
-
-    const filterListViewItem = (viewItem: DzListViewItem): boolean => {
-        var visible = false;
-
-        if (viewItem.childCount() > 0) {
-            var child = viewItem.firstChild()
-            while (child) {
-                visible = visible || filterListViewItem(child)
-                child = child.nextSibling()
-            }
-        }
-
-        viewItem.visible = visible || setListViewItemVisibility(viewItem);
-        return viewItem.visible;
-    }
-
-    listView.getItems(DzListView.All).forEach(viewItem => {
-        viewItem.visible = true
-        filterListViewItem(viewItem)
-    });
-}
-
-export const expand = (listView: DzListView, expandOrCollapse: boolean, listItem?: DzListViewItem) => {
-    if (listItem) {
-        listItem.open = expandOrCollapse
-        if (listItem.childCount() > 0) {
-            var child = listItem.firstChild()
-            while (child) {
-                expand(listView, expandOrCollapse, child)
-                child = child.nextSibling()
-            }
-        }
-    }
-    else {
-        listView.getItems(DzListView.All).forEach((item) => {
-            item.open = expandOrCollapse
-        })
-    }
-}
-
-export const checkAll = (listView: DzListView, onOff: boolean) => {
-    listView.getItems(onOff ? DzListView.NotChecked : DzListView.Checked).forEach(item => {
-        (item as DzCheckListItem).on = onOff
-    })
-}
+import { contains } from './string-helper'
+
+let filterRunId = 0
+
+export const clearColumns = (listView: DzListView) => {
+    for (let i = 0; i < listView.columns; i++) {
+        listView.removeColumn(i)
+    }
+}
+
+export const setDataItem = (listItem: DzListViewItem, data: any) => {
+    listItem.addDataItem('data', data)
+}
+
+export const getDataItem = <T>(listItem: DzListViewItem): T | null => {
+    return listItem?.getDataItem('data') ?? null
+}
+
+export const filter = (listView: DzListView, filterOn: (viewItem: DzListViewItem) => string, keywords: string, options?: { selectOnFilter?: boolean, filters?: (viewItem: DzListViewItem) => boolean }) => {
+    filterRunId++
+    const currentRunId = filterRunId
+    const visitKey = '__dsfFilterVisitId'
+
+    listView.clearSelection()
+    const normalizedKeywords = keywords?.toLowerCase() ?? ''
+    const words = normalizedKeywords.split(" ")
+
+    listView.getItems(DzListView.All).forEach(item => item.visible = true)
+
+    const matchFilter = (text: string): boolean => {
+        text = text.toLowerCase()
+
+        return !keywords || keywords.trim() == "" ||
+            words.every(w => {
+                return w.length >= 1 || !isNaN(Number(w))
+                    ? contains(text, w)
+                    : text.startsWith(w)
+            });
+    }
+
+    const setListViewItemVisibility = (viewItem: DzListViewItem): boolean => {
+        let keywordMatch = matchFilter(filterOn(viewItem))
+        let filtersMatch = !options?.filters || options.filters?.(viewItem) === true
+        viewItem.visible = keywordMatch && filtersMatch
+
+        if (options?.selectOnFilter === true && viewItem.visible && viewItem.childCount() === 0 && !listView.selectedItem()) {
+            listView.setSelected(viewItem, true)
+            listView.ensureItemVisible(viewItem)
+        }
+
+        return viewItem.visible;
+    }
+
+    const filterListViewItem = (viewItem: DzListViewItem): boolean => {
+        if ((viewItem as any)[visitKey] === currentRunId) {
+            return viewItem.visible
+        }
+        ; (viewItem as any)[visitKey] = currentRunId
+
+        var visible = false;
+
+        if (viewItem.childCount() > 0) {
+            var child = viewItem.firstChild()
+            while (child) {
+                visible = visible || filterListViewItem(child)
+                child = child.nextSibling()
+            }
+        }
+
+        const selfVisible = setListViewItemVisibility(viewItem)
+        viewItem.visible = viewItem.childCount() > 0
+            ? visible
+            : selfVisible
+        return viewItem.visible;
+    }
+
+    listView.getItems(DzListView.All).forEach(viewItem => {
+        viewItem.visible = true
+        filterListViewItem(viewItem)
+    });
+}
+
+export const expand = (listView: DzListView, expandOrCollapse: boolean, listItem?: DzListViewItem) => {
+    if (listItem) {
+        listItem.open = expandOrCollapse
+        if (listItem.childCount() > 0) {
+            var child = listItem.firstChild()
+            while (child) {
+                expand(listView, expandOrCollapse, child)
+                child = child.nextSibling()
+            }
+        }
+    }
+    else {
+        listView.getItems(DzListView.All).forEach((item) => {
+            item.open = expandOrCollapse
+        })
+    }
+}
+
+export const checkAll = (listView: DzListView, onOff: boolean) => {
+    listView.getItems(onOff ? DzListView.NotChecked : DzListView.Checked).forEach(item => {
+        (item as DzCheckListItem).on = onOff
+    })
+}

package/src/helpers/menu-helper.ts

@@ -1,29 +1,29 @@
-import { mainWindow } from '@dsf/core/global'
-
-const actionMgr = mainWindow.getActionMgr()
-const paneMgr = mainWindow.getPaneMgr()
-
-export const getMenu = (menuPath: string, createIfNotFound: boolean): DzActionMenu => {
-    var index = menuPath.indexOf("::")
-    var hasPaneDelimiter = index >= 0
-
-    // TODO: Check what a path delimiter is and how to use it
-    if (hasPaneDelimiter) {
-        var paneClass = menuPath.substring(0, index)
-        var paneManager = paneMgr.findPane(paneClass)
-        if (paneManager) {
-            var menu = paneManager.getOptionsMenu();
-            var subMenu = menuPath.substring(index + 2)
-            // Get/Create the sub menu
-            return createIfNotFound
-                ? menu.findOrCreateSubMenu(subMenu)
-                : menu.findSubMenu(subMenu);
-        }
-    }
-    else {
-        // Get/Create the sub menu
-        return createIfNotFound
-            ? actionMgr.getMenu().findOrCreateSubMenu(menuPath)
-            : actionMgr.getMenu().findSubMenu(menuPath)
-    }
+import { mainWindow } from '@dsf/core/global'
+
+const actionMgr = mainWindow.getActionMgr()
+const paneMgr = mainWindow.getPaneMgr()
+
+export const getMenu = (menuPath: string, createIfNotFound: boolean): DzActionMenu => {
+    var index = menuPath.indexOf("::")
+    var hasPaneDelimiter = index >= 0
+
+    // TODO: Check what a path delimiter is and how to use it
+    if (hasPaneDelimiter) {
+        var paneClass = menuPath.substring(0, index)
+        var paneManager = paneMgr.findPane(paneClass)
+        if (paneManager) {
+            var menu = paneManager.getOptionsMenu();
+            var subMenu = menuPath.substring(index + 2)
+            // Get/Create the sub menu
+            return createIfNotFound
+                ? menu.findOrCreateSubMenu(subMenu)
+                : menu.findSubMenu(subMenu);
+        }
+    }
+    else {
+        // Get/Create the sub menu
+        return createIfNotFound
+            ? actionMgr.getMenu().findOrCreateSubMenu(menuPath)
+            : actionMgr.getMenu().findSubMenu(menuPath)
+    }
 }

package/src/helpers/message-box-helper.ts

@@ -1,16 +1,26 @@
-import * as log from "@dsf/common/log"
-
-export const info = (msg: string) => {
-    MessageBox.information(msg, "", "Ok")
-}
-
-export const error = (message: string, writeLog?: boolean) => {
-    if (writeLog) log.debug(message)
-    MessageBox.critical(message, "Error", "Ok")
-}
-
-export const confirm = (message?: string): { ok: boolean, cancel: boolean } => {
-    var response = MessageBox.question(message ?? "Confirm?", "", "Ok", "Cancel");
-
-    return { ok: response == 0, cancel: response != 0 };
+import * as log from "@dsf/common/log"
+
+export const info = (msg: string) => {
+    MessageBox.information(msg, "", "Ok")
+}
+
+export const error = (message: string, writeLog: boolean = true) => {
+    if (writeLog) log.debug(message)
+    MessageBox.critical(message, "Error", "Ok")
+}
+
+export const warning = (message: string) => {
+    MessageBox.warning(message, "Warning", "Ok")
+}
+
+export const confirm = (message?: string): { ok: boolean, cancel: boolean } => {
+    var response = MessageBox.question(message ?? "Confirm?", "", "Ok", "Cancel");
+
+    return { ok: response == 0, cancel: response != 0 };
+}
+
+export const prompt = (text: string, title: string, button0: string, button1?: string): { cancel: boolean, selection: number } => {
+    const response = MessageBox.question(text, title, button0, button1, "Cancel")
+
+    return { cancel: response === 0, selection: response };
 }