@credal/actions 0.1.57 → 0.1.59

package/README.md

@@ -6,6 +6,8 @@ Easily add custom actions for your Credal Copilots. Read more about Credal's Age
 
 ## Adding or updating actions
 
+We strongly encourage you to develop actions that rely on oauth based credentials. This is to ensure we respect the permissions of the underlying systems the actions library interacts with. In some situations, oauth is not a valid option and so API keys are a good fallback.
+
 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
@@ -25,7 +27,7 @@ const result = await runAction(
   "listConversations",
   "slack",
   { authToken: "xoxb-..." },
-  {},
+  {}
 );
 ```
 

package/dist/actions/providers/confluence/fetchPageContent.js

@@ -9,26 +9,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_1 = require("./helpers");
 const axiosClient_1 = require("../../util/axiosClient");
-function getConfluenceRequestConfig(baseUrl, username, apiToken) {
-    return {
-        baseURL: baseUrl,
-        headers: {
-            Accept: "application/json",
-            Authorization: `Basic ${Buffer.from(`${username}:${apiToken}`).toString("base64")}`,
-        },
-    };
-}
 const confluenceFetchPageContent = (_a) => __awaiter(void 0, [_a], void 0, function* ({ params, authParams, }) {
     var _b, _c;
     const { pageId } = params;
-    const { baseUrl, authToken, username } = authParams;
-    if (!baseUrl || !authToken || !username) {
+    const { authToken } = authParams;
+    if (!authToken) {
         throw new Error("Missing required authentication parameters");
     }
-    const config = getConfluenceRequestConfig(baseUrl, username, authToken);
+    const cloudDetails = yield axiosClient_1.axiosClient.get("https://api.atlassian.com/oauth/token/accessible-resources");
+    const cloudId = cloudDetails.data[0].id;
+    const baseUrl = `https://api.atlassian.com/ex/confluence/${cloudId}/api/v2`;
+    const config = (0, helpers_1.getConfluenceRequestConfig)(baseUrl, authToken);
     // Get page content and metadata
-    const response = yield axiosClient_1.axiosClient.get(`/api/v2/pages/${pageId}?body-format=storage`, config);
+    const response = yield axiosClient_1.axiosClient.get(`/pages/${pageId}?body-format=storage`, config);
     // Extract needed data from response
     const title = response.data.title;
     const content = ((_c = (_b = response.data.body) === null || _b === void 0 ? void 0 : _b.storage) === null || _c === void 0 ? void 0 : _c.value) || "";

package/dist/actions/providers/confluence/helpers.d.ts

@@ -0,0 +1,2 @@
+import type { AxiosRequestConfig } from "axios";
+export declare function getConfluenceRequestConfig(baseUrl: string, authToken: string): AxiosRequestConfig;

package/dist/actions/providers/confluence/helpers.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfluenceRequestConfig = getConfluenceRequestConfig;
+function getConfluenceRequestConfig(baseUrl, authToken) {
+    return {
+        baseURL: baseUrl,
+        headers: {
+            Accept: "application/json",
+            Authorization: `Bearer ${authToken}`,
+        },
+    };
+}

package/dist/actions/providers/confluence/overwritePage.js

