microsoft-graph 2.34.1 → 2.36.0

package/dist/cjs/models/DataSource.d.ts

@@ -1,49 +0,0 @@
-/**
- * Tooling for easily creating, updating, and deleting items in a worksheet or range.
- * @module DataSource
- * @category Models
- * @experimental
- */
-import type { Cell, CellValue } from "./Cell.ts";
-import type { ColumnName } from "./Column.ts";
-import type { RowNumber, RowOffset } from "./Row.ts";
-import type { WorkbookRangeRef } from "./WorkbookRange.ts";
-/**
- * Defines a data source for a worksheet or range.
- * @template T Type of the record, extending RecordBase.
- */
-export type DataSource<T extends RecordBase> = {
-    bodyRef: WorkbookRangeRef;
-    bodyOffset: RowOffset;
-    head: ColumnName[];
-    coding: {
-        decode: RowDecoder<T>;
-        encode: RowEncoder<T> | null;
-    };
-} & AsyncIterable<Item<T>>;
-/**
- * Method to decode row into a record.
- */
-export type RowDecoder<T extends RecordBase> = (row: DataSourceRow) => T;
-/**
- * Method to encode a record into a row.
- */
-export type RowEncoder<T extends RecordBase> = (record: T) => DataSourceRow;
-/**
- * Item's position within a data source.
- */
-export type ItemIndex = number & {
-    __brand: "ItemIndex";
-};
-/**
- * Item within a data source.
- */
-export type Item<T extends RecordBase> = {
-    index: ItemIndex;
-    rowNumber: RowNumber;
-    record: T;
-};
-export type RecordBase = Record<string, CellValue>;
-export type DataSourceRow = Record<ColumnName, Partial<Cell>>;
-export type RangeOperationCallback = (rangeRef: WorkbookRangeRef) => Promise<void>;
-//# sourceMappingURL=DataSource.d.ts.map

package/dist/cjs/models/DataSource.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/cjs/models/DataSource.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Tooling for easily creating, updating, and deleting items in a worksheet or range.
- * @module DataSource
- * @category Models
- * @experimental
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/services/dataSource.d.ts

@@ -1,69 +0,0 @@
-/**
- * Tooling for easily creating, updating, and deleting items in a worksheet or range.
- * @module dataSource
- * @category Services
- * @experimental
- */
-import type { DataSource, Item, ItemIndex, RecordBase, RowDecoder, RowEncoder } from "../models/DataSource.ts";
-import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
-/**
- * Define a datasource from an entire worksheet.
- * @template T Type of the record, extending RecordBase.
- * @param worksheetRef Workbook range reference to define the data source on.
- * @param decode Function to decode a row into a record.
- * @param encode Function to encode a record into a row. Optional.
- * @returns The initialized data source.
- * @experimental
- */
-export declare function dataSourceFromWorksheet<T extends RecordBase>(worksheetRef: WorkbookRangeRef, decode: RowDecoder<T>, encode?: RowEncoder<T> | null): Promise<DataSource<T>>;
-/**
- * Defines a data source from a given range.
- * @template T Type of the record, extending RecordBase.
- * @param rangeRef Workbook range reference to define the data source on.
- * @param decode Function to decode a row into a record.
- * @param encode Function to encode a record into a row. Optional.
- * @returns The initialized data source.
- * @experimental
- */
-export declare function dataSourceFromRange<T extends RecordBase>(rangeRef: WorkbookRangeRef, decode: RowDecoder<T>, encode?: RowEncoder<T> | null): Promise<DataSource<T>>;
-/**
- * Reads all items from the data source.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to read from.
- * @returns Array of all items in the data source.
- * @deprecated Iterate on the source directly using `for await (const item of source)`.
- */
-export declare function listItems<T extends RecordBase>(source: DataSource<T>): AsyncIterable<Item<T>>;
-/**
- * Creates a new item in the data source.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to insert into. Must be initialized.
- * @param record Record to insert.
- * @param after Index after which to insert the new item. If null, inserts at the end. If -1 inserts at top.
- * @returns Newly created item, including its index, row number, and record.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @throws {InvalidArgumentError} If the 'after' index is out of range.
- * @experimental
- */
-export declare function createItem<T extends RecordBase>(source: DataSource<T>, record: T, after?: ItemIndex | null): Promise<Item<T>>;
-/**
- * Updates an item in the data source at the specified index.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to update. Must be initialized.
- * @param index Index of the item to update.
- * @param record New record to write at the specified index.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @throws {InvalidArgumentError} If the index is out of range.
- * @experimental
- */
-export declare function updateItem<T extends RecordBase>(source: DataSource<T>, index: ItemIndex, record: T): Promise<void>;
-/**
- * Deletes an item from the data source at the specified index.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to delete from. Must be initialized.
- * @param index Index of the item to delete.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @experimental
- */
-export declare function deleteItem<T extends RecordBase>(source: DataSource<T>, index: ItemIndex): Promise<void>;
-//# sourceMappingURL=dataSource.d.ts.map

