freestyle-sandboxes 0.0.16 → 0.0.18

package/dist/types.gen-C03gaIPq.d.ts

@@ -0,0 +1,297 @@
+type DeploymentLogEntry = {
+    deploymentId: string;
+    accountId: string;
+    provisionedAt: string;
+    timeout: string;
+    state: DeploymentState;
+    deployedAt?: (string) | null;
+    domains: Array<(string)>;
+    envVars: {
+        [key: string]: (string);
+    };
+};
+type DeploymentState = 'provisioning' | 'deployed' | 'failed';
+type ExecuteLogEntry = {
+    deployment: string;
+    account_id: string;
+    provisioned_at: string;
+    started_at?: (string) | null;
+    duration?: (string) | null;
+    state: ExecuteRunState;
+    env_vars: {
+        [key: string]: (string);
+    };
+};
+type ExecuteRunState = 'starting' | 'running' | 'complete';
+type FreestyleCloudstateDeployConfiguration = {
+    /**
+     * ID of the project to deploy, if not provided will create a new project
+     */
+    domains?: Array<(string)> | null;
+    /**
+     * The environment variables that the cloudstate deploy can access
+     */
+    envVars?: {
+        [key: string]: (string);
+    };
+    cloudstateDatabaseId?: (string) | null;
+};
+type FreestyleCloudstateDeployErrorResponse = {
+    message: string;
+};
+type FreestyleCloudstateDeployRequest = {
+    classes: string;
+    config?: FreestyleCloudstateDeployConfiguration;
+};
+type FreestyleCloudstateDeploySuccessResponse = {
+    deploymentId: string;
+    cloudstateDatabaseId: string;
+};
+type FreestyleDeleteDomainVerificationRequest = {
+    /**
+     * The domain to create a verification code for
+     */
+    domain: string;
+    /**
+     * The verification code
+     */
+    verificationCode: string;
+};
+type FreestyleDeployWebConfiguration = {
+    /**
+     * The entrypoint file for the website
+     */
+    entrypoint?: (string) | null;
+    /**
+     * The custom domains for the website, eg. [\"subdomain.yourwebsite.com\"]. You may include a single *.style.dev domain here.
+     */
+    domains?: Array<(string)> | null;
+    /**
+     * Project ID was our original way of tracking deployments together, it is now deprecated and will be removed in the future. Please use the domains field to specify the domains for your project.
+     * @deprecated
+     */
+    projectId?: (string) | null;
+    /**
+     * 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.
+     */
+    nodeModules?: {
+        [key: string]: (string);
+    } | null;
+    /**
+     * The environment variables that the website can access
+     * e.g. { \"RESEND_API_KEY\": \"re_123456789\" }
+     */
+    envVars?: {
+        [key: string]: (string);
+    } | null;
+    serverStartCheck?: boolean;
+};
+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 = {
+    deploymentId: string;
+    domains?: Array<(string)> | null;
+    /**
+     * @deprecated
+     */
+    projectId?: (string) | null;
+};
+type FreestyleDomainVerificationRequest = {
+    /**
+     * The domain to create a verification code for
+     */
+    domain: string;
+};
+type FreestyleExecuteScriptParams = {
+    /**
+     * The JavaScript or TypeScript script to execute
+     */
+    script: string;
+    config?: FreestyleExecuteScriptParamsConfiguration;
+};
+type FreestyleExecuteScriptParamsConfiguration = {
+    /**
+     * The environment variables to set for the script
+     */
+    envVars?: {
+        [key: string]: (string);
+    };
+    /**
+     * The node modules to install for the script
+     */
+    nodeModules?: {
+        [key: string]: (string);
+    };
+    /**
+     * Tags for you to organize your scripts, useful for tracking what you're running
+     */
+    tags?: Array<(string)>;
+    /**
+     * The script timeout
+     */
+    timeout?: (string) | null;
+    /**
+     * If false, we'll not resolve peer dependencies for the packages given, this can speed up execute performance, but will break packages with peers unless the peers are manually specified.
+     */
+    peerDependencyResolution?: boolean;
+};
+type FreestyleExecuteScriptResultSuccess = {
+    result: unknown;
+    logs: Array<FreestyleJavaScriptLog>;
+};
+type FreestyleFile = {
+    /**
+     * The content of the file
+     */
+    content: string;
+    /**
+     * The encoding of the file. Either **utf-8** or **base64**
+     */
+    encoding?: string;
+};
+type FreestyleJavaScriptLog = {
+    /**
+     * The log message
+     */
+    message: string;
+    /**
+     * The log level
+     */
+    type: string;
+};
+type FreestyleLogResponseObject = {
+    message: string;
+    timestamp: string;
+};
+type FreestyleVerifyDomainRequest = {
+    domain: string;
+};
+type HandleDeployCloudstateData = {
+    body: FreestyleCloudstateDeployRequest;
+};
+type HandleDeployCloudstateResponse = (FreestyleCloudstateDeploySuccessResponse);
+type HandleDeployCloudstateError = (FreestyleCloudstateDeployErrorResponse);
+type HandleBackupCloudstateData = {
+    path: {
+        id: string;
+    };
+};
+type HandleBackupCloudstateResponse = (Array<(number)>);
+type HandleBackupCloudstateError = (unknown);
+type HandleVerifyWildcardResponse = ({
+    domain: string;
+});
+type HandleVerifyWildcardError = ({
+    message: string;
+});
+type HandleListDomainsResponse = (Array<{
+    domain: string;
+    createdAt: number;
+}>);
+type HandleListDomainsError = ({
+    message: string;
+});
+type HandleListDomainVerificationRequestsResponse = (Array<{
+    verificationCode: string;
+    domain: string;
+    createdAt: number;
+}>);
+type HandleListDomainVerificationRequestsError = ({
+    message: string;
+});
+type HandleVerifyDomainData = {
+    body: FreestyleVerifyDomainRequest;
+};
+type HandleVerifyDomainResponse = ({
+    domain: string;
+});
+type HandleVerifyDomainError = ({
+    message: string;
+});
+type HandleCreateDomainVerificationData = {
+    body: FreestyleDomainVerificationRequest;
+};
+type HandleCreateDomainVerificationResponse = ({
+    verificationCode: string;
+    domain: string;
+});
+type HandleCreateDomainVerificationError = ({
+    message: string;
+});
+type HandleDeleteDomainVerificationData = {
+    body: FreestyleDeleteDomainVerificationRequest;
+};
+type HandleDeleteDomainVerificationResponse = ({
+    verificationCode: string;
+    domain: string;
+});
+type HandleDeleteDomainVerificationError = ({
+    message: string;
+});
+type HandleListExecuteRunsData = {
+    query?: {
+        limit?: (number) | null;
+        offset?: (number) | null;
+    };
+};
+type HandleListExecuteRunsResponse = ({
+    entries: Array<ExecuteLogEntry>;
+    total: number;
+    offset: number;
+});
+type HandleListExecuteRunsError = ({
+    message: string;
+});
+type HandleGetExecuteRunData = {
+    path: {
+        deployment: string;
+    };
+};
+type HandleGetExecuteRunResponse = (ExecuteLogEntry);
+type HandleGetExecuteRunError = ({
+    message: string;
+});
+type HandleExecuteScriptData = {
+    body: FreestyleExecuteScriptParams;
+};
+type HandleExecuteScriptResponse = ({
+    result: unknown;
+    logs: Array<FreestyleJavaScriptLog>;
+});
+type HandleExecuteScriptError = ({
+    error: string;
+});
+type HandleGetLogsData = {
+    query: {
+        deploymentId: string;
+    };
+};
+type HandleGetLogsResponse = (Array<FreestyleLogResponseObject>);
+type HandleGetLogsError = unknown;
+type HandleDeployWebData = {
+    body: FreestyleDeployWebPayload;
+};
+type HandleDeployWebResponse = (FreestyleDeployWebSuccessResponse);
+type HandleDeployWebError = (FreestyleDeployWebErrorResponse);
+type HandleListWebDeploysResponse = ({
+    entries: Array<DeploymentLogEntry>;
+    total: number;
+    offset: number;
+});
+type HandleListWebDeploysError = ({
+    message: string;
+});
+
+export type { HandleGetLogsData as $, FreestyleJavaScriptLog as A, FreestyleLogResponseObject as B, FreestyleVerifyDomainRequest as C, DeploymentLogEntry as D, ExecuteLogEntry as E, FreestyleExecuteScriptParamsConfiguration as F, HandleDeployCloudstateData as G, HandleBackupCloudstateResponse as H, HandleDeployCloudstateResponse as I, HandleDeployCloudstateError as J, HandleBackupCloudstateData as K, HandleBackupCloudstateError as L, HandleVerifyWildcardError as M, HandleListDomainsError as N, HandleListDomainVerificationRequestsError as O, HandleVerifyDomainData as P, HandleCreateDomainVerificationData as Q, HandleCreateDomainVerificationError as R, HandleDeleteDomainVerificationData as S, HandleDeleteDomainVerificationError as T, HandleListExecuteRunsData as U, HandleListExecuteRunsError as V, HandleGetExecuteRunData as W, HandleGetExecuteRunError as X, HandleExecuteScriptData as Y, HandleExecuteScriptResponse as Z, HandleExecuteScriptError as _, FreestyleExecuteScriptResultSuccess as a, HandleGetLogsError as a0, HandleDeployWebData as a1, HandleDeployWebResponse as a2, HandleDeployWebError as a3, HandleListWebDeploysError as a4, FreestyleDeployWebConfiguration as b, FreestyleDeployWebSuccessResponse as c, FreestyleCloudstateDeployRequest as d, FreestyleCloudstateDeploySuccessResponse as e, HandleGetLogsResponse as f, HandleCreateDomainVerificationResponse as g, HandleVerifyDomainResponse as h, HandleVerifyDomainError as i, HandleListDomainsResponse as j, HandleListDomainVerificationRequestsResponse as k, HandleDeleteDomainVerificationResponse as l, HandleListWebDeploysResponse as m, HandleListExecuteRunsResponse as n, HandleGetExecuteRunResponse as o, HandleVerifyWildcardResponse as p, DeploymentState as q, ExecuteRunState as r, FreestyleCloudstateDeployConfiguration as s, FreestyleCloudstateDeployErrorResponse as t, FreestyleDeleteDomainVerificationRequest as u, FreestyleDeployWebErrorResponse as v, FreestyleDeployWebPayload as w, FreestyleDomainVerificationRequest as x, FreestyleExecuteScriptParams as y, FreestyleFile as z };

