@credal/actions 0.0.1

package/README.md

@@ -0,0 +1,32 @@
+# actions
+
+## Adding or updating actions
+
+1. Add or update the action in `src/actions/schema.yaml`
+2. Run `npm run generate:types` to generate the new types
+3. Run `npm run prettier-format` to format the new files
+4. Create a new provider function in `src/actions/providers/<provider>/<action>.ts` (eg. `src/actions/providers/math/add.ts`) which exports a function using the generated types
+5. If adding a new action or provider, update `src/actions/actionMapper.ts` and `src/actions/groups.ts`.
+6. In `package.json`, bump the version number.
+7. Run `npm publish --access public` to publish the new version to npm. (Need to be logged in via `npm login`)
+
+## Usage
+
+Invoking an action:
+
+```ts
+import { runAction } from "@credal-ai/actions";
+
+const result = await runAction(
+  "listConversations",
+  "slack",
+  { authToken: "xoxb-..." },
+  {}
+);
+```
+
+## Running a basic test for `runAction`
+
+```
+npx ts-node -r tsconfig-paths/register --project tsconfig.json tests/testRunMathAction.ts
+```

package/dist/actions/actionMapper.d.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+import { type ActionFunction } from "./autogen/types";
+interface ActionFunctionComponents {
+    fn: ActionFunction<any, any, any>;
+    paramsSchema: z.ZodSchema;
+    outputSchema: z.ZodSchema;
+}
+export declare const ActionMapper: Record<string, Record<string, ActionFunctionComponents>>;
+export {};

package/dist/actions/actionMapper.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionMapper = void 0;
+const types_1 = require("./autogen/types");
+const updatePage_1 = __importDefault(require("./providers/confluence/updatePage"));
+const callCopilot_1 = __importDefault(require("./providers/credal/callCopilot"));
+const validateAddress_1 = __importDefault(require("./providers/googlemaps/validateAddress"));
+const add_1 = __importDefault(require("./providers/math/add"));
+const insertMongoDoc_1 = __importDefault(require("./providers/mongodb/insertMongoDoc"));
+const listConversations_1 = __importDefault(require("./providers/slack/listConversations"));
+const sendMessage_1 = __importDefault(require("./providers/slack/sendMessage"));
+const getRowByFieldValue_1 = __importDefault(require("./providers/snowflake/getRowByFieldValue"));
+const createZendeskTicket_1 = __importDefault(require("./providers/zendesk/createZendeskTicket"));
+exports.ActionMapper = {
+    math: {
+        add: {
+            fn: add_1.default,
+            paramsSchema: types_1.mathAddParamsSchema,
+            outputSchema: types_1.mathAddOutputSchema,
+        },
+    },
+    slack: {
+        listConversations: {
+            fn: listConversations_1.default,
+            paramsSchema: types_1.slackListConversationsParamsSchema,
+            outputSchema: types_1.slackListConversationsOutputSchema,
+        },
+        sendMessage: {
+            fn: sendMessage_1.default,
+            paramsSchema: types_1.slackSendMessageParamsSchema,
+            outputSchema: types_1.slackSendMessageOutputSchema,
+        },
+    },
+    confluence: {
+        updatePage: {
+            fn: updatePage_1.default,
+            paramsSchema: types_1.confluenceUpdatePageParamsSchema,
+            outputSchema: types_1.confluenceUpdatePageOutputSchema,
+        },
+    },
+    googlemaps: {
+        validateAddress: {
+            fn: validateAddress_1.default,
+            paramsSchema: types_1.googlemapsValidateAddressParamsSchema,
+            outputSchema: types_1.googlemapsValidateAddressOutputSchema,
+        },
+    },
+    credal: {
+        callCopilot: {
+            fn: callCopilot_1.default,
+            paramsSchema: types_1.credalCallCopilotParamsSchema,
+            outputSchema: types_1.credalCallCopilotOutputSchema,
+        },
+    },
+    zendesk: {
+        createZendeskTicket: {
+            fn: createZendeskTicket_1.default,
+            paramsSchema: types_1.zendeskCreateZendeskTicketParamsSchema,
+            outputSchema: types_1.zendeskCreateZendeskTicketOutputSchema,
+        },
+    },
+    mongo: {
+        insertMongoDoc: {
+            fn: insertMongoDoc_1.default,
+            paramsSchema: types_1.mongoInsertMongoDocParamsSchema,
+            outputSchema: types_1.mongoInsertMongoDocOutputSchema,
+        },
+    },
+    snowflake: {
+        getRowByFieldValue: {
+            fn: getRowByFieldValue_1.default,
+            paramsSchema: types_1.snowflakeGetRowByFieldValueParamsSchema,
+            outputSchema: types_1.snowflakeGetRowByFieldValueOutputSchema,
+        },
+    },
+};

