freestyle-sandboxes 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,62 @@
+# Freestyle Sandboxes SDK
+
+SDK for [Freestyle Sandboxes API](https://api.freestyle.sh)
+
+## Installation
+
+```bash
+npm install freestyle-sandboxes
+```
+
+## Usage
+
+```javascript
+import { FreestyleSandboxes } from "freestyle-sandboxes";
+
+const sandboxes = new FreestyleSandboxes({
+  apiKey: "your-api-key",
+});
+
+sandboxes.executeScript(
+  `export default () => {
+  let set1 = [1, 2, 3, 4, 5];
+  let set2 = [4, 5, 6, 7, 8];
+
+  // find the sum of every value of each set multiplied by every value of the other set
+
+  let sum = 0;
+  for (let i = 0; i < set1.length; i++) {
+    for (let j = 0; j < set2.length; j++) {
+      sum += set1[i] * set2[j];
+    }
+  }
+
+  return sum;
+};`
+);
+```
+
+## AI SDK
+
+The freestyle-sandboxes/ai package provides utilities to add Freestyle Sandboxes to your AI.
+
+### Usage
+
+```javascript
+import { executeTool } from "freestyle-sandboxes/ai";
+import { generateText } from "ai";
+
+const codeExecutor = executeTool({
+  apiKey: "your-api-key",
+});
+
+const { text, steps } = await generateText({
+  model: yourModel,
+  tools: {
+    codeExecutor,
+  },
+  maxSteps: 2, // allow up to 5 steps
+  prompt:
+    "What is the sum of every number between 1 and 12 multiplied by itself?",
+});
+```

package/dist/ai/index.cjs

@@ -7,14 +7,19 @@ require('@hey-api/client-fetch');
 
 const executeTool = (config) => {
   const api = new index.FreestyleSandboxes({
-    apiKey: config.apiKey
+    ...config
   });
+  const envVars = Object.keys(config.envVars ?? {}).join(", ");
+  const nodeModules = Object.keys(config.nodeModules ?? {}).join(", ");
   return ai.tool({
-    description: "Execute a JavaScript or TypeScript script",
+    description: `Execute a JavaScript or TypeScript script.
+${envVars.length > 0 ? `You can use the following environment variables: ${envVars}` : ""}
+${nodeModules.length > 0 ? `You can use the following node modules: ${nodeModules}` : "You cannot use any node modules."}`,
     parameters: zod.z.object({
       script: zod.z.string().describe(`
             The JavaScript or TypeScript script to execute, must be in the format of:
             
+            import { someModule } from "someModule";
             export default () => {
                ... your code here ...
                return output;
@@ -22,6 +27,8 @@ const executeTool = (config) => {
 
             or for async functions:
 
+            import { someModule } from "someModule";
+
             export default async () => {
                 ... your code here ...
                 return output;
@@ -29,9 +36,56 @@ const executeTool = (config) => {
             `)
     }),
     execute: async ({ script }) => {
-      return api.executeScript(script, config);
+      try {
+        const res = await api.executeScript(script, config);
+        return res;
+      } catch (e) {
+        console.log("ERROR: ", e.message);
+        return `Error executing script:
+
+${script}
+
+Error: ${e.message}`;
+      }
+    }
+  });
+};
+const deployWebTool = (config) => {
+  const api = new index.FreestyleSandboxes({
+    ...config
+  });
+  const envVars = Object.keys(config.envVars ?? {}).join(", ");
+  const nodeModules = Object.keys(config.nodeModules ?? {}).join(", ");
+  return ai.tool({
+    description: `Deploy a Web project. ${envVars.length > 0 ? `You can use the following environment variables: ${envVars}` : ""}
+${nodeModules.length > 0 ? `You can use the following node modules: ${nodeModules}` : "You cannot use any node modules."}`,
+    parameters: zod.z.object({
+      files: zod.z.record(zod.z.string()).describe(`
+            A record of file names and their contents to deploy. For example:
+            {
+              "index.js": "import http from 'node:http';\\nnconsole.log('starting server');\\n\\nconst server = http.createServer(async(req, res) => {\\n  res.writeHead(200, { 'Content-Type': 'text/plain' });\\n  res.end('Welcome to New York its been waiting for you');\\n});\\n\\nserver.listen(3000, () => {\\n  console.log('Server is running at http://localhost:3000');\\n});",
+            }
+            `)
+    }),
+    execute: async ({ files }) => {
+      try {
+        const res = await api.deployWeb(files, config);
+        return res;
+      } catch (e) {
+        console.log("ERROR: ", e.message);
+        return `Error deploying web project:
+
+${JSON.stringify(
+          files,
+          null,
+          2
+        )}
+
+Error: ${e.message}`;
+      }
     }
   });
 };
 
+exports.deployWebTool = deployWebTool;
 exports.executeTool = executeTool;

package/dist/ai/index.d.cts

@@ -1,12 +1,10 @@
 import * as ai from 'ai';
-import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess } from '../types.gen-BoJEFWW-.js';
+import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, c as FreestyleDeployWebSuccessResponse } from '../types.gen-BoJEFWW-.js';
 import { z } from 'zod';
 
 /**
  * Execute a JavaScript or TypeScript script
  *
- *  **Note: Unless you tell it, the AI won't be aware of any node_modules or environment variables you give it, you need to tell it in your prompt what it can use.**
-
  *
  * @param config - Configuration for the tool
  * @param config.apiKey - The API key to use
@@ -20,10 +18,28 @@ declare const executeTool: (config: FreestyleExecuteScriptParamsConfiguration &
     script?: string;
 }, {
     script?: string;
-}>, FreestyleExecureScriptResultSuccess> & {
+}>, string | FreestyleExecureScriptResultSuccess> & {
     execute: (args: {
         script?: string;
-    }, options: ai.ToolExecutionOptions) => PromiseLike<FreestyleExecureScriptResultSuccess>;
+    }, options: ai.ToolExecutionOptions) => PromiseLike<string | FreestyleExecureScriptResultSuccess>;
+};
+/**
+ * Deploy a Web project
+ * @param config - Configuration for the tool
+ * @param config.apiKey - The API key to use
+ */
+declare const deployWebTool: (config: FreestyleExecuteScriptParamsConfiguration & {
+    apiKey: string;
+}) => ai.CoreTool<z.ZodObject<{
+    files: z.ZodRecord<z.ZodString, z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    files?: Record<string, string>;
+}, {
+    files?: Record<string, string>;
+}>, string | FreestyleDeployWebSuccessResponse> & {
+    execute: (args: {
+        files?: Record<string, string>;
+    }, options: ai.ToolExecutionOptions) => PromiseLike<string | FreestyleDeployWebSuccessResponse>;
 };
 
