@bilig/workbook 0.42.0

package/dist/describe.d.ts

@@ -0,0 +1,153 @@
+import type { CellRangeRef, CellStylePatch, LiteralInput } from '@bilig/protocol';
+import type { WorkbookRef, WorkbookRefKind, WorkbookRowOperator } from './find.js';
+import { type WorkbookActionInspection, type WorkbookActionMap, type WorkbookActionPlan, type WorkbookActionPlanResult, type WorkbookModel } from './model.js';
+import type { WorkbookActionInput } from './input.js';
+import type { WorkbookOp } from './ops.js';
+import type { WorkbookCheckStatus, WorkbookRunErrorCode, WorkbookRunResult } from './result.js';
+export interface WorkbookModelDescription {
+    readonly name: string;
+    readonly description?: string;
+    readonly actions: readonly string[];
+    readonly actionDetails: readonly WorkbookActionInspection[];
+    readonly hasChecks: boolean;
+}
+export interface WorkbookBaseRefDescription {
+    readonly kind: WorkbookRefKind;
+    readonly id: string;
+    readonly label: string;
+}
+export interface WorkbookRangeRefDescription extends WorkbookBaseRefDescription {
+    readonly kind: 'range';
+    readonly range: CellRangeRef;
+}
+export interface WorkbookNameRefDescription extends WorkbookBaseRefDescription {
+    readonly kind: 'name';
+    readonly name: string;
+}
+export interface WorkbookTableRefDescription extends WorkbookBaseRefDescription {
+    readonly kind: 'table';
+    readonly name?: string;
+    readonly sheetName?: string;
+    readonly headers?: readonly string[];
+}
+export interface WorkbookColumnRefDescription extends WorkbookBaseRefDescription {
+    readonly kind: 'column';
+    readonly table: WorkbookTableRefDescription;
+    readonly rows?: WorkbookRowsRefDescription;
+    readonly name: string;
+}
+export interface WorkbookRowsRefDescription extends WorkbookBaseRefDescription {
+    readonly kind: 'rows';
+    readonly sheetName?: string;
+    readonly table?: WorkbookTableRefDescription;
+    readonly where: {
+        readonly column: string;
+        readonly op: WorkbookRowOperator;
+        readonly value: LiteralInput;
+    };
+}
+export type WorkbookRefDescription = WorkbookRangeRefDescription | WorkbookNameRefDescription | WorkbookTableRefDescription | WorkbookColumnRefDescription | WorkbookRowsRefDescription;
+export type WorkbookActionCommandDescription = {
+    readonly kind: 'writeFormula';
+    readonly target: WorkbookRefDescription;
+    readonly formula: string;
+    readonly inputs: readonly WorkbookRefDescription[];
+} | {
+    readonly kind: 'writeValue';
+    readonly target: WorkbookRefDescription;
+    readonly value: LiteralInput;
+} | {
+    readonly kind: 'format';
+    readonly target: WorkbookRefDescription;
+    readonly style?: CellStylePatch;
+    readonly numberFormat?: string | null;
+} | {
+    readonly kind: 'clear';
+    readonly target: WorkbookRefDescription;
+} | {
+    readonly kind: 'op';
+    readonly op: WorkbookOp;
+    readonly target?: WorkbookRefDescription;
+    readonly message?: string;
+};
+export interface WorkbookChangeSummaryDescription {
+    readonly kind: string;
+    readonly target?: WorkbookRefDescription;
+    readonly message: string;
+}
+export interface WorkbookCheckResultDescription {
+    readonly status: WorkbookCheckStatus;
+    readonly kind: string;
+    readonly target?: WorkbookRefDescription;
+    readonly refs?: readonly WorkbookRefDescription[];
+    readonly message: string;
+    readonly expectation?: WorkbookCheckExpectationDescription;
+}
+export type WorkbookCheckExpectationDescription = {
+    readonly kind: 'valueEquals';
+    readonly value: LiteralInput;
+} | {
+    readonly kind: 'valuesEqual';
+    readonly values: readonly (readonly LiteralInput[])[];
+} | {
+    readonly kind: 'formulaEquals';
+    readonly formula: string;
+    readonly inputs: readonly WorkbookRefDescription[];
+} | {
+    readonly kind: 'formulasEqual';
+    readonly formulas: readonly (readonly (string | null)[])[];
+};
+export interface WorkbookActionPlanDescription {
+    readonly modelName: string;
+    readonly actionName: string;
+    readonly input?: WorkbookActionInput;
+    readonly refsUsed: readonly WorkbookRefDescription[];
+    readonly commands: readonly WorkbookActionCommandDescription[];
+    readonly ops: readonly WorkbookOp[];
+    readonly changed: readonly WorkbookChangeSummaryDescription[];
+    readonly checks: readonly WorkbookCheckResultDescription[];
+}
+export type WorkbookActionPlanResultDescription = {
+    readonly status: 'planned';
+    readonly plan: WorkbookActionPlanDescription;
+} | {
+    readonly status: 'failed';
+    readonly modelName: string;
+    readonly actionName: string;
+    readonly input?: WorkbookActionInput;
+    readonly errors: readonly WorkbookRunErrorDescription[];
+    readonly checks: readonly WorkbookCheckResultDescription[];
+};
+export interface WorkbookUndoRefDescription {
+    readonly id: string;
+    readonly ops?: readonly WorkbookOp[];
+}
+export type WorkbookRunResultDescription = {
+    readonly status: 'done';
+    readonly changed: readonly WorkbookChangeSummaryDescription[];
+    readonly checks: readonly WorkbookCheckResultDescription[];
+    readonly undo?: WorkbookUndoRefDescription;
+    readonly applied?: WorkbookAppliedSummaryDescription;
+} | {
+    readonly status: 'failed';
+    readonly errors: readonly WorkbookRunErrorDescription[];
+    readonly checks: readonly WorkbookCheckResultDescription[];
+};
+export interface WorkbookRunErrorDescription {
+    readonly code: WorkbookRunErrorCode;
+    readonly message: string;
+    readonly path?: string;
+    readonly target?: WorkbookRefDescription;
+    readonly check?: WorkbookCheckResultDescription;
+    readonly expected?: WorkbookActionInput;
+    readonly actual?: WorkbookActionInput;
+}
+export interface WorkbookAppliedSummaryDescription {
+    readonly opCount: number;
+    readonly ops?: readonly WorkbookOp[];
+}
+export declare function describeModel<Refs, Actions extends WorkbookActionMap<Refs>>(model: WorkbookModel<Refs, Actions>): WorkbookModelDescription;
+export declare function describeRef(ref: WorkbookRef): WorkbookRefDescription;
+export declare function describePlan<Refs>(plan: WorkbookActionPlan<Refs>): WorkbookActionPlanDescription;
+export declare function describePlanResult<Refs>(result: WorkbookActionPlanResult<Refs>): WorkbookActionPlanResultDescription;
+export declare function describeRunResult(result: WorkbookRunResult): WorkbookRunResultDescription;

