@univerjs/sheets-sort 0.5.2 → 0.5.3

package/lib/cjs/facade.js

@@ -1 +1 @@
-"use strict";const e=require("@univerjs/sheets-sort"),o=require("@univerjs/sheets/facade"),i=require("@univerjs/core");class d extends o.FRange{async sort(r){const s=(Array.isArray(r)?r:[r]).map(t=>typeof t=="number"?{colIndex:t,type:e.SortType.ASC}:{colIndex:t.column,type:t.ascending?e.SortType.ASC:e.SortType.DESC});return await this._commandService.executeCommand(e.SortRangeCommand.id,{orderRules:s,range:this._range,hasTitle:!1,unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId()}),this}}o.FRange.extend(d);class u extends o.FWorksheet{async sort(r,n=!0){const s=[{colIndex:r,type:n?e.SortType.ASC:e.SortType.DESC}],t={startRow:0,startColumn:0,endRow:this._worksheet.getRowCount()-1,endColumn:this._worksheet.getColumnCount()-1,rangeType:i.RANGE_TYPE.ALL};return await this._commandService.executeCommand(e.SortRangeCommand.id,{orderRules:s,range:t,hasTitle:!1,unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId()}),this}}o.FWorksheet.extend(u);
+"use strict";const r=require("@univerjs/sheets-sort"),h=require("@univerjs/sheets/facade"),c=require("@univerjs/core");class l extends h.FRange{sort(o){const e=this._range.startColumn,s=(Array.isArray(o)?o:[o]).map(n=>typeof n=="number"?{colIndex:n+e,type:r.SortType.ASC}:{colIndex:n.column+e,type:n.ascending?r.SortType.ASC:r.SortType.DESC});return this._commandService.syncExecuteCommand(r.SortRangeCommand.id,{orderRules:s,range:this._range,hasTitle:!1,unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId()}),this}}h.FRange.extend(l);class R extends h.FWorksheet{sort(o,e=!0){const t=[{colIndex:o,type:e?r.SortType.ASC:r.SortType.DESC}],s={startRow:0,startColumn:0,endRow:this._worksheet.getRowCount()-1,endColumn:this._worksheet.getColumnCount()-1,rangeType:c.RANGE_TYPE.ALL};return this._commandService.syncExecuteCommand(r.SortRangeCommand.id,{orderRules:t,range:s,hasTitle:!1,unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId()}),this}}h.FWorksheet.extend(R);c.FEventName.extend(h.FSheetEventName);class C extends c.FUniver{_initialize(o){const e=o.get(c.ICommandService);this.disposeWithMe(e.beforeCommandExecuted(t=>{switch(t.id){case r.SortRangeCommand.id:this._beforeRangeSort(t);break}})),this.disposeWithMe(e.onCommandExecuted(t=>{switch(t.id){case r.SortRangeCommand.id:this._onRangeSorted(t);break}}))}_beforeRangeSort(o){const e=o.params,t=this.getUniverSheet(e.unitId),s=t.getSheetBySheetId(e.subUnitId),{startColumn:n,endColumn:m,startRow:a,endRow:S}=e.range,g=s.getRange(a,n,S-a+1,m-n+1),i={workbook:t,worksheet:s,range:g,sortColumn:e.orderRules.map(d=>({column:d.colIndex-n,ascending:d.type===r.SortType.ASC}))};if(this.fireEvent(this.Event.SheetBeforeRangeSort,i),i.cancel)throw new Error("SortRangeCommand canceled.")}_onRangeSorted(o){const e=o.params,t=this.getUniverSheet(e.unitId),s=t.getSheetBySheetId(e.subUnitId),{startColumn:n,endColumn:m,startRow:a,endRow:S}=e.range,g=s.getRange(a,n,S-a+1,m-n+1),i={workbook:t,worksheet:s,range:g,sortColumn:e.orderRules.map(d=>({column:d.colIndex-n,ascending:d.type===r.SortType.ASC}))};if(this.fireEvent(this.Event.SheetRangeSorted,i),i.cancel)throw new Error("SortRangeCommand canceled.")}}c.FUniver.extend(C);

