@microsoft/agents-hosting 0.2.14 → 0.4.1

package/src/storage/fileStorage.ts

@@ -0,0 +1,59 @@
+import path from 'path'
+import fs from 'fs'
+import { Storage, StoreItem } from './storage'
+
+export class FileStorage implements Storage {
+  private _folder: string
+  private _stateFile: Record<string, string>
+  constructor (folder: string) {
+    this._folder = folder
+    if (!fs.existsSync(folder)) {
+      fs.mkdirSync(folder, { recursive: true })
+    }
+    if (!fs.existsSync(path.join(folder, 'state.json'))) {
+      fs.writeFileSync(path.join(folder, 'state.json'), '{}')
+    }
+    const data = fs.readFileSync(path.join(folder, 'state.json'), 'utf8')
+    this._stateFile = JSON.parse(data)
+  }
+
+  read (keys: string[]) : Promise<StoreItem> {
+    return new Promise((resolve, reject) => {
+      if (!keys || keys.length === 0) {
+        reject(new ReferenceError('Keys are required when reading.'))
+      } else {
+        const data: StoreItem = {}
+        for (const key of keys) {
+          const item = this._stateFile[key]
+          if (item) {
+            data[key] = item
+          }
+        }
+        resolve(data)
+      }
+    })
+  }
+
+  write (changes: StoreItem) : Promise<void> {
+    const keys = Object.keys(changes)
+    for (const key of keys) {
+      this._stateFile[key] = changes[key]
+    }
+    fs.writeFileSync(this._folder + '/state.json', JSON.stringify(this._stateFile, null, 2))
+    return Promise.resolve()
+  }
+
+  delete (keys: string[]) : Promise<void> {
+    return new Promise((resolve, reject) => {
+      if (!keys || keys.length === 0) {
+        reject(new ReferenceError('Keys are required when deleting.'))
+      } else {
+        for (const key of keys) {
+          delete this._stateFile[key]
+        }
+        fs.writeFileSync(this._folder + '/state.json', JSON.stringify(this._stateFile, null, 2))
+      }
+      resolve()
+    })
+  }
+}

package/src/storage/index.ts

@@ -1,2 +1,3 @@
 export * from './storage'
 export * from './memoryStorage'
+export * from './fileStorage'

package/src/tokenResponseEventName.ts

@@ -3,4 +3,7 @@
  * Licensed under the MIT License.
  */
 
+/**
+ * The event name used for token response activities.
+ */
 export const tokenResponseEventName = 'tokens/response'

package/dist/src/app/oauth/userIdentity.d.ts

@@ -1,43 +0,0 @@
-/**
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-import { TurnContext } from '../../turnContext';
-import { TurnState } from '../turnState';
-import { Storage } from '../../storage';
-import { OAuthFlow, TokenResponse } from '../../oauth';
-/**
- * Options for configuring user identity.
- * Contains settings related to Single Sign-On (SSO) authentication.
- */
-export interface UserIdentityOptions {
-    /**
-     * Determines whether Single Sign-On (SSO) is enabled for user authentication.
-     */
-    enableSSO: boolean;
-    /**
-     * The name of the SSO connection to use when SSO is enabled.
-     * Only applicable when enableSSO is set to true.
-     */
-    ssoConnectionName?: string;
-}
-export declare class UserIdentity {
-    oAuthFlow: OAuthFlow;
-    /**
-     * Creates a new instance of UserAuthorization.
-     * @param {Storage} storage - The storage system to use for state management.
-     */
-    constructor(storage: Storage, connectionName: string);
-    getToken(context: TurnContext): Promise<TokenResponse>;
-    authenticate(context: TurnContext, state: TurnState): Promise<TokenResponse>;
-    /**
-     * Signs out the current user.
-     * This method clears the user's token and resets the SSO state.
-     *
-     * @param {TurnContext} context - The context object for the current turn.
-     * @param {TurnState} state - The state object for the current turn.
-     */
-    signOut(context: TurnContext, state: TurnState): Promise<void>;
-    _signInHandler: ((context: TurnContext, state: TurnState) => void) | null;
-    onSignInSuccess(handler: (context: TurnContext, state: TurnState) => void): void;
-}

package/dist/src/app/oauth/userIdentity.js

@@ -1,54 +0,0 @@
-"use strict";
-/**
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserIdentity = void 0;
-const oauth_1 = require("../../oauth");
-const state_1 = require("../../state");
-class UserIdentity {
-    /**
-     * Creates a new instance of UserAuthorization.
-     * @param {Storage} storage - The storage system to use for state management.
-     */
-    constructor(storage, connectionName) {
-        this._signInHandler = null;
-        const userState = new state_1.UserState(storage);
-        this.oAuthFlow = new oauth_1.OAuthFlow(userState, connectionName);
-    }
-    async getToken(context) {
-        return await this.oAuthFlow.getUserToken(context);
-    }
-    async authenticate(context, state) {
-        var _a;
-        let tokenResponse;
-        if (((_a = this.oAuthFlow.state) === null || _a === void 0 ? void 0 : _a.flowStarted) === false) {
-            tokenResponse = await this.oAuthFlow.beginFlow(context);
-        }
-        else {
-            tokenResponse = await this.oAuthFlow.continueFlow(context);
-            if (tokenResponse.status === oauth_1.TokenRequestStatus.Success) {
-                if (this._signInHandler) {
-                    await this._signInHandler(context, state);
-                }
-            }
-        }
-        return tokenResponse;
-    }
-    /**
-     * Signs out the current user.
-     * This method clears the user's token and resets the SSO state.
-     *
-     * @param {TurnContext} context - The context object for the current turn.
-     * @param {TurnState} state - The state object for the current turn.
-     */
-    async signOut(context, state) {
-        await this.oAuthFlow.signOut(context);
-    }
-    onSignInSuccess(handler) {
-        this._signInHandler = handler;
-    }
-}
-exports.UserIdentity = UserIdentity;
-//# sourceMappingURL=userIdentity.js.map