package/dist/describe.js

@@ -0,0 +1,210 @@
+import { inspectModel, } from './model.js';
+export function describeModel(model) {
+    return inspectModel(model);
+}
+function describeRangeRef(ref) {
+    return {
+        kind: 'range',
+        id: ref.id,
+        label: ref.label,
+        range: { ...ref.range },
+    };
+}
+function describeNameRef(ref) {
+    return {
+        kind: 'name',
+        id: ref.id,
+        label: ref.label,
+        name: ref.name,
+    };
+}
+function describeTableRef(ref) {
+    return {
+        kind: 'table',
+        id: ref.id,
+        label: ref.label,
+        ...(ref.name !== undefined ? { name: ref.name } : {}),
+        ...(ref.sheetName !== undefined ? { sheetName: ref.sheetName } : {}),
+        ...(ref.headers !== undefined ? { headers: [...ref.headers] } : {}),
+    };
+}
+function describeColumnRef(ref) {
+    return {
+        kind: 'column',
+        id: ref.id,
+        label: ref.label,
+        table: describeTableRef(ref.table),
+        ...(ref.rows !== undefined ? { rows: describeRowsRef(ref.rows) } : {}),
+        name: ref.name,
+    };
+}
+function describeRowsRef(ref) {
+    return {
+        kind: 'rows',
+        id: ref.id,
+        label: ref.label,
+        ...(ref.sheetName !== undefined ? { sheetName: ref.sheetName } : {}),
+        ...(ref.table !== undefined ? { table: describeTableRef(ref.table) } : {}),
+        where: { ...ref.where },
+    };
+}
+export function describeRef(ref) {
+    switch (ref.kind) {
+        case 'range':
+            return describeRangeRef(ref);
+        case 'name':
+            return describeNameRef(ref);
+        case 'table':
+            return describeTableRef(ref);
+        case 'column':
+            return describeColumnRef(ref);
+        case 'rows':
+            return describeRowsRef(ref);
+    }
+}
+function describeCommand(command) {
+    switch (command.kind) {
+        case 'writeFormula':
+            return {
+                kind: 'writeFormula',
+                target: describeRef(command.target),
+                formula: command.formula,
+                inputs: command.inputs.map(describeRef),
+            };
+        case 'writeValue':
+            return {
+                kind: 'writeValue',
+                target: describeRef(command.target),
+                value: command.value,
+            };
+        case 'format':
+            return {
+                kind: 'format',
+                target: describeRef(command.target),
+                ...(command.style !== undefined ? { style: command.style } : {}),
+                ...(command.numberFormat !== undefined ? { numberFormat: command.numberFormat } : {}),
+            };
+        case 'clear':
+            return {
+                kind: 'clear',
+                target: describeRef(command.target),
+            };
+        case 'op':
+            return {
+                kind: 'op',
+                op: command.op,
+                ...(command.target !== undefined ? { target: describeRef(command.target) } : {}),
+                ...(command.message !== undefined ? { message: command.message } : {}),
+            };
+    }
+}
+function describeChange(change) {
+    return {
+        kind: change.kind,
+        ...(change.target !== undefined ? { target: describeRef(change.target) } : {}),
+        message: change.message,
+    };
+}
+function describeCheck(check) {
+    return {
+        status: check.status,
+        kind: check.kind,
+        ...(check.target !== undefined ? { target: describeRef(check.target) } : {}),
+        ...(check.refs !== undefined ? { refs: check.refs.map(describeRef) } : {}),
+        message: check.message,
+        ...(check.expectation !== undefined ? { expectation: describeExpectation(check.expectation) } : {}),
+    };
+}
+function describeExpectation(expectation) {
+    switch (expectation.kind) {
+        case 'valueEquals':
+            return {
+                kind: 'valueEquals',
+                value: expectation.value,
+            };
+        case 'valuesEqual':
+            return {
+                kind: 'valuesEqual',
+                values: expectation.values.map((row) => [...row]),
+            };
+        case 'formulaEquals':
+            return {
+                kind: 'formulaEquals',
+                formula: expectation.formula,
+                inputs: expectation.inputs.map(describeRef),
+            };
+        case 'formulasEqual':
+            return {
+                kind: 'formulasEqual',
+                formulas: expectation.formulas.map((row) => [...row]),
+            };
+    }
+}
+export function describePlan(plan) {
+    return {
+        modelName: plan.modelName,
+        actionName: plan.actionName,
+        ...(plan.input !== undefined ? { input: plan.input } : {}),
+        refsUsed: plan.refsUsed.map(describeRef),
+        commands: plan.commands.map(describeCommand),
+        ops: [...plan.ops],
+        changed: plan.changed.map(describeChange),
+        checks: plan.checks.map(describeCheck),
+    };
+}
+function describeError(error) {
+    return {
+        code: error.code,
+        message: error.message,
+        ...(error.path !== undefined ? { path: error.path } : {}),
+        ...(error.target !== undefined ? { target: describeRef(error.target) } : {}),
+        ...(error.check !== undefined ? { check: describeCheck(error.check) } : {}),
+        ...(error.expected !== undefined ? { expected: error.expected } : {}),
+        ...(error.actual !== undefined ? { actual: error.actual } : {}),
+    };
+}
+function describeApplied(applied) {
+    return {
+        opCount: applied.opCount,
+        ...(applied.ops !== undefined ? { ops: [...applied.ops] } : {}),
+    };
+}
+function describeUndo(undo) {
+    return {
+        id: undo.id,
+        ...(undo.ops !== undefined ? { ops: [...undo.ops] } : {}),
+    };
+}
+export function describePlanResult(result) {
+    if (result.status === 'planned') {
+        return {
+            status: 'planned',
+            plan: describePlan(result.plan),
+        };
+    }
+    return {
+        status: 'failed',
+        modelName: result.modelName,
+        actionName: result.actionName,
+        ...(result.input !== undefined ? { input: result.input } : {}),
+        errors: result.errors.map(describeError),
+        checks: result.checks.map(describeCheck),
+    };
+}
+export function describeRunResult(result) {
+    if (result.status === 'done') {
+        return {
+            status: 'done',
+            changed: result.changed.map(describeChange),
+            checks: result.checks.map(describeCheck),
+            ...(result.undo !== undefined ? { undo: describeUndo(result.undo) } : {}),
+            ...(result.applied !== undefined ? { applied: describeApplied(result.applied) } : {}),
+        };
+    }
+    return {
+        status: 'failed',
+        errors: result.errors.map(describeError),
+        checks: result.checks.map(describeCheck),
+    };
+}
+//# sourceMappingURL=describe.js.map

