@runblackcat/sdk 0.1.0-alpha.78 → 0.1.0-alpha.83

package/LICENSE

@@ -1,202 +1,35 @@
-
-                                 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.
+Blackcat is dual-licensed by component.
+
+SSPL-1.0 (Server Side Public License, version 1) — see LICENSE-SSPL
+  The server: everything that runs a fleet.
+    crates/blackcat-gateway
+    crates/blackcat-placer
+    crates/blackcat-agent
+    crates/blackcat-guest
+    crates/blackcat-local
+    crates/blackcat-aws
+    crates/blackcat-s3
+    crates/blackcat-plugin-supervisor
+    crates/blackcat-plugin-egress
+    crates/blackcat-github-actions
+    crates/blackcat-template-refresh
+
+Apache-2.0 — see LICENSE-APACHE
+  The clients and shared libraries, and everything not listed above.
+    crates/blackcat-cli (source)
+    crates/blackcat-core
+    crates/blackcat-mcp
+    crates/blackcat-plugin
+    crates/blackcat-plugin-sdk
+    sdk/ (the TypeScript SDK, @runblackcat/sdk)
+    the conformance suite, scripts, docs and examples
+
+Each crate's Cargo.toml states its license (SPDX: SSPL-1.0 or Apache-2.0).
+
+Binaries: the `blackcat` CLI binary also embeds SSPL server crates (the local
+fleet, node CA and maintenance executor link blackcat-gateway, blackcat-placer,
+blackcat-guest, blackcat-local and blackcat-s3), so the distributed CLI binary
+as a whole is subject to SSPL-1.0. The TypeScript SDK is Apache-2.0 throughout.
+
+Releases up to and including v0.1.0-alpha.81 were published under Apache-2.0
+and remain available under it.

package/README.md

@@ -393,4 +393,7 @@ security and provider-boundary rules that do *not* relax.
 
 ## License
 
-Apache-2.0. See [LICENSE](LICENSE).
+The server (gateway, placer, agent and the other fleet crates) is [SSPL-1.0](LICENSE-SSPL); the CLI
+source, the TypeScript SDK and the shared client libraries are [Apache-2.0](LICENSE-APACHE). The distributed
+`blackcat` CLI binary embeds server crates and is therefore subject to SSPL-1.0. See [LICENSE](LICENSE) for
+the per-crate split. Releases up to v0.1.0-alpha.81 remain available under Apache-2.0.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runblackcat/sdk",
-  "version": "0.1.0-alpha.78",
+  "version": "0.1.0-alpha.83",
   "description": "TypeScript SDK for the Blackcat sandbox gateway",
   "license": "Apache-2.0",
   "repository": "https://github.com/TreebeardHQ/blackcat",

package/sdk/dist/index.d.ts

@@ -328,6 +328,10 @@ export interface SandboxBatch {
     counts: Partial<Record<SandboxBatchMemberState, number>>;
     members: SandboxBatchMember[];
 }
