@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/protection/IProtection.d.ts

@@ -0,0 +1,170 @@
+import { IListener } from '../listener';
+/**
+ * Interface representing the base protection functionality for both workbook and sheet protection.
+ * This interface provides methods for locking, unlocking, and managing the protection state.
+ */
+export interface IProtection<T, P extends IProtection.Properties, J extends IProtection.JSON> {
+    /**
+     * Locks the object (workbook or sheet or range) with the specified options and password.
+     *
+     * @param password The password required to unlock the object.
+     * @param properties The properties to allow to remain unlocked.
+     * @param algorithm The algorithm for encrypting the password.
+     * @param spinCount The spin count for encrypting the password.
+     * @returns The `IProtection` instance for method chaining.
+     *
+     * @remarks
+     * By default all properties are locked but you can specify which properties to remain unlocked.
+     */
+    lock(properties?: Partial<P>, password?: string, algorithm?: string, spinCount?: number): Promise<IProtection<T, P, J>>;
+    /**
+     * Unlocks the object (workbook or sheet) using the provided password.
+     *
+     * @param password The password required to unlock the object.
+     * @returns The `IProtection` instance for method chaining.
+     *
+     * @remarks
+     * If the correct password is provided, protection is removed from the object.
+     */
+    unlock(password?: string): Promise<IProtection<T, P, J>>;
+    /**
+     * Temporarily disables protection with the provided password.
+     *
+     * @param password The password required to pause protection.
+     * @returns The `IProtection` instance for method chaining.
+     *
+     * @remarks
+     * This method allows temporarily pausing protection without permanently unlocking the object.
+     * Use {@link resume} to restore protection.
+     */
+    pause(password?: string): Promise<IProtection<T, P, J>>;
+    /**
+     * Checks if the object is currently locked.
+     *
+     * @returns `true` if the object is locked, `false` otherwise.
+     *
+     * @remarks
+     * This method returns `true` If the lock is active.
+     */
+    isLocked(): boolean;
+    /**
+     * Verifies if the provided password matches the current protection password.
+     *
+     * @param password The password to check against the current protection.
+     * @returns `true` if the password is correct, `false` otherwise.
+     *
+     * @remarks
+     * Use this method to validate the password before unlocking or modifying the protection settings.
+     */
+    checkPassword(password?: string): Promise<boolean>;
+    /**
+     * Returns true if the protection has a password.
+     */
+    hasPassword(): boolean;
+    /**
+     * Resumes protection that was previously paused.
+     *
+     * @returns The `IProtection` instance for method chaining.
+     *
+     * @remarks
+     * This method restores protection after it was paused using the {@link pause} method.
+     */
+    resume(): IProtection<T, P, J>;
+    /**
+     * Checks if the object has a locked but is paused.
+     *
+     * @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.
+     *
+     * @see
+     * {@link IListener.ISource.addListeners}
+     */
+    addListeners(listeners: IProtection.IListeners, options?: IListener.Options): IListener.Remove;
+    toJSON(): IProtection.JSON | null;
+}
+/**
+ * {@inheritDoc IProtection}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IProtection}
+ */
+export declare namespace IProtection {
+    interface Events<T, P extends IProtection.Properties, J extends IProtection.JSON> {
+        /**
+         * Called when the protection has changed collections has changed have changed.
+         */
+        onChange?(source: IProtection<T, P, J>): void;
+        /**
+         * Called when the protection has changed collections has changed have changed.
+         */
+        onLockChange?(source: IProtection<T, P, J>): void;
+    }
+    interface IListeners extends IListener.Callbacks<IProtection<any, any, any>, IProtection.Events<any, any, any>> {
+    }
+    interface Properties {
+    }
+    interface JSON extends Properties {
+        /**
+         * If this is specified then a password will be requested to unlock.
+         * If this is an empty object this indicates the object has been locked but without a password
+         */
+        password?: Partial<IProtection.EncryptedPassword>;
+        identities?: IProtection.IdentityProvider[];
+    }
+    /**
+     * Represents a locally stored encrypted password.
+     *
+     * @see
+     * * {@link https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.presentation.modificationverifier?view=openxml-2.8.1}
+     */
+    interface EncryptedPassword {
+        /**
+         * The hashed value that was generated during the protection process.
+         * This value is typically derived from the combination of a password and a salt.
+         */
+        hash: string;
+        /**
+         * The salt value that was used during the protection process.
+         * The salt is combined with the password to produce the hash, adding an additional layer of security.
+         */
+        salt: string;
+        /**
+         * The name of the hash algorithm to be used.
+         * Common values include `SHA-256`, `SHA-384`, and `SHA-512`.
+         *
+         * @defaultValue `SHA-512`
+         */
+        algorithm?: string;
+        /**
+         * The number of iterations (also known as spin count) used during the hash computation process.
+         * A higher number increases the security by making brute-force attacks more difficult but also increases computation time.
+         *
+         * @defaultValue `100000`.
+         */
+        spinCount?: number;
+    }
+    /**
+     * **PLACEHOLDER** - Will integrate into the user identity system.
+     */
+    interface IdentityProvider {
+        /**
+         * Optional setting to specify the relative security descriptor.
+         *
+         * The descriptor defines user accounts who may edit this range without providing a password to access the range. Removing this attribute shall
+         * remove all permissions granted or denied to users for this range.
+         */
+        descriptor: string;
+    }
+}
+//# sourceMappingURL=IProtection.d.ts.map