package/openapi/sdk.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createClient, createConfig, type OptionsLegacyParser } from '@hey-api/client-fetch';
-import type { HandleDeployCloudstateData, HandleDeployCloudstateError, HandleDeployCloudstateResponse, HandleBackupCloudstateData, HandleBackupCloudstateError, HandleBackupCloudstateResponse, HandleListDomainsError, HandleListDomainsResponse, HandleListDomainVerificationRequestsError, HandleListDomainVerificationRequestsResponse, HandleVerifyDomainData, HandleVerifyDomainError, HandleVerifyDomainResponse, HandleCreateDomainVerificationData, HandleCreateDomainVerificationError, HandleCreateDomainVerificationResponse, HandleDeleteDomainVerificationData, HandleDeleteDomainVerificationError, HandleDeleteDomainVerificationResponse, HandleExecuteScriptData, HandleExecuteScriptError, HandleExecuteScriptResponse, HandleDeployWebData, HandleDeployWebError, HandleDeployWebResponse, HandleGetLogsData, HandleGetLogsError, HandleGetLogsResponse } from './types.gen';
+import type { HandleDeployCloudstateData, HandleDeployCloudstateError, HandleDeployCloudstateResponse, HandleBackupCloudstateData, HandleBackupCloudstateError, HandleBackupCloudstateResponse, HandleVerifyWildcardError, HandleVerifyWildcardResponse, HandleListDomainsError, HandleListDomainsResponse, HandleListDomainVerificationRequestsError, HandleListDomainVerificationRequestsResponse, HandleVerifyDomainData, HandleVerifyDomainError, HandleVerifyDomainResponse, HandleCreateDomainVerificationData, HandleCreateDomainVerificationError, HandleCreateDomainVerificationResponse, HandleDeleteDomainVerificationData, HandleDeleteDomainVerificationError, HandleDeleteDomainVerificationResponse, HandleListExecuteRunsData, HandleListExecuteRunsError, HandleListExecuteRunsResponse, HandleGetExecuteRunData, HandleGetExecuteRunError, HandleGetExecuteRunResponse, HandleExecuteScriptData, HandleExecuteScriptError, HandleExecuteScriptResponse, HandleGetLogsData, HandleGetLogsError, HandleGetLogsResponse, HandleDeployWebData, HandleDeployWebError, HandleDeployWebResponse, HandleListWebDeploysError, HandleListWebDeploysResponse } from './types.gen';
 
 export const client = createClient(createConfig());
 
