@microsoft/agents-activity 0.1.49

package/README.md

@@ -0,0 +1,22 @@
+# @microsoft/agents-activity
+
+## Overview
+
+The `@microsoft/agents-activity` implements the Activity Protocol Specification https://github.com/microsoft/Agents/blob/main/specs/activity/protocol-activity.md. 
+
+It provides declaration files defined with TypeScript and validators based on `zod`.
+
+## Installation
+
+To install the package, use npm:
+
+```sh
+npm install @microsoft/agents-activity
+```
+
+## Usage
+
+```ts
+const activity = Activity.fromObject({ type: ActivityTypes.Message, text: 'Hello World' })
+```
+

package/dist/src/action/actionTypes.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { z } from 'zod';
+/**
+ * Enum representing the types of actions.
+ */
+export declare enum ActionTypes {
+    OpenUrl = "openUrl",
+    ImBack = "imBack",
+    PostBack = "postBack",
+    PlayAudio = "playAudio",
+    PlayVideo = "playVideo",
+    ShowImage = "showImage",
+    DownloadFile = "downloadFile",
+    Signin = "signin",
+    Call = "call",
+    MessageBack = "messageBack",
+    OpenApp = "openApp"
+}
+/**
+ * Zod schema for validating ActionTypes.
+ */
+export declare const actionTypesZodSchema: z.ZodEnum<["openUrl", "imBack", "postBack", "playAudio", "showImage", "downloadFile", "signin", "call", "messageBack", "openApp"]>;

package/dist/src/action/actionTypes.js

@@ -0,0 +1,30 @@
+"use strict";
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.actionTypesZodSchema = exports.ActionTypes = void 0;
+const zod_1 = require("zod");
+/**
+ * Enum representing the types of actions.
+ */
+var ActionTypes;
+(function (ActionTypes) {
+    ActionTypes["OpenUrl"] = "openUrl";
+    ActionTypes["ImBack"] = "imBack";
+    ActionTypes["PostBack"] = "postBack";
+    ActionTypes["PlayAudio"] = "playAudio";
+    ActionTypes["PlayVideo"] = "playVideo";
+    ActionTypes["ShowImage"] = "showImage";
+    ActionTypes["DownloadFile"] = "downloadFile";
+    ActionTypes["Signin"] = "signin";
+    ActionTypes["Call"] = "call";
+    ActionTypes["MessageBack"] = "messageBack";
+    ActionTypes["OpenApp"] = "openApp";
+})(ActionTypes || (exports.ActionTypes = ActionTypes = {}));
+/**
+ * Zod schema for validating ActionTypes.
+ */
+exports.actionTypesZodSchema = zod_1.z.enum(['openUrl', 'imBack', 'postBack', 'playAudio', 'showImage', 'downloadFile', 'signin', 'call', 'messageBack', 'openApp']);
+//# sourceMappingURL=actionTypes.js.map

package/dist/src/action/actionTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actionTypes.js","sourceRoot":"","sources":["../../../src/action/actionTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6BAAuB;AAEvB;;GAEG;AACH,IAAY,WAYX;AAZD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;IACvB,sCAAuB,CAAA;IACvB,sCAAuB,CAAA;IACvB,4CAA6B,CAAA;IAC7B,gCAAiB,CAAA;IACjB,4BAAa,CAAA;IACb,0CAA2B,CAAA;IAC3B,kCAAmB,CAAA;AACrB,CAAC,EAZW,WAAW,2BAAX,WAAW,QAYtB;AAED;;GAEG;AACU,QAAA,oBAAoB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC,CAAA"}

package/dist/src/action/cardAction.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { z } from 'zod';
+import { ActionTypes } from './actionTypes';
+/**
+ * Interface representing a card action.
+ */
+export interface CardAction {
+    /**
+     * Type of the action.
+     */
+    type: ActionTypes | string;
+    /**
+     * Title of the action.
+     */
+    title: string;
+    /**
+     * URL of the image associated with the action.
+     */
+    image?: string;
+    /**
+     * Text associated with the action.
+     */
+    text?: string;
+    /**
+     * Display text for the action.
+     */
+    displayText?: string;
+    /**
+     * Value associated with the action.
+     */
+    value?: any;
+    /**
+     * Channel-specific data associated with the action.
+     */
+    channelData?: unknown;
+    /**
+     * Alt text for the image.
+     */
+    imageAltText?: string;
+}
+/**
+ * Zod schema for validating CardAction.
+ */
+export declare const cardActionZodSchema: z.ZodObject<{
+    type: z.ZodUnion<[z.ZodEnum<["openUrl", "imBack", "postBack", "playAudio", "showImage", "downloadFile", "signin", "call", "messageBack", "openApp"]>, z.ZodString]>;
+    title: z.ZodString;
+    image: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    displayText: z.ZodOptional<z.ZodString>;
+    value: z.ZodOptional<z.ZodAny>;
+    channelData: z.ZodOptional<z.ZodUnknown>;
+    imageAltText: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    title: string;
+    value?: any;
+    image?: string | undefined;
+    text?: string | undefined;
+    displayText?: string | undefined;
+    channelData?: unknown;
+    imageAltText?: string | undefined;
+}, {
+    type: string;
+    title: string;
+    value?: any;
+    image?: string | undefined;
+    text?: string | undefined;
+    displayText?: string | undefined;
+    channelData?: unknown;
+    imageAltText?: string | undefined;
+}>;

