@origincloud/compute 0.0.0-stage → 0.3.0

package/dist/v1beta1/volume_attachment.js

@@ -0,0 +1,125 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/compute/v1beta1/volume_attachment.proto
+import { Operation, newRequestId, pathValue, query, } from "@origincloud/core";
+/**
+ * Calls VolumeAttachmentService.
+ *
+ * Volume attachments: which volumes of the persistent volume service an
+ * instance holds, and the device names its guest sees them under. Creating
+ * one attaches a volume, deleting it detaches the volume.
+ */
+export class VolumeAttachmentClient {
+    /**
+     * The endpoint the client sends its calls to, which also serves the
+     * operations its methods answer with.
+     */
+    service;
+    /** A client of VolumeAttachmentService that sends its calls through `client`. */
+    constructor(client) {
+        this.service = client.service("compute", true);
+    }
+    /** Returns a volume attachment. A detached attachment isn't found. */
+    async getVolumeAttachment(request, options) {
+        const p0 = pathValue("name", request.name, "projects/*/zones/*/instances/*/volumeAttachments/*");
+        return this.service.call({
+            method: "GET",
+            path: `/v1beta1/${p0}`,
+            query: query(request, ["name"]),
+            idempotent: true,
+        }, options);
+    }
+    /**
+     * Lists an instance's volume attachments, the boot volume's first, then
+     * by device name. With `-` for the instance, lists every instance's in the
+     * zone, which with `volume` finds the instance holding a volume.
+     * Detached attachments aren't listed.
+     */
+    async listVolumeAttachments(request, options) {
+        const p0 = pathValue("parent", request.parent, "projects/*/zones/*/instances/*");
+        return this.service.call({
+            method: "GET",
+            path: `/v1beta1/${p0}/volumeAttachments`,
+            query: query(request, ["parent"]),
+            idempotent: true,
+        }, options);
+    }
+    /**
+     * Iterates over everything listVolumeAttachments lists from the request's page on,
+     * fetching the next page as the loop reaches it. A page that fails ends
+     * the iteration with its error.
+     */
+    async *allVolumeAttachments(request, options) {
+        for (let page = request;;) {
+            const response = await this.listVolumeAttachments(page, options);
+            yield* response.volumeAttachments ?? [];
+            if (!response.nextPageToken)
+                return;
+            page = { ...page, pageToken: response.nextPageToken };
+        }
+    }
+    /**
+     * Attaches an `AVAILABLE` volume to a `RUNNING` or `STOPPED` instance in
+     * the same project and zone. On a stopped instance the disk appears at
+     * the next start, and the operation is done at once. On a running one it
+     * is added live, and the operation is done once the guest sees it, or
+     * failed if it couldn't be added, which leaves the volume available.
+     *
+     * It answers with an operation to wait on, whose result is the VolumeAttachment.
+     */
+    async createVolumeAttachment(request, options) {
+        if (!request.requestId)
+            request = { ...request, requestId: newRequestId() };
+        const p0 = pathValue("parent", request.parent, "projects/*/zones/*/instances/*");
+        const op = await this.service.call({
+            method: "POST",
+            path: `/v1beta1/${p0}/volumeAttachments`,
+            body: request.volumeAttachment,
+            query: query(request, ["parent", "volumeAttachment"]),
+            idempotent: true,
+        }, options);
+        return new Operation(this.service, op, "origincloud.compute.v1beta1.VolumeAttachment");
+    }
+    /**
+     * Detaches a volume, which then is `AVAILABLE` again. The boot volume
+     * can't be detached. On a running instance the device is removed live;
+     * if the guest doesn't release it, the operation fails and the volume
+     * stays attached. The operation is done once the volume is detached.
+     *
+     * It answers with an operation to wait on, which has no result.
+     */
+    async deleteVolumeAttachment(request, options) {
+        if (!request.requestId)
+            request = { ...request, requestId: newRequestId() };
+        const p0 = pathValue("name", request.name, "projects/*/zones/*/instances/*/volumeAttachments/*");
+        const op = await this.service.call({
+            method: "DELETE",
+            path: `/v1beta1/${p0}`,
+            query: query(request, ["name"]),
+            idempotent: true,
+        }, options);
+        return new Operation(this.service, op, "google.protobuf.Empty");
+    }
+}
+/** Where the attachment is. */
+export const VolumeAttachment_State = {
+    /** Not set. */
+    STATE_UNSPECIFIED: "STATE_UNSPECIFIED",
+    /** The volume is being created or claimed for the instance. */
+    CREATING: "CREATING",
+    /** Being added to the running guest. */
+    ATTACHING: "ATTACHING",
+    /** Attached. */
+    ATTACHED: "ATTACHED",
+    /** Being removed from the running guest. */
+    DETACHING: "DETACHING",
+    /** Being released, as the instance is terminated. */
+    RELEASING: "RELEASING",
+    /**
+     * The platform stopped trying to release the volume, which may still
+     * be held.
+     */
+    RELEASE_ABANDONED: "RELEASE_ABANDONED",
+    /** The volume couldn't be attached, and was released. */
+    FAILED: "FAILED",
+};
+//# sourceMappingURL=volume_attachment.js.map

