@buddy-works/sandbox-sdk 0.1.0-rc.1 → 0.1.1-rc.0

package/README.md

@@ -19,6 +19,7 @@ let sandbox: Sandbox;
 
 try {
     sandbox = await Sandbox.getByIdentifier(identifier);
+    await sandbox.start();
 } catch {
     sandbox = await Sandbox.create({
         identifier,
@@ -30,6 +31,8 @@ try {
 await sandbox.runCommand({
     command: "ping -c 5 buddy.works",
 });
+
+await sandbox.stop();
 ```
 
 Set required environment variables:

package/dist/index.d.mts

@@ -3,6 +3,26 @@ import { inspect } from "node:util";
 import { Writable } from "node:stream";
 
 //#region src/api/openapi/types.gen.d.ts
+type GroupPermissionView = {
+  /**
+       * The ID of the group
+       */
+  id?: number;
+  /**
+       * The access level for the group
+       */
+  access_level?: "DENIED" | "READ_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT" | "USE_ONLY";
+};
+type UserPermissionView = {
+  /**
+       * The ID of the user
+       */
+  id?: number;
+  /**
+       * The access level for the user
+       */
+  access_level?: "DENIED" | "READ_ONLY" | "BLIND" | "RUN_ONLY" | "READ_WRITE" | "MANAGE" | "DEFAULT" | "ALLOWED" | "STAGE" | "COMMIT" | "USE_ONLY";
+};
 /**
  * Sandbox reference
  */
@@ -214,6 +234,23 @@ 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
  */
@@ -616,6 +653,7 @@ type SandboxResponse = {
        */
   endpoints?: Array<TunnelView>;
   project?: ProjectView;
+  permissions?: PermissionsView;
   /**
        * The environment variables of the sandbox
        */
@@ -1590,16 +1628,21 @@ declare class Sandbox {
   waitUntilStopped(pollIntervalMs?: number, maxWaitMs?: number): Promise<void>;
   /**
        * Start a stopped sandbox
-       * Waits until the sandbox reaches RUNNING state
+       *
+       * If the sandbox is already running, this method returns immediately.
+       * Waits until the sandbox reaches RUNNING state.
        */
   start(): Promise<void>;
   /**
        * Stop a running sandbox
-       * Waits until the sandbox reaches STOPPED state
+       *
+       * If the sandbox is already stopped, this method returns immediately.
+       * Waits until the sandbox reaches STOPPED state.
        */
   stop(): Promise<void>;
   /**
        * Restart the sandbox
+       *
        * Waits until the sandbox reaches RUNNING state and setup is complete
        */
   restart(): Promise<void>;

package/dist/index.mjs

@@ -55,89 +55,37 @@ const stopSandboxResponseTransformer = async (data) => {
 
 //#endregion
 //#region src/api/openapi/zod.gen.ts
-const zUriBuilder = z.record(z.string(), z.unknown());
-const zStatusType = z.object({
-	family: z.optional(z.enum([
-		"INFORMATIONAL",
-		"SUCCESSFUL",
-		"REDIRECTION",
-		"CLIENT_ERROR",
-		"SERVER_ERROR",
-		"OTHER"
-	])),
-	status_code: z.optional(z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" })),
-	reason_phrase: z.optional(z.string())
-});
-const zEntityTag = z.object({
-	value: z.optional(z.string()),
-	weak: z.optional(z.boolean())
-});
-const zMediaType = z.object({
-	type: z.optional(z.string()),
-	subtype: z.optional(z.string()),
-	parameters: z.optional(z.record(z.string(), z.string())),
-	wildcard_type: z.optional(z.boolean()),
-	wildcard_subtype: z.optional(z.boolean())
-});
-const zLink = z.object({
-	uri: z.optional(z.url()),
-	uri_builder: z.optional(zUriBuilder),
-	rel: z.optional(z.string()),
-	rels: z.optional(z.array(z.string())),
-	type: z.optional(z.string()),
-	params: z.optional(z.record(z.string(), z.string())),
-	title: z.optional(z.string())
-});
-const zNewCookie = z.object({
-	name: z.optional(z.string()),
-	value: z.optional(z.string()),
-	version: z.optional(z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" })),
-	path: z.optional(z.string()),
-	domain: z.optional(z.string()),
-	comment: z.optional(z.string()),
-	max_age: z.optional(z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" })),
-	expiry: z.optional(z.iso.datetime()),
-	secure: z.optional(z.boolean()),
-	http_only: z.optional(z.boolean()),
-	same_site: z.optional(z.enum([
-		"NONE",
-		"LAX",
-		"STRICT"
-	]))
+const zGroupPermissionView = z.object({
+	id: z.optional(z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).register(z.globalRegistry, { description: "The ID of the group" })),
+	access_level: z.optional(z.enum([
+		"DENIED",
+		"READ_ONLY",
+		"BLIND",
+		"RUN_ONLY",
+		"READ_WRITE",
+		"MANAGE",
+		"DEFAULT",
+		"ALLOWED",
+		"STAGE",
+		"COMMIT",
+		"USE_ONLY"
+	]).register(z.globalRegistry, { description: "The access level for the group" }))
 });
-const zResponse = z.object({
-	status_info: z.optional(zStatusType),
-	cookies: z.optional(z.record(z.string(), zNewCookie)),
-	allowed_methods: z.optional(z.array(z.string())),
-	links: z.optional(z.array(zLink)),
-	media_type: z.optional(zMediaType),
-	entity_tag: z.optional(zEntityTag),
-	string_headers: z.optional(z.object({ empty: z.optional(z.boolean()) })),
-	closed: z.optional(z.boolean()),
-	length: z.optional(z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" })),
-	location: z.optional(z.url()),
-	language: z.optional(z.object({
-		language: z.optional(z.string()),
-		display_name: z.optional(z.string()),
-		country: z.optional(z.string()),
-		variant: z.optional(z.string()),
-		script: z.optional(z.string()),
-		unicode_locale_attributes: z.optional(z.array(z.string())),
-		unicode_locale_keys: z.optional(z.array(z.string())),
-		display_language: z.optional(z.string()),
-		display_script: z.optional(z.string()),
-		display_country: z.optional(z.string()),
-		display_variant: z.optional(z.string()),
-		extension_keys: z.optional(z.array(z.string())),
-		iso3_language: z.optional(z.string()),
-		iso3_country: z.optional(z.string())
-	})),
-	date: z.optional(z.iso.datetime()),
-	last_modified: z.optional(z.iso.datetime()),
-	status: z.optional(z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" })),
-	metadata: z.optional(z.object({ empty: z.optional(z.boolean()) })),
-	entity: z.optional(z.record(z.string(), z.unknown())),
-	headers: z.optional(z.object({ empty: z.optional(z.boolean()) }))
+const zUserPermissionView = z.object({
+	id: z.optional(z.int().min(-2147483648, { error: "Invalid value: Expected int32 to be >= -2147483648" }).max(2147483647, { error: "Invalid value: Expected int32 to be <= 2147483647" }).register(z.globalRegistry, { description: "The ID of the user" })),
+	access_level: z.optional(z.enum([
+		"DENIED",
+		"READ_ONLY",
+		"BLIND",
+		"RUN_ONLY",
+		"READ_WRITE",
+		"MANAGE",
+		"DEFAULT",
+		"ALLOWED",
+		"STAGE",
+		"COMMIT",
+		"USE_ONLY"
+	]).register(z.globalRegistry, { description: "The access level for the user" }))
 });
 /**
 * Sandbox reference
@@ -276,6 +224,26 @@ const zProjectView = z.object({
 	without_repository: z.optional(z.boolean().register(z.globalRegistry, { description: "If set to true, the project is created without any repository attached." }))
 });
 /**
+* Access permissions configuration
+*/
+const zPermissionsView = z.object({
+	others: z.optional(z.enum([
+		"DENIED",
+		"READ_ONLY",
+		"BLIND",
+		"RUN_ONLY",
+		"READ_WRITE",
+		"MANAGE",
+		"DEFAULT",
+		"ALLOWED",
+		"STAGE",
+		"COMMIT",
+		"USE_ONLY"
+	]).register(z.globalRegistry, { description: "Access level for other workspace members" })),
+	users: z.optional(z.array(zUserPermissionView).register(z.globalRegistry, { description: "List of specific users with their access levels" })),
+	groups: z.optional(z.array(zGroupPermissionView).register(z.globalRegistry, { description: "List of user groups with their access levels" }))
+}).register(z.globalRegistry, { description: "Access permissions configuration" });
+/**
 * The environment variables of the sandbox
 */
 const zAddVariableInObjectRequest = z.object({
@@ -386,7 +354,8 @@ const zUpdateSandboxRequest = z.object({
 	app_type: z.optional(z.enum(["CMD", "SERVICE"]).register(z.globalRegistry, { description: "The application type of the sandbox (passed command or existent service eg. apache2)" })),
 	tags: z.optional(z.array(z.string().register(z.globalRegistry, { description: "The list of tags associated with the sandbox" })).register(z.globalRegistry, { description: "The list of tags associated with the sandbox" })),
 	endpoints: z.optional(z.array(zTunnelView).register(z.globalRegistry, { description: "The tunnel endpoints of the sandbox" })),
-	variables: z.optional(z.array(zAddVariableInObjectRequest).register(z.globalRegistry, { description: "The environment variables of the sandbox" }))
+	variables: z.optional(z.array(zAddVariableInObjectRequest).register(z.globalRegistry, { description: "The environment variables of the sandbox" })),
+	permissions: z.optional(zPermissionsView)
 });
 const zSandboxesView = z.object({
 	url: z.optional(z.string().register(z.globalRegistry, { description: "API endpoint to GET this object" }).readonly()),
@@ -637,6 +606,7 @@ const zSandboxResponse = z.object({
 	]).register(z.globalRegistry, { description: "The current setup status of the sandbox" })),
 	endpoints: z.optional(z.array(zTunnelView).register(z.globalRegistry, { description: "The tunnel endpoints of the sandbox" })),
 	project: z.optional(zProjectView),
+	permissions: z.optional(zPermissionsView),
 	variables: z.optional(z.array(zEnvironmentVariableView).register(z.globalRegistry, { description: "The environment variables of the sandbox" }))
 });
 /**
@@ -875,7 +845,8 @@ const zUpdateSandboxRequestWritable = z.object({
 	app_type: z.optional(z.enum(["CMD", "SERVICE"]).register(z.globalRegistry, { description: "The application type of the sandbox (passed command or existent service eg. apache2)" })),
 	tags: z.optional(z.array(z.string().register(z.globalRegistry, { description: "The list of tags associated with the sandbox" })).register(z.globalRegistry, { description: "The list of tags associated with the sandbox" })),
 	endpoints: z.optional(z.array(zTunnelViewWritable).register(z.globalRegistry, { description: "The tunnel endpoints of the sandbox" })),
-	variables: z.optional(z.array(zAddVariableInObjectRequestWritable).register(z.globalRegistry, { description: "The environment variables of the sandbox" }))
+	variables: z.optional(z.array(zAddVariableInObjectRequestWritable).register(z.globalRegistry, { description: "The environment variables of the sandbox" })),
+	permissions: z.optional(zPermissionsView)
 });
 const zSandboxesViewWritable = z.object({ sandboxes: z.optional(z.array(zSandboxIdViewWritable)) });
 /**
@@ -1042,6 +1013,7 @@ const zSandboxResponseWritable = z.object({
 	]).register(z.globalRegistry, { description: "The current setup status of the sandbox" })),
 	endpoints: z.optional(z.array(zTunnelViewWritable).register(z.globalRegistry, { description: "The tunnel endpoints of the sandbox" })),
 	project: z.optional(zProjectViewWritable),
+	permissions: z.optional(zPermissionsView),
 	variables: z.optional(z.array(zEnvironmentVariableView).register(z.globalRegistry, { description: "The environment variables of the sandbox" }))
 });
 const zGetSandboxesData = z.object({
@@ -1204,6 +1176,10 @@ const zDownloadSandboxContentData = z.object({
 	}),
 	query: z.optional(z.never())
 });
+/**
+* File download
+*/
+const zDownloadSandboxContentResponse = z.string().register(z.globalRegistry, { description: "File download" });
 const zRestartSandboxData = z.object({
 	body: z.optional(z.never()),
 	path: z.object({
@@ -1311,7 +1287,7 @@ const zAddSandboxByYamlData = z.object({
 //#endregion
 //#region package.json
 var name = "@buddy-works/sandbox-sdk";
-var version = "0.1.0-rc.1";
+var version = "0.1.1-rc.0";
 
 //#endregion
 //#region src/utils/environment.ts
@@ -2551,11 +2527,18 @@ var Sandbox = class Sandbox {
 	}
 	/**
 	* Start a stopped sandbox
-	* Waits until the sandbox reaches RUNNING state
+	*
+	* If the sandbox is already running, this method returns immediately.
+	* Waits until the sandbox reaches RUNNING state.
 	*/
 	async start() {
 		const sandboxId = this.initializedId;
 		return withErrorHandler("Failed to start sandbox", async () => {
+			await this.refresh();
+			if (this.data.status === "RUNNING") {
+				logger_default.debug(`Sandbox ${sandboxId} is already running.`);
+				return;
+			}
 			logger_default.debug(`Starting sandbox ${sandboxId}...`);
 			this.#sandboxData = await this.#client.startSandbox({ path: { sandbox_id: sandboxId } });
 			await this.waitUntilRunning();
@@ -2564,11 +2547,18 @@ var Sandbox = class Sandbox {
 	}
 	/**
 	* Stop a running sandbox
-	* Waits until the sandbox reaches STOPPED state
+	*
+	* If the sandbox is already stopped, this method returns immediately.
+	* Waits until the sandbox reaches STOPPED state.
 	*/
 	async stop() {
 		const sandboxId = this.initializedId;
 		return withErrorHandler("Failed to stop sandbox", async () => {
+			await this.refresh();
+			if (this.data.status === "STOPPED") {
+				logger_default.debug(`Sandbox ${sandboxId} is already stopped.`);
+				return;
+			}
 			logger_default.debug(`Stopping sandbox ${sandboxId}...`);
 			this.#sandboxData = await this.#client.stopSandbox({ path: { sandbox_id: sandboxId } });
 			await this.waitUntilStopped();
@@ -2577,6 +2567,7 @@ var Sandbox = class Sandbox {
 	}
 	/**
 	* Restart the sandbox
+	*
 	* Waits until the sandbox reaches RUNNING state and setup is complete
 	*/
 	async restart() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buddy-works/sandbox-sdk",
-  "version": "0.1.0-rc.1",
+  "version": "0.1.1-rc.0",
   "type": "module",
   "description": "TypeScript SDK for managing sandboxes through the Buddy API",
   "main": "./dist/index.mjs",
@@ -46,6 +46,7 @@
     "knip": "5.81.0",
     "msw": "2.12.7",
     "tsdown": "0.20.0-beta.3",
+    "tsx": "4.21.0",
     "typescript": "5.9.3",
     "vitest": "4.0.17"
   },
@@ -54,7 +55,7 @@
     "zod": "4.3.5"
   },
   "scripts": {
-    "fetch:schemas": "openapi-ts",
+    "fetch:schemas": "dotenvx run -q -- openapi-ts",
     "build": "tsdown",
     "test": "NODE_OPTIONS='--enable-source-maps' dotenvx run -q -- vitest run",
     "test:watch": "NODE_OPTIONS='--enable-source-maps' dotenvx run -q -- vitest",