diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml index 2db977be..a2848618 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml @@ -78,7 +78,9 @@ methods: uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerSize:member(1)' package: ExcelScript! fullName: getMarkerSize() - summary: Represents marker size of a data point. + summary: >- + Represents marker size of a data point. The supported size range is 2 to 72. This method returns an + InvalidArgument error if it's set with a size outside of the supported range. remarks: '' isPreview: false isDeprecated: false @@ -168,7 +170,9 @@ methods: uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerSize:member(1)' package: ExcelScript! fullName: setMarkerSize(markerSize) - summary: Represents marker size of a data point. + summary: >- + Represents marker size of a data point. The supported size range is 2 to 72. This method returns an + InvalidArgument error if it's set with a size outside of the supported range. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml index e8bbc231..b07882d2 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml @@ -525,7 +525,9 @@ methods: uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerSize:member(1)' package: ExcelScript! fullName: getMarkerSize() - summary: Specifies the marker size of a chart series. + summary: >- + Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an + InvalidArgument error if it's set with a size outside of the supported range. remarks: '' isPreview: false isDeprecated: false @@ -1236,7 +1238,9 @@ methods: uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerSize:member(1)' package: ExcelScript! fullName: setMarkerSize(markerSize) - summary: Specifies the marker size of a chart series. + summary: >- + Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an + InvalidArgument error if it's set with a size outside of the supported range. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatrule.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatrule.yml index c4dd4cac..2f57c174 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatrule.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatrule.yml @@ -4,7 +4,32 @@ uid: 'ExcelScript!ExcelScript.ConditionalFormatRule:interface' package: ExcelScript! fullName: ExcelScript.ConditionalFormatRule summary: 'Represents a rule, for all traditional rule/format pairings.' -remarks: '' +remarks: |- + + + #### Examples + + ```TypeScript + /** + * This script applies a custom conditional formatting to the selected range. + * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column. + */ + function main(workbook: ExcelScript.Workbook) { + // Get the selected cells. + let selectedRange = workbook.getSelectedRange(); + + // Apply a rule for positive change from the previous column. + let positiveChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); + + // Set the conditional format to be a lightgreen fill. + let positiveCustom: ExcelScript.CustomConditionalFormat = positiveChange.getCustom(); + positiveCustom.getFormat().getFill().setColor("lightgreen"); + + // Set the conditional rule to be if there is positive change across the row. + let positiveRule: ExcelScript.ConditionalFormatRule = positiveCustom.getRule(); + positiveRule.setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); + } + ``` isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.customconditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.customconditionalformat.yml index f33aa514..b85d1f35 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.customconditionalformat.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.customconditionalformat.yml @@ -19,19 +19,22 @@ remarks: |- let selectedRange = workbook.getSelectedRange(); // Apply a rule for positive change from the previous column. - let positiveChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); - positiveChange.getCustom().getFormat().getFill().setColor("lightgreen"); - positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); + let positiveChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); + let positiveCustom: ExcelScript.CustomConditionalFormat = positiveChange.getCustom(); + positiveCustom.getFormat().getFill().setColor("lightgreen"); + positiveCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); // Apply a rule for negative change from the previous column. - let negativeChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); - negativeChange.getCustom().getFormat().getFill().setColor("pink"); - negativeChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}<${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); + let negativeChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); + let negativeCustom: ExcelScript.CustomConditionalFormat = negativeChange.getCustom(); + negativeCustom.getFormat().getFill().setColor("pink"); + negativeCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}<${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); // Apply a rule for no change from the previous column. - let noChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); - noChange.getCustom().getFormat().getFill().setColor("lightyellow"); - noChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}=${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); + let sameChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); + let sameCustom: ExcelScript.CustomConditionalFormat = sameChange.getCustom(); + sameCustom.getFormat().getFill().setColor("lightyellow"); + sameCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}=${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); } ``` isPreview: false diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml index 73888f3e..bd6d1b1a 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml @@ -54,7 +54,7 @@ methods: fullName: getInvalidCells() summary: >- Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell - values are valid, this method returns `null`. + values are valid, this function will return `null`. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml index 77d80492..7f218486 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml @@ -82,7 +82,7 @@ properties: uid: 'ExcelScript!ExcelScript.PivotLabelFilter#substring:member' package: ExcelScript! fullName: substring - summary: 'The substring used for `beginsWith`, `endsWith`, and `contains` filter conditions.' + summary: 'The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions.' remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml index 87a4214f..028a7a56 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml @@ -1290,7 +1290,7 @@ methods: summary: >- Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object - doesn't exist, then this method returns `undefined`. + doesn't exist, then this function returns `undefined`. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml index bd13b3bf..9eb1d11f 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml @@ -3,7 +3,7 @@ name: ExcelScript.SortMethod uid: 'ExcelScript!ExcelScript.SortMethod:enum' package: ExcelScript! fullName: ExcelScript.SortMethod -summary: '' +summary: Represents the ordering method to be used when sorting Chinese characters. remarks: |- diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml index 46c783ee..286a8141 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml @@ -1614,7 +1614,7 @@ methods: uid: 'ExcelScript!ExcelScript.Workbook#refreshAllDataConnections:member(1)' package: ExcelScript! fullName: refreshAllDataConnections() - summary: Makes a request to refresh all the data connections. + summary: Refreshes all the Data Connections. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml index 1a164ea4..a8161069 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml @@ -45,7 +45,7 @@ methods: uid: 'ExcelScript!ExcelScript.WorkbookProtection#protect:member(1)' package: ExcelScript! fullName: protect(password) - summary: Protects a workbook. Fails if the workbook has been protected. + summary: Protects the workbook. Fails if the workbook has been protected. remarks: '' isPreview: false isDeprecated: false @@ -80,7 +80,7 @@ methods: uid: 'ExcelScript!ExcelScript.WorkbookProtection#unprotect:member(1)' package: ExcelScript! fullName: unprotect(password) - summary: Unprotects a workbook. + summary: Unprotects the workbook. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml index 844ad5f3..ff6ca1e3 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml @@ -792,7 +792,7 @@ methods: ```TypeScript /** * This script searches through a worksheet and finds cells containing "No". - * Those cells are filled red. + * Those cells are filled with the color red. * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range. */ function main(workbook: ExcelScript.Workbook) { @@ -1067,7 +1067,7 @@ methods: uid: 'ExcelScript!ExcelScript.Worksheet#getName:member(1)' package: ExcelScript! fullName: getName() - summary: The display name of the worksheet. + summary: The display name of the worksheet. The name must be fewer than 32 characters. remarks: '' isPreview: false isDeprecated: false @@ -1740,7 +1740,7 @@ methods: uid: 'ExcelScript!ExcelScript.Worksheet#setName:member(1)' package: ExcelScript! fullName: setName(name) - summary: The display name of the worksheet. + summary: The display name of the worksheet. The name must be fewer than 32 characters. remarks: '' isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetsearchcriteria.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetsearchcriteria.yml index 786a1569..3463a2c5 100644 --- a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetsearchcriteria.yml +++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetsearchcriteria.yml @@ -4,7 +4,32 @@ uid: 'ExcelScript!ExcelScript.WorksheetSearchCriteria:interface' package: ExcelScript! fullName: ExcelScript.WorksheetSearchCriteria summary: Represents the worksheet search criteria to be used. -remarks: '' +remarks: |- + + + #### Examples + + ```TypeScript + /** + * This script searches through a worksheet and finds cells containing "No". + * Those cells are filled with the color red. + * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range. + */ + function main(workbook: ExcelScript.Workbook) { + // Get the current, active worksheet. + const worksheet = workbook.getActiveWorksheet(); + + // Get all the cells that exactly contain the string "No". + const searchCriteria: ExcelScript.WorksheetSearchCriteria = { + completeMatch: true, + matchCase: true + }; + const noCells = worksheet.findAll("No", searchCriteria); + + // Set the fill color to red. + noCells.getFormat().getFill().setColor("red"); + } + ``` isPreview: false isDeprecated: false type: interface diff --git a/docs/sample-scripts/excel-scripts.yaml b/docs/sample-scripts/excel-scripts.yaml index e1e2be03..2aebabe7 100644 --- a/docs/sample-scripts/excel-scripts.yaml +++ b/docs/sample-scripts/excel-scripts.yaml @@ -1250,6 +1250,27 @@ }; presetFormat.setRule(duplicateRule); } +'ExcelScript.ConditionalFormatRule:interface': + - |- + /** + * This script applies a custom conditional formatting to the selected range. + * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column. + */ + function main(workbook: ExcelScript.Workbook) { + // Get the selected cells. + let selectedRange = workbook.getSelectedRange(); + + // Apply a rule for positive change from the previous column. + let positiveChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); + + // Set the conditional format to be a lightgreen fill. + let positiveCustom: ExcelScript.CustomConditionalFormat = positiveChange.getCustom(); + positiveCustom.getFormat().getFill().setColor("lightgreen"); + + // Set the conditional rule to be if there is positive change across the row. + let positiveRule: ExcelScript.ConditionalFormatRule = positiveCustom.getRule(); + positiveRule.setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); + } 'ExcelScript.ConditionalFormatRuleType:enum': - |- /** @@ -1640,19 +1661,22 @@ let selectedRange = workbook.getSelectedRange(); // Apply a rule for positive change from the previous column. - let positiveChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); - positiveChange.getCustom().getFormat().getFill().setColor("lightgreen"); - positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); + let positiveChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); + let positiveCustom: ExcelScript.CustomConditionalFormat = positiveChange.getCustom(); + positiveCustom.getFormat().getFill().setColor("lightgreen"); + positiveCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); // Apply a rule for negative change from the previous column. - let negativeChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); - negativeChange.getCustom().getFormat().getFill().setColor("pink"); - negativeChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}<${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); + let negativeChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); + let negativeCustom: ExcelScript.CustomConditionalFormat = negativeChange.getCustom(); + negativeCustom.getFormat().getFill().setColor("pink"); + negativeCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}<${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); // Apply a rule for no change from the previous column. - let noChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); - noChange.getCustom().getFormat().getFill().setColor("lightyellow"); - noChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}=${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); + let sameChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom); + let sameCustom: ExcelScript.CustomConditionalFormat = sameChange.getCustom(); + sameCustom.getFormat().getFill().setColor("lightyellow"); + sameCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}=${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`); } 'ExcelScript.CustomDataValidation:interface': - |- @@ -6748,7 +6772,7 @@ - |- /** * This script searches through a worksheet and finds cells containing "No". - * Those cells are filled red. + * Those cells are filled with the color red. * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range. */ function main(workbook: ExcelScript.Workbook) { @@ -7006,4 +7030,25 @@ // Apply the given protection options. sheetProtection.protect(protectionOptions); + } +'ExcelScript.WorksheetSearchCriteria:interface': + - |- + /** + * This script searches through a worksheet and finds cells containing "No". + * Those cells are filled with the color red. + * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range. + */ + function main(workbook: ExcelScript.Workbook) { + // Get the current, active worksheet. + const worksheet = workbook.getActiveWorksheet(); + + // Get all the cells that exactly contain the string "No". + const searchCriteria: ExcelScript.WorksheetSearchCriteria = { + completeMatch: true, + matchCase: true + }; + const noCells = worksheet.findAll("No", searchCriteria); + + // Set the fill color to red. + noCells.getFormat().getFill().setColor("red"); } \ No newline at end of file diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index ea312c9f..0f592ca4 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -1213,7 +1213,7 @@ ExcelScript.ConditionalFormatPresetCriterion,"twoStdDevAboveAverage",EnumField,M ExcelScript.ConditionalFormatPresetCriterion,"twoStdDevBelowAverage",EnumField,Missing,false ExcelScript.ConditionalFormatPresetCriterion,"uniqueValues",EnumField,Missing,false ExcelScript.ConditionalFormatPresetCriterion,"yesterday",EnumField,Missing,false -ExcelScript.ConditionalFormatRule,N/A,Class,Fine,false +ExcelScript.ConditionalFormatRule,N/A,Class,Fine,true ExcelScript.ConditionalFormatRule,"getFormula()",Method,Poor,false ExcelScript.ConditionalFormatRule,"getFormulaLocal()",Method,Poor,false ExcelScript.ConditionalFormatRule,"setFormula(formula)",Method,Poor,false @@ -2925,7 +2925,7 @@ ExcelScript.SortField,"icon",Property,Fine,false ExcelScript.SortField,"key",Property,Good,true ExcelScript.SortField,"sortOn",Property,Fine,false ExcelScript.SortField,"subField",Property,Fine,false -ExcelScript.SortMethod,N/A,Enum,Missing,true +ExcelScript.SortMethod,N/A,Enum,Fine,true ExcelScript.SortMethod,"pinYin",EnumField,Missing,false ExcelScript.SortMethod,"strokeCount",EnumField,Missing,false ExcelScript.SortOn,N/A,Enum,Fine,true @@ -3246,7 +3246,7 @@ ExcelScript.Worksheet,"getEnableCalculation()",Method,Poor,false ExcelScript.Worksheet,"getFreezePanes()",Method,Poor,false ExcelScript.Worksheet,"getHorizontalPageBreaks()",Method,Poor,false ExcelScript.Worksheet,"getId()",Method,Poor,false -ExcelScript.Worksheet,"getName()",Method,Poor,true +ExcelScript.Worksheet,"getName()",Method,Fine,true ExcelScript.Worksheet,"getNamedItem(name)",Method,Poor,false ExcelScript.Worksheet,"getNamedSheetView(key)",Method,Poor,false ExcelScript.Worksheet,"getNamedSheetViews()",Method,Poor,false @@ -3340,6 +3340,6 @@ ExcelScript.WorksheetProtectionOptions,"allowInsertRows",Property,Fine,false ExcelScript.WorksheetProtectionOptions,"allowPivotTables",Property,Fine,false ExcelScript.WorksheetProtectionOptions,"allowSort",Property,Fine,false ExcelScript.WorksheetProtectionOptions,"selectionMode",Property,Fine,false -ExcelScript.WorksheetSearchCriteria,N/A,Class,Fine,false +ExcelScript.WorksheetSearchCriteria,N/A,Class,Fine,true ExcelScript.WorksheetSearchCriteria,"completeMatch",Property,Good,false ExcelScript.WorksheetSearchCriteria,"matchCase",Property,Good,false diff --git a/generate-docs/api-extractor-inputs-excel/excel.d.ts b/generate-docs/api-extractor-inputs-excel/excel.d.ts index 2abb069e..586909e1 100644 --- a/generate-docs/api-extractor-inputs-excel/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel/excel.d.ts @@ -746,7 +746,7 @@ export declare namespace ExcelScript { getLastWorksheet(visibleOnly?: boolean): Worksheet; /** - * Makes a request to refresh all the data connections. + * Refreshes all the Data Connections. */ refreshAllDataConnections(): void; @@ -768,13 +768,13 @@ export declare namespace ExcelScript { getProtected(): boolean; /** - * Protects a workbook. Fails if the workbook has been protected. + * Protects the workbook. Fails if the workbook has been protected. * @param password - Workbook protection password. */ protect(password?: string): void; /** - * Unprotects a workbook. + * Unprotects the workbook. * @param password - Workbook protection password. */ unprotect(password?: string): void; @@ -812,12 +812,12 @@ export declare namespace ExcelScript { getId(): string; /** - * The display name of the worksheet. + * The display name of the worksheet. The name must be fewer than 32 characters. */ getName(): string; /** - * The display name of the worksheet. + * The display name of the worksheet. The name must be fewer than 32 characters. */ setName(name: string): void; @@ -1869,7 +1869,7 @@ export declare namespace ExcelScript { getLastRow(): Range; /** - * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this method returns `undefined`. + * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this function returns `undefined`. */ getMergedAreas(): RangeAreas; @@ -2947,7 +2947,7 @@ export declare namespace ExcelScript { clear(): void; /** - * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this method returns `null`. + * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this function will return `null`. */ getInvalidCells(): RangeAreas; } @@ -4028,11 +4028,13 @@ export declare namespace ExcelScript { /** * Specifies the marker size of a chart series. + * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. */ getMarkerSize(): number; /** * Specifies the marker size of a chart series. + * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. */ setMarkerSize(markerSize: number): void; @@ -4305,11 +4307,13 @@ export declare namespace ExcelScript { /** * Represents marker size of a data point. + * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. */ getMarkerSize(): number; /** * Represents marker size of a data point. + * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. */ setMarkerSize(markerSize: number): void; @@ -10185,7 +10189,7 @@ export declare namespace ExcelScript { lowerBound?: string; /** - * The substring used for `beginsWith`, `endsWith`, and `contains` filter conditions. + * The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions. */ substring?: string; @@ -13472,6 +13476,9 @@ export declare namespace ExcelScript { textAsNumber, } + /** + * Represents the ordering method to be used when sorting Chinese characters. + */ enum SortMethod { pinYin, diff --git a/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json index 03ce2319..cc1862fc 100644 --- a/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.43.0" + "packageVersion": "7.47.0" } ] } diff --git a/generate-docs/package-lock.json b/generate-docs/package-lock.json index 56b01657..ed12c2bf 100644 --- a/generate-docs/package-lock.json +++ b/generate-docs/package-lock.json @@ -8,21 +8,22 @@ "name": "generate-docs", "version": "1.0.0", "dependencies": { - "@microsoft/api-documenter": "^7.24.1", - "@microsoft/api-extractor": "^7.43.0", + "@microsoft/api-documenter": "^7.25.0", + "@microsoft/api-extractor": "^7.47.0", "reference-coverage-tester": "^0.0.3" } }, "node_modules/@microsoft/api-documenter": { - "version": "7.24.1", - "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.24.1.tgz", - "integrity": "sha512-DX332aznb5SWpOLGuymvzg2OZsQ5+dCbSm8yvVYqTylDgSAiPouvKrdlWPoEeicuLU8wzxSl3xv7DMb6xgYwPw==", + "version": "7.25.4", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.25.4.tgz", + "integrity": "sha512-hGERhz4L11zni1ifapBK3zhHFcX1QIGoTf0WzoCC0mI2IXfWDJ5ToYMZTPO6qPmn3ElrZtSWcoaHVkaRz16Q/Q==", + "license": "MIT", "dependencies": { - "@microsoft/api-extractor-model": "7.28.13", - "@microsoft/tsdoc": "0.14.2", - "@rushstack/node-core-library": "4.0.2", - "@rushstack/terminal": "0.10.0", - "@rushstack/ts-command-line": "4.19.1", + "@microsoft/api-extractor-model": "7.29.2", + "@microsoft/tsdoc": "~0.15.0", + "@rushstack/node-core-library": "5.4.1", + "@rushstack/terminal": "0.13.0", + "@rushstack/ts-command-line": "4.22.0", "js-yaml": "~3.13.1", "resolve": "~1.22.1" }, @@ -31,17 +32,18 @@ } }, "node_modules/@microsoft/api-extractor": { - "version": "7.43.0", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.43.0.tgz", - "integrity": "sha512-GFhTcJpB+MI6FhvXEI9b2K0snulNLWHqC/BbcJtyNYcKUiw7l3Lgis5ApsYncJ0leALX7/of4XfmXk+maT111w==", + "version": "7.47.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.47.0.tgz", + "integrity": "sha512-LT8yvcWNf76EpDC+8/ArTVSYePvuDQ+YbAUrsTcpg3ptiZ93HIcMCozP/JOxDt+rrsFfFHcpfoselKfPyRI0GQ==", + "license": "MIT", "dependencies": { - "@microsoft/api-extractor-model": "7.28.13", - "@microsoft/tsdoc": "0.14.2", - "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "4.0.2", + "@microsoft/api-extractor-model": "7.29.2", + "@microsoft/tsdoc": "~0.15.0", + "@microsoft/tsdoc-config": "~0.17.0", + "@rushstack/node-core-library": "5.4.1", "@rushstack/rig-package": "0.5.2", - "@rushstack/terminal": "0.10.0", - "@rushstack/ts-command-line": "4.19.1", + "@rushstack/terminal": "0.13.0", + "@rushstack/ts-command-line": "4.22.0", "lodash": "~4.17.15", "minimatch": "~3.0.3", "resolve": "~1.22.1", @@ -54,54 +56,48 @@ } }, "node_modules/@microsoft/api-extractor-model": { - "version": "7.28.13", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.28.13.tgz", - "integrity": "sha512-39v/JyldX4MS9uzHcdfmjjfS6cYGAoXV+io8B5a338pkHiSt+gy2eXQ0Q7cGFJ7quSa1VqqlMdlPrB6sLR/cAw==", + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.29.2.tgz", + "integrity": "sha512-hAYajOjQan3uslhKJRwvvHIdLJ+ZByKqdSsJ/dgHFxPtEbdKpzMDO8zuW4K5gkSMYl5D0LbNwxkhxr51P2zsmw==", + "license": "MIT", "dependencies": { - "@microsoft/tsdoc": "0.14.2", - "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "4.0.2" + "@microsoft/tsdoc": "~0.15.0", + "@microsoft/tsdoc-config": "~0.17.0", + "@rushstack/node-core-library": "5.4.1" } }, "node_modules/@microsoft/tsdoc": { - "version": "0.14.2", - "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", - "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==" + "version": "0.15.0", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.15.0.tgz", + "integrity": "sha512-HZpPoABogPvjeJOdzCOSJsXeL/SMCBgBZMVC3X3d7YYp2gf31MfxhUoYUNwf1ERPJOnQc0wkFn9trqI6ZEdZuA==", + "license": "MIT" }, "node_modules/@microsoft/tsdoc-config": { - "version": "0.16.2", - "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.16.2.tgz", - "integrity": "sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw==", + "version": "0.17.0", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.17.0.tgz", + "integrity": "sha512-v/EYRXnCAIHxOHW+Plb6OWuUoMotxTN0GLatnpOb1xq0KuTNw/WI3pamJx/UbsoJP5k9MCw1QxvvhPcF9pH3Zg==", + "license": "MIT", "dependencies": { - "@microsoft/tsdoc": "0.14.2", - "ajv": "~6.12.6", + "@microsoft/tsdoc": "0.15.0", + "ajv": "~8.12.0", "jju": "~1.4.0", - "resolve": "~1.19.0" - } - }, - "node_modules/@microsoft/tsdoc-config/node_modules/resolve": { - "version": "1.19.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", - "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", - "dependencies": { - "is-core-module": "^2.1.0", - "path-parse": "^1.0.6" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" + "resolve": "~1.22.2" } }, "node_modules/@rushstack/node-core-library": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-4.0.2.tgz", - "integrity": "sha512-hyES82QVpkfQMeBMteQUnrhASL/KHPhd7iJ8euduwNJG4mu2GSOKybf0rOEjOm1Wz7CwJEUm9y0yD7jg2C1bfg==", + "version": "5.4.1", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-5.4.1.tgz", + "integrity": "sha512-WNnwdS8r9NZ/2K3u29tNoSRldscFa7SxU0RT+82B6Dy2I4Hl2MeCSKm4EXLXPKeNzLGvJ1cqbUhTLviSF8E6iA==", + "license": "MIT", "dependencies": { + "ajv": "~8.13.0", + "ajv-draft-04": "~1.0.0", + "ajv-formats": "~3.0.1", "fs-extra": "~7.0.1", "import-lazy": "~4.0.0", "jju": "~1.4.0", "resolve": "~1.22.1", - "semver": "~7.5.4", - "z-schema": "~5.0.2" + "semver": "~7.5.4" }, "peerDependencies": { "@types/node": "*" @@ -112,21 +108,39 @@ } } }, + "node_modules/@rushstack/node-core-library/node_modules/ajv": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.13.0.tgz", + "integrity": "sha512-PRA911Blj99jR5RMeTunVbNXMF6Lp4vZXnk5GQjcnUWUTsrXtekg/pnmFFI2u/I36Y/2bITGS30GZCXei6uNkA==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.4.1" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, "node_modules/@rushstack/rig-package": { "version": "0.5.2", "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.5.2.tgz", "integrity": "sha512-mUDecIJeH3yYGZs2a48k+pbhM6JYwWlgjs2Ca5f2n1G2/kgdgP9D/07oglEGf6mRyXEnazhEENeYTSNDRCwdqA==", + "license": "MIT", "dependencies": { "resolve": "~1.22.1", "strip-json-comments": "~3.1.1" } }, "node_modules/@rushstack/terminal": { - "version": "0.10.0", - "resolved": "https://registry.npmjs.org/@rushstack/terminal/-/terminal-0.10.0.tgz", - "integrity": "sha512-UbELbXnUdc7EKwfH2sb8ChqNgapUOdqcCIdQP4NGxBpTZV2sQyeekuK3zmfQSa/MN+/7b4kBogl2wq0vpkpYGw==", + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/@rushstack/terminal/-/terminal-0.13.0.tgz", + "integrity": "sha512-Ou44Q2s81BqJu3dpYedAX54am9vn245F0HzqVrfJCMQk5pGgoKKOBOjkbfZC9QKcGNaECh6pwH2s5noJt7X6ew==", + "license": "MIT", "dependencies": { - "@rushstack/node-core-library": "4.0.2", + "@rushstack/node-core-library": "5.4.1", "supports-color": "~8.1.1" }, "peerDependencies": { @@ -138,26 +152,13 @@ } } }, - "node_modules/@rushstack/terminal/node_modules/supports-color": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", - "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/supports-color?sponsor=1" - } - }, "node_modules/@rushstack/ts-command-line": { - "version": "4.19.1", - "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.19.1.tgz", - "integrity": "sha512-J7H768dgcpG60d7skZ5uSSwyCZs/S2HrWP1Ds8d1qYAyaaeJmpmmLr9BVw97RjFzmQPOYnoXcKA4GkqDCkduQg==", + "version": "4.22.0", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.22.0.tgz", + "integrity": "sha512-Qj28t6MO3HRgAZ72FDeFsrpdE6wBWxF3VENgvrXh7JF2qIT+CrXiOJIesW80VFZB9QwObSpkB1ilx794fGQg6g==", + "license": "MIT", "dependencies": { - "@rushstack/terminal": "0.10.0", + "@rushstack/terminal": "0.13.0", "@types/argparse": "1.0.38", "argparse": "~1.0.9", "string-argv": "~0.3.1" @@ -166,16 +167,18 @@ "node_modules/@types/argparse": { "version": "1.0.38", "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", - "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==" + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "license": "MIT" }, "node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz", + "integrity": "sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==", + "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", "uri-js": "^4.2.2" }, "funding": { @@ -183,10 +186,42 @@ "url": "https://github.com/sponsors/epoberezkin" } }, + "node_modules/ajv-draft-04": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz", + "integrity": "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw==", + "license": "MIT", + "peerDependencies": { + "ajv": "^8.5.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/ajv-formats": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-3.0.1.tgz", + "integrity": "sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ==", + "license": "MIT", + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, "node_modules/ansi-escapes": { "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "license": "MIT", "dependencies": { "type-fest": "^0.21.3" }, @@ -201,6 +236,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", "engines": { "node": ">=8" } @@ -209,6 +245,7 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "license": "MIT", "dependencies": { "color-convert": "^2.0.1" }, @@ -223,6 +260,7 @@ "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "license": "MIT", "dependencies": { "sprintf-js": "~1.0.2" } @@ -230,7 +268,8 @@ "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" }, "node_modules/base64-js": { "version": "1.5.1", @@ -249,12 +288,14 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" }, "node_modules/bl": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", + "license": "MIT", "dependencies": { "buffer": "^5.5.0", "inherits": "^2.0.4", @@ -265,6 +306,7 @@ "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -288,6 +330,7 @@ "url": "https://feross.org/support" } ], + "license": "MIT", "dependencies": { "base64-js": "^1.3.1", "ieee754": "^1.1.13" @@ -297,6 +340,7 @@ "version": "4.1.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "license": "MIT", "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" @@ -308,15 +352,29 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, + "node_modules/chalk/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/chardet": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz", - "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==" + "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==", + "license": "MIT" }, "node_modules/cli-cursor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "license": "MIT", "dependencies": { "restore-cursor": "^3.1.0" }, @@ -328,6 +386,7 @@ "version": "2.9.2", "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.9.2.tgz", "integrity": "sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg==", + "license": "MIT", "engines": { "node": ">=6" }, @@ -339,6 +398,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-3.0.0.tgz", "integrity": "sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==", + "license": "ISC", "engines": { "node": ">= 10" } @@ -347,6 +407,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", "integrity": "sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==", + "license": "MIT", "engines": { "node": ">=0.8" } @@ -355,6 +416,7 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", "dependencies": { "color-name": "~1.1.4" }, @@ -365,26 +427,20 @@ "node_modules/color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" - }, - "node_modules/commander": { - "version": "9.5.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz", - "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==", - "optional": true, - "engines": { - "node": "^12.20.0 || >=14" - } + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "license": "MIT" }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==" + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "license": "MIT" }, "node_modules/defaults": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.4.tgz", "integrity": "sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==", + "license": "MIT", "dependencies": { "clone": "^1.0.2" }, @@ -395,12 +451,14 @@ "node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==" + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" }, "node_modules/escape-string-regexp": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "license": "MIT", "engines": { "node": ">=0.8.0" } @@ -409,6 +467,7 @@ "version": "4.0.1", "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "license": "BSD-2-Clause", "bin": { "esparse": "bin/esparse.js", "esvalidate": "bin/esvalidate.js" @@ -421,6 +480,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz", "integrity": "sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==", + "license": "MIT", "dependencies": { "chardet": "^0.7.0", "iconv-lite": "^0.4.24", @@ -433,17 +493,14 @@ "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" - }, - "node_modules/fast-json-stable-stringify": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "license": "MIT" }, "node_modules/figures": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz", "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==", + "license": "MIT", "dependencies": { "escape-string-regexp": "^1.0.5" }, @@ -458,6 +515,7 @@ "version": "7.0.1", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "license": "MIT", "dependencies": { "graceful-fs": "^4.1.2", "jsonfile": "^4.0.0", @@ -471,6 +529,7 @@ "version": "1.1.2", "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -478,20 +537,23 @@ "node_modules/graceful-fs": { "version": "4.2.11", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", - "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==" + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "license": "ISC" }, "node_modules/has-flag": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/hasown": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.0.tgz", - "integrity": "sha512-vUptKVTpIJhcczKBbgnS+RtcuYMB8+oNzPK2/Hp3hanz8JmpATdmmgLgSaadVREkDm+e2giHwY3ZRkyjSIDDFA==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "license": "MIT", "dependencies": { "function-bind": "^1.1.2" }, @@ -503,6 +565,7 @@ "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "license": "MIT", "dependencies": { "safer-buffer": ">= 2.1.2 < 3" }, @@ -527,12 +590,14 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "BSD-3-Clause" }, "node_modules/import-lazy": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "license": "MIT", "engines": { "node": ">=8" } @@ -540,12 +605,14 @@ "node_modules/inherits": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" }, "node_modules/inquirer": { "version": "8.2.6", "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.2.6.tgz", "integrity": "sha512-M1WuAmb7pn9zdFRtQYk26ZBoY043Sse0wVDdk4Bppr+JOXyQYybdtvK+l9wUibhtjdjvtoiNy8tk+EgsYIUqKg==", + "license": "MIT", "dependencies": { "ansi-escapes": "^4.2.1", "chalk": "^4.1.1", @@ -568,11 +635,15 @@ } }, "node_modules/is-core-module": { - "version": "2.13.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.1.tgz", - "integrity": "sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==", + "version": "2.14.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.14.0.tgz", + "integrity": "sha512-a5dFJih5ZLYlRtDc0dZWP7RiKr6xIKzmn/oAYCDvdLThadVgyJwlaoQPmRtMSpz+rk0OGAgIu+TcM9HUF0fk1A==", + "license": "MIT", "dependencies": { - "hasown": "^2.0.0" + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -582,6 +653,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "license": "MIT", "engines": { "node": ">=8" } @@ -590,6 +662,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz", "integrity": "sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==", + "license": "MIT", "engines": { "node": ">=8" } @@ -598,6 +671,7 @@ "version": "0.1.0", "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==", + "license": "MIT", "engines": { "node": ">=10" }, @@ -609,6 +683,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/isomorphic-fetch/-/isomorphic-fetch-3.0.0.tgz", "integrity": "sha512-qvUtwJ3j6qwsF3jLxkZ72qCgjMysPzDfeV240JHiGZsANBYd+EEuu35v7dfrJ9Up0Ak07D7GGSkGhCHTqg/5wA==", + "license": "MIT", "dependencies": { "node-fetch": "^2.6.1", "whatwg-fetch": "^3.4.1" @@ -617,12 +692,14 @@ "node_modules/jju": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", - "integrity": "sha512-8wb9Yw966OSxApiCt0K3yNJL8pnNeIv+OEq2YMidz4FKP6nonSRoOXc80iXY4JaN2FC11B9qsNmDsm+ZOfMROA==" + "integrity": "sha512-8wb9Yw966OSxApiCt0K3yNJL8pnNeIv+OEq2YMidz4FKP6nonSRoOXc80iXY4JaN2FC11B9qsNmDsm+ZOfMROA==", + "license": "MIT" }, "node_modules/js-yaml": { "version": "3.13.1", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "license": "MIT", "dependencies": { "argparse": "^1.0.7", "esprima": "^4.0.0" @@ -632,14 +709,16 @@ } }, "node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" }, "node_modules/jsonfile": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "license": "MIT", "optionalDependencies": { "graceful-fs": "^4.1.6" } @@ -647,22 +726,14 @@ "node_modules/lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" - }, - "node_modules/lodash.get": { - "version": "4.4.2", - "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", - "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==" - }, - "node_modules/lodash.isequal": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", - "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==" + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "license": "MIT" }, "node_modules/log-symbols": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", "integrity": "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==", + "license": "MIT", "dependencies": { "chalk": "^4.1.0", "is-unicode-supported": "^0.1.0" @@ -678,6 +749,7 @@ "version": "6.0.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "license": "ISC", "dependencies": { "yallist": "^4.0.0" }, @@ -689,6 +761,7 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "license": "MIT", "engines": { "node": ">=6" } @@ -697,6 +770,7 @@ "version": "3.0.8", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.8.tgz", "integrity": "sha512-6FsRAQsxQ61mw+qP1ZzbL9Bc78x2p5OqNgNpnoAFLTrX8n5Kxph0CsnhmKKNXTWjXqU5L0pGPR7hYk+XWZr60Q==", + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -707,12 +781,14 @@ "node_modules/mute-stream": { "version": "0.0.8", "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", - "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==" + "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", + "license": "ISC" }, "node_modules/node-fetch": { "version": "2.7.0", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "license": "MIT", "dependencies": { "whatwg-url": "^5.0.0" }, @@ -732,6 +808,7 @@ "version": "5.1.2", "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "license": "MIT", "dependencies": { "mimic-fn": "^2.1.0" }, @@ -746,6 +823,7 @@ "version": "5.4.1", "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", "integrity": "sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==", + "license": "MIT", "dependencies": { "bl": "^4.1.0", "chalk": "^4.1.0", @@ -768,6 +846,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz", "integrity": "sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -775,12 +854,14 @@ "node_modules/path-parse": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", - "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==" + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "license": "MIT" }, "node_modules/punycode": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "license": "MIT", "engines": { "node": ">=6" } @@ -789,6 +870,7 @@ "version": "3.6.2", "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "license": "MIT", "dependencies": { "inherits": "^2.0.3", "string_decoder": "^1.1.1", @@ -802,6 +884,7 @@ "version": "0.0.3", "resolved": "https://registry.npmjs.org/reference-coverage-tester/-/reference-coverage-tester-0.0.3.tgz", "integrity": "sha512-kt+8ERtHzc5uWUE84Rh1cEYdhQVpklYalLFHtWpVY+LilJZhSZ8ioWrZF1g0wczwxT07R4RXL1QPu0RiwtWTAw==", + "license": "MIT", "dependencies": { "fs-extra": "3.0.1", "inquirer": "^8.2.0", @@ -816,12 +899,14 @@ "node_modules/reference-coverage-tester/node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==" + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" }, "node_modules/reference-coverage-tester/node_modules/fs-extra": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-3.0.1.tgz", "integrity": "sha512-V3Z3WZWVUYd8hoCL5xfXJCaHWYzmtwW5XWYSlLgERi8PWd8bx1kUHUk8L1BT57e49oKnDDD180mjfrHc1yA9rg==", + "license": "MIT", "dependencies": { "graceful-fs": "^4.1.2", "jsonfile": "^3.0.0", @@ -832,6 +917,7 @@ "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.0.0.tgz", "integrity": "sha512-pqon0s+4ScYUvX30wxQi3PogGFAlUyH0awepWvwkj4jD4v+ova3RiYw8bmA6x2rDrEaj8i/oWKoRxpVNW+Re8Q==", + "license": "MIT", "dependencies": { "argparse": "^2.0.1" }, @@ -843,14 +929,25 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-3.0.1.tgz", "integrity": "sha512-oBko6ZHlubVB5mRFkur5vgYR1UyqX+S6Y/oCfLhqNdcc2fYFlDpIoNc7AfKS1KOGcnNAkvsr0grLck9ANM815w==", + "license": "MIT", "optionalDependencies": { "graceful-fs": "^4.1.6" } }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/resolve": { "version": "1.22.8", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", + "license": "MIT", "dependencies": { "is-core-module": "^2.13.0", "path-parse": "^1.0.7", @@ -867,6 +964,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "license": "MIT", "dependencies": { "onetime": "^5.1.0", "signal-exit": "^3.0.2" @@ -879,6 +977,7 @@ "version": "2.4.1", "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.4.1.tgz", "integrity": "sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==", + "license": "MIT", "engines": { "node": ">=0.12.0" } @@ -887,6 +986,7 @@ "version": "7.8.1", "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.1.tgz", "integrity": "sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg==", + "license": "Apache-2.0", "dependencies": { "tslib": "^2.1.0" } @@ -908,17 +1008,20 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" }, "node_modules/safer-buffer": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", - "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "license": "MIT" }, "node_modules/semver": { "version": "7.5.4", "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", + "license": "ISC", "dependencies": { "lru-cache": "^6.0.0" }, @@ -932,12 +1035,14 @@ "node_modules/signal-exit": { "version": "3.0.7", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", - "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==" + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "license": "ISC" }, "node_modules/source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "license": "BSD-3-Clause", "engines": { "node": ">=0.10.0" } @@ -945,12 +1050,14 @@ "node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==" + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", + "license": "BSD-3-Clause" }, "node_modules/string_decoder": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "license": "MIT", "dependencies": { "safe-buffer": "~5.2.0" } @@ -959,6 +1066,7 @@ "version": "0.3.2", "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.2.tgz", "integrity": "sha512-aqD2Q0144Z+/RqG52NeHEkZauTAUWJO8c6yTftGJKO3Tja5tUgIfmIl6kExvhtxSDP7fXB6DvzkfMpCd/F3G+Q==", + "license": "MIT", "engines": { "node": ">=0.6.19" } @@ -967,6 +1075,7 @@ "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", @@ -980,6 +1089,7 @@ "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", "dependencies": { "ansi-regex": "^5.0.1" }, @@ -991,6 +1101,7 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "license": "MIT", "engines": { "node": ">=8" }, @@ -999,20 +1110,25 @@ } }, "node_modules/supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "license": "MIT", "dependencies": { "has-flag": "^4.0.0" }, "engines": { - "node": ">=8" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" } }, "node_modules/supports-preserve-symlinks-flag": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -1023,12 +1139,14 @@ "node_modules/through": { "version": "2.3.8", "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", - "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==" + "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==", + "license": "MIT" }, "node_modules/tmp": { "version": "0.0.33", "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==", + "license": "MIT", "dependencies": { "os-tmpdir": "~1.0.2" }, @@ -1039,17 +1157,20 @@ "node_modules/tr46": { "version": "0.0.3", "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==" + "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", + "license": "MIT" }, "node_modules/tslib": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz", - "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==" + "version": "2.6.3", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.3.tgz", + "integrity": "sha512-xNvxJEOUiWPGhUuUdQgAJPKOOJfGnIyKySOc09XkKsgdUV/3E2zvwZYdejjmRgPCgcym1juLH3226yA7sEFJKQ==", + "license": "0BSD" }, "node_modules/type-fest": { "version": "0.21.3", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=10" }, @@ -1061,6 +1182,7 @@ "version": "5.4.2", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.2.tgz", "integrity": "sha512-+2/g0Fds1ERlP6JsakQQDXjZdZMM+rqpamFZJEKh4kwTIn3iDkgKtby0CeNd5ATNZ4Ry1ax15TMx0W2V+miizQ==", + "license": "Apache-2.0", "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -1073,6 +1195,7 @@ "version": "0.1.2", "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "license": "MIT", "engines": { "node": ">= 4.0.0" } @@ -1081,6 +1204,7 @@ "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "license": "BSD-2-Clause", "dependencies": { "punycode": "^2.1.0" } @@ -1088,20 +1212,14 @@ "node_modules/util-deprecate": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==" - }, - "node_modules/validator": { - "version": "13.11.0", - "resolved": "https://registry.npmjs.org/validator/-/validator-13.11.0.tgz", - "integrity": "sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ==", - "engines": { - "node": ">= 0.10" - } + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "license": "MIT" }, "node_modules/wcwidth": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", "integrity": "sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg==", + "license": "MIT", "dependencies": { "defaults": "^1.0.3" } @@ -1109,17 +1227,20 @@ "node_modules/webidl-conversions": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==" + "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", + "license": "BSD-2-Clause" }, "node_modules/whatwg-fetch": { "version": "3.6.20", "resolved": "https://registry.npmjs.org/whatwg-fetch/-/whatwg-fetch-3.6.20.tgz", - "integrity": "sha512-EqhiFU6daOA8kpjOWTL0olhVOF3i7OrFzSYiGsEMB8GcXS+RrzauAERX65xMeNWVqxA6HXH2m69Z9LaKKdisfg==" + "integrity": "sha512-EqhiFU6daOA8kpjOWTL0olhVOF3i7OrFzSYiGsEMB8GcXS+RrzauAERX65xMeNWVqxA6HXH2m69Z9LaKKdisfg==", + "license": "MIT" }, "node_modules/whatwg-url": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", + "license": "MIT", "dependencies": { "tr46": "~0.0.3", "webidl-conversions": "^3.0.0" @@ -1129,6 +1250,7 @@ "version": "6.2.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==", + "license": "MIT", "dependencies": { "ansi-styles": "^4.0.0", "string-width": "^4.1.0", @@ -1141,26 +1263,8 @@ "node_modules/yallist": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" - }, - "node_modules/z-schema": { - "version": "5.0.5", - "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz", - "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==", - "dependencies": { - "lodash.get": "^4.4.2", - "lodash.isequal": "^4.5.0", - "validator": "^13.7.0" - }, - "bin": { - "z-schema": "bin/z-schema" - }, - "engines": { - "node": ">=8.0.0" - }, - "optionalDependencies": { - "commander": "^9.4.1" - } + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "license": "ISC" } } } diff --git a/generate-docs/package.json b/generate-docs/package.json index d70cc7a9..204c6135 100644 --- a/generate-docs/package.json +++ b/generate-docs/package.json @@ -2,8 +2,8 @@ "name": "generate-docs", "version": "1.0.0", "dependencies": { - "@microsoft/api-extractor": "^7.43.0", - "@microsoft/api-documenter": "^7.24.1", + "@microsoft/api-extractor": "^7.47.0", + "@microsoft/api-documenter": "^7.25.0", "reference-coverage-tester": "^0.0.3" } } diff --git a/generate-docs/script-inputs/excel.d.ts b/generate-docs/script-inputs/excel.d.ts index 21c230a0..156d30b9 100644 --- a/generate-docs/script-inputs/excel.d.ts +++ b/generate-docs/script-inputs/excel.d.ts @@ -746,7 +746,7 @@ declare namespace ExcelScript { getLastWorksheet(visibleOnly?: boolean): Worksheet; /** - * Makes a request to refresh all the data connections. + * Refreshes all the Data Connections. */ refreshAllDataConnections(): void; @@ -768,13 +768,13 @@ declare namespace ExcelScript { getProtected(): boolean; /** - * Protects a workbook. Fails if the workbook has been protected. + * Protects the workbook. Fails if the workbook has been protected. * @param password Workbook protection password. */ protect(password?: string): void; /** - * Unprotects a workbook. + * Unprotects the workbook. * @param password Workbook protection password. */ unprotect(password?: string): void; @@ -812,12 +812,12 @@ declare namespace ExcelScript { getId(): string; /** - * The display name of the worksheet. + * The display name of the worksheet. The name must be fewer than 32 characters. */ getName(): string; /** - * The display name of the worksheet. + * The display name of the worksheet. The name must be fewer than 32 characters. */ setName(name: string): void; @@ -1869,7 +1869,7 @@ declare namespace ExcelScript { getLastRow(): Range; /** - * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this method returns `undefined`. + * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this function returns `undefined`. */ getMergedAreas(): RangeAreas; @@ -2947,7 +2947,7 @@ declare namespace ExcelScript { clear(): void; /** - * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this method returns `null`. + * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this function will return `null`. */ getInvalidCells(): RangeAreas; } @@ -4028,11 +4028,13 @@ declare namespace ExcelScript { /** * Specifies the marker size of a chart series. + * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. */ getMarkerSize(): number; /** * Specifies the marker size of a chart series. + * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. */ setMarkerSize(markerSize: number): void; @@ -4305,11 +4307,13 @@ declare namespace ExcelScript { /** * Represents marker size of a data point. + * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. */ getMarkerSize(): number; /** * Represents marker size of a data point. + * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. */ setMarkerSize(markerSize: number): void; @@ -10185,7 +10189,7 @@ declare namespace ExcelScript { lowerBound?: string; /** - * The substring used for `beginsWith`, `endsWith`, and `contains` filter conditions. + * The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions. */ substring?: string; @@ -13472,6 +13476,9 @@ declare namespace ExcelScript { textAsNumber, } + /** + * Represents the ordering method to be used when sorting Chinese characters. + */ enum SortMethod { pinYin, diff --git a/generate-docs/scripts/postprocessor.ts b/generate-docs/scripts/postprocessor.ts index 62b21e0a..7c1a6fd6 100644 --- a/generate-docs/scripts/postprocessor.ts +++ b/generate-docs/scripts/postprocessor.ts @@ -56,7 +56,7 @@ tryCatch(async () => { }); console.log(`Copying docs output files to: ${docsDestination}`); - // copy docs output to /docs/docs-ref-autogen folder + // Copy docs output to the /docs/docs-ref-autogen folder. fsx.readdirSync(docsSource) .forEach(filename => { fsx.copySync( @@ -65,8 +65,7 @@ tryCatch(async () => { ); }); - // Correct the language from javascript to TypeScript and - // remove example field from yml as the OPS schema does not support it. + // Remove the example field from the YAML as the OPS schema does not support it. fsx.readdirSync(docsDestination) .filter(topLevel => topLevel.indexOf(".") < 0) .forEach(topLevel => { // contents of docs-ref-autogen @@ -92,7 +91,7 @@ tryCatch(async () => { }); }); - // fix all the individual TOC files + // Fix all the TOC file. console.log("Writing TOC for Office Scripts"); let versionPath = path.resolve(`${docsDestination}/excel`); let tocPath = versionPath + "/toc.yml"; @@ -128,33 +127,26 @@ function fixToc(tocPath: string, sourceDtsPath: string): Toc { "href": "overview.md" }] as any; - // create folders for Excel subcategories + // Create a folder for enums. let excelEnumFilter = generateEnumList(fsx.readFileSync(sourceDtsPath).toString()); - let excelFilter: string[] = ["Interfaces"].concat(excelEnumFilter); - - // process all packages - origToc.items.forEach((rootItem, rootIndex) => { - rootItem.items.forEach((packageItem, packageIndex) => { - // fix host capitalization - let packageName = (packageItem.name.substr(0, 1).toUpperCase() + packageItem.name.substr(1)).replace(/\-/g, ' '); + origToc.items.forEach((rootItem) => { + rootItem.items.forEach((packageItem) => { membersToMove.items = packageItem.items; - if (packageName.toLocaleLowerCase().includes('excel')) { - let enumList = membersToMove.items.filter(item => { - return excelEnumFilter.indexOf(item.name) >= 0; - }); - let primaryList = membersToMove.items.filter(item => { - return excelFilter.indexOf(item.name) < 0; - }); - - let excelEnumRoot = {"name": "Enums", "uid": "", "items": enumList}; - primaryList.unshift(excelEnumRoot); - newToc.items[0].items.push({ - "name": packageName, - "uid": packageItem.uid, - "items": primaryList as any - }); - } + let enumList = membersToMove.items.filter(item => { + return excelEnumFilter.indexOf(item.name) >= 0; + }); + let primaryList = membersToMove.items.filter(item => { + return excelEnumFilter.indexOf(item.name) < 0; + }); + + let excelEnumRoot = {"name": "Enums", "uid": "", "items": enumList}; + primaryList.unshift(excelEnumRoot); + newToc.items[0].items.push({ + "name": packageItem.name, + "uid": packageItem.uid, + "items": primaryList as any + }); }); });