package/dist/v1beta1/volume_attachment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"volume_attachment.js","sourceRoot":"","sources":["../../src/v1beta1/volume_attachment.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,8DAA8D;AAE9D,OAAO,EAKL,SAAS,EAET,YAAY,EACZ,SAAS,EACT,KAAK,GACN,MAAM,mBAAmB,CAAC;AAG3B;;;;;;GAMG;AACH,MAAM,OAAO,sBAAsB;IACjC;;;OAGG;IACM,OAAO,CAAU;IAE1B,iFAAiF;IACjF,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,mBAAmB,CAAC,OAAmC,EAAE,OAAqB;QAClF,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,oDAAoD,CAAC,CAAC;QACjG,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,EAAE,EAAE;YACtB,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;YAC/B,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CAAC,OAAqC,EAAE,OAAqB;QACtF,MAAM,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY,EAAE,oBAAoB;YACxC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;YACjC,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,CAAC,oBAAoB,CAAC,OAAqC,EAAE,OAAqB;QACtF,KAAK,IAAI,IAAI,GAAG,OAAO,IAAM,CAAC;YAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACjE,KAAK,CAAC,CAAC,QAAQ,CAAC,iBAAiB,IAAI,EAAE,CAAC;YACxC,IAAI,CAAC,QAAQ,CAAC,aAAa;gBAAE,OAAO;YACpC,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;QACxD,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,sBAAsB,CAAC,OAAsC,EAAE,OAAqB;QACxF,IAAI,CAAC,OAAO,CAAC,SAAS;YAAE,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,CAAC;QAC5E,MAAM,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;QACjF,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAChC;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,YAAY,EAAE,oBAAoB;YACxC,IAAI,EAAE,OAAO,CAAC,gBAAgB;YAC9B,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;YACrD,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;QACF,OAAO,IAAI,SAAS,CAAsC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,8CAA8C,CAAC,CAAC;IAC9H,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,sBAAsB,CAAC,OAAsC,EAAE,OAAqB;QACxF,IAAI,CAAC,OAAO,CAAC,SAAS;YAAE,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,CAAC;QAC5E,MAAM,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,oDAAoD,CAAC,CAAC;QACjG,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAChC;YACE,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,YAAY,EAAE,EAAE;YACtB,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;YAC/B,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;QACF,OAAO,IAAI,SAAS,CAA2B,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,uBAAuB,CAAC,CAAC;IAC5F,CAAC;CACF;AA2BD,+BAA+B;AAC/B,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,eAAe;IACf,iBAAiB,EAAE,mBAAmB;IACtC,+DAA+D;IAC/D,QAAQ,EAAE,UAAU;IACpB,wCAAwC;IACxC,SAAS,EAAE,WAAW;IACtB,gBAAgB;IAChB,QAAQ,EAAE,UAAU;IACpB,4CAA4C;IAC5C,SAAS,EAAE,WAAW;IACtB,qDAAqD;IACrD,SAAS,EAAE,WAAW;IACtB;;;OAGG;IACH,iBAAiB,EAAE,mBAAmB;IACtC,yDAAyD;IACzD,MAAM,EAAE,QAAQ;CACR,CAAC"}

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@origincloud/compute",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.3.0",
+  "description": "Origin Cloud's compute service: instances, images, key pairs, volume attachments and the instance catalog.",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/origincloudhq/sdk-typescript#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/origincloudhq/sdk-typescript.git",
+    "directory": "packages/compute"
+  },
+  "bugs": "https://github.com/origincloudhq/sdk-typescript/issues",
+  "keywords": [
+    "origincloud",
+    "origin-cloud",
+    "sdk",
+    "compute"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": {
+    "./*": {
+      "types": "./dist/*/index.d.ts",
+      "default": "./dist/*/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "!dist/**/*.tsbuildinfo"
+  ],
+  "peerDependencies": {
+    "@origincloud/core": "^0.3.0"
+  },
+  "devDependencies": {
+    "@origincloud/core": "^0.3.0"
+  }
+}