@@ -27,6 +27,23 @@ export const handleBackupCloudstate = <ThrowOnError extends boolean = false>(opt
     });
 };
 
+/**
+ * Provision a wildcard certificate
+ * Provisions a wildcard certificate for a verified domain
+ *
+ *
+ * This speeds up deploys on all subdomains of the domain. In order to use it, you must add the following record to your DNS config:
+ *
+ * `_acme-challenge.yourdomain.com` NS `dns.freestyle.sh`
+ *
+ */
+export const handleVerifyWildcard = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
+    return (options?.client ?? client).post<HandleVerifyWildcardResponse, HandleVerifyWildcardError, ThrowOnError>({
+        ...options,
+        url: '/domains/v1/certs/{domain}/wildcard'
+    });
+};
+
 /**
  * List domains for an account
  * This lists the domains that an account has verified ownership of. This includes the *.style.dev domains the account has claimed.
@@ -82,6 +99,28 @@ export const handleDeleteDomainVerification = <ThrowOnError extends boolean = fa
     });
 };
 
+/**
+ * List execute runs
+ * List execute runs.
+ */
+export const handleListExecuteRuns = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<HandleListExecuteRunsData, ThrowOnError>) => {
+    return (options?.client ?? client).get<HandleListExecuteRunsResponse, HandleListExecuteRunsError, ThrowOnError>({
+        ...options,
+        url: '/execute/v1/deployments'
+    });
+};
+
+/**
+ * Get information on execute run
+ * Get information on execute run
+ */
+export const handleGetExecuteRun = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<HandleGetExecuteRunData, ThrowOnError>) => {
+    return (options?.client ?? client).get<HandleGetExecuteRunResponse, HandleGetExecuteRunError, ThrowOnError>({
+        ...options,
+        url: '/execute/v1/deployments/{deployment}'
+    });
+};
+
 /**
  * Execute Code
  * Send a TypeScript or JavaScript module, get the result
@@ -93,6 +132,17 @@ export const handleExecuteScript = <ThrowOnError extends boolean = false>(option
     });
 };
 
+/**
+ * Deployment Logs
+ * Get the logs for a deployment
+ */
+export const handleGetLogs = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<HandleGetLogsData, ThrowOnError>) => {
+    return (options?.client ?? client).get<HandleGetLogsResponse, HandleGetLogsError, ThrowOnError>({
+        ...options,
+        url: '/observability/v1/logs'
+    });
+};
+
 /**
  * Deploy a Website
  * Deploy a website. Files is a map of file paths to file contents. Configuration is optional and contains additional information about the deployment.
@@ -105,12 +155,12 @@ export const handleDeployWeb = <ThrowOnError extends boolean = false>(options: O
 };
 
 /**
- * Get Website Logs
- * Get the logs for a project
+ * List web deploys
+ * List web deploys.
  */