package/dist/src/app/oauth/userIdentity.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"userIdentity.js","sourceRoot":"","sources":["../../../../src/app/oauth/userIdentity.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH,uCAA0E;AAC1E,uCAAuC;AAqBvC,MAAa,YAAY;IAGvB;;;OAGG;IACH,YAAa,OAAgB,EAAE,cAAsB;QAmCrD,mBAAc,GAA8D,IAAI,CAAA;QAlC9E,MAAM,SAAS,GAAG,IAAI,iBAAS,CAAC,OAAO,CAAC,CAAA;QACxC,IAAI,CAAC,SAAS,GAAG,IAAI,iBAAS,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;IAC3D,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAE,OAAoB;QACzC,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IACnD,CAAC;IAEM,KAAK,CAAC,YAAY,CAAE,OAAoB,EAAE,KAAgB;;QAC/D,IAAI,aAA4B,CAAA;QAChC,IAAI,CAAA,MAAA,IAAI,CAAC,SAAS,CAAC,KAAK,0CAAE,WAAW,MAAK,KAAK,EAAE,CAAC;YAChD,aAAa,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QACzD,CAAC;aAAM,CAAC;YACN,aAAa,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;YAC1D,IAAI,aAAa,CAAC,MAAM,KAAK,0BAAkB,CAAC,OAAO,EAAE,CAAC;gBACxD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;oBACxB,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;gBAC3C,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,aAAa,CAAA;IACtB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAE,OAAoB,EAAE,KAAgB;QACnD,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IACvC,CAAC;IAGM,eAAe,CAAE,OAAyD;QAC/E,IAAI,CAAC,cAAc,GAAG,OAAO,CAAA;IAC/B,CAAC;CACF;AA9CD,oCA8CC"}

package/src/app/oauth/userIdentity.ts

@@ -1,78 +0,0 @@
-/**
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { TurnContext } from '../../turnContext'
-// import { debug } from '../../logger'
-import { TurnState } from '../turnState'
-import { Storage } from '../../storage'
-import { OAuthFlow, TokenRequestStatus, TokenResponse } from '../../oauth'
-import { UserState } from '../../state'
-
-// const logger = debug('agents:user-identity')
-
-/**
- * Options for configuring user identity.
- * Contains settings related to Single Sign-On (SSO) authentication.
- */
-export interface UserIdentityOptions {
-  /**
-   * Determines whether Single Sign-On (SSO) is enabled for user authentication.
-   */
-  enableSSO: boolean;
-
-  /**
-   * The name of the SSO connection to use when SSO is enabled.
-   * Only applicable when enableSSO is set to true.
-   */
-  ssoConnectionName?: string;
-}
-
-export class UserIdentity {
-  oAuthFlow: OAuthFlow
-
-  /**
-   * Creates a new instance of UserAuthorization.
-   * @param {Storage} storage - The storage system to use for state management.
-   */
-  constructor (storage: Storage, connectionName: string) {
-    const userState = new UserState(storage)
-    this.oAuthFlow = new OAuthFlow(userState, connectionName)
-  }
-
-  public async getToken (context: TurnContext): Promise<TokenResponse> {
-    return await this.oAuthFlow.getUserToken(context)
-  }
-
-  public async authenticate (context: TurnContext, state: TurnState) : Promise<TokenResponse> {
-    let tokenResponse: TokenResponse
-    if (this.oAuthFlow.state?.flowStarted === false) {
-      tokenResponse = await this.oAuthFlow.beginFlow(context)
-    } else {
-      tokenResponse = await this.oAuthFlow.continueFlow(context)
-      if (tokenResponse.status === TokenRequestStatus.Success) {
-        if (this._signInHandler) {
-          await this._signInHandler(context, state)
-        }
-      }
-    }
-    return tokenResponse
-  }
-
-  /**
-   * Signs out the current user.
-   * This method clears the user's token and resets the SSO state.
-   *
-   * @param {TurnContext} context - The context object for the current turn.
-   * @param {TurnState} state - The state object for the current turn.
-   */
-  async signOut (context: TurnContext, state: TurnState) {
-    await this.oAuthFlow.signOut(context)
-  }
-
-  _signInHandler: ((context: TurnContext, state: TurnState) => void) | null = null
-  public onSignInSuccess (handler: (context: TurnContext, state: TurnState) => void) {
-    this._signInHandler = handler
-  }
-}