+export type SandboxBatchResponse = SandboxBatch | {
+    request_id: string;
+    state: "prevented";
+};
 export interface SandboxLeaseInput {
     /** Initial lease duration, between 60 seconds and 24 hours. */
     ttl_secs: number;
@@ -351,6 +355,22 @@ export type CreateCapacityReservationInput = ({
     memory_mib: number;
     /** How long to hold the reservation, between 1 second and 4 hours. */
     ttl_secs: number;
+    /** Defaults to `consumable`; `reusable` returns each slot after confirmed destruction. */
+    mode?: "consumable" | "reusable";
+    /** When the capacity must be ready: seconds from now, or an RFC 3339 time
+     * within `ttl_secs`. Absent: as soon as it can be, at the lowest cost. */
+    needed_by?: number | string;
+    /** `shared` (default): any eligible node, free headroom first. `dedicated`:
+     * only hosts dedicated reservations hold, launched for them. A held host
+     * serves only dedicated reservations (of any tenant: they pack), never
+     * ordinary work; a sandbox create naming it waits for one of its slots. */
+    placement?: "shared" | "dedicated";
+    /** With `placement: "dedicated"`, the provider shape to launch: an exact
+     * shape or a family (`c7i`) of the fleet's capacity shapes. Absent: the
+     * planner chooses. */
+    shape?: string;
+    /** Stable retry key, at most 107 ASCII letters, digits, `_` or `-`. */
+    idempotency_key?: string;
 };
 export interface CapacityReservation {
     id: string;
@@ -361,15 +381,23 @@ export interface CapacityReservation {
     /** The template resource this reservation follows, or null when pinned. */
     template_resource: string | null;
     count: number;
+    mode: "consumable" | "reusable";
+    placement: "shared" | "dedicated";
+    /** The shape a dedicated reservation launches, or null. */
+    shape: string | null;
     vcpus: number;
     memory_mib: number;
     /** Slots consumed by an actual sandbox create. */
     claimed: number;
+    /** Current slot occupancy for reusable reservations; zero otherwise. */
+    occupied: number;
     /** Slots bound to a specific node and not yet claimed. */
     bound: number;
     /** Bound slots whose node already has the template warm. */
     warm: number;
     expires_at: SystemTimeValue;
+    /** When the capacity must be ready (epoch milliseconds), or null. */
+    needed_by: number | null;
 }
 /**
  * Response returned by POST /v1/sandboxes (the gateway has no template field).
@@ -379,6 +407,9 @@ export interface CapacityReservation {
  * retryable under a new request id rather than a protocol fault.
  */
 export type CreateSandboxResponse = {
+    request_id: string;
+    state: "prevented";
+} | ({
     request_id: string;
     id: string;
     tier: "boot" | "warm_pool" | "restore";
@@ -402,7 +433,11 @@ export type CreateSandboxResponse = {
     state: "failed";
     node: null;
     error: string;
-});
+} | {
+    state: "destroyed";
+    node: string | null;
+    error: string;
+}));
 /**
  * Restore phase breakdown a node reported for a checkpoint launch (Proposal
  * F, docs/restore-performance.md). `phase_ms` mirrors the node's own
@@ -731,7 +766,7 @@ declare const MAX_PROCESS_STDIN: number;
 declare const MAX_EXEC_STDIN: number;
 export declare function epochMillis(value: unknown, field: string): number;
 export declare function parseCreateSandboxResponse(value: unknown, requestId: string): CreateSandboxResponse;
-export declare function parseSandboxBatch(value: unknown, requestId: string): SandboxBatch;
+export declare function parseSandboxBatch(value: unknown, requestId: string): SandboxBatchResponse;
 export declare function assertSecureBlackcatGatewayUrl(baseUrl: string): void;
 declare class GatewayClient {
     readonly baseUrl: string;
@@ -811,6 +846,10 @@ declare class ReservationsResource {
     /** Release early. Unclaimed slots free immediately; bound nodes then fall
      * back to the normal empty-worker scale-in grace period. */
     release(id: string): Promise<CapacityReservation>;
+    renew(id: string, input: {
+        ttl_secs: number;
+        idempotency_key: string;
+    }): Promise<CapacityReservation>;
 }
 declare class SandboxesResource {
     private readonly client;
@@ -829,10 +868,15 @@ declare class SandboxesResource {
      * Repeat the exact request to recover a lost response: member IDs are
      * stable. Poll `batch` for counts by state, or a member with `acquisition`.
      */
-    createBatch(input: CreateSandboxBatchInput): Promise<SandboxBatch>;
+    createBatch(input: CreateSandboxBatchInput): Promise<SandboxBatchResponse>;
     /** Counts by state and every member of a batch created with `createBatch`. */
-    batch(requestId: string): Promise<SandboxBatch>;
+    batch(requestId: string): Promise<SandboxBatchResponse>;
     acquisition(requestId: string): Promise<CreateSandboxResponse>;
+    /**
+     * Fence an acquisition request ID before its create is recorded, or destroy
+     * the allocation when the create has already won.
+     */
+    cancelAcquisition(requestId: string): Promise<CreateSandboxResponse>;
     get(id: string): Promise<Sandbox>;
     /** Extend the soft expiry without moving the immutable hard deadline. */
     renew(id: string, ttl_secs: number): Promise<RenewSandboxResponse>;

package/sdk/dist/index.js

@@ -91,7 +91,10 @@ function parseCreateSandboxResponse(value, requestId) {
     throw new BlackcatProtocolError("sandbox create receipt is malformed or belongs to another request");
   }
   const row = value;
-  if (row.request_id !== requestId || typeof row.id !== "string" || row.id.length === 0 || !["boot", "warm_pool", "restore"].includes(String(row.tier)) || !["placed", "pending", "failed"].includes(String(row.state)) || row.state === "placed" && typeof row.node !== "string" || row.state === "pending" && row.node !== null && typeof row.node !== "string" || row.state === "failed" && (row.node !== null || typeof row.error !== "string") || !isSystemTime(row.expires_at) || !isSystemTime(row.renewable_until)) {
+  if (row.request_id === requestId && row.state === "prevented") {
+    return value;
+  }
+  if (row.request_id !== requestId || typeof row.id !== "string" || row.id.length === 0 || !["boot", "warm_pool", "restore"].includes(String(row.tier)) || !["placed", "pending", "failed", "destroyed"].includes(String(row.state)) || row.state === "placed" && typeof row.node !== "string" || row.state === "pending" && row.node !== null && typeof row.node !== "string" || row.state === "failed" && (row.node !== null || typeof row.error !== "string") || row.state === "destroyed" && (row.node !== null && typeof row.node !== "string" || typeof row.error !== "string") || !isSystemTime(row.expires_at) || !isSystemTime(row.renewable_until)) {
     throw new BlackcatProtocolError("sandbox create receipt is malformed or belongs to another request");
   }
   return value;
@@ -102,6 +105,9 @@ function parseSandboxBatch(value, requestId) {
   if (typeof value !== "object" || value === null || Array.isArray(value))
     throw malformed();
   const row = value;
+  if (row.request_id === requestId && row.state === "prevented") {
+    return value;
+  }
   if (row.request_id !== requestId || typeof row.count !== "number" || typeof row.counts !== "object" || row.counts === null || !Array.isArray(row.members) || row.members.length !== row.count || !row.members.every((member) => {
     const m = member;
     return typeof m === "object" && m !== null && typeof m.request_id === "string" && typeof m.id === "string" && BATCH_STATES.includes(String(m.state));
@@ -436,6 +442,9 @@ class ReservationsResource {
   release(id) {
     return this.client.json("DELETE", `/v1/capacity-reservations/${pathSegment(id)}`, undefined, "token");
   }
+  renew(id, input) {
+    return this.client.json("POST", `/v1/capacity-reservations/${pathSegment(id)}/renew`, input, "token");
+  }
 }
 
 class SandboxesResource {
@@ -458,6 +467,9 @@ class SandboxesResource {
   async acquisition(requestId) {
     return parseCreateSandboxResponse(await this.client.json("GET", `/v1/sandboxes/acquisitions/${pathSegment(requestId)}`, undefined, "token"), requestId);
   }
+  async cancelAcquisition(requestId) {
+    return parseCreateSandboxResponse(await this.client.json("DELETE", `/v1/sandboxes/acquisitions/${pathSegment(requestId)}`, undefined, "token"), requestId);
+  }
   get(id) {
     return this.client.json("GET", `/v1/sandboxes/${pathSegment(id)}`, undefined, "token");
   }
@@ -706,17 +718,17 @@ class BlackcatClient extends GatewayClient {
   }
 }
 export {
-  parseSandboxBatch,
-  parseCreateSandboxResponse,
-  epochMillis,
-  assertSecureBlackcatGatewayUrl,
-  MAX_PROCESS_STDIN,
-  MAX_FILE_CHUNK as MAX_FILE_WRITE_CHUNK,
-  MAX_FILE_READ_CHUNK,
-  MAX_FILE_CHUNK,
-  MAX_EXEC_STDIN,
-  CAPABILITY_OPS,
-  BlackcatClient,
+  BLACKCAT_ERROR_CODES,
   BlackcatApiError,
-  BLACKCAT_ERROR_CODES
+  BlackcatClient,
+  CAPABILITY_OPS,
+  MAX_EXEC_STDIN,
+  MAX_FILE_CHUNK,
+  MAX_FILE_READ_CHUNK,
+  MAX_FILE_CHUNK as MAX_FILE_WRITE_CHUNK,
+  MAX_PROCESS_STDIN,
+  assertSecureBlackcatGatewayUrl,
+  epochMillis,
+  parseCreateSandboxResponse,
+  parseSandboxBatch
 };