@sheetxl/sdk 0.4.22 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/browser/cjs/B2dZuRP83Z9xdkrt.cjs +54 -0
  2. package/browser/cjs/{rPn2U0Q2Eagh41Xd.cjs → B36ErK4PM-eagk-P.cjs} +1 -1
  3. package/browser/cjs/{Dub6MS5nk4D_Iv7p.cjs → BIevZx_GNhjxyrnW.cjs} +2 -2
  4. package/browser/cjs/{DMROSNSDJaUVqfoW.cjs → BKXpDOiyUbOaGCen.cjs} +1 -1
  5. package/browser/cjs/{D3ZDdkSutmtUfAG2.cjs → BQPnj3zwanZghAIn.cjs} +1 -1
  6. package/browser/cjs/{BFSSWIb-BPsXlS8k.cjs → BV7s-9nFDCubKH3d.cjs} +1 -1
  7. package/browser/cjs/{CV_Kse7BQ7sBx0S2.cjs → BbLOjDl72Sie7ejs.cjs} +1 -1
  8. package/browser/cjs/{Ko4UgjHi20zmyEpu.cjs → BmVYe8u5-lEa5P_F.cjs} +1 -1
  9. package/browser/cjs/{7IXJLhV4t0ot3XB5.cjs → BoQC57Ryz0sKE9Q5.cjs} +3 -3
  10. package/browser/cjs/{DItG5mSJNZ40zltg.cjs → Buf7xK-3ZDUtjx2m.cjs} +1 -1
  11. package/browser/cjs/{CFE-vojYpMggdKVQ.cjs → BvODFP9I_Vf_tPFV.cjs} +1 -1
  12. package/browser/cjs/{SkNXytY6UX9i6WhY.cjs → Bw0Q46MiHOI9i-0d.cjs} +2 -2
  13. package/browser/cjs/{Bein9-S48RBhhxLW.cjs → C-vCMpoIHKJjANgD.cjs} +1 -1
  14. package/browser/cjs/{B1FA-mZrhIhB8VoC.cjs → C6bmh1asBXLRUPRF.cjs} +1 -1
  15. package/browser/cjs/{88wgo6pjVpM9y5ul.cjs → CEavx_v2ooYxSB0p.cjs} +1 -1
  16. package/browser/cjs/{BSj9kpCBxyd5EZvX.cjs → CJOZKuNuxg5hqVvy.cjs} +1 -1
  17. package/browser/cjs/{CW7Kbm45TFbAZYO3.cjs → CTQH922gKq4XgWny.cjs} +1 -1
  18. package/browser/cjs/{BYwSD92n1THKdj9V.cjs → CkDIP_uyzgppeXbP.cjs} +1 -1
  19. package/browser/cjs/{BHMiYQTwGjWzRdGf.cjs → ClDpVLCq2Cn_5PTf.cjs} +1 -1
  20. package/browser/cjs/{Cx69pnzjeLfQMYgm.cjs → CqLVFZ8OJ0M7C1CR.cjs} +1 -1
  21. package/browser/cjs/{DWG2lOB7T0SRr5Ni.cjs → DUhJyiUMD_K9luBH.cjs} +1 -1
  22. package/browser/cjs/{CGslljb6hC8DcpsE.cjs → Dc-Qscdq9PZ9xc_8.cjs} +1 -1
  23. package/browser/cjs/{OgnqbIZEb37S4Hcz.cjs → DsWkw0lvemEUVjfX.cjs} +1 -1
  24. package/browser/cjs/{D2eWn6G2QvkYzR0D.cjs → aZZvmBDGrhdGC9ns.cjs} +1 -1
  25. package/browser/cjs/{BG_fhZO0IruefQYx.cjs → awaf86jB1qljeOTQ.cjs} +1 -1
  26. package/browser/cjs/{ZyyHV9ugA--j9V3Q.cjs → dZESMdPG8HqhsOw-.cjs} +1 -1
  27. package/browser/cjs/index.cjs +2 -2
  28. package/browser/cjs/{D1ZVN_gmSiXwUeCX.cjs → vdLkzeqc-6d8JjXv.cjs} +1 -1
  29. package/{node/esm/CIOhVshLBBACTKw4.mjs → browser/esm/8zEsMTrlFsOUui9E.mjs} +1 -1
  30. package/browser/esm/{BANL0IBU0th0Z0aE.mjs → 9Dos-3NKWJYJtvHB.mjs} +1 -1
  31. package/{node/esm/CMSKXl6rbx5miTNQ.mjs → browser/esm/B61ulMiuYBZn8SNN.mjs} +1 -1
  32. package/browser/esm/{ease-qEarwjnTOzw.mjs → BJIP7XCsQU7xCVvJ.mjs} +1 -1
  33. package/browser/esm/{BsPKTSv0eCvPH73D.mjs → BcDAKeHf67KAp5VL.mjs} +1 -1
  34. package/browser/esm/{XxsAmmMnL6UJ_NtN.mjs → BoKdLKHO0j7mIBSj.mjs} +1 -1
  35. package/browser/esm/{BE-hRu2cYg4ljCeu.mjs → C1WBPCvgoWSF9WCz.mjs} +1 -1
  36. package/{node/esm/Dd2ZeNLusT_ZXcoE.mjs → browser/esm/CCArsCkXn7NZMxKW.mjs} +1 -1
  37. package/browser/esm/{D3P3XCQVij2nAmi9.mjs → CE8sj_d2XwOfNWh3.mjs} +3 -3
  38. package/{node/esm/C1m7sGNTYP1bb_Uu.mjs → browser/esm/CHcgxFOF0b2ZNX6e.mjs} +1 -1
  39. package/{node/esm/C1VWw92RN5017GH2.mjs → browser/esm/CJgAKQILMv8X3B4W.mjs} +1 -1
  40. package/browser/esm/{E-RGQA1dKJwkkonk.mjs → CL4O8dajHSQO_udB.mjs} +1 -1
  41. package/browser/esm/{DEAxRkKlMDxHooJB.mjs → CS4_SR4y-fVGUw2-.mjs} +1 -1
  42. package/browser/esm/{-z0NclKcw0SSbo2L.mjs → CWm8Phee7kbyzTfU.mjs} +5168 -5178
  43. package/browser/esm/{BcSVj-rRzZCTKFUS.mjs → CYgwMG0CQxiv0YSb.mjs} +2 -2
  44. package/browser/esm/{DI52n-xcpb7jEqop.mjs → CyhfB8XQcAku7y-f.mjs} +1 -1
  45. package/browser/esm/{B5M_o8HB4RRWBd_Y.mjs → D08G73B-JFuO2cG-.mjs} +1 -1
  46. package/{node/esm/CiTlupx_cuXQySFz.mjs → browser/esm/D24KqjFTq38XcjRB.mjs} +1 -1
  47. package/browser/esm/{OABZjfPgUYHzd5rY.mjs → D4br_bpYlatmmEp_.mjs} +1 -1
  48. package/{node/esm/NvmvIR3jfjlY98jJ.mjs → browser/esm/D70uUh7q-JP_CDIM.mjs} +1 -1
  49. package/browser/esm/{CF-2-aQTgc-DoXzn.mjs → DO1lYqeWDGnvzc2k.mjs} +1 -1
  50. package/{node/esm/D6IgoU0LlIv_Vb4m.mjs → browser/esm/DUS5pLIeiMMQTNW9.mjs} +1 -1
  51. package/browser/esm/{45xuwq8di_97VrOg.mjs → DbEuqd5tLoOG-CTR.mjs} +1 -1
  52. package/browser/esm/{DDHWZD7Y6pihyVio.mjs → Ig9rKmhujrhrmGw_.mjs} +1 -1
  53. package/browser/esm/{pyVBYhEMGgaVvnd1.mjs → eMmunljluODMmzPP.mjs} +1 -1
  54. package/browser/esm/index.mjs +2 -2
  55. package/browser/esm/{CESAJuxgB8SgHaC0.mjs → lsDwTqYF-3IbTEBM.mjs} +2 -2
  56. package/browser/esm/{CB1_HpaA6RdaxTgB.mjs → uRi_w6Ccng-hSYqK.mjs} +1 -1
  57. package/node/esm/{C5pshc3Ik9rfVQTG.mjs → 0jNDDUndpkGyGTIA.mjs} +1 -1
  58. package/{browser/esm/CIOhVshLBBACTKw4.mjs → node/esm/8zEsMTrlFsOUui9E.mjs} +1 -1
  59. package/node/esm/{BANL0IBU0th0Z0aE.mjs → 9Dos-3NKWJYJtvHB.mjs} +1 -1
  60. package/node/esm/{Cb6FcT6gppjhiDSw.mjs → B1iDPfEHLtJ41VMY.mjs} +2 -2
  61. package/{browser/esm/CMSKXl6rbx5miTNQ.mjs → node/esm/B61ulMiuYBZn8SNN.mjs} +1 -1
  62. package/node/esm/{ease-qEarwjnTOzw.mjs → BJIP7XCsQU7xCVvJ.mjs} +1 -1
  63. package/node/esm/{CNmI4DKpe0t8gN4o.mjs → Bc-P6GigiFjg1N69.mjs} +1 -1
  64. package/node/esm/{XxsAmmMnL6UJ_NtN.mjs → BoKdLKHO0j7mIBSj.mjs} +1 -1
  65. package/node/esm/{xlM5nOnBp3h54uCb.mjs → Brx1VuszaLpc_rB3.mjs} +1 -1
  66. package/node/esm/{BE-hRu2cYg4ljCeu.mjs → C1WBPCvgoWSF9WCz.mjs} +1 -1
  67. package/{browser/esm/Dd2ZeNLusT_ZXcoE.mjs → node/esm/CCArsCkXn7NZMxKW.mjs} +1 -1
  68. package/{browser/esm/C1m7sGNTYP1bb_Uu.mjs → node/esm/CHcgxFOF0b2ZNX6e.mjs} +1 -1
  69. package/{browser/esm/C1VWw92RN5017GH2.mjs → node/esm/CJgAKQILMv8X3B4W.mjs} +1 -1
  70. package/node/esm/{CPs770aIZwPh6mF0.mjs → CO7YGGQ8BEK9BxES.mjs} +1 -1
  71. package/node/esm/{C2cb5mfR_vAlX9Fe.mjs → CP70GYskMIlD-Lg-.mjs} +1 -1
  72. package/node/esm/{DEAxRkKlMDxHooJB.mjs → CS4_SR4y-fVGUw2-.mjs} +1 -1
  73. package/node/esm/{BFQWsItEwIA8MHSr.mjs → CyHJ57YU316MCyDg.mjs} +1 -1
  74. package/{browser/esm/CiTlupx_cuXQySFz.mjs → node/esm/D24KqjFTq38XcjRB.mjs} +1 -1
  75. package/{browser/esm/NvmvIR3jfjlY98jJ.mjs → node/esm/D70uUh7q-JP_CDIM.mjs} +1 -1
  76. package/node/esm/{CE5UUdZ8bidtZxVI.mjs → DDiiUcpOQf_NlDYz.mjs} +1 -1
  77. package/{browser/esm/D6IgoU0LlIv_Vb4m.mjs → node/esm/DUS5pLIeiMMQTNW9.mjs} +1 -1
  78. package/node/esm/{DDHWZD7Y6pihyVio.mjs → Ig9rKmhujrhrmGw_.mjs} +1 -1
  79. package/node/esm/{DzsYVdrM0pVVPfdv.mjs → K5dREj5qS3w9CkmC.mjs} +1 -1
  80. package/node/esm/{pyVBYhEMGgaVvnd1.mjs → eMmunljluODMmzPP.mjs} +1 -1
  81. package/node/esm/index.mjs +3335 -3346
  82. package/node/esm/{CB1_HpaA6RdaxTgB.mjs → uRi_w6Ccng-hSYqK.mjs} +1 -1
  83. package/package.json +4 -4
  84. package/types/index.d.ts +105 -90
  85. package/types/scripting.d.ts +133 -111
  86. package/browser/cjs/D1uvbAWH1atUhVUP.cjs +0 -53
