@azure/msal-common 14.0.2 → 14.1.0-alpha.0

package/src/cache/interface/ICachePlugin.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { TokenCacheContext } from "../persistence/TokenCacheContext";
+
+export interface ICachePlugin {
+    beforeCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
+    afterCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
+}

package/src/cache/interface/ISerializableTokenCache.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export interface ISerializableTokenCache {
+    deserialize: (cache: string) => void;
+    serialize: () => string;
+}

package/src/cache/persistence/TokenCacheContext.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ISerializableTokenCache } from "../interface/ISerializableTokenCache";
+
+/**
+ * This class instance helps track the memory changes facilitating
+ * decisions to read from and write to the persistent cache
+ */ export class TokenCacheContext {
+    /**
+     * boolean indicating cache change
+     */
+    hasChanged: boolean;
+    /**
+     * serializable token cache interface
+     */
+    cache: ISerializableTokenCache;
+
+    constructor(tokenCache: ISerializableTokenCache, hasChanged: boolean) {
+        this.cache = tokenCache;
+        this.hasChanged = hasChanged;
+    }
+
+    /**
+     * boolean which indicates the changes in cache
+     */
+    get cacheHasChanged(): boolean {
+        return this.hasChanged;
+    }
+
+    /**
+     * function to retrieve the token cache
+     */
+    get tokenCache(): ISerializableTokenCache {
+        return this.cache;
+    }
+}

package/src/cache/utils/CacheTypes.ts

@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AccountEntity } from "../entities/AccountEntity";
+import { IdTokenEntity } from "../entities/IdTokenEntity";
+import { AccessTokenEntity } from "../entities/AccessTokenEntity";
+import { RefreshTokenEntity } from "../entities/RefreshTokenEntity";
+import { AppMetadataEntity } from "../entities/AppMetadataEntity";
+import { ServerTelemetryEntity } from "../entities/ServerTelemetryEntity";
+import { ThrottlingEntity } from "../entities/ThrottlingEntity";
+import { AuthorityMetadataEntity } from "../entities/AuthorityMetadataEntity";
+import { AuthenticationScheme } from "../../utils/Constants";
+import { ScopeSet } from "../../request/ScopeSet";
+
+/** @internal */
+export type AccountCache = Record<string, AccountEntity>;
+/** @internal */
+export type IdTokenCache = Record<string, IdTokenEntity>;
+/** @internal */
+export type AccessTokenCache = Record<string, AccessTokenEntity>;
+/** @internal */
+export type RefreshTokenCache = Record<string, RefreshTokenEntity>;
+/** @internal */
+export type AppMetadataCache = Record<string, AppMetadataEntity>;
+
+/**
+ * Object type of all accepted cache types
+ * @internal
+ */
+export type ValidCacheType =
+    | AccountEntity
+    | IdTokenEntity
+    | AccessTokenEntity
+    | RefreshTokenEntity
+    | AppMetadataEntity
+    | AuthorityMetadataEntity
+    | ServerTelemetryEntity
+    | ThrottlingEntity
+    | string;
+
+/**
+ * Object type of all credential types
+ * @internal
+ */
+export type ValidCredentialType =
+    | IdTokenEntity
+    | AccessTokenEntity
+    | RefreshTokenEntity;
+
+/**
+ * Account:	<home_account_id>-<environment>-<realm*>
+ */
+export type AccountFilter = {
+    homeAccountId?: string;
+    localAccountId?: string;
+    username?: string;
+    environment?: string;
+    realm?: string;
+    nativeAccountId?: string;
+};
+
+/**
+ * Credential: <home_account_id*>-<environment>-<credential_type>-<client_id>-<realm*>-<target*>-<scheme*>
+ */
+export type CredentialFilter = {
+    homeAccountId?: string;
+    environment?: string;
+    credentialType?: string;
+    clientId?: string;
+    familyId?: string;
+    realm?: string;
+    target?: ScopeSet;
+    userAssertionHash?: string;
+    tokenType?: AuthenticationScheme;
+    keyId?: string;
+    requestedClaimsHash?: string;
+};
+
+/**
+ * AppMetadata: appmetadata-<environment>-<client_id>
+ */
+export type AppMetadataFilter = {
+    environment?: string;
+    clientId?: string;
+};
+
+export type TokenKeys = {
+    idToken: string[];
+    accessToken: string[];
+    refreshToken: string[];
+};