@sudoplatform/sudo-common 5.6.0 → 5.9.0

package/lib/errors/error.d.ts

@@ -236,6 +236,12 @@ export declare class KeyArchiveUnknownKeyTypeError extends Error {
 export declare class OperationNotImplementedError extends Error {
     constructor(message?: string);
 }
+/**
+ * Encryption algorithm is not recognized
+ */
+export declare class UnrecognizedAlgorithmError extends Error {
+    constructor(message?: string);
+}
 /**
  * Helper method for mapping an App Sync error to common errors.
  *

package/lib/errors/error.js

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.VersionMismatchError = exports.UserNotConfirmedError = exports.UnrecognizedAlgorithmError = exports.UnknownGraphQLError = exports.SignOutError = exports.ServiceError = exports.RequestFailedError = exports.RegisterError = exports.OperationNotImplementedError = exports.NotSignedInError = exports.NotRegisteredError = exports.NotAuthorizedError = exports.NoEntitlementsError = exports.LimitExceededError = exports.KeyStoreNotExportableError = exports.KeyNotFoundError = exports.KeyArchiveVersionError = exports.KeyArchiveUnknownKeyTypeError = exports.KeyArchiveTypeError = exports.KeyArchivePasswordRequiredError = exports.KeyArchiveNoPasswordRequiredError = exports.KeyArchiveMissingError = exports.KeyArchiveIncorrectPasswordError = exports.KeyArchiveDecodingError = exports.InvalidTokenError = exports.InvalidOwnershipProofError = exports.InsufficientEntitlementsError = exports.IllegalStateError = exports.IllegalArgumentError = exports.FatalError = exports.DecodeError = exports.ConfigurationSetNotFoundError = exports.ConfigurationNotSetError = exports.AuthenticationError = exports.AccountLockedError = void 0;
 exports.isAppSyncNetworkError = isAppSyncNetworkError;
 exports.mapGraphQLToClientError = mapGraphQLToClientError;
 exports.mapNetworkErrorToClientError = mapNetworkErrorToClientError;
-exports.OperationNotImplementedError = exports.KeyArchiveUnknownKeyTypeError = exports.KeyArchiveVersionError = exports.KeyArchiveTypeError = exports.KeyArchiveIncorrectPasswordError = exports.KeyArchiveDecodingError = exports.KeyArchiveNoPasswordRequiredError = exports.KeyArchivePasswordRequiredError = exports.KeyArchiveMissingError = exports.KeyStoreNotExportableError = exports.KeyNotFoundError = exports.InvalidTokenError = exports.NoEntitlementsError = exports.FatalError = exports.RequestFailedError = exports.LimitExceededError = exports.IllegalStateError = exports.IllegalArgumentError = exports.ServiceError = exports.AccountLockedError = exports.InsufficientEntitlementsError = exports.InvalidOwnershipProofError = exports.VersionMismatchError = exports.UserNotConfirmedError = exports.NotSignedInError = exports.NotAuthorizedError = exports.NotRegisteredError = exports.RegisterError = exports.SignOutError = exports.AuthenticationError = exports.DecodeError = exports.ConfigurationNotSetError = exports.ConfigurationSetNotFoundError = exports.UnknownGraphQLError = void 0;
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
@@ -526,6 +526,20 @@ class OperationNotImplementedError extends Error {
     this.name = 'OperationNotImplementedError';
   }
 
+}
+/**
+ * Encryption algorithm is not recognized
+ */
+
+
+exports.OperationNotImplementedError = OperationNotImplementedError;
+
+class UnrecognizedAlgorithmError extends Error {
+  constructor(message) {
+    super(message !== null && message !== void 0 ? message : 'Unrecognized encryption algorithm name.');
+    this.name = 'UnrecognizedAlgorithmError';
+  }
+
 }
 /**
  * Helper method for mapping an App Sync error to common errors.
@@ -537,7 +551,7 @@ class OperationNotImplementedError extends Error {
  */
 
 
-exports.OperationNotImplementedError = OperationNotImplementedError;
+exports.UnrecognizedAlgorithmError = UnrecognizedAlgorithmError;
 
 function mapGraphQLToClientError(error) {
   switch (error.errorType) {

package/lib/logging/bunyanLogger.js

@@ -3,8 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getLogLevel = getLogLevel;
 exports.createBunyanLogger = createBunyanLogger;
+exports.getLogLevel = getLogLevel;
 
 var _browserBunyan = require("browser-bunyan");
 

package/lib/sudoKeyArchive/keyArchive.js

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isSecureKeyArchive = isSecureKeyArchive;
+exports.UnrecognizedKeyArchiveCodec = exports.SecureKeyArchiveType = exports.SecureKeyArchiveCodec = exports.KeyArchiveCodec = exports.InsecureKeyArchiveType = exports.InsecureKeyArchiveCodec = exports.CURRENT_ARCHIVE_VERSION = void 0;
 exports.isInsecureKeyArchive = isInsecureKeyArchive;
+exports.isSecureKeyArchive = isSecureKeyArchive;
 exports.isUnrecognizedKeyArchive = isUnrecognizedKeyArchive;
-exports.KeyArchiveCodec = exports.SecureKeyArchiveCodec = exports.UnrecognizedKeyArchiveCodec = exports.SecureKeyArchiveType = exports.InsecureKeyArchiveCodec = exports.InsecureKeyArchiveType = exports.CURRENT_ARCHIVE_VERSION = void 0;
 
 var t = _interopRequireWildcard(require("io-ts"));
 

package/lib/sudoKeyArchive/keyInfo.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.KeyArchiveKeyInfoArrayCodec = exports.KeyArchiveKeyInfoCodec = void 0;
+exports.KeyArchiveKeyInfoCodec = exports.KeyArchiveKeyInfoArrayCodec = void 0;
 
 var t = _interopRequireWildcard(require("io-ts"));
 

package/lib/sudoKeyArchive/sudoKeyArchive.d.ts

@@ -80,7 +80,7 @@ export interface SudoKeyArchive {
     /** @return the meta-information associated with this archive in an unmodifiable map. */
     getMetaInfo(): ReadonlyMap<string, string>;
 }
-declare type KeyArchiveKeyInfoDecoded = KeyArchiveKeyInfo & {
+export declare type KeyArchiveKeyInfoDecoded = KeyArchiveKeyInfo & {
     Decoded: ArrayBuffer;
 };
 export declare class DefaultSudoKeyArchive implements SudoKeyArchive {
@@ -188,4 +188,3 @@ export declare class DefaultSudoKeyArchive implements SudoKeyArchive {
 }
 export declare function keyArchiveInfoFromKeyData(keyData: KeyData): KeyArchiveKeyInfoDecoded;
 export declare function keyArchiveKeyTypeFromKeyDataKeyType(keyDataKeyType: KeyDataKeyType): KeyArchiveKeyType;
-export {};

package/lib/sudoKeyArchive/sudoKeyArchive.js

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.DefaultSudoKeyArchive = void 0;
 exports.keyArchiveInfoFromKeyData = keyArchiveInfoFromKeyData;
 exports.keyArchiveKeyTypeFromKeyDataKeyType = keyArchiveKeyTypeFromKeyDataKeyType;
-exports.DefaultSudoKeyArchive = void 0;
 
 var _fflate = require("fflate");
 

package/lib/sudoKeyManager/keyData.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.KeyDataKeyFormat = exports.KeyDataKeyType = void 0;
+exports.KeyDataKeyType = exports.KeyDataKeyFormat = void 0;
 
 /**
  * Type of key

package/lib/sudoKeyManager/sudoCryptoProvider.d.ts

@@ -161,6 +161,8 @@ export interface SudoCryptoProvider {
      *
      *
      * @returns Encrypted data and IV
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -182,6 +184,8 @@ export interface SudoCryptoProvider {
      * @param data The data to decrypt.
      *
      * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -203,6 +207,8 @@ export interface SudoCryptoProvider {
      * @param data Data to encrypt.
      *
      * @returns Encrypted data and IV
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -224,6 +230,8 @@ export interface SudoCryptoProvider {
      * @param data The data to decrypt.
      *
      * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -233,6 +241,8 @@ export interface SudoCryptoProvider {
      * @param data The data to encrypt.
      *
      * @returns Encrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     encryptWithPublicKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -242,6 +252,8 @@ export interface SudoCryptoProvider {
      * @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>;
     /**

package/lib/sudoKeyManager/sudoKeyManager.d.ts

@@ -116,6 +116,8 @@ export interface SudoKeyManager {
      * @param data Data to encrypt.
      *
      * @returns Encrypted data and IV
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -137,6 +139,8 @@ export interface SudoKeyManager {
      * @param encryptedData The encrypted data.
      *
      * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -158,6 +162,8 @@ export interface SudoKeyManager {
      * @param data The data to decrypt.
      *
      * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -178,6 +184,8 @@ export interface SudoKeyManager {
      * @param data The data to decrypt.
      *
      * @returns Decrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -187,6 +195,8 @@ export interface SudoKeyManager {
      * @param data The data to encrypt.
      *
      * @returns Encrypted data
+     *
+     * @throws {@link UnrecognizedAlgorithmError}
      */
     encryptWithPublicKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
     /**
@@ -196,6 +206,8 @@ export interface SudoKeyManager {
      * @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>;
     /**

package/lib/types/types.d.ts

@@ -41,3 +41,74 @@ export declare enum EncryptionAlgorithm {
     AesCbcPkcs7Padding = "AES/CBC/PKCS7Padding",
     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/lib/types/types.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EncryptionAlgorithm = exports.CachePolicy = void 0;
+exports.ListOperationResultStatus = exports.EncryptionAlgorithm = exports.CachePolicy = void 0;
 
 /**
  * Generic type for paginated results from list queries
@@ -32,4 +32,16 @@ exports.EncryptionAlgorithm = EncryptionAlgorithm;
 (function (EncryptionAlgorithm) {
   EncryptionAlgorithm["AesCbcPkcs7Padding"] = "AES/CBC/PKCS7Padding";
   EncryptionAlgorithm["RsaOaepSha1"] = "RSA/OAEPWithSHA-1";
-})(EncryptionAlgorithm || (exports.EncryptionAlgorithm = EncryptionAlgorithm = {}));
+})(EncryptionAlgorithm || (exports.EncryptionAlgorithm = EncryptionAlgorithm = {}));
+
+/**
+ * Status of the list operation result.
+ */
+let ListOperationResultStatus;
+exports.ListOperationResultStatus = ListOperationResultStatus;
+
+(function (ListOperationResultStatus) {
+  ListOperationResultStatus["Success"] = "Success";
+  ListOperationResultStatus["Partial"] = "Partial";
+  ListOperationResultStatus["Failure"] = "Failure";
+})(ListOperationResultStatus || (exports.ListOperationResultStatus = ListOperationResultStatus = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sudoplatform/sudo-common",
-  "version": "5.6.0",
+  "version": "5.9.0",
   "author": "Anonyome Labs, Inc.",
   "repository": {
     "type": "git",
@@ -18,7 +18,7 @@
     "build:verify": "yarn audit-with-suppressions && yarn lint && yarn test --coverage",
     "build:transpile": "babel src --out-dir lib --extensions '.ts'",
     "build:declarations": "yarn tsc --emitDeclarationOnly",
-    "build:doc": "typedoc --excludePrivate --out docs src/index.ts"
+    "build:doc": "typedoc --treatWarningsAsErrors --excludePrivate --out docs src/index.ts"
   },
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -31,42 +31,45 @@
     "!*.spec.*"
   ],
   "resolutions": {
-    "**/apollo-client": "^2.6.10"
+    "**/apollo-cache-inmemory": "^1.6.6",
+    "**/apollo-client": "^2.6.10",
+    "ansi-regex": "^5.0.1",
+    "tmpl": "^1.0.5"
   },
   "dependencies": {
     "apollo-client": "^2.6.10",
     "browser-bunyan": "^1.6.3",
-    "fflate": "^0.7.1"
+    "fflate": "^0.7.1",
+    "graphql": "^15.6.1"
   },
   "peerDependencies": {
     "io-ts": "^2.2.10"
   },
   "devDependencies": {
-    "@babel/cli": "^7.14.8",
-    "@babel/core": "^7.15.0",
+    "@babel/cli": "^7.15.7",
+    "@babel/core": "^7.15.8",
     "@babel/plugin-proposal-class-properties": "^7.14.5",
     "@babel/plugin-proposal-private-methods": "^7.14.5",
-    "@babel/preset-env": "^7.15.0",
+    "@babel/preset-env": "^7.15.8",
     "@babel/preset-typescript": "^7.15.0",
-    "@types/jest": "^27.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.29.3",
-    "@typescript-eslint/parser": "^4.29.3",
+    "@types/jest": "^27.0.2",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-prettier": "^3.4.1",
-    "fp-ts": "^2.11.1",
-    "graphql": "^15.5.1",
+    "eslint-plugin-prettier": "^4.0.0",
+    "fp-ts": "^2.11.4",
     "io-ts": "^2.2.16",
     "io-ts-types": "^0.5.16",
     "isomorphic-webcrypto": "^2.3.8",
-    "jest": "^27.0.6",
+    "jest": "^27.2.4",
     "monocle-ts": "^2.3.11",
     "newtype-ts": "^0.3.2",
-    "prettier": "^2.3.2",
+    "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
     "ts-mockito": "^2.6.1",
-    "typedoc": "^0.21.6",
-    "typescript": "^4.3.5"
+    "typedoc": "^0.22.5",
+    "typescript": "^4.4.3"
   }
 }

package/src/errors/error.ts

@@ -398,6 +398,16 @@ export class OperationNotImplementedError extends Error {
   }
 }
 
+/**
+ * Encryption algorithm is not recognized
+ */
+export class UnrecognizedAlgorithmError extends Error {
+  constructor(message?: string) {
+    super(message ?? 'Unrecognized encryption algorithm name.')
+    this.name = 'UnrecognizedAlgorithmError'
+  }
+}
+
 /**
  * Helper method for mapping an App Sync error to common errors.
  *

package/src/sudoKeyArchive/sudoKeyArchive.ts

@@ -124,7 +124,7 @@ export interface SudoKeyArchive {
   getMetaInfo(): ReadonlyMap<string, string>
 }
 
-type KeyArchiveKeyInfoDecoded = KeyArchiveKeyInfo & {
+export type KeyArchiveKeyInfoDecoded = KeyArchiveKeyInfo & {
   Decoded: ArrayBuffer
 }
 

package/src/sudoKeyManager/sudoCryptoProvider.ts

@@ -194,6 +194,8 @@ export interface SudoCryptoProvider {
    *
    *
    * @returns Encrypted data and IV
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithSymmetricKeyName(
     name: string,
@@ -225,6 +227,8 @@ export interface SudoCryptoProvider {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithSymmetricKeyName(
     name: string,
@@ -256,6 +260,8 @@ export interface SudoCryptoProvider {
    * @param data Data to encrypt.
    *
    * @returns Encrypted data and IV
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithSymmetricKey(
     key: ArrayBuffer,
@@ -287,6 +293,8 @@ export interface SudoCryptoProvider {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithSymmetricKey(
     key: ArrayBuffer,
@@ -301,6 +309,8 @@ export interface SudoCryptoProvider {
    * @param data The data to encrypt.
    *
    * @returns Encrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithPublicKey(
     name: string,
@@ -315,6 +325,8 @@ export interface SudoCryptoProvider {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data or undefined if the private key is not found.
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithPrivateKey(
     name: string,

package/src/sudoKeyManager/sudoKeyManager.ts

@@ -139,6 +139,8 @@ export interface SudoKeyManager {
    * @param data Data to encrypt.
    *
    * @returns Encrypted data and IV
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithSymmetricKey(
     key: ArrayBuffer,
@@ -170,6 +172,8 @@ export interface SudoKeyManager {
    * @param encryptedData The encrypted data.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithSymmetricKey(
     key: ArrayBuffer,
@@ -201,6 +205,8 @@ export interface SudoKeyManager {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithSymmetricKeyName(
     name: string,
@@ -231,6 +237,8 @@ export interface SudoKeyManager {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithSymmetricKeyName(
     name: string,
@@ -245,6 +253,8 @@ export interface SudoKeyManager {
    * @param data The data to encrypt.
    *
    * @returns Encrypted data
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   encryptWithPublicKey(
     name: string,
@@ -259,6 +269,8 @@ export interface SudoKeyManager {
    * @param data The data to decrypt.
    *
    * @returns Decrypted data or undefined if the private key is not found.
+   *
+   * @throws {@link UnrecognizedAlgorithmError}
    */
   decryptWithPrivateKey(
     name: string,

package/src/types/types.ts

@@ -48,3 +48,81 @@ export enum EncryptionAlgorithm {
   AesCbcPkcs7Padding = 'AES/CBC/PKCS7Padding',
   RsaOaepSha1 = 'RSA/OAEPWithSHA-1',
 }
+
+export 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 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 type ListOperationResult<T, S extends Subset<S, T> = T> =
+  | ListOperationSuccessResult<T>
+  | ListOperationFailureResult
+  | ListOperationPartialResult<T, S>