-export const handleGetLogs = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<HandleGetLogsData, ThrowOnError>) => {
-    return (options?.client ?? client).get<HandleGetLogsResponse, HandleGetLogsError, ThrowOnError>({
+export const handleListWebDeploys = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => {
+    return (options?.client ?? client).get<HandleListWebDeploysResponse, HandleListWebDeploysError, ThrowOnError>({
         ...options,
-        url: '/web/v1/projects/{id}/logs'
+        url: '/web/v1/deployments'
     });
 };

package/openapi/types.gen.ts

@@ -1,16 +1,46 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
+export type DeploymentLogEntry = {
+    deploymentId: string;
+    accountId: string;
+    provisionedAt: string;
+    timeout: string;
+    state: DeploymentState;
+    deployedAt?: (string) | null;
+    domains: Array<(string)>;
+    envVars: {
+        [key: string]: (string);
+    };
+};
+
+export type DeploymentState = 'provisioning' | 'deployed' | 'failed';
+
+export type ExecuteLogEntry = {
+    deployment: string;
+    account_id: string;
+    provisioned_at: string;
+    started_at?: (string) | null;
+    duration?: (string) | null;
+    state: ExecuteRunState;
+    env_vars: {
+        [key: string]: (string);
+    };
+};
+
+export type ExecuteRunState = 'starting' | 'running' | 'complete';
+
 export type FreestyleCloudstateDeployConfiguration = {
     /**
      * ID of the project to deploy, if not provided will create a new project
      */
-    projectId?: (string) | null;
+    domains?: Array<(string)> | null;
     /**
      * The environment variables that the cloudstate deploy can access
      */
     envVars?: {
         [key: string]: (string);
     };
+    cloudstateDatabaseId?: (string) | null;
 };
 
 export type FreestyleCloudstateDeployErrorResponse = {
@@ -23,10 +53,8 @@ export type FreestyleCloudstateDeployRequest = {
 };
 
 export type FreestyleCloudstateDeploySuccessResponse = {
-    /**
-     * The id of the project deployed to
-     */
-    projectId: string;
+    deploymentId: string;
+    cloudstateDatabaseId: string;
 };
 
 export type FreestyleDeleteDomainVerificationRequest = {
@@ -102,15 +130,6 @@ export type FreestyleDomainVerificationRequest = {
     domain: string;
 };
 
-export type FreestyleExecureScriptResultError = {
-    error: string;
-};
-
-export type FreestyleExecureScriptResultSuccess = {
-    result: unknown;
-    logs: Array<JavaScriptLog>;
-};
-
 export type FreestyleExecuteScriptParams = {
     /**
      * The JavaScript or TypeScript script to execute
@@ -146,6 +165,11 @@ export type FreestyleExecuteScriptParamsConfiguration = {
     peerDependencyResolution?: boolean;
 };
 
+export type FreestyleExecuteScriptResultSuccess = {
+    result: unknown;
+    logs: Array<FreestyleJavaScriptLog>;
+};
+
 export type FreestyleFile = {
     /**
      * The content of the file
@@ -157,15 +181,7 @@ export type FreestyleFile = {
     encoding?: string;
 };
 
-export type FreestyleLogResponseObject = {
-    message: string;
-};
-
-export type FreestyleVerifyDomainRequest = {
-    domain: string;
-};
-
-export type JavaScriptLog = {
+export type FreestyleJavaScriptLog = {
     /**
      * The log message
      */
@@ -176,6 +192,15 @@ export type JavaScriptLog = {
     type: string;
 };
 
+export type FreestyleLogResponseObject = {
+    message: string;
+    timestamp: string;
+};
+
+export type FreestyleVerifyDomainRequest = {
+    domain: string;
+};
+
 export type HandleDeployCloudstateData = {
     body: FreestyleCloudstateDeployRequest;
 };
@@ -194,6 +219,14 @@ export type HandleBackupCloudstateResponse = (Array<(number)>);
 
 export type HandleBackupCloudstateError = (unknown);
 
+export type HandleVerifyWildcardResponse = ({
+    domain: string;
+});
+
+export type HandleVerifyWildcardError = ({
+    message: string;
+});
+
 export type HandleListDomainsResponse = (Array<{
     domain: string;
     createdAt: number;
@@ -251,13 +284,57 @@ export type HandleDeleteDomainVerificationError = ({
     message: string;
 });
 
+export type HandleListExecuteRunsData = {
+    query?: {
+        limit?: (number) | null;
+        offset?: (number) | null;
+    };
+};
+
+export type HandleListExecuteRunsResponse = ({
+    entries: Array<ExecuteLogEntry>;
+    total: number;
+    offset: number;
+});
+
+export type HandleListExecuteRunsError = ({
+    message: string;
+});
+
+export type HandleGetExecuteRunData = {
+    path: {
+        deployment: string;
+    };
+};
+
+export type HandleGetExecuteRunResponse = (ExecuteLogEntry);
+
+export type HandleGetExecuteRunError = ({
+    message: string;
+});
+
 export type HandleExecuteScriptData = {
     body: FreestyleExecuteScriptParams;
 };
 
-export type HandleExecuteScriptResponse = (FreestyleExecureScriptResultSuccess);
+export type HandleExecuteScriptResponse = ({
+    result: unknown;
+    logs: Array<FreestyleJavaScriptLog>;
+});
+
+export type HandleExecuteScriptError = ({
+    error: string;
+});
+
+export type HandleGetLogsData = {
+    query: {
+        deploymentId: string;
+    };
+};
+
+export type HandleGetLogsResponse = (Array<FreestyleLogResponseObject>);
 
-export type HandleExecuteScriptError = (FreestyleExecureScriptResultError);
+export type HandleGetLogsError = unknown;
 
 export type HandleDeployWebData = {
     body: FreestyleDeployWebPayload;
@@ -267,12 +344,12 @@ export type HandleDeployWebResponse = (FreestyleDeployWebSuccessResponse);
 
 export type HandleDeployWebError = (FreestyleDeployWebErrorResponse);
 
-export type HandleGetLogsData = {
-    path: {
-        id: string;
-    };
-};
-
-export type HandleGetLogsResponse = (Array<FreestyleLogResponseObject>);
+export type HandleListWebDeploysResponse = ({
+    entries: Array<DeploymentLogEntry>;
+    total: number;
+    offset: number;
+});
 
-export type HandleGetLogsError = unknown;
+export type HandleListWebDeploysError = ({
+    message: string;
+});