@superblocksteam/sdk 1.13.1 → 1.14.0

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import { ComponentEvent, LocalGitRepoState, SuperblocksResourceType } from "@superblocksteam/util";
 import { StdISocketRPCClient } from "./socket";
-import { Api, ApiWithPb, Page, RemoteCommitDto, UserMeDto, ViewMode } from "./types";
+import { Api, ApiWithPb, Page, RemoteCommitDto, UserMeDto, ViewMode, DeploymentDto } from "./types";
 export interface UploadFile {
     name: string;
     filename: string;
@@ -151,3 +151,5 @@ export declare function fetchApiCommits({ cliVersion, applicationId, branch, tok
     limit?: number;
     offset?: number;
 }): Promise<GetCommitsResponseBody>;
+export declare function deployApplication(cliVersion: string, applicationId: string, token: string, superblocksBaseUrl: string, commitId?: string): Promise<DeploymentDto>;
+export declare function deployApi(cliVersion: string, apiId: string, token: string, superblocksBaseUrl: string, commitId?: string): Promise<DeploymentDto>;

package/dist/client.js

@@ -51,6 +51,8 @@ exports.pushApplication = pushApplication;
 exports.pushApi = pushApi;
 exports.fetchApplicationCommits = fetchApplicationCommits;
 exports.fetchApiCommits = fetchApiCommits;
+exports.deployApplication = deployApplication;
+exports.deployApi = deployApi;
 const fs = __importStar(require("fs"));
 const util_1 = require("@superblocksteam/util");
 const axios_1 = __importStar(require("axios"));
@@ -69,6 +71,11 @@ const BASE_SERVER_API_URL_V3 = "api/v3";
 const SUPERBLOCKS_MAX_FILE_SIZE_MB = 10;
 const CLI_VERSION_HEADER = "x-superblocks-cli-version";
 const SUPERBLOCKS_URL_HEADER = "x-superblocks-url";
+var ResourceType;
+(function (ResourceType) {
+    ResourceType["APPLICATION"] = "APPLICATION";
+    ResourceType["BACKEND"] = "BACKEND";
+})(ResourceType || (ResourceType = {}));
 async function fetchApplication({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, commitId, skipSigningVerification = false, injectedHeaders = {}, }) {
     if (commitId && viewMode !== "export-commit") {
         throw new Error(`If commitId ${commitId} is provided, viewMode cannot be ${viewMode}`);
@@ -292,11 +299,11 @@ async function validateGitSetup(cliVersion, resourceId, resourceType, event, loc
         };
         let path;
         switch (resourceType) {
-            case "APPLICATION": {
+            case ResourceType.APPLICATION: {
                 path = `/application/${resourceId}/validate-git-setup`;
                 break;
             }
-            case "BACKEND": {
+            case ResourceType.BACKEND: {
                 path = `/api/${resourceId}/validate-git-setup`;
                 break;
             }
@@ -724,3 +731,58 @@ async function fetchApiCommits({ cliVersion, applicationId, branch, token, super
         throw new Error("Could not fetch application");
     }
 }
+async function deployApplication(cliVersion, applicationId, token, superblocksBaseUrl, commitId) {
+    return deployResource(cliVersion, ResourceType.APPLICATION, applicationId, token, superblocksBaseUrl, commitId);
+}
+async function deployApi(cliVersion, apiId, token, superblocksBaseUrl, commitId) {
+    return deployResource(cliVersion, ResourceType.BACKEND, apiId, token, superblocksBaseUrl, commitId);
+}
+async function deployResource(cliVersion, resourceType, resourceId, token, superblocksBaseUrl, commitId) {
+    let apiBaseUrl;
+    try {
+        if (resourceType === ResourceType.BACKEND) {
+            apiBaseUrl = `${BASE_SERVER_PUBLIC_API_URL_V1}/api/${resourceId}/deploy`;
+        }
+        else if (resourceType === ResourceType.APPLICATION) {
+            apiBaseUrl = `${BASE_SERVER_PUBLIC_API_URL_V1}/application/${resourceId}/deploy`;
+        }
+        else {
+            throw new Error(`Unsupported resource type: ${resourceType}`);
+        }
+        const config = {
+            method: "post",
+            url: new URL(apiBaseUrl, superblocksBaseUrl).toString(),
+            headers: {
+                Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: cliVersion,
+            },
+            data: {
+                commitId: commitId ?? "HEAD",
+            },
+        };
+        const serverResponse = await (0, axios_1.default)(config);
+        return serverResponse?.data?.data;
+    }
+    catch (e) {
+        let message;
+        if (axios_1.default.isAxiosError(e)) {
+            if (e.response?.status === 404) {
+                throw new util_1.NotFoundError(`${e.response?.data?.responseMeta?.message}`);
+            }
+            else if (e.response?.status === 403) {
+                throw new util_1.ForbiddenError(`${e.response?.data?.responseMeta?.message}`);
+            }
+            else if (e.response?.status === 400) {
+                throw new util_1.BadRequestError(`${e.response?.data?.responseMeta?.message}`);
+            }
+            else {
+                message =
+                    e.response?.data?.responseMeta?.message ??
+                        JSON.stringify(e.response?.data) ??
+                        e.response?.statusText;
+                throw new Error(`${message}`);
+            }
+        }
+        throw new Error(`${e.message}`);
+    }
+}

package/dist/sdk.d.ts

@@ -75,4 +75,6 @@ export declare class SuperblocksSdk {
     } | {
         updated: Date;
     } | undefined>;
+    deployApplication(applicationId: string, commitId?: string): Promise<import("./types").DeploymentDto>;
+    deployApi(apiId: string, commitId?: string): Promise<import("./types").DeploymentDto>;
 }

package/dist/sdk.js

@@ -144,5 +144,11 @@ class SuperblocksSdk {
             injectedHeaders: headers,
         });
     }
+    async deployApplication(applicationId, commitId) {
+        return (0, client_1.deployApplication)(this.cliVersion, applicationId, this.token, this.superblocksBaseUrl, commitId);
+    }
+    async deployApi(apiId, commitId) {
+        return (0, client_1.deployApi)(this.cliVersion, apiId, this.token, this.superblocksBaseUrl, commitId);
+    }
 }
 exports.SuperblocksSdk = SuperblocksSdk;

package/dist/types/common.d.ts

@@ -201,4 +201,17 @@ export interface RemoteCommitDto {
     branchName: string;
     repositoryId: string;
 }
+export interface DeploymentDto {
+    commitId: string;
+    previousCommitId?: string | null;
+    entityId: string;
+    deployer: {
+        id: string;
+        email: string;
+        name: string;
+    };
+    deploymentId: string;
+    deployMessage: string;
+    deploymentTime: number;
+}
 export type ViewMode = "export-deployed" | "export-latest" | "export-live" | "export-commit";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "1.13.1",
+  "version": "1.14.0",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {
@@ -29,7 +29,7 @@
     "form-data": "^4.0.0",
     "lodash": "^4.17.21",
     "ws": "^8.17.0",
-    "@superblocksteam/util": "1.13.1"
+    "@superblocksteam/util": "1.14.0"
   },
   "homepage": "https://www.superblocks.com",
   "engines": {

package/src/client.ts

@@ -2,11 +2,13 @@ import * as fs from "fs";
 import {
   COMPONENT_EVENT_HEADER,
   ComponentEvent,
+  ForbiddenError,
   getBucketeerUrlFromSuperblocksUrl,
   getContentType,
   LocalGitRepoState,
   NotFoundError,
   SuperblocksResourceType,
+  BadRequestError,
   unreachable,
   ValidateGitSetupRequestBody,
 } from "@superblocksteam/util";
@@ -28,6 +30,7 @@ import {
   RemoteCommitDto,
   UserMeDto,
   ViewMode,
+  DeploymentDto,
 } from "./types";
 import { getAgentUrl } from "./utils";
 
@@ -112,6 +115,11 @@ export interface GetCommitsResponseBody {
   commits: CommitDto[];
 }
 
+enum ResourceType {
+  APPLICATION = "APPLICATION",
+  BACKEND = "BACKEND",
+}
+
 export async function fetchApplication({
   cliVersion,
   applicationId,
@@ -481,16 +489,16 @@ export async function validateGitSetup(
     };
     let path: string;
     switch (resourceType) {
-      case "APPLICATION": {
+      case ResourceType.APPLICATION: {
         path = `/application/${resourceId}/validate-git-setup`;
         break;
       }
-      case "BACKEND": {
+      case ResourceType.BACKEND: {
         path = `/api/${resourceId}/validate-git-setup`;
         break;
       }
       default:
-        unreachable(resourceType);
+        unreachable(resourceType as never);
     }
     const config: AxiosRequestConfig = {
       method: "post",
@@ -1120,3 +1128,90 @@ export async function fetchApiCommits({
     throw new Error("Could not fetch application");
   }
 }
+
+export async function deployApplication(
+  cliVersion: string,
+  applicationId: string,
+  token: string,
+  superblocksBaseUrl: string,
+  commitId?: string,
+): Promise<DeploymentDto> {
+  return deployResource(
+    cliVersion,
+    ResourceType.APPLICATION,
+    applicationId,
+    token,
+    superblocksBaseUrl,
+    commitId,
+  );
+}
+
+export async function deployApi(
+  cliVersion: string,
+  apiId: string,
+  token: string,
+  superblocksBaseUrl: string,
+  commitId?: string,
+): Promise<DeploymentDto> {
+  return deployResource(
+    cliVersion,
+    ResourceType.BACKEND,
+    apiId,
+    token,
+    superblocksBaseUrl,
+    commitId,
+  );
+}
+
+async function deployResource(
+  cliVersion: string,
+  resourceType: ResourceType,
+  resourceId: string,
+  token: string,
+  superblocksBaseUrl: string,
+  commitId?: string,
+): Promise<DeploymentDto> {
+  let apiBaseUrl;
+
+  try {
+    if (resourceType === ResourceType.BACKEND) {
+      apiBaseUrl = `${BASE_SERVER_PUBLIC_API_URL_V1}/api/${resourceId}/deploy`;
+    } else if (resourceType === ResourceType.APPLICATION) {
+      apiBaseUrl = `${BASE_SERVER_PUBLIC_API_URL_V1}/application/${resourceId}/deploy`;
+    } else {
+      throw new Error(`Unsupported resource type: ${resourceType}`);
+    }
+
+    const config: AxiosRequestConfig = {
+      method: "post",
+      url: new URL(apiBaseUrl, superblocksBaseUrl).toString(),
+      headers: {
+        Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
+      },
+      data: {
+        commitId: commitId ?? "HEAD",
+      },
+    };
+    const serverResponse = await axios(config);
+    return serverResponse?.data?.data;
+  } catch (e: any) {
+    let message: string;
+    if (axios.isAxiosError(e)) {
+      if (e.response?.status === 404) {
+        throw new NotFoundError(`${e.response?.data?.responseMeta?.message}`);
+      } else if (e.response?.status === 403) {
+        throw new ForbiddenError(`${e.response?.data?.responseMeta?.message}`);
+      } else if (e.response?.status === 400) {
+        throw new BadRequestError(`${e.response?.data?.responseMeta?.message}`);
+      } else {
+        message =
+          (e.response?.data?.responseMeta?.message as string) ??
+          JSON.stringify(e.response?.data) ??
+          e.response?.statusText;
+        throw new Error(`${message}`);
+      }
+    }
+    throw new Error(`${e.message}`);
+  }
+}

package/src/sdk.ts

@@ -20,6 +20,8 @@ import {
   registerComponents,
   uploadComponents,
   validateGitSetup,
+  deployApplication,
+  deployApi,
 } from "./client";
 import { FeatureFlags } from "./flag";
 import { UserMeDto, ViewMode } from "./types";
@@ -305,4 +307,24 @@ export class SuperblocksSdk {
       injectedHeaders: headers,
     });
   }
+
+  async deployApplication(applicationId: string, commitId?: string) {
+    return deployApplication(
+      this.cliVersion,
+      applicationId,
+      this.token,
+      this.superblocksBaseUrl,
+      commitId,
+    );
+  }
+
+  async deployApi(apiId: string, commitId?: string) {
+    return deployApi(
+      this.cliVersion,
+      apiId,
+      this.token,
+      this.superblocksBaseUrl,
+      commitId,
+    );
+  }
 }

package/src/types/common.ts

@@ -244,6 +244,20 @@ export interface RemoteCommitDto {
   repositoryId: string;
 }
 
+export interface DeploymentDto {
+  commitId: string;
+  previousCommitId?: string | null;
+  entityId: string;
+  deployer: {
+    id: string;
+    email: string;
+    name: string;
+  };
+  deploymentId: string;
+  deployMessage: string;
+  deploymentTime: number;
+}
+
 export type ViewMode =
   | "export-deployed"
   | "export-latest"