package/src/longrunning/v1beta1/index.ts

@@ -0,0 +1,3 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+
+export * from "./operations.js";

package/src/longrunning/v1beta1/operations.ts

@@ -0,0 +1,103 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/longrunning/v1beta1/operations.proto
+
+import {
+  type CallOptions,
+  type Client,
+  type LongrunningOperation,
+  type Service,
+  pathValue,
+  query,
+} from "@origincloud/core";
+
+/**
+ * Calls OperationService.
+ *
+ * The long-running operations of a service: what its creates, updates and
+ * deletes answer with, until their resource settles. Every service serves
+ * this at its own host, for the operations its own methods return.
+ *
+ * An operation is done when its resource reaches the state its method
+ * promises, or failed when it can't get there; that outcome never changes
+ * afterwards, whatever later happens to the resource. It can be read for a
+ * day after it is done.
+ */
+export class OperationClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /**
+   * A client of OperationService at the compute host, which serves the
+   * operations the compute methods answer with.
+   */
+  constructor(client: Client) {
+    this.service = client.service("compute", true);
+  }
+
+  /** Returns an operation as it is now. */
+  async getOperation(request: GetOperationRequest, options?: CallOptions): Promise<LongrunningOperation> {
+    const p0 = pathValue("name", request.name, "projects/*/zones/*/operations/*");
+    return this.service.call<LongrunningOperation>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Waits until an operation is done or `timeout` has passed, whichever
+   * comes first, and returns it as it is then. It only reads, so a client
+   * may repeat it after a transport error.
+   */
+  async waitOperation(request: WaitOperationRequest, options?: CallOptions): Promise<LongrunningOperation> {
+    const p0 = pathValue("name", request.name, "projects/*/zones/*/operations/*");
+    return this.service.call<LongrunningOperation>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}:wait`,
+        body: request,
+        idempotent: true,
+      },
+      options,
+    );
+  }
+}
+
+/** The request for GetOperation. */
+export interface GetOperationRequest {
+  /**
+   * The operation to return, `projects/{project}/zones/{zone}/operations/{operation}`,
+   * exactly as a method returned it.
+   */
+  name?: string;
+}
+
+/** The request for WaitOperation. */
+export interface WaitOperationRequest {
+  /** The operation to wait for, exactly as a method returned it. */
+  name?: string;
+  /** The longest to wait, at most a minute; a minute when not set. */
+  timeout?: string;
+}
+
+/** What an operation is about. */
+export interface OperationMetadata {
+  /** The resource the operation acts on. */
+  target?: string;
+  /**
+   * What it does, as the method that started it names it: for example
+   * `create`, `update` or `delete`.
+   */
+  verb?: string;
+  /** When it was accepted. */
+  createTime?: string;
+  /** When it finished; empty while it hasn't. */
+  endTime?: string;
+}

package/src/v1beta1/catalog.ts

@@ -0,0 +1,208 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/compute/v1beta1/catalog.proto
+
+import { type CallOptions, type Client, type Service, pathValue, query } from "@origincloud/core";
+
+/**
+ * Calls InstanceTypeService.
+ *
+ * The catalog of instance types: every size the platform publishes, each
+ * saying whether an instance can be launched as it right now. Not scoped to
+ * an organisation or a project; no permission is needed.
+ */
+export class InstanceTypeClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of InstanceTypeService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("compute", true);
+  }
+
+  /** Returns an instance type. */
+  async getInstanceType(request: GetInstanceTypeRequest, options?: CallOptions): Promise<InstanceType> {
+    const p0 = pathValue("name", request.name, "instanceTypes/*");
+    return this.service.call<InstanceType>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Lists every instance type, including those no longer offered, which
+   * instances launched as them still report: check `available` before
+   * launching as one.
+   */
+  async listInstanceTypes(request: ListInstanceTypesRequest, options?: CallOptions): Promise<ListInstanceTypesResponse> {
+    return this.service.call<ListInstanceTypesResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/instanceTypes`,
+        query: query(request, []),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+}
+
+/**
+ * Calls ImageFamilyService.
+ *
+ * The catalog of image families: stable names that each launch whichever
+ * public image is current for them, so a launch gets the latest build
+ * without naming an image. Not scoped to an organisation or a project; no
+ * permission is needed.
+ */
+export class ImageFamilyClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of ImageFamilyService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("compute", true);
+  }
+
+  /** Returns an image family. */
+  async getImageFamily(request: GetImageFamilyRequest, options?: CallOptions): Promise<ImageFamily> {
+    const p0 = pathValue("name", request.name, "imageFamilies/*");
+    return this.service.call<ImageFamily>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Lists every image family, including those no longer offered: check
+   * `available` before launching from one.
+   */
+  async listImageFamilies(request: ListImageFamiliesRequest, options?: CallOptions): Promise<ListImageFamiliesResponse> {
+    return this.service.call<ListImageFamiliesResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/imageFamilies`,
+        query: query(request, []),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+}
+
+/** A size an instance is launched as. */
+export interface InstanceType {
+  /** The type's resource name, `instanceTypes/gp1.core.2`. */
+  name?: string;
+  /** The name the console shows. */
+  displayName?: string;
+  /** The hardware kind, such as `gp1`. */
+  kind?: string;
+  /** How its vCPUs are allocated, such as `core`: dedicated and guaranteed. */
+  cpuAllocationMode?: string;
+  /** The vCPUs an instance of the type has. */
+  vcpu?: number;
+  /** The memory an instance of the type has, in MiB. */
+  memoryMib?: number;
+  /**
+   * The most an instance of the type reads and writes across all its
+   * volumes together, in megabits per second; 0 when it isn't limited.
+   */
+  storageBandwidthMbit?: number;
+  /**
+   * The rate an instance of the type can burst to above
+   * `storageBandwidthMbit`, in megabits per second, for 60 seconds of
+   * traffic at that rate, which staying under the limit refills; 0 when it
+   * can't burst.
+   */
+  storageBurstBandwidthMbit?: number;
+  /**
+   * Whether an instance can be launched as, or changed to, the type now. A
+   * type listed but not available is no longer offered; instances already
+   * of the type keep running.
+   */
+  available?: boolean;
+}
+
+/**
+ * A stable name for the current public image of an operating system
+ * release.
+ */
+export interface ImageFamily {
+  /**
+   * The family's resource name, `imageFamilies/ubuntu-24-04-minimal`.
+   * Never renamed, and never reused for another release.
+   */
+  name?: string;
+  /** The name the console shows. */
+  displayName?: string;
+  /** What the family's images hold. */
+  description?: string;
+  /** Who publishes the release, such as `Canonical`. */
+  vendor?: string;
+  /** The operating system, such as `ubuntu`. */
+  os?: string;
+  /** The release, such as `24.04`. */
+  osVersion?: string;
+  /**
+   * When the vendor stops supporting the release; empty when no date is
+   * known. Advisory: launches aren't refused after it.
+   */
+  supportEndTime?: string;
+  /**
+   * Whether an instance can be launched from the family now. Instances
+   * launched from a family no longer offered are unaffected.
+   */
+  available?: boolean;
+}
+
+/** The request for GetInstanceType. */
+export interface GetInstanceTypeRequest {
+  /** The type to return, `instanceTypes/{instance_type}`. */
+  name?: string;
+}
+
+/**
+ * The request for ListInstanceTypes. The catalog is small and bounded by
+ * the platform, so it comes in one page.
+ */
+export interface ListInstanceTypesRequest {}
+
+/** The response for ListInstanceTypes. */
+export interface ListInstanceTypesResponse {
+  /** Every instance type, by kind, then by size. */
+  instanceTypes?: InstanceType[];
+}
+
+/** The request for GetImageFamily. */
+export interface GetImageFamilyRequest {
+  /** The family to return, `imageFamilies/{image_family}`. */
+  name?: string;
+}
+
+/**
+ * The request for ListImageFamilies. The catalog is small and bounded by
+ * the platform, so it comes in one page.
+ */
+export interface ListImageFamiliesRequest {}
+
+/** The response for ListImageFamilies. */
+export interface ListImageFamiliesResponse {
+  /** Every image family, by name. */
+  imageFamilies?: ImageFamily[];
+}