microsoft-graph 2.26.0 → 2.28.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 (138) hide show
  1. package/dist/cjs/models/Border.d.ts +16 -0
  2. package/dist/cjs/models/Border.d.ts.map +1 -0
  3. package/dist/cjs/models/Border.js +2 -0
  4. package/dist/cjs/models/Cell.d.ts +90 -7
  5. package/dist/cjs/models/Cell.d.ts.map +1 -1
  6. package/dist/cjs/models/Color.d.ts +9 -0
  7. package/dist/cjs/models/Color.d.ts.map +1 -0
  8. package/dist/cjs/models/Color.js +2 -0
  9. package/dist/cjs/models/Column.d.ts +5 -0
  10. package/dist/cjs/models/Column.d.ts.map +1 -1
  11. package/dist/cjs/models/Column.js +5 -1
  12. package/dist/cjs/models/DataSource.d.ts +49 -0
  13. package/dist/cjs/models/DataSource.d.ts.map +1 -0
  14. package/dist/cjs/models/DataSource.js +8 -0
  15. package/dist/cjs/models/FontName.d.ts +9 -0
  16. package/dist/cjs/models/FontName.d.ts.map +1 -0
  17. package/dist/cjs/models/FontName.js +2 -0
  18. package/dist/cjs/models/Row.d.ts +3 -0
  19. package/dist/cjs/models/Row.d.ts.map +1 -1
  20. package/dist/cjs/operations/workbookRange/getWorkbookWorksheetRange.d.ts +6 -1
  21. package/dist/cjs/operations/workbookRange/getWorkbookWorksheetRange.d.ts.map +1 -1
  22. package/dist/cjs/operations/workbookRange/getWorkbookWorksheetRange.js +9 -2
  23. package/dist/cjs/operations/workbookRange/listWorkbookRangeBorders.d.ts +16 -0
  24. package/dist/cjs/operations/workbookRange/listWorkbookRangeBorders.d.ts.map +1 -0
  25. package/dist/cjs/operations/workbookRange/listWorkbookRangeBorders.js +33 -0
  26. package/dist/cjs/operations/workbookRange/setWorkbookRangeBorder.d.ts +19 -0
  27. package/dist/cjs/operations/workbookRange/setWorkbookRangeBorder.d.ts.map +1 -0
  28. package/dist/cjs/operations/workbookRange/setWorkbookRangeBorder.js +44 -0
  29. package/dist/cjs/services/addressManipulation.d.ts.map +1 -1
  30. package/dist/cjs/services/addressManipulation.js +2 -1
  31. package/dist/cjs/services/cartesianAddress.js +2 -2
  32. package/dist/cjs/services/dataSource.d.ts +69 -0
  33. package/dist/cjs/services/dataSource.d.ts.map +1 -0
  34. package/dist/cjs/services/dataSource.js +195 -0
  35. package/dist/cjs/services/iteration.d.ts +1 -0
  36. package/dist/cjs/services/iteration.d.ts.map +1 -1
  37. package/dist/cjs/services/iteration.js +1 -0
  38. package/dist/cjs/tasks/deleteDriveItemWithRetry.d.ts +1 -0
  39. package/dist/cjs/tasks/deleteDriveItemWithRetry.d.ts.map +1 -1
  40. package/dist/cjs/tasks/deleteDriveItemWithRetry.js +1 -0
  41. package/dist/cjs/tasks/iterateRows.d.ts +24 -0
  42. package/dist/cjs/tasks/iterateRows.d.ts.map +1 -0
  43. package/dist/cjs/tasks/iterateRows.js +127 -0
  44. package/dist/cjs/tasks/iterateWorkbookRange.d.ts.map +1 -1
  45. package/dist/cjs/tasks/iterateWorkbookRange.js +7 -0
  46. package/dist/cjs/tasks/readWorkbookRows.d.ts.map +1 -1
  47. package/dist/cjs/tasks/readWorkbookRows.js +8 -0
  48. package/dist/cjs/tasks/setColumnHidden.d.ts +5 -0
  49. package/dist/cjs/tasks/setColumnHidden.d.ts.map +1 -1
  50. package/dist/cjs/tasks/setColumnHidden.js +5 -0
  51. package/dist/cjs/tasks/setRowHidden.d.ts +5 -0
  52. package/dist/cjs/tasks/setRowHidden.d.ts.map +1 -1
  53. package/dist/cjs/tasks/setRowHidden.js +5 -0
  54. package/dist/cjs/tasks/setWorkbookRangeValues.d.ts +7 -2
  55. package/dist/cjs/tasks/setWorkbookRangeValues.d.ts.map +1 -1
  56. package/dist/cjs/tasks/setWorkbookRangeValues.js +7 -2
  57. package/dist/esm/models/Border.d.ts +16 -0
  58. package/dist/esm/models/Border.d.ts.map +1 -0
  59. package/dist/esm/models/Border.js +1 -0
  60. package/dist/esm/models/Cell.d.ts +90 -7
  61. package/dist/esm/models/Cell.d.ts.map +1 -1
  62. package/dist/esm/models/Color.d.ts +9 -0
  63. package/dist/esm/models/Color.d.ts.map +1 -0
  64. package/dist/esm/models/Color.js +1 -0
  65. package/dist/esm/models/Column.d.ts +5 -0
  66. package/dist/esm/models/Column.d.ts.map +1 -1
  67. package/dist/esm/models/Column.js +5 -1
  68. package/dist/esm/models/DataSource.d.ts +49 -0
  69. package/dist/esm/models/DataSource.d.ts.map +1 -0
  70. package/dist/esm/models/DataSource.js +7 -0
  71. package/dist/esm/models/FontName.d.ts +9 -0
  72. package/dist/esm/models/FontName.d.ts.map +1 -0
  73. package/dist/esm/models/FontName.js +1 -0
  74. package/dist/esm/models/Row.d.ts +3 -0
  75. package/dist/esm/models/Row.d.ts.map +1 -1
  76. package/dist/esm/operations/workbookRange/getWorkbookWorksheetRange.d.ts +6 -1
  77. package/dist/esm/operations/workbookRange/getWorkbookWorksheetRange.d.ts.map +1 -1
  78. package/dist/esm/operations/workbookRange/getWorkbookWorksheetRange.js +9 -2
  79. package/dist/esm/operations/workbookRange/listWorkbookRangeBorders.d.ts +16 -0
  80. package/dist/esm/operations/workbookRange/listWorkbookRangeBorders.d.ts.map +1 -0
  81. package/dist/esm/operations/workbookRange/listWorkbookRangeBorders.js +30 -0
  82. package/dist/esm/operations/workbookRange/setWorkbookRangeBorder.d.ts +19 -0
  83. package/dist/esm/operations/workbookRange/setWorkbookRangeBorder.d.ts.map +1 -0
  84. package/dist/esm/operations/workbookRange/setWorkbookRangeBorder.js +41 -0
  85. package/dist/esm/services/addressManipulation.d.ts.map +1 -1
  86. package/dist/esm/services/addressManipulation.js +2 -1
  87. package/dist/esm/services/cartesianAddress.js +2 -2
  88. package/dist/esm/services/dataSource.d.ts +69 -0
  89. package/dist/esm/services/dataSource.d.ts.map +1 -0
  90. package/dist/esm/services/dataSource.js +184 -0
  91. package/dist/esm/services/iteration.d.ts +1 -0
  92. package/dist/esm/services/iteration.d.ts.map +1 -1
  93. package/dist/esm/services/iteration.js +1 -0
  94. package/dist/esm/tasks/deleteDriveItemWithRetry.d.ts +1 -0
  95. package/dist/esm/tasks/deleteDriveItemWithRetry.d.ts.map +1 -1
  96. package/dist/esm/tasks/deleteDriveItemWithRetry.js +1 -0
  97. package/dist/esm/tasks/iterateRows.d.ts +24 -0
  98. package/dist/esm/tasks/iterateRows.d.ts.map +1 -0
  99. package/dist/esm/tasks/iterateRows.js +121 -0
  100. package/dist/esm/tasks/iterateWorkbookRange.d.ts.map +1 -1
  101. package/dist/esm/tasks/iterateWorkbookRange.js +7 -0
  102. package/dist/esm/tasks/readWorkbookRows.d.ts.map +1 -1
  103. package/dist/esm/tasks/readWorkbookRows.js +8 -0
  104. package/dist/esm/tasks/setColumnHidden.d.ts +5 -0
  105. package/dist/esm/tasks/setColumnHidden.d.ts.map +1 -1
  106. package/dist/esm/tasks/setColumnHidden.js +5 -0
  107. package/dist/esm/tasks/setRowHidden.d.ts +5 -0
  108. package/dist/esm/tasks/setRowHidden.d.ts.map +1 -1
  109. package/dist/esm/tasks/setRowHidden.js +5 -0
  110. package/dist/esm/tasks/setWorkbookRangeValues.d.ts +7 -2
  111. package/dist/esm/tasks/setWorkbookRangeValues.d.ts.map +1 -1
  112. package/dist/esm/tasks/setWorkbookRangeValues.js +7 -2
  113. package/docs/api/Border.md +55 -0
  114. package/docs/api/Cell.md +94 -13
  115. package/docs/api/Color.md +19 -0
  116. package/docs/api/Column.md +12 -2
  117. package/docs/api/DataSource-1.md +191 -0
  118. package/docs/api/FontName.md +19 -0
  119. package/docs/api/Iteration.md +3 -1
  120. package/docs/api/README.md +11 -10
  121. package/docs/api/Row.md +5 -3
  122. package/docs/api/addressManipulation.md +3 -3
  123. package/docs/api/dataSource.md +204 -0
  124. package/docs/api/deleteWorkbookRange.md +1 -1
  125. package/docs/api/getWorkbookWorksheetByName.md +1 -1
  126. package/docs/api/getWorkbookWorksheetRange.md +6 -2
  127. package/docs/api/insertWorkbookCells.md +1 -1
  128. package/docs/api/iterateRows.md +43 -0
  129. package/docs/api/listWorkbookRangeBorders.md +31 -0
  130. package/docs/api/readWorkbookRows.md +1 -1
  131. package/docs/api/{tasks/setColumnHidden.md → setColumnHidden.md} +6 -4
  132. package/docs/api/{tasks/setRowHidden.md → setRowHidden.md} +6 -4
  133. package/docs/api/setWorkbookRangeBorder.md +33 -0
  134. package/docs/topics/README.md +2 -1
  135. package/docs/topics/versioning.md +17 -0
  136. package/package.json +201 -1
  137. package/docs/api/deleteDriveItemWithRetry.md +0 -33
  138. package/docs/api/tasks/setWorkbookRangeValues.md +0 -3
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Defining a border that could be on a cell.
3
+ * @experimental
4
+ * @module Border
5
+ * @category Models
6
+ */
7
+ import type { Color } from "./Color.ts";
8
+ export type Border = {
9
+ color: Color;
10
+ style: BorderType;
11
+ weight: BorderWeight;
12
+ };
13
+ export type BorderSide = "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp";
14
+ export type BorderType = "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot";
15
+ export type BorderWeight = "Hairline" | "Thin" | "Medium" | "Thick";
16
+ //# sourceMappingURL=Border.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Border.d.ts","sourceRoot":"","sources":["../../../src/models/Border.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,MAAM,MAAM,MAAM,GAAG;IACpB,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,UAAU,CAAC;IAClB,MAAM,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,cAAc,GAAG,YAAY,CAAC;AAErJ,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,YAAY,GAAG,KAAK,GAAG,QAAQ,GAAG,cAAc,CAAC;AAEvH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,6 +3,9 @@
3
3
  * @module Cell