@@ -1464,16 +1464,16 @@ declare module "type/ICollection" {
1464
1464
  /**
1465
1465
  * Interface used for all ICollections.
1466
1466
  */
1467
- export interface ICollection {
1467
+ export interface ICollection<T, O = ICollection.GetItemsOptions> {
1468
1468
  /**
1469
- * Return the items at the index.
1470
- * @param index
1469
+ * Returns the items in the collection.
1471
1470
  */
1471
+ getItems(options?: ICollection.GetItemsOptions): T[];
1472
1472
  /**
1473
1473
  * Returns the total items available.
1474
1474
  *
1475
1475
  * @remarks
1476
- * Useful as a quick escape for search.
1476
+ * Useful as a quick escape for getItems.
1477
1477
  */
1478
1478
  getCount(): number;
1479
1479
  }
@@ -1485,6 +1485,14 @@ declare module "type/ICollection" {
1485
1485
  * {@link ICollection}
1486
1486
  */
1487
1487
  export namespace ICollection {
1488
+ /**
1489
+ * Options for getting items from the collection.
1490
+ *
1491
+ * @remarks
1492
+ * This placeholder is extended by implementations of ICollection
1493
+ */
1494
+ interface GetItemsOptions {
1495
+ }
1488
1496
  /**
1489
1497
  * Collection that can be persisted.
1490
1498
  */
@@ -1538,13 +1546,13 @@ declare module "type/ICollection" {
1538
1546
  /**
1539
1547
  * Called when collections have changes.
1540
1548
  */
1541
- onCollectionChange?(source: ICollection): void;
1549
+ onCollectionChange?(source: ICollection<any>): void;
1542
1550
  /**
1543
1551
  * Called when the collection has been updated due to a undo/redo and a rerender is required.
1544
1552
  */
1545
- onInvalidated?(source: ICollection): void;
1553
+ onInvalidated?(source: ICollection<any>): void;
1546
1554
  }
1547
- interface IListeners extends IListener.Callbacks<ICollection, ICollection.Events> {
1555
+ interface IListeners extends IListener.Callbacks<ICollection<any>, ICollection.Events> {
1548
1556
  }
1549
1557
  }
1550
1558
  }
@@ -2187,7 +2195,7 @@ declare module "resource/IResourceCollection" {
2187
2195
  /**
2188
2196
  * Collections of {@link IResource}.
2189
2197
  */
2190
- export interface IResourceCollection extends ICollection {
2198
+ export interface IResourceCollection extends ICollection<IResource> {
2191
2199
  /**
2192
2200
  * Add a resource to a collection with an initial reference.
2193
2201
  * @param resource
@@ -2195,6 +2203,11 @@ declare module "resource/IResourceCollection" {
2195
2203
  * Resources are not removed from the the collection. They are autoGCed when there are no references.
2196
2204
  */
2197
2205
  add(resource: string | IResource | IResourceCollection.AddOptions): IResource;
2206
+ /**
2207
+ * Returns a list of all resources in the collection.
2208
+ * @param options
2209
+ */
2210
+ getItems(options?: ICollection.GetItemsOptions): IResource[];
2198
2211
  /**
2199
2212
  * Used for saving resource. Returns a visitor that will allow for a toJSON that
2200
2213
  * will only save the resource that were accessed within the persist scope.
@@ -2234,6 +2247,8 @@ declare module "resource/IResourceCollection" {
2234
2247
  */
2235
2248
  name?: string;
2236
2249
  }
2250
+ interface GetItemsOptions extends ICollection.GetItemsOptions {
2251
+ }
2237
2252
  interface IPersistScope<J extends IResource.JSON> {
2238
2253
  /**
2239
2254
  * For a resource this will return a number that can be used to reference the resource in the persisted json.
@@ -2307,6 +2322,8 @@ declare module "resource/ResourceCollection" {
2307
2322
  constructor();
2308
2323
  /** {@inheritDoc IResourceCollection.add} */
2309
2324
  add(res: string | IResource | IResourceCollection.AddOptions): IResource;
2325
+ /** {@inheritDoc IResourceCollection.getItems} */
2326
+ getItems(options?: IResourceCollection.GetItemsOptions): IResource[];
2310
2327
  /** {@inheritDoc IResourceCollection.getCount} */
2311
2328
  getCount(): number;
2312
2329
  /** {@inheritDoc IResourceCollection.beginPersist} */
@@ -7670,7 +7687,7 @@ declare module "theme/IThemeCollection" {
7670
7687
  /**
7671
7688
  * A collection of themes.
7672
7689
  */
7673
- export interface IThemeCollection extends ICollection {
7690
+ export interface IThemeCollection extends ICollection<ITheme> {
7674
7691
  /**
7675
7692
  * Add or update a theme.
7676
7693
  *
@@ -7692,15 +7709,15 @@ declare module "theme/IThemeCollection" {
7692
7709
  */
7693
7710
  getByName(name: string): ITheme | null;
7694
7711
  /**
7695
- * Returns all themes that match the search criteria.
7712
+ * Returns all themes that match the filter criteria.
7696
7713
  *
7697
- * @param options {@link IThemeCollection.SearchOptions}
7714
+ * @param options {@link IThemeCollection.GetItemsOptions}
7698
7715
  *
7699
7716
  * @remarks
7700
- * * If no search criteria is provided, all items will be returned.
7717
+ * * If no filter criteria is provided, all items will be returned.
7701
7718
  * * Generates a new array so this can be mutated without affecting the internal state.
7702
7719
  */
7703
- search(options?: IThemeCollection.SearchOptions): ITheme[];
7720
+ getItems(options?: IThemeCollection.GetItemsOptions): ITheme[];
7704
7721
  /**
7705
7722
  * Remove a custom theme.
7706
7723
  *
@@ -7731,22 +7748,22 @@ declare module "theme/IThemeCollection" {
7731
7748
  */
7732
7749
  export namespace IThemeCollection {
7733
7750
  type JSON = ITheme.JSON[];
7734
- interface SearchOptions {
7751
+ interface GetItemsOptions extends ICollection.GetItemsOptions {
7735
7752
  /**
7736
- * @defaultValue `IThemeCollection.BuiltInSearchType.All`
7753
+ * @defaultValue `IThemeCollection.BuiltInFilterType.All`
7737
7754
  */
7738
- type?: BuiltInSearchType;
7755
+ type?: BuiltInFilterType;
7739
7756
  /**
7740
- * Allows for the search to return a specific theme even if not in the list.
7757
+ * Allows for the filter to return a specific theme even if not in the list.
7741
7758
  */
7742
7759
  selected?: ITheme;
7743
7760
  }
7744
- const BuiltInSearchType: {
7761
+ const BuiltInFilterType: {
7745
7762
  readonly BuiltIn: "builtIn";
7746
7763
  readonly All: "all";
7747
7764
  readonly Custom: "custom";
7748
7765
  };
7749
- type BuiltInSearchType = typeof BuiltInSearchType[keyof typeof BuiltInSearchType];
7766
+ type BuiltInFilterType = typeof BuiltInFilterType[keyof typeof BuiltInFilterType];
7750
7767
  }
7751
7768
  }
7752
7769
  declare module "theme/_BuiltInColorSchemes" {
@@ -7809,7 +7826,8 @@ declare module "theme/ThemeCollection" {
7809
7826
  setDefaultTheme(theme: ITheme): ITheme;
7810
7827
  /** {@inheritDoc IThemeCollection.getByName} */
7811
7828
  getByName(name: string): ITheme | null;
7812
- search(options?: IThemeCollection.SearchOptions): ITheme[];
7829
+ /** {@inheritDoc IThemeCollection.getByName} */
7830
+ getItems(options?: IThemeCollection.GetItemsOptions): ITheme[];
7813
7831
  /** {@inheritDoc IThemeCollection.getCount} */
7814
7832
  getCount(): number;
7815
7833
  /** {@inheritDoc IThemeCollection.setCustomTheme} */
@@ -8420,7 +8438,7 @@ declare module "named/INamedCollection" {
8420
8438
  /**
8421
8439
  * A collection of `INamed` items.
8422
8440
  */
8423
- export interface INamedCollection extends ICollection {
8441
+ export interface INamedCollection extends ICollection<INamed> {
8424
8442
  /**
8425
8443
  * Add a named reference.
8426
8444
  *
@@ -8443,10 +8461,10 @@ declare module "named/INamedCollection" {
8443
8461
  */
8444
8462
  add(named: INamed): INamed;
8445
8463
  /**
8446
- * Search the named items.
8464
+ * Return the named items.
8447
8465
  * These are sorted by type then by name.
8448
8466
  */
8449
- search(options?: INamedCollection.SearchOptions): INamed[];
8467
+ getItems(options?: INamedCollection.GetItemsOptions): INamed[];
8450
8468
  /**
8451
8469
  * Lookup a named range with a given name.
8452
8470
  *
@@ -8458,7 +8476,7 @@ declare module "named/INamedCollection" {
8458
8476
  * Lookup a named range by WorkbookRangeCoords. This will only
8459
8477
  * return a match if all the ranges are exact matches.
8460
8478
  *
8461
- * @deprecated Use search({ address }) instead.
8479
+ * @deprecated Use getItems({ address }) instead.
8462
8480
  */
8463
8481
  lookupByRanges(ranges: ICellRanges.Address): INamed[] | null;
8464
8482
  /**
@@ -8538,7 +8556,7 @@ declare module "named/INamedCollection" {
8538
8556
  }
8539
8557
  interface IListeners extends IListener.Callbacks<INamedCollection, INamedCollection.Events> {
8540
8558
  }
8541
- interface SearchOptions {
8559
+ interface GetItemsOptions extends ICollection.GetItemsOptions {
8542
8560
  /**
8543
8561
  * A string indicating the type.
8544
8562
  */
@@ -8600,7 +8618,7 @@ declare module "table/ITableCollection" {
8600
8618
  /**
8601
8619
  * Holds a collection of {@link ITable}s.
8602
8620
  */
8603
- export interface ITableCollection extends ICollection {
8621
+ export interface ITableCollection extends ICollection<ITable> {
8604
8622
  /**
8605
8623
  * Add an `ITable` to the container.
8606
8624
  *
@@ -8609,18 +8627,18 @@ declare module "table/ITableCollection" {
8609
8627
  */
8610
8628
  add(address: ICellRange.Address, options?: ITableCollection.AddOptions): ITable;
8611
8629
  /**
8612
- * Returns items that match the search criteria.
8630
+ * Returns items that match the filter criteria.
8613
8631
  *
8614
- * If no search criteria is provided, all items will be returned.
8632
+ * If no filter criteria is provided, all items will be returned.
8615
8633
  *
8616
- * @param options {@link ITableCollection.SearchOptions}
8634
+ * @param options {@link ITableCollection.GetItemsOptions}
8617
8635
  */
8618
- search(options?: ITableCollection.SearchOptions): ITable[];
8636
+ getItems(options?: ITableCollection.GetItemsOptions): ITable[];
8619
8637
  /**
8620
- * Convenience method for searching by name. This is
8621
- * functionally equivalent to search({ name });
8638
+ * Convenience method for filter by name. This is
8639
+ * functionally equivalent to getItems({ name });
8622
8640
  *
8623
- * @param name The name to search for This is case insensitive.
8641
+ * @param name The name to filter for This is case insensitive.
8624
8642
  */
8625
8643
  getByName(name: string): ITable | null;
8626
8644
  }
@@ -8664,9 +8682,9 @@ declare module "table/ITableCollection" {
8664
8682
  */
8665
8683
  isLoad?: boolean;
8666
8684
  }
8667
- interface SearchOptions {
8685
+ interface GetItemsOptions {
8668
8686
  /**
8669
- * If provided, the search will be limited to items that intersect the range.
8687
+ * If provided, the filter will be limited to items that intersect the range.
8670
8688
  */
8671
8689
  address?: ICellRange.Address;
8672
8690
  /**
@@ -8676,13 +8694,13 @@ declare module "table/ITableCollection" {
8676
8694
  */
8677
8695
  excludeHidden?: boolean;
8678
8696
  /**
8679
- * Only return items that are completely contained with the search bounds.
8697
+ * Only return items that are completely contained with the filter bounds.
8680
8698
  *
8681
8699
  * @defaultValue false
8682
8700
  */
8683
8701
  fullyContained?: boolean;
8684
8702
  /**
8685
- * Search with the given name. This is case insensitive.
8703
+ * Filter with the given name. This is case insensitive.
8686
8704
  */
8687
8705
  name?: string;
8688
8706
  }
@@ -9403,7 +9421,7 @@ declare module "string/IStringCollection" {
9403
9421
  /**
9404
9422
  * Contains a collection of interned strings.
9405
9423
  */
9406
- export interface IStringCollection extends ICollection, ICollection.IPersistable {
9424
+ export interface IStringCollection extends ICollection<string>, ICollection.IPersistable {
9407
9425
  /**
9408
9426
  * Add a string to the collection.
9409
9427
  *
@@ -9440,6 +9458,9 @@ declare module "string/IStringCollection" {
9440
9458
  * {@link IStringCollection}
9441
9459
  */
9442
9460
  export namespace IStringCollection {
9461
+ interface GetItemsOptions extends ICollection.GetItemsOptions {
9462
+ id?: number;
9463
+ }
9443
9464
  /**
9444
9465
  * Alias for persist type of `string`.
9445
9466
  */
@@ -9461,6 +9482,8 @@ declare module "string/StringCollection" {
9461
9482
  addMultiple(shared: string[], conflateDuplicates?: boolean): void;
9462
9483
  /** {@inheritDoc IStringCollection.add} */
9463
9484
  add(shared: string): number;
9485
+ /** {@inheritDoc IStringCollection.getItems} */
9486
+ getItems(options?: IStringCollection.GetItemsOptions): string[];
9464
9487
  /** {@inheritDoc IStringCollection.getById} */
9465
9488
  getById(id: number): string;
9466
9489
  /** {@inheritDoc ICollection.getCount} */
@@ -9480,7 +9503,7 @@ declare module "script/IFunctionCollection" {
9480
9503
  /**
9481
9504
  * Collections of {@link IFunction}.
9482
9505
  */
9483
- export interface IFunctionCollection extends ICollection {
9506
+ export interface IFunctionCollection extends ICollection<IFunction> {
9484
9507
  /**
9485
9508
  * Add a custom function to a collection.
9486
9509
  *
@@ -9488,16 +9511,16 @@ declare module "script/IFunctionCollection" {
9488
9511
  */
9489
9512
  add(options: IFunction | IFunctionCollection.AddOptions): IFunction;
9490
9513
  /**
9491
- * Returns functions that match the search criteria.
9514
+ * Returns functions that match the filter criteria.
9492
9515
  *
9493
- * If no search criteria is provided, all items will be returned.
9516
+ * If no filter criteria is provided, all items will be returned.
9494
9517
  *
9495
- * @param options {@link IFunctionCollection.SearchOptions}
9518
+ * @param options {@link IFunctionCollection.GetItemsOptions}
9496
9519
  */
9497
- search(options?: IFunctionCollection.SearchOptions): IFunction[];
9520
+ getItems(options?: IFunctionCollection.GetItemsOptions): IFunction[];
9498
9521
  /**
9499
- * Convenience method for searching by name.
9500
- * This is functionally equivalent to search({ name });
9522
+ * Convenience method for filter by name.
9523
+ * This is functionally equivalent to getItems({ name });
9501
9524
  *
9502
9525
  * @param name The name to search for This is case insensitive.
9503
9526
  */
@@ -9514,7 +9537,7 @@ declare module "script/IFunctionCollection" {
9514
9537
  /**
9515
9538
  * Options for searching a function in the collection.
9516
9539
  */
9517
- interface SearchOptions {
9540
+ interface GetItemsOptions {
9518
9541
  /**
9519
9542
  * Search with the given name. This is case insensitive.
9520
9543
  */
@@ -9645,7 +9668,7 @@ declare module "script/IModuleCollection" {
9645
9668
  /**
9646
9669
  * Represents a collection of functions. This is analogous to a file.
9647
9670
  */
9648
- export interface IModuleCollection extends ICollection {
9671
+ export interface IModuleCollection extends ICollection<IModule> {
9649
9672
  /**
9650
9673
  * Adds the module to the collection.
9651
9674
  *
@@ -9655,16 +9678,16 @@ declare module "script/IModuleCollection" {
9655
9678
  */
9656
9679
  add(uid: string, module: IModule, options?: IModuleCollection.AddOptions): void;
9657
9680
  /**
9658
- * Returns functions that match the search criteria.
9681
+ * Returns functions that match the filter criteria.
9659
9682
  *
9660
- * If no search criteria is provided, all items will be returned.
9683
+ * If no filter criteria is provided, all items will be returned.
9661
9684
  *
9662
- * @param options {@link IModuleCollection.SearchOptions}
9685
+ * @param options {@link IModuleCollection.GetItemsOptions}
9663
9686
  */
9664
- search(options?: IModuleCollection.SearchOptions): IModule[];
9687
+ getItems(options?: IModuleCollection.GetItemsOptions): IModule[];
9665
9688
  /**
9666
- * Convenience method for searching by name.
9667
- * This is functionally equivalent to search({ name });
9689
+ * Convenience method for filtering by name.
9690
+ * This is functionally equivalent to getItems({ name });
9668
9691
  *
9669
9692
  * @param name The name to search for This is case insensitive.
9670
9693
  */
@@ -9693,9 +9716,9 @@ declare module "script/IModuleCollection" {
9693
9716
  ignoreErrors?: boolean;
9694
9717
  }
9695
9718
  /**
9696
- * Options for searching a function in the collection.
9719
+ * Options for filtering a function in the collection.
9697
9720
  */
9698
- interface SearchOptions {
9721
+ interface GetItemsOptions extends ICollection.GetItemsOptions {
9699
9722
  /**
9700
9723
  * Search with the given name. This is case insensitive.
9701
9724
  */
@@ -14929,7 +14952,7 @@ declare module "conditional/IConditionalFormatCollection" {
14929
14952
  /**
14930
14953
  * Holds a collection of {@link IConditionalFormat}s.
14931
14954
  */
14932
- export interface IConditionalFormatCollection extends ICollection {
14955
+ export interface IConditionalFormatCollection extends ICollection<IConditionalFormat> {
14933
14956
  /**
14934
14957
  * Add an `IConditional` to the container.
14935
14958
  *
@@ -14938,21 +14961,13 @@ declare module "conditional/IConditionalFormatCollection" {
14938
14961
  */
14939
14962
  add(address: ICellRanges.Address, options: IConditionalFormatCollection.AddOptions): IConditionalFormat;
14940
14963
  /**
14941
- * Returns items that match the search criteria.
14964
+ * Returns items that match the filter criteria.
14942
14965
  *
14943
- * If no search criteria is provided, all items will be returned.
14966
+ * If no filter criteria is provided, all items will be returned.
14944
14967
  *
14945
- * @param options {@link IConditionalFormatCollection.SearchOptions}
14968
+ * @param options {@link IConditionalFormatCollection.GetItemsOptions}
14946
14969
  */
14947
- search(options?: IConditionalFormatCollection.SearchOptions): IConditionalFormat[];
14948
- /**
14949
- * Convenience method for searching by name. This is
14950
- * functionally equivalent to search({ name });
14951
- *
14952
- * @param name The name to search for This is case insensitive.
14953
- */
14954
- /** {@inheritDoc ICollection.getCount} */
14955
- getCount(): number;
14970
+ getItems(options?: IConditionalFormatCollection.GetItemsOptions): IConditionalFormat[];
14956
14971
  }
14957
14972
  /**
14958
14973
  * {@inheritDoc IConditionalFormatCollection}
@@ -14970,7 +14985,7 @@ declare module "conditional/IConditionalFormatCollection" {
14970
14985
  /**
14971
14986
  * Options for searching for {@link IConditionalFormat}s.
14972
14987
  */
14973
- interface SearchOptions {
14988
+ interface GetItemsOptions extends ICollection.GetItemsOptions {
14974
14989
  /**
14975
14990
  * If provided, the search will be limited to items that intersect the range.
14976
14991
  */
@@ -16860,6 +16875,7 @@ declare module "sheet/_SheetTypes" {
16860
16875
  bounds?: IRange.Coords;
16861
16876
  includeRangeTypes: boolean | SearchTypes;
16862
16877
  excludeHidden?: boolean | IRange.Orientation;
16878
+ includeMergeOverflow?: boolean;
16863
16879
  }
16864
16880
  interface Entry {
16865
16881
  /**
@@ -16997,25 +17013,19 @@ declare module "sheet/_SheetTypes" {
16997
17013
  }
16998
17014
  declare module "sheet/spatial/MergeEntry" {
16999
17015
  import { Scalar, IRange } from '@sheetxl/primitives';
17000
- import { RangeState } from "sheet/_SheetTypes";
17001
17016
  /**
17002
17017
  * MergeEntry
17003
17018
  */
17004
17019
  export class MergeEntry {
17005
17020
  private _c;
17006
17021
  private _tvTl;
17007
- private _rsTl;
17008
- constructor(coords: IRange.Coords, tvTl?: (coords: IRange.Coords) => Scalar | null, rsTl?: (coords: IRange.Coords) => RangeState.Intersection | null);
17022
+ constructor(coords: IRange.Coords, tvTl?: (coords: IRange.Coords) => Scalar | null);
17009
17023
  /**
17010
17024
  * The cell value at the top left.
17011
17025
  * We track this because we want a quick way to access
17012
17026
  * the coords state during overflow scenarios.
17013
17027
  */
17014
17028
  tvTl(): Scalar | null;
17015
- /**
17016
- * The range state at the top left.
17017
- */
17018
- rsTl(): RangeState.Intersection | null;
17019
17029
  getCoords(): IRange.Coords;
17020
17030
  }
17021
17031
  }
@@ -23804,7 +23814,6 @@ declare module "script/_FunctionMessages" {
23804
23814
  }
23805
23815
  declare module "script/FunctionCollection" {
23806
23816
  import type { IFunction, IFormulaContext } from '@sheetxl/primitives';
23807
- import type { ICollection } from "type/index";
23808
23817
  import { type ITransaction } from "transaction/index";
23809
23818
  import type { IListener } from "listener/index";
23810
23819
  import { ListenerEmitter } from "listener/ListenerEmitter";
@@ -23812,7 +23821,7 @@ declare module "script/FunctionCollection" {
23812
23821
  /**
23813
23822
  * Implementation for `IFunctionCollection`.
23814
23823
  */
23815
- export class FunctionCollection implements IFunctionCollection, ICollection {
23824
+ export class FunctionCollection implements IFunctionCollection {
23816
23825
  protected _emitter: ListenerEmitter<this, IFunctionCollection.IListeners>;
23817
23826
  private _options;
23818
23827
  private _readonly;
@@ -23820,8 +23829,8 @@ declare module "script/FunctionCollection" {
23820
23829
  private _transactionsRemoveListener;
23821
23830
  private _closed;
23822
23831
  constructor(options: ConstructorOptions);
23823
- /** {@inheritDoc IFunctionCollection.search} */
23824
- search(options?: IFunctionCollection.SearchOptions): IFunction[];
23832
+ /** {@inheritDoc IFunctionCollection.getItems} */
23833
+ getItems(options?: IFunctionCollection.GetItemsOptions): IFunction[];
23825
23834
  /** {@inheritDoc IFunctionCollection.getByName} */
23826
23835
  getByName(name: string): IFunction | null;
23827
23836
  /** {@inheritDoc ICollection.getCount} */
@@ -28567,7 +28576,7 @@ declare module "movable/IMovableCollection" {
28567
28576
  /**
28568
28577
  * Holds a collection of IMovables.
28569
28578
  */
28570
- export interface IMovableCollection extends ICollection, IListener.ISource<IMovableCollection> {
28579
+ export interface IMovableCollection extends ICollection<IMovable>, IListener.ISource<IMovableCollection> {
28571
28580
  /**
28572
28581
  * Add a resource to the movable collection.
28573
28582
  *
@@ -28576,15 +28585,15 @@ declare module "movable/IMovableCollection" {
28576
28585
  */
28577
28586
  add(options?: IMovableCollection.AddOptions): Promise<IMovable>;
28578
28587
  /**
28579
- * Returns movables that match the search criteria.
28588
+ * Returns movables that match the filter criteria.
28580
28589
  *
28581
- * @param options {@link IMovableCollection.SearchOptions}
28590
+ * @param options {@link IMovableCollection.GetItemsOptions}
28582
28591
  * @returns An Array of {@link IMovable}.
28583
28592
  *
28584
28593
  * @remarks
28585
- * If no search criteria is provided, all items will be returned.
28594
+ * If no filter criteria is provided, all items will be returned.
28586
28595
  */
28587
- search(options?: IMovableCollection.SearchOptions): IMovable[];
28596
+ getItems(options?: IMovableCollection.GetItemsOptions): IMovable[];
28588
28597
  /**
28589
28598
  * Update all of the selected movable in a single transaction
28590
28599
  */
@@ -28615,9 +28624,9 @@ declare module "movable/IMovableCollection" {
28615
28624
  */
28616
28625
  export namespace IMovableCollection {
28617
28626
  /**
28618
- * Options for searching a collection of movables.
28627
+ * Options for filtering a collection of movables.
28619
28628
  */
28620
- interface SearchOptions {
28629
+ interface GetItemsOptions extends ICollection.GetItemsOptions {
28621
28630
  /**
28622
28631
  * If provided, the search will be limited to items that intersect the range.
28623
28632
  * @remarks
@@ -29574,27 +29583,27 @@ declare module "sheet/ISheetCollection" {
29574
29583
  /**
29575
29584
  * Holds a collection of {@link ISheet}s.
29576
29585
  */
29577
- export interface ISheetCollection extends ICollection {
29586
+ export interface ISheetCollection extends ICollection<ISheet> {
29578
29587
  /**
29579
29588
  * Add an `ISheet` to the collection.
29580
29589
  */
29581
29590
  add(options?: ISheetCollection.AddOptions): ISheet;
29582
29591
  /**
29583
- * Returns sheets that match the search criteria.
29592
+ * Returns sheets that match the filter criteria.
29584
29593
  *
29585
- * If no search criteria is provided, all sheets will be returned.
29594
+ * If no filter criteria is provided, all sheets will be returned.
29586
29595
  *
29587
- * @param options {@link ISheetCollection.SearchOptions}
29596
+ * @param options {@link ISheetCollection.GetItemsOptions}
29588
29597
  */
29589
- search(options?: ISheetCollection.SearchOptions): ISheet[];
29598
+ getItems(options?: ISheetCollection.GetItemsOptions): ISheet[];
29590
29599
  /**
29591
29600
  * Returns the sheet at the given index.
29592
29601
  * @param index
29593
29602
  * @returns
29594
29603
  */
29595
29604
  /**
29596
- * Convenience method for searching by name. This is
29597
- * functionally equivalent to search({ name });
29605
+ * Convenience method for filtering by name. This is
29606
+ * functionally equivalent to getItems({ name });
29598
29607
  *
29599
29608
  * @param name The name to search for This is case insensitive.
29600
29609
  */
@@ -29624,7 +29633,7 @@ declare module "sheet/ISheetCollection" {
29624
29633
  */
29625
29634
  index?: number;
29626
29635
  }
29627
- interface SearchOptions {
29636
+ interface GetItemsOptions extends ICollection.GetItemsOptions {
29628
29637
  /**
29629
29638
  * Indicate if items that are in hidden headers or marked as hidden should be returned.
29630
29639
  * @defaultValue false
@@ -29860,16 +29869,16 @@ declare module "movable/MovableCollection" {
29860
29869
  import { IMovableCollection } from "movable/IMovableCollection";
29861
29870
  export class MovableCollection implements IMovableCollection {
29862
29871
  private _add;
29863
- private _search;
29872
+ private _getItems;
29864
29873
  private _getCount;
29865
29874
  private _updateSelected;
29866
29875
  private _addListeners;
29867
29876
  private _addImage;
29868
- constructor(add: (options?: IMovableCollection.AddOptions) => Promise<IMovable>, search: (options?: IMovableCollection.SearchOptions) => IMovable[], getCount: () => number, updateSelected: (update: (movable: IMovable) => void, action?: string) => void, addListeners: (listeners: ICollection.IListeners, options?: IListener.Options) => IListener.Remove, addImage: (image: string | IResource | IResourceCollection.AddOptions, options?: IMovableCollection.AddOptions) => Promise<IMovable>);
29877
+ constructor(add: (options?: IMovableCollection.AddOptions) => Promise<IMovable>, getItems: (options?: IMovableCollection.GetItemsOptions) => IMovable[], getCount: () => number, updateSelected: (update: (movable: IMovable) => void, action?: string) => void, addListeners: (listeners: ICollection.IListeners, options?: IListener.Options) => IListener.Remove, addImage: (image: string | IResource | IResourceCollection.AddOptions, options?: IMovableCollection.AddOptions) => Promise<IMovable>);
29869
29878
  /** {@inheritDoc IMovableCollection.add} */
29870
29879
  add(options?: IMovableCollection.AddOptions): Promise<IMovable>;
29871
- /** {@inheritDoc IMovableCollection.search} */
29872
- search(options?: IMovableCollection.SearchOptions): IMovable[];
29880
+ /** {@inheritDoc IMovableCollection.getItems} */
29881
+ getItems(options?: IMovableCollection.GetItemsOptions): IMovable[];
29873
29882
  /** {@inheritDoc IMovableCollection.getCount} */
29874
29883
  getCount(): number;
29875
29884
  /** {@inheritDoc IMovableCollection.updateSelected} */
@@ -29929,7 +29938,6 @@ declare module "named/_NamedMessages" {
29929
29938
  export const ERROR_NAME_DOES_NOT_EXIST: (name: string) => string;
29930
29939
  }
29931
29940
  declare module "named/NamedCollection" {
29932
- import { ICollection } from "type/index";
29933
29941
  import { ITransaction } from "transaction/index";
29934
29942
  import { IListener } from "listener/index";
29935
29943
  import { ICellRanges } from "cellRange/index";
@@ -29940,7 +29948,7 @@ declare module "named/NamedCollection" {
29940
29948
  /**
29941
29949
  * Implementation for `INamedCollection`.
29942
29950
  */
29943
- export class NamedCollection implements INamedCollection, ICollection {
29951
+ export class NamedCollection implements INamedCollection {
29944
29952
  protected _emitter: ListenerEmitter<this, INamedCollection.IListeners>;
29945
29953
  private _options;
29946
29954
  private _transactions;
@@ -29952,8 +29960,8 @@ declare module "named/NamedCollection" {
29952
29960
  private _lastLookupType;
29953
29961
  private _allowExtrudes;
29954
29962
  constructor(options: INamedCollection.ConstructorOptions);
29955
- /** {@inheritDoc INamedCollection.search} */
29956
- search(options?: INamedCollection.SearchOptions): INamed[];
29963
+ /** {@inheritDoc INamedCollection.getItems} */
29964
+ getItems(options?: INamedCollection.GetItemsOptions): INamed[];
29957
29965
  /** {@inheritDoc INamedCollection.lookupByRanges} */
29958
29966
  lookupByRanges(address: ICellRanges.Address): INamed[] | null;
29959
29967
  /** {@inheritDoc INamedCollection.getByName} */
@@ -30863,9 +30871,13 @@ declare module "table/TableCollection" {
30863
30871
  private _get;
30864
30872
  private _getByName;
30865
30873
  constructor(add: (address: ICellRange.Address, options: ITableCollection.AddOptions) => ITable, get: (address: ICellRanges.Address, excludeHidden: boolean, fullyContained: boolean) => ITable[], getByName: (name: string) => ITable);
30874
+ /** {@inheritDoc ITableCollection.add} */
30866
30875
  add(address: ICellRange.Address, options?: ITableCollection.AddOptions): ITable;
30867
- search(options?: ITableCollection.SearchOptions): ITable[];
30876
+ /** {@inheritDoc ITableCollection.getItems} */
30877
+ getItems(options?: ITableCollection.GetItemsOptions): ITable[];
30878
+ /** {@inheritDoc ITableCollection.getByName} */
30868
30879
  getByName(name: string): ITable;
30880
+ /** {@inheritDoc ITableCollection.getCount} */
30869
30881
  getCount(): number;
30870
30882
  }
30871
30883
  }
@@ -31125,8 +31137,11 @@ declare module "conditional/ConditionalFormatCollection" {
31125
31137
  private _add;
31126
31138
  private _get;
31127
31139
  constructor(add: (address: ICellRange.Address, options: IConditionalFormatCollection.AddOptions) => IConditionalFormat, get: (address: ICellRanges.Address, excludeHidden: boolean, fullyContained: boolean) => IConditionalFormat[]);
31140
+ /** {@inheritDoc IConditionalFormatCollection.add} */
31128
31141
  add(address: ICellRange.Address, options?: IConditionalFormatCollection.AddOptions): IConditionalFormat;
31129
- search(options?: IConditionalFormatCollection.SearchOptions): IConditionalFormat[];
31142
+ /** {@inheritDoc IConditionalFormatCollection.getItems} */
31143
+ getItems(options?: IConditionalFormatCollection.GetItemsOptions): IConditionalFormat[];
31144
+ /** {@inheritDoc IConditionalFormatCollection.getCount} */
31130
31145
  getCount(): number;
31131
31146
  }
31132
31147
  }
@@ -32402,6 +32417,10 @@ declare module "sheet/Sheet" {
32402
32417
  listeners?: Map<number, BeforeAfterRange>;
32403
32418
  /** If `true` then don't do protection check. (For example load or range listeners) */
32404
32419
  skipProtectionCheck?: boolean;
32420
+ /**
32421
+ * We update values (cache, potentially styling, as a result of calculations)
32422
+ */
32423
+ calculationSideEffect?: boolean;
32405
32424
  }
32406
32425
  /**
32407
32426
  * Base implementation of {@link ISheet}.
@@ -32750,7 +32769,7 @@ declare module "sheet/Sheet" {
32750
32769
  /** {@inheritDoc ISheet.getStrings} */
32751
32770
  getStrings(): IStringCollection;
32752
32771
  /** @internal */
32753
- protected _searchMovables(options?: IMovableCollection.SearchOptions): IMovable[];
32772
+ protected _searchMovables(options?: IMovableCollection.GetItemsOptions): IMovable[];
32754
32773
  /** @internal */
32755
32774
  protected _updateSelectedMovables(update: (movable: IMovable) => void, action?: string): void;
32756
32775
  /** @internal */
@@ -33568,7 +33587,6 @@ declare module "workbook/IWorkbook" {
33568
33587
  }
33569
33588
  }
33570
33589
  declare module "script/ModuleCollection" {
33571
- import type { ICollection } from "type/index";
33572
33590
  import { type ITransaction } from "transaction/index";
33573
33591
  import type { IListener } from "listener/index";
33574
33592
  import { ListenerEmitter } from "listener/ListenerEmitter";
@@ -33577,7 +33595,7 @@ declare module "script/ModuleCollection" {
33577
33595
  /**
33578
33596
  * Implementation for `IModuleCollection`.
33579
33597
  */
33580
- export class ModuleCollection implements IModuleCollection, ICollection {
33598
+ export class ModuleCollection implements IModuleCollection {
33581
33599
  protected _emitter: ListenerEmitter<this, IModuleCollection.IListeners>;
33582
33600
  private _options;
33583
33601
  private _transactions;
@@ -33586,8 +33604,8 @@ declare module "script/ModuleCollection" {
33586
33604
  constructor(options: ModuleCollection.ConstructorOptions);
33587
33605
  /** {@inheritDoc IModuleCollection.add} */
33588
33606
  add(uid: string, module: IModule, options?: IModuleCollection.AddOptions): void;
33589
- /** {@inheritDoc IModuleCollection.search} */
33590
- search(options?: IModuleCollection.SearchOptions): IModule[];
33607
+ /** {@inheritDoc IModuleCollection.getItems} */
33608
+ getItems(options?: IModuleCollection.GetItemsOptions): IModule[];
33591
33609
  /** {@inheritDoc IModuleCollection.getByName} */
33592
33610
  getByName(name: string): IModule | null;
33593
33611
  /** {@inheritDoc ICollection.getCount} */
@@ -33757,9 +33775,13 @@ declare module "sheet/SheetCollection" {
33757
33775
  private _add;
33758
33776
  private _get;
33759
33777
  constructor(add: (options: ISheetCollection.AddOptions) => ISheet, get: (name?: string, visibility?: ISheet.Visibility) => ISheet[]);
33778
+ /** {@inheritDoc ISheetCollection.add} */
33760
33779
  add(options?: ISheetCollection.AddOptions): ISheet;
33761
- search(options?: ISheetCollection.SearchOptions): ISheet[];
33780
+ /** {@inheritDoc ISheetCollection.getItems} */
33781
+ getItems(options?: ISheetCollection.GetItemsOptions): ISheet[];
33782
+ /** {@inheritDoc ISheetCollection.getByName} */
33762
33783
  getByName(name: string): ISheet;
33784
+ /** {@inheritDoc ISheetCollection.getCount} */
33763
33785
  getCount(): number;
33764
33786
  }
33765
33787
  }