@chilkat/react-native 11.6.1

package/src/specs/Asn.nitro.ts

@@ -0,0 +1,509 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { BinData } from './BinData.nitro'
+
+/**
+ * Load, inspect, build, edit, and encode ASN.1 structures in DER or XML form.
+ *
+ * `Asn` represents an ASN.1 item and its optional child
+ * items. It can load ASN.1 from binary DER, encoded DER strings, files, or
+ * `BinData`; expose tags, tag values, primitive content, boolean
+ * and integer values, and child counts; build constructed structures such as
+ * `SEQUENCE` and `SET`; append common primitive types
+ * such as booleans, integers, big integers, bit strings, octets, OIDs, strings,
+ * times, null values, and context-specific items; convert ASN.1 to XML; reload
+ * from that XML form; and write the final structure back to DER.
+ *
+ * **Load DER data**
+ *
+ * Load ASN.1 from binary DER bytes, encoded text such as Base64 or hex,
+ * files, or existing `BinData` objects.
+ *
+ * **Inspect ASN.1 items**
+ *
+ * Read the item tag, tag value, constructed/primitive state, sub-item
+ * count, string content, boolean value, or integer value.
+ *
+ * **Build sequences and sets**
+ *
+ * Append constructed `SEQUENCE` and `SET` items,
+ * then add child ASN.1 values beneath them.
+ *
+ * **Append primitive values**
+ *
+ * Add booleans, integers, big integers, bit strings, octet strings, OIDs,
+ * strings, times, null values, and encoded byte content.
+ *
+ * **Context-specific tags**
+ *
+ * Add context-specific primitive or constructed items when working with
+ * ASN.1 formats that use tagged application-specific structures.
+ *
+ * **DER and XML conversion**
+ *
+ * Convert ASN.1 to XML for inspection or editing, load ASN.1 back from XML,
+ * and output the result as binary or encoded DER.
+ *
+ * **Common pattern:**
+ * Load existing DER with `LoadBinary`, `LoadEncoded`,
+ * `LoadBd`, or `LoadBinaryFile`, inspect the tree with
+ * `Tag`, `Constructed`, `NumSubItems`, and
+ * `GetSubItem`, then extract primitive content or convert to XML
+ * with `AsnToXml`. To create ASN.1, start with a constructed item,
+ * append child values, and write the final DER with `GetBinaryDer`,
+ * `GetEncodedDer`, `WriteBd`, or
+ * `WriteBinaryDer`.
+ *
+ * Each `Asn` 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 Asn()`.
+ */
+export interface Asn 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 ASN.1 item's boolean value if it is a boolean item.
+   */
+  boolValue: boolean
+
+  /**
+   * `true` if this ASN.1 item is a constructed item. Sequence and Set items are constructed and can
+   * contain sub-items. All other tags (boolean, integer, octets, utf8String, etc.) are primitive
+   * (non-constructed).
+   *
+   * This property is read-only.
+   */
+  readonly constructed: boolean
+
+  /**
+   * The ASN.1 item's content if it is an ASN.1 string type (such as Utf8String, BmpString,
+   * PrintableString, VisibleString, T61String, IA5String, NumericString, or UniversalString).
+   */
+  contentStr: string
+
+  /**
+   * The ASN.1 item's integer value if it is a small integer item.
+   */
+  intValue: number
+
+  /**
+   * The number of sub-items contained within this ASN.1 item. Only constructed items, such as
+   * Sequence and Set will contain sub-iitems. Primitive items such as OIDs, octet strings,
+   * integers, etc. will never contain sub-items.
+   *
+   * This property is read-only.
+   */
+  readonly numSubItems: number
+
+  /**
+   * The ASN.1 item's tag as a descriptive string.  Possible values are:
+   *
+   * ```
+   * boolean
+   * integer
+   * bitString
+   * octets
+   * null
+   * oid
+   * utf8String
+   * relativeOid
+   * sequence
+   * set
+   * numericString
+   * printableString
+   * t61String
+   * ia5String
+   * utcTime
+   * bmpString
+   * ```
+   *
+   * This property is read-only.
+   */
+  readonly tag: string
+
+  /**
+   * The ASN.1 item's tag as a integer value.  The integer values for possible tags are as follows:
+   *
+   * ```
+   * boolean (1)
+   * integer (2)
+   * bitString (3)
+   * octets (4)
+   * null (5)
+   * oid (6)
+   * utf8String (12)
+   * relativeOid (13)
+   * sequence (16)
+   * set (17)
+   * numericString (18)
+   * printableString (19)
+   * t61String (20)
+   * ia5String (22)
+   * utcTime (23)
+   * bmpString (30)
+   * ```
+   *
+   * This property is read-only.
+   */
+  readonly tagValue: number
+
+  // ---- Methods ----
+
+  /**
+   * Appends an ASN.1 integer, but one that is a big (huge) integer that is too large to be
+   * represented by an integer variable. The bytes composing the integer are passed in encoded
+   * string format (such as base64, hex, etc.). The byte order must be big-endian. The `encoding`
+   * may be any of the following encodings: `Base64`, `Hex`, `Base58`, `modBase64`, `Base32`, `UU`,
+   * `QP` (for quoted-printable), `URL` (for url-encoding), `Q`, `B`, `url_oath`, `url_rfc1738`,
+   * `url_rfc2396`, and `url_rfc3986`. The `encoding` name is case insensitive (for example, both
+   * `Base64` and `base64` are treated the same).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendBigInt(encodedBytes: string, encoding: string): void
+
+  /**
+   * Appends an ASN.1 bit string to the caller's sub-items. The bytes containing the bits are passed
+   * in encoded string format (such as base64, hex, etc.). The byte order must be big-endian (MSB
+   * first). The `encoding` may be any of the following encodings: `Base64`, `Hex`, `Base58`,
+   * `modBase64`, `Base32`, `UU`, `QP` (for quoted-printable), `URL` (for url-encoding), `Q`, `B`,
+   * `url_oath`, `url_rfc1738`, `url_rfc2396`, and `url_rfc3986`. The `encoding` name is case
+   * insensitive (for example, both `Base64` and `base64` are treated the same).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendBits(encodedBytes: string, encoding: string): void
+
+  /**
+   * Appends an ASN.1 boolean item to the caller's sub-items. Items may only be appended to
+   * constructed data types such as Sequence and Set.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendBool(value: boolean): void
+
+  /**
+   * Appends an ASN.1 context-specific constructed item to the caller's sub-items.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendContextConstructed(tag: number): void
+
+  /**
+   * Appends an ASN.1 context-specific primitive item to the caller's sub-items. The bytes are
+   * passed in encoded string format (such as base64, hex, etc.). The `encoding` may be any of the
+   * following encodings: `Base64`, `Hex`, `Base58`, `modBase64`, `Base32`, `UU`, `QP` (for
+   * quoted-printable), `URL` (for url-encoding), `Q`, `B`, `url_oath`, `url_rfc1738`,
+   * `url_rfc2396`, and `url_rfc3986`. The `encoding` name is case insensitive (for example, both
+   * `Base64` and `base64` are treated the same).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendContextPrimitive(tag: number, encodedBytes: string, encoding: string): void
+
+  /**
+   * Appends an ASN.1 integer item to the caller's sub-items. Items may only be appended to
+   * constructed data types such as Sequence and Set.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendInt(value: number): void
+
+  /**
+   * Appends an ASN.1 null item to the caller's sub-items. Items may only be appended to constructed
+   * data types such as Sequence and Set.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendNull(): void
+
+  /**
+   * Appends an ASN.1 octet string to the caller's sub-items. The bytes are passed in encoded string
+   * format (such as base64, hex, etc.). The `encoding` may be any of the following encodings:
+   * `Base64`, `Hex`, `Base58`, `modBase64`, `Base32`, `UU`, `QP` (for quoted-printable), `URL` (for
+   * url-encoding), `Q`, `B`, `url_oath`, `url_rfc1738`, `url_rfc2396`, and `url_rfc3986`. The
+   * `encoding` name is case insensitive (for example, both `Base64` and `base64` are treated the
+   * same).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendOctets(encodedBytes: string, encoding: string): void
+
+  /**
+   * Appends an ASN.1 OID (object identifier) to the caller's sub-items. The OID is passed in string
+   * form, such as `1.2.840.113549.1.9.1`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendOid(oid: string): void
+
+  /**
+   * Appends an ASN.1 sequence item to the caller's sub-items.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendSequence(): void
+
+  /**
+   * Appends an ASN.1 sequence item to the caller's sub-items, and updates the internal reference to
+   * point to the newly appended sequence item.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendSequence2(): void
+
+  /**
+   * Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended
+   * sequence item.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendSequenceR(): Asn
+
+  /**
+   * Appends an ASN.1 set item to the caller's sub-items.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendSet(): void
+
+  /**
+   * Appends an ASN.1 set item to the caller's sub-items, and updates the internal reference to
+   * point to the newly appended set item.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendSet2(): void
+
+  /**
+   * Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendSetR(): Asn
+
+  /**
+   * Appends a string item to the caller's sub-items. The `strType` specifies the type of string to
+   * be added. It may be `utf8`, `ia5`, `t61`, `printable`, `visible`, `numeric`, `universal`, or
+   * `bmp`. The `value` must conform to the ASN.1 restrictions imposed for a given string type. The
+   * `utf8`, `bmp`, and `universal` types have no restrictions on what characters are allowed. In
+   * general, unless a specific type of string is required, choose the `utf8` type.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendString(strType: string, value: string): void
+
+  /**
+   * Appends a UTCTime item to the caller's sub-items. The `timeFormat` specifies the format of the
+   * `dateTimeStr`. It should be set to `utc`. (In the future, this method will be expanded to
+   * append GeneralizedTime items by using `generalized` for `timeFormat`.) To append the current
+   * date/time, set `dateTimeStr` equal to the empty string or the keyword `now`. Otherwise, the
+   * `dateTimeStr` should be in the UTC time format `YYMMDDhhmm[ss]Z` or `YYMMDDhhmm[ss](+|-)hhmm`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  appendTime(timeFormat: string, dateTimeStr: string): void
+
+  /**
+   * Converts ASN.1 to XML and returns the XML string.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  asnToXml(): string
+
+  /**
+   * Discards the Nth sub-item.  (The 1st sub-item is at index 0.)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  deleteSubItem(index: number): void
+
+  /**
+   * Returns the content of the ASN.1 item in encoded string form. The `encoding` may be any of the
+   * following encodings: `Base64`, `Hex`, `Base58`, `modBase64`, `Base32`, `UU`, `QP` (for
+   * quoted-printable), `URL` (for url-encoding), `Q`, `B`, `url_oath`, `url_rfc1738`,
+   * `url_rfc2396`, and `url_rfc3986`. The `encoding` name is case insensitive (for example, both
+   * `Base64` and `base64` are treated the same).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  getEncodedContent(encoding: string): string
+
+  /**
+   * Returns the binary DER in encoded string form. The `encoding` indicates the encoding and can be
+   * `base64`, `hex`, `uu`, `quoted-printable`, `base32`, or `modbase64`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  getEncodedDer(encoding: string): string
+
+  /**
+   * Returns the last ASN.1 sub-item. This method can be called immediately after any Append\*
+   * method to access the appended item.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  getLastSubItem(): Asn
+
+  /**
+   * Returns the Nth ASN.1 sub-item.  The 1st sub-item is at index 0.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  getSubItem(index: number): Asn
+
+  /**
+   * Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  loadAsnXml(xmlStr: string): void
+
+  /**
+   * Loads ASN.1 from a binary DER file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  loadBinaryFile(path: string): void
+
+  /**
+   * Loads ASN.1 from an encoded string. The `encoding` can be `base64`, `hex`, `uu`,
+   * `quoted-printable`, `base32`, or `modbase64`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  loadEncoded(asnContent: string, encoding: string): void
+
+  /**
+   * Sets the content of this primitive ASN.1 item. The `encoding` may be any of the following
+   * encodings: `Base64`, `Hex`, `Base58`, `modBase64`, `Base32`, `UU`, `QP` (for quoted-printable),
+   * `URL` (for url-encoding), `Q`, `B`, `url_oath`, `url_rfc1738`, `url_rfc2396`, and
+   * `url_rfc3986`. The `encoding` name is case insensitive (for example, both `Base64` and `base64`
+   * are treated the same).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  setEncodedContent(encodedBytes: string, encoding: string): void
+
+  /**
+   * Writes the ASN.1 in binary DER form to a file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  writeBinaryDer(path: string): void
+
+  /**
+   * Loads ASN.1 from the binary DER contained in `bd`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  loadBd(bd: BinData): void
+
+  /**
+   * Appends the ASN.1 in binary DER format to `bd`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Asn.lastErrorText}.
+   */
+  writeBd(bd: BinData): void
+}