4
4
  * @category Models
5
5
  */
6
+ import type { Border } from "./Border.ts";
7
+ import type { Color } from "./Color.ts";
8
+ import type { FontName } from "./FontName.ts";
6
9
  /**
7
10
  * Cell in a worksheet.
8
11
  * @remarks Contrary to common expectation, while a cell does contain a single value, it also contains a text representation of that value and a number format that often defines that representation.
@@ -21,19 +24,21 @@ export type Cell = {
21
24
  * Formatting that is applied to the value to derive the text representation.
22
25
  */
23
26
  format: CellFormat;
24
- };
25
- /**
26
- * Text content of a cell in a worksheet.
27
- * @remarks This is a string that represents the text displayed in the cell, which may differ from the actual value of the cell (e.g., due to formatting).
28
- */
29
- export type CellText = string & {
30
- __brand: "CellText";
27
+ /**
28
+ * Style applied to the cell to affect its appearance, like color, borders, alignment, etc.
29
+ */
30
+ style: CellStyle;
31
31
  };
32
32
  /**
33
33
  * CellValue represents the value of a cell in a spreadsheet.
34
34
  * @see {@link Cell} for a more comprehensive representation of a cell, which includes text and formatting.
35
35
  */
36
36
  export type CellValue = string | number | boolean;