package/types/src/protection/IProtection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IProtection.d.ts","sourceRoot":"","sources":["../../../../src/protection/IProtection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;GAGG;AAGH,MAAM,WAAW,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,CAAC,UAAU,EAAE,CAAC,SAAS,WAAW,CAAC,IAAI;IAC1F;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACxH;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACzD;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACxD;;;;;;;OAOG;IACH,QAAQ,IAAI,OAAO,CAAC;IACpB;;;;;;;;OAQG;IACH,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACnD;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC;IACvB;;;;;;;OAOG;IACH,MAAM,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/B;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC;IACpB;;;;;OAKG;IACH,UAAU,IAAI,OAAO,CAAC;IACtB;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;IAE/F,MAAM,IAAI,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;CACnC;AAED;;;;;;GAMG;AACH,yBAAiB,WAAW,CAAC;IAC3B,UAAiB,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,CAAC,UAAU,EAAE,CAAC,SAAS,WAAW,CAAC,IAAI;QACrF;;WAEG;QACH,QAAQ,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;QAC9C;;WAEG;QACH,YAAY,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;KACnD;IAED,UAAiB,UAAW,SAAQ,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;KAAG;IAEzH,UAAiB,UAAU;KAAK;IAEhC,UAAiB,IAAK,SAAQ,UAAU;QACtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QAElD,UAAU,CAAC,EAAE,WAAW,CAAC,gBAAgB,EAAE,CAAC;KAC7C;IAED;;;;;OAKG;IAGH,UAAiB,iBAAiB;QAChC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IAEH,UAAiB,gBAAgB;QAC/B;;;;;WAKG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF"}

package/types/src/protection/PasswordHasher.d.ts

@@ -0,0 +1,35 @@
+export interface SaltAndHash {
+    salt: string;
+    hash: string;
+}
+export declare class PasswordHasher {
+    static DefaultAlgo: string;
+    static DefaultSpinCount: number;
+    /**
+     * Create a salt and hash from a password.
+     *
+     * @param password The password.
+     * @param algorithm The hash algorithm. Default value `SHA-512`.
+     * @param spinCount The spin count. Default value `100000`.
+     *
+     * @returns The encryption key as a base64 string.
+     */
+    static generateSaltAndHash(password: string, algorithm?: string, spinCount?: number): Promise<SaltAndHash | null>;
+    /**
+     * Verify a password again a hash a salt and hash from a password.
+     *
+     * @param password The encrypted password.
+     * @param salt The salt returned when generating the hash
+     * @param hash The hash used to encrypt the password.
+     * @param algorithm The hash algorithm. Default value `SHA-512`.
+     * @param spinCount The spin count. Default value `100000`.
+     *
+     * @returns The encryption key as a base64 string.
+     */
+    static verifyPassword(password: string, saltAndHash: SaltAndHash, algorithm?: string, spinCount?: number): Promise<boolean>;
+    /**
+     * For unit testing against existing salt and hash keys.
+     */
+    protected static _convertPasswordToHash(password: string, salt: string, algorithm: string, spinCount: number): Promise<string>;
+}
+//# sourceMappingURL=PasswordHasher.d.ts.map