package/dist/cjs/services/dataSource.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/cjs/services/dataSource.js

@@ -1,193 +0,0 @@
-"use strict";
-/**
- * Tooling for easily creating, updating, and deleting items in a worksheet or range.
- * @module dataSource
- * @category Services
- * @experimental
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dataSourceFromWorksheet = dataSourceFromWorksheet;
-exports.dataSourceFromRange = dataSourceFromRange;
-exports.listItems = listItems;
-exports.createItem = createItem;
-exports.updateItem = updateItem;
-exports.deleteItem = deleteItem;
-const InvalidOperationError_ts_1 = __importDefault(require("../errors/InvalidOperationError.js"));
-const ProtocolError_ts_1 = __importDefault(require("../errors/ProtocolError.js"));
-const deleteWorkbookRange_ts_1 = __importDefault(require("../operations/workbookRange/deleteWorkbookRange.js"));
-const getWorkbookWorksheetRange_ts_1 = __importDefault(require("../operations/workbookRange/getWorkbookWorksheetRange.js"));
-const insertWorkbookCells_ts_1 = __importDefault(require("../operations/workbookRange/insertWorkbookCells.js"));
-const updateWorkbookRange_ts_1 = __importDefault(require("../operations/workbookRange/updateWorkbookRange.js"));
-const getWorkbookWorksheetUsedRangeRef_ts_1 = __importDefault(require("../operations/workbookWorksheet/getWorkbookWorksheetUsedRangeRef.js"));
-const readWorkbookRows_ts_1 = __importDefault(require("../tasks/readWorkbookRows.js"));
-const addressManipulation_ts_1 = require("./addressManipulation.js");
-const cartesianAddress_ts_1 = require("./cartesianAddress.js");
-const cell_ts_1 = require("./cell.js");
-/**
- * Define a datasource from an entire worksheet.
- * @template T Type of the record, extending RecordBase.
- * @param worksheetRef Workbook range reference to define the data source on.
- * @param decode Function to decode a row into a record.
- * @param encode Function to encode a record into a row. Optional.
- * @returns The initialized data source.
- * @experimental
- */
-async function dataSourceFromWorksheet(worksheetRef, decode, encode = null) {
-    const rangeRef = await (0, getWorkbookWorksheetUsedRangeRef_ts_1.default)(worksheetRef);
-    return dataSourceFromRange(rangeRef, decode, encode);
-}
-/**
- * Defines a data source from a given range.
- * @template T Type of the record, extending RecordBase.
- * @param rangeRef Workbook range reference to define the data source on.
- * @param decode Function to decode a row into a record.
- * @param encode Function to encode a record into a row. Optional.
- * @returns The initialized data source.
- * @experimental
- */
-async function dataSourceFromRange(rangeRef, decode, encode = null) {
-    if ((0, addressManipulation_ts_1.countAddressRows)(rangeRef.address) < 1) {
-        throw new InvalidOperationError_ts_1.default("Cannot create a data source from an empty range. It must at least contain a header row.");
-    }
-    const headRef = (0, addressManipulation_ts_1.subRange)(rangeRef, 0, 1);
-    const bodyRef = (0, addressManipulation_ts_1.subRange)(rangeRef, 1);
-    const head = await getHead(headRef);
-    const { ay: bodyOffset } = (0, cartesianAddress_ts_1.addressToCartesian)(bodyRef.address);
-    const source = {
-        bodyRef,
-        bodyOffset,
-        coding: {
-            decode,
-            encode,
-        },
-        head,
-        async *[Symbol.asyncIterator]() {
-            let index = 0;
-            for await (const row of (0, readWorkbookRows_ts_1.default)(source.bodyRef)) {
-                const record = rowToRecord(row, source);
-                const rowNumber = indexToRowNumber(source.bodyOffset, index);
-                yield {
-                    index,
-                    rowNumber,
-                    record,
-                };
-                index++;
-            }
-        },
-    };
-    return source;
-}
-/**
- * Reads all items from the data source.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to read from.
- * @returns Array of all items in the data source.
- * @deprecated Iterate on the source directly using `for await (const item of source)`.
- */
-async function* listItems(source) {
-    for await (const item of source) {
-        yield item;
-    }
-}
-/**
- * Creates a new item in the data source.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to insert into. Must be initialized.
- * @param record Record to insert.
- * @param after Index after which to insert the new item. If null, inserts at the end. If -1 inserts at top.
- * @returns Newly created item, including its index, row number, and record.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @throws {InvalidArgumentError} If the 'after' index is out of range.
- * @experimental
- */
-async function createItem(source, record, after = null) {
-    const count = (0, addressManipulation_ts_1.countAddressRows)(source.bodyRef.address);
-    const index = (after === null ? count : after + 1);
-    const rowNumber = indexToRowNumber(source.bodyOffset, index);
-    await (0, insertWorkbookCells_ts_1.default)((0, addressManipulation_ts_1.superRange)(source.bodyRef, index, 1), "Down");
-    source.bodyRef = (0, addressManipulation_ts_1.superRange)(source.bodyRef, 0, count + 1);
-    await updateItem(source, index, record);
-    return {
-        index,
-        rowNumber,
-        record,
-    };
-}
-/**
- * Updates an item in the data source at the specified index.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to update. Must be initialized.
- * @param index Index of the item to update.
- * @param record New record to write at the specified index.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @throws {InvalidArgumentError} If the index is out of range.
- * @experimental
- */
-async function updateItem(source, index, record) {
-    const row = recordToRow(record, source);
-    const rowRef = (0, addressManipulation_ts_1.subRange)(source.bodyRef, index, 1);
-    await (0, updateWorkbookRange_ts_1.default)(rowRef, {
-        values: [row.map((x) => x.value)],
-        text: [row.map((x) => x.text)],
-        numberFormat: [row.map((x) => x.format)],
-    });
-}
-/**
- * Deletes an item from the data source at the specified index.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to delete from. Must be initialized.
- * @param index Index of the item to delete.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @experimental
- */
-async function deleteItem(source, index) {
-    const rowRef = (0, addressManipulation_ts_1.subRange)(source.bodyRef, index, 1);
-    await (0, deleteWorkbookRange_ts_1.default)(rowRef, "Up");
-    source.bodyRef = (0, addressManipulation_ts_1.subRange)(source.bodyRef, 0, -1);
-}
-function rowToRecord(row, source) {
-    const sourceRow = source.head.reduce((acc, heading, columnIndex) => {
-        const cell = row[columnIndex];
-        if (!cell) {
-            throw new ProtocolError_ts_1.default(`Cell for '${heading}' is undefined`);
-        }
-        acc[heading] = cell;
-        return acc;
-    }, {});
-    const record = source.coding.decode(sourceRow);
-    return record;
-}
-function recordToRow(record, source) {
-    if (!source.coding.encode) {
-        throw new InvalidOperationError_ts_1.default("Data source does not have an encoder defined. Add an encoder for reading.");
-    }
-    const sourceRow = source.coding.encode(record);
-    const row = source.head.map((heading) => {
-        const cell = sourceRow[heading];
-        if (cell === undefined) {
-            throw new Error(`Encoder produced undefined value for '${heading}'.`); // TODO: Make more specific error
-        }
-        return {
-            value: cell.value ?? "",
-            text: cell.text ?? (cell.value ?? "").toString(),
-            format: cell.format ?? cell_ts_1.generalCellFormat,
-            merge: {},
-            alignment: {},
-            borders: {},
-            fill: {},
-            font: {},
-        };
-    });
-    return row;
-}
-function indexToRowNumber(bodyOffset, index) {
-    return (bodyOffset + index + 1); // +1 to convert to 1-based index
-}
-async function getHead(headRef) {
-    const headRange = await (0, getWorkbookWorksheetRange_ts_1.default)(headRef);
-    const head = headRange.text[0].map((x) => x);
-    return head;
-}