package/lib/es/facade.js

@@ -1,14 +1,14 @@
-import { SortType as o, SortRangeCommand as s } from "@univerjs/sheets-sort";
-import { FRange as i, FWorksheet as a } from "@univerjs/sheets/facade";
-import { RANGE_TYPE as m } from "@univerjs/core";
-class h extends i {
-  async sort(t) {
-    const r = (Array.isArray(t) ? t : [t]).map((e) => typeof e == "number" ? { colIndex: e, type: o.ASC } : {
-      colIndex: e.column,
-      type: e.ascending ? o.ASC : o.DESC
+import { SortType as r, SortRangeCommand as c } from "@univerjs/sheets-sort";
+import { FRange as S, FWorksheet as l, FSheetEventName as R } from "@univerjs/sheets/facade";
+import { RANGE_TYPE as k, FEventName as w, FUniver as C, ICommandService as p } from "@univerjs/core";
+class f extends S {
+  sort(o) {
+    const e = this._range.startColumn, s = (Array.isArray(o) ? o : [o]).map((n) => typeof n == "number" ? { colIndex: n + e, type: r.ASC } : {
+      colIndex: n.column + e,
+      type: n.ascending ? r.ASC : r.DESC
     });
-    return await this._commandService.executeCommand(s.id, {
-      orderRules: r,
+    return this._commandService.syncExecuteCommand(c.id, {
+      orderRules: s,
       range: this._range,
       hasTitle: !1,
       unitId: this._workbook.getUnitId(),
@@ -16,26 +16,73 @@ class h extends i {
     }), this;
   }
 }
-i.extend(h);
-class u extends a {
-  async sort(t, n = !0) {
-    const r = [{
-      colIndex: t,
-      type: n ? o.ASC : o.DESC
-    }], e = {
+S.extend(f);
+class v extends l {
+  sort(o, e = !0) {
+    const t = [{
+      // real column index should be colIndex - 1.
+      colIndex: o,
+      type: e ? r.ASC : r.DESC
+    }], s = {
       startRow: 0,
       startColumn: 0,
       endRow: this._worksheet.getRowCount() - 1,
       endColumn: this._worksheet.getColumnCount() - 1,
-      rangeType: m.ALL
+      rangeType: k.ALL
     };
-    return await this._commandService.executeCommand(s.id, {
-      orderRules: r,
-      range: e,
+    return this._commandService.syncExecuteCommand(c.id, {
+      orderRules: t,
+      range: s,
       hasTitle: !1,
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId()
     }), this;
   }
 }
-a.extend(u);
+l.extend(v);
+w.extend(R);
+class E extends C {
+  _initialize(o) {
+    const e = o.get(p);
+    this.disposeWithMe(e.beforeCommandExecuted((t) => {
+      switch (t.id) {
+        case c.id:
+          this._beforeRangeSort(t);
+          break;
+      }
+    })), this.disposeWithMe(e.onCommandExecuted((t) => {
+      switch (t.id) {
+        case c.id:
+          this._onRangeSorted(t);
+          break;
+      }
+    }));
+  }
+  _beforeRangeSort(o) {
+    const e = o.params, t = this.getUniverSheet(e.unitId), s = t.getSheetBySheetId(e.subUnitId), { startColumn: n, endColumn: h, startRow: a, endRow: m } = e.range, g = s.getRange(a, n, m - a + 1, h - n + 1), i = {
+      workbook: t,
+      worksheet: s,
+      range: g,
+      sortColumn: e.orderRules.map((d) => ({
+        column: d.colIndex - n,
+        ascending: d.type === r.ASC
+      }))
+    };
+    if (this.fireEvent(this.Event.SheetBeforeRangeSort, i), i.cancel)
+      throw new Error("SortRangeCommand canceled.");
+  }
+  _onRangeSorted(o) {
+    const e = o.params, t = this.getUniverSheet(e.unitId), s = t.getSheetBySheetId(e.subUnitId), { startColumn: n, endColumn: h, startRow: a, endRow: m } = e.range, g = s.getRange(a, n, m - a + 1, h - n + 1), i = {
+      workbook: t,
+      worksheet: s,
+      range: g,
+      sortColumn: e.orderRules.map((d) => ({
+        column: d.colIndex - n,
+        ascending: d.type === r.ASC
+      }))
+    };
+    if (this.fireEvent(this.Event.SheetRangeSorted, i), i.cancel)
+      throw new Error("SortRangeCommand canceled.");
+  }
+}
+C.extend(E);

package/lib/types/facade/f-event.d.ts

@@ -0,0 +1,59 @@
+import { IEventBase, FEventName } from '@univerjs/core';
+import { FRange, FWorkbook, FWorksheet } from '@univerjs/sheets/facade';
+export interface IFSheetSortEventMixin {
+    /**
+     * This event will be emitted when a range on a worksheet is sorted.
+     * Type of the event is {@link ISheetRangeSortedParams}.
+     *
+     * @example
+     * ```typescript
+     * const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeSorted, (params) => {
+     *   const { workbook, worksheet, sortColumn } = params;
+     *   sortColumn.forEach((col) => {
+     *    console.log(col.column, col.ascending);
+     *  });
+     * });
+     * ```
+     */
+    SheetRangeSorted: 'SheetRangeSorted';
+    /**
+     * This event will be emitted before sorting a range on a worksheet.
+     * Type of the event is {@link ISheetRangeSortParams}.
+     *
+     * @example
+     * ```typescript
+     * const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeSort, (params) => {
+     *   const { workbook, worksheet, sortColumn } = params;
+     *   sortColumn.forEach((col) => {
+     *    console.log(col.column, col.ascending);
+     *   });
+     * });
+     * ```
+     */
+    SheetBeforeRangeSort: 'SheetBeforeRangeSort';
+}
+export declare class FSheetSortEventName extends FEventName implements IFSheetSortEventMixin {
+    readonly SheetRangeSorted: "SheetRangeSorted";
+    readonly SheetBeforeRangeSort: "SheetBeforeRangeSort";
+}
+interface ISortColumn {
+    column: number;
+    ascending: boolean;
+}
+export interface ISheetRangeSortParams extends IEventBase {
+    workbook: FWorkbook;
+    worksheet: FWorksheet;
+    range: FRange;
+    sortColumn: ISortColumn[];
+}
+export interface ISheetRangeSortEventParamConfig {
+    SheetBeforeRangeSort: ISheetRangeSortParams;
+    SheetRangeSorted: ISheetRangeSortParams;
+}
+declare module '@univerjs/core' {
+    interface FEventName extends IFSheetSortEventMixin {
+    }
+    interface IEventParamConfig extends ISheetRangeSortEventParamConfig {
+    }
+}
+export {};

package/lib/types/facade/f-range.d.ts

@@ -5,16 +5,26 @@ export type SortColumnSpec = {
 } | number;
 export interface IFRangeSort {
     /**
-     * Sort the range by the specified column(s) with specified order.
+     * Sorts the cells in the given range, by column(s) and order specified.
      *
-     * @async
+     * @param {SortColumnSpec | SortColumnSpec[]} column The column index with order or an array of column indexes with order. The column index starts from 1.
      *
-     * @return The range itself to chain other operations.
+     * @returns The range itself for chaining.
+     *
+     * @example
+     * ```typescript
+     * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+     * const activeSheet = activeSpreadsheet.getActiveSheet();
+     * const range = activeSheet.getRange(0, 0, 10, 10);
+     * range.sort(1); // Sorts the range by the first column in ascending order.
+     * range.sort({ column: 1, ascending: false }); // Sorts the range by the first column in descending order.
+     * range.sort([{ column: 1, ascending: false }, 2]); // Sorts the range by the first column in descending order and the second column in ascending order.
+     * ```
      */
-    sort(column: SortColumnSpec | SortColumnSpec[]): Promise<FRange>;
+    sort(column: SortColumnSpec | SortColumnSpec[]): FRange;
 }
 export declare class FRangeSort extends FRange implements IFRangeSort {
-    sort(column: SortColumnSpec | SortColumnSpec[]): Promise<FRange>;
+    sort(column: SortColumnSpec | SortColumnSpec[]): FRange;
 }
 declare module '@univerjs/sheets/facade' {
     interface FRange extends IFRangeSort {

package/lib/types/facade/f-worksheet.d.ts

@@ -3,16 +3,22 @@ export interface IFWorksheetSort {
     /**
      * Sort the worksheet by the specified column.
      *
-     * @async
+     * @param {number} colIndex The column index to sort by. which starts from 1.
+     * @param {boolean} [asc=true] The sort order. `true` for ascending, `false` for descending.
+     * @returns The worksheet itself for chaining.
      *
-     * @param colIndex The column index to sort by.
-     * @param asc Whether to sort in ascending order. Default is `true`.
-     * @returns The worksheet itself to chain calls.
+     * @example
+     * ```typescript
+     * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+     * const activeSheet = activeSpreadsheet.getActiveSheet();
+     * activeSheet.sort(1); // Sorts the worksheet by the first column in ascending order.
+     * activeSheet.sort(1, false); // Sorts the worksheet by the first column in descending order.
+     * ```
      */
-    sort(colIndex: number, asc?: boolean): Promise<FWorksheet>;
+    sort(colIndex: number, asc?: boolean): FWorksheet;
 }
 export declare class FWorksheetSort extends FWorksheet implements IFWorksheetSort {
-    sort(colIndex: number, asc?: boolean): Promise<FWorksheet>;
+    sort(colIndex: number, asc?: boolean): FWorksheet;
 }
 declare module '@univerjs/sheets/facade' {
     interface FWorksheet extends IFWorksheetSort {

package/lib/types/facade/index.d.ts

@@ -15,5 +15,7 @@
  */
 import './f-range';
 import './f-worksheet';
+import './f-event';
+export type * from './f-event';
 export type * from './f-range';
 export type * from './f-worksheet';

package/lib/umd/facade.js

@@ -1 +1 @@
-(function(e,t){typeof exports=="object"&&typeof module<"u"?t(require("@univerjs/sheets-sort"),require("@univerjs/sheets/facade"),require("@univerjs/core")):typeof define=="function"&&define.amd?define(["@univerjs/sheets-sort","@univerjs/sheets/facade","@univerjs/core"],t):(e=typeof globalThis<"u"?globalThis:e||self,t(e.UniverSheetsSort,e.UniverSheetsFacade,e.UniverCore))})(this,function(e,t,i){"use strict";class d extends t.FRange{async sort(r){const s=(Array.isArray(r)?r:[r]).map(n=>typeof n=="number"?{colIndex:n,type:e.SortType.ASC}:{colIndex:n.column,type:n.ascending?e.SortType.ASC:e.SortType.DESC});return await this._commandService.executeCommand(e.SortRangeCommand.id,{orderRules:s,range:this._range,hasTitle:!1,unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId()}),this}}t.FRange.extend(d);class u extends t.FWorksheet{async sort(r,o=!0){const s=[{colIndex:r,type:o?e.SortType.ASC:e.SortType.DESC}],n={startRow:0,startColumn:0,endRow:this._worksheet.getRowCount()-1,endColumn:this._worksheet.getColumnCount()-1,rangeType:i.RANGE_TYPE.ALL};return await this._commandService.executeCommand(e.SortRangeCommand.id,{orderRules:s,range:n,hasTitle:!1,unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId()}),this}}t.FWorksheet.extend(u)});
+(function(e,s){typeof exports=="object"&&typeof module<"u"?s(require("@univerjs/sheets-sort"),require("@univerjs/sheets/facade"),require("@univerjs/core")):typeof define=="function"&&define.amd?define(["@univerjs/sheets-sort","@univerjs/sheets/facade","@univerjs/core"],s):(e=typeof globalThis<"u"?globalThis:e||self,s(e.UniverSheetsSort,e.UniverSheetsFacade,e.UniverCore))})(this,function(e,s,a){"use strict";class C extends s.FRange{sort(r){const t=this._range.startColumn,i=(Array.isArray(r)?r:[r]).map(o=>typeof o=="number"?{colIndex:o+t,type:e.SortType.ASC}:{colIndex:o.column+t,type:o.ascending?e.SortType.ASC:e.SortType.DESC});return this._commandService.syncExecuteCommand(e.SortRangeCommand.id,{orderRules:i,range:this._range,hasTitle:!1,unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId()}),this}}s.FRange.extend(C);class R extends s.FWorksheet{sort(r,t=!0){const n=[{colIndex:r,type:t?e.SortType.ASC:e.SortType.DESC}],i={startRow:0,startColumn:0,endRow:this._worksheet.getRowCount()-1,endColumn:this._worksheet.getColumnCount()-1,rangeType:a.RANGE_TYPE.ALL};return this._commandService.syncExecuteCommand(e.SortRangeCommand.id,{orderRules:n,range:i,hasTitle:!1,unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId()}),this}}s.FWorksheet.extend(R),a.FEventName.extend(s.FSheetEventName);class l extends a.FUniver{_initialize(r){const t=r.get(a.ICommandService);this.disposeWithMe(t.beforeCommandExecuted(n=>{switch(n.id){case e.SortRangeCommand.id:this._beforeRangeSort(n);break}})),this.disposeWithMe(t.onCommandExecuted(n=>{switch(n.id){case e.SortRangeCommand.id:this._onRangeSorted(n);break}}))}_beforeRangeSort(r){const t=r.params,n=this.getUniverSheet(t.unitId),i=n.getSheetBySheetId(t.subUnitId),{startColumn:o,endColumn:m,startRow:d,endRow:u}=t.range,g=i.getRange(d,o,u-d+1,m-o+1),c={workbook:n,worksheet:i,range:g,sortColumn:t.orderRules.map(h=>({column:h.colIndex-o,ascending:h.type===e.SortType.ASC}))};if(this.fireEvent(this.Event.SheetBeforeRangeSort,c),c.cancel)throw new Error("SortRangeCommand canceled.")}_onRangeSorted(r){const t=r.params,n=this.getUniverSheet(t.unitId),i=n.getSheetBySheetId(t.subUnitId),{startColumn:o,endColumn:m,startRow:d,endRow:u}=t.range,g=i.getRange(d,o,u-d+1,m-o+1),c={workbook:n,worksheet:i,range:g,sortColumn:t.orderRules.map(h=>({column:h.colIndex-o,ascending:h.type===e.SortType.ASC}))};if(this.fireEvent(this.Event.SheetRangeSorted,c),c.cancel)throw new Error("SortRangeCommand canceled.")}}a.FUniver.extend(l)});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-sort",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "private": false,
   "description": "A library for sorting data in Univer Sheet",
   "author": "DreamNum <developer@univer.ai>",
@@ -53,38 +53,15 @@
     "lib"
   ],
   "dependencies": {
-    "@univerjs/core": "0.5.2",
-    "@univerjs/engine-formula": "0.5.2",
-    "@univerjs/sheets": "0.5.2"
+    "@univerjs/core": "0.5.3",
+    "@univerjs/sheets": "0.5.3",
+    "@univerjs/engine-formula": "0.5.3"
   },
   "devDependencies": {
     "typescript": "^5.7.2",
-    "vite": "^6.0.3",
+    "vite": "^6.0.6",
     "vitest": "^2.1.8",
-    "@univerjs-infra/shared": "0.5.2"
-  },
-  "space": {
-    ".": {
-      "import": "./lib/es/index.js",
-      "require": "./lib/cjs/index.js",
-      "types": "./lib/types/index.d.ts"
-    },
-    "./*": {
-      "import": "./lib/es/*",
-      "require": "./lib/cjs/*",
-      "types": "./lib/types/index.d.ts"
-    },
-    "./locale/*": {
-      "import": "./lib/es/locale/*.js",
-      "require": "./lib/cjs/locale/*.js",
-      "types": "./lib/types/locale/*.d.ts"
-    },
-    "./facade": {
-      "import": "./lib/es/facade.js",
-      "require": "./lib/cjs/facade.js",
-      "types": "./lib/types/facade/index.d.ts"
-    },
-    "./lib/*": "./lib/*"
+    "@univerjs-infra/shared": "0.5.3"
   },
   "scripts": {
     "test": "vitest run",