@chilkat/react-native 11.6.1

package/src/specs/AuthAws.nitro.ts

@@ -0,0 +1,234 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+
+/**
+ * Configure AWS request signing for REST calls and temporary pre-signed URLs.
+ *
+ * `AuthAws` holds the AWS authentication settings used by
+ * `Chilkat.Rest` when sending signed AWS requests. It supports AWS
+ * Signature Version 4 by default, can optionally use the older Signature
+ * Version 2 where applicable, accepts direct credential values or secure secret
+ * specifiers, and can generate temporary Signature V4 pre-signed URLs for AWS
+ * services.
+ *
+ * **REST authentication object**
+ *
+ * Provide AWS signing settings to `Chilkat.Rest` so outgoing
+ * requests are authenticated according to AWS requirements.
+ *
+ * **Signature Version 4**
+ *
+ * Sign requests using AWS Signature Version 4, including service, region,
+ * credentials, headers, and request payload details.
+ *
+ * **Credentials and secrets**
+ *
+ * Use access keys and secret keys directly, or use secret specifiers when
+ * credentials should be resolved from a secure credential source.
+ *
+ * **Region and service targeting**
+ *
+ * Configure the AWS region and service name so signatures are generated
+ * for the correct AWS endpoint.
+ *
+ * **Temporary credentials**
+ *
+ * Include session tokens when signing requests with temporary AWS
+ * credentials from STS, IAM roles, or similar credential flows.
+ *
+ * **Pre-signed URLs**
+ *
+ * Generate temporary Signature V4 pre-signed URLs when a client needs
+ * limited-time access without sending AWS credentials.
+ *
+ * **Common pattern:**
+ * Create and configure an `AuthAws` object with the AWS access key,
+ * secret key or secret specifier, region, service name, and optional session
+ * token, then pass it to `Chilkat.Rest` before sending the request.
+ * Use `AuthAws` for AWS request signing; use service-specific
+ * Chilkat classes or `Chilkat.Http`/`Chilkat.Rest` for
+ * constructing and sending the actual API request.
+ *
+ * For an extended overview, see
+ * [AuthAws Class Overview](https://www.chilkatsoft.com/authaws_class_overview.asp).
+ *
+ * Each `AuthAws` 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 AuthAws()`.
+ */
+export interface AuthAws 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 AWS access key.
+   */
+  accessKey: string
+
+  /**
+   * If AWS Signature Version V2 is used, then this property must be set. The rules for setting the
+   * canonicalized resource for the V2 signature method is described here: [Constructing the
+   * CanonicalizedResource
+   * Element](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html#ConstructingTheCanonicalizedResourceElement).
+   */
+  canonicalizedResourceV2: string
+
+  /**
+   * This property can optionally be set for AWS requests that have a non-empty request body. This
+   * should be the base64 encoding of the 16 bytes of the MD5 hash. The most common need for this is
+   * if doing an S3 upload from a stream. (If the pre-computed MD5 is not provided, then Chilkat is
+   * forced to stream the entire file into memory so that it can calculate the MD5 for
+   * authentication.)
+   *
+   * **Note: **AWS Signature Version 2 uses the MD5, whereas Signature Version 4 uses SHA256.
+   */
+  precomputedMd5: string
+
+  /**
+   * This property can optionally be set for AWS requests that have a non-empty request body. This
+   * should be the lowercase hex encoding of the 32-bytes of the SHA256 hash. The most common need
+   * for this is if doing an S3 upload from a stream. (If the pre-computed SHA-256 is not provided,
+   * then Chilkat is forced to stream the entire file into memory so that it can calculate the
+   * SHA-256 for authentication.)
+   *
+   * **Note: **AWS Signature Version 4 uses the SHA256 hash.  (AWS Signature Version 2 uses MD5)
+   */
+  precomputedSha256: string
+
+  /**
+   * The AWS region, such as `us-east-1`, `us-west-2`, `eu-west-1`, `eu-central-1`, etc. The default
+   * is `us-east-1`. It is only used when the SignatureVersion property is set to 4. This property
+   * is unused when the SignatureVersion property is set to 2.
+   */
+  region: string
+
+  /**
+   * The AWS secret key.
+   */
+  secretKey: string
+
+  /**
+   * The AWS service namespace, such as `s3`, `ses`, etc. See
+   * <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>
+   *
+   * This property is unused when the SignatureVersion property is set to 2.
+   */
+  serviceName: string
+
+  /**
+   * The AWS Signature Version to be used in authentication. The default value is 4. This can
+   * optionally be set to the value 2 to use the older V2 signature version.
+   */
+  signatureVersion: number
+
+  /**
+   * If `true` a secret specifier of the format "!!part1|part2|.." can be provided instead of the
+   * actual value for the AccessKey and SecretKey properties.
+   *
+   * The default value is `false`.
+   */
+  enableSecrets: boolean
+
+  // ---- Methods ----
+
+  /**
+   * Generates a temporary pre-signed URL for an Amazon AWS service using AWS Signature V4. Requires
+   * that the SecretKey, AccessKey, and Region properties be set to valid values prior to calling
+   * this method.
+   *
+   * The URL that is generated has this format:
+   *
+   * ```
+   * https:///
+   * ?X-Amz-Algorithm=AWS4-HMAC-SHA256
+   * &X-Amz-Credential=////aws4_request
+   * &X-Amz-Date=
+   * &X-Amz-Expires=
+   * &X-Amz-SignedHeaders=host
+   * &X-Amz-Signature=
+   * ```
+   *
+   * The `httpVerb` is the HTTP verb such as `GET`, `PUT`, `POST`, `DELETE`, etc. The `awsService`
+   * is a string naming the AWS service, such as `s3`, `execute-api`, etc. If `useHttps` is `true`,
+   * then the returned URL begins with `https://`, otherwise it begins with `http://`.
+   *
+   * **Note:** It is generally not feasible to use pre-signed URLs for `POST` operations for any AWS
+   * service except for `S3`. See [AWS Pre-Signed URLs for POST Operations
+   * (non-S3)](https://www.chilkatsoft.com/aws_pre_signed_urls_for_post_operations.asp)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link AuthAws.lastErrorText}.
+   */
+  genPresignedUrl(httpVerb: string, useHttps: boolean, domain: string, path: string, numSecondsValid: number, awsService: string): string
+}