package/types/src/protection/PasswordHasher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PasswordHasher.d.ts","sourceRoot":"","sources":["../../../../src/protection/PasswordHasher.ts"],"names":[],"mappings":"AA0GA,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACf;AAED,qBAAa,cAAc;IAEzB,MAAM,CAAC,WAAW,EAAE,MAAM,CAAY;IACtC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAQ;IAEvC;;;;;;;;OAQG;WACU,mBAAmB,CAC9B,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,MAAiC,EAC5C,SAAS,GAAE,MAAsC,GAChD,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAc9B;;;;;;;;;;OAUG;WACU,cAAc,CACzB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,MAAiC,EAC5C,SAAS,GAAE,MAAsC,GAChD,OAAO,CAAC,OAAO,CAAC;IAgBnB;;OAEG;qBACoB,sBAAsB,CAC3C,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC;CAoBnB"}

package/types/src/protection/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Used for OOXML import
+ * @hidden
+ */
+export * from './IProtection';
+//# sourceMappingURL=index.d.ts.map

package/types/src/protection/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/protection/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,eAAe,CAAC"}

package/types/src/resource/IResource.d.ts

@@ -0,0 +1,98 @@
+import { JSONSerializableAsync } from '@sheetxl/utils';
+/**
+ * A resource is an item referenced elsewhere with the application.
+ * This will track when a resource is no longer being used and can be removed.
+ */
+export interface IResource extends JSONSerializableAsync<IResource.JSON> {
+    /**
+     * The mimetype of the resource.
+     */
+    getType(): Promise<IResource.Type>;
+    /**
+     * An optional name for the resource.
+     */
+    getName(): string | null;
+    /**
+     * For saving to json resources.
+     */
+    toJSONAsync(): Promise<IResource.JSON>;
+    /**
+     * Returns the resource as a Promise to array buffer.
+     */
+    toBuffer(): Promise<ArrayBuffer>;
+    /**
+     * Returns the resource as a uri if this is external.
+     */
+    getExternalURI(): Promise<string | null>;
+    /**
+     * Add a reference to the resource.
+     *
+     * @param ref The object to strongly hold the resource.
+     *
+     * @deprecated References are now strongly held by the resource collection.
+     */
+    addReference(ref: any): void;
+    /**
+     * Delete a reference to the resource.
+     *
+     * @param ref The object that held the resource.
+     *
+     * @deprecated References are now strongly held by the resource collection.
+     */
+    deleteReference(ref: any): void;
+    /**
+     * This does not follow the standard listener pattern and is only called once.
+     *
+     * @param listener The listener to call when the resource is unloaded.
+     */
+    addUnloadListener(listener: IResource.IUnloadListener): void;
+    /**
+     * `true` if the resource if all references have been deleted.
+     */
+    isClosed(): boolean;
+    /**
+     * For runtime type checking.
+     */
+    readonly isIResource: true;
+}
+/**
+ * {@inheritDoc IResource}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IResource}
+ */
+export declare namespace IResource {
+    interface IUnloadListener {
+        onUnload: (ref: IResource) => void;
+    }
+    /**
+     * A type for the resource.
+     */
+    interface Type {
+        /**
+         * The mime type of the resource.
+         */
+        mime: string;
+        /**
+         * The file extension of the resource.
+         */
+        ext?: string;
+    }
+    interface JSON {
+        /**
+         * If the resource is embedded, this will be a base64 encoded string of the data.
+         */
+        base64?: string;
+        /**
+         * If the resource is external, this will be the uri.
+         */
+        uri?: string;
+        /**
+         * The name of the resource.
+         * This is optional but if provided then resource lookup will use this as a cache key.
+         */
+        name?: string;
+    }
+}
+//# sourceMappingURL=IResource.d.ts.map

