@openwallet-foundation/askar-nodejs 0.7.0-alpha-20261028112522 → 0.7.0-alpha-20261028113056

package/build/index.d.mts

@@ -0,0 +1,111 @@
+import { AeadParams, ArcHandle, Argon2DerivePasswordOptions, Askar, AskarErrorObject, EncryptedBuffer, EntryListCountOptions, EntryListFreeOptions, EntryListGetCategoryOptions, EntryListGetNameOptions, EntryListGetTagsOptions, EntryListGetValueOptions, EntryListHandle, Jwk, Key, KeyAeadDecryptOptions, KeyAeadEncryptOptions, KeyAeadGetPaddingOptions, KeyAeadGetParamsOptions, KeyAeadRandomNonceOptions, KeyConvertOptions, KeyCryptoBoxOpenOptions, KeyCryptoBoxOptions, KeyCryptoBoxSealOpenOptions, KeyCryptoBoxSealOptions, KeyDeriveEcdh1puOptions, KeyDeriveEcdhEsOptions, KeyEntryListCountOptions, KeyEntryListFreeOptions, KeyEntryListGetAlgorithmOptions, KeyEntryListGetMetadataOptions, KeyEntryListGetNameOptions, KeyEntryListGetTagsOptions, KeyEntryListHandle, KeyEntryListLoadLocalOptions, KeyFreeOptions, KeyFromJwkOptions, KeyFromKeyExchangeOptions, KeyFromPublicBytesOptions, KeyFromSecretBytesOptions, KeyFromSeedOptions, KeyGenerateOptions, KeyGetAlgorithmOptions, KeyGetEphemeralOptions, KeyGetJwkPublicOptions, KeyGetJwkSecretOptions, KeyGetJwkThumbprintOptions, KeyGetPublicBytesOptions, KeyGetSecretBytesOptions, KeySignMessageOptions, KeyUnwrapKeyOptions, KeyVerifySignatureOptions, KeyWrapKeyOptions, LocalKeyHandle, MigrateIndySdkOptions, ScanFreeOptions, ScanHandle, ScanNextOptions, ScanStartOptions, SessionCloseOptions, SessionCountOptions, SessionFetchAllKeysOptions, SessionFetchAllOptions, SessionFetchKeyOptions, SessionFetchOptions, SessionHandle, SessionInsertKeyOptions, SessionRemoveAllOptions, SessionRemoveKeyOptions, SessionStartOptions, SessionUpdateKeyOptions, SessionUpdateOptions, SetCustomLoggerOptions, SetMaxLogLevelOptions, StoreCloseOptions, StoreCopyProfileOptions, StoreCopyToOptions, StoreCreateProfileOptions, StoreGenerateRawKeyOptions, StoreGetDefaultProfileOptions, StoreGetProfileNameOptions, StoreHandle, StoreListProfilesOptions, StoreListScansOptions, StoreListSessionsOptions, StoreOpenOptions, StoreProvisionOptions, StoreRekeyOptions, StoreRemoveOptions, StoreRemoveProfileOptions, StoreRenameProfileOptions, StoreSetDefaultProfileOptions } from "@openwallet-foundation/askar-shared";
+import * as koffi from "koffi";
+export * from "@openwallet-foundation/askar-shared";
+type TypeSpec = Parameters<typeof koffi.out>[0];
+declare const nativeBindings: Record<string, [TypeSpec, Array<TypeSpec>]>;
+type NativeMethods = Record<keyof typeof nativeBindings, (...args: unknown[]) => any>;
+declare class NodeJSAskar implements Askar {
+  private callbackId;
+  private promisify;
+  /**
+   * Fetch the error from the native library and throw it as a JS error
+   *
+   * NOTE:
+   * Checks whether the error code of the returned error matches the error code that was passed to the function.
+   * If it doesn't, we throw an error with the original errorCode, and a custom message explaining we weren't able
+   * to retrieve the error message from the native library. This should however not break functionality as long as
+   * error codes are used rather than error messages for error handling.
+   *
+   */
+  private getAskarError;
+  private handleError;
+  private handleListFree;
+  get nativeAskar(): NativeMethods;
+  version(): string;
+  getCurrentError(): AskarErrorObject;
+  clearCustomLogger(): void;
+  setCustomLogger({ logLevel, logger }: SetCustomLoggerOptions): void;
+  setDefaultLogger(): void;
+  setMaxLogLevel(options: SetMaxLogLevelOptions): void;
+  argon2DerivePassword(options: Argon2DerivePasswordOptions): Uint8Array;
+  entryListCount(options: EntryListCountOptions): number;
+  entryListFree(options: EntryListFreeOptions): void;
+  entryListGetCategory(options: EntryListGetCategoryOptions): string;
+  entryListGetName(options: EntryListGetNameOptions): string;
+  entryListGetTags(options: EntryListGetTagsOptions): string | null;
+  entryListGetValue(options: EntryListGetValueOptions): Uint8Array;
+  keyAeadDecrypt(options: KeyAeadDecryptOptions): Uint8Array;
+  keyAeadEncrypt(options: KeyAeadEncryptOptions): EncryptedBuffer;
+  keyAeadGetPadding(options: KeyAeadGetPaddingOptions): number;
+  keyAeadGetParams(options: KeyAeadGetParamsOptions): AeadParams;
+  keyAeadRandomNonce(options: KeyAeadRandomNonceOptions): Uint8Array;
+  keyConvert(options: KeyConvertOptions): LocalKeyHandle;
+  keyCryptoBox(options: KeyCryptoBoxOptions): Uint8Array;
+  keyCryptoBoxOpen(options: KeyCryptoBoxOpenOptions): Uint8Array;
+  keyCryptoBoxRandomNonce(): Uint8Array;
+  keyCryptoBoxSeal(options: KeyCryptoBoxSealOptions): Uint8Array;
+  keyCryptoBoxSealOpen(options: KeyCryptoBoxSealOpenOptions): Uint8Array;
+  keyDeriveEcdh1pu(options: KeyDeriveEcdh1puOptions): LocalKeyHandle;
+  keyDeriveEcdhEs(options: KeyDeriveEcdhEsOptions): LocalKeyHandle;
+  keyEntryListCount(options: KeyEntryListCountOptions): number;
+  keyEntryListFree(options: KeyEntryListFreeOptions): void;
+  keyEntryListGetAlgorithm(options: KeyEntryListGetAlgorithmOptions): string;
+  keyEntryListGetMetadata(options: KeyEntryListGetMetadataOptions): string | null;
+  keyEntryListGetName(options: KeyEntryListGetNameOptions): string;
+  keyEntryListGetTags(options: KeyEntryListGetTagsOptions): string | null;
+  keyEntryListLoadLocal(options: KeyEntryListLoadLocalOptions): LocalKeyHandle;
+  keyFree(options: KeyFreeOptions): void;
+  keyFromJwk(options: KeyFromJwkOptions): LocalKeyHandle;
+  keyFromKeyExchange(options: KeyFromKeyExchangeOptions): LocalKeyHandle;
+  keyFromPublicBytes(options: KeyFromPublicBytesOptions): LocalKeyHandle;
+  keyFromSecretBytes(options: KeyFromSecretBytesOptions): LocalKeyHandle;
+  keyFromSeed(options: KeyFromSeedOptions): LocalKeyHandle;
+  keyGenerate(options: KeyGenerateOptions): LocalKeyHandle;
+  keyGetAlgorithm(options: KeyGetAlgorithmOptions): string;
+  keyGetEphemeral(options: KeyGetEphemeralOptions): number;
+  keyGetJwkPublic(options: KeyGetJwkPublicOptions): string;
+  keyGetJwkSecret(options: KeyGetJwkSecretOptions): Uint8Array;
+  keyGetJwkThumbprint(options: KeyGetJwkThumbprintOptions): string;
+  keyGetPublicBytes(options: KeyGetPublicBytesOptions): Uint8Array;
+  keyGetSecretBytes(options: KeyGetSecretBytesOptions): Uint8Array;
+  keySignMessage(options: KeySignMessageOptions): Uint8Array;
+  keyUnwrapKey(options: KeyUnwrapKeyOptions): LocalKeyHandle;
+  keyVerifySignature(options: KeyVerifySignatureOptions): boolean;
+  keyWrapKey(options: KeyWrapKeyOptions): EncryptedBuffer;
+  keyGetSupportedBackends(): string[];
+  scanFree(options: ScanFreeOptions): void;
+  scanNext(options: ScanNextOptions): Promise<EntryListHandle | null>;
+  scanStart(options: ScanStartOptions): Promise<ScanHandle>;
+  sessionClose(options: SessionCloseOptions): Promise<void>;
+  sessionCount(options: SessionCountOptions): Promise<number>;
+  sessionFetch(options: SessionFetchOptions): Promise<EntryListHandle | null>;
+  sessionFetchAll(options: SessionFetchAllOptions): Promise<EntryListHandle | null>;
+  sessionFetchAllKeys(options: SessionFetchAllKeysOptions): Promise<KeyEntryListHandle | null>;
+  sessionFetchKey(options: SessionFetchKeyOptions): Promise<KeyEntryListHandle | null>;
+  sessionInsertKey(options: SessionInsertKeyOptions): Promise<void>;
+  sessionRemoveAll(options: SessionRemoveAllOptions): Promise<number>;
+  sessionRemoveKey(options: SessionRemoveKeyOptions): Promise<void>;
+  sessionStart(options: SessionStartOptions): Promise<SessionHandle>;
+  sessionUpdate(options: SessionUpdateOptions): Promise<void>;
+  sessionUpdateKey(options: SessionUpdateKeyOptions): Promise<void>;
+  storeClose(options: StoreCloseOptions): Promise<void>;
+  storeCopyTo(options: StoreCopyToOptions): Promise<StoreHandle>;
+  storeCreateProfile(options: StoreCreateProfileOptions): Promise<string>;
+  storeGenerateRawKey(options: StoreGenerateRawKeyOptions): string;
+  storeGetDefaultProfile(options: StoreGetDefaultProfileOptions): Promise<string>;
+  storeGetProfileName(options: StoreGetProfileNameOptions): Promise<string>;
+  storeListProfiles(options: StoreListProfilesOptions): Promise<string[]>;
+  storeListScans(options: StoreListScansOptions): Promise<ScanHandle[]>;
+  storeListSessions(options: StoreListSessionsOptions): Promise<SessionHandle[]>;
+  storeOpen(options: StoreOpenOptions): Promise<StoreHandle>;
+  storeProvision(options: StoreProvisionOptions): Promise<StoreHandle>;
+  storeRekey(options: StoreRekeyOptions): Promise<void>;
+  storeRemove(options: StoreRemoveOptions): Promise<number>;
+  storeRemoveProfile(options: StoreRemoveProfileOptions): Promise<number>;
+  storeSetDefaultProfile(options: StoreSetDefaultProfileOptions): Promise<void>;
+  storeRenameProfile(options: StoreRenameProfileOptions): Promise<number>;
+  storeCopyProfile(options: StoreCopyProfileOptions): Promise<void>;
+  migrateIndySdk(options: MigrateIndySdkOptions): Promise<void>;
+}
+export declare const askarNodeJS: NodeJSAskar;
+//# sourceMappingURL=index.d.mts.map