@chilkat/react-native 11.6.1

package/src/specs/TrustedRoots.nitro.ts

@@ -0,0 +1,360 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { Cert } from './Cert.nitro'
+import type { JavaKeyStore } from './JavaKeyStore.nitro'
+
+/**
+ * Configure the trusted root certificates used by Chilkat certificate validation.
+ *
+ * `TrustedRoots` manages a collection of trusted CA and
+ * self-signed root certificates used Chilkat-wide for PKCS7/CMS signature
+ * validation and SSL/TLS server certificate validation. It can add individual
+ * certificates, import trusted certificates from a Java keystore, load PEM CA
+ * bundles, activate or deactivate the trusted-root set, and control whether
+ * system CA roots and self-signed server certificates are trusted.
+ *
+ * **Custom trusted roots**
+ *
+ * Add root or CA certificates that should be trusted by Chilkat validation
+ * operations.
+ *
+ * **PEM CA bundles**
+ *
+ * Load one or more trusted CA certificates from PEM bundle files used by
+ * many TLS and certificate-validation workflows.
+ *
+ * **Java keystore import**
+ *
+ * Import trusted certificates from a `JavaKeyStore` when trust
+ * anchors are maintained in JKS-style storage.
+ *
+ * **System CA root control**
+ *
+ * Choose whether Chilkat should also trust the operating system's CA root
+ * certificates.
+ *
+ * **Self-signed certificate policy**
+ *
+ * Control whether self-signed server certificates are rejected or accepted
+ * during certificate validation.
+ *
+ * **Activate Chilkat-wide trust**
+ *
+ * Activate the configured trusted-root set so it is used by Chilkat classes
+ * that perform TLS or signature certificate validation.
+ *
+ * **Common pattern:**
+ * Create a `TrustedRoots` object, add trusted certificates or load a
+ * PEM CA bundle, configure whether system roots and self-signed certificates
+ * should be trusted, then call `Activate`. Treat trusted roots as
+ * Chilkat-wide validation configuration, not as private state for a single
+ * object.
+ *
+ * For an extended overview, see
+ * [TrustedRoots Class Overview](https://www.chilkatsoft.com/trustedroots_class_overview.asp).
+ *
+ * Each `TrustedRoots` instance owns a native Chilkat object. It is released when the JavaScript
+ * object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new TrustedRoots()`.
+ *
+ * Methods that can take a while (network, files, compression, key generation) also have an
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
+ * rendering. While such a call is pending, every other call on this object throws, except
+ * {@link TrustedRoots.abort} and assigning {@link TrustedRoots.onPercentDone} / {@link
+ * TrustedRoots.onProgressInfo}.
+ */
+export interface TrustedRoots extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * The number of certificates explicitly contained in this object. The count includes certificates
+   * added by `AddCert`, `AddJavaKeyStore`, and `LoadCaCertsPem`.
+   *
+   * Use indexes from `0` through `NumCerts - 1` with `CertAt`.
+   *
+   * **Scope of the count:** This property does not include operating-system CA roots made available
+   * by `TrustSystemCaRoots`. It reports only the certificates stored in this object.
+   *
+   * This property is read-only.
+   */
+  readonly numCerts: number
+
+  /**
+   * Controls whether operating-system CA roots are included when this object's trust configuration
+   * is activated. The default value is `_TRUE_`.
+   *
+   * ValueBehavior
+   *
+   * | `_TRUE_` | | Trust explicitly added certificates and the system-provided CA roots available
+   * to Chilkat. |
+   *
+   * | `_FALSE_` | | Do not automatically trust system-provided CA roots; use the explicitly
+   * configured collection and the selected self-signed-certificate policy. |
+   *
+   * On Windows, system roots come from registry-based certificate stores. On Linux, Chilkat may use
+   * a system CA bundle such as `/etc/ssl/certs/ca-certificates.crt` when available.
+   *
+   * System roots are not added to this object's explicit collection and therefore are not included
+   * in `NumCerts` or returned by `CertAt`.
+   */
+  trustSystemCaRoots: boolean
+
+  /**
+   * Controls the special case in which an SSL/TLS server presents a certificate chain containing
+   * exactly one certificate and that certificate is self-signed. The default value is `_FALSE_`.
+   *
+   * ValueBehavior
+   *
+   * | `_FALSE_` | | Do not reject a one-certificate TLS chain solely because the certificate is
+   * self-signed. |
+   *
+   * | `_TRUE_` |  | Reject TLS server chains consisting of one self-signed certificate. |
+   *
+   * This property applies to the TLS server-certificate case described above. It does not reject a
+   * self-signed CA certificate merely because that certificate appears as the trust anchor above a
+   * longer chain.
+   *
+   * **Security guidance:** A self-signed certificate has no external issuer establishing trust.
+   * Accept it only when the certificate or its public-key fingerprint has been authenticated
+   * through a separate trusted channel.
+   */
+  rejectSelfSignedCerts: boolean
+
+  // ---- Methods ----
+
+  /**
+   * Activates this object's trust configuration for Chilkat-wide certificate validation. The active
+   * configuration includes:
+   *
+   * - Certificates explicitly added to this object by `AddCert`, `AddJavaKeyStore`, or
+   *   `LoadCaCertsPem`.
+   *
+   * - Operating-system CA roots when `TrustSystemCaRoots` is `_TRUE_`.
+   *
+   * - The self-signed TLS certificate policy selected by `RejectSelfSignedCerts`.
+   *
+   * After activation, Chilkat classes that validate PKCS7/CMS signatures or SSL/TLS server
+   * certificate chains use this trust configuration. Returns `_TRUE_` if the configuration was
+   * activated successfully; otherwise returns `_FALSE_`.
+   *
+   * **Trust-anchor note:** Activating a certificate as trusted supplies a starting point for
+   * certificate-path validation. It does not, by itself, prove that every certificate issued
+   * beneath that anchor is valid for every purpose; the applicable validation operation may also
+   * evaluate signatures, validity periods, identity, key usage, constraints, and other policy
+   * requirements.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link TrustedRoots.lastErrorText}.
+   */
+  activate(): void
+
+  /**
+   * Adds the certificate in `cert` to this object's explicit trusted-certificate collection. The
+   * certificate is subsequently treated as a trust anchor when this configuration is activated.
+   *
+   * Returns `_TRUE_` if the certificate was added successfully; otherwise returns `_FALSE_`.
+   *
+   * **Security-sensitive operation:** Calling this method is an explicit trust decision. It does
+   * not first determine whether the certificate is self-signed, belongs to a public CA, is
+   * currently valid, or is appropriate for the intended application. Add only certificates obtained
+   * and verified through a trustworthy process.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link TrustedRoots.lastErrorText}.
+   */
+  addCert(cert: Cert): void
+
+  /**
+   * Adds the certificates designated as trusted entries in the `keystore` `JavaKeyStore` to this
+   * object's explicit trusted-certificate collection.
+   *
+   * Private keys and secret keys are not imported. Returns `_TRUE_` if the trusted certificates
+   * were added successfully; otherwise returns `_FALSE_`.
+   *
+   * **Java keystore terminology:** A trusted-certificate entry represents a certificate that the
+   * keystore owner has chosen to trust. Importing it preserves that trust decision; it does not
+   * independently validate the certificate or build a certification path for it.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link TrustedRoots.addJavaKeyStoreAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link TrustedRoots.lastErrorText}.
+   */
+  addJavaKeyStore(keystore: JavaKeyStore): void
+
+  /**
+   * Asynchronous form of {@link TrustedRoots.addJavaKeyStore}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link TrustedRoots.abort} (which cancels it) and the {@link TrustedRoots.onPercentDone}
+   * /
+   * {@link TrustedRoots.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link TrustedRoots.lastErrorText}.
+   */
+  addJavaKeyStoreAsync(keystore: JavaKeyStore): Promise<void>
+
+  /**
+   * Deactivates the previously activated Chilkat-wide trusted-root configuration. After
+   * deactivation, roots and single-certificate self-signed certificates are implicitly trusted.
+   *
+   * Returns `_TRUE_` if the active configuration was deactivated successfully; otherwise returns
+   * `_FALSE_`.
+   *
+   * **Security warning:** This is a permissive mode. It does not merely restore a conventional
+   * “trust the operating-system CA store” policy. Use `Deactivate` only when implicitly trusting
+   * arbitrary roots and self-signed certificates is intentional and acceptable for the application.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link TrustedRoots.lastErrorText}.
+   */
+  deactivate(): void
+
+  /**
+   * Loads one or more PEM-encoded certificates from the file at `path` and adds them to this
+   * object's explicit trusted-certificate collection. A CA bundle normally contains consecutive
+   * `-----BEGIN CERTIFICATE-----` / `-----END CERTIFICATE-----` blocks.
+   *
+   * This method can load a curated application bundle, a Mozilla-derived CA bundle, or a platform
+   * bundle such as `/etc/ssl/certs/ca-certificates.crt` when that file exists. Returns `_TRUE_` if
+   * the bundle was loaded successfully; otherwise returns `_FALSE_`.
+   *
+   * **Trust implication:** Certificates loaded by this method are treated as trusted anchors after
+   * activation. The file is not merely a source of intermediate certificates. Review and protect
+   * the bundle as security-sensitive configuration.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link TrustedRoots.loadCaCertsPemAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link TrustedRoots.lastErrorText}.
+   */
+  loadCaCertsPem(path: string): void
+
+  /**
+   * Asynchronous form of {@link TrustedRoots.loadCaCertsPem}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link TrustedRoots.abort} (which cancels it) and the {@link TrustedRoots.onPercentDone}
+   * /
+   * {@link TrustedRoots.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link TrustedRoots.lastErrorText}.
+   */
+  loadCaCertsPemAsync(path: string): Promise<void>
+
+  /**
+   * Copies the certificate at zero-based `index` into the caller-supplied `Cert` object in `cert`.
+   *
+   * Valid indexes are from `0` through `NumCerts - 1`. Returns `_TRUE_` if the certificate was
+   * retrieved successfully; otherwise returns `_FALSE_`, such as when the index is outside the
+   * valid range.
+   *
+   * This method enumerates only certificates explicitly contained in this `TrustedRoots` object.
+   * Operating-system roots enabled through `TrustSystemCaRoots` are not included.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link TrustedRoots.lastErrorText}.
+   */
+  certAt(index: number, cert: Cert): void
+
+  // ---- Events (ReactNativeGen_DESIGN.md §6) ----
+
+  /**
+   * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
+   * can measure progress. Runs on the JavaScript thread, so it is only useful with the
+   * `...Async` methods (during a synchronous call the thread is busy and the events arrive
+   * after it returns). Assign `undefined` to remove.
+   */
+  onPercentDone?: (pctDone: number) => void
+
+  /**
+   * Called with a name/value pair of progress information while a long-running method runs
+   * (what is reported depends on the class and method). Runs on the JavaScript thread; see
+   * {@link TrustedRoots.onPercentDone}. Assign `undefined` to remove.
+   */
+  onProgressInfo?: (name: string, value: string) => void
+
+  /**
+   * Requests that the pending `...Async` call on this object stop at its next progress check.
+   * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
+   * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
+   * for a responsive cancel. Harmless when nothing is pending.
+   */
+  abort(): void
+}

