@chilkat/react-native 11.6.1 → 11.7.0

package/src/specs/Formats.nitro.ts

@@ -0,0 +1,170 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { JsonObject } from './JsonObject.nitro'
+
+/**
+ * A collection of data-format operations, starting with barcode and QR code generation.
+ *
+ * `Formats` is not string, number or date display formatting.  It groups operations on
+ * well-defined data formats behind a small number of JSON-driven methods, so the class can grow by
+ * adding a
+ * method per format family without adding a public class for each feature. Introduced in v11.7.0
+ * with the
+ * barcode feature methods `Barcode` and `QrCode`.
+ *
+ * **QR Code generation**
+ *
+ * Versions 1–40, error-correction levels L/M/Q/H, automatic or explicit version and mask,
+ * numeric/alphanumeric/byte modes, ECI, structured append.
+ *
+ * **Precise rendering**
+ *
+ * Integer-pixel modules, px/mm/in/pt units with DPI, quiet zone, padding, rotation, colors with
+ * opacity, caption text, size limits with shrink-to-fit.
+ *
+ * **PNG or SVG output**
+ *
+ * Returned inline as base64 or SVG text, or written to files (numbered file sets for structured
+ * append). Optional module bit-matrix and reusable definition.
+ *
+ * **Measure and validate**
+ *
+ * `measure` reports exact geometry without rendering; `validate` checks a request; `capabilities`
+ * describes what the build supports.
+ *
+ * **One calling convention:** every operation is `method(op, jsonIn, jsonOut)`.  Requests are
+ * checked strictly (unknown options are rejected, not ignored) and every failure has a stable error
+ * code with the
+ * JSON Pointer of the offending member.
+ *
+ * See the [Barcode / QR Code Generation Overview](https://www.chilkatsoft.com/barcode_overview.asp)
+ * for the complete documentation with examples and sample images.
+ *
+ * Each `Formats` 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 Formats()`.
+ */
+export interface Formats 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
+
+  // ---- Methods ----
+
+  /**
+   * Runs one barcode operation and returns the result as JSON. `op` is the operation: "generate"
+   * (encode the payload, lay out the symbol and render a PNG or SVG), "measure" (encode and lay out
+   * only, reporting the exact geometry and whether the symbol fits), "validate" (examine a
+   * request's definition, capacity or layout) or "capabilities" (describe the symbologies,
+   * operations, formats and limits this build implements). `jsonIn` is the request: it names the
+   * `symbology` (currently `"qr"`), the `payload` (text or base64 binary) and optional `encoding`,
+   * `render`, `output` and `limits` groups. `jsonOut` is replaced with the response. Every response
+   * carries `errors[]` and `warnings[]`; a successful "generate" also returns `symbols[]` (the
+   * encoding actually selected), `measurements[]` (pixel geometry) and `outputs[]` (the image as
+   * base64 or SVG text, or the path of the file written).
+   *
+   * Returns `true` when the operation completed successfully. Returns `false` when the request was
+   * rejected or execution failed; `errors[0]` then holds a stable `code`, the JSON Pointer `path`
+   * of the offending request member and a `message`.
+   *
+   * The request and response vocabulary (payload types, QR version, error correction, mask, ECI,
+   * structured append, module size and physical units, quiet zone, rotation, colors, captions,
+   * PNG/SVG output, file writing, limits and error codes) is documented in full, with examples and
+   * sample images, at the links below.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Formats.lastErrorText}.
+   */
+  barcode(op: string, jsonIn: JsonObject, jsonOut: JsonObject): void
+
+  /**
+   * The same as `Barcode` with the `symbology` defaulting to `"qr"`, so the smallest request is `{
+   * "payload": { "text": "..." } }`. `op` is the operation ("generate", "measure", "validate" or
+   * "capabilities"), `jsonIn` the request and `jsonOut` the response. Identical requests to
+   * `QrCode` and `Barcode` produce identical results; a request naming a symbology outside the QR
+   * family is rejected.
+   *
+   * Generates QR Code (Model 2) symbols in versions 1-40 with error-correction levels L, M, Q and
+   * H, automatic or explicit version and mask selection, numeric, alphanumeric and byte modes,
+   * optional ECI, and structured append of up to 16 symbols. Output is PNG or SVG, returned inline
+   * (base64 or SVG text) and/or written to files.
+   *
+   * Returns `true` when the operation completed successfully, otherwise `false` with the reason in
+   * `errors[0]` of `jsonOut` (code, JSON Pointer path and message). See the links below for the
+   * complete documentation of every option, with examples and sample images.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Formats.lastErrorText}.
+   */
+  qrCode(op: string, jsonIn: JsonObject, jsonOut: JsonObject): void
+}