-export { executeTool };
+export { deployWebTool, executeTool };

package/dist/ai/index.d.mts

@@ -1,12 +1,10 @@
 import * as ai from 'ai';
-import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess } from '../types.gen-BoJEFWW-.js';
+import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, c as FreestyleDeployWebSuccessResponse } from '../types.gen-BoJEFWW-.js';
 import { z } from 'zod';
 
 /**
  * Execute a JavaScript or TypeScript script
  *
- *  **Note: Unless you tell it, the AI won't be aware of any node_modules or environment variables you give it, you need to tell it in your prompt what it can use.**
-
  *
  * @param config - Configuration for the tool
  * @param config.apiKey - The API key to use
@@ -20,10 +18,28 @@ declare const executeTool: (config: FreestyleExecuteScriptParamsConfiguration &
     script?: string;
 }, {
     script?: string;
-}>, FreestyleExecureScriptResultSuccess> & {
+}>, string | FreestyleExecureScriptResultSuccess> & {
     execute: (args: {
         script?: string;
-    }, options: ai.ToolExecutionOptions) => PromiseLike<FreestyleExecureScriptResultSuccess>;
+    }, options: ai.ToolExecutionOptions) => PromiseLike<string | FreestyleExecureScriptResultSuccess>;
+};
+/**
+ * Deploy a Web project
+ * @param config - Configuration for the tool
+ * @param config.apiKey - The API key to use
+ */
+declare const deployWebTool: (config: FreestyleExecuteScriptParamsConfiguration & {
+    apiKey: string;
+}) => ai.CoreTool<z.ZodObject<{
+    files: z.ZodRecord<z.ZodString, z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    files?: Record<string, string>;
+}, {
+    files?: Record<string, string>;
+}>, string | FreestyleDeployWebSuccessResponse> & {
+    execute: (args: {
+        files?: Record<string, string>;
+    }, options: ai.ToolExecutionOptions) => PromiseLike<string | FreestyleDeployWebSuccessResponse>;
 };
 
