@chilkat/react-native 11.6.1

package/src/specs/Secrets.nitro.ts

@@ -0,0 +1,470 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { BinData } from './BinData.nitro'
+import type { JsonObject } from './JsonObject.nitro'
+import type { StringBuilder } from './StringBuilder.nitro'
+
+/**
+ * Manage application secrets through one consistent API.
+ *
+ * `Secrets` provides a unified interface for storing,
+ * retrieving, listing, and deleting secrets across local, cloud-based, and
+ * in-memory secret stores. It supports string, binary, and JSON secrets, making
+ * it useful for passwords, API keys, OAuth credentials, tokens, unlock codes,
+ * certificates, and private configuration data.
+ *
+ * **Local secure storage**
+ *
+ * - Windows Credential Manager
+ *
+ * - Apple Keychain
+ *
+ * **Cloud secret managers**
+ *
+ * - AWS Secrets Manager
+ *
+ * - Azure Key Vault
+ *
+ * - IBM Cloud Secrets Manager
+ *
+ * - Oracle Cloud Secrets
+ *
+ * - Doppler Secrets
+ *
+ * **Temporary secrets**
+ *
+ * Use in-memory secrets when values should exist only for the lifetime of
+ * the running process.
+ *
+ * **Flexible content types**
+ *
+ * Store and retrieve secrets as strings, binary data, or structured JSON.
+ *
+ * **Note:**
+ * Cloud-based secret managers often require local bootstrap credentials. These
+ * can be stored securely in the Windows Credential Manager or Apple Keychain
+ * and then used to authenticate to the cloud secret manager.
+ *
+ * Start with the
+ * [Conceptual Overview](https://www.chilkatsoft.com/chilkat_secrets_api.asp)
+ * and
+ * [Components of a Secret Name](https://www.chilkatsoft.com/components_of_a_secret_name.asp).
+ * For an extended overview, see the
+ * [Secrets Class Overview](https://www.chilkatsoft.com/secrets_class_overview.asp).
+ *
+ * Each `Secrets` 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 Secrets()`.
+ *
+ * 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 Secrets.abort} and assigning {@link Secrets.onPercentDone} / {@link
+ * Secrets.onProgressInfo}.
+ */
+export interface Secrets 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
+
+  /**
+   * This is a catch-all property to be used for uncommon needs. This property defaults to the empty
+   * string and should typically remain empty.
+   */
+  uncommonOptions: string
+
+  /**
+   * The location of the secrets.  Possible values are:
+   *
+   * - `local_manager` - On Windows this is the Credentials Manager. On MacOS and iOS it is the
+   *   Keychain. This is not yet an option on Linux or Android.
+   *
+   * - `aws_secrets_manager` - AWS Secrets Manager
+   *
+   * - `azure_key_vault` - Azure Key Vault
+   *
+   * - `ibm_cloud` - IBM Cloud Secrets Manager
+   *
+   * - `oracle_cloud` - Oracle Cloud Secrets
+   *
+   * - `doppler` - Doppler Secrets
+   *
+   * - `memory` - In-Memory Secrets
+   *
+   * The default location is the `local_manager`. On Linux and Android, `local_manager` will behave
+   * the same as `memory`.
+   */
+  location: string
+
+  /**
+   * If set to `true`, then the contents of the secret will be stored compressed. The default value
+   * of this property is `false`.
+   */
+  compression: boolean
+
+  /**
+   * The AutoSplit property is specific to `local_manager` secrets on Windows. The Windows
+   * Credentials Manager supports a maximum of 2560 bytes per secret. If a secret exceeds this size,
+   * it will be automatically compressed and split when created or updated, and automatically
+   * recomposed when retrieved.
+   *
+   * A secret can be split into a maximum of 10 parts.
+   *
+   * The default value is `true`.
+   */
+  autoSplit: boolean
+
+  // ---- Methods ----
+
+  /**
+   * Fetches a string secret and returns the content of the secret.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.getSecretStrAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  getSecretStr(jsonId: JsonObject): string
+
+  /**
+   * Asynchronous form of {@link Secrets.getSecretStr}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  getSecretStrAsync(jsonId: JsonObject): Promise<string>
+
+  /**
+   * Fetches a binary secret and returns the content in `bd`.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.getSecretBdAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  getSecretBd(jsonId: JsonObject, bd: BinData): void
+
+  /**
+   * Asynchronous form of {@link Secrets.getSecretBd}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  getSecretBdAsync(jsonId: JsonObject, bd: BinData): Promise<void>
+
+  /**
+   * Fetches a JSON secret and returns the content in `jsonOut`.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.getSecretJsonAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  getSecretJson(jsonId: JsonObject, jsonOut: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Secrets.getSecretJson}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  getSecretJsonAsync(jsonId: JsonObject, jsonOut: JsonObject): Promise<void>
+
+  /**
+   * Creates a string secret if it does not yet exist, or updates an existing secret. The name of
+   * the secret is specified in `jsonId`, and the string content of the secret in `secret`.
+   *
+   * Note: Starting in Chilkat **v11.3.0**, if the `service` = `"Chilkat"` and the `username` =
+   * `"unlock_code"`, then the secret (which is the Chilkat unlock code) can be stored and retrieved
+   * without Chilkat being unlocked. This allows for the Chilkat unlock code itself to be persisted
+   * to a secrets manager.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.updateSecretStrAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  updateSecretStr(jsonId: JsonObject, secret: string): void
+
+  /**
+   * Asynchronous form of {@link Secrets.updateSecretStr}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  updateSecretStrAsync(jsonId: JsonObject, secret: string): Promise<void>
+
+  /**
+   * Creates a JSON secret if it does not yet exist, or updates an existing secret. The name of the
+   * secret is specified in `jsonId`, and the JSON content of the secret in `secret`.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.updateSecretJsonAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  updateSecretJson(jsonId: JsonObject, secret: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Secrets.updateSecretJson}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  updateSecretJsonAsync(jsonId: JsonObject, secret: JsonObject): Promise<void>
+
+  /**
+   * Creates a binary secret if it does not yet exist, or updates an existing secret. The name of
+   * the secret is specified in `jsonId`, and the binary content of the secret in `secret`.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.updateSecretBdAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  updateSecretBd(jsonId: JsonObject, secret: BinData): void
+
+  /**
+   * Asynchronous form of {@link Secrets.updateSecretBd}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  updateSecretBdAsync(jsonId: JsonObject, secret: BinData): Promise<void>
+
+  /**
+   * Deletes a secret. Cloud secrets managers will typically disable the secret and schedule the
+   * secret for deletion after some number of days.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.deleteSecretAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  deleteSecret(jsonId: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Secrets.deleteSecret}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  deleteSecretAsync(jsonId: JsonObject): Promise<void>
+
+  /**
+   * Lists secrets matching the wildcarded or exact values passed in `json`. The results of the
+   * query are returned in `jsonOut`.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.listSecretsAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  listSecrets(json: JsonObject, jsonOut: JsonObject): void
+
+  /**
+   * Asynchronous form of {@link Secrets.listSecrets}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  listSecretsAsync(json: JsonObject, jsonOut: JsonObject): Promise<void>
+
+  /**
+   * Accessing a cloud-based secrets manager requires authentication credentials, which cannot be
+   * stored in the manager itself. Instead, they must be securely stored locally.
+   *
+   * One solution is to store the authentication credentials as a secret in the Windows Credentials
+   * Manager or Apple Keychain. These credentials serve as the `bootstrap secret` for authenticating
+   * with the cloud-based secrets manager.
+   *
+   * `jsonId` contains the name of the bootstrap secret. `secretContent` contains the bootstrap's
+   * secret content.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  setBootstrapSecret(jsonId: JsonObject, secretContent: Secrets): void
+
+  /**
+   * Fetches a string secret and returns the content in `sb`.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.getSecretSbAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  getSecretSb(jsonId: JsonObject, sb: StringBuilder): void
+
+  /**
+   * Asynchronous form of {@link Secrets.getSecretSb}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  getSecretSbAsync(jsonId: JsonObject, sb: StringBuilder): Promise<void>
+
+  /**
+   * Creates a string secret if it does not yet exist, or updates an existing secret. The name of
+   * the secret is specified in `jsonId`, and the string content of the secret in `sb`.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Secrets.updateSecretSbAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  updateSecretSb(jsonId: JsonObject, sb: StringBuilder): void
+
+  /**
+   * Asynchronous form of {@link Secrets.updateSecretSb}: 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 Secrets.abort} (which cancels it) and the {@link Secrets.onPercentDone} /
+   * {@link Secrets.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  updateSecretSbAsync(jsonId: JsonObject, sb: StringBuilder): Promise<void>
+
+  /**
+   * Converts a secret specification string (`secretSpec`) to JSON. A secret specification string is
+   * formatted as "!!part1|part2|part3|part4" where parts 3 and 4 are optional. `json` is the output
+   * argument.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Secrets.lastErrorText}.
+   */
+  secretSpecToJson(secretSpec: string, json: JsonObject): 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 Secrets.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/SecureString.nitro.ts

