dolphindb 2.0.520 → 2.0.523

package/index.d.ts

@@ -10,6 +10,7 @@ export declare enum DdbForm {
     dict = 5,
     table = 6,
     chart = 7,
+    /** Node internal communication may be used, calling function execution script generally does not return this type */
     chunk = 8,
     /** sysobj */
     object = 9
@@ -106,6 +107,32 @@ export interface DdbMatrixValue {
     cols: DdbObj<DdbVectorValue>;
     data: DdbVectorValue;
 }
+export declare type DdbDictValue = [DdbObj<DdbVectorValue>, DdbObj<DdbVectorValue>];
+export declare enum DdbChartType {
+    area = 0,
+    bar = 1,
+    column = 2,
+    histogram = 3,
+    line = 4,
+    pie = 5,
+    scatter = 6,
+    trend = 7,
+    kline = 8
+}
+export interface DdbChartValue {
+    /** original: chartType */
+    type: DdbChartType;
+    stacking: boolean;
+    titles: {
+        chart: string;
+        x_axis: string;
+        y_axis: string;
+    };
+    extras: {
+        multi_y_axis: boolean;
+    };
+    data: DdbObj<DdbMatrixValue>;
+}
 export declare type DdbScalarValue = null | boolean | number | bigint | string | Uint8Array | // uuid, ipaddr, int128, blob
 [
     number,
@@ -116,7 +143,7 @@ export declare type DdbVectorValue = Uint8Array | Int8Array | Int16Array | Int32
 Uint8Array[] | // blob
 DdbObj[] | // any
 DdbSymbolExtendedValue | DdbArrayVectorBlock[];
-export declare type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue;
+export declare type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue | DdbDictValue | DdbChartValue;
 export declare const nulls: {
     readonly int8: -128;
     readonly int16: -32768;
@@ -182,8 +209,24 @@ export declare class DdbObj<T extends DdbValue = DdbValue> {
     pack(): Uint8Array;
     static pack_vector_body(value: DdbVectorValue, type: DdbType, length: number): ArrayBufferView[];
     [inspect.custom](depth: number, options: InspectOptions, _inspect: any): string;
+    /** 自动转换 js string, boolean 为 DdbObj */
+    static to_ddbobj(value: DdbObj | string | boolean): DdbObj;
+    /** 转换 js 数组为 DdbObj[] */
+    static to_ddbobjs(values: any[]): DdbObj<DdbValue>[];
     to_rows<T extends Record<string, any> = Record<string, any>>(): T[];
-    to_dict<T = Record<string, any>>(): T;
+    /** convert dict<string, any> to js object (Record<string, any>)
+        - options?:
+            - strip?: `false` Whether to directly extract and strip the value in DdbObj as the value of js object (discard the rest of the information in DdbObj, only keep the value)
+            - deep?: `false` Whether to convert recursively
+    */
+    to_dict<T extends Record<string, DdbObj> = Record<string, DdbObj>>(): T;
+    to_dict<T extends Record<string, any> = Record<string, any>>(options: {
+        strip: true;
+    }): T;
+    to_dict<T extends Record<string, any> = Record<string, any>>(options?: {
+        strip?: boolean;
+        deep?: boolean;
+    }): T;
 }
 export declare function format(type: DdbType, value: DdbValue, le: boolean, options: InspectOptions): string;
 export declare class DdbVoid extends DdbObj<undefined> {
@@ -232,7 +275,7 @@ export declare class DdbVectorString extends DdbObj<string[]> {
     constructor(strings: string[], name?: string);
 }
 export declare class DdbVectorAny extends DdbObj {
-    constructor(objs: DdbObj<DdbValue>[], name?: string);
+    constructor(objs: (DdbObj | string | boolean)[], name?: string);
 }
 export declare class DdbVectorSymbol extends DdbObj<DdbSymbolExtendedValue> {
     constructor(strings: string[], name?: string);
@@ -246,6 +289,14 @@ export declare class DdbSetDouble extends DdbObj<Float64Array> {
 export declare class DdbSetString extends DdbObj<string[]> {
     constructor(strings: string[] | Set<string>);
 }
+/** Constructs a DdbDict object, which supports two usages:
+     - The incoming type is the keys of DdbObj<DdbVectorValue>, and the two parameters of values directly form the DdbDict of dict<keys.type, values.type>
+     - Pass in js object (type is Record<string, boolean | string | DdbObj>), automatically converted to DdbDict of dict<string, any>
+*/
+export declare class DdbDict extends DdbObj<DdbDictValue> {
+    constructor(obj: Record<string, boolean | string | DdbObj>);
+    constructor(keys: DdbObj<DdbVectorValue>, values: DdbObj<DdbVectorValue>);
+}
 export declare class DdbTable extends DdbObj<DdbObj[]> {
     constructor(columns: DdbObj[], name?: string);
 }
@@ -464,10 +515,6 @@ export declare class DDB {
     }): Promise<DdbObj<DdbValue>>;
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
     parse_message(buf: Uint8Array, parse_object?: boolean): DdbMessage;
-    /** 自动转换 js string, boolean 为 DdbObj */
-    to_ddbobj(value: DdbObj | string | boolean): DdbObj;
-    /** 转换 js 数组为 DdbObj[] */
-    to_ddbobjs(values: any[]): DdbObj<DdbValue>[];
 }
 export interface DdbMessageListener {
     (message: DdbMessage, _this: DDB): any;

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nanotimestamp2str = exports.nanotimestamp2ns = exports.nanotime2str = exports.nanotime2ns = exports.str2timestamp = exports.datehour2str = exports.datehour2ms = exports.timestamp2str = exports.timestamp2ms = exports.datetime2str = exports.datetime2ms = exports.second2str = exports.second2ms = exports.minute2str = exports.minute2ms = exports.time2str = exports.time2ms = exports.month2str = exports.month2ms = exports.date2str = exports.date2ms = exports.DdbTable = exports.DdbSetString = exports.DdbSetDouble = exports.DdbSetInt = exports.DdbVectorSymbol = exports.DdbVectorAny = exports.DdbVectorString = exports.DdbVectorDouble = exports.DdbVectorInt = exports.DdbFunction = exports.DdbPair = exports.DdbNanoTimeStamp = exports.DdbTimeStamp = exports.DdbDateTime = exports.DdbDouble = exports.DdbLong = exports.DdbString = exports.DdbInt = exports.DdbChar = exports.DdbBool = exports.DdbVoid = exports.format = exports.DdbObj = exports.timezone_offset = exports.nulls = exports.DdbDurationUnit = exports.DdbFunctionType = exports.DdbType = exports.DdbForm = void 0;
-exports.DDB = exports.int1282str = exports.uuid2str = exports.ipaddr2str = exports.str2nanotimestamp = void 0;
+exports.nanotime2str = exports.nanotime2ns = exports.str2timestamp = exports.datehour2str = exports.datehour2ms = exports.timestamp2str = exports.timestamp2ms = exports.datetime2str = exports.datetime2ms = exports.second2str = exports.second2ms = exports.minute2str = exports.minute2ms = exports.time2str = exports.time2ms = exports.month2str = exports.month2ms = exports.date2str = exports.date2ms = exports.DdbTable = exports.DdbDict = exports.DdbSetString = exports.DdbSetDouble = exports.DdbSetInt = exports.DdbVectorSymbol = exports.DdbVectorAny = exports.DdbVectorString = exports.DdbVectorDouble = exports.DdbVectorInt = exports.DdbFunction = exports.DdbPair = exports.DdbNanoTimeStamp = exports.DdbTimeStamp = exports.DdbDateTime = exports.DdbDouble = exports.DdbLong = exports.DdbString = exports.DdbInt = exports.DdbChar = exports.DdbBool = exports.DdbVoid = exports.format = exports.DdbObj = exports.timezone_offset = exports.nulls = exports.DdbChartType = exports.DdbDurationUnit = exports.DdbFunctionType = exports.DdbType = exports.DdbForm = void 0;
+exports.DDB = exports.int1282str = exports.uuid2str = exports.ipaddr2str = exports.str2nanotimestamp = exports.nanotimestamp2str = exports.nanotimestamp2ns = void 0;
 const tslib_1 = require("tslib");
 const ws_1 = require("ws");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
@@ -21,6 +21,7 @@ var DdbForm;
     DdbForm[DdbForm["dict"] = 5] = "dict";
     DdbForm[DdbForm["table"] = 6] = "table";
     DdbForm[DdbForm["chart"] = 7] = "chart";
+    /** Node internal communication may be used, calling function execution script generally does not return this type */
     DdbForm[DdbForm["chunk"] = 8] = "chunk";
     /** sysobj */
     DdbForm[DdbForm["object"] = 9] = "object";
@@ -95,6 +96,18 @@ var DdbDurationUnit;
     DdbDurationUnit[DdbDurationUnit["y"] = 9] = "y";
     DdbDurationUnit[DdbDurationUnit["B"] = 10] = "B";
 })(DdbDurationUnit = exports.DdbDurationUnit || (exports.DdbDurationUnit = {}));
+var DdbChartType;
+(function (DdbChartType) {
+    DdbChartType[DdbChartType["area"] = 0] = "area";
+    DdbChartType[DdbChartType["bar"] = 1] = "bar";
+    DdbChartType[DdbChartType["column"] = 2] = "column";
+    DdbChartType[DdbChartType["histogram"] = 3] = "histogram";
+    DdbChartType[DdbChartType["line"] = 4] = "line";
+    DdbChartType[DdbChartType["pie"] = 5] = "pie";
+    DdbChartType[DdbChartType["scatter"] = 6] = "scatter";
+    DdbChartType[DdbChartType["trend"] = 7] = "trend";
+    DdbChartType[DdbChartType["kline"] = 8] = "kline";
+})(DdbChartType = exports.DdbChartType || (exports.DdbChartType = {}));
 exports.nulls = {
     int8: -0x80,
     int16: -32768,
@@ -199,7 +212,8 @@ class DdbObj {
                     value,
                 });
             }
-            case DdbForm.dict: {
+            case DdbForm.dict:
+            case DdbForm.chart: {
                 // <Buffer 19 05 type = any, form = dict
                 // 12 01 keys.type = string, keys.form = vector
                 // 03 00 00 00 01 00 00 00 keys.cols = 3, keys.rows = 1
@@ -211,9 +225,9 @@ class DdbObj {
                 keys.length += 2;
                 let values = this.parse_vector(buf_data.subarray(keys.length + 2), le, buf_data[keys.length]);
                 values.length += 2;
-                return new this({
+                let dict = new this({
                     le,
-                    form,
+                    form: DdbForm.dict,
                     type,
                     length: i_data + keys.length + values.length,
                     rows: keys.rows,
@@ -223,6 +237,30 @@ class DdbObj {
                         values
                     ],
                 });
+                if (form === DdbForm.dict)
+                    return dict;
+                else {
+                    const { chartType: type, stacking, title: titles, extras, data, ...others } = dict.to_dict();
+                    const [chart, x_axis, y_axis] = titles.value;
+                    const { multiYAxes: multi_y_axis, ...extras_others } = extras.to_dict({ strip: true });
+                    dict.form = DdbForm.chart;
+                    dict.value = {
+                        type: type.value,
+                        stacking: stacking.value,
+                        titles: {
+                            chart,
+                            x_axis,
+                            y_axis,
+                        },
+                        extras: {
+                            multi_y_axis,
+                            ...extras_others,
+                        },
+                        data,
+                        ...others,
+                    };
+                    return dict;
+                }
             }
             case DdbForm.matrix: {
                 // rename!(
@@ -792,6 +830,23 @@ class DdbObj {
                         value[0].pack(),
                         value[1].pack(),
                     ];
+                case DdbForm.chart: {
+                    const { type, stacking, titles: { chart, x_axis, y_axis, }, extras: { multi_y_axis, ...extras_other }, data } = this.value;
+                    const { value: [keys, values] } = new DdbDict({
+                        chartType: new DdbInt(type),
+                        stacking,
+                        title: new DdbVectorString([chart, x_axis, y_axis]),
+                        extras: new DdbDict({
+                            multiYAxis: multi_y_axis,
+                            ...extras_other
+                        }),
+                        data,
+                    });
+                    return [
+                        keys.pack(),
+                        values.pack(),
+                    ];
+                }
                 case DdbForm.matrix: {
                     const { rows, cols, data } = value;
                     return [
@@ -917,6 +972,8 @@ class DdbObj {
                     return `table[${this.rows}r][${this.cols}c]`;
                 case DdbForm.dict:
                     return `dict<${DdbType[this.value[0].type]}, ${DdbType[this.value[1].type]}>`;
+                case DdbForm.chart:
+                    return `chart<${DdbChartType[this.value.type]}>`;
                 case DdbForm.matrix:
                     return `matrix<${tname}>[${this.rows}r][${this.cols}c]`;
                 default:
@@ -1012,9 +1069,27 @@ class DdbObj {
         })();
         return `${options.colors ? type.blue : type}(${this.name ? `${(0, utils_js_1.inspect)(this.name, options)}, ` : ''}${data})`;
     }
+    /** 自动转换 js string, boolean 为 DdbObj */
+    static to_ddbobj(value) {
+        if (value && value instanceof DdbObj)
+            return value;
+        const type = typeof value;
+        switch (type) {
+            case 'string':
+                return new DdbString(value);
+            case 'boolean':
+                return new DdbBool(value);
+            default:
+                throw new Error(`Cannot automatically convert ${type} to DdbObj`);
+        }
+    }
+    /** 转换 js 数组为 DdbObj[] */
+    static to_ddbobjs(values) {
+        return values.map(value => this.to_ddbobj(value));
+    }
     to_rows() {
         if (this.form !== DdbForm.table)
-            throw new Error('this.form 不是 DdbForm.table, 不能 to_rows');
+            throw new Error('this.form is not DdbForm.table, cannot to_rows');
         let rows = new Array(this.rows);
         for (let i = 0; i < this.rows; i++) {
             let row = {};
@@ -1045,13 +1120,22 @@ class DdbObj {
         }
         return rows;
     }
-    to_dict() {
+    to_dict({ strip, deep, } = {}) {
         if (this.form !== DdbForm.dict)
-            throw new Error('this.form 不是 DdbForm.dict, 不能转换为 Object');
-        const [{ value: keys }, { value: values }] = this.value;
+            throw new Error('this.form is not DdbForm.dict and cannot be converted to js object');
+        const [{ value: keys, type: key_type }, { value: values, type: value_type }] = this.value;
+        if (key_type !== DdbType.string || value_type !== DdbType.any)
+            throw new Error('Not dict<string, any>, automatic conversion to js object is not supported for the time being');
+        if (deep && !strip)
+            throw new Error('strip = true must be set when deep = true');
         let obj = {};
-        for (let i = 0; i < this.rows; i++)
-            obj[keys[i]] = values[i].value;
+        for (let i = 0; i < this.rows; i++) {
+            let value = values[i];
+            if (deep && value.form === DdbForm.dict)
+                obj[keys[i]] = value.to_dict({ strip, deep });
+            else
+                obj[keys[i]] = strip ? value.value : value;
+        }
         return obj;
     }
 }
@@ -1432,7 +1516,7 @@ class DdbVectorAny extends DdbObj {
             type: DdbType.any,
             rows: objs.length,
             cols: 1,
-            value: objs,
+            value: DdbObj.to_ddbobjs(objs),
             name,
         });
     }
@@ -1524,6 +1608,36 @@ class DdbSetString extends DdbObj {
     }
 }
 exports.DdbSetString = DdbSetString;
+/** Constructs a DdbDict object, which supports two usages:
+     - The incoming type is the keys of DdbObj<DdbVectorValue>, and the two parameters of values directly form the DdbDict of dict<keys.type, values.type>
+     - Pass in js object (type is Record<string, boolean | string | DdbObj>), automatically converted to DdbDict of dict<string, any>
+*/
+class DdbDict extends DdbObj {
+    constructor(arg0, arg1) {
+        if (arg1)
+            super({
+                form: DdbForm.dict,
+                type: arg1.type,
+                rows: arg0.rows,
+                cols: 2,
+                value: [arg0, arg1]
+            });
+        else {
+            const keys = Object.keys(arg0);
+            super({
+                form: DdbForm.dict,
+                type: DdbType.any,
+                rows: keys.length,
+                cols: 2,
+                value: [
+                    new DdbVectorString(keys),
+                    new DdbVectorAny(Object.values(arg0))
+                ]
+            });
+        }
+    }
+}
+exports.DdbDict = DdbDict;
 class DdbTable extends DdbObj {
     constructor(columns, name = '') {
         super({
@@ -2014,7 +2128,7 @@ class DDB {
                 reject(error);
             }
         };
-        args = this.to_ddbobjs(args);
+        args = DdbObj.to_ddbobjs(args);
         const command = this.enc.encode((() => {
             switch (type) {
                 case 'function':
@@ -2082,7 +2196,7 @@ class DDB {
             args = [
                 new DdbVectorString(nodes),
                 func,
-                new DdbVectorAny(this.to_ddbobjs(args)),
+                new DdbVectorAny(args),
                 ...(() => {
                     if (typeof add_node_alias !== 'undefined')
                         return [add_node_alias];
@@ -2163,24 +2277,6 @@ class DDB {
                     })
         };
     }
-    /** 自动转换 js string, boolean 为 DdbObj */
-    to_ddbobj(value) {
-        if (value instanceof DdbObj)
-            return value;
-        const type = typeof value;
-        switch (type) {
-            case 'string':
-                return new DdbString(value);
-            case 'boolean':
-                return new DdbBool(value);
-            default:
-                throw new Error(`不能自动转换 ${type} 至 DdbObj`);
-        }
-    }
-    /** 转换 js 数组为 DdbObj[] */
-    to_ddbobjs(values) {
-        return values.map(value => this.to_ddbobj(value));
-    }
 }
 exports.DDB = DDB;
 /** little endian (client) */