@prisma/compute-sdk 0.1.0 → 0.3.0

package/src/compute-client.ts

@@ -1,5 +1,6 @@
 import type { ManagementApiClient } from "@prisma/management-api-sdk";
 import { type InferOk, Result } from "better-result";
+import invariant from "tiny-invariant";
 import {
   InternalApiClient,
   readUploadUrl,
@@ -15,18 +16,26 @@ import type {
   DestroyVersionProgress,
   UpdateEnvProgress,
 } from "./callbacks.ts";
-import type { ComputeError } from "./errors.ts";
 import {
   ApiError,
+  type ApiRequestError,
   ArtifactError,
+  type AuthenticationError,
   BuildError,
   CancelledError,
+  type DeployError,
   DestroyAggregateError,
+  type DestroyServiceError,
+  type DestroyVersionError,
   MissingArgumentError,
   NoExistingVersionError,
+  NoVersionsFoundError,
+  type UpdateEnvError,
+  type VersionOperationError,
 } from "./errors.ts";
 import { pollVersionStatus } from "./polling.ts";
 import type {
+  CreateProjectResult,
   PortMapping,
   ProjectInfo,
   ResolvedConfig,
@@ -110,6 +119,13 @@ export interface DeleteServiceOptions {
   signal?: AbortSignal;
 }
 
+export interface CreateProjectOptions {
+  name: string;
+  createDatabase?: boolean;
+  region?: string;
+  signal?: AbortSignal;
+}
+
 export interface ListProjectsOptions {
   signal?: AbortSignal;
 }
@@ -182,7 +198,7 @@ export class ComputeClient {
 
   async deploy(
     options: DeployOptions,
-  ): Promise<Result<DeployResult, ComputeError>> {
+  ): Promise<Result<DeployResult, DeployError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -246,7 +262,9 @@ export class ComputeClient {
         yield* self.#checkAborted(options.signal);
 
         options.progress?.onUploadStart?.();
-        yield* Result.await(self.#uploadArtifact(uploadUrl, archiveBytes));
+        yield* Result.await(
+          self.#uploadArtifact(uploadUrl, archiveBytes, options.signal),
+        );
         options.progress?.onUploadComplete?.();
 
         yield* self.#checkAborted(options.signal);
@@ -292,7 +310,7 @@ export class ComputeClient {
 
   async updateEnv(
     options: UpdateEnvOptions,
-  ): Promise<Result<UpdateEnvResult, ComputeError>> {
+  ): Promise<Result<UpdateEnvResult, UpdateEnvError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -361,7 +379,7 @@ export class ComputeClient {
 
   async destroyVersion(
     options: DestroyVersionOptions,
-  ): Promise<Result<DestroyVersionResult, ComputeError>> {
+  ): Promise<Result<DestroyVersionResult, DestroyVersionError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -402,7 +420,7 @@ export class ComputeClient {
           .sort(versionSortComparator);
 
         if (versionInfos.length === 0) {
-          return Result.err(new MissingArgumentError({ field: "versionId" }));
+          return Result.err(new NoVersionsFoundError({ serviceId }));
         }
 
         if (!options.interaction?.selectVersion) {
@@ -451,7 +469,7 @@ export class ComputeClient {
 
   async destroyService(
     options: DestroyServiceOptions,
-  ): Promise<Result<DestroyServiceResult, ComputeError>> {
+  ): Promise<Result<DestroyServiceResult, DestroyServiceError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -477,7 +495,10 @@ export class ComputeClient {
       );
 
       const succeededIds: string[] = [];
-      const failures: Array<{ versionId: string; error: ComputeError }> = [];
+      const failures: Array<{
+        versionId: string;
+        error: VersionOperationError;
+      }> = [];
 
       if (activeVersions.length > 0) {
         const activeIds = activeVersions.map((v) => v.id);
@@ -594,9 +615,48 @@ export class ComputeClient {
     });
   }
 
+  async createProject(
+    options: CreateProjectOptions,
+  ): Promise<Result<CreateProjectResult, ApiRequestError>> {
+    const self = this;
+    return Result.gen(async function* () {
+      yield* self.#checkAborted(options.signal);
+      const createDatabase = options.createDatabase ?? false;
+      const response = yield* Result.await(
+        self.#api.createProject(
+          {
+            name: options.name,
+            createDatabase,
+            region: options.region,
+          },
+          options.signal,
+        ),
+      );
+
+      const result: CreateProjectResult = {
+        id: response.id,
+        name: response.name,
+        defaultRegion: response.defaultRegion ?? undefined,
+      };
+
+      if (response.database) {
+        const connection = response.database.connections?.[0];
+        result.database = {
+          id: response.database.id,
+          name: response.database.name,
+          region: response.database.region.id,
+          connectionString:
+            connection?.endpoints?.direct?.connectionString ?? undefined,
+        };
+      }
+
+      return Result.ok(result);
+    });
+  }
+
   async listProjects(
     options: ListProjectsOptions = {},
-  ): Promise<Result<ProjectInfo[], ComputeError>> {
+  ): Promise<Result<ProjectInfo[], ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -617,7 +677,7 @@ export class ComputeClient {
 
   async listServices(
     options: ListServicesOptions,
-  ): Promise<Result<ServiceInfo[], ComputeError>> {
+  ): Promise<Result<ServiceInfo[], ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -639,7 +699,7 @@ export class ComputeClient {
 
   async createService(
     options: CreateServiceOptions,
-  ): Promise<Result<ServiceInfo, ComputeError>> {
+  ): Promise<Result<ServiceInfo, ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -664,7 +724,7 @@ export class ComputeClient {
 
   async showService(
     options: ShowServiceOptions,
-  ): Promise<Result<ServiceDetail, ComputeError>> {
+  ): Promise<Result<ServiceDetail, ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -683,7 +743,7 @@ export class ComputeClient {
 
   async deleteService(
     options: DeleteServiceOptions,
-  ): Promise<Result<void, ComputeError>> {
+  ): Promise<Result<void, ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -696,7 +756,7 @@ export class ComputeClient {
 
   async listVersions(
     options: ListVersionsOptions,
-  ): Promise<Result<VersionInfo[], ComputeError>> {
+  ): Promise<Result<VersionInfo[], ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -732,7 +792,7 @@ export class ComputeClient {
 
   async showVersion(
     options: ShowVersionOptions,
-  ): Promise<Result<VersionDetail, ComputeError>> {
+  ): Promise<Result<VersionDetail, ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -751,7 +811,7 @@ export class ComputeClient {
 
   async startVersion(
     options: StartVersionOptions,
-  ): Promise<Result<void, ComputeError>> {
+  ): Promise<Result<void, ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -764,7 +824,7 @@ export class ComputeClient {
 
   async stopVersion(
     options: StopVersionOptions,
-  ): Promise<Result<void, ComputeError>> {
+  ): Promise<Result<void, ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -777,7 +837,7 @@ export class ComputeClient {
 
   async deleteVersion(
     options: DeleteVersionOptions,
-  ): Promise<Result<void, ComputeError>> {
+  ): Promise<Result<void, ApiRequestError>> {
     const self = this;
     return Result.gen(async function* () {
       yield* self.#checkAborted(options.signal);
@@ -810,7 +870,7 @@ export class ComputeClient {
         serviceName: string;
         region: string;
       },
-      CancelledError | MissingArgumentError | ComputeError
+      MissingArgumentError | CancelledError | AuthenticationError | ApiError
     >
   > {
     const self = this;
@@ -891,9 +951,7 @@ export class ComputeClient {
 
       if (selectedServiceId !== null) {
         const service = services.find((s) => s.id === selectedServiceId);
-        if (!service) {
-          throw new Error("selectService returned service ID not in the list");
-        }
+        invariant(service, "selectService returned service ID not in the list");
         return Result.ok({
           projectId,
           serviceId: selectedServiceId,
@@ -941,13 +999,15 @@ export class ComputeClient {
   async #uploadArtifact(
     url: string,
     body: Uint8Array,
-  ): Promise<Result<void, ArtifactError>> {
+    signal?: AbortSignal,
+  ): Promise<Result<void, ArtifactError | CancelledError>> {
     return Result.tryPromise({
       try: async () => {
         const res = await fetch(url, {
           method: "PUT",
           headers: { "content-type": "application/gzip" },
           body,
+          signal,
         });
 
         if (!res.ok) {
@@ -964,10 +1024,12 @@ export class ComputeClient {
         }
       },
       catch: (e) =>
-        new ArtifactError({
-          message: e instanceof Error ? e.message : String(e),
-          cause: e,
-        }),
+        signal?.aborted
+          ? new CancelledError()
+          : new ArtifactError({
+              message: e instanceof Error ? e.message : String(e),
+              cause: e,
+            }),
     });
   }
 }

package/src/errors.ts

@@ -80,6 +80,18 @@ export class NoExistingVersionError extends TaggedError(
   }
 }
 
+export class NoVersionsFoundError extends TaggedError("NoVersionsFoundError")<{
+  serviceId: string;
+  message: string;
+}>() {
+  constructor(args: { serviceId: string }) {
+    super({
+      serviceId: args.serviceId,
+      message: `Service ${args.serviceId} has no versions to destroy`,
+    });
+  }
+}
+
 export class CancelledError extends TaggedError("CancelledError")<{
   message: string;
 }>() {
@@ -93,12 +105,12 @@ export class DestroyAggregateError extends TaggedError(
 )<{
   message: string;
   succeededVersionIds: string[];
-  failures: Array<{ versionId: string; error: ComputeError }>;
+  failures: Array<{ versionId: string; error: VersionOperationError }>;
   serviceDeleted: boolean;
 }>() {
   constructor(args: {
     succeededVersionIds: string[];
-    failures: Array<{ versionId: string; error: ComputeError }>;
+    failures: Array<{ versionId: string; error: VersionOperationError }>;
     serviceDeleted: boolean;
   }) {
     const failedIds = args.failures.map((f) => f.versionId).join(", ");
@@ -109,18 +121,6 @@ export class DestroyAggregateError extends TaggedError(
   }
 }
 
-export type ComputeError =
-  | AuthenticationError
-  | ApiError
-  | MissingArgumentError
-  | BuildError
-  | ArtifactError
-  | TimeoutError
-  | VersionFailedError
-  | NoExistingVersionError
-  | CancelledError
-  | DestroyAggregateError;
-
 export type DeployError =
   | AuthenticationError
   | ApiError
@@ -140,9 +140,26 @@ export type UpdateEnvError =
   | VersionFailedError
   | CancelledError;
 
-export type DestroyError =
+export type DestroyVersionError =
+  | CancelledError
+  | MissingArgumentError
+  | NoVersionsFoundError
   | AuthenticationError
   | ApiError
-  | MissingArgumentError
+  | TimeoutError
+  | VersionFailedError;
+
+export type DestroyServiceError =
   | CancelledError
+  | AuthenticationError
+  | ApiError
   | DestroyAggregateError;
+
+export type ApiRequestError = CancelledError | AuthenticationError | ApiError;
+
+export type VersionOperationError =
+  | CancelledError
+  | AuthenticationError
+  | ApiError
+  | TimeoutError
+  | VersionFailedError;

package/src/index.ts

@@ -21,6 +21,7 @@ export type {
   UpdateEnvProgress,
 } from "./callbacks.ts";
 export type {
+  CreateProjectOptions,
   CreateServiceOptions,
   DeleteServiceOptions,
   DeleteVersionOptions,
@@ -43,10 +44,12 @@ export type {
 // Core client
 export { ComputeClient } from "./compute-client.ts";
 export type {
-  ComputeError,
+  ApiRequestError,
   DeployError,
-  DestroyError,
+  DestroyServiceError,
+  DestroyVersionError,
   UpdateEnvError,
+  VersionOperationError,
 } from "./errors.ts";
 // Errors
 export {
@@ -58,11 +61,14 @@ export {
   DestroyAggregateError,
   MissingArgumentError,
   NoExistingVersionError,
+  NoVersionsFoundError,
   TimeoutError,
   VersionFailedError,
 } from "./errors.ts";
 // Domain types
 export type {
+  CreateProjectResult,
+  DatabaseInfo,
   PortMapping,
   ProjectInfo,
   RegionInfo,

package/src/polling.ts

@@ -45,7 +45,9 @@ export async function pollVersionStatus(
         return Result.err(new CancelledError());
       }
 
-      const version = yield* Result.await(api.getVersion(versionId));
+      const version = yield* Result.await(
+        api.getVersion(versionId, options.signal),
+      );
 
       if (version.status !== lastStatus) {
         lastStatus = version.status;

package/src/types.ts

@@ -12,6 +12,17 @@ export interface ProjectInfo {
   defaultRegion?: string;
 }
 
+export interface DatabaseInfo {
+  id: string;
+  name: string;
+  region: string;
+  connectionString?: string;
+}
+
+export interface CreateProjectResult extends ProjectInfo {
+  database?: DatabaseInfo;
+}
+
 export interface ServiceInfo {
   id: string;
   name: string;