package/src/specs/AuthAzureSAS.nitro.ts

@@ -0,0 +1,205 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+
+/**
+ * Create Azure Shared Access Signature tokens for signed Azure Storage requests.
+ *
+ * `AuthAzureSAS` creates Azure Shared Access Signature
+ * authentication tokens. It defines the SAS string-to-sign, supplies the Azure
+ * Storage account access key used to compute the signature, and controls which
+ * parameters are included in the generated SAS token query string. The
+ * resulting token can be used with `Chilkat.Rest`,
+ * `Chilkat.Http`, or other request-building code that needs
+ * time-limited, permission-scoped access to Azure Storage resources.
+ *
+ * **SAS token generation**
+ *
+ * Generate a signed query-string token that authorizes limited access to an
+ * Azure Storage resource.
+ *
+ * **String-to-sign control**
+ *
+ * Provide the exact Azure SAS string-to-sign required for the storage
+ * service and resource being accessed.
+ *
+ * **Account key signing**
+ *
+ * Use the Azure Storage account access key to compute the signature placed
+ * in the generated SAS token.
+ *
+ * **Token parameters**
+ *
+ * Add signed SAS parameters such as permissions, expiry, resource type, API
+ * version, protocol, or IP restrictions.
+ *
+ * **Non-token parameters**
+ *
+ * Add query parameters that should accompany the request but should not be
+ * included as part of the SAS token itself.
+ *
+ * **REST integration**
+ *
+ * Use the generated SAS query string with Azure Storage requests built
+ * using `Chilkat.Rest` or other Chilkat HTTP workflows.
+ *
+ * **Common pattern:**
+ * Create an `AuthAzureSAS` object, set the Azure Storage
+ * `AccessKey`, provide the required `StringToSign`, add
+ * SAS token parameters with `SetTokenParam`, add any extra query
+ * parameters with `SetNonTokenParam`, then call
+ * `GenerateToken`. Use `AuthAzureSAS` when you need a SAS
+ * query token; use `Chilkat.AuthAzureStorage` when you need Shared
+ * Key authorization headers instead.
+ *
+ * For an extended overview, see
+ * [AuthAzureSAS Class Overview](https://www.chilkatsoft.com/authazuresas_class_overview.asp).
+ *
+ * Each `AuthAzureSAS` 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 AuthAzureSAS()`.
+ */
+export interface AuthAzureSAS 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
+
+  /**
+   * Defines the format of the string to sign.
+   *
+   * The format is specified as a comma-separated list of names. For example:
+   *
+   * ```
+   * signedpermissions,signedstart,signedexpiry,canonicalizedresource,signedidentifier,signedIP,signedProtocol,signedversion,rscc,rscd,rsce,rscl,rsct
+   * ```
+   *
+   * This will result in an actual string-to-sign that is composed of the values for each name
+   * separated by newline (LF) chars. For example:
+   *
+   * ```
+   * signedpermissions + \n +
+   * signedstart + \n +
+   * signedexpiry + \n +
+   * canonicalizedresource + \n +
+   * signedidentifier + \n +
+   * signedIP + \n +
+   * signedProtocol + \n +
+   * signedversion + \n +
+   * rscc + \n +
+   * rscd + \n +
+   * rsce + \n +
+   * rscl + \n +
+   * rsct
+   * ```
+   */
+  stringToSign: string
+
+  /**
+   * This is the signing key (access key) that must be kept private. It is a base64 string such as
+   * `abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4Y2eaw==`
+   */
+  accessKey: string
+
+  // ---- Methods ----
+
+  /**
+   * Adds a token parameter name/value. This is a value that is included in the string to sign, and
+   * is also included in the token query params.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link AuthAzureSAS.lastErrorText}.
+   */
+  setTokenParam(name: string, authParamName: string, value: string): void
+
+  /**
+   * Adds a non-token parameter name/value. This is a value that is included in the string to sign,
+   * but is NOT included in the token query params.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link AuthAzureSAS.lastErrorText}.
+   */
+  setNonTokenParam(name: string, value: string): void
+
+  /**
+   * Generates and returns the SAS token based on the defined {@link AuthAzureSAS.stringToSign} and
+   * params.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link AuthAzureSAS.lastErrorText}.
+   */
+  generateToken(): string
+
+  /**
+   * Clears all params set by the methods SetNonTokenParam and SetTokenParam.
+   */
+  clear(): void
+}