37
+ /**
38
+ * Text content of a cell in a worksheet.
39
+ * @remarks This is a string that represents the text displayed in the cell, which may differ from the actual value of the cell (e.g., due to formatting).
40
+ */
41
+ export type CellText = string;
37
42
  /**
38
43
  * Format to be applied to a cell value to convert it to text to display to the user.
39
44
  * @see {@link Cell} for a more comprehensive representation of a cell, which includes text and formatting.
@@ -41,4 +46,82 @@ export type CellValue = string | number | boolean;
41
46
  export type CellFormat = string & {
42
47
  __brand: "CellFormat";
43
48
  };
49
+ /**
50
+ * Style applied to the cell to affect its appearance, like color, borders, alignment, etc.
51
+ */
52
+ export type CellStyle = {
53
+ /**
54
+ * Number of cell merges (WRITE ONLY).
55
+ * @remarks Due to API limitations, this value is never populated when reading a cell, but it can be set when writing a cell.
56
+ * @experimental
57
+ */
58
+ merge: {
59
+ right?: number;
60
+ down?: number;
61
+ };
62
+ /**
63
+ * Alignment of cell contents.
64
+ * @experimental
65
+ */
66
+ alignment: {
67
+ horizontal?: CellHorizontalAlignment;
68
+ vertical?: CellVerticalAlignment;
69
+ wrapText?: boolean | undefined;
70
+ };
71
+ /**
72
+ * Borders around the cell.
73
+ * @experimental
74
+ */
75
+ borders: {
76
+ top?: Border | undefined;
77
+ bottom?: Border | undefined;
78
+ left?: Border | undefined;
79
+ right?: Border | undefined;
80
+ insideVertical?: Border | undefined;
81
+ insideHorizontal?: Border | undefined;
82
+ diagonalDown?: Border | undefined;
83
+ diagonalUp?: Border | undefined;
84
+ };
85
+ /**
86
+ * Fill color of the cell.
87
+ * @experimental
88
+ */
89
+ fill: {
90
+ color?: Color;
91
+ };
92
+ /**
93
+ * Font settings for the cell.
94
+ * @experimental
95
+ */
96
+ font: {
97
+ name?: FontName;
98
+ size?: number;
99
+ color?: Color;
100
+ bold?: boolean;
101
+ italic?: boolean;
102
+ underline?: CellUnderline;
103
+ };
104
+ };
105
+ /**
106
+ * The amount of detail that we're reading from a cell.
107
+ */
108
+ export type CellScope = {
109
+ /** Raw underlying value. Cheap to read/write (1 op per ~10K cells for values, text & format) */
110
+ values: boolean;
111
+ /** Formatted value, as presented to the user. Cheap to read/write (1 op per ~10K cells for values, text & format) */
112
+ text: boolean;
113
+ /** Logic used to format values to text. Cheap to read/write (1 op per ~10K cells for values, text & format) */
114
+ format: boolean;
115
+ /** Content position with the cell. Expensive to read/write (1 op per cell) */
116
+ alignment: boolean;
117
+ /** Cell borders. Expensive to read/write (1 op per cell) */
118
+ borders: boolean;
119
+ /** Background fill style. Expensive to read/write (1 op per cell) */
120
+ fill: boolean;
121
+ /** Text style. Expensive to read/write (1 op per cell) */
122
+ font: boolean;
123
+ };
124
+ export type CellHorizontalAlignment = "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";
125
+ export type CellVerticalAlignment = "Top" | "Center" | "Bottom" | "Justify" | "Distributed";
126
+ export type CellUnderline = "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";
44
127
  //# sourceMappingURL=Cell.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Cell.d.ts","sourceRoot":"","sources":["../../../src/models/Cell.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG;IAClB;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAC/B,OAAO,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IACjC,OAAO,EAAE,YAAY,CAAC;CACtB,CAAC"}
