@lifeready/core 5.0.1 → 5.0.2

package/lib/_common/exceptions.d.ts

@@ -1,6 +1,20 @@
 import { GraphQLError } from 'graphql';
 export declare function handleApolloError(errors: ReadonlyArray<GraphQLError>): void;
-export declare class LrError {
+export declare class KcError {
+    /**
+     * The _tag prevents being able to return an object when a class is required:
+     * ref: https://medium.com/decathlondevelopers/whats-the-problem-with-typescript-s-classes-2e60aaad3f6
+     * Example:
+     *   // This works because KcError is being treated as a type.
+     *   function test(): KcError {
+     *     return {message: "123"};
+     *   }
+     * With the private _tag property, the above will cause a compiler error because _tag property is missing
+     * from the returned object.
+     *
+     * The _type property also provides a type indicator when serialising the class to POJO.
+     */
+    private _type;
     code?: string;
     source?: string;
     message: string;
@@ -11,13 +25,19 @@ export declare class LrError {
         }[];
         path: string[];
     };
-}
-export declare class LrException {
-    errors: LrError[];
-    constructor(...errors: LrError[]);
+    constructor(options: Partial<KcError>);
+}
+export declare class KcException {
+    private _type;
+    errors: KcError[];
+    /**
+     *
+     * @param errors Each argument is a KcError.
+     */
+    constructor(...errors: KcError[]);
     toString(): string[];
 }
