@microsoft/agents-hosting-dialogs 0.1.49

package/src/dialogsAgentComponent.ts

@@ -0,0 +1,71 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as z from 'zod'
+import { AgentComponent } from './agentComponent'
+import { ServiceCollection } from './serviceCollection'
+import { Configuration } from './configuration'
+import { MemoryScope, PathResolver } from './memory'
+
+import {
+  ClassMemoryScope,
+  ConversationMemoryScope,
+  DialogClassMemoryScope,
+  DialogContextMemoryScope,
+  DialogMemoryScope,
+  SettingsMemoryScope,
+  ThisMemoryScope,
+  TurnMemoryScope,
+  UserMemoryScope,
+} from './memory/scopes'
+
+import {
+  AtAtPathResolver,
+  AtPathResolver,
+  DollarPathResolver,
+  HashPathResolver,
+  PercentPathResolver,
+} from './memory/pathResolvers'
+
+const InitialSettings = z.record(z.unknown())
+
+/**
+ * Agent component for agent Dialogs.
+ */
+export class DialogsAgentComponent extends AgentComponent {
+  /**
+     * @param services Services Collection to register.
+     * @param configuration Configuration for the agent component.
+     */
+  configureServices (services: ServiceCollection, configuration: Configuration): void {
+    services.composeFactory<MemoryScope[]>('memoryScopes', (memoryScopes) => {
+      const rootConfiguration = configuration.get()
+      const rootConfigurationParse = InitialSettings.safeParse(rootConfiguration)
+      const initialSettings = rootConfigurationParse.success ? rootConfigurationParse.data : undefined
+
+      return memoryScopes.concat(
+        new TurnMemoryScope(),
+        new SettingsMemoryScope(initialSettings),
+        new DialogMemoryScope(),
+        new DialogContextMemoryScope(),
+        new DialogClassMemoryScope(),
+        new ClassMemoryScope(),
+        new ThisMemoryScope(),
+        new ConversationMemoryScope(),
+        new UserMemoryScope()
+      )
+    })
+
+    services.composeFactory<PathResolver[]>('pathResolvers', (pathResolvers) =>
+      pathResolvers.concat(
+        new DollarPathResolver(),
+        new HashPathResolver(),
+        new AtAtPathResolver(),
+        new AtPathResolver(),
+        new PercentPathResolver()
+      )
+    )
+  }
+}

package/src/dialogsComponentRegistration.ts

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ComponentRegistration } from './componentRegistration'
+import { ServiceCollection } from './serviceCollection'
+import { noOpConfiguration } from './configuration'
+import { DialogsAgentComponent } from './dialogsAgentComponent'
+import { ComponentMemoryScopes, ComponentPathResolvers, MemoryScope, PathResolver } from './memory'
+
+/**
+ * Makes dialogs component available to the system registering functionality.
+ */
+export class DialogsComponentRegistration
+  extends ComponentRegistration
+  implements ComponentMemoryScopes, ComponentPathResolvers {
+  private readonly services = new ServiceCollection({
+    memoryScopes: [],
+    pathResolvers: [],
+  })
+
+  /**
+     * Creates an instance of the DialogsComponentRegistration class.
+     */
+  constructor () {
+    super()
+
+    new DialogsAgentComponent().configureServices(this.services, noOpConfiguration)
+  }
+
+  /**
+     * Gets the dialogs memory scopes.
+     *
+     * @returns {MemoryScope[]} A list of MemoryScope.
+     */
+  getMemoryScopes (): MemoryScope[] {
+    return this.services.mustMakeInstance<MemoryScope[]>('memoryScopes')
+  }
+
+  /**
+     * Gets the dialogs path resolvers.
+     *
+     * @returns {PathResolver[]} A list of PathResolver.
+     */
+  getPathResolvers (): PathResolver[] {
+    return this.services.mustMakeInstance<PathResolver[]>('pathResolvers')
+  }
+}

