freestyle-sandboxes 0.0.3 → 0.0.5

package/dist/ai/index.cjs

@@ -68,8 +68,12 @@ ${nodeModules.length > 0 ? `You can use the following node modules: ${nodeModule
             `)
     }),
     execute: async ({ files }) => {
+      const new_files = Object.keys(files).reduce((acc, key) => {
+        acc[key] = { content: files[key] };
+        return acc;
+      }, {});
       try {
-        const res = await api.deployWeb(files, config);
+        const res = await api.deployWeb(new_files, config);
         return res;
       } catch (e) {
         console.log("ERROR: ", e.message);

package/dist/ai/index.d.cts

@@ -1,5 +1,5 @@
 import * as ai from 'ai';
-import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, c as FreestyleDeployWebSuccessResponse } from '../types.gen-BoJEFWW-.js';
+import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, c as FreestyleDeployWebSuccessResponse } from '../types.gen-DyY7Deri.js';
 import { z } from 'zod';
 
 /**

package/dist/ai/index.d.mts

@@ -1,5 +1,5 @@
 import * as ai from 'ai';
-import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, c as FreestyleDeployWebSuccessResponse } from '../types.gen-BoJEFWW-.js';
+import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, c as FreestyleDeployWebSuccessResponse } from '../types.gen-DyY7Deri.js';
 import { z } from 'zod';
 
 /**

package/dist/ai/index.mjs

@@ -66,8 +66,12 @@ ${nodeModules.length > 0 ? `You can use the following node modules: ${nodeModule
             `)
     }),
     execute: async ({ files }) => {
+      const new_files = Object.keys(files).reduce((acc, key) => {
+        acc[key] = { content: files[key] };
+        return acc;
+      }, {});
       try {
-        const res = await api.deployWeb(files, config);
+        const res = await api.deployWeb(new_files, config);
         return res;
       } catch (e) {
         console.log("ERROR: ", e.message);

package/dist/index.cjs

@@ -85,7 +85,9 @@ ${JSON.stringify(
     if (response.data) {
       return response.data;
     } else {
-      throw new Error("Failed to deploy Web project");
+      throw new Error(
+        `Failed to deploy web project: ${response.error?.message}`
+      );
     }
   }
   /**

package/dist/index.d.cts

@@ -1,4 +1,5 @@
-import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, b as FreestyleDeployWebConfiguration, c as FreestyleDeployWebSuccessResponse, d as FreestyleCloudstateDeployRequest, e as FreestyleCloudstateDeploySuccessResponse, H as HandleBackupCloudstateResponse, f as HandleGetLogsResponse } from './types.gen-BoJEFWW-.js';
+import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, b as FreestyleDeployWebConfiguration, c as FreestyleDeployWebSuccessResponse, d as FreestyleCloudstateDeployRequest, e as FreestyleCloudstateDeploySuccessResponse, H as HandleBackupCloudstateResponse, f as HandleGetLogsResponse } from './types.gen-DyY7Deri.js';
+export { g as FreestyleCloudstateDeployConfiguration, h as FreestyleCloudstateDeployErrorResponse, i as FreestyleDeployWebErrorResponse, j as FreestyleDeployWebPayload, k as FreestyleExecureScriptResultError, l as FreestyleExecuteScriptParams, m as FreestyleFile, n as FreestyleLogResponseObject, r as HandleBackupCloudstateError, o as HandleDeployCloudstateData, q as HandleDeployCloudstateError, p as HandleDeployCloudstateResponse, v as HandleDeployWebData, x as HandleDeployWebError, w as HandleDeployWebResponse, s as HandleExecuteScriptData, u as HandleExecuteScriptError, t as HandleExecuteScriptResponse, y as HandleGetLogsError } from './types.gen-DyY7Deri.js';
 
 declare class FreestyleSandboxes {
     private client;
@@ -19,7 +20,10 @@ declare class FreestyleSandboxes {
     /**
      * Deploy a Web project to a sandbox.
      */
-    deployWeb(files: Record<string, string>, config?: FreestyleDeployWebConfiguration): Promise<FreestyleDeployWebSuccessResponse>;
+    deployWeb(files: Record<string, {
+        content: string;
+        encoding?: string;
+    }>, config?: FreestyleDeployWebConfiguration): Promise<FreestyleDeployWebSuccessResponse>;
     /**
      * Deploy a Cloudstate project to a sandbox.
      */
@@ -40,4 +44,4 @@ declare class FreestyleSandboxes {
     getWebLogs(id: string): Promise<HandleGetLogsResponse>;
 }
 