package/types/src/resource/IResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IResource.d.ts","sourceRoot":"","sources":["../../../../src/resource/IResource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,qBAAqB,CAAC,SAAS,CAAC,IAAI,CAAC;IACtE;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACnC;;OAEG;IACH,OAAO,IAAI,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACvC;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACjC;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACzC;;;;;;OAMG;IACH,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAC7B;;;;;;OAMG;IACH,eAAe,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAChC;;;;OAIG;IACH,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,eAAe,GAAG,IAAI,CAAC;IAC7D;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,yBAAiB,SAAS,CAAC;IAEzB,UAAiB,eAAe;QAC9B,QAAQ,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,IAAI,CAAC;KACpC;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAA;KACb;IAED,UAAiB,IAAI;QACnB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF"}

package/types/src/resource/IResourceCollection.d.ts

@@ -0,0 +1,96 @@
+import { JSONSerializableAsync, FetchArgs, MaybePromise, OneOf } from '@sheetxl/utils';
+import { ICollection } from '../type';
+import { IResource } from './IResource';
+/**
+ * Collections of {@link IResource}.
+ */
+export interface IResourceCollection extends ICollection<IResource> {
+    /**
+     * Add a resource to a collection with an initial reference.
+     *
+     * @param resource
+     * @remarks
+     * Resources are not removed from the the collection. They are autoGCed when there are no references.
+     */
+    add(resource: string | IResource | IResourceCollection.AddOptions): IResource;
+    /**
+     * Returns a list of all resources in the collection.
+     *
+     * @param options
+     */
+    getItems(options?: ICollection.GetItemsOptions): IResource[];
+    /**
+     * Used for saving resource. Returns a visitor that will allow for a toJSON that
+     * will only save the resource that were accessed within the persist scope.
+     */
+    beginPersist(): IResourceCollection.IPersistScope<IResource.JSON>;
+}
+/**
+ * {@inheritDoc IResourceCollection}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IResourceCollection}
+ */
+export declare namespace IResourceCollection {
+    /**
+     * When adding a shared source there are a number of ways to create it
+     * Either from a base64 string, a buffer, a fetch, or a custom resolve function.
+     */
+    interface AddOptions {
+        /**
+         * An encoding for the resource. One and only of these should be provided
+         */
+        source: MaybePromise<IResourceCollection.Source> | (() => MaybePromise<IResourceCollection.Source>);
+        /**
+         * The name of the resource.
+         * This is optional and purely for human consumption and is not used by the system.
+         */
+        name?: string;
+    }
+    /**
+     * A type that represents the various ways to provide a resource source.
+     * One and only one of the options should be provided.
+     */
+    type SourceType = {
+        base64: string;
+        buffer: ArrayBuffer;
+        file: File;
+        fetch: string | FetchArgs;
+        /**
+         * If provided, this function will be called to resolve the resource.
+         * This behaves exactly like fetch but does not internalize the results
+         */
+        external: string | FetchArgs;
+    };
+    /**
+     * A type that represents a resource source that can be one of several types.
+     */
+    type Source = OneOf<SourceType>;
+    interface IPersistScope<J extends IResource.JSON> {
+        /**
+         * For a resource this will return a number that can be used to reference the resource in the persisted json.
+         * @param resource
+         */
+        toResourceId(resource: JSONSerializableAsync<J>): number | null;
+        /**
+         * For a given resourceId this will return the resource.
+         * @param resourceId
+         */
+        fromResourceId(resourceId: number): JSONSerializableAsync<J> | null;
+        /**
+         * Called when done persisting.
+         */
+        endPersist(): void;
+        /**
+         * Loads the json.
+         * @param json
+         */
+        fromJSON(json: J[]): void;
+        /**
+         * This can be called multiple times.
+         */
+        toJSONAsync(): Promise<J[]>;
+    }
+}
+//# sourceMappingURL=IResourceCollection.d.ts.map