@@ -0,0 +1,231 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { StringBuilder } from './StringBuilder.nitro'
+
+/**
+ * Store, append, compare, hash, verify, and securely access sensitive string values.
+ *
+ * `SecureString` holds sensitive text in an encrypted
+ * in-memory form while still allowing controlled operations on the value. It
+ * can append clear-text strings, append text from a
+ * `StringBuilder`, append another `SecureString`, load
+ * text from a file, return the clear-text value when needed, compare secure
+ * strings, mark the value read-only, maintain a hash of the current value, and
+ * verify a supplied hash against that maintained value.
+ *
+ * **Encrypted in-memory value**
+ *
+ * Store sensitive text in a form that is decrypted only when needed for
+ * access, modification, comparison, or hashing.
+ *
+ * **Append safely**
+ *
+ * Append clear-text strings, `StringBuilder` content, or another
+ * `SecureString`; the value is then re-encrypted.
+ *
+ * **Read-only protection**
+ *
+ * Set `ReadOnly` to prevent later modification of the secure
+ * string.
+ *
+ * **Hash maintenance**
+ *
+ * Set `MaintainHash` to a supported hash algorithm such as
+ * `sha256`, `sha512`, `sha1`, or
+ * `md5`.
+ *
+ * **Hash output and verification**
+ *
+ * Retrieve the current hash value in an encoding such as hex or Base64, or
+ * verify a supplied encoded hash with `VerifyHash`.
+ *
+ * **Compare and access**
+ *
+ * Compare two secure strings with `SecStrEquals`, or call
+ * `Access` when the clear-text value is required.
+ *
+ * **Common pattern:**
+ * Create a `SecureString`, load or append the sensitive text, set
+ * `MaintainHash` if later verification is needed, and optionally set
+ * `ReadOnly` after the final value is established. Use
+ * `Access` only at the point where the clear-text string is actually
+ * needed, and check `LastErrorText` if an append, file load, hash,
+ * or verification operation fails.
+ *
+ * **Hash note:**
+ * `VerifyHash` depends on `MaintainHash` having already
+ * been set so the object maintains an internal hash for the current secure
+ * string value.
+ *
+ * Each `SecureString` 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 SecureString()`.
+ */
+export interface SecureString 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
+
+  /**
+   * If set to the name of a hash algorithm, then a hash of the current string value is maintained.
+   * This allows for the hash to be verified via the VerifyHash method. Possible hash algorithm
+   * names are `sha1`, `sha256`, `sha384`, `sha512`, `md5`, `md2`, `ripemd160`,
+   * `ripemd128`,`ripemd256`, and `ripemd320`.
+   */
+  maintainHash: string
+
+  /**
+   * Can be set to `true` to make this secure string read-only (cannot be modified).
+   */
+  readOnly: boolean
+
+  // ---- Methods ----
+
+  /**
+   * Returns the clear-text string value.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SecureString.lastErrorText}.
+   */
+  access(): string
+
+  /**
+   * Appends a clear-text string to this secure string. The in-memory data will be decrypted, the
+   * string will be appended, and then it will be re-encrypted. Can return `false` if the string has
+   * been marked as read-only via the ReadOnly property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SecureString.lastErrorText}.
+   */
+  append(str: string): void
+
+  /**
+   * Appends the contents of a secure string to this secure string. The in-memory data will be
+   * decrypted, the secure string will be appended, and then it will be re-encrypted. Can return
+   * `false` if this string has been marked as read-only via the ReadOnly property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SecureString.lastErrorText}.
+   */
+  appendSecure(secStr: SecureString): void
+
+  /**
+   * Verifies the `hashVal` against the hash value stored for the current value of this secure
+   * string. The MaintainHash property must've previously been set for this secure string to
+   * maintain an internal hash. The `encoding` specifies the encoding of the `hashVal`. It can be
+   * any of the binary encoding algorithms, such as `base64`, `hex`, and many more listed at
+   * [Chilkat Binary Encodings](https://www.chilkatsoft.com/binary_encodings.asp)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SecureString.lastErrorText}.
+   */
+  verifyHash(hashVal: string, encoding: string): void
+
+  /**
+   * Returns `true` if the `secStr` equals the contents of this secure string.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SecureString.lastErrorText}.
+   */
+  secStrEquals(secStr: SecureString): void
+
+  /**
+   * Returns the hash value for the current value of this secure string. The `encoding` specifies
+   * the encoding to be used. It can be any of the binary encoding algorithms, such as `base64`,
+   * `hex`, and many more listed at [Chilkat Binary
+   * Encodings](https://www.chilkatsoft.com/binary_encodings.asp)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SecureString.lastErrorText}.
+   */
+  hashVal(encoding: string): string
+
+  /**
+   * Appends a clear-text string contained in a StringBuilder to this secure string. The in-memory
+   * data will be decrypted, the string will be appended, and then it will be re-encrypted. Can
+   * return `false` if the string has been marked as read-only via the ReadOnly property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SecureString.lastErrorText}.
+   */
+  appendSb(sb: StringBuilder): void
+
+  /**
+   * Loads the contents of a file into this secure string. The current contents of this object are
+   * replaced with the new text from the file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link SecureString.lastErrorText}.
+   */
+  loadFile(path: string, charset: string): void
+}