package/dist/actions/autogen/definitions.d.ts

@@ -0,0 +1,5 @@
+import { ActionTemplate } from "@/actions/parse";
+export declare const slackSendMessageDefinition: ActionTemplate;
+export declare const slackListConversationsDefinition: ActionTemplate;
+export declare const mathAddDefinition: ActionTemplate;
+export declare const confluenceUpdatePageDefinition: ActionTemplate;

package/dist/actions/autogen/definitions.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.confluenceUpdatePageDefinition = exports.mathAddDefinition = exports.slackListConversationsDefinition = exports.slackSendMessageDefinition = void 0;
+exports.slackSendMessageDefinition = {
+    provider: "slack",
+    name: "send_message",
+    description: "Sends a message to a Slack channel",
+    scopes: ["chat:write"],
+    parameters: {
+        channel: {
+            type: "string",
+            description: "The Slack channel to send the message to (e.g., \\#general, \\#alerts)",
+            required: true,
+        },
+        message: {
+            type: "string",
+            description: "The message content to send to Slack. Can include markdown formatting.",
+            required: true,
+        },
+    },
+    output: {},
+};
+exports.slackListConversationsDefinition = {
+    provider: "slack",
+    name: "list_conversations",
+    description: "Lists all conversations in a Slack workspace",
+    scopes: ["channels:read", "groups:read", "im:read", "mpim:read"],
+    authToken: {
+        type: "string",
+        description: "The Slack access token to use",
+        required: true,
+    },
+    parameters: {},
+    output: {
+        channels: {
+            type: "array",
+            description: "A list of channels in Slack",
+            required: true,
+            items: {
+                type: "object",
+                description: "A channel in Slack",
+                required: true,
+                properties: {
+                    id: {
+                        type: "string",
+                        description: "The ID of the channel",
+                        required: true,
+                    },
+                    name: {
+                        type: "string",
+                        description: "The name of the channel",
+                        required: true,
+                    },
+                    topic: {
+                        type: "string",
+                        description: "The topic of the channel",
+                        required: true,
+                    },
+                    purpose: {
+                        type: "string",
+                        description: "The purpose of the channel",
+                        required: true,
+                    },
+                },
+            },
+        },
+    },
+};
+exports.mathAddDefinition = {
+    provider: "math",
+    name: "add",
+    description: "Adds two numbers together",
+    scopes: [],
+    parameters: {
+        a: {
+            type: "number",
+            description: "The first number to add",
+            required: true,
+        },
+        b: {
+            type: "number",
+            description: "The second number to add",
+            required: true,
+        },
+    },
+    output: {
+        result: {
+            type: "number",
+            description: "The sum of the two numbers",
+            required: true,
+        },
+    },
+};
+exports.confluenceUpdatePageDefinition = {
+    provider: "confluence",
+    name: "updatePage",
+    description: "Updates a confluence page with the new content specified",
+    scopes: [],
+    authToken: {
+        type: "string",
+        description: "The access token to use for confluence",
+        required: true,
+    },
+    baseUrl: {
+        type: "string",
+        description: "The base url required to access the confluence instance",
+        required: true,
+    },
+    parameters: {
+        pageId: {
+            type: "string",
+            description: "The page id that should be updated",
+            required: true,
+        },
+        title: {
+            type: "string",
+            description: "The title of the page that should be updated",
+            required: true,
+        },
+        username: {
+            type: "string",
+            description: "The username of the person updating the page",
+            required: true,
+        },
+        content: {
+            type: "string",
+            description: "The new content for the page",
+            required: true,
+        },
+    },
+    output: {},
+};

package/dist/actions/autogen/templates.d.ts

@@ -0,0 +1,11 @@
+import { ActionTemplate } from "../../actions/parse";
+export declare const slackSendMessageDefinition: ActionTemplate;
+export declare const slackListConversationsDefinition: ActionTemplate;
+export declare const mathAddDefinition: ActionTemplate;
+export declare const confluenceUpdatePageDefinition: ActionTemplate;
+export declare const jiraCreateJiraTicketDefinition: ActionTemplate;
+export declare const googlemapsValidateAddressDefinition: ActionTemplate;
+export declare const credalCallCopilotDefinition: ActionTemplate;
+export declare const zendeskCreateZendeskTicketDefinition: ActionTemplate;
+export declare const mongoInsertMongoDocDefinition: ActionTemplate;
+export declare const snowflakeGetRowByFieldValueDefinition: ActionTemplate;