package/types/src/resource/IResourceCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IResourceCollection.d.ts","sourceRoot":"","sources":["../../../../src/resource/IResourceCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,qBAAqB,EAAE,KAAK,SAAS,EAAE,KAAK,YAAY,EAAE,KAAK,KAAK,EAC1E,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW,CAAC,SAAS,CAAC;IACjE;;;;;;OAMG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,CAAC,UAAU,GAAG,SAAS,CAAC;IAE9E;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,eAAe,GAAG,SAAS,EAAE,CAAC;IAE7D;;;OAGG;IACH,YAAY,IAAI,mBAAmB,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;CACnE;AAED;;;;;;GAMG;AACH,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,MAAM,EAAE,YAAY,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,YAAY,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;QACpG;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IAEH,KAAY,UAAU,GAAG;QACvB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,WAAW,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC;QACX,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;KAC9B,CAAC;IAEF;;OAEG;IACH,KAAY,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAEvC,UAAiB,aAAa,CAAC,CAAC,SAAS,SAAS,CAAC,IAAI;QACrD;;;WAGG;QACH,YAAY,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;QAChE;;;WAGG;QACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;QACpE;;WAEG;QACH,UAAU,IAAI,IAAI,CAAC;QACnB;;;WAGG;QACH,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC;QAC1B;;WAEG;QACH,WAAW,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;KAC7B;CACF"}

package/types/src/resource/Resource.d.ts

@@ -0,0 +1,39 @@
+import { IResource } from './IResource';
+import { IResourceCollection } from './IResourceCollection';
+export declare class Resource implements IResource {
+    private _name;
+    private _refs;
+    private _listeners;
+    private _isClosed;
+    private _arrayBuffer;
+    private _type;
+    private _source;
+    private _sourceResolved;
+    private _externalURI;
+    constructor(options: IResourceCollection.AddOptions);
+    /** @internal */
+    protected _resolveSource(): Promise<IResourceCollection.Source>;
+    /** @internal */
+    protected _resolveArrayBuffer(): Promise<ArrayBuffer>;
+    /** {@inheritDoc IResource.getName} */
+    getName(): string | null;
+    /** {@inheritDoc IResource.toJSONAsync} */
+    toJSONAsync(): Promise<IResource.JSON>;
+    /** {@inheritDoc IResource.toBuffer} */
+    toBuffer(): Promise<ArrayBuffer>;
+    /** {@inheritDoc IResource.getType} */
+    getType(): Promise<IResource.Type>;
+    /** {@inheritDoc IResource.getExternalURI} */
+    getExternalURI(): Promise<string | null>;
+    /** {@inheritDoc IResource.addReference} */
+    addReference(ref: any): void;
+    /** {@inheritDoc IResource.deleteReference} */
+    deleteReference(ref: any): void;
+    /** {@inheritDoc IResource.addUnloadListener} */
+    addUnloadListener(listener: IResource.IUnloadListener): void;
+    /** {@inheritDoc IResource.isIResource} */
+    get isIResource(): true;
+    /** {@inheritDoc IResource.isClosed} */
+    isClosed(): boolean;
+}
+//# sourceMappingURL=Resource.d.ts.map

package/types/src/resource/Resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Resource.d.ts","sourceRoot":"","sources":["../../../../src/resource/Resource.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAIjE,qBAAa,QAAS,YAAW,SAAS;IACxC,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,KAAK,CAAW;IAExB,OAAO,CAAC,UAAU,CAAwC;IAC1D,OAAO,CAAC,SAAS,CAAU;IAE3B,OAAO,CAAC,YAAY,CAAqC;IACzD,OAAO,CAAC,KAAK,CAA+B;IAE5C,OAAO,CAAC,OAAO,CAA8F;IAC7G,OAAO,CAAC,eAAe,CAA2C;IAClE,OAAO,CAAC,YAAY,CAAuC;gBAGzD,OAAO,EAAE,mBAAmB,CAAC,UAAU;IAWzC,gBAAgB;cACA,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAAC;IAkBrE,gBAAgB;cACA,mBAAmB,IAAI,OAAO,CAAC,WAAW,CAAC;IAoD3D,sCAAsC;IACtC,OAAO,IAAI,MAAM,GAAG,IAAI;IAIxB,0CAA0C;IACpC,WAAW,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;IAgB5C,uCAAuC;IACjC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC;IAUtC,sCAAsC;IAChC,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;IAQxC,6CAA6C;IACvC,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IA2B9C,2CAA2C;IAC3C,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAK5B,8CAA8C;IAC9C,eAAe,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAiB/B,gDAAgD;IAChD,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,eAAe,GAAG,IAAI;IAO5D,0CAA0C;IAC1C,IAAI,WAAW,IAAI,IAAI,CAEtB;IAED,uCAAuC;IACvC,QAAQ,IAAI,OAAO;CAGpB"}