1
+ {"version":3,"file":"Cell.d.ts","sourceRoot":"","sources":["../../../src/models/Cell.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,IAAI,GAAG;IAClB;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IACjC,OAAO,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACvB;;;;OAIG;IACH,KAAK,EAAE;QACN,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF;;;OAGG;IACH,SAAS,EAAE;QACV,UAAU,CAAC,EAAE,uBAAuB,CAAC;QACrC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;QACjC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC/B,CAAC;IACF;;;OAGG;IACH,OAAO,EAAE;QACR,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC3B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACpC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACtC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAClC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KAChC,CAAC;IAUF;;;OAGG;IACH,IAAI,EAAE;QACL,KAAK,CAAC,EAAE,KAAK,CAAC;KACd,CAAC;IACF;;;OAGG;IACH,IAAI,EAAE;QACL,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,SAAS,CAAC,EAAE,aAAa,CAAC;KAC1B,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACvB,gGAAgG;IAChG,MAAM,EAAE,OAAO,CAAC;IAEhB,qHAAqH;IACrH,IAAI,EAAE,OAAO,CAAC;IAEd,+GAA+G;IAC/G,MAAM,EAAE,OAAO,CAAC;IAEhB,8EAA8E;IAC9E,SAAS,EAAE,OAAO,CAAC;IAEnB,4DAA4D;IAC5D,OAAO,EAAE,OAAO,CAAC;IAEjB,qEAAqE;IACrE,IAAI,EAAE,OAAO,CAAC;IAEd,0DAA0D;IAC1D,IAAI,EAAE,OAAO,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,uBAAuB,GAAG,aAAa,CAAC;AAE7I,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC;AAE5F,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,kBAAkB,GAAG,kBAAkB,CAAC"}
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Color has a hexadecimal representation (ie #ffffff").
3
+ * @category Models
4
+ * @module Color
5
+ */
6
+ export type Color = string & {
7
+ __brand: "Color";
8
+ };
9
+ //# sourceMappingURL=Color.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Color.d.ts","sourceRoot":"","sources":["../../../src/models/Color.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG;IAC5B,OAAO,EAAE,OAAO,CAAC;CACjB,CAAC"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,6 +3,11 @@
3
3
  * @module Column
4
4
  * @category Models
5
5
  */
6
+ import type { Cell } from "./Cell.ts";
7
+ /**
8
+ * Vertical linear sequence of cells in a worksheet.
9
+ */
10
+ export type Column = Cell[];
6
11
  /**
7
12
  * Zero-based index representing the position of a column in a range.
8
13
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Column.d.ts","sourceRoot":"","sources":["../../../src/models/Column.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IACnC,OAAO,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IACjC,OAAO,EAAE,YAAY,CAAC;CACtB,CAAC"}
1
+ {"version":3,"file":"Column.d.ts","sourceRoot":"","sources":["../../../src/models/Column.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IACnC,OAAO,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IACjC,OAAO,EAAE,YAAY,CAAC;CACtB,CAAC"}
@@ -1,3 +1,7 @@
1
1
  "use strict";
2
- // biome-ignore lint/style/useFilenamingConvention: Appropriate in this context
2
+ /**
3
+ * Column pointers.
4
+ * @module Column
5
+ * @category Models
6
+ */
3
7
  Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,49 @@
1
+ /**
2
+ * Tooling for easily creating, updating, and deleting items in a worksheet or range.
3
+ * @module DataSource
4
+ * @category Models
5
+ * @experimental
6
+ */
7
+ import type { Cell, CellValue } from "./Cell.ts";
8
+ import type { ColumnName } from "./Column.ts";
9
+ import type { RowNumber, RowOffset } from "./Row.ts";
10
+ import type { WorkbookRangeRef } from "./WorkbookRange.ts";
11
+ /**
12
+ * Defines a data source for a worksheet or range.
13
+ * @template T Type of the record, extending RecordBase.
14
+ */
15
+ export type DataSource<T extends RecordBase> = {
16
+ bodyRef: WorkbookRangeRef;
17
+ bodyOffset: RowOffset;
18
+ head: ColumnName[];
19
+ coding: {
20
+ decode: RowDecoder<T>;
21
+ encode: RowEncoder<T> | null;
22
+ };
23
+ } & AsyncIterable<Item<T>>;
24
+ /**
25
+ * Method to decode row into a record.
26
+ */
27
+ export type RowDecoder<T extends RecordBase> = (row: DataSourceRow) => T;
28
+ /**
29
+ * Method to encode a record into a row.
30
+ */
31
+ export type RowEncoder<T extends RecordBase> = (record: T) => DataSourceRow;
32
+ /**
33
+ * Item's position within a data source.
34
+ */
35
+ export type ItemIndex = number & {
36
+ __brand: "ItemIndex";
37
+ };
38
+ /**
39
+ * Item within a data source.
40
+ */
41
+ export type Item<T extends RecordBase> = {
42
+ index: ItemIndex;
43
+ rowNumber: RowNumber;
44
+ record: T;
45
+ };
46
+ export type RecordBase = Record<string, CellValue>;
47
+ export type DataSourceRow = Record<ColumnName, Partial<Cell>>;
48
+ export type RangeOperationCallback = (rangeRef: WorkbookRangeRef) => Promise<void>;
49
+ //# sourceMappingURL=DataSource.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DataSource.d.ts","sourceRoot":"","sources":["../../../src/models/DataSource.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,UAAU,IAAI;IAC9C,OAAO,EAAE,gBAAgB,CAAC;IAC1B,UAAU,EAAE,SAAS,CAAC;IACtB,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB,MAAM,EAAE;QACP,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;QACtB,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;KAC7B,CAAC;CACF,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,GAAG,EAAE,aAAa,KAAK,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,aAAa,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAChC,OAAO,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,UAAU,IAAI;IACxC,KAAK,EAAE,SAAS,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC;CACV,CAAC;AAGF,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AACnD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9D,MAAM,MAAM,sBAAsB,GAAG,CAAC,QAAQ,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC"}
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ /**
3
+ * Tooling for easily creating, updating, and deleting items in a worksheet or range.
4
+ * @module DataSource
5
+ * @category Models
6
+ * @experimental
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Name of a font.
3
+ * @category Models
4
+ * @module FontName
5
+ */
6
+ export type FontName = string & {
7
+ __brand: "FontName";
8
+ };
9
+ //# sourceMappingURL=FontName.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"FontName.d.ts","sourceRoot":"","sources":["../../../src/models/FontName.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG;IAC/B,OAAO,EAAE,UAAU,CAAC;CACpB,CAAC"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -4,6 +4,9 @@
4
4
  * @category Models
5
5
  */
6
6
  import type { Cell } from "./Cell.ts";
7
+ /**
8
+ * Horizontal linear sequence of cells in a worksheet.
9
+ */
7
10
  export type Row = Cell[];
8
11
  /**
9
12
  * Row number as it appears in Excel.
@@ -1 +1 @@
1
- {"version":3,"file":"Row.d.ts","sourceRoot":"","sources":["../../../src/models/Row.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC,MAAM,MAAM,GAAG,GAAG,IAAI,EAAE,CAAC;AAEzB;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAChC,OAAO,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAChC,OAAO,EAAE,WAAW,CAAC;CACrB,CAAC"}
1
+ {"version":3,"file":"Row.d.ts","sourceRoot":"","sources":["../../../src/models/Row.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,IAAI,EAAE,CAAC;AAEzB;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAChC,OAAO,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAChC,OAAO,EAAE,WAAW,CAAC;CACrB,CAAC"}
@@ -9,8 +9,13 @@ import type { WorkbookRangeRef } from "../../models/WorkbookRange.ts";
9
9
  /**
10
10
  * Fetch a range.
11
11
  * @param rangeRef Reference to the range to be fetched.
12
+ * @param select Optional parameters to select specific properties of the range.
12
13
  * @returns The fetched range, including values and formatting
13
14
  * @see https://learn.microsoft.com/en-us/graph/api/range-get
14
15
  */
15
- export default function getWorkbookWorksheetRange(rangeRef: WorkbookRangeRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
16
+ export default function getWorkbookWorksheetRange(rangeRef: WorkbookRangeRef, select?: {
17
+ values?: boolean;
18
+ text?: boolean;
19
+ numberFormat?: boolean;
20
+ }): GraphOperation<WorkbookRange & WorkbookRangeRef>;
16
21
  //# sourceMappingURL=getWorkbookWorksheetRange.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getWorkbookWorksheetRange.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookRange/getWorkbookWorksheetRange.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAKtE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAoB9H"}
1
+ {"version":3,"file":"getWorkbookWorksheetRange.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookRange/getWorkbookWorksheetRange.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAKtE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CA2BrM"}
@@ -12,15 +12,22 @@ const templatedPaths_ts_1 = require("../../services/templatedPaths.js");
12
12
  /**
13
13
  * Fetch a range.
14
14
  * @param rangeRef Reference to the range to be fetched.
15
+ * @param select Optional parameters to select specific properties of the range.
15
16
  * @returns The fetched range, including values and formatting
16
17
  * @see https://learn.microsoft.com/en-us/graph/api/range-get
17
18
  */
18
- function getWorkbookWorksheetRange(rangeRef) {
19
+ function getWorkbookWorksheetRange(rangeRef, select) {
19
20
  const address = (0, addressManipulation_ts_1.normalizeAddress)(rangeRef.address, true);
21
+ const selectString = select
22
+ ? Object.entries(select)
23
+ .map(([k, v]) => (v ? k : undefined))
24
+ .filter((v) => !!v)
25
+ .join(",")
26
+ : null;
20
27
  return (0, operationInvoker_ts_1.operation)({
21
28
  context: rangeRef.context,
22
29
  method: "GET",
23
- path: (0, templatedPaths_ts_1.generatePath)(`/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range(address='${address}')`, rangeRef),
30
+ path: (0, templatedPaths_ts_1.generatePath)(`/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range(address='${address}')?$select=${selectString}`, rangeRef),
24
31
  headers: {
25
32
  "workbook-session-id": rangeRef.sessionId,
26
33
  },
@@ -0,0 +1,16 @@
1
+ /**
2
+ * List the borders of a range.
3
+ * @module listWorkbookRangeBorders
4
+ * @category Operations
5
+ */
6
+ import type { WorkbookRangeBorder } from "@microsoft/microsoft-graph-types";
7
+ import type { GraphOperation } from "../../models/GraphOperation.ts";
8
+ import type { WorkbookRangeRef } from "../../models/WorkbookRange.ts";
9
+ /**
10
+ * List the borders of a range.
11
+ * @param rangeRef Reference to the range whose borders will be listed.
12
+ * @returns Array of borders for the specified range.
13
+ * @see https://learn.microsoft.com/en-us/graph/api/rangeborder-list
14
+ */
15
+ export default function listWorkbookRangeBorders(rangeRef: WorkbookRangeRef): GraphOperation<WorkbookRangeBorder[]>;
16
+ //# sourceMappingURL=listWorkbookRangeBorders.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"listWorkbookRangeBorders.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookRange/listWorkbookRangeBorders.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAKtE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAelH"}
@@ -0,0 +1,33 @@
1
+ "use strict";
2
+ /**
3
+ * List the borders of a range.
4
+ * @module listWorkbookRangeBorders
5
+ * @category Operations
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.default = listWorkbookRangeBorders;
9
+ const addressManipulation_ts_1 = require("../../services/addressManipulation.js");
10
+ const operationInvoker_ts_1 = require("../../services/operationInvoker.js");
11
+ const templatedPaths_ts_1 = require("../../services/templatedPaths.js");
12
+ /**
13
+ * List the borders of a range.
14
+ * @param rangeRef Reference to the range whose borders will be listed.
15
+ * @returns Array of borders for the specified range.
16
+ * @see https://learn.microsoft.com/en-us/graph/api/rangeborder-list
17
+ */
18
+ function listWorkbookRangeBorders(rangeRef) {
19
+ const address = (0, addressManipulation_ts_1.normalizeAddress)(rangeRef.address, true);
20
+ return (0, operationInvoker_ts_1.operation)({
21
+ context: rangeRef.context,
22
+ method: "GET",
23
+ path: (0, templatedPaths_ts_1.generatePath)(`/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range(address='${address}')/format/borders`, rangeRef),
24
+ headers: {
25
+ "workbook-session-id": rangeRef.sessionId,
26
+ },
27
+ body: null,
28
+ responseTransform: (response) => {
29
+ const typed = response;
30
+ return typed.value;
31
+ },
32
+ });
33
+ }
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Update a specific border of a workbook range.
3
+ * @module setWorkbookRangeBorder
4
+ * @category Operations
5
+ */
6
+ import type { WorkbookRangeBorder } from "@microsoft/microsoft-graph-types";
7
+ import type { Border, BorderSide } from "../../models/Border.ts";
8
+ import type { GraphOperation } from "../../models/GraphOperation.ts";
9
+ import type { WorkbookRangeRef } from "../../models/WorkbookRange.ts";
10
+ /**
11
+ * Update a specific border of a workbook range.
12
+ * @param rangeRef Reference to the range whose border will be updated.
13
+ * @param side The border side to update (e.g., "EdgeTop", "EdgeBottom", "EdgeLeft", "EdgeRight", "InsideHorizontal", "InsideVertical").
14
+ * @param values Partial border object to update (color, style, weight, etc.).
15
+ * @returns The updated border for the specified range and side.
16
+ * @see https://learn.microsoft.com/en-us/graph/api/rangeborder-update
17
+ */
18
+ export default function setWorkbookRangeBorder(rangeRef: WorkbookRangeRef, side: BorderSide, values: Partial<Border>): GraphOperation<WorkbookRangeBorder & WorkbookRangeRef>;
19
+ //# sourceMappingURL=setWorkbookRangeBorder.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"setWorkbookRangeBorder.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookRange/setWorkbookRangeBorder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAKtE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,CAwB5K"}
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+ /**
3
+ * Update a specific border of a workbook range.
4
+ * @module setWorkbookRangeBorder
5
+ * @category Operations
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.default = setWorkbookRangeBorder;
9
+ const addressManipulation_ts_1 = require("../../services/addressManipulation.js");
10
+ const operationInvoker_ts_1 = require("../../services/operationInvoker.js");
11
+ const templatedPaths_ts_1 = require("../../services/templatedPaths.js");
12
+ /**
13
+ * Update a specific border of a workbook range.
14
+ * @param rangeRef Reference to the range whose border will be updated.
15
+ * @param side The border side to update (e.g., "EdgeTop", "EdgeBottom", "EdgeLeft", "EdgeRight", "InsideHorizontal", "InsideVertical").
16
+ * @param values Partial border object to update (color, style, weight, etc.).
17
+ * @returns The updated border for the specified range and side.
18
+ * @see https://learn.microsoft.com/en-us/graph/api/rangeborder-update
19
+ */
20
+ function setWorkbookRangeBorder(rangeRef, side, values) {
21
+ const address = (0, addressManipulation_ts_1.normalizeAddress)(rangeRef.address, true);
22
+ return (0, operationInvoker_ts_1.operation)({
23
+ context: rangeRef.context,
24
+ method: "PATCH",
25
+ path: (0, templatedPaths_ts_1.generatePath)(`/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range(address='${address}')/format/borders/${side}`, rangeRef),
26
+ headers: {
27
+ "workbook-session-id": rangeRef.sessionId,
28
+ "content-type": "application/json",
29
+ },
30
+ body: {
31
+ sideIndex: side,
32
+ color: values.color,
33
+ style: values.style,
34
+ weight: values.weight,
35
+ },
36
+ responseTransform: (response) => {
37
+ const updated = response;
38
+ return {
39
+ ...updated,
40
+ ...rangeRef,
41
+ };
42
+ },
43
+ });
44
+ }
@@ -1 +1 @@
1
- {"version":3,"file":"addressManipulation.d.ts","sourceRoot":"","sources":["../../../src/services/addressManipulation.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAuD,iBAAiB,EAA+B,MAAM,sBAAsB,CAAC;AAGtK,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAuBnE;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,UAAQ,GAAG,OAAO,CAE9E;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,iBAAiB,CAcpE;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,iBAAiB,EAAE,UAAU,UAAQ,GAAG,OAAO,CAsBzF;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGjE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGhE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS5D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS3D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS/D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAqChG;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAKlF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG5D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG/D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG7D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG1D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAGzD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAG5D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAuCzF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,GAAG,OAAO,CAqC1J;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,GAAG,OAAO,CA2B5J;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,GAAG,gBAAgB,CAM3K;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,GAAG,gBAAgB,CAM7K"}
1
+ {"version":3,"file":"addressManipulation.d.ts","sourceRoot":"","sources":["../../../src/services/addressManipulation.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAuD,iBAAiB,EAA+B,MAAM,sBAAsB,CAAC;AAGtK,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAuBnE;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,UAAQ,GAAG,OAAO,CAE9E;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,iBAAiB,CAcpE;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,iBAAiB,EAAE,UAAU,UAAQ,GAAG,OAAO,CAsBzF;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGjE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGhE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS5D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS3D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS/D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAqChG;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAKlF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG5D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG/D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG7D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAG1D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAGzD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAG5D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAuCzF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,GAAG,OAAO,CAsC1J;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,GAAG,OAAO,CA2B5J;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,GAAG,gBAAgB,CAM3K;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,EAAE,QAAQ,SAAI,EAAE,QAAQ,SAA2B,GAAG,gBAAgB,CAM7K"}
@@ -374,7 +374,8 @@ function subAddress(address, skipRows = 0, takeRows = Number.POSITIVE_INFINITY,
374
374
  const [startRow, endRow] = slice(ay, by, skipRows, takeRows);
375
375
  const [startCol, endCol] = slice(ax, bx, skipCols, takeCols);
376
376
  if (startRow < ay || endRow > by || startRow > endRow || startCol < ax || endCol > bx || startCol > endCol) {
377
- throw new InvalidArgumentError_ts_1.default(`Requested subaddress is out of bounds: rows [${startRow + 1},${endRow + 1}], cols [${startCol + 1},${endCol + 1}] in range.`);
377
+ const requestedAddress = (0, cartesianAddress_ts_1.cartesianToAddress)({ ax: startCol, bx: endCol, ay: startRow, by: endRow });
378
+ throw new InvalidArgumentError_ts_1.default(`Requested subaddress ${requestedAddress} is out of bounds of the base address ${address}.`);
378
379
  }
379
380
  return (0, cartesianAddress_ts_1.cartesianToAddress)({
380
381
  ay: startRow,
@@ -39,10 +39,10 @@ function cartesianToAddress({ ax, ay, bx, by }) {
39
39
  const endColumn = (0, addressOffset_ts_1.columnOffsetToAddress)(bx);
40
40
  const endRow = (0, addressOffset_ts_1.rowOffsetToAddress)(by);
41
41
  if (ax > bx) {
42
- throw new InvalidArgumentError_ts_1.default("Invalid address. End column is before start column.");
42
+ throw new InvalidArgumentError_ts_1.default(`Invalid address. End column is before start column. ax=${ax} bx=${bx}.`);
43
43
  }
44
44
  if (ay > by) {
45
- throw new InvalidArgumentError_ts_1.default("Invalid address. End row is before start row.");
45
+ throw new InvalidArgumentError_ts_1.default(`Invalid address. End row is before start row. ay=${ay} by=${by}.`);
46
46
  }
47
47
  const address = (0, addressManipulation_ts_1.composeAddress)({
48
48
  startRow,
@@ -0,0 +1,69 @@
1
+ /**
2
+ * Tooling for easily creating, updating, and deleting items in a worksheet or range.
3
+ * @module dataSource
4
+ * @category Services
5
+ * @experimental
6
+ */
7
+ import type { DataSource, Item, ItemIndex, RecordBase, RowDecoder, RowEncoder } from "../models/DataSource.ts";
8
+ import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
9
+ /**
10
+ * Define a datasource from an entire worksheet.
11
+ * @template T Type of the record, extending RecordBase.
12
+ * @param worksheetRef Workbook range reference to define the data source on.
13
+ * @param decode Function to decode a row into a record.
14
+ * @param encode Function to encode a record into a row. Optional.
15
+ * @returns The initialized data source.
16
+ * @experimental
17
+ */
18
+ export declare function dataSourceFromWorksheet<T extends RecordBase>(worksheetRef: WorkbookRangeRef, decode: RowDecoder<T>, encode?: RowEncoder<T> | null): Promise<DataSource<T>>;
19
+ /**
20
+ * Defines a data source from a given range.
21
+ * @template T Type of the record, extending RecordBase.
22
+ * @param rangeRef Workbook range reference to define the data source on.
23
+ * @param decode Function to decode a row into a record.
24
+ * @param encode Function to encode a record into a row. Optional.
25
+ * @returns The initialized data source.
26
+ * @experimental
27
+ */
28
+ export declare function dataSourceFromRange<T extends RecordBase>(rangeRef: WorkbookRangeRef, decode: RowDecoder<T>, encode?: RowEncoder<T> | null): Promise<DataSource<T>>;
29
+ /**
30
+ * Reads all items from the data source.
31
+ * @template T Type of the record, extending RecordBase.
32
+ * @param source Data source to read from.
33
+ * @returns Array of all items in the data source.
34
+ * @deprecated Iterate on the source directly using `for await (const item of source)`.
35
+ */
36
+ export declare function listItems<T extends RecordBase>(source: DataSource<T>): AsyncIterable<Item<T>>;
37
+ /**
38
+ * Creates a new item in the data source.
39
+ * @template T Type of the record, extending RecordBase.
40
+ * @param source Data source to insert into. Must be initialized.
41
+ * @param record Record to insert.
42
+ * @param after Index after which to insert the new item. If null, inserts at the end. If -1 inserts at top.
43
+ * @returns Newly created item, including its index, row number, and record.
44
+ * @throws {InvalidOperationError} If the data source is not initialized.
45
+ * @throws {InvalidArgumentError} If the 'after' index is out of range.
46
+ * @experimental
47
+ */
48
+ export declare function createItem<T extends RecordBase>(source: DataSource<T>, record: T, after?: ItemIndex | null): Promise<Item<T>>;
49
+ /**
50
+ * Updates an item in the data source at the specified index.
51
+ * @template T Type of the record, extending RecordBase.
52
+ * @param source Data source to update. Must be initialized.
53
+ * @param index Index of the item to update.
54
+ * @param record New record to write at the specified index.
55
+ * @throws {InvalidOperationError} If the data source is not initialized.
56
+ * @throws {InvalidArgumentError} If the index is out of range.
57
+ * @experimental
58
+ */
59
+ export declare function updateItem<T extends RecordBase>(source: DataSource<T>, index: ItemIndex, record: T): Promise<void>;
60
+ /**
61
+ * Deletes an item from the data source at the specified index.
62
+ * @template T Type of the record, extending RecordBase.
63
+ * @param source Data source to delete from. Must be initialized.
64
+ * @param index Index of the item to delete.
65
+ * @throws {InvalidOperationError} If the data source is not initialized.
66
+ * @experimental
67
+ */
68
+ export declare function deleteItem<T extends RecordBase>(source: DataSource<T>, index: ItemIndex): Promise<void>;
69
+ //# sourceMappingURL=dataSource.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dataSource.d.ts","sourceRoot":"","sources":["../../../src/services/dataSource.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,KAAK,EAAE,UAAU,EAAiB,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE9H,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAWnE;;;;;;;;GAQG;AACH,wBAAsB,uBAAuB,CAAC,CAAC,SAAS,UAAU,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,GAAE,UAAU,CAAC,CAAC,CAAC,GAAG,IAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAGtL;AACD;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,SAAS,UAAU,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,GAAE,UAAU,CAAC,CAAC,CAAC,GAAG,IAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAqC9K;AAED;;;;;;GAMG;AACH,wBAAuB,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAIpG;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,GAAE,SAAS,GAAG,IAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAgBzI;AAED;;;;;;;;;GASG;AACH,wBAAsB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CASxH;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAI7G"}