@superblocksteam/sdk 1.2.0 → 1.3.0

package/dist/client.d.ts

@@ -1,10 +1,5 @@
+import { ComponentEvent, LocalGitRepoState, SuperblocksResourceType } from "@superblocksteam/util";
 export type ViewMode = "export-deployed" | "export-latest" | "export-live";
-export declare class BranchNotCheckedOutError extends Error {
-    constructor(message: string);
-}
-export declare class CommitAlreadyExistsError extends Error {
-    constructor(message: string);
-}
 export interface UploadFile {
     name: string;
     filename: string;
@@ -28,7 +23,7 @@ export type Branch = {
 };
 export declare function fetchApplication({ applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
     applicationId: string;
-    branch: string;
+    branch?: string;
     token: string;
     superblocksBaseUrl: string;
     viewMode: ViewMode;
@@ -53,6 +48,9 @@ export declare function fetchApplicationWithComponents({ applicationId, branch,
 export declare function fetchApplications(token: string, superblocksBaseUrl: string, injectedHeaders?: Record<string, string>): Promise<any>;
 export declare function fetchApi(apiId: string, token: string, superblocksBaseUrl: string, viewMode: ViewMode): Promise<any>;
 export declare function fetchApis(token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function validateGitSetup(resourceId: string, resourceType: Exclude<SuperblocksResourceType, "BACKEND">, event: ComponentEvent, localGitRepoState: LocalGitRepoState, token: string, superblocksBaseUrl: string, injectedHeaders?: Record<string, string>): Promise<{
+    branchName: string | null;
+}>;
 export declare function registerComponents(applicationId: string, componentConfigs: Record<string, any>, token: string, superblocksBaseUrl: string, branch: string | null, injectedHeaders?: Record<string, string>): Promise<any>;
 export declare function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, branch, }: {
     applicationId: string;

package/dist/client.js

@@ -1,33 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pushApplication = exports.fetchCurrentUser = exports.uploadComponents = exports.registerComponents = exports.fetchApis = exports.fetchApi = exports.fetchApplications = exports.fetchApplicationWithComponents = exports.fetchApplicationBranches = exports.fetchApplication = exports.CommitAlreadyExistsError = exports.BranchNotCheckedOutError = void 0;
+exports.pushApplication = exports.fetchCurrentUser = exports.uploadComponents = exports.registerComponents = exports.validateGitSetup = exports.fetchApis = exports.fetchApi = exports.fetchApplications = exports.fetchApplicationWithComponents = exports.fetchApplicationBranches = exports.fetchApplication = void 0;
 const fs = require("fs");
 const util_1 = require("@superblocksteam/util");
 const axios_1 = require("axios");
 const FormData = require("form-data");
 const lodash_1 = require("lodash");
+const errors_1 = require("./errors");
 const BASE_SERVER_URL = "api/v1";
 const BASE_BUCKETEER_URL = "api/v1";
 const SUPERBLOCKS_MAX_FILE_SIZE_MB = 10;
 const CLI_VERSION_HEADER = "x-superblocks-cli-version";
 const SUPERBLOCKS_URL_HEADER = "x-superblocks-url";
-class BranchNotCheckedOutError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "BranchNotCheckedOutError";
-    }
-}
-exports.BranchNotCheckedOutError = BranchNotCheckedOutError;
-class CommitAlreadyExistsError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "CommitAlreadyExistsError";
-    }
-}
-exports.CommitAlreadyExistsError = CommitAlreadyExistsError;
 async function fetchApplication({ applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
     var _a, _b;
-    const serverURL = new URL(`api/v2/applications/${applicationId}/branches/${branch}?viewMode=${viewMode}`, superblocksBaseUrl);
+    const serverURL = branch
+        ? new URL(`api/v2/applications/${applicationId}/branches/${branch}?viewMode=${viewMode}`, superblocksBaseUrl)
+        : new URL(`api/v2/applications/${applicationId}?viewMode=${viewMode}`, superblocksBaseUrl);
     let serverResponse;
     try {
         const config = {
@@ -98,7 +87,8 @@ async function fetchApplicationWithComponents({ applicationId, branch, token, su
     superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
     const bucketeerBaseUrl = (0, util_1.getBucketeerUrlFromSuperblocksUrl)(superblocksBaseUrl);
     // fetch files from bucketeer
-    const componentFileURL = new URL(`${BASE_BUCKETEER_URL}/components/${applicationId}?commit=${commitId}&viewMode=${viewMode}`, bucketeerBaseUrl).toString();
+    const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
+    const componentFileURL = new URL(`${BASE_BUCKETEER_URL}/components/${applicationId}${branchPath}?commit=${commitId}&viewMode=${viewMode}`, bucketeerBaseUrl).toString();
     try {
         const config = {
             method: "get",
@@ -176,6 +166,61 @@ async function fetchApis(token, superblocksBaseUrl) {
     }
 }
 exports.fetchApis = fetchApis;
+async function validateGitSetup(resourceId, 
+// TODO: change the type to `SuperblocksResourceType` once we support other resource types
+resourceType, event, localGitRepoState, token, superblocksBaseUrl, injectedHeaders) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    let resourceName;
+    try {
+        const [rootSettings] = await (0, util_1.getSuperblocksMonorepoConfigJson)(true);
+        const requestBody = {
+            event,
+            gitState: localGitRepoState,
+        };
+        let path;
+        switch (resourceType) {
+            case "APPLICATION": {
+                path = `/public/application/${resourceId}/validate-git-setup`;
+                break;
+            }
+            default:
+                (0, util_1.unreachable)(resourceType);
+        }
+        const config = {
+            method: "post",
+            url: new URL(`${BASE_SERVER_URL}/${path}`, superblocksBaseUrl).toString(),
+            headers: {
+                Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+                ...injectedHeaders,
+            },
+            data: requestBody,
+        };
+        const response = await (0, axios_1.default)(config);
+        const { validationResult } = response.data.data;
+        if (validationResult.errors.length > 0) {
+            if (validationResult.resourceName) {
+                resourceName = validationResult.resourceName;
+            }
+            throw new Error(validationResult.errors.join("\n"));
+        }
+        return {
+            branchName: ((_a = validationResult.branchName) !== null && _a !== void 0 ? _a : null),
+        };
+    }
+    catch (e) {
+        let message;
+        if (e instanceof axios_1.AxiosError) {
+            message =
+                (_k = (_j = (_g = (_e = (_d = (_c = (_b = e.response) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.responseMeta) === null || _d === void 0 ? void 0 : _d.message) !== null && _e !== void 0 ? _e : JSON.stringify((_f = e.response) === null || _f === void 0 ? void 0 : _f.data)) !== null && _g !== void 0 ? _g : (_h = e.response) === null || _h === void 0 ? void 0 : _h.statusText) !== null && _j !== void 0 ? _j : e === null || e === void 0 ? void 0 : e.message) !== null && _k !== void 0 ? _k : `${e}`;
+        }
+        else {
+            message = `${(e === null || e === void 0 ? void 0 : e.message) ? e === null || e === void 0 ? void 0 : e.message : e}`;
+        }
+        throw new Error(`Could not validate your git setup against Superblocks for the ${resourceType.toLowerCase()} ${resourceName !== null && resourceName !== void 0 ? resourceName : resourceId}${message ? "\n" + message : ""}`);
+    }
+}
+exports.validateGitSetup = validateGitSetup;
 async function registerComponents(applicationId, componentConfigs, token, superblocksBaseUrl, branch, injectedHeaders) {
     var _a, _b, _c, _d, _e, _f, _g;
     try {
@@ -324,10 +369,10 @@ async function pushApplication({ applicationId, token, superblocksBaseUrl, appli
         if (axios_1.default.isAxiosError(e)) {
             const respCode = (_d = (_c = (_b = (_a = e.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.responseMeta) === null || _c === void 0 ? void 0 : _c.status) !== null && _d !== void 0 ? _d : (_e = e.response) === null || _e === void 0 ? void 0 : _e.status;
             if (respCode === 405) {
-                throw new BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
+                throw new errors_1.BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
             }
             else if (respCode === 409) {
-                throw new CommitAlreadyExistsError(`Commit ${applicationConfig.commitId} already exists`);
+                throw new errors_1.CommitAlreadyExistsError(`Commit ${applicationConfig.commitId} already exists`);
             }
             const message = (_l = (_j = (_h = (_g = (_f = e.response) === null || _f === void 0 ? void 0 : _f.data) === null || _g === void 0 ? void 0 : _g.responseMeta) === null || _h === void 0 ? void 0 : _h.message) !== null && _j !== void 0 ? _j : JSON.stringify((_k = e.response) === null || _k === void 0 ? void 0 : _k.data)) !== null && _l !== void 0 ? _l : (_m = e.response) === null || _m === void 0 ? void 0 : _m.statusText;
             throw new Error(`Could not push application ${message ? "\n" + message : ""}`);

package/dist/errors.d.ts

@@ -0,0 +1,6 @@
+export declare class BranchNotCheckedOutError extends Error {
+    constructor(message: string);
+}
+export declare class CommitAlreadyExistsError extends Error {
+    constructor(message: string);
+}

package/dist/errors.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommitAlreadyExistsError = exports.BranchNotCheckedOutError = void 0;
+class BranchNotCheckedOutError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "BranchNotCheckedOutError";
+    }
+}
+exports.BranchNotCheckedOutError = BranchNotCheckedOutError;
+class CommitAlreadyExistsError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "CommitAlreadyExistsError";
+    }
+}
+exports.CommitAlreadyExistsError = CommitAlreadyExistsError;

package/dist/sdk.d.ts

@@ -1,11 +1,13 @@
+import { ComponentEvent, LocalGitRepoState, SuperblocksResourceType } from "@superblocksteam/util";
 import { ViewMode, PushApplicationWithCommitConfig } from "./client";
+export * from "./errors";
 export declare class SuperblocksSdk {
     token: string;
     superblocksBaseUrl: string;
     constructor(accessToken: string, superblocksBaseUrl: string);
     fetchApplication({ applicationId, branch, headers, viewMode, }: {
         applicationId: string;
-        branch: string;
+        branch?: string;
         headers?: Record<string, string>;
         viewMode?: ViewMode;
     }): Promise<import("./client").ApplicationWrapper | undefined>;
@@ -21,6 +23,9 @@ export declare class SuperblocksSdk {
     fetchApplications(headers?: Record<string, string>): Promise<any>;
     fetchApi(apiId: string, viewMode?: ViewMode): Promise<any>;
     fetchApis(): Promise<any>;
+    validateGitSetup(resourceId: string, resourceType: Exclude<SuperblocksResourceType, "BACKEND">, event: ComponentEvent, localGitRepoState: LocalGitRepoState, injectedHeaders?: Record<string, string>): Promise<{
+        branchName: string | null;
+    }>;
     registerComponents(applicationId: string, componentConfigs: Record<string, any>, branch: string | null, injectedHeaders?: Record<string, string>): Promise<any>;
     uploadComponents(applicationId: string, componentConfigs: Record<string, any>, files: string[], branch: string | null): Promise<any>;
     fetchCurrentUser(): Promise<any>;

package/dist/sdk.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SuperblocksSdk = void 0;
+const tslib_1 = require("tslib");
 const client_1 = require("./client");
+// Exporting here instead of index.ts because only sdk.ts is exposed outside in package.json
+tslib_1.__exportStar(require("./errors"), exports);
 class SuperblocksSdk {
     constructor(accessToken, superblocksBaseUrl) {
         this.token = "";
@@ -46,6 +49,11 @@ class SuperblocksSdk {
     async fetchApis() {
         return (0, client_1.fetchApis)(this.token, this.superblocksBaseUrl);
     }
+    async validateGitSetup(resourceId, 
+    // TODO: change the type to `SuperblocksResourceType` once we support other resource types
+    resourceType, event, localGitRepoState, injectedHeaders) {
+        return (0, client_1.validateGitSetup)(resourceId, resourceType, event, localGitRepoState, this.token, this.superblocksBaseUrl, injectedHeaders);
+    }
     async registerComponents(applicationId, componentConfigs, branch, injectedHeaders) {
         return (0, client_1.registerComponents)(applicationId, componentConfigs, this.token, this.superblocksBaseUrl, branch, injectedHeaders);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {
@@ -30,7 +30,7 @@
     "typescript": "^5.1.3"
   },
   "dependencies": {
-    "@superblocksteam/util": "1.2.0",
+    "@superblocksteam/util": "1.3.0",
     "axios": "^1.3.5"
   },
   "homepage": "https://www.superblocks.com",

package/src/client.ts

@@ -6,10 +6,15 @@ import {
   getContentType,
   COMPONENT_EVENT_HEADER,
   NotFoundError,
+  LocalGitRepoState,
+  ValidateGitSetupRequestBody,
+  SuperblocksResourceType,
+  unreachable,
 } from "@superblocksteam/util";
 import axios, { AxiosError, AxiosRequestConfig } from "axios";
 import * as FormData from "form-data";
 import { isEmpty } from "lodash";
+import { BranchNotCheckedOutError, CommitAlreadyExistsError } from "./errors";
 
 const BASE_SERVER_URL = "api/v1";
 const BASE_BUCKETEER_URL = "api/v1";
@@ -21,20 +26,6 @@ const SUPERBLOCKS_URL_HEADER = "x-superblocks-url";
 
 export type ViewMode = "export-deployed" | "export-latest" | "export-live";
 
-export class BranchNotCheckedOutError extends Error {
-  constructor(message: string) {
-    super(message);
-    this.name = "BranchNotCheckedOutError";
-  }
-}
-
-export class CommitAlreadyExistsError extends Error {
-  constructor(message: string) {
-    super(message);
-    this.name = "CommitAlreadyExistsError";
-  }
-}
-
 export interface UploadFile {
   name: string;
   filename: string;
@@ -72,16 +63,22 @@ export async function fetchApplication({
   injectedHeaders = {},
 }: {
   applicationId: string;
-  branch: string;
+  branch?: string;
   token: string;
   superblocksBaseUrl: string;
   viewMode: ViewMode;
   injectedHeaders: Record<string, string>;
 }): Promise<ApplicationWrapper | undefined> {
-  const serverURL = new URL(
-    `api/v2/applications/${applicationId}/branches/${branch}?viewMode=${viewMode}`,
-    superblocksBaseUrl
-  );
+  const serverURL = branch
+    ? new URL(
+        `api/v2/applications/${applicationId}/branches/${branch}?viewMode=${viewMode}`,
+        superblocksBaseUrl
+      )
+    : new URL(
+        `api/v2/applications/${applicationId}?viewMode=${viewMode}`,
+        superblocksBaseUrl
+      );
+
   let serverResponse;
 
   try {
@@ -184,8 +181,9 @@ export async function fetchApplicationWithComponents({
     getBucketeerUrlFromSuperblocksUrl(superblocksBaseUrl);
 
   // fetch files from bucketeer
+  const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
   const componentFileURL = new URL(
-    `${BASE_BUCKETEER_URL}/components/${applicationId}?commit=${commitId}&viewMode=${viewMode}`,
+    `${BASE_BUCKETEER_URL}/components/${applicationId}${branchPath}?commit=${commitId}&viewMode=${viewMode}`,
     bucketeerBaseUrl
   ).toString();
 
@@ -273,6 +271,73 @@ export async function fetchApis(token: string, superblocksBaseUrl: string) {
   }
 }
 
+export async function validateGitSetup(
+  resourceId: string,
+  // TODO: change the type to `SuperblocksResourceType` once we support other resource types
+  resourceType: Exclude<SuperblocksResourceType, "BACKEND">,
+  event: ComponentEvent,
+  localGitRepoState: LocalGitRepoState,
+  token: string,
+  superblocksBaseUrl: string,
+  injectedHeaders?: Record<string, string>
+) {
+  let resourceName: string | undefined;
+  try {
+    const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
+    const requestBody: ValidateGitSetupRequestBody = {
+      event,
+      gitState: localGitRepoState,
+    };
+    let path: string;
+    switch (resourceType) {
+      case "APPLICATION": {
+        path = `/public/application/${resourceId}/validate-git-setup`;
+        break;
+      }
+      default:
+        unreachable(resourceType);
+    }
+    const config: AxiosRequestConfig = {
+      method: "post",
+      url: new URL(`${BASE_SERVER_URL}/${path}`, superblocksBaseUrl).toString(),
+      headers: {
+        Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+        ...injectedHeaders,
+      },
+      data: requestBody,
+    };
+    const response = await axios(config);
+    const { validationResult } = response.data.data;
+    if (validationResult.errors.length > 0) {
+      if (validationResult.resourceName) {
+        resourceName = validationResult.resourceName;
+      }
+      throw new Error(validationResult.errors.join("\n"));
+    }
+    return {
+      branchName: (validationResult.branchName ?? null) as string | null,
+    };
+  } catch (e: any) {
+    let message: string;
+    if (e instanceof AxiosError) {
+      message =
+        (e.response?.data?.responseMeta?.message as string) ??
+        JSON.stringify(e.response?.data) ??
+        e.response?.statusText ??
+        e?.message ??
+        `${e}`;
+    } else {
+      message = `${e?.message ? e?.message : e}`;
+    }
+    throw new Error(
+      `Could not validate your git setup against Superblocks for the ${resourceType.toLowerCase()} ${
+        resourceName ?? resourceId
+      }${message ? "\n" + message : ""}`
+    );
+  }
+}
+
 export async function registerComponents(
   applicationId: string,
   componentConfigs: Record<string, any>,

package/src/errors.ts

@@ -0,0 +1,13 @@
+export class BranchNotCheckedOutError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = "BranchNotCheckedOutError";
+  }
+}
+
+export class CommitAlreadyExistsError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = "CommitAlreadyExistsError";
+  }
+}

package/src/sdk.ts

@@ -1,3 +1,8 @@
+import {
+  ComponentEvent,
+  LocalGitRepoState,
+  SuperblocksResourceType,
+} from "@superblocksteam/util";
 import {
   fetchApi,
   fetchApis,
@@ -11,8 +16,12 @@ import {
   pushApplication,
   PushApplicationWithCommitConfig,
   fetchApplicationBranches,
+  validateGitSetup,
 } from "./client";
 
+// Exporting here instead of index.ts because only sdk.ts is exposed outside in package.json
+export * from "./errors";
+
 export class SuperblocksSdk {
   token = "";
   superblocksBaseUrl = "";
@@ -29,7 +38,7 @@ export class SuperblocksSdk {
     viewMode = "export-live",
   }: {
     applicationId: string;
-    branch: string;
+    branch?: string;
     headers?: Record<string, string>;
     viewMode?: ViewMode;
   }) {
@@ -85,6 +94,25 @@ export class SuperblocksSdk {
     return fetchApis(this.token, this.superblocksBaseUrl);
   }
 
+  async validateGitSetup(
+    resourceId: string,
+    // TODO: change the type to `SuperblocksResourceType` once we support other resource types
+    resourceType: Exclude<SuperblocksResourceType, "BACKEND">,
+    event: ComponentEvent,
+    localGitRepoState: LocalGitRepoState,
+    injectedHeaders?: Record<string, string>
+  ) {
+    return validateGitSetup(
+      resourceId,
+      resourceType,
+      event,
+      localGitRepoState,
+      this.token,
+      this.superblocksBaseUrl,
+      injectedHeaders
+    );
+  }
+
   async registerComponents(
     applicationId: string,
     componentConfigs: Record<string, any>,