package/src/specs/AuthAzureStorage.nitro.ts

@@ -0,0 +1,172 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+
+/**
+ * Authenticate Azure Storage REST requests with account-key Shared Key signing.
+ *
+ * `AuthAzureStorage` is a credential object for Azure
+ * Storage Services authentication. It stores the storage account name, Base64
+ * account access key, Azure Storage service type, authentication scheme, and
+ * `x-ms-version` API version used when signing REST requests for
+ * Blob, Queue, File, or Table storage.
+ *
+ * **Azure Storage credentials**
+ *
+ * Hold the storage account name and Base64 account access key used to sign
+ * Azure Storage REST requests.
+ *
+ * **Shared Key signing**
+ *
+ * Configure Azure Storage authentication using `SharedKey` or
+ * `SharedKeyLite`, depending on the service and request style.
+ *
+ * **Service targeting**
+ *
+ * Specify the Azure Storage service being accessed, such as
+ * `Blob`, `Queue`, `File`, or
+ * `Table`.
+ *
+ * **API version header**
+ *
+ * Set the `x-ms-version` value required by the Azure Storage
+ * REST API version being used.
+ *
+ * **REST integration**
+ *
+ * Use the configured object with `Chilkat.Rest` so requests are
+ * signed automatically before being sent.
+ *
+ * **Low-level control**
+ *
+ * Pair this authentication object with manually constructed REST requests
+ * when application code needs direct control over Azure Storage operations.
+ *
+ * **Common pattern:**
+ * Create an `AuthAzureStorage` object, set the storage
+ * `Account`, Base64 `AccessKey`, `Service`,
+ * `Scheme`, and `XMsVersion`, then attach it to a
+ * `Chilkat.Rest` request workflow. Use
+ * `AuthAzureStorage` for Shared Key authorization headers; use
+ * `Chilkat.AuthAzureSAS` when the request should be authorized with
+ * a SAS query token instead.
+ *
+ * For an extended overview, see
+ * [AuthAzureStorage Class
+ * Overview](https://www.chilkatsoft.com/authazurestorage_class_overview.asp).
+ *
+ * Each `AuthAzureStorage` 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 AuthAzureStorage()`.
+ */
+export interface AuthAzureStorage 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
+
+  /**
+   * A valid base64 access key for the Azure storage account.
+   */
+  accessKey: string
+
+  /**
+   * The Azure storage account name. (A storage account can contain zero or more containers. A
+   * container contains properties, metadata, and zero or more blobs. A blob is any single entity
+   * comprised of binary data, properties, and metadata. )
+   */
+  account: string
+
+  /**
+   * Can be `SharedKey` or `SharedKeyLite`.   The default value is `SharedKey`.
+   */
+  scheme: string
+
+  /**
+   * Can be `Blob`, `Queue`, `File`, or `Table`.  The default is `Blob`.
+   *
+   * **Note:** Authentication for the `Table` service did not work in versions prior to v9.5.0.83.
+   */
+  service: string
+
+  /**
+   * If set, automatically adds the `x-ms-version` HTTP request header to Azure Storage requests.
+   * The default value is `2014-02-14`.
+   */
+  xMsVersion: string
+
+  // ---- Methods ----
+
+  /**
+   * Does nothing.  For technical reasons, all Chilkat classes must have at least one method.
+   */
+  noop(): void
+}