@@ -10,24 +10,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const axiosClient_1 = require("../../util/axiosClient");
-function getConfluenceRequestConfig(baseUrl, username, apiToken) {
-    return {
-        baseURL: baseUrl,
-        headers: {
-            Accept: "application/json",
-            Authorization: `Basic ${Buffer.from(`${username}:${apiToken}`).toString("base64")}`,
-        },
-    };
-}
+const helpers_1 = require("./helpers");
 const confluenceOverwritePage = (_a) => __awaiter(void 0, [_a], void 0, function* ({ params, authParams, }) {
     const { pageId, content, title } = params;
-    const { baseUrl, authToken, username } = authParams;
-    if (!baseUrl || !authToken || !username) {
+    const { authToken } = authParams;
+    if (!authToken) {
         throw new Error("Missing required authentication parameters");
     }
-    const config = getConfluenceRequestConfig(baseUrl, username, authToken);
+    const cloudDetails = yield axiosClient_1.axiosClient.get("https://api.atlassian.com/oauth/token/accessible-resources");
+    const cloudId = cloudDetails.data[0].id;
+    const baseUrl = `https://api.atlassian.com/ex/confluence/${cloudId}/api/v2`;
+    const config = (0, helpers_1.getConfluenceRequestConfig)(baseUrl, authToken);
     // Get current page content and version number
-    const response = yield axiosClient_1.axiosClient.get(`/api/v2/pages/${pageId}?body-format=storage`, config);
+    const response = yield axiosClient_1.axiosClient.get(`/pages/${pageId}?body-format=storage`, config);
     const currVersion = response.data.version.number;
     const payload = {
         id: pageId,
@@ -41,6 +36,6 @@ const confluenceOverwritePage = (_a) => __awaiter(void 0, [_a], void 0, function
             number: currVersion + 1,
         },
     };
-    yield axiosClient_1.axiosClient.put(`/api/v2/pages/${pageId}`, payload, config);
+    yield axiosClient_1.axiosClient.put(`/pages/${pageId}`, payload, config);
 });
 exports.default = confluenceOverwritePage;

package/dist/actions/providers/confluence/updatePage.d.ts

@@ -0,0 +1,3 @@
+import { confluenceUpdatePageFunction } from "../../../actions/autogen/types";
+declare const confluenceUpdatePage: confluenceUpdatePageFunction;
+export default confluenceUpdatePage;

package/dist/actions/providers/confluence/updatePage.js

@@ -0,0 +1,47 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+function getConfluenceApi(baseUrl, username, apiToken) {
+    const api = axios_1.default.create({
+        baseURL: baseUrl,
+        headers: {
+            Accept: "application/json",
+            // Tokens are associated with a specific user.
+            Authorization: `Basic ${Buffer.from(`${username}:${apiToken}`).toString("base64")}`,
+        },
+    });
+    return api;
+}
+const confluenceUpdatePage = (_a) => __awaiter(void 0, [_a], void 0, function* ({ params, authParams, }) {
+    const { pageId, username, content, title } = params;
+    const { baseUrl, authToken } = authParams;
+    const api = getConfluenceApi(baseUrl, username, authToken);
+    // Get current version number
+    const response = yield api.get(`/api/v2/pages/${pageId}`);
+    const currVersion = response.data.version.number;
+    yield api.put(`/api/v2/pages/${pageId}`, {
+        id: pageId,
+        status: "current",
+        title,
+        body: {
+            representation: "storage",
+            value: content,
+        },
+        version: {
+            number: currVersion + 1,
+        },
+    });
+});
+exports.default = confluenceUpdatePage;

package/dist/actions/providers/workday/requestTimeOff.d.ts

@@ -0,0 +1,23 @@
+declare const axios: any;
+declare const WORKDAY_BASE_URL = "https://your-workday-url/ccx/service/YOUR_TENANT/Absence_Management/v43.2";
+declare const TOKEN_URL = "https://your-workday-url/oauth2/YOUR_TENANT/token";
+declare const CLIENT_ID = "your-client-id";
+declare const CLIENT_SECRET = "your-client-secret";
+/**
+ * Fetches an OAuth 2.0 access token from Workday.
+ */
+declare function getAccessToken(): Promise<any>;
+/**
+ * Submits a time-off request to Workday.
+ * @param {Object} params - Time-off details.
+ * @param {string} params.workerId - Worker's ID in Workday.
+ * @param {string} params.startDate - Start date (YYYY-MM-DD).
+ * @param {string} params.endDate - End date (YYYY-MM-DD).
+ * @param {string} params.timeOffType - Time-off type (e.g., "SICK_LEAVE").
+ */
+declare function submitTimeOff({ workerId, startDate, endDate, timeOffType }: {
+    workerId: any;
+    startDate: any;
+    endDate: any;
+    timeOffType: any;
+}): Promise<any>;

package/dist/actions/providers/workday/requestTimeOff.js

@@ -0,0 +1,88 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+const axios = require("axios");
+const WORKDAY_BASE_URL = "https://your-workday-url/ccx/service/YOUR_TENANT/Absence_Management/v43.2";
+const TOKEN_URL = "https://your-workday-url/oauth2/YOUR_TENANT/token"; // OAuth token endpoint
+const CLIENT_ID = "your-client-id";
+const CLIENT_SECRET = "your-client-secret";
+/**
+ * Fetches an OAuth 2.0 access token from Workday.
+ */
+function getAccessToken() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        try {
+            const response = yield axios.post(TOKEN_URL, new URLSearchParams({ grant_type: "client_credentials" }), {
+                auth: {
+                    username: CLIENT_ID,
+                    password: CLIENT_SECRET
+                },
+                headers: { "Content-Type": "application/x-www-form-urlencoded" }
+            });
+            return response.data.access_token;
+        }
+        catch (error) {
+            console.error("Error fetching access token:", ((_a = error.response) === null || _a === void 0 ? void 0 : _a.data) || error.message);
+            throw error;
+        }
+    });
+}
+/**
+ * Submits a time-off request to Workday.
+ * @param {Object} params - Time-off details.
+ * @param {string} params.workerId - Worker's ID in Workday.
+ * @param {string} params.startDate - Start date (YYYY-MM-DD).
+ * @param {string} params.endDate - End date (YYYY-MM-DD).
+ * @param {string} params.timeOffType - Time-off type (e.g., "SICK_LEAVE").
+ */
+function submitTimeOff(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ workerId, startDate, endDate, timeOffType }) {
+        var _b;
+        try {
+            const token = yield getAccessToken(); // Get OAuth token
+            const requestBody = {
+                "wd:Enter_Time_Off_Request": {
+                    "wd:Worker_Reference": {
+                        "wd:ID": [{ "_": workerId, "$": { "wd:type": "WID" } }]
+                    },
+                    "wd:Time_Off_Entries": [
+                        {
+                            "wd:Start_Date": startDate,
+                            "wd:End_Date": endDate,
+                            "wd:Time_Off_Type_Reference": {
+                                "wd:ID": [{ "_": timeOffType, "$": { "wd:type": "Time_Off_Type_ID" } }]
+                            }
+                        }
+                    ]
+                }
+            };
+            const response = yield axios.post(`${WORKDAY_BASE_URL}/Enter_Time_Off`, requestBody, {
+                headers: {
+                    "Authorization": `Bearer ${token}`,
+                    "Content-Type": "application/json"
+                }
+            });
+            console.log("Time-off request submitted successfully:", response.data);
+            return response.data;
+        }
+        catch (error) {
+            console.error("Error submitting time-off request:", ((_b = error.response) === null || _b === void 0 ? void 0 : _b.data) || error.message);
+            throw error;
+        }
+    });
+}
+// Example Usage:
+submitTimeOff({
+    workerId: "12345",
+    startDate: "2025-03-10",
+    endDate: "2025-03-12",
+    timeOffType: "SICK_LEAVE"
+}).then(console.log).catch(console.error);

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { runAction, getActionGroups, type ActionGroupsReturn } from "./app";
 export { ACTION_GROUPS, type ActionGroups } from "./actions/groups";