-export declare enum LrApiErrorCode {
+export declare enum KcErrorCode {
     ARCHIVED_RESOURCE = "ARCHIVED_RESOURCE",
     BAD_ARGUMENT = "BAD_ARGUMENT",
     BAD_SIGNATURE = "BAD_SIGNATURE",
@@ -47,63 +67,59 @@ export declare enum LrApiErrorCode {
     UNAUTHENTICATED_USER = "UNAUTHENTICATED_USER",
     USER_NOT_FOUND = "USER_NOT_FOUND",
     VERSION_MISMATCH = "VERSION_MISMATCH",
-    WRONG_PERMISSIONS = "WRONG_PERMISSIONS"
-}
-export declare enum LrErrorCode {
-    BadTimeSync = "LrBadTimeSync",
-    ReceiveClaimMismatch = "LrReceiveClaimMismatch",
-    BadState = "LrBadState",
-    BadSignature = "LrBadSignature",
-    Auth = "LrAuth",
-    BadArgument = "LrBadArgument",
-    SuspiciousException = "LrSuspiciousException",
-    NotFound = "LrNotFound",
-    BadLogic = "LrBadLogicException",
-    CodeMismatch = "LrCodeMismatchException",
-    ConcurrentAccess = "LrConcurrentAccessException",
-    BadRequest = "LrBadRequestException",
-    Encryption = "LrEncryptionGoBad",
-    Locked = "LrLockedException"
-}
-export declare class LrBadArgumentException extends LrException {
+    WRONG_PERMISSIONS = "WRONG_PERMISSIONS",
+    AUTH = "AUTH",
+    BAD_LOGIC = "BAD_LOGIC",
+    BAD_REQUEST = "BAD_REQUEST",
+    BAD_TIME_SYNC = "BAD_TIME_SYNC",
+    CODE_MISMATCH = "CODE_MISMATCH",
+    ENCRYPTION = "ENCRYPTION",
+    NOT_FOUND = "NOT_FOUND",
+    SUSPICIOUS_OPERATION = "SUSPICIOUS_OPERATION",
+    UNSUPPORTED = "UNSUPPORTED"
+}
+export declare class KcAuthException extends KcException {
     constructor(message: any);
 }
-export declare class LrSuspiciousException extends LrException {
+export declare class KcBadArgumentException extends KcException {
+    constructor(message: string);
+}
+export declare class KcBadLogicException extends KcException {
     constructor(message: any);
 }
-export declare class LrNotFoundException extends LrException {
+export declare class KcBadRequestException extends KcException {
     constructor(message: any);
 }
-export declare class LrBadLogicException extends LrException {
+export declare class KcBadSignatureException extends KcException {
     constructor(message: any);
 }
-export declare class LrCodeMismatchException extends LrException {
+export declare class KcBadStateException extends KcException {
     constructor(message: any);
 }
-export declare class LrConcurrentAccessException extends LrException {
+export declare class KcBadTimeSyncException extends KcException {
     constructor(message: any);
 }
-export declare class LrLockedException extends LrException {
+export declare class KcCodeMismatchException extends KcException {
     constructor(message: any);
 }
-export declare class LrBadRequestException extends LrException {
+export declare class KcConcurrentAccessException extends KcException {
     constructor(message: any);
 }
-export declare class LrAuthException extends LrException {
+export declare class KcEncryptionException extends KcException {
     constructor(message: any);
 }
-export declare class LrEncryptionException extends LrException {
+export declare class KcInternalErrorException extends KcException {
     constructor(message: any);
 }
-export declare class LrUnsupportedException extends LrException {
+export declare class KcLockedException extends KcException {
     constructor(message: any);
 }
-export declare class LrExpiredCodeException extends LrException {
+export declare class KcNotFoundException extends KcException {
     constructor(message: any);
 }
-export declare class LrExpiredException extends LrException {
+export declare class KcSuspiciousOperationException extends KcException {
     constructor(message: any);
 }
-export declare class LrBadStateException extends LrException {
+export declare class KcUnsupportedException extends KcException {
     constructor(message: any);
 }

package/lib/_common/types.d.ts

@@ -1,4 +1,3 @@
-import { HasKeyGraph } from '../key/key.types';
 export declare type SomePartial<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 export declare type SomeRequired<T, K extends keyof T> = Pick<Required<T>, K> & Omit<T, K>;
 export interface Edge<T> {
@@ -7,7 +6,4 @@ export interface Edge<T> {
 export interface HasEdges<T> {
     edges: Edge<T>[];
 }
-export interface HasKeyGraphEdges<T> extends HasKeyGraph {
-    list: HasEdges<T>;
-}
 export declare type MayAsync<T> = T | Promise<T>;

package/lib/_common/utils.d.ts

@@ -1,5 +1,4 @@
 import { AuthClass } from '@aws-amplify/auth/lib-esm/Auth';
-import { KcConfig } from '../life-ready.config';
 export declare function promiseAllMayAsync(values: any[]): Promise<any> | any;
 export declare function mapValuesMayAsync(obj: Record<string, any>, callback: (value: any, key: string, obj: Record<string, any>) => any | Promise<any>): Promise<any> | any;
 export declare function mapValuesAsync(obj: Record<string, any>, callback?: (value: any, key: string, obj: Record<string, any>) => any | Promise<any>): Promise<any>;
@@ -10,10 +9,3 @@ export declare function mapValuesAsync(obj: Record<string, any>, callback?: (val
  */
 export declare function undefinedDefault(value: any, defaultValue: any): any;
 export declare function getAccessJwtToken(auth: AuthClass): Promise<string>;
-export declare function httpOptions(auth: AuthClass, config: KcConfig): Promise<{
-    withCredentials: boolean;
-    headers: {
-        'x-kc-dev-user': string;
-        authorization: string;
-    };
-}>;

package/lib/auth/auth.types.d.ts

@@ -3,7 +3,7 @@ import { JWK } from 'node-jose';
 import { JSONObject, TpPasswordResetUserNode, UserDeleteNode } from '../api/types';
 import { PassIdpParams, PassKeyParams } from '../key/key.types';
 import { UserPlan } from '../plan/plan.types';
-import { CurrentUserKey, MainContactCard } from '../profile/profile.types';
+import { CurrentUserKey, Features, MainContactCard } from '../profile/profile.types';
 export interface PassKeyBundle {
     passKeyParams: PassKeyParams;
     passKey: JWK.Key;
@@ -18,14 +18,6 @@ export declare class CognitoChallengeUser extends CognitoUser {
     challengeParam: JSONObject;
     isTpPasswordResetUser: boolean;
 }
-export declare enum FeatureAction {
-    ACCESS = "access"
-}
-export declare class Features {
-    myVault: FeatureAction[];
-    tpVault: FeatureAction[];
-    shareVault: FeatureAction[];
-}
 export declare class CurrentUser {
     id: string;
     sub: string;

package/lib/key/key.types.d.ts

@@ -1,6 +1,6 @@
 import { JWK } from 'node-jose';
 import { JSONObject, PassKeyNode } from '../api/types';
-import { SomeRequired } from '../_common/types';
+import { HasEdges, SomeRequired } from '../_common/types';
 export interface Key {
     id: string;
     pbk?: string;
@@ -77,3 +77,6 @@ export interface DerivePassKeyParams extends PassKeyParams {
 export interface DeriveLbopKeyParams extends PassKeyParams {
     password: CryptoKey;
 }
+export interface HasKeyGraphEdges<T> extends HasKeyGraph {
+    list: HasEdges<T>;
+}

package/lib/lbop/lbop.service.d.ts

@@ -10,6 +10,10 @@ import { KeyService } from '../key/key.service';
 import { PassKeyParams } from '../key/key.types';
 import { KcConfig } from '../life-ready.config';
 import { PasswordService } from '../password/password.service';
+export declare const ERROR_SOURCE = "LBOP";
+export declare enum KcLbopErrorCode {
+    INVALID_PASSPHRASE = "INVALID_PASSPHRASE"
+}
 export interface SetPasswordParams {
     lbopId: string;
     newPassword: CryptoKey;

package/lib/life-ready.config.d.ts

@@ -2,6 +2,13 @@ import { InjectionToken } from '@angular/core';
 import { ApolloClientOptions } from '@apollo/client/core';
 import { AuthClass } from '@aws-amplify/auth/lib-esm/Auth';
 export declare const KC_CONFIG: InjectionToken<KcConfig>;
+export declare function httpOptions(auth: AuthClass, config: KcConfig): Promise<{
+    withCredentials: boolean;
+    headers: {
+        'x-kc-dev-user': string;
+        authorization: string;
+    };
+}>;
 export interface KcConfig {
     authUrl: string;
     apiUrl: string;

package/lib/profile/profile.types.d.ts

@@ -1,6 +1,13 @@
 import { UserDeleteNode } from '../api/types';
-import { Features } from '../auth/auth.types';
 import { PassIdpParams, PassKey } from '../key/key.types';
+export declare enum FeatureAction {
+    ACCESS = "access"
+}
+export declare class Features {
+    myVault: FeatureAction[];
+    tpVault: FeatureAction[];
+    shareVault: FeatureAction[];
+}
 export declare class CurrentUserKey {
     passKey?: PassKey;
     masterKey?: {