package/dist/esm/models/DataSource.d.ts

@@ -1,49 +0,0 @@
-/**
- * Tooling for easily creating, updating, and deleting items in a worksheet or range.
- * @module DataSource
- * @category Models
- * @experimental
- */
-import type { Cell, CellValue } from "./Cell.ts";
-import type { ColumnName } from "./Column.ts";
-import type { RowNumber, RowOffset } from "./Row.ts";
-import type { WorkbookRangeRef } from "./WorkbookRange.ts";
-/**
- * Defines a data source for a worksheet or range.
- * @template T Type of the record, extending RecordBase.
- */
-export type DataSource<T extends RecordBase> = {
-    bodyRef: WorkbookRangeRef;
-    bodyOffset: RowOffset;
-    head: ColumnName[];
-    coding: {
-        decode: RowDecoder<T>;
-        encode: RowEncoder<T> | null;
-    };
-} & AsyncIterable<Item<T>>;
-/**
- * Method to decode row into a record.
- */
-export type RowDecoder<T extends RecordBase> = (row: DataSourceRow) => T;
-/**
- * Method to encode a record into a row.
- */
-export type RowEncoder<T extends RecordBase> = (record: T) => DataSourceRow;
-/**
- * Item's position within a data source.
- */
-export type ItemIndex = number & {
-    __brand: "ItemIndex";
-};
-/**
- * Item within a data source.
- */
-export type Item<T extends RecordBase> = {
-    index: ItemIndex;
-    rowNumber: RowNumber;
-    record: T;
-};
-export type RecordBase = Record<string, CellValue>;
-export type DataSourceRow = Record<ColumnName, Partial<Cell>>;
-export type RangeOperationCallback = (rangeRef: WorkbookRangeRef) => Promise<void>;
-//# sourceMappingURL=DataSource.d.ts.map

