@agentproto/computer-api 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,59 @@
-# Temporary Holding Version
+# @agentproto/computer-api
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Versioned public contract for the computer controller's HTTP API
+(`POST/GET/DELETE /v1/computers...`): zod schemas plus inferred types for
+every request body, response body, the error envelope, computer states and
+published ports.
+
+Generic and deployment-independent: no host names, no IPs, no tenant names,
+no deployment specifics. Template ids are an OPEN string (any id a
+controller has registered); controller error strings are also open.
+
+## Design rules
+
+- MINIMAL: only fields a client actually consumes are declared.
+- Passthrough everywhere: a controller adding fields never breaks an
+  older client.
+- Read-tolerant computer states: unknown future states bucket under
+  `"unknown"` instead of throwing.
+- Synchronous, no-throw status reads: the state transform is a widening
+  map, not an enum validator.
+
+## Versioning
+
+`COMPUTER_API_VERSION` (currently `"v1"`) is the API version the schemas
+describe. A major bump of this package is where that constant changes.
+
+## Endpoints covered
+
+| Method | Route                        | Request schema              | Response schema              |
+| ------ | ---------------------------- | --------------------------- | ---------------------------- |
+| POST   | `/v1/computers`              | `createComputerRequestSchema` | `createComputerResponseSchema` |
+| GET    | `/v1/computers/:id`          | -                           | `computerStatusSchema`       |
+| POST   | `/v1/computers/:id/exec`     | `execRequestSchema`         | `execResponseSchema`         |
+| POST   | `/v1/computers/:id/suspend`  | -                           | `suspendResponseSchema`      |
+| POST   | `/v1/computers/:id/resume`   | -                           | `resumeResponseSchema`       |
+| POST   | `/v1/computers/:id/attach`   | -                           | `sessionsResponseSchema`     |
+| POST   | `/v1/computers/:id/detach`   | -                           | `sessionsResponseSchema`     |
+| DELETE | `/v1/computers/:id`          | - (`?force=true` optional)  | `suspendResponseSchema` shape (all-optional) |
+| any    | error body                   | -                           | `errorResponseSchema`        |
+
+## Contract tests
+
+`src/__tests__/fixtures.ts` carries a valid and an invalid fixture per
+payload; `contract.test.ts` pins them. The fake controller used by
+`@agentproto/sandbox-computer` validates everything it emits against the
+same schemas, so the test double cannot drift from the published contract.
+
+## Notes
+
+- Sessions: `maxSessions` on create sizes the computer for that many
+  concurrent sessions. `attach` takes a slot (409 at the cap), `detach`
+  releases one (floors at 0), and `DELETE` answers 409 while sessions are
+  attached unless `?force=true` is passed.
+- `resume` MAY rename the computer: the controller can restore the suspend
+  snapshot into a fresh computer under a NEW generated id and answer
+  `{ id: <new>, state: "running" }`. Callers must treat the old id as gone
+  and adopt the returned id.
+- Egress is deny-by-default: a computer created without an
+  `egress.allow` list has no DNS.

package/dist/index.d.ts

