@sheetxl/sdk 0.4.7 → 0.4.9

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sheetxl/sdk",
   "description": "SDK - A high-performance, embeddable spreadsheet engine.",
-  "version": "0.4.7",
+  "version": "0.4.9",
   "license": "SEE LICENSE IN <LICENSE>",
   "type": "module",
   "exports": {
@@ -31,9 +31,9 @@
     "automation"
   ],
   "dependencies": {
-    "@sheetxl/primitives": "^0.4.7",
-    "@sheetxl/scripting": "^0.4.7",
-    "@sheetxl/utils": "^0.4.7",
+    "@sheetxl/primitives": "^0.4.9",
+    "@sheetxl/scripting": "^0.4.9",
+    "@sheetxl/utils": "^0.4.9",
     "bahttext": "^2.3.0",
     "bessel": "^1.0.2",
     "chalk": "^5.4.1",

package/types/index.d.ts

@@ -1040,7 +1040,8 @@ declare class DefaultProtection<T, P extends IProtection.Properties, J extends I
     protected _password: Partial<IProtection.EncryptedPassword>;
     protected _identities: IProtection.IdentityProvider[];
     protected _properties: Partial<P>;
-    constructor(json?: J);
+    protected _isReadOnly: boolean;
+    constructor(json?: J, isReadOnly?: boolean);
     /** {@inheritDoc IProtection.lock} */
     lock(properties?: Partial<P>, password?: string, algorithm?: string, spinCount?: number): Promise<IProtection<T, P, J>>;
     /** {@inheritDoc IProtection.unlock} */
@@ -1053,8 +1054,12 @@ declare class DefaultProtection<T, P extends IProtection.Properties, J extends I
     pause(password?: string): Promise<IProtection<T, P, J>>;
     /** {@inheritDoc IProtection.resume} */
     resume(): IProtection<T, P, J>;
+    /** {@inheritDoc IProtection.isPaused} */
     isPaused(): boolean;
+    /** {@inheritDoc IProtection.isLocked} */
     isLocked(): boolean;
+    /** {@inheritDoc IProtection.isReadOnly} */
+    isReadOnly(): boolean;
     protected _validatePassword(password?: string): Promise<boolean>;
     getProperties(): Partial<P>;
     protected _isPropertyAllowed(property: keyof P): boolean;
@@ -3220,10 +3225,12 @@ export declare interface ICell {
     /**
      * Returns the cell's value as a formatted string, applying any number formatting.
      *
+     * @param numFmt A custom number format to apply (optional).
+     *
      * @see
      * {@link toTextUnformatted}
      */
-    toText(): string;
+    toText(numFmt?: string): string;
     /**
      * Returns the cell's value as an unformatted string.
      *
@@ -3723,6 +3730,15 @@ export declare interface ICellContainerOptions {
      * @defaultValue false
      */
     date1904?: boolean;
+    /**
+     * If `true` then the model is readonly and cannot be save.
+     *
+     * @defaultValue false
+     *
+     * @remarks
+     * Useful when you want to load a model for viewing only and prevent any accidental changes.
+     */
+    readonly?: boolean;
 }
 
 /**
@@ -10392,6 +10408,10 @@ export declare namespace INamedCollection {
          * A transaction store that can be used to undo/redo changes to the names.
          */
         transactions?: ITransaction.IStore;
+        /**
+         * If the collection is readonly.
+         */
+        isReadOnly?: () => boolean;
         /**
          * JSON state to load.
          */
@@ -10868,6 +10888,13 @@ export declare interface IProtection<T, P extends IProtection.Properties, J exte
      * @returns `true` if the object is locked but paused, `false` otherwise.
      */
     isPaused(): boolean;
+    /**
+     * If the element is protected as readonly.
+     *
+     * @remarks
+     * Readonly is set cannot be changed.
+     */
+    isReadOnly(): boolean;
     /**
      * Add Listeners.
      *
@@ -18323,7 +18350,6 @@ export declare class Sheet implements ISheet {
     protected _rowHeadersRemoveListener: IListener.Remove;
     protected _emptyCell: ICell;
     protected _cellOptions: SheetCellOptions;
-    protected _initialized: boolean;
     protected _closed: boolean;
     protected _defaultColWidthCache: number;
     protected _defaultRowHeightCache: number;
@@ -20441,6 +20467,8 @@ export declare class Workbook implements IWorkbook {
     protected _transactionsRemoveListener: IListener.Remove;
     protected _lastTransactionUUID: string;
     protected _starting: Promise<void>;
+    protected _closed: boolean;
+    protected _initializing: boolean;
     protected _emitter: ListenerEmitter<IWorkbook, IWorkbook.IListeners>;
     protected _scripts: IScript;
     protected _theme: ITheme;
@@ -20464,7 +20492,6 @@ export declare class Workbook implements IWorkbook {
     protected _listenerProtection: IListener.Remove;
     protected _listenerWorkbookView: IListener.Remove;
     protected _isDate1904: boolean;
-    protected _closed: boolean;
     constructor(options?: IWorkbook.ConstructorOptions);
     protected _initState(): void;
     /** {@inheritDoc IWorkbook.getView} */

package/types/scripting.d.ts

@@ -8577,6 +8577,10 @@ declare module "named/INamedCollection" {
              * A transaction store that can be used to undo/redo changes to the names.
              */
             transactions?: ITransaction.IStore;
+            /**
+             * If the collection is readonly.
+             */
+            isReadOnly?: () => boolean;
             /**
              * JSON state to load.
              */
@@ -14601,6 +14605,13 @@ declare module "protection/IProtection" {
          * @returns `true` if the object is locked but paused, `false` otherwise.
          */
         isPaused(): boolean;
+        /**
+         * If the element is protected as readonly.
+         *
+         * @remarks
+         * Readonly is set cannot be changed.
+         */
+        isReadOnly(): boolean;
         /**
          * Add Listeners.
          *
@@ -14899,6 +14910,15 @@ declare module "sheet/ICellContainerOptions" {
          * @defaultValue false
          */
         date1904?: boolean;
+        /**
+         * If `true` then the model is readonly and cannot be save.
+         *
+         * @defaultValue false
+         *
+         * @remarks
+         * Useful when you want to load a model for viewing only and prevent any accidental changes.
+         */
+        readonly?: boolean;
     }
 }
 declare module "conditional/IConditionalFormatCollection" {
@@ -16424,6 +16444,7 @@ declare module "address/_AddressMessages" {
 }
 declare module "sheet/_SheetMessages" {
     export const ERROR_INVALID_ARGS = "The arguments are not valid.";
+    export const ERROR_READONLY_SHEET: (description?: string) => string;
     export const ERROR_PROTECTED_SHEET = "This sheet is protected. To make a change, unprotect the sheet. You might be requested to enter a password.";
     export const ERROR_PROTECTED_FIELD: (description?: string) => string;
     export const ERROR_OOB_RANGE = "The range is outside of the bounds of the sheet.";
@@ -17966,7 +17987,7 @@ declare module "sheet/SheetCell" {
         /** {@inheritDoc ICell.toDate} */
         toDate(): Date | null;
         /** {@inheritDoc ICell.toText} */
-        toText(): string;
+        toText(numFmt?: string): string;
         /** {@inheritDoc ICell.toTextUnformatted} */
         toTextUnformatted(showFormula?: boolean): string;
         /** {@inheritDoc ICell.getComments} */
@@ -23987,10 +24008,12 @@ declare module "cell/ICell" {
         /**
          * Returns the cell's value as a formatted string, applying any number formatting.
          *
+         * @param numFmt A custom number format to apply (optional).
+         *
          * @see
          * {@link toTextUnformatted}
          */
-        toText(): string;
+        toText(numFmt?: string): string;
         /**
          * Returns the cell's value as an unformatted string.
          *
@@ -29865,6 +29888,7 @@ declare module "named/_NamedMessages" {
     export const ERROR_INVALID_SPECIAL_R_C = "Name can not be 'r' or 'c'.";
     export const ERROR_INVALID_INVALID_CELL_ADDRESS = "Name can not be an address.";
     export const ERROR_NAME_EXISTS: (name: string, scope?: string) => string;
+    export const ERROR_NAME_READONLY = "Names are read-only.";
     export const ERROR_NAME_DOES_NOT_EXIST: (name: string) => string;
 }
 declare module "named/NamedCollection" {
@@ -31779,7 +31803,8 @@ declare module "protection/DefaultProtection" {
         protected _password: Partial<IProtection.EncryptedPassword>;
         protected _identities: IProtection.IdentityProvider[];
         protected _properties: Partial<P>;
-        constructor(json?: J);
+        protected _isReadOnly: boolean;
+        constructor(json?: J, isReadOnly?: boolean);
         /** {@inheritDoc IProtection.lock} */
         lock(properties?: Partial<P>, password?: string, algorithm?: string, spinCount?: number): Promise<IProtection<T, P, J>>;
         /** {@inheritDoc IProtection.unlock} */
@@ -31792,8 +31817,12 @@ declare module "protection/DefaultProtection" {
         pause(password?: string): Promise<IProtection<T, P, J>>;
         /** {@inheritDoc IProtection.resume} */
         resume(): IProtection<T, P, J>;
+        /** {@inheritDoc IProtection.isPaused} */
         isPaused(): boolean;
+        /** {@inheritDoc IProtection.isLocked} */
         isLocked(): boolean;
+        /** {@inheritDoc IProtection.isReadOnly} */
+        isReadOnly(): boolean;
         protected _validatePassword(password?: string): Promise<boolean>;
         getProperties(): Partial<P>;
         protected _isPropertyAllowed(property: keyof P): boolean;
@@ -32427,7 +32456,6 @@ declare module "sheet/Sheet" {
         protected _rowHeadersRemoveListener: IListener.Remove;
         protected _emptyCell: ICell;
         protected _cellOptions: SheetCellOptions;
-        protected _initialized: boolean;
         protected _closed: boolean;
         protected _defaultColWidthCache: number;
         protected _defaultRowHeightCache: number;
@@ -32456,7 +32484,7 @@ declare module "sheet/Sheet" {
         /** @internal */
         protected _createRangeError(address: ICellRanges.Address): Error;
         /** @internal */
-        protected _protectionCheck(check?: ProtectionCheck, coords?: Readonly<IRange.Coords> | readonly IRange.Coords[]): void;
+        protected _protectionCheck(check?: ProtectionCheck, coords?: Readonly<IRange.Coords> | readonly IRange.Coords[], action?: string): void;
         /**
          * Returns an array of ranges.
          *
@@ -33879,6 +33907,8 @@ declare module "workbook/Workbook" {
         protected _transactionsRemoveListener: IListener.Remove;
         protected _lastTransactionUUID: string;
         protected _starting: Promise<void>;
+        protected _closed: boolean;
+        protected _initializing: boolean;
         protected _emitter: ListenerEmitter<IWorkbook, IWorkbook.IListeners>;
         protected _scripts: IScript;
         protected _theme: ITheme;
@@ -33902,7 +33932,6 @@ declare module "workbook/Workbook" {
         protected _listenerProtection: IListener.Remove;
         protected _listenerWorkbookView: IListener.Remove;
         protected _isDate1904: boolean;
-        protected _closed: boolean;
         constructor(options?: IWorkbook.ConstructorOptions);
         protected _initState(): void;
         /** {@inheritDoc IWorkbook.getView} */