package/types/src/resource/ResourceCollection.d.ts

@@ -0,0 +1,19 @@
+import { ICollection } from '../type';
+import { IResource } from './IResource';
+import { IResourceCollection } from './IResourceCollection';
+export declare class ResourceCollection implements IResourceCollection {
+    private _resources;
+    private _persistOpen;
+    constructor();
+    /** {@inheritDoc IResourceCollection.add} */
+    add(res: string | IResource | IResourceCollection.AddOptions): IResource;
+    /** {@inheritDoc ICollection.[Symbol.iterator]} */
+    [Symbol.iterator](): IterableIterator<IResource>;
+    /** {@inheritDoc IResourceCollection.getItems} */
+    getItems(options?: ICollection.GetItemsOptions): IResource[];
+    /** {@inheritDoc IResourceCollection.getCount} */
+    getCount(): number;
+    /** {@inheritDoc IResourceCollection.beginPersist} */
+    beginPersist(): IResourceCollection.IPersistScope<IResource.JSON>;
+}
+//# sourceMappingURL=ResourceCollection.d.ts.map

package/types/src/resource/ResourceCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceCollection.d.ts","sourceRoot":"","sources":["../../../../src/resource/ResourceCollection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAwFjE,qBAAa,kBAAmB,YAAW,mBAAmB;IAC5D,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,YAAY,CAAkD;;IAMtE,4CAA4C;IAC5C,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,CAAC,UAAU,GAAG,SAAS;IAuCxE,kDAAkD;IACjD,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,SAAS,CAAC;IAIjD,iDAAiD;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,eAAe,GAAG,SAAS,EAAE;IAI5D,iDAAiD;IACjD,QAAQ,IAAI,MAAM;IAIlB,qDAAqD;IACrD,YAAY,IAAI,mBAAmB,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC;CAuClE"}

package/types/src/resource/_ResourceMessages.d.ts

@@ -0,0 +1,4 @@
+export declare const ERROR_DUPLICATE_DATA_VALUES: string;
+export declare const ERROR_NO_DATA_VALUES: string;
+export declare const CLOSED_MODEL: string;
+//# sourceMappingURL=_ResourceMessages.d.ts.map

package/types/src/resource/_ResourceMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ResourceMessages.d.ts","sourceRoot":"","sources":["../../../../src/resource/_ResourceMessages.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,2BAA2B,EAAE,MAAgE,CAAC;AAE3G,eAAO,MAAM,oBAAoB,EAAE,MAA0D,CAAC;AAE9F,eAAO,MAAM,YAAY,EAAE,MAA8B,CAAC"}

package/types/src/resource/index.d.ts

@@ -0,0 +1,5 @@
+export * from './IResource';
+export * from './Resource';
+export * from './IResourceCollection';
+export * from './ResourceCollection';
+//# sourceMappingURL=index.d.ts.map

package/types/src/resource/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/resource/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAE3B,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC"}

package/types/src/resource/resourceKinds.d.ts