-export { FreestyleSandboxes };
+export { FreestyleCloudstateDeployRequest, FreestyleCloudstateDeploySuccessResponse, FreestyleDeployWebConfiguration, FreestyleDeployWebSuccessResponse, FreestyleExecureScriptResultSuccess, FreestyleExecuteScriptParamsConfiguration, FreestyleSandboxes, HandleBackupCloudstateResponse, HandleGetLogsResponse };

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, b as FreestyleDeployWebConfiguration, c as FreestyleDeployWebSuccessResponse, d as FreestyleCloudstateDeployRequest, e as FreestyleCloudstateDeploySuccessResponse, H as HandleBackupCloudstateResponse, f as HandleGetLogsResponse } from './types.gen-BoJEFWW-.js';
+import { F as FreestyleExecuteScriptParamsConfiguration, a as FreestyleExecureScriptResultSuccess, b as FreestyleDeployWebConfiguration, c as FreestyleDeployWebSuccessResponse, d as FreestyleCloudstateDeployRequest, e as FreestyleCloudstateDeploySuccessResponse, H as HandleBackupCloudstateResponse, f as HandleGetLogsResponse } from './types.gen-DyY7Deri.js';
+export { g as FreestyleCloudstateDeployConfiguration, h as FreestyleCloudstateDeployErrorResponse, i as FreestyleDeployWebErrorResponse, j as FreestyleDeployWebPayload, k as FreestyleExecureScriptResultError, l as FreestyleExecuteScriptParams, m as FreestyleFile, n as FreestyleLogResponseObject, r as HandleBackupCloudstateError, o as HandleDeployCloudstateData, q as HandleDeployCloudstateError, p as HandleDeployCloudstateResponse, v as HandleDeployWebData, x as HandleDeployWebError, w as HandleDeployWebResponse, s as HandleExecuteScriptData, u as HandleExecuteScriptError, t as HandleExecuteScriptResponse, y as HandleGetLogsError } from './types.gen-DyY7Deri.js';
 
 declare class FreestyleSandboxes {
     private client;
@@ -19,7 +20,10 @@ declare class FreestyleSandboxes {
     /**
      * Deploy a Web project to a sandbox.
      */
-    deployWeb(files: Record<string, string>, config?: FreestyleDeployWebConfiguration): Promise<FreestyleDeployWebSuccessResponse>;
+    deployWeb(files: Record<string, {
+        content: string;
+        encoding?: string;
+    }>, config?: FreestyleDeployWebConfiguration): Promise<FreestyleDeployWebSuccessResponse>;
     /**
      * Deploy a Cloudstate project to a sandbox.
      */
@@ -40,4 +44,4 @@ declare class FreestyleSandboxes {
     getWebLogs(id: string): Promise<HandleGetLogsResponse>;
 }
 
-export { FreestyleSandboxes };
+export { FreestyleCloudstateDeployRequest, FreestyleCloudstateDeploySuccessResponse, FreestyleDeployWebConfiguration, FreestyleDeployWebSuccessResponse, FreestyleExecureScriptResultSuccess, FreestyleExecuteScriptParamsConfiguration, FreestyleSandboxes, HandleBackupCloudstateResponse, HandleGetLogsResponse };

package/dist/index.mjs

@@ -83,7 +83,9 @@ ${JSON.stringify(
     if (response.data) {
       return response.data;
     } else {
-      throw new Error("Failed to deploy Web project");
+      throw new Error(
+        `Failed to deploy web project: ${response.error?.message}`
+      );
     }
   }
   /**

package/dist/{types.gen-BoJEFWW-.d.ts → types.gen-DyY7Deri.d.ts}

@@ -10,6 +10,9 @@ type FreestyleCloudstateDeployConfiguration = {
         [key: string]: (string);
     };
 };
+type FreestyleCloudstateDeployErrorResponse = {
+    message: string;
+};
 type FreestyleCloudstateDeployRequest = {
     classes: string;
     config?: FreestyleCloudstateDeployConfiguration;
@@ -47,12 +50,36 @@ type FreestyleDeployWebConfiguration = {
         [key: string]: (string);
     } | null;
 };
+type FreestyleDeployWebErrorResponse = {
+    message: string;
+};
+type FreestyleDeployWebPayload = {
+    /**
+     * The files to deploy, a map of file paths to file contents, e.g. { \"index.js\": {\"content\": \"your main\", \"encoding\": \"utf-8\"}, \"file2.js\": {\"content\": \"your helper\" } }
+     *
+     * **Do not include node modules in this bundle, they will not work**. Instead, includes a package-lock.json, bun.lockb, pnpm-lock.yaml, or yarn.lock, the node modules for the project will be installed from that lock file, or use the node_modules field in the configuration to specify the node modules to install.
+     */
+    files: {
+        [key: string]: FreestyleFile;
+    };
+    config?: FreestyleDeployWebConfiguration;
+};
 type FreestyleDeployWebSuccessResponse = {
     projectId: string;
 };
+type FreestyleExecureScriptResultError = {
+    error: string;
+};
 type FreestyleExecureScriptResultSuccess = {
     result: unknown;
 };
+type FreestyleExecuteScriptParams = {
+    /**
+     * The JavaScript or TypeScript script to execute
+     */
+    script: string;
+    config?: FreestyleExecuteScriptParamsConfiguration;
+};
 type FreestyleExecuteScriptParamsConfiguration = {
     /**
      * The environment variables to set for the script
@@ -75,10 +102,37 @@ type FreestyleExecuteScriptParamsConfiguration = {
      */
     timeout?: (string) | null;
 };
+type FreestyleFile = {
+    /**
+     * The content of the file
+     */
+    content: string;
+    /**
+     * The encoding of the file. Either **utf-8** or **base64**
+     */
+    encoding?: string;
+};
 type FreestyleLogResponseObject = {
     message: string;
 };
+type HandleDeployCloudstateData = {
+    body: FreestyleCloudstateDeployRequest;
+};
+type HandleDeployCloudstateResponse = (FreestyleCloudstateDeploySuccessResponse);
+type HandleDeployCloudstateError = (FreestyleCloudstateDeployErrorResponse);
 type HandleBackupCloudstateResponse = (Array<(number)>);
+type HandleBackupCloudstateError = (unknown);
+type HandleExecuteScriptData = {
+    body: FreestyleExecuteScriptParams;
+};
+type HandleExecuteScriptResponse = (FreestyleExecureScriptResultSuccess);
+type HandleExecuteScriptError = (FreestyleExecureScriptResultError);
+type HandleDeployWebData = {
+    body: FreestyleDeployWebPayload;
+};
+type HandleDeployWebResponse = (FreestyleDeployWebSuccessResponse);
+type HandleDeployWebError = (FreestyleDeployWebErrorResponse);
 type HandleGetLogsResponse = (Array<FreestyleLogResponseObject>);
+type HandleGetLogsError = unknown;
 
-export type { FreestyleExecuteScriptParamsConfiguration as F, HandleBackupCloudstateResponse as H, FreestyleExecureScriptResultSuccess as a, FreestyleDeployWebConfiguration as b, FreestyleDeployWebSuccessResponse as c, FreestyleCloudstateDeployRequest as d, FreestyleCloudstateDeploySuccessResponse as e, HandleGetLogsResponse as f };
+export type { FreestyleExecuteScriptParamsConfiguration as F, HandleBackupCloudstateResponse as H, FreestyleExecureScriptResultSuccess as a, FreestyleDeployWebConfiguration as b, FreestyleDeployWebSuccessResponse as c, FreestyleCloudstateDeployRequest as d, FreestyleCloudstateDeploySuccessResponse as e, HandleGetLogsResponse as f, FreestyleCloudstateDeployConfiguration as g, FreestyleCloudstateDeployErrorResponse as h, FreestyleDeployWebErrorResponse as i, FreestyleDeployWebPayload as j, FreestyleExecureScriptResultError as k, FreestyleExecuteScriptParams as l, FreestyleFile as m, FreestyleLogResponseObject as n, HandleDeployCloudstateData as o, HandleDeployCloudstateResponse as p, HandleDeployCloudstateError as q, HandleBackupCloudstateError as r, HandleExecuteScriptData as s, HandleExecuteScriptResponse as t, HandleExecuteScriptError as u, HandleDeployWebData as v, HandleDeployWebResponse as w, HandleDeployWebError as x, HandleGetLogsError as y };

package/openapi/types.gen.ts

@@ -63,12 +63,12 @@ export type FreestyleDeployWebErrorResponse = {
 
 export type FreestyleDeployWebPayload = {
     /**
-     * The files to deploy, a map of file paths to file contents, e.g. { \"index.js\": \"your main", \"file2.js\": \"your helper\" }
+     * The files to deploy, a map of file paths to file contents, e.g. { \"index.js\": {\"content\": \"your main\", \"encoding\": \"utf-8\"}, \"file2.js\": {\"content\": \"your helper\" } }
      *
      * **Do not include node modules in this bundle, they will not work**. Instead, includes a package-lock.json, bun.lockb, pnpm-lock.yaml, or yarn.lock, the node modules for the project will be installed from that lock file, or use the node_modules field in the configuration to specify the node modules to install.
      */
     files: {
-        [key: string]: (string);
+        [key: string]: FreestyleFile;
     };
     config?: FreestyleDeployWebConfiguration;
 };
@@ -116,6 +116,17 @@ export type FreestyleExecuteScriptParamsConfiguration = {
     timeout?: (string) | null;
 };
 
+export type FreestyleFile = {
+    /**
+     * The content of the file
+     */
+    content: string;
+    /**
+     * The encoding of the file. Either **utf-8** or **base64**
+     */
+    encoding?: string;
+};
+
 export type FreestyleLogResponseObject = {
     message: string;
 };

package/openapi.json

@@ -1 +1,432 @@
-{"openapi":"3.1.0","info":{"title":"Freestyle Sandoxes","description":"\nFreestyle Sandboxes lets you deploy your users or AIs code.\n        \nThey are broken up into 3 categories: [Web](#tag/web), [Execute](#tag/execute) and [Cloudstate](#tag/cloudstate).\n\n[Web](#tag/web): Send us the code for the website, we'll provision the certificates and get it hosted\n\n[Execute](#tag/execute): Send us a function, we'll run it and send you the output\n\n[Cloudstate](#tag/cloudstate): Our Opensource JavaScript Runtime used for cloud functions with persistent state\n","contact":{"name":"Ben","email":"ben@freestyle.sh"},"license":{"name":""},"version":"0.1.0"},"servers":[{"url":"https://api.freestyle.sh","description":"Production"}],"paths":{"/cloudstate/v1/deploy":{"post":{"tags":["Cloudstate"],"summary":"Deploy Cloudstate Project","description":"Deploy a cloudstate project","operationId":"handle_deploy_cloudstate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleCloudstateDeployRequest"}}},"required":true},"responses":{"200":{"description":"successfully deployed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleCloudstateDeploySuccessResponse"}}}},"500":{"description":"failed to deploy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleCloudstateDeployErrorResponse"}}}}}}},"/cloudstate/v1/projects/:id/backup":{"get":{"tags":["Cloudstate"],"summary":"Get Backup of Cloudstate Project","description":"Get a backup of a cloudstate project","operationId":"handle_backup_cloudstate","responses":{"200":{"description":"successfully backed up","content":{"application/octet-stream":{"schema":{"type":"array","items":{"type":"integer","format":"int32","minimum":0}}}}},"500":{"description":"failed to backup"}}}},"/execute/v1/script":{"post":{"tags":["Execute"],"summary":"Execute Code","description":"Send a TypeScript or JavaScript module, get the result","operationId":"handle_execute_script","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleExecuteScriptParams"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleExecureScriptResultSuccess"}}}},"400":{"description":"Error in your Script","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleExecureScriptResultError"}}}},"500":{"description":"Internal Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleExecureScriptResultError"}}}}}}},"/web/v1/deploy":{"post":{"tags":["Web"],"summary":"Deploy a Website","description":"Deploy a website. Files is a map of file paths to file contents. Configuration is optional and contains additional information about the deployment.","operationId":"handle_deploy_web","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleDeployWebPayload"}}},"required":true},"responses":{"200":{"description":"successfully deployed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleDeployWebSuccessResponse"}}}},"400":{"description":"failed to deploy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreestyleDeployWebErrorResponse"}}}}}}},"/web/v1/projects/:id/logs":{"get":{"tags":["Web"],"summary":"Get Website Logs","description":"Get the logs for a project","operationId":"handle_get_logs","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FreestyleLogResponseObject"}}}}}}}}},"components":{"schemas":{"FreestyleCloudstateDeployConfiguration":{"type":"object","properties":{"projectId":{"type":["string","null"],"description":"ID of the project to deploy, if not provided will create a new project","default":null},"envVars":{"type":"object","description":"The environment variables that the cloudstate deploy can access","default":{},"additionalProperties":{"type":"string"},"propertyNames":{"type":"string"}}}},"FreestyleCloudstateDeployErrorResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"FreestyleCloudstateDeployRequest":{"type":"object","required":["classes"],"properties":{"classes":{"type":"string"},"config":{"$ref":"#/components/schemas/FreestyleCloudstateDeployConfiguration"}}},"FreestyleCloudstateDeploySuccessResponse":{"type":"object","required":["projectId"],"properties":{"projectId":{"type":"string","description":"The id of the project deployed to"}}},"FreestyleDeployWebConfiguration":{"type":"object","properties":{"entrypoint":{"type":["string","null"],"description":"The entrypoint file for the website","default":"index.js"},"domains":{"type":["array","null"],"items":{"type":"string"},"description":"The custom domains for the website, eg. [\\\"subdomain.yourwebsite.com\\\"]. You may not include *.style.dev domains here, those are reserved for projectIds","example":["subdomain.yourdomain.com"],"default":null},"projectId":{"type":["string","null"],"description":"The project id to deploy to, if not provided will create a new project, may be used to provision a new project with a specific id if that id is available","default":null},"nodeModules":{"type":["object","null"],"description":"Node Modules to install for the website, a map of package names to versions, e.g. { \\\"express\\\": \\\"4.17.1\\\" }. If this and a package-lock.json are provided, the package-lock.json, bun.lockb, pnpm-lock.yaml, or yarn.lock is also provided, the versions here will override the versions in those lock files.","default":null,"additionalProperties":{"type":"string"},"propertyNames":{"type":"string"},"example":{"resend":"4.0.1"}},"envVars":{"type":["object","null"],"description":"The environment variables that the website can access\ne.g. { \\\"RESEND_API_KEY\\\": \\\"re_123456789\\\" }","default":null,"additionalProperties":{"type":"string"},"propertyNames":{"type":"string"},"example":{"RESEND_API_KEY":"re_123456789"}}}},"FreestyleDeployWebErrorResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"FreestyleDeployWebPayload":{"type":"object","required":["files"],"properties":{"files":{"type":"object","description":"The files to deploy, a map of file paths to file contents, e.g. { \\\"index.js\\\": \\\"your main\", \\\"file2.js\\\": \\\"your helper\\\" }\n\n**Do not include node modules in this bundle, they will not work**. Instead, includes a package-lock.json, bun.lockb, pnpm-lock.yaml, or yarn.lock, the node modules for the project will be installed from that lock file, or use the node_modules field in the configuration to specify the node modules to install.","additionalProperties":{"type":"string"},"propertyNames":{"type":"string"},"example":{"index.js":"import http from 'node:http';\\n// import { resolver } from './file2.js';\\n\\nconsole.log('starting server');\\n\\nconst server = http.createServer(async(req, res) => {\\n  // wait 5 seconds before responding\\n  // await new Promise((resolve) => setTimeout(resolve, 5000));\\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});"}},"config":{"$ref":"#/components/schemas/FreestyleDeployWebConfiguration"}}},"FreestyleDeployWebSuccessResponse":{"type":"object","required":["projectId"],"properties":{"projectId":{"type":"string"}}},"FreestyleExecureScriptResultError":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}}},"FreestyleExecureScriptResultSuccess":{"type":"object","required":["result"],"properties":{"result":{}}},"FreestyleExecuteScriptParams":{"type":"object","required":["script"],"properties":{"script":{"type":"string","description":"The JavaScript or TypeScript script to execute","example":"export default () => {\n  // get the value of the factorials of the numbers from 1 to 10 combined\n  const a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];\n\n  function factorial(n) {\n    if (n === 0) {\n      return 1;\n    }\n    return n * factorial(n - 1);\n  }\n\n  const b = a.map(factorial);\n\n  return b.reduce((a, b) => a + b);\n};\n"},"config":{"$ref":"#/components/schemas/FreestyleExecuteScriptParamsConfiguration"}}},"FreestyleExecuteScriptParamsConfiguration":{"type":"object","properties":{"envVars":{"type":"object","description":"The environment variables to set for the script","default":{},"additionalProperties":{"type":"string"},"propertyNames":{"type":"string"},"example":{"RESEND_API_KEY":"re_123456789"}},"nodeModules":{"type":"object","description":"The node modules to install for the script","default":{},"additionalProperties":{"type":"string"},"propertyNames":{"type":"string"},"example":{"resend":"4.0.1"}},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for you to organize your scripts, useful for tracking what you're running","example":["email"],"default":[]},"timeout":{"type":["string","null"],"description":"The script timeout","default":null}}},"FreestyleLogResponseObject":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"tags":[{"name":"Web","description":"APIs for deploying websites. We handle node modules caching, scaling, certificates and the whole end to end process. Send the code using the [deploy](#tag/web/POST/web/v1/deploy) endpoint, and you'll get a full hosted website back. Works with any TypeScript or JavaScript codebase."},{"name":"Execute","description":"APIs for running code. Send the code using the [execute](#tag/execute/POST/execute/v1/execute) endpoint, and you'll get the output back. Works with any TypeScript or JavaScript code + handles any node modules and environment variables you want."},{"name":"Cloudstate","description":"APIs for running cloud functions with persistent state. [Cloudstate](https://github.com/freestyle-sh/cloudstate/) is an opensource, durable JavaScript runtime maintained by the Freestyle Team."}]}
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Freestyle Sandboxes",
+    "description": "\nFreestyle Sandboxes lets you deploy your users or AIs code.\n        \nThey are broken up into 3 categories: [Web](#tag/web), [Execute](#tag/execute) and [Cloudstate](#tag/cloudstate).\n\n[Web](#tag/web): Send us the code for the website, we'll provision the certificates and get it hosted\n\n[Execute](#tag/execute): Send us a function, we'll run it and send you the output\n\n[Cloudstate](#tag/cloudstate): Our Opensource JavaScript Runtime used for cloud functions with persistent state\n",
+    "contact": { "name": "Ben", "email": "ben@freestyle.sh" },
+    "license": { "name": "" },
+    "version": "0.1.0"
+  },
+  "servers": [
+    { "url": "https://api.freestyle.sh", "description": "Production" }
+  ],
+  "paths": {
+    "/cloudstate/v1/deploy": {
+      "post": {
+        "tags": ["Cloudstate"],
+        "summary": "Deploy Cloudstate Project",
+        "description": "Deploy a cloudstate project",
+        "operationId": "handle_deploy_cloudstate",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/FreestyleCloudstateDeployRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "successfully deployed",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FreestyleCloudstateDeploySuccessResponse"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "failed to deploy",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FreestyleCloudstateDeployErrorResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/cloudstate/v1/projects/:id/backup": {
+      "get": {
+        "tags": ["Cloudstate"],
+        "summary": "Get Backup of Cloudstate Project",
+        "description": "Get a backup of a cloudstate project",
+        "operationId": "handle_backup_cloudstate",
+        "responses": {
+          "200": {
+            "description": "successfully backed up",
+            "content": {
+              "application/octet-stream": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "integer",
+                    "format": "int32",
+                    "minimum": 0
+                  }
+                }
+              }
+            }
+          },
+          "500": { "description": "failed to backup" }
+        }
+      }
+    },
+    "/execute/v1/script": {
+      "post": {
+        "tags": ["Execute"],
+        "summary": "Execute Code",
+        "description": "Send a TypeScript or JavaScript module, get the result",
+        "operationId": "handle_execute_script",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/FreestyleExecuteScriptParams"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FreestyleExecureScriptResultSuccess"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Error in your Script",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FreestyleExecureScriptResultError"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FreestyleExecureScriptResultError"
+                }
+              }
+            }
+          }
+        },
+        "x-codeSamples": [
+          {
+            "label": "Human SDK",
+            "lang": "JavaScript",
+            "source": "import { FreestyleSandboxes } from 'freestyle-sandboxes';\n\nconst sandboxes = new FreestyleSandboxes({\n  apiKey: 'your-api-key',\n});\n\nsandboxes.executeScript(\n  `export default () => {\n  let set1 = [1, 2, 3, 4, 5];\n  let set2 = [4, 5, 6, 7, 8];\n\n  // find the sum of every value of each set multiplied by every value of the other set\n\n  let sum = 0;\n  for (let i = 0; i < set1.length; i++) {\n    for (let j = 0; j < set2.length; j++) {\n      sum += set1[i] * set2[j];\n    }\n  }\n\n  return sum;\n};`\n);"
+          },
+          {
+            "label": "AI SDK",
+            "lang": "JavaScript",
+            "source": "import { executeTool } from 'freestyle-sandboxes/ai';\nimport { generateText } from 'ai';\n\nconst codeExecutor = executeTool({\n  apiKey: 'your-api-key',\n});\n\nconst { text, steps } = await generateText({\n  model: yourModel,\n  tools: {\n    codeExecutor,\n  },\n  maxSteps: 2,\n  prompt:\n    'What is the sum of every number between 1 and 12 multiplied by itself?',\n});"
+          }
+        ]
+      }
+    },
+    "/web/v1/deploy": {
+      "post": {
+        "tags": ["Web"],
+        "summary": "Deploy a Website",
+        "description": "Deploy a website. Files is a map of file paths to file contents. Configuration is optional and contains additional information about the deployment.",
+        "operationId": "handle_deploy_web",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/FreestyleDeployWebPayload"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "successfully deployed",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FreestyleDeployWebSuccessResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "failed to deploy",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FreestyleDeployWebErrorResponse"
+                }
+              }
+            }
+          }
+        },
+        "x-codeSamples": [
+          {
+            "label": "Human SDK",
+            "lang": "JavaScript",
+            "source": "import { FreestyleSandboxes } from 'freestyle-sandboxes';\nimport 'dotenv/config';\n\nconst api = new FreestyleSandboxes({\n  apiKey: process.env.FREESTYLE_API_KEY!,\n});\n\napi\n  .deployWeb({\n    'index.js': `\n        import http from 'node:http';\n        console.log('starting server');\n\n        const server = http.createServer(async(req, res) => {\n        // wait 5 seconds before responding\n        // await new Promise((resolve) => setTimeout(resolve, 5000));\n        res.writeHead(200, { 'Content-Type': 'text/plain' });\n        res.end('Welcome to New York its been waiting for you');\n        });\n\n        server.listen(3000, () => {\n        console.log('Server is running at http://localhost:3000');\n        });`,\n    })\n    .then((result) => {\n        console.log('Deployed website @ ', result.projectId);\n    });\n"
+          },
+          {
+            "label": "AI SDK",
+            "lang": "JavaScript",
+            "source": "import { deployWebTool } from 'freestyle-sandboxes/ai';\nimport { generateText } from 'ai';\n\nconst deployer = deployWebTool({\n  apiKey: 'your-api-key',\n});\n\nconst { text, steps } = await generateText({\n  model: yourModel,\n  tools: {\n    deployer,\n  },\n  maxSteps: 2,\n  prompt:\n    'Deploy a website to subdomain.yourdomain.com that has all the lyrics to Sandstorm by Darude on the homepage',\n});"
+          }
+        ]
+      }
+    },
+    "/web/v1/projects/:id/logs": {
+      "get": {
+        "tags": ["Web"],
+        "summary": "Get Website Logs",
+        "description": "Get the logs for a project",
+        "operationId": "handle_get_logs",
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/FreestyleLogResponseObject"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-codeSamples": [
+          {
+            "label": "Human SDK",
+            "lang": "JavaScript",
+            "source": "import { FreestyleSandboxes } from 'freestyle-sandboxes';\nimport 'dotenv/config';\n\nconst api = new FreestyleSandboxes({\n  apiKey: process.env.FREESTYLE_API_KEY!,\n});\n\napi.getWebLogs('1234abcd-5678-efgh-ijkl-9012mnop3456').then((logs) => {\n  console.log('Logs for project 1234abcd-5678-efgh-ijkl-9012mnop3456: ', logs);\n});"
+          }
+        ]
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "FreestyleCloudstateDeployConfiguration": {
+        "type": "object",
+        "properties": {
+          "projectId": {
+            "type": ["string", "null"],
+            "description": "ID of the project to deploy, if not provided will create a new project",
+            "default": null
+          },
+          "envVars": {
+            "type": "object",
+            "description": "The environment variables that the cloudstate deploy can access",
+            "default": {},
+            "additionalProperties": { "type": "string" },
+            "propertyNames": { "type": "string" }
+          }
+        }
+      },
+      "FreestyleCloudstateDeployErrorResponse": {
+        "type": "object",
+        "required": ["message"],
+        "properties": { "message": { "type": "string" } }
+      },
+      "FreestyleCloudstateDeployRequest": {
+        "type": "object",
+        "required": ["classes"],
+        "properties": {
+          "classes": { "type": "string" },
+          "config": {
+            "$ref": "#/components/schemas/FreestyleCloudstateDeployConfiguration"
+          }
+        }
+      },
+      "FreestyleCloudstateDeploySuccessResponse": {
+        "type": "object",
+        "required": ["projectId"],
+        "properties": {
+          "projectId": {
+            "type": "string",
+            "description": "The id of the project deployed to"
+          }
+        }
+      },
+      "FreestyleDeployWebConfiguration": {
+        "type": "object",
+        "properties": {
+          "entrypoint": {
+            "type": ["string", "null"],
+            "description": "The entrypoint file for the website",
+            "default": "index.js"
+          },
+          "domains": {
+            "type": ["array", "null"],
+            "items": { "type": "string" },
+            "description": "The custom domains for the website, eg. [\\\"subdomain.yourwebsite.com\\\"]. You may not include *.style.dev domains here, those are reserved for projectIds",
+            "example": ["subdomain.yourdomain.com"],
+            "default": null
+          },
+          "projectId": {
+            "type": ["string", "null"],
+            "description": "The project id to deploy to, if not provided will create a new project, may be used to provision a new project with a specific id if that id is available",
+            "default": null
+          },
+          "nodeModules": {
+            "type": ["object", "null"],
+            "description": "Node Modules to install for the website, a map of package names to versions, e.g. { \\\"express\\\": \\\"4.17.1\\\" }. If this and a package-lock.json are provided, the package-lock.json, bun.lockb, pnpm-lock.yaml, or yarn.lock is also provided, the versions here will override the versions in those lock files.",
+            "default": null,
+            "additionalProperties": { "type": "string" },
+            "propertyNames": { "type": "string" },
+            "example": { "resend": "4.0.1" }
+          },
+          "envVars": {
+            "type": ["object", "null"],
+            "description": "The environment variables that the website can access\ne.g. { \\\"RESEND_API_KEY\\\": \\\"re_123456789\\\" }",
+            "default": null,
+            "additionalProperties": { "type": "string" },
+            "propertyNames": { "type": "string" },
+            "example": { "RESEND_API_KEY": "re_123456789" }
+          }
+        }
+      },
+      "FreestyleDeployWebErrorResponse": {
+        "type": "object",
+        "required": ["message"],
+        "properties": { "message": { "type": "string" } }
+      },
+      "FreestyleDeployWebPayload": {
+        "type": "object",
+        "required": ["files"],
+        "properties": {
+          "files": {
+            "type": "object",
+            "description": "The files to deploy, a map of file paths to file contents, e.g. { \\\"index.js\\\": {\\\"content\\\": \\\"your main\\\", \\\"encoding\\\": \\\"utf-8\\\"}, \\\"file2.js\\\": {\\\"content\\\": \\\"your helper\\\" } }\n\n**Do not include node modules in this bundle, they will not work**. Instead, includes a package-lock.json, bun.lockb, pnpm-lock.yaml, or yarn.lock, the node modules for the project will be installed from that lock file, or use the node_modules field in the configuration to specify the node modules to install.",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/FreestyleFile"
+            },
+            "propertyNames": { "type": "string" },
+            "example": {
+              "index.js": {
+                "content": "import http from 'node:http';\\n// import { resolver } from './file2.js';\\n\\nconsole.log('starting server');\\n\\nconst server = http.createServer(async(req, res) => {\\n  // wait 5 seconds before responding\\n  // await new Promise((resolve) => setTimeout(resolve, 5000));\\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});"
+              }
+            }
+          },
+          "config": {
+            "$ref": "#/components/schemas/FreestyleDeployWebConfiguration"
+          }
+        }
+      },
+      "FreestyleDeployWebSuccessResponse": {
+        "type": "object",
+        "required": ["projectId"],
+        "properties": { "projectId": { "type": "string" } }
+      },
+      "FreestyleExecureScriptResultError": {
+        "type": "object",
+        "required": ["error"],
+        "properties": { "error": { "type": "string" } }
+      },
+      "FreestyleExecureScriptResultSuccess": {
+        "type": "object",
+        "required": ["result"],
+        "properties": { "result": {} }
+      },
+      "FreestyleExecuteScriptParams": {
+        "type": "object",
+        "required": ["script"],
+        "properties": {
+          "script": {
+            "type": "string",
+            "description": "The JavaScript or TypeScript script to execute",
+            "example": "export default () => {\n  // get the value of the factorials of the numbers from 1 to 10 combined\n  const a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];\n\n  function factorial(n) {\n    if (n === 0) {\n      return 1;\n    }\n    return n * factorial(n - 1);\n  }\n\n  const b = a.map(factorial);\n\n  return b.reduce((a, b) => a + b);\n};\n"
+          },
+          "config": {
+            "$ref": "#/components/schemas/FreestyleExecuteScriptParamsConfiguration"
+          }
+        }
+      },
+      "FreestyleExecuteScriptParamsConfiguration": {
+        "type": "object",
+        "properties": {
+          "envVars": {
+            "type": "object",
+            "description": "The environment variables to set for the script",
+            "default": {},
+            "additionalProperties": { "type": "string" },
+            "propertyNames": { "type": "string" },
+            "example": { "RESEND_API_KEY": "re_123456789" }
+          },
+          "nodeModules": {
+            "type": "object",
+            "description": "The node modules to install for the script",
+            "default": {},
+            "additionalProperties": { "type": "string" },
+            "propertyNames": { "type": "string" },
+            "example": { "resend": "4.0.1" }
+          },
+          "tags": {
+            "type": "array",
+            "items": { "type": "string" },
+            "description": "Tags for you to organize your scripts, useful for tracking what you're running",
+            "example": ["email"],
+            "default": []
+          },
+          "timeout": {
+            "type": ["string", "null"],
+            "description": "The script timeout",
+            "default": null
+          }
+        }
+      },
+      "FreestyleFile": {
+        "type": "object",
+        "required": ["content"],
+        "properties": {
+          "content": {
+            "type": "string",
+            "description": "The content of the file"
+          },
+          "encoding": {
+            "type": "string",
+            "description": "The encoding of the file. Either **utf-8** or **base64**"
+          }
+        }
+      },
+      "FreestyleLogResponseObject": {
+        "type": "object",
+        "required": ["message"],
+        "properties": { "message": { "type": "string" } }
+      }
+    },
+    "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } }
+  },
+  "tags": [
+    {
+      "name": "Web",
+      "description": "APIs for deploying websites. We handle node modules caching, scaling, certificates and the whole end to end process. Send the code using the [deploy](#tag/web/POST/web/v1/deploy) endpoint, and you'll get a full hosted website back. Works with any TypeScript or JavaScript codebase."
+    },
+    {
+      "name": "Execute",
+      "description": "APIs for running code. Send the code using the [execute](#tag/execute/POST/execute/v1/execute) endpoint, and you'll get the output back. Works with any TypeScript or JavaScript code + handles any node modules and environment variables you want."
+    },
+    {
+      "name": "Cloudstate",
+      "description": "APIs for running cloud functions with persistent state. [Cloudstate](https://github.com/freestyle-sh/cloudstate/) is an opensource, durable JavaScript runtime maintained by the Freestyle Team."
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freestyle-sandboxes",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -42,6 +42,9 @@
   "dependencies": {
     "@hey-api/client-fetch": "^0.5.7",
     "ai": "^4.0.25",
+    "humanlayer": "^0.7.0",
+    "openai": "^4.77.3",
+    "openapi": "^1.0.1",
     "zod": "^3.24.1"
   }
 }

package/src/ai/index.ts

@@ -99,8 +99,13 @@ export const deployWebTool = (
             `),
     }),
     execute: async ({ files }) => {
+      // map from record<string, string> to record<string, {content: string}>
+      const new_files = Object.keys(files).reduce((acc, key) => {
+        acc[key] = { content: files[key] };
+        return acc;
+      }, {} as Record<string, { content: string }>);
       try {
-        const res = await api.deployWeb(files, config);
+        const res = await api.deployWeb(new_files, config);
         return res;
       } catch (e) {
         console.log("ERROR: ", e.message);

package/src/index.ts

@@ -50,7 +50,13 @@ export class FreestyleSandboxes {
    * Deploy a Web project to a sandbox.
    */
   async deployWeb(
-    files: Record<string, string>,
+    files: Record<
+      string,
+      {
+        content: string;
+        encoding?: string;
+      }
+    >,
     config?: sandbox_openapi.FreestyleDeployWebConfiguration
   ): Promise<sandbox_openapi.FreestyleDeployWebSuccessResponse> {
     const response = await sandbox_openapi.handleDeployWeb({
@@ -63,7 +69,9 @@ export class FreestyleSandboxes {
     if (response.data) {
       return response.data;
     } else {
-      throw new Error("Failed to deploy Web project");
+      throw new Error(
+        `Failed to deploy web project: ${response.error?.message}`
+      );
     }
   }
 
@@ -126,3 +134,5 @@ export class FreestyleSandboxes {
     }
   }
 }
+
+export * from "../openapi/types.gen.ts";