package/dist/src/action/cardAction.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cardActionZodSchema = void 0;
+const zod_1 = require("zod");
+const actionTypes_1 = require("./actionTypes");
+/**
+ * Zod schema for validating CardAction.
+ */
+exports.cardActionZodSchema = zod_1.z.object({
+    type: zod_1.z.union([actionTypes_1.actionTypesZodSchema, zod_1.z.string().min(1)]),
+    title: zod_1.z.string().min(1),
+    image: zod_1.z.string().min(1).optional(),
+    text: zod_1.z.string().min(1).optional(),
+    displayText: zod_1.z.string().min(1).optional(),
+    value: zod_1.z.any().optional(),
+    channelData: zod_1.z.unknown().optional(),
+    imageAltText: zod_1.z.string().min(1).optional()
+});
+//# sourceMappingURL=cardAction.js.map

package/dist/src/action/cardAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cardAction.js","sourceRoot":"","sources":["../../../src/action/cardAction.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6BAAuB;AACvB,+CAAiE;AAwCjE;;GAEG;AACU,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,kCAAoB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACzC,KAAK,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACzB,WAAW,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAA"}

package/dist/src/action/semanticAction.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { z } from 'zod';
+import { Entity } from '../entity/entity';
+import { SemanticActionStateTypes } from './semanticActionStateTypes';
+/**
+ * Interface representing a semantic action.
+ */
+export interface SemanticAction {
+    /**
+     * Unique identifier for the semantic action.
+     */
+    id: string;
+    /**
+     * State of the semantic action.
+     */
+    state: SemanticActionStateTypes | string;
+    /**
+     * Entities associated with the semantic action.
+     */
+    entities: {
+        [propertyName: string]: Entity;
+    };
+}
+/**
+ * Zod schema for validating SemanticAction.
+ */
+export declare const semanticActionZodSchema: z.ZodObject<{
+    id: z.ZodString;
+    state: z.ZodUnion<[z.ZodEnum<["start", "continue", "done"]>, z.ZodString]>;
+    entities: z.ZodRecord<z.ZodString, z.ZodObject<{
+        type: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+    }, {
+        type: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    state: string;
+    entities: Record<string, {
+        type: string;
+    }>;
+}, {
+    id: string;
+    state: string;
+    entities: Record<string, {
+        type: string;
+    }>;
+}>;

package/dist/src/action/semanticAction.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.semanticActionZodSchema = void 0;
+const zod_1 = require("zod");
+const entity_1 = require("../entity/entity");
+const semanticActionStateTypes_1 = require("./semanticActionStateTypes");
+/**
+ * Zod schema for validating SemanticAction.
+ */
+exports.semanticActionZodSchema = zod_1.z.object({
+    id: zod_1.z.string().min(1),
+    state: zod_1.z.union([semanticActionStateTypes_1.semanticActionStateTypesZodSchema, zod_1.z.string().min(1)]),
+    entities: zod_1.z.record(entity_1.entityZodSchema)
+});
+//# sourceMappingURL=semanticAction.js.map

package/dist/src/action/semanticAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semanticAction.js","sourceRoot":"","sources":["../../../src/action/semanticAction.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6BAAuB;AACvB,6CAA0D;AAC1D,yEAAwG;AAoBxG;;GAEG;AACU,QAAA,uBAAuB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9C,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,4DAAiC,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC,wBAAe,CAAC;CACpC,CAAC,CAAA"}

package/dist/src/action/semanticActionStateTypes.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { z } from 'zod';
+/**
+ * Enum representing the state types of a semantic action.
+ */
+export declare enum SemanticActionStateTypes {
+    Start = "start",
+    Continue = "continue",
+    Done = "done"
+}
+/**
+ * Zod schema for validating SemanticActionStateTypes.
+ */
+export declare const semanticActionStateTypesZodSchema: z.ZodEnum<["start", "continue", "done"]>;

package/dist/src/action/semanticActionStateTypes.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.semanticActionStateTypesZodSchema = exports.SemanticActionStateTypes = void 0;
+const zod_1 = require("zod");
+/**
+ * Enum representing the state types of a semantic action.
+ */
+var SemanticActionStateTypes;
+(function (SemanticActionStateTypes) {
+    SemanticActionStateTypes["Start"] = "start";
+    SemanticActionStateTypes["Continue"] = "continue";
+    SemanticActionStateTypes["Done"] = "done";
+})(SemanticActionStateTypes || (exports.SemanticActionStateTypes = SemanticActionStateTypes = {}));
+/**
+ * Zod schema for validating SemanticActionStateTypes.
+ */
+exports.semanticActionStateTypesZodSchema = zod_1.z.enum(['start', 'continue', 'done']);
+//# sourceMappingURL=semanticActionStateTypes.js.map

package/dist/src/action/semanticActionStateTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semanticActionStateTypes.js","sourceRoot":"","sources":["../../../src/action/semanticActionStateTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6BAAuB;AAEvB;;GAEG;AACH,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,2CAAe,CAAA;IACf,iDAAqB,CAAA;IACrB,yCAAa,CAAA;AACf,CAAC,EAJW,wBAAwB,wCAAxB,wBAAwB,QAInC;AAED;;GAEG;AACU,QAAA,iCAAiC,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAA"}

package/dist/src/action/suggestedActions.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { z } from 'zod';
+import { CardAction } from './cardAction';
+/**
+ * Interface representing suggested actions.
+ */
+export interface SuggestedActions {
+    /**
+     * Array of recipient IDs.
+     */
+    to: string[];
+    /**
+     * Array of card actions.
+     */
+    actions: CardAction[];
+}
+/**
+ * Zod schema for validating SuggestedActions.
+ */
+export declare const suggestedActionsZodSchema: z.ZodObject<{
+    to: z.ZodArray<z.ZodString, "many">;
+    actions: z.ZodArray<z.ZodObject<{
+        type: z.ZodUnion<[z.ZodEnum<["openUrl", "imBack", "postBack", "playAudio", "showImage", "downloadFile", "signin", "call", "messageBack", "openApp"]>, z.ZodString]>;
+        title: z.ZodString;
+        image: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        displayText: z.ZodOptional<z.ZodString>;
+        value: z.ZodOptional<z.ZodAny>;
+        channelData: z.ZodOptional<z.ZodUnknown>;
+        imageAltText: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        title: string;
+        value?: any;
+        image?: string | undefined;
+        text?: string | undefined;
+        displayText?: string | undefined;
+        channelData?: unknown;
+        imageAltText?: string | undefined;
+    }, {
+        type: string;
+        title: string;
+        value?: any;
+        image?: string | undefined;
+        text?: string | undefined;
+        displayText?: string | undefined;
+        channelData?: unknown;
+        imageAltText?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    to: string[];
+    actions: {
+        type: string;
+        title: string;
+        value?: any;
+        image?: string | undefined;
+        text?: string | undefined;
+        displayText?: string | undefined;
+        channelData?: unknown;
+        imageAltText?: string | undefined;
+    }[];
+}, {
+    to: string[];
+    actions: {
+        type: string;
+        title: string;
+        value?: any;
+        image?: string | undefined;
+        text?: string | undefined;
+        displayText?: string | undefined;
+        channelData?: unknown;
+        imageAltText?: string | undefined;
+    }[];
+}>;

package/dist/src/action/suggestedActions.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.suggestedActionsZodSchema = void 0;
+const zod_1 = require("zod");
+const cardAction_1 = require("./cardAction");
+/**
+ * Zod schema for validating SuggestedActions.
+ */
+exports.suggestedActionsZodSchema = zod_1.z.object({
+    to: zod_1.z.array(zod_1.z.string().min(1)),
+    actions: zod_1.z.array(cardAction_1.cardActionZodSchema)
+});
+//# sourceMappingURL=suggestedActions.js.map

package/dist/src/action/suggestedActions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggestedActions.js","sourceRoot":"","sources":["../../../src/action/suggestedActions.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6BAAuB;AACvB,6CAA8D;AAgB9D;;GAEG;AACU,QAAA,yBAAyB,GAAG,OAAC,CAAC,MAAM,CAAC;IAChD,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC9B,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,gCAAmB,CAAC;CACtC,CAAC,CAAA"}