@@ -0,0 +1,23 @@
+import { ResourceKindDefinition } from '@sheetxl/utils';
+/**
+ * The resource kinds SheetXL defines: **locales** and **fonts**.
+ *
+ * Declared here rather than in `@sheetxl/utils` because utils owns the resource *machinery*, not any
+ * particular kind — it should no more know what a locale directory contains than what a font is. The
+ * SDK is the lowest layer that is a product rather than generic utility, and it is also what the CLI
+ * depends on, so declaring them here is what lets `sheetxl resources add` understand both.
+ *
+ * Exported as DATA rather than as a self-registering side-effect module, for two reasons:
+ *  - the only import is a type (erased), so nothing is pulled into any bundle that touches this file;
+ *  - build tooling loads it as source by relative path, where a package-specifier import of another
+ *    workspace package resolves as native ESM and cannot follow extensionless TS imports.
+ *
+ * A host applies it with `registerResourceKinds(SHEETXL_RESOURCE_KINDS)`. `@sheetxl/utils-react` adds
+ * `.cmd.json` to the `locales` kind separately, because command chrome is its format, not this one's.
+ */
+/** The locale namespace: message catalogs, and (from utils-react) command catalogs. */
+export declare const LOCALES_KIND = "locales";
+/** The font namespace. */
+export declare const FONTS_KIND = "fonts";
+export declare const SHEETXL_RESOURCE_KINDS: readonly ResourceKindDefinition[];
+//# sourceMappingURL=resourceKinds.d.ts.map

package/types/src/resource/resourceKinds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceKinds.d.ts","sourceRoot":"","sources":["../../../../src/resource/resourceKinds.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAE7D;;;;;;;;;;;;;;;GAeG;AAEH,uFAAuF;AACvF,eAAO,MAAM,YAAY,YAAY,CAAC;AAEtC,0BAA0B;AAC1B,eAAO,MAAM,UAAU,UAAU,CAAC;AAiClC,eAAO,MAAM,sBAAsB,EAAE,SAAS,sBAAsB,EAGnE,CAAC"}

package/types/src/richData/index.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=index.d.ts.map

package/types/src/richData/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/richData/index.ts"],"names":[],"mappings":""}

package/types/src/scripting/FunctionCollection.d.ts

@@ -0,0 +1,88 @@
+import { IFunction, IFormulaContext } from '@sheetxl/primitives';
+import { ITransaction } from '../transaction';
+import { IListener } from '../listener';
+import { ICollection } from '../type';
+import { ListenerEmitter } from '../listener/ListenerEmitter';
+import { IFunctionCollection } from './IFunctionCollection';
+import { FunctionMatch } from './_FunctionIndex';
+/**
+ * Implementation for `IFunctionCollection`.
+ */
+export declare class FunctionCollection implements IFunctionCollection {
+    protected _emitter: ListenerEmitter<this, IFunctionCollection.IListeners>;
+    private _options;
+    private _readonly;
+    private _transactions;
+    private _stateId;
+    private _transactionsRemoveListener;
+    private _closed;
+    /**
+     * The descriptor index behind the metadata searches. Built on first use and dropped whenever the
+     * collection's contents change — see {@link FunctionIndex}.
+     */
+    private _index;
+    constructor(options: ConstructorOptions);
+    /** {@inheritDoc ICollection.[Symbol.iterator]} */
+    [Symbol.iterator](): IterableIterator<IFunction>;
+    /** {@inheritDoc IFunctionCollection.getItems} */
+    getItems(options?: ICollection.GetItemsOptions): IFunction[];
+    /** {@inheritDoc IFunctionCollection.getByName} */
+    getByName(name: string, options?: IFunctionCollection.GetByNameOptions): IFunction | null;
+    /** {@inheritDoc IFunctionCollection.search} */
+    search(options?: IFunctionCollection.SearchOptions): Promise<IFunction[]>;
+    /**
+     * {@link search}, keeping each hit's relevance score.
+     *
+     * @remarks
+     * Not part of {@link IFunctionCollection}: it exists so a caller merging SEVERAL collections
+     * ({@link IScript.searchFunctions} — built-ins plus every module) can rank the union on one
+     * scale instead of concatenating separately-ranked lists.
+     */
+    searchScored(options?: IFunctionCollection.SearchOptions): Promise<FunctionMatch[]>;
+    /** {@inheritDoc IFunctionCollection.getCategories} */
+    getCategories(options?: IFunctionCollection.GetCategoryOptions): Promise<IFunctionCollection.Category[]>;
+    /** {@inheritDoc ICollection.getCount} */
+    getCount(): number;
+    /** {@inheritDoc IFunctionCollection.validateName} */
+    validateName(named: string): void;
+    _validateName(name: string, ignoreExisting?: boolean): void;
+    /** {@inheritDoc IFunctionCollection.add} */
+    add(option: string | IFunction | IFunctionCollection.AddOptions): Promise<IFunction>;
+    /**
+     * Compiles TypeScript source into runnable functions and registers each in this collection.
+     * Returns the first (primary) function.
+     */
+    private _addFromSource;
+    /**
+     * Registers a single pre-built function (or AddOptions) into this collection, rebinding it to this
+     * collection's context. Preserves the macro vs calculation function type.
+     */
+    private _addFunction;
+    /** {@inheritDoc ITransaction.ITransactional.beginCommit} */
+    beginCommit(options?: string | ITransaction.OperationOptions): ITransaction;
+    private _getState;
+    private _beginCommit;
+    private _updateState;
+    protected _initState(): void;
+    /** {@inheritDoc IListener.ISource.addListeners} */
+    addListeners(listeners: IFunctionCollection.IListeners, options?: IListener.Options): IListener.Remove;
+    isClosed(): boolean;
+    close(): void;
+    get isFunctionCollection(): true;
+}
+export interface ConstructorOptions {
+    /**
+     * A transaction store that can be used to undo/redo changes to the names.
+     */
+    transactions?: ITransaction.IStore | null;
+    context?: IFormulaContext;
+    readonlyFunctions?: ReadonlyMap<string, IFunction>;
+    /**
+     * Mints an evaluation context bound to a sheet, for `getByName(name, { sheet })`'s vended
+     * instances (functions callable as a public API outside the calculation graph). Wired by the
+     * calculation layer (`CalculationContext._createScoped`); layering keeps the type opaque here.
+     * Returns null for an unknown sheet.
+     */
+    createScopedContext?: (sheet: string) => IFormulaContext | null;
+}
+//# sourceMappingURL=FunctionCollection.d.ts.map