package/src/specs/Hashtable.nitro.ts

@@ -248,11 +248,8 @@ export interface Hashtable extends HybridObject<{ ios: 'c++', android: 'c++' }>
    *
    * A `false` result caused by an absent key is a normal lookup outcome, not an indication that the
    * hashtable was damaged. Removing an existing entry decreases `Count` by one.
-   *
-   * @throws Error if the call fails (the message names the reason); the full log is in
-   * {@link Hashtable.lastErrorText}.
    */
-  remove(key: string): void
+  remove(key: string): boolean
 
   /**
    * Appends all hashtable key strings to the `StringTable` passed in `ARG1`. Existing strings

package/src/specs/Http.nitro.ts

@@ -1465,6 +1465,13 @@ export interface Http extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    * explicitly set the SNI hostname via the `SniHostname` property, which would be typical if
    * connecting via an IP address. See the example below.
    *
+   * Starting in v11.7.0, a wildcard SAN entry is matched as RFC 9525 (formerly RFC 6125) specifies.
+   * The wildcard must be the entire left-most label (`*.example.com`) and stands for exactly one
+   * label: `*.example.com` matches `www.example.com`, but not `a.b.example.com` and not the bare
+   * `example.com`. (Earlier versions matched the bare domain, and accepted a wildcard in any
+   * position.) A wildcard is not accepted directly under a top-level domain or a country-code
+   * second level such as `co.uk`, and never matches an IP address.
+   *
    * The default value is `false`.
    */
   requireHostnameMatch: boolean