package/dist/describe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describe.js","sourceRoot":"","sources":["../src/describe.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,YAAY,GAOb,MAAM,YAAY,CAAA;AAiMnB,MAAM,UAAU,aAAa,CAC3B,KAAmC;IAEnC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAA;AAC5B,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAqB;IAC7C,OAAO;QACL,IAAI,EAAE,OAAO;QACb,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,KAAK,EAAE,EAAE,GAAG,GAAG,CAAC,KAAK,EAAE;KACxB,CAAA;AACH,CAAC;AAED,SAAS,eAAe,CAAC,GAAoB;IAC3C,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,IAAI,EAAE,GAAG,CAAC,IAAI;KACf,CAAA;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAqB;IAC7C,OAAO;QACL,IAAI,EAAE,OAAO;QACb,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,GAAG,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,GAAG,CAAC,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACpE,CAAA;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,GAAsB;IAC/C,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC;QAClC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtE,IAAI,EAAE,GAAG,CAAC,IAAI;KACf,CAAA;AACH,CAAC;AAED,SAAS,eAAe,CAAC,GAAoB;IAC3C,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,GAAG,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,GAAG,CAAC,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1E,KAAK,EAAE,EAAE,GAAG,GAAG,CAAC,KAAK,EAAE;KACxB,CAAA;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAgB;IAC1C,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,OAAO;YACV,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAC9B,KAAK,MAAM;YACT,OAAO,eAAe,CAAC,GAAG,CAAC,CAAA;QAC7B,KAAK,OAAO;YACV,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAC9B,KAAK,QAAQ;YACX,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAA;QAC/B,KAAK,MAAM;YACT,OAAO,eAAe,CAAC,GAAG,CAAC,CAAA;IAC/B,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,OAA8B;IACrD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,cAAc;YACjB,OAAO;gBACL,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;gBACnC,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC;aACxC,CAAA;QACH,KAAK,YAAY;YACf,OAAO;gBACL,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;gBACnC,KAAK,EAAE,OAAO,CAAC,KAAK;aACrB,CAAA;QACH,KAAK,QAAQ;YACX,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;gBACnC,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChE,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACtF,CAAA;QACH,KAAK,OAAO;YACV,OAAO;gBACL,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;aACpC,CAAA;QACH,KAAK,IAAI;YACP,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChF,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACvE,CAAA;IACL,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,MAA6B;IACnD,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9E,OAAO,EAAE,MAAM,CAAC,OAAO;KACxB,CAAA;AACH,CAAC;AAED,SAAS,aAAa,CAAC,KAA0B;IAC/C,OAAO;QACL,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1E,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,GAAG,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,mBAAmB,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACpG,CAAA;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,WAAqC;IAChE,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;QACzB,KAAK,aAAa;YAChB,OAAO;gBACL,IAAI,EAAE,aAAa;gBACnB,KAAK,EAAE,WAAW,CAAC,KAAK;aACzB,CAAA;QACH,KAAK,aAAa;YAChB,OAAO;gBACL,IAAI,EAAE,aAAa;gBACnB,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;aAClD,CAAA;QACH,KAAK,eAAe;YAClB,OAAO;gBACL,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,WAAW,CAAC,OAAO;gBAC5B,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC;aAC5C,CAAA;QACH,KAAK,eAAe;YAClB,OAAO;gBACL,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;aACtD,CAAA;IACL,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAO,IAA8B;IAC/D,OAAO;QACL,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1D,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC;QACxC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC;QAC5C,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QAClB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;QACzC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;KACvC,CAAA;AACH,CAAC;AAED,SAAS,aAAa,CAAC,KAAuB;IAC5C,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzD,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3E,GAAG,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrE,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChE,CAAA;AACH,CAAC;AAED,SAAS,eAAe,CAAC,OAA+B;IACtD,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChE,CAAA;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAqB;IACzC,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1D,CAAA;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAO,MAAsC;IAC7E,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO;YACL,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC;SAChC,CAAA;IACH,CAAC;IACD,OAAO;QACL,MAAM,EAAE,QAAQ;QAChB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;QACxC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;KACzC,CAAA;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAyB;IACzD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC7B,OAAO;YACL,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;YAC3C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;YACxC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzE,GAAG,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACtF,CAAA;IACH,CAAC;IACD,OAAO;QACL,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;QACxC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;KACzC,CAAA;AACH,CAAC"}