package/types/src/scripting/FunctionCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionCollection.d.ts","sourceRoot":"","sources":["../../../../src/scripting/FunctionCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAG3E,OAAO,EAAoB,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAI3C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAK9D,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EACgD,KAAK,aAAa,EACxE,MAAM,kBAAkB,CAAC;AAe1B;;GAEG;AAEH,qBAAa,kBAAmB,YAAW,mBAAmB;IAE5D,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAC,IAAI,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAE1E,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,SAAS,CAA2D;IAE5E,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,2BAA2B,CAAmB;IAEtD,OAAO,CAAC,OAAO,CAAkB;IAEjC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAgB;gBAElB,OAAO,EAAE,kBAAkB;IAgCvC,kDAAkD;IACjD,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,SAAS,CAAC;IAIjD,iDAAiD;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,eAAe,GAAG,SAAS,EAAE;IAY5D,kDAAkD;IAClD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,GAAG,SAAS,GAAG,IAAI;IAyCzF,+CAA+C;IACzC,MAAM,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC,aAAa,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAW/E;;;;;;;OAOG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IA0DzF,sDAAsD;IAChD,aAAa,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,EAAE,CAAC;IA0B9G,yCAAyC;IACzC,QAAQ,IAAI,MAAM;IA0BlB,qDAAqD;IACrD,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIjC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,cAAc,GAAE,OAAa,GAAG,IAAI;IAkChE,4CAA4C;IACtC,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAY1F;;;OAGG;YACW,cAAc;IAoD5B;;;OAGG;IACH,OAAO,CAAC,YAAY;IA2DpB,4DAA4D;IAC5D,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC,gBAAgB,GAAG,YAAY;IAI3E,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,YAAY;IAkBpB,SAAS,CAAC,UAAU,IAAI,IAAI;IAS5B,mDAAmD;IACnD,YAAY,CAAC,SAAS,EAAE,mBAAmB,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM;IAItG,QAAQ,IAAI,OAAO;IAInB,KAAK;IASL,IAAI,oBAAoB,IAAI,IAAI,CAE/B;CACF;AAGD,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC;IAG1C,OAAO,CAAC,EAAE,eAAe,CAAC;IAG1B,iBAAiB,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAElD;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,GAAG,IAAI,CAAC;CACjE"}