@buddy-works/sandbox-sdk 0.1.5 → 0.1.6-rc.0

package/README.md

@@ -56,6 +56,7 @@ const sandbox = await Sandbox.create({
     os: "ubuntu:24.04",
     first_boot_commands: "apt-get update && apt-get install -y curl",
     apps: ["node server.js", "python worker.py"],
+    timeout: 600, // auto-stop after 10 minutes of inactivity
 });
 
 // List apps
@@ -73,6 +74,27 @@ const { logs } = await sandbox.getAppLogs(appId);
 console.log(logs);
 ```
 
+## Fetching repositories and artifacts
+
+Use `fetch` to clone repositories or download artifacts into the sandbox on
+first boot. Each entry sets a `type` (`PROJECT_REPO`, `PUBLIC_REPO`, or
+`ARTIFACT`) plus the fields relevant to it.
+
+```typescript
+await Sandbox.create({
+    identifier: "my-sandbox",
+    fetch: [
+        {
+            type: "PUBLIC_REPO",
+            repository: "https://github.com/octocat/Hello-World",
+            ref: "master",
+            path: "/workspace/hello",
+            build_command: "echo built",
+        },
+    ],
+});
+```
+
 ## Regions
 
 Configure the API region:

package/dist/index.d.mts

@@ -10,7 +10,7 @@ type GroupPermissionView = {
   /**
        * The access level for the group
        */
-  access_level?: "DENIED" | "READ_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT" | "USE_ONLY";
+  access_level?: "DENIED" | "READ_ONLY" | "USE_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT";
 };
 type UserPermissionView = {
   /**
@@ -20,7 +20,24 @@ type UserPermissionView = {
   /**
        * The access level for the user
        */
-  access_level?: "DENIED" | "READ_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT" | "USE_ONLY";
+  access_level?: "DENIED" | "READ_ONLY" | "USE_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT";
+};
+/**
+ * Access permissions configuration
+ */
+type PermissionsView = {
+  /**
+       * Access level for other workspace members
+       */
+  others?: "DENIED" | "READ_ONLY" | "USE_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT";
+  /**
+       * List of specific users with their access levels
+       */
+  users?: Array<UserPermissionView>;
+  /**
+       * List of user groups with their access levels
+       */
+  groups?: Array<GroupPermissionView>;
 };
 type IdsView = {
   /**
@@ -48,17 +65,37 @@ type IdsView = {
        */
   environment_id?: string;
   /**
-       * The ID of the package
+       * The ID of the artifact
        */
-  pkg_id?: string;
+  artifact_id?: string;
   /**
-       * The ID of the package version
+       * The ID of the artifact version
        */
-  pkg_version_id?: string;
+  artifact_version_id?: string;
   /**
        * The ID of the sandbox
        */
   sandbox_id?: string;
+  /**
+       * The ID of the unit test suite
+       */
+  unit_test_suite_id?: string;
+  /**
+       * The ID of the visual test suite
+       */
+  visual_test_suite_id?: string;
+  /**
+       * The ID of the crawl suite
+       */
+  crawl_suite_id?: string;
+  /**
+       * The ID of the distribution
+       */
+  distribution_id?: string;
+  /**
+       * The ID of the route
+       */
+  route_id?: string;
 };
 /**
  * Sandbox reference
@@ -120,7 +157,7 @@ type IntegrationIdView = {
   /**
        * The type of integration
        */
-  type?: "GIT_HUB" | "BITBUCKET" | "GOOGLE" | "DIGITAL_OCEAN" | "SLACK" | "MODULUS" | "HEROKU" | "AMAZON" | "GIT_LAB" | "SHOPIFY" | "GIT_HUB_ENTERPRISE" | "GIT_LAB_ENTERPRISE" | "PUSHOVER" | "PUSHBULLET" | "RACKSPACE" | "CUSTOM" | "CLOUDFLARE" | "NEW_RELIC" | "SENTRY" | "ROLLBAR" | "DATADOG" | "DO_SPACES" | "HONEYBADGER" | "VULTR" | "SENTRY_ENTERPRISE" | "LOGGLY" | "HIP_CHAT" | "FIREBASE" | "TELEGRAM" | "AZURE" | "UPCLOUD" | "GHOST_INSPECTOR" | "NETLIFY" | "AZURE_CLOUD" | "MICROSOFT_TEAMS" | "GOOGLE_SERVICE_ACCOUNT" | "GOOGLE_PLAY_STORE" | "DOCKER_HUB" | "APP_STORE" | "GIT_HUB_APP" | "GIT_HUB_APP_ENTERPRISE" | "GIT_HUB_API" | "ATOP" | "SNYK" | "STACK_HAWK" | "BLACKFIRE" | "BACKBLAZE" | "ONE_LOGIN" | "OKTA" | "CONTENTFUL" | "JIRA";
+  type?: "GIT_HUB" | "BITBUCKET" | "GOOGLE" | "DIGITAL_OCEAN" | "SLACK" | "MODULUS" | "HEROKU" | "AMAZON" | "GIT_LAB" | "SHOPIFY" | "GIT_HUB_ENTERPRISE" | "GIT_LAB_ENTERPRISE" | "PUSHOVER" | "PUSHBULLET" | "RACKSPACE" | "CUSTOM" | "CLOUDFLARE" | "NEW_RELIC" | "SENTRY" | "ROLLBAR" | "DATADOG" | "DO_SPACES" | "HONEYBADGER" | "VULTR" | "SENTRY_ENTERPRISE" | "LOGGLY" | "HIP_CHAT" | "FIREBASE" | "TELEGRAM" | "AZURE" | "UPCLOUD" | "GHOST_INSPECTOR" | "NETLIFY" | "AZURE_CLOUD" | "MICROSOFT_TEAMS" | "GOOGLE_SERVICE_ACCOUNT" | "GOOGLE_PLAY_STORE" | "DOCKER_HUB" | "APP_STORE" | "GIT_HUB_APP" | "GIT_HUB_APP_ENTERPRISE" | "GIT_HUB_API" | "ATOP" | "SNYK" | "STACK_HAWK" | "BLACKFIRE" | "BACKBLAZE" | "ONE_LOGIN" | "OKTA" | "CONTENTFUL" | "JIRA" | "NPM_REGISTRY" | "ANTHROPIC";
   /**
        * The authentication method used by the integration
        */
@@ -275,23 +312,6 @@ type ProjectView = {
        */
   without_repository?: boolean;
 };
-/**
- * Access permissions configuration
- */
-type PermissionsView = {
-  /**
-       * Access level for other workspace members
-       */
-  others?: "DENIED" | "READ_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT" | "USE_ONLY";
-  /**
-       * List of specific users with their access levels
-       */
-  users?: Array<UserPermissionView>;
-  /**
-       * List of user groups with their access levels
-       */
-  groups?: Array<GroupPermissionView>;
-};
 /**
  * The TLS/SSL encryption settings of the tunnel
  */
@@ -414,6 +434,32 @@ type TunnelView = {
        */
   endpoint_url?: string;
 };
+type SandboxFetchView = {
+  /**
+       * The type of the fetch item: PROJECT_REPO, PUBLIC_REPO, or ARTIFACT
+       */
+  type?: "PROJECT_REPO" | "PUBLIC_REPO" | "ARTIFACT";
+  /**
+       * The URL of the git repository (for PUBLIC_REPO type)
+       */
+  repository?: string;
+  /**
+       * The branch, tag, or commit to checkout. Defaults to the default branch
+       */
+  ref?: string;
+  /**
+       * The target path where the item will be cloned/downloaded. Defaults to the app directory
+       */
+  path?: string;
+  /**
+       * The command to run after fetching
+       */
+  build_command?: string;
+  /**
+       * The artifact identifier in format pkg:version (for ARTIFACT type)
+       */
+  artifact?: string;
+};
 type SandboxAppView = {
   /**
        * The auto-generated ID of the app
@@ -607,15 +653,15 @@ type EnvironmentVariableView = {
        */
   defaults?: string;
   /**
-       * Specifies where to copy the file on each run. Set if `type` is `SSH_KEY`
+       * Specifies where to copy the file on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`
        */
   file_path?: string;
   /**
-       * File permission set on copy to a container on each run. Set if `type` is `SSH_KEY`
+       * File permission set on copy to a container on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`
        */
   file_chmod?: string;
   /**
-       * Set if `type` is `SSH_KEY`. If it's `NONE`, the variable can be used as a parameter in an action. For `CONTAINER`, the given key is additionally copied to an action container on each run
+       * Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`. If it's `NONE`, the variable can be used as a parameter in an action. For `CONTAINER`, the given key is additionally copied to an action container on each run
        */
   file_place?: "NONE" | "CONTAINER";
   /**
@@ -643,9 +689,13 @@ type EnvironmentVariableView = {
        */
   passphrase?: string;
   /**
-       * GPG key identifier
+       * Key identifier for iOS certificates, provisioning profiles, or GPG keys
        */
   key_identifier?: string;