package/dist/esm/models/DataSource.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/esm/models/DataSource.js

@@ -1,7 +0,0 @@
-/**
- * Tooling for easily creating, updating, and deleting items in a worksheet or range.
- * @module DataSource
- * @category Models
- * @experimental
- */
-export {};

package/dist/esm/services/dataSource.d.ts

@@ -1,69 +0,0 @@
-/**
- * Tooling for easily creating, updating, and deleting items in a worksheet or range.
- * @module dataSource
- * @category Services
- * @experimental
- */
-import type { DataSource, Item, ItemIndex, RecordBase, RowDecoder, RowEncoder } from "../models/DataSource.ts";
-import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
-/**
- * Define a datasource from an entire worksheet.
- * @template T Type of the record, extending RecordBase.
- * @param worksheetRef Workbook range reference to define the data source on.
- * @param decode Function to decode a row into a record.
- * @param encode Function to encode a record into a row. Optional.
- * @returns The initialized data source.
- * @experimental
- */
-export declare function dataSourceFromWorksheet<T extends RecordBase>(worksheetRef: WorkbookRangeRef, decode: RowDecoder<T>, encode?: RowEncoder<T> | null): Promise<DataSource<T>>;
-/**
- * Defines a data source from a given range.
- * @template T Type of the record, extending RecordBase.
- * @param rangeRef Workbook range reference to define the data source on.
- * @param decode Function to decode a row into a record.
- * @param encode Function to encode a record into a row. Optional.
- * @returns The initialized data source.
- * @experimental
- */
-export declare function dataSourceFromRange<T extends RecordBase>(rangeRef: WorkbookRangeRef, decode: RowDecoder<T>, encode?: RowEncoder<T> | null): Promise<DataSource<T>>;
-/**
- * Reads all items from the data source.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to read from.
- * @returns Array of all items in the data source.
- * @deprecated Iterate on the source directly using `for await (const item of source)`.
- */
-export declare function listItems<T extends RecordBase>(source: DataSource<T>): AsyncIterable<Item<T>>;
-/**
- * Creates a new item in the data source.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to insert into. Must be initialized.
- * @param record Record to insert.
- * @param after Index after which to insert the new item. If null, inserts at the end. If -1 inserts at top.
- * @returns Newly created item, including its index, row number, and record.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @throws {InvalidArgumentError} If the 'after' index is out of range.
- * @experimental
- */
-export declare function createItem<T extends RecordBase>(source: DataSource<T>, record: T, after?: ItemIndex | null): Promise<Item<T>>;
-/**
- * Updates an item in the data source at the specified index.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to update. Must be initialized.
- * @param index Index of the item to update.
- * @param record New record to write at the specified index.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @throws {InvalidArgumentError} If the index is out of range.
- * @experimental
- */
-export declare function updateItem<T extends RecordBase>(source: DataSource<T>, index: ItemIndex, record: T): Promise<void>;
-/**
- * Deletes an item from the data source at the specified index.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to delete from. Must be initialized.
- * @param index Index of the item to delete.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @experimental
- */
-export declare function deleteItem<T extends RecordBase>(source: DataSource<T>, index: ItemIndex): Promise<void>;
-//# sourceMappingURL=dataSource.d.ts.map

