@credal/actions 0.1.17 → 0.1.20

package/README.md

@@ -1,4 +1,7 @@
-# actions
+![Credal Logo](assets/credal-logo.svg)
+
+## Credal.ai's Open Source Actions Framework
+Easily add custom actions for your Credal Copilots. Read more about Credal's Agent platform [here](https://www.credal.ai/products/ai-agent-platform).
 
 ## Adding or updating actions
 

package/dist/actions/actionMapper.js

@@ -24,6 +24,8 @@ const createSharePostLinkedinUrl_1 = __importDefault(require("./providers/linked
 const createNewGoogleDoc_1 = __importDefault(require("./providers/google-oauth/createNewGoogleDoc"));
 const createXSharePostUrl_1 = __importDefault(require("./providers/x/createXSharePostUrl"));
 const scrapeTweetDataWithNitter_1 = __importDefault(require("./providers/firecrawl/scrapeTweetDataWithNitter"));
+const symbolLookup_1 = __importDefault(require("./providers/finnhub/symbolLookup"));
+const getBasicFinancials_1 = __importDefault(require("./providers/finnhub/getBasicFinancials"));
 exports.ActionMapper = {
     math: {
         add: {
@@ -152,4 +154,16 @@ exports.ActionMapper = {
             outputSchema: types_1.xCreateShareXPostUrlOutputSchema,
         },
     },
+    finnhub: {
+        symbolLookup: {
+            fn: symbolLookup_1.default,
+            paramsSchema: types_1.finnhubSymbolLookupParamsSchema,
+            outputSchema: types_1.finnhubSymbolLookupOutputSchema,
+        },
+        getBasicFinancials: {
+            fn: getBasicFinancials_1.default,
+            paramsSchema: types_1.finnhubGetBasicFinancialsParamsSchema,
+            outputSchema: types_1.finnhubGetBasicFinancialsOutputSchema,
+        },
+    },
 };

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

@@ -18,3 +18,5 @@ export declare const firecrawlScrapeUrlDefinition: ActionTemplate;
 export declare const firecrawlScrapeTweetDataWithNitterDefinition: ActionTemplate;
 export declare const resendSendEmailDefinition: ActionTemplate;
 export declare const googleOauthCreateNewGoogleDocDefinition: ActionTemplate;
+export declare const finnhubSymbolLookupDefinition: ActionTemplate;
+export declare const finnhubGetBasicFinancialsDefinition: ActionTemplate;

package/dist/actions/autogen/templates.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.googleOauthCreateNewGoogleDocDefinition = exports.resendSendEmailDefinition = exports.firecrawlScrapeTweetDataWithNitterDefinition = exports.firecrawlScrapeUrlDefinition = exports.nwsGetForecastForLocationDefinition = exports.openstreetmapGetLatitudeLongitudeFromLocationDefinition = exports.snowflakeGetRowByFieldValueDefinition = exports.mongoInsertMongoDocDefinition = exports.xCreateShareXPostUrlDefinition = exports.linkedinCreateShareLinkedinPostUrlDefinition = exports.zendeskCreateZendeskTicketDefinition = exports.credalCallCopilotDefinition = exports.googlemapsNearbysearchRestaurantsDefinition = exports.googlemapsValidateAddressDefinition = exports.jiraCreateJiraTicketDefinition = exports.confluenceUpdatePageDefinition = exports.mathAddDefinition = exports.slackListConversationsDefinition = exports.slackSendMessageDefinition = void 0;
+exports.finnhubGetBasicFinancialsDefinition = exports.finnhubSymbolLookupDefinition = exports.googleOauthCreateNewGoogleDocDefinition = exports.resendSendEmailDefinition = exports.firecrawlScrapeTweetDataWithNitterDefinition = exports.firecrawlScrapeUrlDefinition = exports.nwsGetForecastForLocationDefinition = exports.openstreetmapGetLatitudeLongitudeFromLocationDefinition = exports.snowflakeGetRowByFieldValueDefinition = exports.mongoInsertMongoDocDefinition = exports.xCreateShareXPostUrlDefinition = exports.linkedinCreateShareLinkedinPostUrlDefinition = exports.zendeskCreateZendeskTicketDefinition = exports.credalCallCopilotDefinition = exports.googlemapsNearbysearchRestaurantsDefinition = exports.googlemapsValidateAddressDefinition = exports.jiraCreateJiraTicketDefinition = exports.confluenceUpdatePageDefinition = exports.mathAddDefinition = exports.slackListConversationsDefinition = exports.slackSendMessageDefinition = void 0;
 exports.slackSendMessageDefinition = {
     description: "Sends a message to a Slack channel",
     scopes: ["chat:write"],
@@ -149,6 +149,11 @@ exports.jiraCreateJiraTicketDefinition = {
                 type: "string",
                 description: "The assignee for the new ticket creation",
             },
+            customFields: {
+                type: "object",
+                description: "Custom fields to be set on the create ticket request",
+                additionalProperties: true,
+            },
         },
     },
     output: {
@@ -427,6 +432,82 @@ exports.credalCallCopilotDefinition = {
                 type: "string",
                 description: "The response from the Credal Copilot",
             },
+            referencedSources: {
+                type: "array",
+                description: "The sources referenced in the response",
+                items: {
+                    type: "object",
+                    description: "The source referenced in the response",
+                    required: ["id", "externalResourceId", "name"],
+                    properties: {
+                        id: {
+                            type: "string",
+                            description: "The id of the source",
+                        },
+                        externalResourceId: {
+                            type: "object",
+                            required: ["externalResourceId", "resourceType"],
+                            description: "The external resource id of the source",
+                            properties: {
+                                externalResourceId: {
+                                    type: "string",
+                                    description: "The external resource id of the source",
+                                },
+                                resourceType: {
+                                    type: "string",
+                                    description: "The type of the resource",
+                                },
+                            },
+                        },
+                        name: {
+                            type: "string",
+                            description: "The name of the source",
+                        },
+                        url: {
+                            type: "string",
+                            description: "The url of the source",
+                        },
+                    },
+                },
+            },
+            sourcesInDataContext: {
+                type: "array",
+                description: "The sources in the data context of the response",
+                items: {
+                    type: "object",
+                    description: "The source in the data context of the response",
+                    required: ["id", "externalResourceId", "name"],
+                    properties: {
+                        id: {
+                            type: "string",
+                            description: "The id of the source",
+                        },
+                        externalResourceId: {
+                            type: "object",
+                            description: "The external resource id of the source",
+                            required: ["externalResourceId", "resourceType"],
+                            properties: {
+                                externalResourceId: {
+                                    type: "string",
+                                    description: "The external resource id of the source",
+                                },
+                                resourceType: {
+                                    type: "string",
+                                    description: "The type of the resource",
+                                },
+                            },
+                        },
+                        name: {
+                            type: "string",
+                            description: "The name of the source",
+                        },
+                        url: {
+                            type: "string",
+                            description: "The url of the source",
+                        },
+                    },
+                },
+            },
         },
     },
     name: "callCopilot",
@@ -859,3 +940,135 @@ exports.googleOauthCreateNewGoogleDocDefinition = {
     name: "createNewGoogleDoc",
     provider: "googleOauth",
 };
+exports.finnhubSymbolLookupDefinition = {
+    description: "Look up a stock symbol by name",
+    scopes: [],
+    parameters: {
+        type: "object",
+        required: ["query"],
+        properties: {
+            query: {
+                type: "string",
+                description: "The query to look up",
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["result"],
+        properties: {
+            result: {
+                type: "array",
+                description: "The results of the symbol lookup",
+                items: {
+                    type: "object",
+                    description: "The metadata of the stock",
+                    properties: {
+                        symbol: {
+                            type: "string",
+                            description: "The symbol of the stock",
+                        },
+                        description: {
+                            type: "string",
+                            description: "The description of the stock",
+                        },
+                    },
+                },
+            },
+        },
+    },
+    name: "symbolLookup",
+    provider: "finnhub",
+};
+exports.finnhubGetBasicFinancialsDefinition = {
+    description: "Get company basic financials such as margin, P/E ratio, 52-week high/low etc.",
+    scopes: [],
+    parameters: {
+        type: "object",
+        required: ["symbol"],
+        properties: {
+            symbol: {
+                type: "string",
+                description: "The symbol/TICKER of the stock",
+            },
+        },
+    },
+    output: {
+        type: "object",
+        required: ["result"],
+        properties: {
+            result: {
+                type: "object",
+                description: "The basic financials of the stock",
+                properties: {
+                    annual: {
+                        type: "array",
+                        description: "The annual financials of the stock",
+                        items: {
+                            type: "object",
+                            description: "The annual financials of the stock",
+                            properties: {
+                                metric: {
+                                    type: "string",
+                                    description: "The name of the financial metric",
+                                },
+                                series: {
+                                    type: "array",
+                                    description: "The series of values for the financial metric",
+                                    items: {
+                                        type: "object",
+                                        description: "The value of the financial metric",
+                                        properties: {
+                                            period: {
+                                                type: "string",
+                                                description: "The period of the financial metric in YYYY-MM-DD format",
+                                            },
+                                            v: {
+                                                type: "number",
+                                                description: "The value of the financial metric",
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                    quarterly: {
+                        type: "array",
+                        description: "The quarterly financials of the stock",
+                        items: {
+                            type: "object",
+                            description: "The quarterly financials of the stock",
+                            properties: {
+                                metric: {
+                                    type: "string",
+                                    description: "The name of the financial metric",
+                                },
+                                series: {
+                                    type: "array",
+                                    description: "The series of values for the financial metric",
+                                    items: {
+                                        type: "object",
+                                        description: "The value of the financial metric",
+                                        properties: {
+                                            period: {
+                                                type: "string",
+                                                description: "The period of the financial metric in YYYY-MM-DD format",
+                                            },
+                                            v: {
+                                                type: "number",
+                                                description: "The value of the financial metric",
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    name: "getBasicFinancials",
+    provider: "finnhub",
+};

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

@@ -12,6 +12,7 @@ export declare const AuthParamsSchema: z.ZodObject<{
     emailFrom: z.ZodOptional<z.ZodString>;
     emailReplyTo: z.ZodOptional<z.ZodString>;
     emailBcc: z.ZodOptional<z.ZodString>;
+    cloudId: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     username?: string | undefined;
     authToken?: string | undefined;
@@ -21,6 +22,7 @@ export declare const AuthParamsSchema: z.ZodObject<{
     emailFrom?: string | undefined;
     emailReplyTo?: string | undefined;
     emailBcc?: string | undefined;
+    cloudId?: string | undefined;
 }, {
     username?: string | undefined;
     authToken?: string | undefined;
@@ -30,6 +32,7 @@ export declare const AuthParamsSchema: z.ZodObject<{
     emailFrom?: string | undefined;
     emailReplyTo?: string | undefined;
     emailBcc?: string | undefined;
+    cloudId?: string | undefined;
 }>;
 export type AuthParamsType = z.infer<typeof AuthParamsSchema>;
 export declare const slackSendMessageParamsSchema: z.ZodObject<{
@@ -129,6 +132,7 @@ export declare const jiraCreateJiraTicketParamsSchema: z.ZodObject<{
     issueType: z.ZodString;
     reporter: z.ZodOptional<z.ZodString>;
     assignee: z.ZodOptional<z.ZodString>;
+    customFields: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodAny, z.objectOutputType<{}, z.ZodAny, "strip">, z.objectInputType<{}, z.ZodAny, "strip">>>;
 }, "strip", z.ZodTypeAny, {
     description: string;
     projectKey: string;
@@ -136,6 +140,7 @@ export declare const jiraCreateJiraTicketParamsSchema: z.ZodObject<{
     issueType: string;
     reporter?: string | undefined;
     assignee?: string | undefined;
+    customFields?: z.objectOutputType<{}, z.ZodAny, "strip"> | undefined;
 }, {
     description: string;
     projectKey: string;
@@ -143,6 +148,7 @@ export declare const jiraCreateJiraTicketParamsSchema: z.ZodObject<{
     issueType: string;
     reporter?: string | undefined;
     assignee?: string | undefined;
+    customFields?: z.objectInputType<{}, z.ZodAny, "strip"> | undefined;
 }>;
 export type jiraCreateJiraTicketParamsType = z.infer<typeof jiraCreateJiraTicketParamsSchema>;
 export declare const jiraCreateJiraTicketOutputSchema: z.ZodObject<{
@@ -457,10 +463,108 @@ export declare const credalCallCopilotParamsSchema: z.ZodObject<{
 export type credalCallCopilotParamsType = z.infer<typeof credalCallCopilotParamsSchema>;
 export declare const credalCallCopilotOutputSchema: z.ZodObject<{
     response: z.ZodString;
+    referencedSources: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        externalResourceId: z.ZodObject<{
+            externalResourceId: z.ZodString;
+            resourceType: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            externalResourceId: string;
+            resourceType: string;
+        }, {
+            externalResourceId: string;
+            resourceType: string;
+        }>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        externalResourceId: {
+            externalResourceId: string;
+            resourceType: string;
+        };
+        url?: string | undefined;
+    }, {
+        name: string;
+        id: string;
+        externalResourceId: {
+            externalResourceId: string;
+            resourceType: string;
+        };
+        url?: string | undefined;
+    }>, "many">>;
+    sourcesInDataContext: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        externalResourceId: z.ZodObject<{
+            externalResourceId: z.ZodString;
+            resourceType: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            externalResourceId: string;
+            resourceType: string;
+        }, {
+            externalResourceId: string;
+            resourceType: string;
+        }>;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        externalResourceId: {
+            externalResourceId: string;
+            resourceType: string;
+        };
+        url?: string | undefined;
+    }, {
+        name: string;
+        id: string;
+        externalResourceId: {
+            externalResourceId: string;
+            resourceType: string;
+        };
+        url?: string | undefined;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     response: string;
+    referencedSources?: {
+        name: string;
+        id: string;
+        externalResourceId: {
+            externalResourceId: string;
+            resourceType: string;
+        };
+        url?: string | undefined;
+    }[] | undefined;
+    sourcesInDataContext?: {
+        name: string;
+        id: string;
+        externalResourceId: {
+            externalResourceId: string;
+            resourceType: string;
+        };
+        url?: string | undefined;
+    }[] | undefined;
 }, {
     response: string;
+    referencedSources?: {
+        name: string;
+        id: string;
+        externalResourceId: {
+            externalResourceId: string;
+            resourceType: string;
+        };
+        url?: string | undefined;
+    }[] | undefined;
+    sourcesInDataContext?: {
+        name: string;
+        id: string;
+        externalResourceId: {
+            externalResourceId: string;
+            resourceType: string;
+        };
+        url?: string | undefined;
+    }[] | undefined;
 }>;
 export type credalCallCopilotOutputType = z.infer<typeof credalCallCopilotOutputSchema>;
 export type credalCallCopilotFunction = ActionFunction<credalCallCopilotParamsType, AuthParamsType, credalCallCopilotOutputType>;
@@ -782,3 +886,163 @@ export declare const googleOauthCreateNewGoogleDocOutputSchema: z.ZodObject<{
 }>;
 export type googleOauthCreateNewGoogleDocOutputType = z.infer<typeof googleOauthCreateNewGoogleDocOutputSchema>;
 export type googleOauthCreateNewGoogleDocFunction = ActionFunction<googleOauthCreateNewGoogleDocParamsType, AuthParamsType, googleOauthCreateNewGoogleDocOutputType>;
+export declare const finnhubSymbolLookupParamsSchema: z.ZodObject<{
+    query: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    query: string;
+}, {
+    query: string;
+}>;
+export type finnhubSymbolLookupParamsType = z.infer<typeof finnhubSymbolLookupParamsSchema>;
+export declare const finnhubSymbolLookupOutputSchema: z.ZodObject<{
+    result: z.ZodArray<z.ZodObject<{
+        symbol: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        symbol?: string | undefined;
+        description?: string | undefined;
+    }, {
+        symbol?: string | undefined;
+        description?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    result: {
+        symbol?: string | undefined;
+        description?: string | undefined;
+    }[];
+}, {
+    result: {
+        symbol?: string | undefined;
+        description?: string | undefined;
+    }[];
+}>;
+export type finnhubSymbolLookupOutputType = z.infer<typeof finnhubSymbolLookupOutputSchema>;
+export type finnhubSymbolLookupFunction = ActionFunction<finnhubSymbolLookupParamsType, AuthParamsType, finnhubSymbolLookupOutputType>;
+export declare const finnhubGetBasicFinancialsParamsSchema: z.ZodObject<{
+    symbol: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    symbol: string;
+}, {
+    symbol: string;
+}>;
+export type finnhubGetBasicFinancialsParamsType = z.infer<typeof finnhubGetBasicFinancialsParamsSchema>;
+export declare const finnhubGetBasicFinancialsOutputSchema: z.ZodObject<{
+    result: z.ZodObject<{
+        annual: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            metric: z.ZodOptional<z.ZodString>;
+            series: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                period: z.ZodOptional<z.ZodString>;
+                v: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                period?: string | undefined;
+                v?: number | undefined;
+            }, {
+                period?: string | undefined;
+                v?: number | undefined;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }, {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }>, "many">>;
+        quarterly: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            metric: z.ZodOptional<z.ZodString>;
+            series: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                period: z.ZodOptional<z.ZodString>;
+                v: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                period?: string | undefined;
+                v?: number | undefined;
+            }, {
+                period?: string | undefined;
+                v?: number | undefined;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }, {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        annual?: {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }[] | undefined;
+        quarterly?: {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }[] | undefined;
+    }, {
+        annual?: {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }[] | undefined;
+        quarterly?: {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    result: {
+        annual?: {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }[] | undefined;
+        quarterly?: {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }[] | undefined;
+    };
+}, {
+    result: {
+        annual?: {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }[] | undefined;
+        quarterly?: {
+            metric?: string | undefined;
+            series?: {
+                period?: string | undefined;
+                v?: number | undefined;
+            }[] | undefined;
+        }[] | undefined;
+    };
+}>;
+export type finnhubGetBasicFinancialsOutputType = z.infer<typeof finnhubGetBasicFinancialsOutputSchema>;
+export type finnhubGetBasicFinancialsFunction = ActionFunction<finnhubGetBasicFinancialsParamsType, AuthParamsType, finnhubGetBasicFinancialsOutputType>;