@@ -0,0 +1,170 @@
+import { z } from 'zod';
+
+/**
+ * Version of the computer controller HTTP contract described by this
+ * package. The controller routes live under this version prefix (for
+ * example `POST /v1/computers`), and every payload schema here corresponds
+ * to that version.
+ *
+ * Semver of the PACKAGE tracks this contract: a MAJOR bump of
+ * `@agentproto/computer-api` is where this constant changes.
+ */
+declare const COMPUTER_API_VERSION = "v1";
+
+/**
+ * Driver-level computer states, as reported by `GET /v1/computers/:id`.
+ *
+ * The controller itself never reports `suspended`: a suspended computer
+ * reads back as `stopped`. The state is kept here as a tolerated alias so
+ * a newer controller can report it without breaking an older client.
+ */
+declare const COMPUTER_STATES: readonly ["running", "stopped", "paused", "crashed", "starting", "unknown", "missing", "suspended"];
+type ComputerState = (typeof COMPUTER_STATES)[number];
+
+/**
+ * The state field is READ-tolerant: any unknown future state is bucketed
+ * under `"unknown"` instead of rejecting, so a status read never throws on
+ * controller evolution.
+ */
+declare const computerStateSchema: z.ZodPipe<z.ZodString, z.ZodTransform<"running" | "stopped" | "paused" | "crashed" | "starting" | "unknown" | "missing" | "suspended", string>>;
+declare const COMPUTER_STATE_UNKNOWN: ComputerState;
+
+/**
+ * Zod schemas for the computer controller's HTTP contract constants -
+ * the generic, deployment-independent shape of every endpoint:
+ *
+ *   POST   /v1/computers            create
+ *   GET    /v1/computers/:id        status
+ *   POST   /v1/computers/:id/exec   synchronous exec of an argv array
+ *   POST   /v1/computers/:id/suspend  full snapshot + stop
+ *   POST   /v1/computers/:id/resume   restore into a FRESH computer
+ *   POST   /v1/computers/:id/attach   take a session slot
+ *   POST   /v1/computers/:id/detach   release a session slot
+ *   DELETE /v1/computers/:id        rm + snapshot cleanup (?force=true skips the session check)
+ *
+ * These are deliberately MINIMAL: only the fields a client actually
+ * consumes are declared, and every schema allows (and preserves) extra
+ * fields so a controller version adding fields never breaks an older
+ * client. Template ids are an OPEN string - any registered id is valid.
+ *
+ * Nothing deployment-specific belongs here: no host names, no IPs, no
+ * tenant names, no auth realm details. Auth headers are wired by the
+ * client, not the contract.
+ */
+
+/** A published port: the host-side port mapped to the guest-side port. */
+declare const portPublishSchema: z.ZodObject<{
+    host: z.ZodNumber;
+    guest: z.ZodNumber;
+}, z.core.$strip>;
+type PortPublish = z.infer<typeof portPublishSchema>;
+/** Egress allowlist entry in the create body: destination host + port. */
+declare const egressRuleSchema: z.ZodObject<{
+    host: z.ZodString;
+    port: z.ZodNumber;
+}, z.core.$strip>;
+type EgressRule = z.infer<typeof egressRuleSchema>;
+/**
+ * Controller error bodies are always `{ error: string }`, sometimes with a
+ * `detail` array of validation issues. The `code` strings a controller may
+ * emit (for example unknown template, capacity) are contract-OPEN: clients
+ * inspect but never switch exhaustively on them.
+ */
+declare const errorResponseSchema: z.ZodObject<{
+    error: z.ZodString;
+    detail: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$loose>;
+type ErrorResponse = z.infer<typeof errorResponseSchema>;
+/** Request body for `POST /v1/computers`. */
+declare const createComputerRequestSchema: z.ZodObject<{
+    template: z.ZodString;
+    tenantId: z.ZodString;
+    cpus: z.ZodOptional<z.ZodNumber>;
+    memoryMiB: z.ZodOptional<z.ZodNumber>;
+    rootDiskMiB: z.ZodOptional<z.ZodNumber>;
+    ttl: z.ZodOptional<z.ZodNumber>;
+    maxSessions: z.ZodOptional<z.ZodNumber>;
+    env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    egress: z.ZodOptional<z.ZodObject<{
+        allow: z.ZodArray<z.ZodObject<{
+            host: z.ZodString;
+            port: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$loose>;
+type CreateComputerRequest = z.infer<typeof createComputerRequestSchema>;
+/** 201 response body of `POST /v1/computers`. */
+declare const createComputerResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    template: z.ZodString;
+    state: z.ZodString;
+    ports: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        host: z.ZodNumber;
+        guest: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$loose>;
+type CreateComputerResponse = z.infer<typeof createComputerResponseSchema>;
+/**
+ * Status response of `GET /v1/computers/:id` (status + published ports and
+ * any egress/template metadata; extras preserved). The state is parsed
+ * READ-tOLERANTLY: unknown future states bucket under `"unknown"`.
+ */
+declare const computerStatusSchema: z.ZodObject<{
+    name: z.ZodString;
+    state: z.ZodPipe<z.ZodString, z.ZodTransform<"running" | "stopped" | "paused" | "crashed" | "starting" | "unknown" | "missing" | "suspended", string>>;
+    ports: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        host: z.ZodNumber;
+        guest: z.ZodNumber;
+    }, z.core.$strip>>>;
+    template: z.ZodOptional<z.ZodString>;
+    tenantId: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+type ComputerStatus = z.infer<typeof computerStatusSchema>;
+/** Request body of `POST /v1/computers/:id/exec` - synchronous argv exec. */
+declare const execRequestSchema: z.ZodObject<{
+    argv: z.ZodArray<z.ZodString>;
+    timeoutSec: z.ZodNumber;
+}, z.core.$loose>;
+type ExecRequest = z.infer<typeof execRequestSchema>;
+/** 200 response body of `POST /v1/computers/:id/exec`. Controllers may
+ *  redact registered secret values from the streams and cap their length. */
+declare const execResponseSchema: z.ZodObject<{
+    exitCode: z.ZodNumber;
+    stdout: z.ZodString;
+    stderr: z.ZodString;
+}, z.core.$loose>;
+type ExecResponse = z.infer<typeof execResponseSchema>;
+/** 200 response body of `POST /v1/computers/:id/suspend`. */
+declare const suspendResponseSchema: z.ZodObject<{
+    ok: z.ZodOptional<z.ZodBoolean>;
+    snapshot: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+type SuspendResponse = z.infer<typeof suspendResponseSchema>;
+/**
+ * Response of `POST /v1/computers/:id/resume`. MAY rename the computer:
+ * the controller can restore the suspend snapshot into a FRESH computer
+ * under a NEW generated id and answer `{ id: <new>, state: "running" }`.
+ * Callers must treat the old id as gone and adopt the returned id.
+ */
+declare const resumeResponseSchema: z.ZodObject<{
+    ok: z.ZodOptional<z.ZodBoolean>;
+    id: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+type ResumeResponse = z.infer<typeof resumeResponseSchema>;
+/**
+ * 200 response body of `POST /v1/computers/:id/attach` and `.../detach`:
+ * the controller-held session count after the call and the cap the computer
+ * was sized for. Neither route takes a body. Attach answers 409 when the
+ * computer already hosts `maxSessions` sessions; detach floors at 0.
+ * `DELETE /v1/computers/:id` answers 409 while sessions are attached unless
+ * the `force=true` query parameter is passed.
+ */
+declare const sessionsResponseSchema: z.ZodObject<{
+    sessions: z.ZodOptional<z.ZodNumber>;
+    maxSessions: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+type SessionsResponse = z.infer<typeof sessionsResponseSchema>;
+
+export { COMPUTER_API_VERSION, COMPUTER_STATES, COMPUTER_STATE_UNKNOWN, type ComputerState, type ComputerStatus, type CreateComputerRequest, type CreateComputerResponse, type EgressRule, type ErrorResponse, type ExecRequest, type ExecResponse, type PortPublish, type ResumeResponse, type SessionsResponse, type SuspendResponse, computerStateSchema, computerStatusSchema, createComputerRequestSchema, createComputerResponseSchema, egressRuleSchema, errorResponseSchema, execRequestSchema, execResponseSchema, portPublishSchema, resumeResponseSchema, sessionsResponseSchema, suspendResponseSchema };

package/dist/index.mjs

@@ -0,0 +1,94 @@
+import { z } from 'zod';
+
+/**
+ * @agentproto/computer-api v0.1.0
+ * 
+ * Versioned public contract for the computer controller HTTP API.
+ */
+
+// src/version.ts
+var COMPUTER_API_VERSION = "v1";
+var COMPUTER_STATES = [
+  "running",
+  "stopped",
+  "paused",
+  "crashed",
+  "starting",
+  "unknown",
+  "missing",
+  "suspended"
+];
+var computerStateSchema = z.string().transform((v) => {
+  return COMPUTER_STATES.includes(v) ? v : "unknown";
+});
+var COMPUTER_STATE_UNKNOWN = "unknown";
+var portPublishSchema = z.object({
+  host: z.number().int(),
+  guest: z.number().int()
+});
+var egressRuleSchema = z.object({
+  host: z.string(),
+  port: z.number().int()
+});
+var errorResponseSchema = z.object({
+  error: z.string(),
+  detail: z.unknown().optional()
+}).passthrough();
+var createComputerRequestSchema = z.object({
+  /** Registered template id (OPEN string; a controller rejects unknown ids). */
+  template: z.string(),
+  /** Tenant the computer is created under (scope marker, not a name). */
+  tenantId: z.string(),
+  cpus: z.number().int().optional(),
+  memoryMiB: z.number().int().optional(),
+  rootDiskMiB: z.number().int().optional(),
+  /** Computer TTL seconds. */
+  ttl: z.number().int().optional(),
+  /** Concurrent sessions the computer is sized for (controller default 1). */
+  maxSessions: z.number().int().optional(),
+  /** Environment variables injected into the computer. */
+  env: z.record(z.string(), z.string()).optional(),
+  /** Deny-by-default egress allowlist; a computer created without one has no DNS. */
+  egress: z.object({ allow: z.array(egressRuleSchema) }).optional()
+}).passthrough();
+var createComputerResponseSchema = z.object({
+  id: z.string(),
+  template: z.string(),
+  state: z.string(),
+  ports: z.array(portPublishSchema).optional()
+}).passthrough();
+var computerStatusSchema = z.object({
+  name: z.string(),
+  state: computerStateSchema,
+  ports: z.array(portPublishSchema).optional(),
+  template: z.string().optional(),
+  tenantId: z.string().optional()
+}).passthrough();
+var execRequestSchema = z.object({
+  argv: z.array(z.string()),
+  /** Per-exec timeout; controllers cap this (for example at 600 seconds). */
+  timeoutSec: z.number().int()
+}).passthrough();
+var execResponseSchema = z.object({
+  exitCode: z.number().int(),
+  stdout: z.string(),
+  stderr: z.string()
+}).passthrough();
+var suspendResponseSchema = z.object({
+  ok: z.boolean().optional(),
+  snapshot: z.string().optional(),
+  state: z.string().optional()
+}).passthrough();
+var resumeResponseSchema = z.object({
+  ok: z.boolean().optional(),
+  id: z.string().optional(),
+  state: z.string().optional()
+}).passthrough();
+var sessionsResponseSchema = z.object({
+  sessions: z.number().int().optional(),
+  maxSessions: z.number().int().optional()
+}).passthrough();
+
+export { COMPUTER_API_VERSION, COMPUTER_STATES, COMPUTER_STATE_UNKNOWN, computerStateSchema, computerStatusSchema, createComputerRequestSchema, createComputerResponseSchema, egressRuleSchema, errorResponseSchema, execRequestSchema, execResponseSchema, portPublishSchema, resumeResponseSchema, sessionsResponseSchema, suspendResponseSchema };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/version.ts","../src/computer-states.ts","../src/schemas.ts"],"names":["z"],"mappings":";;;;;;;;;AASO,IAAM,oBAAA,GAAuB;ACF7B,IAAM,eAAA,GAAkB;AAAA,EAC7B,SAAA;AAAA,EACA,SAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,UAAA;AAAA,EACA,SAAA;AAAA,EACA,SAAA;AAAA,EACA;AACF;AAWO,IAAM,sBAAsB,CAAA,CAAE,MAAA,EAAO,CAAE,SAAA,CAAU,CAAC,CAAA,KAAqB;AAC5E,EAAA,OAAQ,eAAA,CAAsC,QAAA,CAAS,CAAC,CAAA,GAAK,CAAA,GAAsB,SAAA;AACrF,CAAC;AAEM,IAAM,sBAAA,GAAwC;ACF9C,IAAM,iBAAA,GAAoBA,EAAE,MAAA,CAAO;AAAA,EACxC,IAAA,EAAMA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI;AAAA,EACrB,KAAA,EAAOA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA;AACpB,CAAC;AAIM,IAAM,gBAAA,GAAmBA,EAAE,MAAA,CAAO;AAAA,EACvC,IAAA,EAAMA,EAAE,MAAA,EAAO;AAAA,EACf,IAAA,EAAMA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA;AACnB,CAAC;AASM,IAAM,mBAAA,GAAsBA,EAAE,MAAA,CAAO;AAAA,EAC1C,KAAA,EAAOA,EAAE,MAAA,EAAO;AAAA,EAChB,MAAA,EAAQA,CAAAA,CAAE,OAAA,EAAQ,CAAE,QAAA;AACtB,CAAC,EAAE,WAAA;AAMI,IAAM,2BAAA,GAA8BA,EAAE,MAAA,CAAO;AAAA;AAAA,EAElD,QAAA,EAAUA,EAAE,MAAA,EAAO;AAAA;AAAA,EAEnB,QAAA,EAAUA,EAAE,MAAA,EAAO;AAAA,EACnB,MAAMA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA,EAAS;AAAA,EAChC,WAAWA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA,EAAS;AAAA,EACrC,aAAaA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA,EAAS;AAAA;AAAA,EAEvC,KAAKA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA,EAAS;AAAA;AAAA,EAE/B,aAAaA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA,EAAS;AAAA;AAAA,EAEvC,GAAA,EAAKA,CAAAA,CAAE,MAAA,CAAOA,CAAAA,CAAE,MAAA,IAAUA,CAAAA,CAAE,MAAA,EAAQ,CAAA,CAAE,QAAA,EAAS;AAAA;AAAA,EAE/C,MAAA,EAAQA,CAAAA,CAAE,MAAA,CAAO,EAAE,KAAA,EAAOA,CAAAA,CAAE,KAAA,CAAM,gBAAgB,CAAA,EAAG,CAAA,CAAE,QAAA;AACzD,CAAC,EAAE,WAAA;AAII,IAAM,4BAAA,GAA+BA,EAAE,MAAA,CAAO;AAAA,EACnD,EAAA,EAAIA,EAAE,MAAA,EAAO;AAAA,EACb,QAAA,EAAUA,EAAE,MAAA,EAAO;AAAA,EACnB,KAAA,EAAOA,EAAE,MAAA,EAAO;AAAA,EAChB,KAAA,EAAOA,CAAAA,CAAE,KAAA,CAAM,iBAAiB,EAAE,QAAA;AACpC,CAAC,EAAE,WAAA;AAUI,IAAM,oBAAA,GAAuBA,EAAE,MAAA,CAAO;AAAA,EAC3C,IAAA,EAAMA,EAAE,MAAA,EAAO;AAAA,EACf,KAAA,EAAO,mBAAA;AAAA,EACP,KAAA,EAAOA,CAAAA,CAAE,KAAA,CAAM,iBAAiB,EAAE,QAAA,EAAS;AAAA,EAC3C,QAAA,EAAUA,CAAAA,CAAE,MAAA,EAAO,CAAE,QAAA,EAAS;AAAA,EAC9B,QAAA,EAAUA,CAAAA,CAAE,MAAA,EAAO,CAAE,QAAA;AACvB,CAAC,EAAE,WAAA;AAMI,IAAM,iBAAA,GAAoBA,EAAE,MAAA,CAAO;AAAA,EACxC,IAAA,EAAMA,CAAAA,CAAE,KAAA,CAAMA,CAAAA,CAAE,QAAQ,CAAA;AAAA;AAAA,EAExB,UAAA,EAAYA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA;AACzB,CAAC,EAAE,WAAA;AAKI,IAAM,kBAAA,GAAqBA,EAAE,MAAA,CAAO;AAAA,EACzC,QAAA,EAAUA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI;AAAA,EACzB,MAAA,EAAQA,EAAE,MAAA,EAAO;AAAA,EACjB,MAAA,EAAQA,EAAE,MAAA;AACZ,CAAC,EAAE,WAAA;AAMI,IAAM,qBAAA,GAAwBA,EAAE,MAAA,CAAO;AAAA,EAC5C,EAAA,EAAIA,CAAAA,CAAE,OAAA,EAAQ,CAAE,QAAA,EAAS;AAAA,EACzB,QAAA,EAAUA,CAAAA,CAAE,MAAA,EAAO,CAAE,QAAA,EAAS;AAAA,EAC9B,KAAA,EAAOA,CAAAA,CAAE,MAAA,EAAO,CAAE,QAAA;AACpB,CAAC,EAAE,WAAA;AAWI,IAAM,oBAAA,GAAuBA,EAAE,MAAA,CAAO;AAAA,EAC3C,EAAA,EAAIA,CAAAA,CAAE,OAAA,EAAQ,CAAE,QAAA,EAAS;AAAA,EACzB,EAAA,EAAIA,CAAAA,CAAE,MAAA,EAAO,CAAE,QAAA,EAAS;AAAA,EACxB,KAAA,EAAOA,CAAAA,CAAE,MAAA,EAAO,CAAE,QAAA;AACpB,CAAC,EAAE,WAAA;AAaI,IAAM,sBAAA,GAAyBA,EAAE,MAAA,CAAO;AAAA,EAC7C,UAAUA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA,EAAS;AAAA,EACpC,aAAaA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA;AAChC,CAAC,EAAE,WAAA","file":"index.mjs","sourcesContent":["/**\n * Version of the computer controller HTTP contract described by this\n * package. The controller routes live under this version prefix (for\n * example `POST /v1/computers`), and every payload schema here corresponds\n * to that version.\n *\n * Semver of the PACKAGE tracks this contract: a MAJOR bump of\n * `@agentproto/computer-api` is where this constant changes.\n */\nexport const COMPUTER_API_VERSION = \"v1\"\n","/**\n * Driver-level computer states, as reported by `GET /v1/computers/:id`.\n *\n * The controller itself never reports `suspended`: a suspended computer\n * reads back as `stopped`. The state is kept here as a tolerated alias so\n * a newer controller can report it without breaking an older client.\n */\nexport const COMPUTER_STATES = [\n  \"running\",\n  \"stopped\",\n  \"paused\",\n  \"crashed\",\n  \"starting\",\n  \"unknown\",\n  \"missing\",\n  \"suspended\",\n] as const\n\nexport type ComputerState = (typeof COMPUTER_STATES)[number]\n\nimport { z } from \"zod\"\n\n/**\n * The state field is READ-tolerant: any unknown future state is bucketed\n * under `\"unknown\"` instead of rejecting, so a status read never throws on\n * controller evolution.\n */\nexport const computerStateSchema = z.string().transform((v): ComputerState => {\n  return (COMPUTER_STATES as readonly string[]).includes(v) ? (v as ComputerState) : \"unknown\"\n})\n\nexport const COMPUTER_STATE_UNKNOWN: ComputerState = \"unknown\"\n","/**\n * Zod schemas for the computer controller's HTTP contract constants -\n * the generic, deployment-independent shape of every endpoint:\n *\n *   POST   /v1/computers            create\n *   GET    /v1/computers/:id        status\n *   POST   /v1/computers/:id/exec   synchronous exec of an argv array\n *   POST   /v1/computers/:id/suspend  full snapshot + stop\n *   POST   /v1/computers/:id/resume   restore into a FRESH computer\n *   POST   /v1/computers/:id/attach   take a session slot\n *   POST   /v1/computers/:id/detach   release a session slot\n *   DELETE /v1/computers/:id        rm + snapshot cleanup (?force=true skips the session check)\n *\n * These are deliberately MINIMAL: only the fields a client actually\n * consumes are declared, and every schema allows (and preserves) extra\n * fields so a controller version adding fields never breaks an older\n * client. Template ids are an OPEN string - any registered id is valid.\n *\n * Nothing deployment-specific belongs here: no host names, no IPs, no\n * tenant names, no auth realm details. Auth headers are wired by the\n * client, not the contract.\n */\n\nimport { z } from \"zod\"\nimport { computerStateSchema } from \"./computer-states.js\"\n\n// ── transport pieces ──────────────────────────────────────────────────\n\n/** A published port: the host-side port mapped to the guest-side port. */\nexport const portPublishSchema = z.object({\n  host: z.number().int(),\n  guest: z.number().int(),\n})\nexport type PortPublish = z.infer<typeof portPublishSchema>\n\n/** Egress allowlist entry in the create body: destination host + port. */\nexport const egressRuleSchema = z.object({\n  host: z.string(),\n  port: z.number().int(),\n})\nexport type EgressRule = z.infer<typeof egressRuleSchema>\n\n/**\n * Controller error bodies are always `{ error: string }`, sometimes with a\n * `detail` array of validation issues. The `code` strings a controller may\n * emit (for example unknown template, capacity) are contract-OPEN: clients\n * inspect but never switch exhaustively on them.\n */\nexport const errorResponseSchema = z.object({\n  error: z.string(),\n  detail: z.unknown().optional(),\n}).passthrough()\nexport type ErrorResponse = z.infer<typeof errorResponseSchema>\n\n// ── POST /v1/computers ────────────────────────────────────────────────\n\n/** Request body for `POST /v1/computers`. */\nexport const createComputerRequestSchema = z.object({\n  /** Registered template id (OPEN string; a controller rejects unknown ids). */\n  template: z.string(),\n  /** Tenant the computer is created under (scope marker, not a name). */\n  tenantId: z.string(),\n  cpus: z.number().int().optional(),\n  memoryMiB: z.number().int().optional(),\n  rootDiskMiB: z.number().int().optional(),\n  /** Computer TTL seconds. */\n  ttl: z.number().int().optional(),\n  /** Concurrent sessions the computer is sized for (controller default 1). */\n  maxSessions: z.number().int().optional(),\n  /** Environment variables injected into the computer. */\n  env: z.record(z.string(), z.string()).optional(),\n  /** Deny-by-default egress allowlist; a computer created without one has no DNS. */\n  egress: z.object({ allow: z.array(egressRuleSchema) }).optional(),\n}).passthrough()\nexport type CreateComputerRequest = z.infer<typeof createComputerRequestSchema>\n\n/** 201 response body of `POST /v1/computers`. */\nexport const createComputerResponseSchema = z.object({\n  id: z.string(),\n  template: z.string(),\n  state: z.string(),\n  ports: z.array(portPublishSchema).optional(),\n}).passthrough()\nexport type CreateComputerResponse = z.infer<typeof createComputerResponseSchema>\n\n// ── GET /v1/computers/:id ─────────────────────────────────────────────\n\n/**\n * Status response of `GET /v1/computers/:id` (status + published ports and\n * any egress/template metadata; extras preserved). The state is parsed\n * READ-tOLERANTLY: unknown future states bucket under `\"unknown\"`.\n */\nexport const computerStatusSchema = z.object({\n  name: z.string(),\n  state: computerStateSchema,\n  ports: z.array(portPublishSchema).optional(),\n  template: z.string().optional(),\n  tenantId: z.string().optional(),\n}).passthrough()\nexport type ComputerStatus = z.infer<typeof computerStatusSchema>\n\n// ── POST /v1/computers/:id/exec ───────────────────────────────────────\n\n/** Request body of `POST /v1/computers/:id/exec` - synchronous argv exec. */\nexport const execRequestSchema = z.object({\n  argv: z.array(z.string()),\n  /** Per-exec timeout; controllers cap this (for example at 600 seconds). */\n  timeoutSec: z.number().int(),\n}).passthrough()\nexport type ExecRequest = z.infer<typeof execRequestSchema>\n\n/** 200 response body of `POST /v1/computers/:id/exec`. Controllers may\n *  redact registered secret values from the streams and cap their length. */\nexport const execResponseSchema = z.object({\n  exitCode: z.number().int(),\n  stdout: z.string(),\n  stderr: z.string(),\n}).passthrough()\nexport type ExecResponse = z.infer<typeof execResponseSchema>\n\n// ── POST /v1/computers/:id/suspend ────────────────────────────────────\n\n/** 200 response body of `POST /v1/computers/:id/suspend`. */\nexport const suspendResponseSchema = z.object({\n  ok: z.boolean().optional(),\n  snapshot: z.string().optional(),\n  state: z.string().optional(),\n}).passthrough()\nexport type SuspendResponse = z.infer<typeof suspendResponseSchema>\n\n// ── POST /v1/computers/:id/resume ─────────────────────────────────────\n\n/**\n * Response of `POST /v1/computers/:id/resume`. MAY rename the computer:\n * the controller can restore the suspend snapshot into a FRESH computer\n * under a NEW generated id and answer `{ id: <new>, state: \"running\" }`.\n * Callers must treat the old id as gone and adopt the returned id.\n */\nexport const resumeResponseSchema = z.object({\n  ok: z.boolean().optional(),\n  id: z.string().optional(),\n  state: z.string().optional(),\n}).passthrough()\nexport type ResumeResponse = z.infer<typeof resumeResponseSchema>\n\n// ── POST /v1/computers/:id/attach | detach ────────────────────────────\n\n/**\n * 200 response body of `POST /v1/computers/:id/attach` and `.../detach`:\n * the controller-held session count after the call and the cap the computer\n * was sized for. Neither route takes a body. Attach answers 409 when the\n * computer already hosts `maxSessions` sessions; detach floors at 0.\n * `DELETE /v1/computers/:id` answers 409 while sessions are attached unless\n * the `force=true` query parameter is passed.\n */\nexport const sessionsResponseSchema = z.object({\n  sessions: z.number().int().optional(),\n  maxSessions: z.number().int().optional(),\n}).passthrough()\nexport type SessionsResponse = z.infer<typeof sessionsResponseSchema>\n"]}

package/package.json

@@ -1,6 +1,62 @@
 {
   "name": "@agentproto/computer-api",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "@agentproto/computer-api — versioned public contract for the computer controller HTTP API: zod schemas and inferred types for create/get/exec/suspend/resume/rm of computers, published ports, status and the error envelope.",
+  "keywords": [
+    "agentproto",
+    "aip-36",
+    "sandbox",
+    "computer",
+    "microvm",
+    "contract",
+    "open-standard"
+  ],
+  "homepage": "https://agentproto.sh/docs/aip-36",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/agentproto/ts",
+    "directory": "packages/computer-api"
+  },
+  "bugs": {
+    "url": "https://github.com/agentproto/ts/issues"
+  },
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "zod": "^4.6.5"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.5",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.7",
+    "@agentproto/tooling": "0.1.0"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "clean": "rm -rf dist",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
 }