@mescius/spread-sheets 19.0.5 → 19.0.6

package/dist/gc.spread.sheets.d.ts

@@ -7262,11 +7262,11 @@ declare module GC{
                  * @param {GC.Spread.Pivot.PivotTable} pivotTable  Indicates the pivot table which is attached.
                  * @returns void
                  */
-                attach(pivotTable: GC.Spread.Pivot.PivotTable): any;
+                attach(pivotTable: GC.Spread.Pivot.PivotTable): void;
                 /**
                  * @description destroy the PivotPanel.
                  */
-                destroy(): any;
+                destroy(): void;
                 /**
                  * @description detach the pivot table for pivot panel, stop the pivot panel control bound pivot table.
                  * @returns void
@@ -20130,13 +20130,11 @@ declare module GC{
                  * @param eventParam *{@link GC.Spread.Sheets.Collaboration.IPermission}* `permission` The sheet that triggered the event.
                  * @example
                  * ```javascript
-                 * ```javascript
                  * //This example uses the ThreadedCommentChanged event.
                  * spread.bind(GC.Spread.Sheets.Events.PermissionChanged, function (e, info) {
                  *     console.log(info.permission);
                  * });
                  * ```
-                 * ```
                  */
                 static PermissionChanged: string;
                 /**
@@ -21397,13 +21395,11 @@ declare module GC{
                  * @param eventParam *string[]* `userIds` The user ids that were mentioned.
                  * @example
                  * ```javascript
-                 * ```javascript
                  * //This example uses the ThreadedCommentChanged event.
                  * sheet.bind(GC.Spread.Sheets.Events.UserMentioned, function (e, info) {
                  *     console.log(info.userId);
                  * });
                  * ```
-                 * ```
                  */
                 static UserMentioned: string;
                 /**
@@ -21748,7 +21744,7 @@ declare module GC{
                  * sheet.pivotTables.remove("pivotTable_1");
                  * ```
                  */
-                remove(name: string): any;
+                remove(name: string): void;
             }
 
             export class Point{
@@ -23083,7 +23079,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Apex: ColorScheme;
+                static Apex: ColorScheme;
                 /**
                  * The theme color of the Aspect theme.
                  * @example
@@ -23094,7 +23090,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Aspect: ColorScheme;
+                static Aspect: ColorScheme;
                 /**
                  * The theme color of the Civic theme.
                  * @example
@@ -23105,7 +23101,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Civic: ColorScheme;
+                static Civic: ColorScheme;
                 /**
                  * The theme color of the Concourse theme.
                  * @example
@@ -23116,7 +23112,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Concourse: ColorScheme;
+                static Concourse: ColorScheme;
                 /**
                  * The theme color of the Default theme.
                  * @example
@@ -23127,7 +23123,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Default: ColorScheme;
+                static Default: ColorScheme;
                 /**
                  * The theme color of the Equity theme.
                  * @example
@@ -23138,7 +23134,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Equity: ColorScheme;
+                static Equity: ColorScheme;
                 /**
                  * The theme color of the Flow theme.
                  * @example
@@ -23149,7 +23145,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Flow: ColorScheme;
+                static Flow: ColorScheme;
                 /**
                  * The theme color of the Foundry theme.
                  * @example
@@ -23160,7 +23156,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Foundry: ColorScheme;
+                static Foundry: ColorScheme;
                 /**
                  * The theme color of the Median theme.
                  * @example
@@ -23171,7 +23167,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Median: ColorScheme;
+                static Median: ColorScheme;
                 /**
                  * The theme color of the Metro theme.
                  * @example
@@ -23182,7 +23178,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Metro: ColorScheme;
+                static Metro: ColorScheme;
                 /**
                  * The theme color of the Module theme.
                  * @example
@@ -23193,7 +23189,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Module: ColorScheme;
+                static Module: ColorScheme;
                 /**
                  * The theme color of the Office theme.
                  * @example
@@ -23204,7 +23200,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Office: ColorScheme;
+                static Office: ColorScheme;
                 /**
                  * The theme color of the Office 2007 theme.
                  * @example
@@ -23215,7 +23211,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Office2007: ColorScheme;
+                static Office2007: ColorScheme;
                 /**
                  * The theme color of the Opulent theme.
                  * @example
@@ -23226,7 +23222,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Opulent: ColorScheme;
+                static Opulent: ColorScheme;
                 /**
                  * The theme color of the Oriel theme.
                  * @example
@@ -23237,7 +23233,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Oriel: ColorScheme;
+                static Oriel: ColorScheme;
                 /**
                  * The theme color of the Origin theme.
                  * @example
@@ -23248,7 +23244,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Origin: ColorScheme;
+                static Origin: ColorScheme;
                 /**
                  * The theme color of the Paper theme.
                  * @example
@@ -23259,7 +23255,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Paper: ColorScheme;
+                static Paper: ColorScheme;
                 /**
                  * The theme color of the Solstice theme.
                  * @example
@@ -23270,7 +23266,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Solstice: ColorScheme;
+                static Solstice: ColorScheme;
                 /**
                  * The theme color of the Technic theme.
                  * @example
@@ -23281,7 +23277,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Technic: ColorScheme;
+                static Technic: ColorScheme;
                 /**
                  * The theme color of the Trek theme.
                  * @example
@@ -23292,7 +23288,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Trek: ColorScheme;
+                static Trek: ColorScheme;
                 /**
                  * The theme color of the Urban theme.
                  * @example
@@ -23303,7 +23299,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Urban: ColorScheme;
+                static Urban: ColorScheme;
                 /**
                  * The theme color of the Verve theme.
                  * @example
@@ -23314,7 +23310,7 @@ declare module GC{
                  * activeSheet.repaint();
                  * ```
                  */
-                Verve: ColorScheme;
+                static Verve: ColorScheme;
             }
 
             export class ThemeFont{
@@ -23437,87 +23433,87 @@ declare module GC{
                 /**
                  * The theme font named BookmanGillSansMT.
                  */
-                BookmanGillSansMT: GC.Spread.Sheets.ThemeFont;
+                static BookmanGillSansMT: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named CalibriConstantia.
                  */
-                CalibriConstantia: GC.Spread.Sheets.ThemeFont;
+                static CalibriConstantia: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named CenturyGothic.
                  */
-                CenturyGothic: GC.Spread.Sheets.ThemeFont;
+                static CenturyGothic: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named CenturySchoolbook.
                  */
-                CenturySchoolbook: GC.Spread.Sheets.ThemeFont;
+                static CenturySchoolbook: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named ConsolasCorbel.
                  */
-                ConsolasCorbel: GC.Spread.Sheets.ThemeFont;
+                static ConsolasCorbel: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named Constantia.
                  */
-                Constantia: GC.Spread.Sheets.ThemeFont;
+                static Constantia: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named Corbel.
                  */
-                Corbel: GC.Spread.Sheets.ThemeFont;
+                static Corbel: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named FranklinGothic.
                  */
-                FranklinGothic: GC.Spread.Sheets.ThemeFont;
+                static FranklinGothic: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named FranklinGothicArial.
                  */
-                FranklinGothicArial: GC.Spread.Sheets.ThemeFont;
+                static FranklinGothicArial: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named FranklinGothicPerpetua.
                  */
-                FranklinGothicPerpetua: GC.Spread.Sheets.ThemeFont;
+                static FranklinGothicPerpetua: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named Georgia.
                  */
-                Georgia: GC.Spread.Sheets.ThemeFont;
+                static Georgia: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named GillSansMT.
                  */
-                GillSansMT: GC.Spread.Sheets.ThemeFont;
+                static GillSansMT: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named LucidaBook.
                  */
-                LucidaBook: GC.Spread.Sheets.ThemeFont;
+                static LucidaBook: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named LucidaSansUnicode.
                  */
-                LucidaSansUnicode: GC.Spread.Sheets.ThemeFont;
+                static LucidaSansUnicode: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named Office.
                  */
-                Office: GC.Spread.Sheets.ThemeFont;
+                static Office: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named Office2007.
                  */
-                Office2007: GC.Spread.Sheets.ThemeFont;
+                static Office2007: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named Rockwell.
                  */
-                Rockwell: GC.Spread.Sheets.ThemeFont;
+                static Rockwell: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named TrebuchetGeorgia.
                  */
-                TrebuchetGeorgia: GC.Spread.Sheets.ThemeFont;
+                static TrebuchetGeorgia: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named TrebuchetMS.
                  */
-                TrebuchetMS: GC.Spread.Sheets.ThemeFont;
+                static TrebuchetMS: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named TwCenMT.
                  */
-                TwCenMT: GC.Spread.Sheets.ThemeFont;
+                static TwCenMT: GC.Spread.Sheets.ThemeFont;
                 /**
                  * The theme font named Verdana.
                  */
-                Verdana: GC.Spread.Sheets.ThemeFont;
+                static Verdana: GC.Spread.Sheets.ThemeFont;
             }
 
             export class Themes{
@@ -23529,91 +23525,91 @@ declare module GC{
                 /**
                  * Indicates the Apex theme.
                  */
-                Apex: Theme;
+                static Apex: Theme;
                 /**
                  * Indicates the Aspect theme.
                  */
-                Aspect: Theme;
+                static Aspect: Theme;
                 /**
                  * Indicates the Civic theme.
                  */
-                Civic: Theme;
+                static Civic: Theme;
                 /**
                  * Indicates the Concourse theme.
                  */
-                Concourse: Theme;
+                static Concourse: Theme;
                 /**
                  * Indicates the Default theme.
                  */
-                Default: Theme;
+                static Default: Theme;
                 /**
                  * Indicates the Equity theme.
                  */
-                Equity: Theme;
+                static Equity: Theme;
                 /**
                  * Indicates the Flow theme.
                  */
-                Flow: Theme;
+                static Flow: Theme;
                 /**
                  * Indicates the Foundry theme.
                  */
-                Foundry: Theme;
+                static Foundry: Theme;
                 /**
                  * Indicates the Median theme.
                  */
-                Median: Theme;
+                static Median: Theme;
                 /**
                  * Indicates the Metro theme.
                  */
-                Metro: Theme;
+                static Metro: Theme;
                 /**
                  * Indicates the Module theme.
                  */
-                Module: Theme;
+                static Module: Theme;
                 /**
                  * Indicates the Office theme.
                  */
-                Office: Theme;
+                static Office: Theme;
                 /**
                  * Indicates the Office 2007 theme.
                  */
-                Office2007: Theme;
+                static Office2007: Theme;
                 /**
                  * Indicates the Opulent theme.
                  */
-                Opulent: Theme;
+                static Opulent: Theme;
                 /**
                  * Indicates the Oriel theme.
                  */
-                Oriel: Theme;
+                static Oriel: Theme;
                 /**
                  * Indicates the Origin theme.
                  */
-                Origin: Theme;
+                static Origin: Theme;
                 /**
                  * Indicates the Paper theme.
                  */
-                Paper: Theme;
+                static Paper: Theme;
                 /**
                  * Indicates the Solstice theme.
                  */
-                Solstice: Theme;
+                static Solstice: Theme;
                 /**
                  * Indicates the Technic theme.
                  */
-                Technic: Theme;
+                static Technic: Theme;
                 /**
                  * Indicates the Trek theme.
                  */
-                Trek: Theme;
+                static Trek: Theme;
                 /**
                  * Indicates the Urban theme.
                  */
-                Urban: Theme;
+                static Urban: Theme;
                 /**
                  * Indicates the Verve theme.
                  */
-                Verve: Theme;
+                static Verve: Theme;
             }
 
             export class Workbook{
@@ -27894,18 +27890,25 @@ declare module GC{
             module AI{
 
                 /**
-                 * @param {IAIConfig} config
-                 * @returns {Promise<any>}
+                 * Callback function type for sending an AI request.
+                 * @typedef {Function} AIRequestCallback
+                 * @param {IAIConfig} config - Request parameters to forward to the AI provider.
+                 * @returns {Promise<any>} Promise that resolves with the provider response.
                  */
                 export type AIRequestCallback = 
                     (config: IAIConfig) => Promise<any>
                 
 
                 /**
-                 * @property {{ role: string; content: string }[]} [messages]
-                 * @property {number} [temperature]
-                 * @property {number} [max_tokens]
-                 * @property {boolean} [stream]
+                 * Simplified request body passed to the AI provider.
+                 * This shape is compatible with the OpenAI Chat Completions API request body used by this plugin,
+                 * while allowing additional OpenAI-compatible fields to pass through as custom properties.
+                 * @typedef {Object} IAIConfig
+                 * @property {{ role: string; content: string }[]} [messages] - Array of message objects containing role and content pairs for conversation history
+                 * @property {number} [temperature] - Sampling temperature for the generated response. Higher values make output more random.
+                 * @property {number} [max_tokens] - Legacy maximum output token limit.
+                 * @property {boolean} [stream] - Whether to return the response as a server-sent event stream (SSE).
+                 * @property {any} [key: string] - Additional provider-specific or OpenAI-compatible request properties, such as `model` or `max_completion_tokens`.
                  */
                 export type IAIConfig = 
                     {
@@ -27918,14 +27921,25 @@ declare module GC{
                 
 
                 /**
-                 * @property {string} model
-                 * @property {string} key
-                 * @property {string} basePath
+                 * Environment configuration for the AI service endpoint.
+                 * @typedef {Object} IAIEnvironment
+                 * @property {string} model - Model identifier added to the outbound request body, for example an OpenAI chat model name.
+                 * @property {string} key - API key used in the `Authorization: Bearer` request header.
+                 * @property {string} basePath - HTTP endpoint that receives the JSON request body, for example a server route or OpenAI-compatible API URL.
                  */
                 export type IAIEnvironment = 
                     {
+                        /**
+                         * Model identifier added to the outbound request body, for example an OpenAI chat model name.
+                         */
                         model: string;
+                        /**
+                         * API key used in the `Authorization: Bearer` request header.
+                         */
                         key: string;
+                        /**
+                         * HTTP endpoint that receives the JSON request body, for example a server route or OpenAI-compatible API URL.
+                         */
                         basePath: string;
                     }
                 
@@ -39789,7 +39803,7 @@ declare module GC{
                      */
                     type?:string;
                     /**
-                     * Represents on which area this context menu item should be shown. Value can be a collection of conditions separated by whitespace. Include: "outline", "rowHeader", "colHeader", "corner", "slicer", "chart", "shape", "table", "vpWithoutTb", "pivotPageFilter", "pivotTopLeft", "pivotEmptyLabel", "pivotHeader", "pivotGrandTotal", "pivotContent", "pivotTable", "sheetTab", "timeline".
+                     * Represents on which area this context menu item should be shown. Value can be a collection of conditions separated by whitespace. Include: "viewport", "rowHeader", "colHeader", "corner", "sheetTab", "outline", "slicer", "timeline", "chart", "shape", "table", "vpWithoutTb", "pivotPageFilter", "pivotTopLeft", "pivotEmptyLabel", "pivotHeader", "pivotGrandTotal", "pivotContent", "pivotTable", "GanttRowHeader", "GanttField", "GanttColumn".
                      */
                     workArea?:string;
                     /**
@@ -39848,7 +39862,7 @@ declare module GC{
                      * @property {string} [group] - Represent this context menu item is a group menu item and this property's value should be it's group header's name.
                      * @property {Object[]} [subMenu] - Represent this context menu item has sub menu.
                      * @property {string} [type] - Represent a context menu's type.
-                     * @property {string} [workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "outline","rowHeader","colHeader","corner","slicer","chart","shape","table","vpWithoutTb","pivotPageFilter","pivotTopLeft","pivotEmptyLabel","pivotHeader","pivotGrandTotal","pivotContent","pivotTable".
+                     * @property {string} [workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "viewport","rowHeader","colHeader","corner","sheetTab","outline","slicer","timeline","chart","shape","table","vpWithoutTb","pivotPageFilter","pivotTopLeft","pivotEmptyLabel","pivotHeader","pivotGrandTotal","pivotContent","pivotTable","GanttRowHeader","GanttField","GanttColumn".
                      */
                     menuData: GC.Spread.Sheets.ContextMenu.IMenuItemData[];
                     /**
@@ -39952,7 +39966,7 @@ declare module GC{
                      * @param {string} [menuData.group] - Represent this context menu item is a group menu item and this param's value should be it's group header's name.
                      * @param {Object[]} [menuData.subMenu] - Represent this context menu item has sub menu.
                      * @param {string} [menuData.type] - Represent a context menu's type.
-                     * @param {string} [menuData.workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "outline","rowHeader","colHeader","corner","slicer","chart","shape","table","vpWithoutTb","pivotPageFilter","pivotTopLeft","pivotEmptyLabel","pivotHeader","pivotGrandTotal","pivotContent","pivotTable".
+                     * @param {string} [menuData.workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "viewport","rowHeader","colHeader","corner","sheetTab","outline","slicer","timeline","chart","shape","table","vpWithoutTb","pivotPageFilter","pivotTopLeft","pivotEmptyLabel","pivotHeader","pivotGrandTotal","pivotContent","pivotTable","GanttRowHeader","GanttField","GanttColumn".
                      * @param {Object[]} itemsDataForShown
                      * @param {string} [itemsDataForShown.name] - Represent context menu item's identify.
                      * @param {string} [itemsDataForShown.text] - Represent the text to be shown,if this context menu item is a group,text will be shown as DOM element's title.
@@ -39962,7 +39976,7 @@ declare module GC{
                      * @param {string} [itemsDataForShown.group] - Represent this context menu item is a group menu item and this param's value should be it's group header's name.
                      * @param {Object[]} [itemsDataForShown.subMenu] - Represent this context menu item has sub menu.
                      * @param {string} [itemsDataForShown.type] - Represent a context menu's type.
-                     * @param {string} [itemsDataForShown.workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "outline","rowHeader","colHeader","corner","slicer","chart","shape","table","vpWithoutTb","pivotPageFilter","pivotTopLeft","pivotEmptyLabel","pivotHeader","pivotGrandTotal","pivotContent","pivotTable".
+                     * @param {string} [itemsDataForShown.workArea] - Represent this context menu item's should be shown on what area,value can be a collection of conditions,separate by whitespace. include: "viewport","rowHeader","colHeader","corner","sheetTab","outline","slicer","timeline","chart","shape","table","vpWithoutTb","pivotPageFilter","pivotTopLeft","pivotEmptyLabel","pivotHeader","pivotGrandTotal","pivotContent","pivotTable","GanttRowHeader","GanttField","GanttColumn".
                      * @param {Object} hitInfo
                      * @param {Object} spread
                      * @return {boolean} indicate whether or not the contextmenu event has been processed done
@@ -44193,7 +44207,7 @@ declare module GC{
                      * @param {GC.Spread.Sheets.Workbook} workbook Indicates the workbook which is attached.
                      * @returns void
                      */
-                    attach(workbook: GC.Spread.Sheets.Workbook): any;
+                    attach(workbook: GC.Spread.Sheets.Workbook): void;
                     /**
                      * Gets the command manager.
                      * @returns {GC.Spread.Commands.CommandManager} The command manager.
@@ -62368,11 +62382,11 @@ declare module GC{
                      * @param {GC.Spread.Sheets.Workbook} workbook Indicates the workbook which is attached.
                      * @returns void
                      */
-                    attach(workbook: GC.Spread.Sheets.Workbook): any;
+                    attach(workbook: GC.Spread.Sheets.Workbook): void;
                     /**
                      * @description destroy the PivotPanel.
                      */
-                    destroy(): any;
+                    destroy(): void;
                     /**
                      * @description detach the workbook for threaded comment panel.
                      * @returns void

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mescius/spread-sheets",
-  "version": "19.0.5",
+  "version": "19.0.6",
   "main": "index.js",
   "description":"A Complete Microsoft Excel-like JavaScript Spreadsheet for Enterprise Applications",
   "scripts": {},