package/dist/find.d.ts

@@ -0,0 +1,99 @@
+import { type CellRangeRef, type LiteralInput } from '@bilig/protocol';
+export type WorkbookRefKind = 'range' | 'name' | 'table' | 'column' | 'rows';
+export interface WorkbookBaseRef {
+    readonly kind: WorkbookRefKind;
+    readonly id: string;
+    readonly label: string;
+}
+export interface WorkbookRangeRef extends WorkbookBaseRef {
+    readonly kind: 'range';
+    readonly range: CellRangeRef;
+}
+export interface WorkbookNameRef extends WorkbookBaseRef {
+    readonly kind: 'name';
+    readonly name: string;
+}
+export interface WorkbookTableRef extends WorkbookBaseRef {
+    readonly kind: 'table';
+    readonly name?: string;
+    readonly sheetName?: string;
+    readonly headers?: readonly string[];
+    readonly column: (name: string) => WorkbookColumnRef;
+}
+export interface WorkbookColumnRef extends WorkbookBaseRef {
+    readonly kind: 'column';
+    readonly table: WorkbookTableRef;
+    readonly rows?: WorkbookRowsRef;
+    readonly name: string;
+}
+export type WorkbookRowOperator = 'eq' | 'neq' | 'contains' | 'startsWith' | 'gt' | 'gte' | 'lt' | 'lte';
+export interface WorkbookRowsRef extends WorkbookBaseRef {
+    readonly kind: 'rows';
+    readonly sheetName?: string;
+    readonly table?: WorkbookTableRef;
+    readonly where: {
+        readonly column: string;
+        readonly op: WorkbookRowOperator;
+        readonly value: LiteralInput;
+    };
+    readonly column: (name: string) => WorkbookColumnRef;
+}
+export type WorkbookRef = WorkbookRangeRef | WorkbookNameRef | WorkbookTableRef | WorkbookColumnRef | WorkbookRowsRef;
+export declare function isWorkbookRef(value: unknown): value is WorkbookRef;
+export declare function collectWorkbookRefs(value: unknown): readonly WorkbookRef[];
+export interface FindTableOptions {
+    readonly name?: string;
+    readonly sheetName?: string;
+    readonly headers?: readonly string[];
+}
+export interface FindColumnOptions {
+    readonly table: WorkbookTableRef;
+    readonly rows?: WorkbookRowsRef;
+    readonly name: string;
+}
+export interface FindRowsOptions {
+    readonly sheetName?: string;
+    readonly table?: WorkbookTableRef;
+    readonly where: {
+        readonly column: string;
+        readonly op: WorkbookRowOperator;
+        readonly value: LiteralInput;
+    };
+}
+export interface FindRangeCellInput extends CellRangeRef {
+}
+export type FindRangeInput = FindRangeCellInput | {
+    readonly sheetName: string;
+    readonly address: string;
+} | {
+    readonly sheetName: string;
+    readonly startAddress: string;
+    readonly endAddress?: string;
+};
+export interface WorkbookFindApi {
+    readonly findTable: (options: FindTableOptions) => WorkbookTableRef;
+    readonly findColumn: (options: FindColumnOptions) => WorkbookColumnRef;
+    readonly findRange: (input: FindRangeInput) => WorkbookRangeRef;
+    readonly findName: (name: string) => WorkbookNameRef;
+    readonly findRows: (options: FindRowsOptions) => WorkbookRowsRef;
+}
+export interface WorkbookFindNamespace extends WorkbookFindApi {
+    readonly table: (options: FindTableOptions) => WorkbookTableRef;
+    readonly column: (options: FindColumnOptions) => WorkbookColumnRef;
+    readonly range: (input: FindRangeInput) => WorkbookRangeRef;
+    readonly name: (name: string) => WorkbookNameRef;
+    readonly rows: (options: FindRowsOptions) => WorkbookRowsRef;
+}
+export declare function normalizeRangeRef(input: FindRangeInput): CellRangeRef;
+export declare function createWorkbookTableRef(options: FindTableOptions): WorkbookTableRef;
+export declare function createWorkbookColumnRef(options: FindColumnOptions): WorkbookColumnRef;
+export declare function createWorkbookRangeRef(input: FindRangeInput): WorkbookRangeRef;
+export declare function createWorkbookNameRef(name: string): WorkbookNameRef;
+export declare function createWorkbookRowsRef(options: FindRowsOptions): WorkbookRowsRef;
+export declare function findTable(options: FindTableOptions): WorkbookTableRef;
+export declare function findColumn(options: FindColumnOptions): WorkbookColumnRef;
+export declare function findRange(input: FindRangeInput): WorkbookRangeRef;
+export declare function findName(name: string): WorkbookNameRef;
+export declare function findRows(options: FindRowsOptions): WorkbookRowsRef;
+export declare function createWorkbookFindApi(): WorkbookFindApi;
+export declare const find: WorkbookFindNamespace;