@sudoplatform/sudo-common 7.1.3 → 8.0.0

package/cjs/sudoKeyManager/sudoKeyManager.d.ts

@@ -0,0 +1,344 @@
+import { KeyData } from './keyData';
+import { PublicKey } from './publicKey';
+import { AsymmetricEncryptionOptions, SudoCryptoProvider, SymmetricEncryptionOptions } from './sudoCryptoProvider';
+/**
+ * Interface for a set of methods for securely storing keys and performing
+ * cryptographic operations.
+ */
+export interface SudoKeyManager {
+    readonly namespace: string;
+    readonly serviceName: string;
+    /**
+     * Adds as password to the secure store.
+     *
+     * @param password
+     * @param name
+     */
+    addPassword(password: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Retrieves a password from the secure store.
+     *
+     * @param name The name of the password to retrieve
+     *
+     * @returns The password or undefined if the password was not found.
+     */
+    getPassword(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Deletes a password from the secure store.
+     *
+     * @param name
+     */
+    deletePassword(name: string): Promise<void>;
+    /**
+     * Updates a password stored in the secure store.
+     *
+     * @param password
+     * @param name
+     */
+    updatePassword(password: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Adds a symmetric key to the secure store.
+     *
+     * @param key The symmetric key.
+     * @param name The name for the symmetric key.
+     */
+    addSymmetricKey(key: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Retrieves a symmetric key from the secure store.
+     *
+     * @param name The name of the symmetric key.
+     *
+     * @returns The symmetric key or undefined if not found.
+     */
+    getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Checks to see if the specified symmetric key exists.
+     *
+     * @param name The name of the symmetric key.
+     */
+    doesSymmetricKeyExist(name: string): Promise<boolean>;
+    /**
+     * Deletes a symmetric key from the secure store.
+     *
+     * @param name The name of the symmetric key.
+     */
+    deleteSymmetricKey(name: string): Promise<void>;
+    /**
+     * Adds a private key to the secure store.
+     *
+     * @param key The private key to store securely.
+     * @param name The name of the private key to be stored.
+     */
+    addPrivateKey(key: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Retrieves a private key from the secure store.
+     *
+     * @param name The name of the private key to be retrieved.
+     *
+     * @returns Requested private key or undefined if the key was not found.
+     */
+    getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Checks to see if the specified private key exists.
+     *
+     * @param name The name of the private key.
+     */
+    doesPrivateKeyExist(name: string): Promise<boolean>;
+    /**
+     * Adds a public key to the secure store.
+     *
+     * The format of the public key should be SubjectPublicKeyInfo (spki)
+     *
+     * @param key The public key to store securely.
+     * @param name The name of the public key to be stored.
+     */
+    addPublicKey(key: ArrayBuffer, name: string): Promise<void>;
+    /**
+     * Deletes the specified public key from the secure store.
+     *
+     * @param name The name of the public key to be removed.
+     */
+    deletePublicKey(name: string): Promise<void>;
+    /**
+     * Retrieves the public key from the secure store.
+     *
+     * The format of the public key is SubjectPublicKeyInfo (spki)
+     *
+     * @param name The name of the public key.
+     *
+     * @returns The public key or undefined if the key was not found.
+     */
+    getPublicKey(name: string): Promise<PublicKey | undefined>;
+    /**
+     * Deletes a key pair from the secure store.
+     *
+     * @param name The name of the key pair to be deleted.
+     */
+    deleteKeyPair(name: string): Promise<void>;
+    /**
+     * Generates a signature for the given data with the specified private key.
+     *
+     * @param name The name of the private key to use for generation.
+     * @param data The data to sign.
+     *
+     * @returns Data signature or undefined if the private key is not found.
+     */
+    generateSignatureWithPrivateKey(name: string, data: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Verifies the given data against the provided signature using the specified public key.
+     *
+     * @param name The name of the public key to use for validation.
+     * @param data The data to verify
+     * @param signature The signature to verify against
+     *
+     * @returns True if the data and signature could be successfully verified
+     */
+    verifySignatureWithPublicKey(name: string, data: ArrayBuffer, signature: ArrayBuffer): Promise<boolean>;
+    /**
+     * @deprecated Use version with `options` param.
+     *
+     * Encrypts the given data with the specified key
+     *
+     * @param name The name of the symmetric key to use to encrypt.
+     * @param data Data to encrypt.
+     * @param iv Optional Initialization Vector.
+     *
+     * @returns Encrypted data and IV
+     */
+    encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Encrypts the given data with the specified key
+     *
+     * @param name The name of the symmetric key to use to encrypt.
+     * @param data Data to encrypt.
+     *
+     * @returns Encrypted data and IV
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     */
+    encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * @deprecated Use version with `options` param.
+     *
+     * Decrypt the given data with the given symmetric key
+     *
+     * @param key The symmetric key to use to decrypt the data.
+     * @param encryptedData The encrypted data.
+     * @param iv Optional Initialization Vector.
+     *
+     * @returns Decrypted data
+     */
+    decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Decrypt the given data with the given symmetric key
+     *
+     * @param key The symmetric key to use to decrypt the data.
+     * @param encryptedData The encrypted data.
+     *
+     * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     */
+    decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * @deprecated Use version with `options` param.
+     *
+     * Decrypt the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to decrypt.
+     * @param data The data to decrypt.
+     * @param iv Optional Initialization Vector.
+     *
+     * @returns Decrypted data
+     */
+    encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Decrypt the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to decrypt.
+     * @param data The data to decrypt.
+     *
+     * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     */
+    encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * @deprecated Use version with `options` param.
+     * Decrypt the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to decrypt.
+     * @param data The data to decrypt.
+     * @param iv Optional Initialization Vector.
+     *
+     * @returns Decrypted data
+     */
+    decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Decrypt the given data with the specified symmetric key stored in the secure store.
+     *
+     * @param name The name of the symmetric key to use to decrypt.
+     * @param data The data to decrypt.
+     *
+     * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     */
+    decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * Encrypts the given data with the specified public key.
+     *
+     * @param name The name of the public key to use for encryption.
+     * @param data The data to encrypt.
+     *
+     * @returns Encrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     */
+    encryptWithPublicKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    /**
+     * Decrypts the given data with the specified private key.
+     *
+     * @param name The name of the private key to use for decryption.
+     * @param data The data to decrypt.
+     *
+     * @returns Decrypted data or undefined if the private key is not found.
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
+     */
+    decryptWithPrivateKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer | undefined>;
+    /**
+     * Remove all keys associated with this `SudoKeyManager`
+     */
+    removeAllKeys(): Promise<void>;
+    /**
+     * Generates and securely stores a symmetric key.
+     *
+     * @param name The name of the symmetric key.
+     */
+    generateSymmetricKey(name: string): Promise<void>;
+    /**
+     * Generates a symmetric key, derived from a password using PBKDF2.
+     *
+     * @param name The name to store the symmetric key as
+     * @param password The password from which to generate the symmetric key
+     * @param salt Salt to use in generation of the key
+     * @param rounds The number of rounds of PBKDF2 to perform. Default: per getDefaultPBKDF2Rounds
+     *
+     * @returns The generated symmetric key.
+     */
+    generateSymmetricKeyFromPassword(password: ArrayBuffer, salt: ArrayBuffer, options?: {
+        rounds?: number;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Generate random bytes using a secure random number generator.
+     *
+     * @param size Number of random bytes to generate
+     *
+     * @returns ArrayBuffer containing the random bytes.
+     */
+    generateRandomData(size: number): Promise<ArrayBuffer>;
+    /**
+     * Creates a SHA256 hash of the specified data.
+     *
+     * @param data Data to hash.
+     */
+    generateHash(data: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Generates and securely stores a key pair for public key cryptography.
+     *
+     * The public key is exported as `SubjectPublicKeyInfo (spki)
+     * The private key is exported as `pkcs8`
+     *
+     * @param name The name of the key pair to be generated.
+     */
+    generateKeyPair(name: string): Promise<void>;
+    /**
+     * Export all contents of the key manager as an array of KeyArchiveKeyInfo
+     * ready for archive.
+     */
+    exportKeys(): Promise<KeyData[]>;
+}
+export declare class DefaultSudoKeyManager implements SudoKeyManager {
+    private readonly sudoCryptoProvider;
+    /**
+     * @param namespace A namespace to use as part of the key name.  If a namespace is specified then
+     * a unique identifier for each key will be `<namespace>.<keyName>`. Namespace cannot be an empty string.
+     * @param sudoCryptoProvider
+     */
+    constructor(sudoCryptoProvider: SudoCryptoProvider);
+    get serviceName(): string;
+    get namespace(): string;
+    addPassword(password: ArrayBuffer, name: string): Promise<void>;
+    getPassword(name: string): Promise<ArrayBuffer | undefined>;
+    deletePassword(name: string): Promise<void>;
+    updatePassword(password: ArrayBuffer, name: string): Promise<void>;
+    addSymmetricKey(key: ArrayBuffer, name: string): Promise<void>;
+    getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
+    doesSymmetricKeyExist(name: string): Promise<boolean>;
+    deleteSymmetricKey(name: string): Promise<void>;
+    generateKeyPair(name: string): Promise<void>;
+    addPrivateKey(key: ArrayBuffer, name: string): Promise<void>;
+    getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
+    doesPrivateKeyExist(name: string): Promise<boolean>;
+    addPublicKey(key: ArrayBuffer, name: string): Promise<void>;
+    deletePublicKey(name: string): Promise<void>;
+    getPublicKey(name: string): Promise<PublicKey | undefined>;
+    deleteKeyPair(name: string): Promise<void>;
+    generateSignatureWithPrivateKey(name: string, data: ArrayBuffer): Promise<ArrayBuffer>;
+    verifySignatureWithPublicKey(name: string, data: ArrayBuffer, signature: ArrayBuffer): Promise<boolean>;
+    encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    encryptWithPublicKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
+    decryptWithPrivateKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer | undefined>;
+    removeAllKeys(): Promise<void>;
+    generateSymmetricKey(name: string): Promise<void>;
+    generateSymmetricKeyFromPassword(password: ArrayBuffer, salt: ArrayBuffer, options?: {
+        rounds?: number;
+    }): Promise<ArrayBuffer>;
+    generateRandomData(size: number): Promise<ArrayBuffer>;
+    generateHash(data: ArrayBuffer): Promise<ArrayBuffer>;
+    exportKeys(): Promise<KeyData[]>;
+}

package/cjs/sudoKeyManager/sudoKeyManager.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultSudoKeyManager = void 0;
+const buffer_1 = require("../utils/buffer");
+class DefaultSudoKeyManager {
+    /**
+     * @param namespace A namespace to use as part of the key name.  If a namespace is specified then
+     * a unique identifier for each key will be `<namespace>.<keyName>`. Namespace cannot be an empty string.
+     * @param sudoCryptoProvider
+     */
+    constructor(sudoCryptoProvider) {
+        this.sudoCryptoProvider = sudoCryptoProvider;
+    }
+    get serviceName() {
+        return this.sudoCryptoProvider.getServiceName();
+    }
+    get namespace() {
+        return this.sudoCryptoProvider.getNamespace();
+    }
+    addPassword(password, name) {
+        return this.sudoCryptoProvider.addPassword(password, name);
+    }
+    getPassword(name) {
+        return this.sudoCryptoProvider.getPassword(name);
+    }
+    deletePassword(name) {
+        return this.sudoCryptoProvider.deletePassword(name);
+    }
+    updatePassword(password, name) {
+        return this.sudoCryptoProvider.updatePassword(password, name);
+    }
+    addSymmetricKey(key, name) {
+        return this.sudoCryptoProvider.addSymmetricKey(key, name);
+    }
+    getSymmetricKey(name) {
+        return this.sudoCryptoProvider.getSymmetricKey(name);
+    }
+    doesSymmetricKeyExist(name) {
+        return this.sudoCryptoProvider.doesSymmetricKeyExist(name);
+    }
+    deleteSymmetricKey(name) {
+        return this.sudoCryptoProvider.deleteSymmetricKey(name);
+    }
+    generateKeyPair(name) {
+        return this.sudoCryptoProvider.generateKeyPair(name);
+    }
+    addPrivateKey(key, name) {
+        return this.sudoCryptoProvider.addPrivateKey(key, name);
+    }
+    getPrivateKey(name) {
+        return this.sudoCryptoProvider.getPrivateKey(name);
+    }
+    doesPrivateKeyExist(name) {
+        return this.sudoCryptoProvider.doesPrivateKeyExist(name);
+    }
+    addPublicKey(key, name) {
+        return this.sudoCryptoProvider.addPublicKey(key, name);
+    }
+    deletePublicKey(name) {
+        return this.sudoCryptoProvider.deletePublicKey(name);
+    }
+    getPublicKey(name) {
+        return this.sudoCryptoProvider.getPublicKey(name);
+    }
+    deleteKeyPair(name) {
+        return this.sudoCryptoProvider.deleteKeyPair(name);
+    }
+    generateSignatureWithPrivateKey(name, data) {
+        return this.sudoCryptoProvider.generateSignatureWithPrivateKey(name, data);
+    }
+    verifySignatureWithPublicKey(name, data, signature) {
+        return this.sudoCryptoProvider.verifySignatureWithPublicKey(name, data, signature);
+    }
+    encryptWithSymmetricKey(key, data, ivOrOptions) {
+        if (buffer_1.Buffer.isArrayBuffer(ivOrOptions)) {
+            return this.sudoCryptoProvider.encryptWithSymmetricKey(key, data, {
+                iv: ivOrOptions,
+            });
+        }
+        else {
+            return this.sudoCryptoProvider.encryptWithSymmetricKey(key, data, ivOrOptions);
+        }
+    }
+    decryptWithSymmetricKey(key, data, ivOrOptions) {
+        if (buffer_1.Buffer.isArrayBuffer(ivOrOptions)) {
+            return this.sudoCryptoProvider.decryptWithSymmetricKey(key, data, {
+                iv: ivOrOptions,
+            });
+        }
+        else {
+            return this.sudoCryptoProvider.decryptWithSymmetricKey(key, data, ivOrOptions);
+        }
+    }
+    encryptWithSymmetricKeyName(name, data, ivOrOptions) {
+        if (buffer_1.Buffer.isArrayBuffer(ivOrOptions)) {
+            return this.sudoCryptoProvider.encryptWithSymmetricKeyName(name, data, {
+                iv: ivOrOptions,
+            });
+        }
+        else {
+            return this.sudoCryptoProvider.encryptWithSymmetricKeyName(name, data, ivOrOptions);
+        }
+    }
+    decryptWithSymmetricKeyName(name, data, ivOrOptions) {
+        if (buffer_1.Buffer.isArrayBuffer(ivOrOptions)) {
+            return this.sudoCryptoProvider.decryptWithSymmetricKeyName(name, data, {
+                iv: ivOrOptions,
+            });
+        }
+        else {
+            return this.sudoCryptoProvider.decryptWithSymmetricKeyName(name, data, ivOrOptions);
+        }
+    }
+    encryptWithPublicKey(name, data, options) {
+        return this.sudoCryptoProvider.encryptWithPublicKey(name, data, options);
+    }
+    decryptWithPrivateKey(name, data, options) {
+        return this.sudoCryptoProvider.decryptWithPrivateKey(name, data, options);
+    }
+    removeAllKeys() {
+        return this.sudoCryptoProvider.removeAllKeys();
+    }
+    generateSymmetricKey(name) {
+        return this.sudoCryptoProvider.generateSymmetricKey(name);
+    }
+    generateSymmetricKeyFromPassword(password, salt, options) {
+        return this.sudoCryptoProvider.generateSymmetricKeyFromPassword(password, salt, options);
+    }
+    generateRandomData(size) {
+        return this.sudoCryptoProvider.generateRandomData(size);
+    }
+    generateHash(data) {
+        return this.sudoCryptoProvider.generateHash(data);
+    }
+    exportKeys() {
+        return this.sudoCryptoProvider.exportKeys();
+    }
+}
+exports.DefaultSudoKeyManager = DefaultSudoKeyManager;
+//# sourceMappingURL=sudoKeyManager.js.map

package/cjs/sudoKeyManager/sudoKeyManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sudoKeyManager.js","sourceRoot":"","sources":["../../src/sudoKeyManager/sudoKeyManager.ts"],"names":[],"mappings":";;;AAAA,4CAAsD;AAsYtD,MAAa,qBAAqB;IAChC;;;;OAIG;IACH,YAA6B,kBAAsC;QAAtC,uBAAkB,GAAlB,kBAAkB,CAAoB;IAAG,CAAC;IAEvE,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,CAAA;IACjD,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAA;IAC/C,CAAC;IAEM,WAAW,CAAC,QAAqB,EAAE,IAAY;QACpD,OAAO,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC5D,CAAC;IAEM,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAClD,CAAC;IAEM,cAAc,CAAC,IAAY;QAChC,OAAO,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;IACrD,CAAC;IAEM,cAAc,CAAC,QAAqB,EAAE,IAAY;QACvD,OAAO,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC/D,CAAC;IAEM,eAAe,CAAC,GAAgB,EAAE,IAAY;QACnD,OAAO,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IAC3D,CAAC;IAEM,eAAe,CAAC,IAAY;QACjC,OAAO,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;IACtD,CAAC;IAEM,qBAAqB,CAAC,IAAY;QACvC,OAAO,IAAI,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;IAC5D,CAAC;IAEM,kBAAkB,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;IACzD,CAAC;IAEM,eAAe,CAAC,IAAY;QACjC,OAAO,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;IACtD,CAAC;IAEM,aAAa,CAAC,GAAgB,EAAE,IAAY;QACjD,OAAO,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IACzD,CAAC;IAEM,aAAa,CAAC,IAAY;QAC/B,OAAO,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;IACpD,CAAC;IAEM,mBAAmB,CAAC,IAAY;QACrC,OAAO,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;IAC1D,CAAC;IAEM,YAAY,CAAC,GAAgB,EAAE,IAAY;QAChD,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IACxD,CAAC;IAEM,eAAe,CAAC,IAAY;QACjC,OAAO,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;IACtD,CAAC;IAEM,YAAY,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACnD,CAAC;IAEM,aAAa,CAAC,IAAY;QAC/B,OAAO,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;IACpD,CAAC;IAEM,+BAA+B,CACpC,IAAY,EACZ,IAAiB;QAEjB,OAAO,IAAI,CAAC,kBAAkB,CAAC,+BAA+B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC5E,CAAC;IAED,4BAA4B,CAC1B,IAAY,EACZ,IAAiB,EACjB,SAAsB;QAEtB,OAAO,IAAI,CAAC,kBAAkB,CAAC,4BAA4B,CACzD,IAAI,EACJ,IAAI,EACJ,SAAS,CACV,CAAA;IACH,CAAC;IAEM,uBAAuB,CAC5B,GAAgB,EAChB,IAAiB,EACjB,WAAsD;QAEtD,IAAI,eAAU,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,GAAG,EAAE,IAAI,EAAE;gBAChE,EAAE,EAAE,WAAW;aAChB,CAAC,CAAA;SACH;aAAM;YACL,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAuB,CACpD,GAAG,EACH,IAAI,EACJ,WAAW,CACZ,CAAA;SACF;IACH,CAAC;IAEM,uBAAuB,CAC5B,GAAgB,EAChB,IAAiB,EACjB,WAAsD;QAEtD,IAAI,eAAU,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,GAAG,EAAE,IAAI,EAAE;gBAChE,EAAE,EAAE,WAAW;aAChB,CAAC,CAAA;SACH;aAAM;YACL,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAuB,CACpD,GAAG,EACH,IAAI,EACJ,WAAW,CACZ,CAAA;SACF;IACH,CAAC;IAEM,2BAA2B,CAChC,IAAY,EACZ,IAAiB,EACjB,WAAsD;QAEtD,IAAI,eAAU,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,IAAI,EAAE,IAAI,EAAE;gBACrE,EAAE,EAAE,WAAW;aAChB,CAAC,CAAA;SACH;aAAM;YACL,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAA2B,CACxD,IAAI,EACJ,IAAI,EACJ,WAAW,CACZ,CAAA;SACF;IACH,CAAC;IAEM,2BAA2B,CAChC,IAAY,EACZ,IAAiB,EACjB,WAAsD;QAEtD,IAAI,eAAU,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,IAAI,EAAE,IAAI,EAAE;gBACrE,EAAE,EAAE,WAAW;aAChB,CAAC,CAAA;SACH;aAAM;YACL,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAA2B,CACxD,IAAI,EACJ,IAAI,EACJ,WAAW,CACZ,CAAA;SACF;IACH,CAAC;IAEM,oBAAoB,CACzB,IAAY,EACZ,IAAiB,EACjB,OAAqC;QAErC,OAAO,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IAC1E,CAAC;IAEM,qBAAqB,CAC1B,IAAY,EACZ,IAAiB,EACjB,OAAqC;QAErC,OAAO,IAAI,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IAC3E,CAAC;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,kBAAkB,CAAC,aAAa,EAAE,CAAA;IAChD,CAAC;IAEM,oBAAoB,CAAC,IAAY;QACtC,OAAO,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAA;IAC3D,CAAC;IAEM,gCAAgC,CACrC,QAAqB,EACrB,IAAiB,EACjB,OAA6B;QAE7B,OAAO,IAAI,CAAC,kBAAkB,CAAC,gCAAgC,CAC7D,QAAQ,EACR,IAAI,EACJ,OAAO,CACR,CAAA;IACH,CAAC;IAEM,kBAAkB,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;IACzD,CAAC;IAEM,YAAY,CAAC,IAAiB;QACnC,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACnD,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAA;IAC7C,CAAC;CACF;AA1ND,sDA0NC"}

package/cjs/types/types.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Generic type for paginated results from list queries
+ */
+export interface ListOutput<T> {
+    items: T[];
+    nextToken?: string;
+}
+/**
+ * Cache policy that determines how data is accessed when performing a query method
+ * from the Email Service.
+ */
+export declare enum CachePolicy {
+    CacheOnly = "cache-only",
+    RemoteOnly = "network-only"
+}
+export interface Owner {
+    id: string;
+    issuer: string;
+}
+/**
+ * A filter to use on string fields when listing items in a repository
+ */
+export interface StringFilter {
+    ne?: string;
+    eq?: string;
+    beginsWith?: string;
+}
+/**
+ * A filter to use on string fields when listing items in a repository
+ */
+export interface BooleanFilter {
+    eq?: boolean;
+    ne?: boolean;
+}
+/**
+ * Encryption algorithm names that are
+ * supported by the Sudo Platform and can be used
+ * between devices.
+ */
+export declare enum EncryptionAlgorithm {
+    AesCbcPkcs7Padding = "AES/CBC/PKCS7Padding",
+    AesGcmNoPadding = "AES/GCM/NoPadding",
+    RsaOaepSha1 = "RSA/OAEPWithSHA-1"
+}
+export declare type Subset<T, S> = Pick<S, Extract<keyof T, keyof S>> & Partial<Record<Exclude<keyof T, keyof S>, never>>;
+/**
+ * Status of the list operation result.
+ */
+export declare enum ListOperationResultStatus {
+    /**
+     * The operation completed successfully.
+     */
+    Success = "Success",
+    /**
+     * The operation completed but some items had errors during
+     * processing.
+     */
+    Partial = "Partial",
+    /**
+     * The operation failed and no list item could be returned.
+     */
+    Failure = "Failure"
+}
+export interface ListOperationSuccessResult<T> {
+    /**
+     * Operation status.
+     */
+    status: ListOperationResultStatus.Success;
+    /**
+     * List of items that were successfully processed.
+     */
+    items: T[];
+    /**
+     * Pagination token.
+     */
+    nextToken?: string;
+}
+export interface ListOperationFailureResult {
+    /**
+     * Operation status.
+     */
+    status: ListOperationResultStatus.Failure;
+    /**
+     * The error that caused the failure.
+     */
+    cause: Error;
+}
+export interface ListOperationPartialResult<T, S extends Subset<S, T>> {
+    /**
+     * Operation status.
+     */
+    status: ListOperationResultStatus.Partial;
+    /**
+     * List of items that were successfully processed.
+     */
+    items: T[];
+    /**
+     * List of items that failed to be processed and the error
+     * that caused the failure.
+     */
+    failed: {
+        item: Omit<T, keyof S>;
+        cause: Error;
+    }[];
+    /**
+     * Pagination token.
+     */
+    nextToken?: string;
+}
+/**
+ * Result of a list operation. T is the expected item type and
+ * S is a subset of T's properties that won't be present if the
+ * additional processing after the item has been fetched fails.
+ */
+export declare type ListOperationResult<T, S extends Subset<S, T> = T> = ListOperationSuccessResult<T> | ListOperationFailureResult | ListOperationPartialResult<T, S>;

package/cjs/types/types.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListOperationResultStatus = exports.EncryptionAlgorithm = exports.CachePolicy = void 0;
+/**
+ * Cache policy that determines how data is accessed when performing a query method
+ * from the Email Service.
+ */
+var CachePolicy;
+(function (CachePolicy) {
+    // Use the device cached data.
+    CachePolicy["CacheOnly"] = "cache-only";
+    // Query and use the data on the server.
+    CachePolicy["RemoteOnly"] = "network-only";
+})(CachePolicy = exports.CachePolicy || (exports.CachePolicy = {}));
+/**
+ * Encryption algorithm names that are
+ * supported by the Sudo Platform and can be used
+ * between devices.
+ */
+var EncryptionAlgorithm;
+(function (EncryptionAlgorithm) {
+    EncryptionAlgorithm["AesCbcPkcs7Padding"] = "AES/CBC/PKCS7Padding";
+    EncryptionAlgorithm["AesGcmNoPadding"] = "AES/GCM/NoPadding";
+    EncryptionAlgorithm["RsaOaepSha1"] = "RSA/OAEPWithSHA-1";
+})(EncryptionAlgorithm = exports.EncryptionAlgorithm || (exports.EncryptionAlgorithm = {}));
+/**
+ * Status of the list operation result.
+ */
+var ListOperationResultStatus;
+(function (ListOperationResultStatus) {
+    /**
+     * The operation completed successfully.
+     */
+    ListOperationResultStatus["Success"] = "Success";
+    /**
+     * The operation completed but some items had errors during
+     * processing.
+     */
+    ListOperationResultStatus["Partial"] = "Partial";
+    /**
+     * The operation failed and no list item could be returned.
+     */
+    ListOperationResultStatus["Failure"] = "Failure";
+})(ListOperationResultStatus = exports.ListOperationResultStatus || (exports.ListOperationResultStatus = {}));
+//# sourceMappingURL=types.js.map

package/cjs/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":";;;AAQA;;;GAGG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,8BAA8B;IAC9B,uCAAwB,CAAA;IACxB,wCAAwC;IACxC,0CAA2B,CAAA;AAC7B,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAwBD;;;;GAIG;AACH,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,kEAA2C,CAAA;IAC3C,4DAAqC,CAAA;IACrC,wDAAiC,CAAA;AACnC,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B;AAKD;;GAEG;AACH,IAAY,yBAcX;AAdD,WAAY,yBAAyB;IACnC;;OAEG;IACH,gDAAmB,CAAA;IACnB;;;OAGG;IACH,gDAAmB,CAAA;IACnB;;OAEG;IACH,gDAAmB,CAAA;AACrB,CAAC,EAdW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAcpC"}