package/dist/esm/services/dataSource.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/esm/services/dataSource.js

@@ -1,182 +0,0 @@
-/**
- * Tooling for easily creating, updating, and deleting items in a worksheet or range.
- * @module dataSource
- * @category Services
- * @experimental
- */
-import InvalidOperationError from "../errors/InvalidOperationError.js";
-import ProtocolError from "../errors/ProtocolError.js";
-import deleteWorkbookRange from "../operations/workbookRange/deleteWorkbookRange.js";
-import getWorkbookWorksheetRange from "../operations/workbookRange/getWorkbookWorksheetRange.js";
-import insertWorkbookCells from "../operations/workbookRange/insertWorkbookCells.js";
-import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
-import getWorkbookWorksheetUsedRangeRef from "../operations/workbookWorksheet/getWorkbookWorksheetUsedRangeRef.js";
-import readWorkbookRows from "../tasks/readWorkbookRows.js";
-import { countAddressRows, subRange, superRange } from "./addressManipulation.js";
-import { addressToCartesian } from "./cartesianAddress.js";
-import { generalCellFormat } from "./cell.js";
-/**
- * Define a datasource from an entire worksheet.
- * @template T Type of the record, extending RecordBase.
- * @param worksheetRef Workbook range reference to define the data source on.
- * @param decode Function to decode a row into a record.
- * @param encode Function to encode a record into a row. Optional.
- * @returns The initialized data source.
- * @experimental
- */
-export async function dataSourceFromWorksheet(worksheetRef, decode, encode = null) {
-    const rangeRef = await getWorkbookWorksheetUsedRangeRef(worksheetRef);
-    return dataSourceFromRange(rangeRef, decode, encode);
-}
-/**
- * Defines a data source from a given range.
- * @template T Type of the record, extending RecordBase.
- * @param rangeRef Workbook range reference to define the data source on.
- * @param decode Function to decode a row into a record.
- * @param encode Function to encode a record into a row. Optional.
- * @returns The initialized data source.
- * @experimental
- */
-export async function dataSourceFromRange(rangeRef, decode, encode = null) {
-    if (countAddressRows(rangeRef.address) < 1) {
-        throw new InvalidOperationError("Cannot create a data source from an empty range. It must at least contain a header row.");
-    }
-    const headRef = subRange(rangeRef, 0, 1);
-    const bodyRef = subRange(rangeRef, 1);
-    const head = await getHead(headRef);
-    const { ay: bodyOffset } = addressToCartesian(bodyRef.address);
-    const source = {
-        bodyRef,
-        bodyOffset,
-        coding: {
-            decode,
-            encode,
-        },
-        head,
-        async *[Symbol.asyncIterator]() {
-            let index = 0;
-            for await (const row of readWorkbookRows(source.bodyRef)) {
-                const record = rowToRecord(row, source);
-                const rowNumber = indexToRowNumber(source.bodyOffset, index);
-                yield {
-                    index,
-                    rowNumber,
-                    record,
-                };
-                index++;
-            }
-        },
-    };
-    return source;
-}
-/**
- * Reads all items from the data source.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to read from.
- * @returns Array of all items in the data source.
- * @deprecated Iterate on the source directly using `for await (const item of source)`.
- */
-export async function* listItems(source) {
-    for await (const item of source) {
-        yield item;
-    }
-}
-/**
- * Creates a new item in the data source.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to insert into. Must be initialized.
- * @param record Record to insert.
- * @param after Index after which to insert the new item. If null, inserts at the end. If -1 inserts at top.
- * @returns Newly created item, including its index, row number, and record.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @throws {InvalidArgumentError} If the 'after' index is out of range.
- * @experimental
- */
-export async function createItem(source, record, after = null) {
-    const count = countAddressRows(source.bodyRef.address);
-    const index = (after === null ? count : after + 1);
-    const rowNumber = indexToRowNumber(source.bodyOffset, index);
-    await insertWorkbookCells(superRange(source.bodyRef, index, 1), "Down");
-    source.bodyRef = superRange(source.bodyRef, 0, count + 1);
-    await updateItem(source, index, record);
-    return {
-        index,
-        rowNumber,
-        record,
-    };
-}
-/**
- * Updates an item in the data source at the specified index.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to update. Must be initialized.
- * @param index Index of the item to update.
- * @param record New record to write at the specified index.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @throws {InvalidArgumentError} If the index is out of range.
- * @experimental
- */
-export async function updateItem(source, index, record) {
-    const row = recordToRow(record, source);
-    const rowRef = subRange(source.bodyRef, index, 1);
-    await updateWorkbookRange(rowRef, {
-        values: [row.map((x) => x.value)],
-        text: [row.map((x) => x.text)],
-        numberFormat: [row.map((x) => x.format)],
-    });
-}
-/**
- * Deletes an item from the data source at the specified index.
- * @template T Type of the record, extending RecordBase.
- * @param source Data source to delete from. Must be initialized.
- * @param index Index of the item to delete.
- * @throws {InvalidOperationError} If the data source is not initialized.
- * @experimental
- */
-export async function deleteItem(source, index) {
-    const rowRef = subRange(source.bodyRef, index, 1);
-    await deleteWorkbookRange(rowRef, "Up");
-    source.bodyRef = subRange(source.bodyRef, 0, -1);
-}
-function rowToRecord(row, source) {
-    const sourceRow = source.head.reduce((acc, heading, columnIndex) => {
-        const cell = row[columnIndex];
-        if (!cell) {
-            throw new ProtocolError(`Cell for '${heading}' is undefined`);
-        }
-        acc[heading] = cell;
-        return acc;
-    }, {});
-    const record = source.coding.decode(sourceRow);
-    return record;
-}
-function recordToRow(record, source) {
-    if (!source.coding.encode) {
-        throw new InvalidOperationError("Data source does not have an encoder defined. Add an encoder for reading.");
-    }
-    const sourceRow = source.coding.encode(record);
-    const row = source.head.map((heading) => {
-        const cell = sourceRow[heading];
-        if (cell === undefined) {
-            throw new Error(`Encoder produced undefined value for '${heading}'.`); // TODO: Make more specific error
-        }
-        return {
-            value: cell.value ?? "",
-            text: cell.text ?? (cell.value ?? "").toString(),
-            format: cell.format ?? generalCellFormat,
-            merge: {},
-            alignment: {},
-            borders: {},
-            fill: {},
-            font: {},
-        };
-    });
-    return row;
-}
-function indexToRowNumber(bodyOffset, index) {
-    return (bodyOffset + index + 1); // +1 to convert to 1-based index
-}
-async function getHead(headRef) {
-    const headRange = await getWorkbookWorksheetRange(headRef);
-    const head = headRange.text[0].map((x) => x);
-    return head;
-}