MutationIssue | @sheetwrite/core

Structured warning or rejection produced while applying an operation.

Package: @sheetwrite/core
Source: packages/core/src/types/document.ts#L247

Variants 5

{
  kind: "validation";
  severity: "error" | "warning";
  ruleId: string;
  addr: CellAddressinterface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}interface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}interface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}Zero-based address of one cell on a stable sheet ID.API reference →;
  value: CellValuetype CellValue =
  | { kind: "literal"; value: CellScalar }
  | { kind: "ref"; target: CellAddress }
  | { kind: "formula"; src: string };type CellValue =
  | { kind: "literal"; value: CellScalar }
  | { kind: "ref"; target: CellAddress }
  | { kind: "formula"; src: string };type CellValue =
  | {
      kind: "literal";
      value: CellScalar;
    }
  | {
      kind: "ref";
      target: CellAddress;
    }
  | {
      kind: "formula";
      src: string;
    };A cell's persisted input: a literal, a cross-reference, or a formula. References resolve through the store's reference graph; formulas resolve in the WASM calculation engine.API reference →;
  message: string;
  operationIndex: number;
}

{
  kind: "protection";
  severity: "error";
  protectedRangeId: string;
  range: Rangeinterface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: {
    row: number;
    col: number;
  };
  end: {
    row: number;
    col: number;
  };
}Inclusive rectangular cell range on a stable sheet ID.API reference →;
  operationIndex: number;
  message: string;
}

{
  kind: "invalid-operation";
  severity: "error";
  operationIndex: number;
  message: string;
}

{
  kind: "resource-limit";
  severity: "error";
  resource:
    | "operations"
    | "encoded-bytes"
    | "pending-commits"
    | "pending-operations"
    | "pending-encoded-bytes"
    | "paged-dirty-cells"
    | "paged-reference-simulation";
  actual: number;
  max: number;
  message: string;
}

{
  kind: "sheet-lifecycle";
  severity: "error";
  code: SheetLifecycleIssueCodetype SheetLifecycleIssueCode =
  | SheetNameIssueCode
  | "duplicate-sheet-id"
  | "sheet-not-found"
  | "invalid-sheet"
  | "invalid-position"
  | "last-visible-sheet";type SheetLifecycleIssueCode =
  | SheetNameIssueCode
  | "duplicate-sheet-id"
  | "sheet-not-found"
  | "invalid-sheet"
  | "invalid-position"
  | "last-visible-sheet";type SheetLifecycleIssueCode =
  | SheetNameIssueCode
  | "duplicate-sheet-id"
  | "sheet-not-found"
  | "invalid-sheet"
  | "invalid-position"
  | "last-visible-sheet";Stable lifecycle rejection codes suitable for inline sheet-management UI.API reference →;
  sheet?: SheetIdtype SheetId = string;type SheetId = string;type SheetId = string;Stable identifier used to address a workbook sheet.API reference →;
  operationIndex: number;
  message: string;
}

Declaration

View full TypeScript declaration

export type MutationIssue =
  | {
      kind: "validation";
      severity: "error" | "warning";
      ruleId: string;
      addr: CellAddressinterface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}interface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}interface CellAddress {
  sheet: SheetId;
  row: number;
  col: number;
}Zero-based address of one cell on a stable sheet ID.API reference →;
      value: CellValuetype CellValue =
  | { kind: "literal"; value: CellScalar }
  | { kind: "ref"; target: CellAddress }
  | { kind: "formula"; src: string };type CellValue =
  | { kind: "literal"; value: CellScalar }
  | { kind: "ref"; target: CellAddress }
  | { kind: "formula"; src: string };type CellValue =
  | {
      kind: "literal";
      value: CellScalar;
    }
  | {
      kind: "ref";
      target: CellAddress;
    }
  | {
      kind: "formula";
      src: string;
    };A cell's persisted input: a literal, a cross-reference, or a formula. References resolve through the store's reference graph; formulas resolve in the WASM calculation engine.API reference →;
      message: string;
      operationIndex: number;
    }
  | {
      kind: "protection";
      severity: "error";
      protectedRangeId: string;
      range: Rangeinterface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: {
    row: number;
    col: number;
  };
  end: {
    row: number;
    col: number;
  };
}Inclusive rectangular cell range on a stable sheet ID.API reference →;
      operationIndex: number;
      message: string;
    }
  | {
      kind: "invalid-operation";
      severity: "error";
      operationIndex: number;
      message: string;
    }
  | {
      kind: "resource-limit";
      severity: "error";
      resource:
        | "operations"
        | "encoded-bytes"
        | "pending-commits"
        | "pending-operations"
        | "pending-encoded-bytes"
        | "paged-dirty-cells"
        | "paged-reference-simulation";
      actual: number;
      max: number;
      message: string;
    }
  | {
      kind: "sheet-lifecycle";
      severity: "error";
      code: SheetLifecycleIssueCodetype SheetLifecycleIssueCode =
  | SheetNameIssueCode
  | "duplicate-sheet-id"
  | "sheet-not-found"
  | "invalid-sheet"
  | "invalid-position"
  | "last-visible-sheet";type SheetLifecycleIssueCode =
  | SheetNameIssueCode
  | "duplicate-sheet-id"
  | "sheet-not-found"
  | "invalid-sheet"
  | "invalid-position"
  | "last-visible-sheet";type SheetLifecycleIssueCode =
  | SheetNameIssueCode
  | "duplicate-sheet-id"
  | "sheet-not-found"
  | "invalid-sheet"
  | "invalid-position"
  | "last-visible-sheet";Stable lifecycle rejection codes suitable for inline sheet-management UI.API reference →;
      sheet?: SheetIdtype SheetId = string;type SheetId = string;type SheetId = string;Stable identifier used to address a workbook sheet.API reference →;
      operationIndex: number;
      message: string;
    };