-export { executeTool };
+export { deployWebTool, executeTool };

package/dist/ai/index.mjs

@@ -5,14 +5,19 @@ import '@hey-api/client-fetch';
 
 const executeTool = (config) => {
   const api = new FreestyleSandboxes({
-    apiKey: config.apiKey
+    ...config
   });
+  const envVars = Object.keys(config.envVars ?? {}).join(", ");
+  const nodeModules = Object.keys(config.nodeModules ?? {}).join(", ");
   return tool({
-    description: "Execute a JavaScript or TypeScript script",
+    description: `Execute a JavaScript or TypeScript script.
+${envVars.length > 0 ? `You can use the following environment variables: ${envVars}` : ""}
+${nodeModules.length > 0 ? `You can use the following node modules: ${nodeModules}` : "You cannot use any node modules."}`,
     parameters: z.object({
       script: z.string().describe(`
             The JavaScript or TypeScript script to execute, must be in the format of:
             
+            import { someModule } from "someModule";
             export default () => {
                ... your code here ...
                return output;
@@ -20,6 +25,8 @@ const executeTool = (config) => {
 
             or for async functions:
 
+            import { someModule } from "someModule";
+
             export default async () => {
                 ... your code here ...
                 return output;
@@ -27,9 +34,55 @@ const executeTool = (config) => {
             `)
     }),
     execute: async ({ script }) => {
-      return api.executeScript(script, config);
+      try {
+        const res = await api.executeScript(script, config);
+        return res;
+      } catch (e) {
+        console.log("ERROR: ", e.message);
+        return `Error executing script:
+
+${script}
+
+Error: ${e.message}`;
+      }
+    }
+  });
+};
+const deployWebTool = (config) => {
+  const api = new FreestyleSandboxes({
+    ...config
+  });
+  const envVars = Object.keys(config.envVars ?? {}).join(", ");
+  const nodeModules = Object.keys(config.nodeModules ?? {}).join(", ");
+  return tool({
+    description: `Deploy a Web project. ${envVars.length > 0 ? `You can use the following environment variables: ${envVars}` : ""}
+${nodeModules.length > 0 ? `You can use the following node modules: ${nodeModules}` : "You cannot use any node modules."}`,
+    parameters: z.object({
+      files: z.record(z.string()).describe(`
+            A record of file names and their contents to deploy. For example:
+            {
+              "index.js": "import http from 'node:http';\\nnconsole.log('starting server');\\n\\nconst server = http.createServer(async(req, res) => {\\n  res.writeHead(200, { 'Content-Type': 'text/plain' });\\n  res.end('Welcome to New York its been waiting for you');\\n});\\n\\nserver.listen(3000, () => {\\n  console.log('Server is running at http://localhost:3000');\\n});",
+            }
+            `)
+    }),
+    execute: async ({ files }) => {
+      try {
+        const res = await api.deployWeb(files, config);
+        return res;
+      } catch (e) {
+        console.log("ERROR: ", e.message);
+        return `Error deploying web project:
+
+${JSON.stringify(
+          files,
+          null,
+          2
+        )}
+
+Error: ${e.message}`;
+      }
     }
   });
 };
 
-export { executeTool };
+export { deployWebTool, executeTool };

package/dist/index.cjs

@@ -58,7 +58,17 @@ class FreestyleSandboxes {
     if (response.data) {
       return response.data;
     } else {
-      throw new Error("Failed to execute script");
+      throw new Error(
+        `Failed to execute script: 
+
+${script}
+
+Error:
+
+${JSON.stringify(
+          response
+        )}`
+      );
     }
   }
   /**
@@ -117,7 +127,7 @@ class FreestyleSandboxes {
    * @returns The logs for the sandbox.
    * @throws An error if the logs could not be retrieved.
    */