+export { ActionMapper } from "./actions/actionMapper";
 export * from "./actions/autogen/templates";
 export * from "./actions/autogen/types";
 export * from "./actions/providers/math/index";

package/dist/index.js

@@ -15,12 +15,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ACTION_GROUPS = exports.getActionGroups = exports.runAction = void 0;
+exports.ActionMapper = exports.ACTION_GROUPS = exports.getActionGroups = exports.runAction = void 0;
 var app_1 = require("./app");
 Object.defineProperty(exports, "runAction", { enumerable: true, get: function () { return app_1.runAction; } });
 Object.defineProperty(exports, "getActionGroups", { enumerable: true, get: function () { return app_1.getActionGroups; } });
 var groups_1 = require("./actions/groups");
 Object.defineProperty(exports, "ACTION_GROUPS", { enumerable: true, get: function () { return groups_1.ACTION_GROUPS; } });
+var actionMapper_1 = require("./actions/actionMapper");
+Object.defineProperty(exports, "ActionMapper", { enumerable: true, get: function () { return actionMapper_1.ActionMapper; } });
 __exportStar(require("./actions/autogen/templates"), exports);
 __exportStar(require("./actions/autogen/types"), exports);
 __exportStar(require("./actions/providers/math/index"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@credal/actions",
-  "version": "0.1.57",
+  "version": "0.1.59",
   "description": "AI Actions by Credal AI",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/actions/providers/salesforce/getSalesforceRecordByQuery.d.ts

@@ -1,3 +0,0 @@
-import { salesforceGetSalesforceRecordsByQueryFunction } from "../../autogen/types";
-declare const getSalesforceRecordByQuery: salesforceGetSalesforceRecordsByQueryFunction;
-export default getSalesforceRecordByQuery;

package/dist/actions/providers/salesforce/getSalesforceRecordByQuery.js

@@ -1,43 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axiosClient_1 = require("../../util/axiosClient");
-const getSalesforceRecordByQuery = (_a) => __awaiter(void 0, [_a], void 0, function* ({ params, authParams, }) {
-    const { authToken, baseUrl } = authParams;
-    const { query, limit } = params;
-    if (!authToken || !baseUrl) {
-        return {
-            success: false,
-            error: "authToken and baseUrl are required for Salesforce API",
-        };
-    }
-    // The API limits the maximum number of records returned to 2000, the limit lets the user set a smaller custom limit
-    const url = `${baseUrl}/services/data/v56.0/query/?q=${encodeURIComponent(query + " LIMIT " + (limit != undefined && limit <= 2000 ? limit : 2000))}`;
-    try {
-        const response = yield axiosClient_1.axiosClient.get(url, {
-            headers: {
-                Authorization: `Bearer ${authToken}`,
-            },
-        });
-        return {
-            success: true,
-            records: response.data,
-        };
-    }
-    catch (error) {
-        console.error("Error retrieving Salesforce record:", error);
-        return {
-            success: false,
-            error: error instanceof Error ? error.message : "An unknown error occurred",
-        };
-    }
-});
-exports.default = getSalesforceRecordByQuery;