+  /**
+       * Set to `true` to disable the variable. Disabled variables are not injected anywhere
+       */
+  disabled?: boolean;
 };
 type CloneSandboxRequest = {
   /**
@@ -710,6 +760,10 @@ type SandboxResponse = {
        * The list of apps (run commands) for the sandbox
        */
   apps?: Array<SandboxAppView>;
+  /**
+       * The list of items (repositories and artifacts) to fetch into the sandbox
+       */
+  fetch?: Array<SandboxFetchView>;
   /**
        * The timeout in seconds after which the sandbox will be automatically stopped
        */
@@ -726,6 +780,14 @@ type SandboxResponse = {
        * The tunnel endpoints of the sandbox
        */
   endpoints?: Array<TunnelView>;
+  /**
+       * The SSH hostname
+       */
+  ssh_host?: string;
+  /**
+       * The SSH port
+       */
+  ssh_port?: number;
   project?: ProjectView;
   permissions?: PermissionsView;
   /**
@@ -770,15 +832,15 @@ type AddVariableInObjectRequestWritable = {
        */
   defaults?: string;
   /**
-       * Specifies where to copy the file on each run. Set if `type` is `SSH_KEY`
+       * Specifies where to copy the file on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`
        */
   file_path?: string;
   /**
-       * File permission set on copy to a container on each run. Set if `type` is `SSH_KEY`
+       * File permission set on copy to a container on each run. Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`
        */
   file_chmod?: string;
   /**
-       * Set if `type` is `SSH_KEY`. If it's `NONE`, the variable can be used as a parameter in an action. For `CONTAINER`, the given key is additionally copied to an action container on each run
+       * Set if `type` is `FILE`, `SSH_KEY`, `SSH_PUBLIC_KEY`, `IOS_KEYCHAIN`, or `IOS_PROVISION_PROFILES`. If it's `NONE`, the variable can be used as a parameter in an action. For `CONTAINER`, the given key is additionally copied to an action container on each run
        */
   file_place?: "NONE" | "CONTAINER";
   /**
@@ -790,9 +852,13 @@ type AddVariableInObjectRequestWritable = {
        */
   passphrase?: string;
   /**
-       * GPG key identifier
+       * Key identifier for iOS certificates, provisioning profiles, or GPG keys
        */
   key_identifier?: string;
+  /**
+       * Set to `true` to disable the variable. Disabled variables are not injected anywhere
+       */
+  disabled?: boolean;
   /**
        * The type of the added variable
        */
@@ -945,6 +1011,10 @@ type CreateNewSandboxRequestWritable = {
        * The list of apps (run commands) for the sandbox
        */
   apps?: Array<string>;
+  /**
+       * The list of items (repositories and artifacts) to fetch into the sandbox
+       */
+  fetch?: Array<SandboxFetchView>;
   /**
        * The list of tags associated with the sandbox
        */
@@ -1031,17 +1101,45 @@ type GetIdentifiersData = {
              */
     environment?: string;
     /**
-             * The human-readable ID of the package
+             * The human-readable ID of the artifact
              */
-    package?: string;
+    artifact?: string;
     /**
-             * The version of the package
+             * The version of the artifact
              */
-    package_version?: string;
+    artifact_version?: string;
     /**
              * The human-readable ID of the sandbox
              */
     sandbox?: string;
+    /**
+             * The human-readable ID of the unit test suite
+             */
+    unit_test_suite?: string;
+    /**
+             * The human-readable ID of the visual test suite
+             */
+    visual_test_suite?: string;
+    /**
+             * The human-readable ID of the crawl suite
+             */
+    crawl_suite?: string;
+    /**
+             * The human-readable ID of the distribution
+             */
+    distribution?: string;
+    /**
+             * The subdomain of the route. Resolved together with route_domain and route_path against the parent distribution.
+             */
+    route_subdomain?: string;
+    /**
+             * The domain of the route. Required to resolve a route.
+             */
+    route_domain?: string;
+    /**
+             * The path of the route. Resolved together with route_subdomain and route_domain against the parent distribution.
+             */
+    route_path?: string;
   };
   url: "/workspaces/{workspace_domain}/identifiers";
 };