@@ -3059,15 +3066,44 @@ export interface Http extends HybridObject<{ ios: 'c++', android: 'c++' }> {
   clearInMemoryCookies(): void
 
   /**
-   * Sets the EC private key for automatically adding the DPoP header to HTTP requests. Chilkat will
-   * generate a JWT for each request and include the `DPoP` header. Ensure the AuthToken property is
-   * also set.
+   * Sets the private key for automatically adding the DPoP header to HTTP requests. Chilkat will
+   * generate a JWT (a DPoP proof) for each request and include the `DPoP` header. Ensure the {@link
+   * Http.authToken} property is also set.
+   *
+   * The key can be an EC key on the P-256, P-384 or P-521 curve (the proof is signed with ES256,
+   * ES384 or ES512), an RSA key of 2048 bits or more (RS256), or an Ed25519 key (EdDSA). Before
+   * v11.7.0, only EC keys were accepted.
    *
    * @throws Error if the call fails (the message names the reason); the full log is in
    * {@link Http.lastErrorText}.
    */
   setDPoPKey(privKey: PrivateKey): void
 
+  /**
+   * Sets the private key for `private_key_jwt` client authentication (RFC 7523) in the OAuth2
+   * client credentials flow of the {@link Http.authToken} property. When the `AuthToken` is set to
+   * JSON with the client credentials, Chilkat creates a new `client_assertion` JWT, signed with
+   * this key, for each token request, and sends it with `client_assertion_type` set to
+   * `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. The JWT has the claims `iss` and
+   * `sub` (the `client_id` from the JSON), `aud` (the `token_endpoint`), `iat`, `exp` (5 minutes
+   * after `iat`) and a unique `jti`.
+   *
+   * \*kid\* is the key ID, which is put in the JWT header. Pass an empty string if the
+   * authorization server does not need one. The key can be an EC key on the P-256, P-384 or P-521
+   * curve (the JWT is signed with ES256, ES384 or ES512), an RSA key of 2048 bits or more (RS256),
+   * or an Ed25519 key (EdDSA). For example, load a key in JWK format with `PrivateKey.LoadJwk` and
+   * pass its `kid`.
+   *
+   * This is typically used with {@link Http.setDPoPKey}, when the authorization server requires
+   * both a client assertion and DPoP. The same key may be passed to both methods if the server
+   * allows it. A `client_assertion` or `client_assertion_type` member in the `AuthToken` JSON is
+   * ignored once this key is set. The JSON must include the `client_id`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Http.lastErrorText}.
+   */
+  setClientAssertionKey(privKey: PrivateKey, kid: string): void
+
   // ---- Events (ReactNativeGen_DESIGN.md §6) ----
 
   /**

package/src/specs/HttpCurl.nitro.ts

@@ -16,8 +16,9 @@ import type { Xml } from './Xml.nitro'
  * dependency resolution, response extraction, and structured diagnostics.
  *
  * Variables such as `{{access_token}}`, `{{site_id}}`, or
- * `{{drive_id}}` can appear in URLs, headers, query parameters, or request
- * bodies. If a variable is not yet known, `HttpCurl` can build an execution
+ * `{{drive_id}}` can appear in URLs, headers, query parameters, request
+ * bodies, the JSON paths that extract values from a response, and the local file path a
+ * response is written to. If a variable is not yet known, `HttpCurl` can build an execution
  * plan from previously defined curl functions, run the prerequisite requests, extract
  * values from JSON responses, and then execute the final target request.
  *
@@ -157,6 +158,19 @@ export interface HttpCurl extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    */
   readonly responseBodyStr: string
 
+  /**
+   * Returns the HTTP response header from the last call to {@link HttpCurl.doYourThing}: the status
+   * line (such as `HTTP/1.1 200 OK`) followed by the header fields, with CRLF line endings. Empty
+   * if no response was received. When redirects were followed (`-L`), this is the header of the
+   * final response. To get a single field, use {@link HttpCurl.getResponseHeaderField}. The curl
+   * `-D`/`--dump-header` option writes the header of every response (including redirects) to a
+   * file, and `-i`/`--include` writes the header before the body in the `-o`/`-O` output file;
+   * neither changes this property or the response body returned in memory.
+   *
+   * This property is read-only.
+   */
+  readonly responseHeader: string
+
   /**
    * Set this property to the path of a file to stream the response body to a file. If the response
    * is streamed to a file, it will not be available in {@link HttpCurl.responseBodyStr}, {@link
@@ -200,6 +214,10 @@ export interface HttpCurl extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    *
    * - Failed to open or create the local output file (if a curl option directed output to a file).
    *
+   * - The response body is compressed with a Content-Encoding Chilkat cannot decode, such as Brotli
+   *   (`br`) or zstd, so it is unusable. gzip and deflate are decoded automatically. (Introduced in
+   *   v11.7.0.)
+   *
    * **Note:** `curl` can read data from a local file and send it in a request (usually POST/PUT)
    * using special syntax:
    *
@@ -238,6 +256,16 @@ export interface HttpCurl extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    * Provides a comma-separated list of uncommon option keywords.
    *
    * This property defaults to an empty string and should normally remain empty.
+   *
+   * Can be set to a list of the following comma separated keywords:
+   *
+   * - `IgnoreUnknownCurlOptions` - Introduced in v11.7.0. Starting in v11.7.0, a curl option that
+   *   HttpCurl does not recognize causes {@link HttpCurl.doYourThing} to fail with a syntax error
+   *   ({@link HttpCurl.failReason} = 1) naming the option in `LastErrorText`, rather than being
+   *   silently dropped as in earlier versions. (Options that are meaningless to HttpCurl but
+   *   harmless, such as `--progress-bar` or `--retry`, are accepted and ignored.) This keyword
+   *   restores the earlier behavior: an unknown option is skipped with a note in `LastErrorText`.
+   *   Note that the value of an unknown option that takes one is then seen as a stray token.
    */
   uncommonOptions: string
 
@@ -264,6 +292,53 @@ export interface HttpCurl extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    * {@link HttpCurl.addTargetOutput} will be populated by applying each variable's JSON path to the
    * response JSON.
    *
+   * **Writing the response to a local file**
+   *
+   * A curl command may write the response body to a local file with `-o` / `--output` (an explicit
+   * filename), or with
+   * `-O` / `--remote-name` (the filename is the final path segment of the URL). Either may be
+   * combined with
+   * `--output-dir`, which, as in curl, is applied only when the filename itself contains no
+   * directory separator.
+   *
+   * Starting in v11.7.0, the output file path may contain variable names enclosed in `{{` and `}}`,
+   * resolved from the
+   * current variable values at the time the request is sent. This applies to the path given with
+   * `-o`, the directory given with
+   * `--output-dir`, and the URL that `-O` derives a filename from. In previous versions the path
+   * was used exactly as
+   * written, so `-o "{{report_name}}.pdf"` created a file literally named `{{report_name}}.pdf` and
+   * reported success.
+   *
+   * ```
+   * httpCurl.SetVar("customer","acme");
+   * httpCurl.SetVar("report_name","q3-summary");
+   * httpCurl.DoYourThing("curl https://api.example.com/reports/{{report_name}} "
+   *     "--output-dir \"reports/{{customer}}\" -o \"{{report_name}}.pdf\"");
+   * // writes reports/acme/q3-summary.pdf
+   * ```
+   *
+   * Two conditions cause the request to fail rather than write a file:
+   *
+   * - The resolved path still contains a `{{varName}}` reference, or a variable in it resolved to
+   *   an empty string. (Elsewhere -- in a URL
+   *   or a request body -- an unresolved reference is left in place. In a file path that would
+   *   silently create a misnamed file.)
+   *
+   * - A variable substituted into the path has a value containing a `..` directory segment. Because
+   *   a variable's value can come from a
+   *   server's response (see {@link HttpCurl.addOutput} and {@link HttpCurl.addOutput2}), a
+   *   response
+   *   must not be able to move the output file out of the directory the curl command named. A `..`
+   *   written literally in the curl command
+   *   itself is the application's own choice and is allowed.
+   *
+   * The path as it will actually be used is written to `LastErrorText` as `resolvedOutputPath`.
+   *
+   * This is independent of the {@link HttpCurl.responseFilePath} property, which streams the
+   * response body to a file
+   * for requests whose curl command names no output file.
+   *
    * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
    * {@link HttpCurl.doYourThingAsync}.
    *
@@ -350,9 +425,25 @@ export interface HttpCurl extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    */
   getResponseJarr(jarr: JsonArray): void
 
+  /**
+   * Returns the value of the response header field named `name` (case-insensitive) from the last
+   * call to {@link HttpCurl.doYourThing}, such as `"Content-Type"` or `"ETag"`. Returns an empty
+   * string if the response has no such field. When redirects were followed (`-L`), the field is
+   * from the final response. The full response header is available in {@link
+   * HttpCurl.responseHeader}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpCurl.lastErrorText}.
+   */
+  getResponseHeaderField(name: string): string
+
   /**
    * Sets the value of a variable to be replaced in curl commands. Variable names are enclosed in
-   * `{{` and `}}` and can occur in the path, query params, or the body of the request.
+   * `{{` and `}}` and can occur in the path, query params, or the body of the request. Starting in
+   * v11.7.0, they can also occur in the `arrayPath`, `wherePath`, `whereValue` and `subPath` passed
+   * to {@link HttpCurl.addOutput2}, and in the local output file path of a curl command -- the path
+   * given with `-o` or `--output`, the directory given with `--output-dir`, and the URL that `-O`
+   * derives a filename from. See {@link HttpCurl.doYourThing}.
    */
   setVar(varName: string, varValue: string): void
 
@@ -457,13 +548,16 @@ export interface HttpCurl extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    *
    * -
    * `arrayPath` — The JSON path identifying the array of records within the JSON response.
+   * May contain variable references (see below).
    *
    * -
    * `wherePath` — A relative JSON path within each array element used to locate the matching
    * record.
+   * May contain variable references (see below).
    *
    * -
    * `whereValue` — The value to match against the JSON value found at `wherePath`.
+   * May contain variable references (see below).
    *
    * -
    * `caseSensitive` — If `true`, the comparison between `whereValue` and the JSON value is
@@ -472,10 +566,32 @@ export interface HttpCurl extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    * -
    * `subPath` — A relative JSON path within the matched array element identifying the value to
    * extract.
+   * May contain variable references (see below).
    *
    * -
    * `varName` — The name of the variable that will receive the extracted value.
    *
+   * **Variable references**
+   *
+   * Starting in v11.7.0, the `arrayPath`, `wherePath`, `whereValue` and
+   * `subPath` may each contain variable names enclosed in `{{` and `}}`, such as
+   * `{{site_name}}`, either on their own or within a longer string such as
+   * `result.{{list_name}}.items`. Each is stored exactly as passed here, and the references in it
+   * are
+   * resolved every time this output is evaluated — not when `AddOutput2` is called. A variable
+   * whose value
+   * is set later by `SetVar`, or that is produced as the output of another curl function, is
+   * therefore used
+   * with its current value.
+   *
+   * A variable referenced here is treated as an input of the curl function, exactly like one
+   * appearing in the curl
+   * command itself, so the execution plan runs whatever produces it first. If a referenced variable
+   * has no value and
+   * nothing can produce it, the reference is left in place, no array element matches, and the
+   * LastErrorText reports the
+   * failure with both the resolved and the unresolved form of the record spec.
+   *
    * **Example**
    *
    * Given the following JSON response:

package/src/specs/Jwe.nitro.ts

@@ -214,13 +214,19 @@ export interface Jwe extends HybridObject<{ ios: 'c++', android: 'c++' }> {
   preferFlattened: boolean
 
   /**
-   * Provides a catch-all string for specialized compatibility options that are not exposed as
+   * Provides a comma-separated list of specialized compatibility options that are not exposed as
    * ordinary properties. The default is the empty string, which is appropriate for normal JWE
    * creation and decryption.
    *
-   * **No public keywords documented:** This reference does not currently define any public
-   * `Jwe.UncommonOptions` keywords. Leave the property empty unless a Chilkat release note,
-   * example, or support response provides the exact option name, syntax, and intended use.
+   * OptionEffect
+   *
+   * | `jwe-no-inflate-limit` | | Starting in v11.7.0. Removes the limit on the decompressed size of
+   * a JWE that uses `zip`:`DEF`. By default, decryption fails if the plaintext would decompress to
+   * more than 64 MB, which protects against decompression bombs. |
+   *
+   * **Use only for trusted senders:** A small compressed JWE can expand to an enormous plaintext.
+   * Set `jwe-no-inflate-limit` only when every JWE you decrypt comes from a trusted source and
+   * legitimately decompresses to more than 64 MB.
    */
   uncommonOptions: string
 
@@ -548,7 +554,8 @@ export interface Jwe extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    *
    * Loaded AAD is used automatically. Authentication is completed before plaintext is returned. For
    * `zip`:`DEF`, decompression occurs only after successful authentication, and no partial
-   * decompressed output is returned.
+   * decompressed output is returned. Starting in v11.7.0, decryption fails if the plaintext would
+   * decompress to more than 64 MB, unless `UncommonOptions` contains `jwe-no-inflate-limit`.
    *
    * **Charset errors:** Charset conversion errors cause `Decrypt` to fail.
    *

package/src/specs/MailMan.nitro.ts

@@ -1610,6 +1610,13 @@ export interface MailMan extends HybridObject<{ ios: 'c++', android: 'c++' }> {
    * {@link MailMan.requireSslCertVerify}. Therefore,
    * it still occurs when certificate-chain verification is not required.
    *
+   * Starting in v11.7.0, a wildcard SAN entry is matched as RFC 9525 (formerly RFC 6125) specifies.
+   * The wildcard must be the entire left-most label (`*.example.com`) and stands for exactly one
+   * label: `*.example.com` matches `www.example.com`, but not `a.b.example.com` and not the bare
+   * `example.com`. (Earlier versions matched the bare domain, and accepted a wildcard in any
+   * position.) A wildcard is not accepted directly under a top-level domain or a country-code
+   * second level such as `co.uk`, and never matches an IP address.
+   *
    * The default value is `_FALSE_`.
    */
   requireHostnameMatch: boolean