package/src/i18n.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+const Chinese = require('../../vendor/cldr-data/main/zh/numbers.json')
+const English = require('../../vendor/cldr-data/main/en/numbers.json')
+const French = require('../../vendor/cldr-data/main/fr/numbers.json')
+const German = require('../../vendor/cldr-data/main/de/numbers.json')
+const Dutch = require('../../vendor/cldr-data/main/nl/numbers.json')
+const Japanese = require('../../vendor/cldr-data/main/ja/numbers.json')
+const LikelySubtags = require('../../vendor/cldr-data/supplemental/likelySubtags.json')
+const NumberingSystem = require('../../vendor/cldr-data/supplemental/numberingSystems.json')
+const Portuguese = require('../../vendor/cldr-data/main/pt/numbers.json')
+const Spanish = require('../../vendor/cldr-data/main/es/numbers.json')
+
+export { Chinese, English, French, German, Dutch, Japanese, LikelySubtags, NumberingSystem, Portuguese, Spanish }

package/src/index.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export * from './componentDialog'
+export * from './configurable'
+export * from './converter'
+export * from './dialog'
+export * from './dialogContainer'
+export * from './dialogContext'
+export * from './dialogContextError'
+export * from './dialogEvents'
+export * from './dialogManager'
+export * from './dialogSet'
+export * from './dialogTurnStateConstants'
+export * from './dialogsAgentComponent'
+export * from './memory'
+export * from './prompts'
+export * from './choices'
+export * from './recognizer'
+export * from './template'
+export * from './waterfallDialog'
+export * from './waterfallStepContext'
+export * from './dialogTurnResult'
+export * from './dialogTurnStatus'
+export * from './dialogEvent'
+export * from './dialogReason'
+export * from './dialogInstance'
+
+export { runDialog } from './dialogHelper'

package/src/intentScore.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Score plus any extra information about an intent.
+ */
+export interface IntentScore {
+  score?: number;
+  [key: string]: unknown;
+}

package/src/memory/componentMemoryScopes.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as z from 'zod'
+import { MemoryScope } from './scopes'
+
+/**
+ * Interface for enumerating memory scopes.
+ */
+export interface ComponentMemoryScopes {
+  getMemoryScopes(): MemoryScope[];
+}
+
+const componentMemoryScopes = z.custom<ComponentMemoryScopes>((val: any) => typeof val.getMemoryScopes === 'function', {
+  message: 'ComponentMemoryScopes',
+})
+
+/**
+ * Check if a ComponentRegistration is ComponentMemoryScopes or not.
+ *
+ * @param {any} component The component registration.
+ * @returns {boolean} Type check result.
+ */
+export function isComponentMemoryScopes (component: unknown): component is ComponentMemoryScopes {
+  return componentMemoryScopes.safeParse(component).success
+}

package/src/memory/componentPathResolvers.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as z from 'zod'
+import { PathResolver } from './pathResolvers'
+
+/**
+ * Interface for declaring path resolvers.
+ */
+export interface ComponentPathResolvers {
+  getPathResolvers(): PathResolver[];
+}
+
+const componentPathResolvers = z.custom<ComponentPathResolvers>(
+  (val: any) => typeof val.getPathResolvers === 'function',
+  { message: 'ComponentPathResolvers' }
+)
+
+/**
+ * Check if a ComponentRegistration) is ComponentPathResolvers or not.
+ *
+ * @param {any} component The component registration.
+ * @returns {boolean} Type check result.
+ */
+export function isComponentPathResolvers (component: unknown): component is ComponentPathResolvers {
+  return componentPathResolvers.safeParse(component).success
+}

package/src/memory/dialogPath.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Defines path for available dialogs.
+ */
+export class DialogPath {
+  /// Counter of emitted events.
+  static readonly eventCounter = 'dialog.eventCounter'
+
+  /// Currently expected properties.
+  static readonly expectedProperties = 'dialog.expectedProperties'
+
+  /// Default operation to use for entities where there is no identified operation entity.
+  static readonly defaultOperation = 'dialog.defaultOperation'
+
+  /// Last surfaced entity ambiguity event.
+  static readonly lastEvent = 'dialog.lastEvent'
+
+  /// Currently required properties.
+  static readonly requiredProperties = 'dialog.requiredProperties'
+
+  /// Number of retries for the current Ask.
+  static readonly retries = 'dialog.retries'
+
+  /// Last intent.
+  static readonly lastIntent = 'dialog.lastIntent'
+
+  /// Last trigger event: defined in FormEvent, ask, clarifyEntity etc..
+  static readonly lastTriggerEvent = 'dialog.lastTriggerEvent'
+}