package/src/specs/UnixCompress.nitro.ts

@@ -0,0 +1,293 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+
+/**
+ * Compress, uncompress, and unpack legacy UNIX `.Z` files.
+ *
+ * `UnixCompress` provides UNIX `compress` and
+ * `uncompress` functionality for legacy `.Z` files. It
+ * supports file-based, memory-based, and string-based workflows, uses LZW
+ * compression, can unpack `.tar.Z` archives, and includes abort and
+ * progress-related support for longer-running operations.
+ *
+ * **Compress to .Z**
+ *
+ * Compress files, memory data, or strings into UNIX `.Z`
+ * format using LZW compression.
+ *
+ * **Uncompress .Z data**
+ *
+ * Expand UNIX-compressed data back to files, memory, byte arrays, or text
+ * depending on the application workflow.
+ *
+ * **File workflows**
+ *
+ * Compress and uncompress directly between input and output files when
+ * working with existing filesystem data.
+ *
+ * **Memory workflows**
+ *
+ * Work with compressed or uncompressed byte data in memory when temporary
+ * files are not desired.
+ *
+ * **String workflows**
+ *
+ * Compress and uncompress text using an explicit character set so string
+ * data round-trips correctly.
+ *
+ * **Unpack tar.Z archives**
+ *
+ * Use `UnTarZ` to decompress and extract legacy
+ * `.tar.Z` archives in a single workflow.
+ *
+ * **Common pattern:**
+ * Use `UnixCompress` when the data is in classic UNIX
+ * `.Z` format or when a `.tar.Z` archive must be
+ * unpacked. Use `Chilkat.Gzip` for `.gz` and
+ * `.tar.gz` files, `Chilkat.Bz2` for
+ * `.bz2` files, and `Chilkat.Compression` for raw
+ * compression algorithms and general-purpose compression workflows.
+ *
+ * For an extended overview, see
+ * [UnixCompress Class Overview](https://www.chilkatsoft.com/unixcompress_class_overview.asp).
+ *
+ * Each `UnixCompress` instance owns a native Chilkat object. It is released when the JavaScript
+ * object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new UnixCompress()`.
+ *
+ * Methods that can take a while (network, files, compression, key generation) also have an
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
+ * rendering. While such a call is pending, every other call on this object throws, except
+ * {@link UnixCompress.abort} and assigning {@link UnixCompress.onPercentDone} / {@link
+ * UnixCompress.onProgressInfo}.
+ */
+export interface UnixCompress extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * The interval in milliseconds between each `AbortCheck` event callback, which enables an
+   * application to abort certain method calls before they complete. **By default, HeartbeatMs is
+   * set to **`0`**, meaning no AbortCheck event callbacks will trigger.**
+   */
+  heartbeatMs: number
+
+  /**
+   * When set to `true`, causes the currently running method to abort. Methods that always finish
+   * quickly (i.e.have no length file operations or network communications) are not affected. If no
+   * method is running, then this property is automatically reset to `false` when the next method is
+   * called. When the abort occurs, this property is reset to `false`. Both synchronous and
+   * asynchronous method calls can be aborted. (A synchronous method call could be aborted by
+   * setting this property from a separate thread.)
+   */
+  abortCurrent: boolean
+
+  // ---- Methods ----
+
+  /**
+   * Compresses a file to create a UNIX compressed file (.Z). This compression uses the LZW
+   * (Lempel-Ziv-Welch) compression algorithm.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link UnixCompress.compressFileAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link UnixCompress.lastErrorText}.
+   */
+  compressFile(inFilename: string, destPath: string): void
+
+  /**
+   * Asynchronous form of {@link UnixCompress.compressFile}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link UnixCompress.abort} (which cancels it) and the {@link UnixCompress.onPercentDone}
+   * /
+   * {@link UnixCompress.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link UnixCompress.lastErrorText}.
+   */
+  compressFileAsync(inFilename: string, destPath: string): Promise<void>
+
+  /**
+   * Unix compresses and creates a .Z file from string data. The `charset` specifies the character
+   * encoding used for the byte representation of the characters when compressed. The `charset` can
+   * be any one of a large number of character encodings, such as `utf-8`, `iso-8859-1`,
+   * `Windows-1252`, `ucs-2`, etc.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link UnixCompress.lastErrorText}.
+   */
+  compressStringToFile(inStr: string, charset: string, destPath: string): void
+
+  /**
+   * Unpacks a .tar.Z file. The decompress and untar occur in streaming mode. There are no temporary
+   * files and the memory footprint is constant (and small) while untarring.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link UnixCompress.unTarZAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link UnixCompress.lastErrorText}.
+   */
+  unTarZ(zFilename: string, destDir: string, bNoAbsolute: boolean): void
+
+  /**
+   * Asynchronous form of {@link UnixCompress.unTarZ}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link UnixCompress.abort} (which cancels it) and the {@link UnixCompress.onPercentDone}
+   * /
+   * {@link UnixCompress.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link UnixCompress.lastErrorText}.
+   */
+  unTarZAsync(zFilename: string, destDir: string, bNoAbsolute: boolean): Promise<void>
+
+  /**
+   * Uncompresses a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression
+   * algorithm.)
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link UnixCompress.uncompressFileAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link UnixCompress.lastErrorText}.
+   */
+  uncompressFile(inFilename: string, destPath: string): void
+
+  /**
+   * Asynchronous form of {@link UnixCompress.uncompressFile}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link UnixCompress.abort} (which cancels it) and the {@link UnixCompress.onPercentDone}
+   * /
+   * {@link UnixCompress.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link UnixCompress.lastErrorText}.
+   */
+  uncompressFileAsync(inFilename: string, destPath: string): Promise<void>
+
+  /**
+   * Uncompresses a .Z file that contains a text file. The contents of the text file are returned as
+   * a string. The character encoding of the text file is specified by `charset`. Typical charsets
+   * are `iso-8859-1`, `utf-8`, `windows-1252`, `shift_JIS`, `big5`, etc.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link UnixCompress.uncompressFileToStringAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link UnixCompress.lastErrorText}.
+   */
+  uncompressFileToString(zFilename: string, charset: string): string
+
+  /**
+   * Asynchronous form of {@link UnixCompress.uncompressFileToString}: the same call on a native
+   * worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link UnixCompress.abort} (which cancels it) and the {@link UnixCompress.onPercentDone}
+   * /
+   * {@link UnixCompress.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link UnixCompress.lastErrorText}.
+   */
+  uncompressFileToStringAsync(zFilename: string, charset: string): Promise<string>
+
+  // ---- Events (ReactNativeGen_DESIGN.md §6) ----
+
+  /**
+   * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
+   * can measure progress. Runs on the JavaScript thread, so it is only useful with the
+   * `...Async` methods (during a synchronous call the thread is busy and the events arrive
+   * after it returns). Assign `undefined` to remove.
+   */
+  onPercentDone?: (pctDone: number) => void
+
+  /**
+   * Called with a name/value pair of progress information while a long-running method runs
+   * (what is reported depends on the class and method). Runs on the JavaScript thread; see
+   * {@link UnixCompress.onPercentDone}. Assign `undefined` to remove.
+   */
+  onProgressInfo?: (name: string, value: string) => void
+
+  /**
+   * Requests that the pending `...Async` call on this object stop at its next progress check.
+   * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
+   * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
+   * for a responsive cancel. Harmless when nothing is pending.
+   */
+  abort(): void
+}