-  async getLogs(id) {
+  async getWebLogs(id) {
     const response = await handleGetLogs({
       client: this.client,
       path: {

package/dist/index.d.cts

@@ -15,11 +15,11 @@ declare class FreestyleSandboxes {
     /**
      * Execute a script in a sandbox.
      */
-    executeScript(script: string, config: FreestyleExecuteScriptParamsConfiguration): Promise<FreestyleExecureScriptResultSuccess>;
+    executeScript(script: string, config?: FreestyleExecuteScriptParamsConfiguration): Promise<FreestyleExecureScriptResultSuccess>;
     /**
      * Deploy a Web project to a sandbox.
      */
-    deployWeb(files: Record<string, string>, config: FreestyleDeployWebConfiguration): Promise<FreestyleDeployWebSuccessResponse>;
+    deployWeb(files: Record<string, string>, config?: FreestyleDeployWebConfiguration): Promise<FreestyleDeployWebSuccessResponse>;
     /**
      * Deploy a Cloudstate project to a sandbox.
      */
@@ -37,7 +37,7 @@ declare class FreestyleSandboxes {
      * @returns The logs for the sandbox.
      * @throws An error if the logs could not be retrieved.
      */
-    getLogs(id: string): Promise<HandleGetLogsResponse>;
+    getWebLogs(id: string): Promise<HandleGetLogsResponse>;
 }
 
 export { FreestyleSandboxes };

package/dist/index.d.mts

@@ -15,11 +15,11 @@ declare class FreestyleSandboxes {
     /**
      * Execute a script in a sandbox.
      */
-    executeScript(script: string, config: FreestyleExecuteScriptParamsConfiguration): Promise<FreestyleExecureScriptResultSuccess>;
+    executeScript(script: string, config?: FreestyleExecuteScriptParamsConfiguration): Promise<FreestyleExecureScriptResultSuccess>;
     /**
      * Deploy a Web project to a sandbox.
      */
-    deployWeb(files: Record<string, string>, config: FreestyleDeployWebConfiguration): Promise<FreestyleDeployWebSuccessResponse>;
+    deployWeb(files: Record<string, string>, config?: FreestyleDeployWebConfiguration): Promise<FreestyleDeployWebSuccessResponse>;
     /**
      * Deploy a Cloudstate project to a sandbox.
      */
@@ -37,7 +37,7 @@ declare class FreestyleSandboxes {
      * @returns The logs for the sandbox.
      * @throws An error if the logs could not be retrieved.
      */
-    getLogs(id: string): Promise<HandleGetLogsResponse>;
+    getWebLogs(id: string): Promise<HandleGetLogsResponse>;
 }
 
 export { FreestyleSandboxes };

package/dist/index.mjs

@@ -56,7 +56,17 @@ class FreestyleSandboxes {
     if (response.data) {
       return response.data;
     } else {
-      throw new Error("Failed to execute script");
+      throw new Error(
+        `Failed to execute script: 
+
+${script}
+
+Error:
+
+${JSON.stringify(
+          response
+        )}`
+      );
     }
   }
   /**
@@ -115,7 +125,7 @@ class FreestyleSandboxes {
    * @returns The logs for the sandbox.
    * @throws An error if the logs could not be retrieved.
    */
-  async getLogs(id) {
+  async getWebLogs(id) {
     const response = await handleGetLogs({
       client: this.client,
       path: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freestyle-sandboxes",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/src/ai/index.ts

@@ -5,9 +5,7 @@ import { z } from "zod";
 
 /**
  * Execute a JavaScript or TypeScript script
- * 
- *  **Note: Unless you tell it, the AI won't be aware of any node_modules or environment variables you give it, you need to tell it in your prompt what it can use.**
-
+ *
  *
  * @param config - Configuration for the tool
  * @param config.apiKey - The API key to use
@@ -19,14 +17,26 @@ export const executeTool = (
   }
 ) => {
   const api = new FreestyleSandboxes({
-    apiKey: config.apiKey,
+    ...config,
   });
+
+  const envVars = Object.keys(config.envVars ?? {}).join(", ");
+  const nodeModules = Object.keys(config.nodeModules ?? {}).join(", ");
   return tool({
-    description: "Execute a JavaScript or TypeScript script",
+    description: `Execute a JavaScript or TypeScript script.\n${
+      envVars.length > 0
+        ? `You can use the following environment variables: ${envVars}`
+        : ""
+    }\n${
+      nodeModules.length > 0
+        ? `You can use the following node modules: ${nodeModules}`
+        : "You cannot use any node modules."
+    }`,
     parameters: z.object({
       script: z.string().describe(`
             The JavaScript or TypeScript script to execute, must be in the format of:
             
+            import { someModule } from "someModule";
             export default () => {
                ... your code here ...
                return output;
@@ -34,6 +44,8 @@ export const executeTool = (
 
             or for async functions:
 
+            import { someModule } from "someModule";
+
             export default async () => {
                 ... your code here ...
                 return output;
@@ -41,7 +53,63 @@ export const executeTool = (
             `),
     }),
     execute: async ({ script }) => {
-      return api.executeScript(script, config);
+      try {
+        const res = await api.executeScript(script, config);
+        return res;
+      } catch (e) {
+        console.log("ERROR: ", e.message);
+        return `Error executing script:\n\n${script}\n\nError: ${e.message}`;
+      }
+    },
+  });
+};
+
+/**
+ * Deploy a Web project
+ * @param config - Configuration for the tool
+ * @param config.apiKey - The API key to use
+ */
+export const deployWebTool = (
+  config: FreestyleExecuteScriptParamsConfiguration & {
+    apiKey: string;
+  }
+) => {
+  const api = new FreestyleSandboxes({
+    ...config,
+  });
+
+  const envVars = Object.keys(config.envVars ?? {}).join(", ");
+  const nodeModules = Object.keys(config.nodeModules ?? {}).join(", ");
+  return tool({
+    description: `Deploy a Web project. ${
+      envVars.length > 0
+        ? `You can use the following environment variables: ${envVars}`
+        : ""
+    }\n${
+      nodeModules.length > 0
+        ? `You can use the following node modules: ${nodeModules}`
+        : "You cannot use any node modules."
+    }`,
+    parameters: z.object({
+      files: z.record(z.string()).describe(`
+            A record of file names and their contents to deploy. For example:
+            {
+              "index.js": "import http from 'node:http';\\nnconsole.log('starting server');\\n\\nconst server = http.createServer(async(req, res) => {\\n  res.writeHead(200, { 'Content-Type': 'text/plain' });\\n  res.end('Welcome to New York its been waiting for you');\\n});\\n\\nserver.listen(3000, () => {\\n  console.log('Server is running at http://localhost:3000');\\n});",
+            }
+            `),
+    }),
+    execute: async ({ files }) => {
+      try {
+        const res = await api.deployWeb(files, config);
+        return res;
+      } catch (e) {
+        console.log("ERROR: ", e.message);
+        return `Error deploying web project:\n\n${JSON.stringify(
+          files,
+          null,
+          2
+        )}\n\nError: ${e.message}`;
+      }
     },
   });
 };

package/src/index.ts

@@ -25,7 +25,7 @@ export class FreestyleSandboxes {
    */
   async executeScript(
     script: string,
-    config: sandbox_openapi.FreestyleExecuteScriptParamsConfiguration
+    config?: sandbox_openapi.FreestyleExecuteScriptParamsConfiguration
   ): Promise<sandbox_openapi.FreestyleExecureScriptResultSuccess> {
     const response = await sandbox_openapi.handleExecuteScript({
       client: this.client,
@@ -34,10 +34,15 @@ export class FreestyleSandboxes {
         config: config,
       },
     });
+
     if (response.data) {
       return response.data;
     } else {
-      throw new Error("Failed to execute script");
+      throw new Error(
+        `Failed to execute script: \n\n${script}\n\nError:\n\n${JSON.stringify(
+          response
+        )}`
+      );
     }
   }
 
@@ -46,7 +51,7 @@ export class FreestyleSandboxes {
    */
   async deployWeb(
     files: Record<string, string>,
-    config: sandbox_openapi.FreestyleDeployWebConfiguration
+    config?: sandbox_openapi.FreestyleDeployWebConfiguration
   ): Promise<sandbox_openapi.FreestyleDeployWebSuccessResponse> {
     const response = await sandbox_openapi.handleDeployWeb({
       client: this.client,
@@ -107,7 +112,7 @@ export class FreestyleSandboxes {
    * @returns The logs for the sandbox.
    * @throws An error if the logs could not be retrieved.
    */
-  async getLogs(id: string): Promise<sandbox_openapi.HandleGetLogsResponse> {
+  async getWebLogs(id: string): Promise<sandbox_openapi.HandleGetLogsResponse> {
     const response = await sandbox_openapi.handleGetLogs({
       client: this.client,
       path: {

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
     "allowImportingTsExtensions": true,
-    "lib": ["ESNext"]
+    "lib": ["ESNext", "DOM"]
   }
 }