@superblocksteam/sdk 1.0.2 → 1.1.0

package/dist/client.d.ts

@@ -9,15 +9,34 @@ export interface ApplicationWrapper {
     page: Record<string, any>;
     apis: Record<string, any>[];
 }
-export declare function fetchApplication({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
+export type PushApplicationWithCommitConfig = ApplicationWrapper & {
+    commitId: string;
+    commitMessage: string;
+};
+export type Branches = {
+    branches: Branch[];
+};
+export type Branch = {
+    name: string;
+    isDefault: boolean;
+};
+export declare function fetchApplication({ applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
     applicationId: string;
+    branch: string;
     token: string;
     superblocksBaseUrl: string;
     viewMode: ViewMode;
     injectedHeaders: Record<string, string>;
 }): Promise<ApplicationWrapper | undefined>;
-export declare function fetchApplicationWithComponents({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
+export declare function fetchApplicationBranches({ applicationId, token, superblocksBaseUrl, injectedHeaders, }: {
+    applicationId: string;
+    token: string;
+    superblocksBaseUrl: string;
+    injectedHeaders: Record<string, string>;
+}): Promise<Branches | undefined>;
+export declare function fetchApplicationWithComponents({ applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
     applicationId: string;
+    branch: string;
     token: string;
     superblocksBaseUrl: string;
     viewMode: ViewMode;
@@ -29,11 +48,20 @@ export declare function fetchApplications(token: string, superblocksBaseUrl: str
 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 registerComponents(applicationId: string, componentConfigs: Record<string, any>, token: string, superblocksBaseUrl: string, injectedHeaders?: Record<string, string>): Promise<any>;
-export declare function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, }: {
+export declare function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, branch, }: {
     applicationId: string;
     componentConfigs: Record<string, any>;
     files: string[];
     token: string;
     superblocksBaseUrl: string;
+    branch: string | null;
 }): Promise<any>;
 export declare function fetchCurrentUser(token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function pushApplication({ applicationId, token, superblocksBaseUrl, applicationConfig, branch, injectedHeaders, }: {
+    applicationId: string;
+    token: string;
+    superblocksBaseUrl: string;
+    branch: string;
+    injectedHeaders: Record<string, string>;
+    applicationConfig: ApplicationWrapper;
+}): Promise<ApplicationWrapper | undefined>;

package/dist/client.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchCurrentUser = exports.uploadComponents = exports.registerComponents = exports.fetchApis = exports.fetchApi = exports.fetchApplications = exports.fetchApplicationWithComponents = exports.fetchApplication = void 0;
+exports.pushApplication = exports.fetchCurrentUser = exports.uploadComponents = exports.registerComponents = 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");
@@ -11,9 +11,9 @@ 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";
-async function fetchApplication({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
+async function fetchApplication({ applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
     var _a, _b;
-    const serverURL = new URL(`api/v2/applications/${applicationId}?viewMode=${viewMode}`, superblocksBaseUrl);
+    const serverURL = new URL(`api/v2/applications/${applicationId}/branches/${branch}?viewMode=${viewMode}`, superblocksBaseUrl);
     let serverResponse;
     try {
         const config = {
@@ -35,10 +35,35 @@ async function fetchApplication({ applicationId, token, superblocksBaseUrl, view
     return (_b = serverResponse === null || serverResponse === void 0 ? void 0 : serverResponse.data) === null || _b === void 0 ? void 0 : _b.data;
 }
 exports.fetchApplication = fetchApplication;
-async function fetchApplicationWithComponents({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
+async function fetchApplicationBranches({ applicationId, token, superblocksBaseUrl, injectedHeaders = {}, }) {
+    var _a, _b;
+    const serverURL = new URL(`api/v2/applications/${applicationId}/branches`, superblocksBaseUrl);
+    let serverResponse;
+    try {
+        const config = {
+            method: "get",
+            url: serverURL.toString(),
+            headers: {
+                Authorization: "Bearer " + token,
+                ...injectedHeaders,
+            },
+        };
+        serverResponse = await (0, axios_1.default)(config);
+    }
+    catch (e) {
+        if (axios_1.default.isAxiosError(e) && ((_a = e.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+            throw new util_1.NotFoundError(`Application ${applicationId} was not found`);
+        }
+        throw new Error(`Could not fetch application branches: ${e.message}`);
+    }
+    return (_b = serverResponse === null || serverResponse === void 0 ? void 0 : serverResponse.data) === null || _b === void 0 ? void 0 : _b.data;
+}
+exports.fetchApplicationBranches = fetchApplicationBranches;
+async function fetchApplicationWithComponents({ applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
     var _a, _b, _c;
     const applicationWrapper = await fetchApplication({
         applicationId,
+        branch,
         token,
         superblocksBaseUrl,
         viewMode,
@@ -163,8 +188,8 @@ async function registerComponents(applicationId, componentConfigs, token, superb
     }
 }
 exports.registerComponents = registerComponents;
-async function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, }) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+async function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, branch, }) {
+    var _a, _b, _c, _d, _e, _f;
     superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
     const bucketeerBaseUrl = (0, util_1.getBucketeerUrlFromSuperblocksUrl)(superblocksBaseUrl);
     // parse files to source and bundled files based on path
@@ -184,6 +209,7 @@ async function uploadComponents({ applicationId, componentConfigs, files, token,
     const srcFiles = uploadFiles.filter((uploadFile) => !uploadFile.filename.startsWith("dist/"));
     const formatJSON = JSON.stringify({
         applicationId,
+        branch,
         registeredComponents: componentConfigs,
         srcFiles,
         buildFiles,
@@ -227,8 +253,7 @@ You can reduce your component bundle size by uploading static assets to a separa
         else {
             let message;
             if (e instanceof axios_1.AxiosError) {
-                message =
-                    (_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 : (_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;
+                message = ((_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) || ((_e = e.response) === null || _e === void 0 ? void 0 : _e.data) || ((_f = e.response) === null || _f === void 0 ? void 0 : _f.statusText);
             }
             else {
                 message = e.message;
@@ -259,3 +284,31 @@ async function fetchCurrentUser(token, superblocksBaseUrl) {
     }
 }
 exports.fetchCurrentUser = fetchCurrentUser;
+async function pushApplication({ applicationId, token, superblocksBaseUrl, applicationConfig, branch, injectedHeaders = {}, }) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const [rootSettings] = await (0, util_1.getSuperblocksMonorepoConfigJson)(true);
+    const serverURL = new URL(`${BASE_SERVER_URL}/public/applications/${applicationId}/branches/${encodeURIComponent(branch)}/push`, superblocksBaseUrl);
+    let serverResponse;
+    try {
+        const config = {
+            method: "post",
+            url: serverURL.toString(),
+            headers: {
+                Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+                ...injectedHeaders,
+            },
+            data: applicationConfig,
+        };
+        serverResponse = await (0, axios_1.default)(config);
+    }
+    catch (e) {
+        if (axios_1.default.isAxiosError(e)) {
+            const message = (_f = (_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.message) !== null && _d !== void 0 ? _d : JSON.stringify((_e = e.response) === null || _e === void 0 ? void 0 : _e.data)) !== null && _f !== void 0 ? _f : (_g = e.response) === null || _g === void 0 ? void 0 : _g.statusText;
+            throw new Error(`Could not push application ${message ? "\n" + message : ""}`);
+        }
+        throw new Error(`Could not push application ${e.message ? "\n" + e.message : ""}`);
+    }
+    return (_h = serverResponse === null || serverResponse === void 0 ? void 0 : serverResponse.data) === null || _h === void 0 ? void 0 : _h.data;
+}
+exports.pushApplication = pushApplication;

package/dist/sdk.d.ts

@@ -1,15 +1,18 @@
-import { ViewMode } from "./client";
+import { ViewMode, PushApplicationWithCommitConfig } from "./client";
 export declare class SuperblocksSdk {
     token: string;
     superblocksBaseUrl: string;
     constructor(accessToken: string, superblocksBaseUrl: string);
-    fetchApplication({ applicationId, headers, viewMode, }: {
+    fetchApplication({ applicationId, branch, headers, viewMode, }: {
         applicationId: string;
+        branch: string;
         headers?: Record<string, string>;
         viewMode?: ViewMode;
     }): Promise<import("./client").ApplicationWrapper | undefined>;
-    fetchApplicationWithComponents({ applicationId, headers, viewMode, }: {
+    fetchApplicationBranches(applicationId: string, headers?: {}): Promise<import("./client").Branches | undefined>;
+    fetchApplicationWithComponents({ applicationId, branch, headers, viewMode, }: {
         applicationId: string;
+        branch: string;
         headers?: Record<string, string>;
         viewMode?: ViewMode;
     }): Promise<(import("./client").ApplicationWrapper & {
@@ -19,6 +22,12 @@ export declare class SuperblocksSdk {
     fetchApi(apiId: string, viewMode?: ViewMode): Promise<any>;
     fetchApis(): Promise<any>;
     registerComponents(applicationId: string, componentConfigs: Record<string, any>, injectedHeaders?: Record<string, string>): Promise<any>;
-    uploadComponents(applicationId: string, componentConfigs: Record<string, any>, files: string[]): Promise<any>;
+    uploadComponents(applicationId: string, componentConfigs: Record<string, any>, files: string[], branch: string | null): Promise<any>;
     fetchCurrentUser(): Promise<any>;
+    pushApplication({ applicationId, applicationConfig, branch, headers, }: {
+        applicationId: string;
+        applicationConfig: PushApplicationWithCommitConfig;
+        branch: string;
+        headers?: Record<string, string>;
+    }): Promise<import("./client").ApplicationWrapper | undefined>;
 }

package/dist/sdk.js

@@ -9,18 +9,28 @@ class SuperblocksSdk {
         this.token = accessToken;
         this.superblocksBaseUrl = superblocksBaseUrl;
     }
-    async fetchApplication({ applicationId, headers = {}, viewMode = "export-live", }) {
+    async fetchApplication({ applicationId, branch, headers = {}, viewMode = "export-live", }) {
         return (0, client_1.fetchApplication)({
             applicationId,
+            branch,
             token: this.token,
             superblocksBaseUrl: this.superblocksBaseUrl,
             viewMode,
             injectedHeaders: headers,
         });
     }
-    async fetchApplicationWithComponents({ applicationId, headers = {}, viewMode = "export-live", }) {
+    async fetchApplicationBranches(applicationId, headers = {}) {
+        return (0, client_1.fetchApplicationBranches)({
+            applicationId,
+            token: this.token,
+            superblocksBaseUrl: this.superblocksBaseUrl,
+            injectedHeaders: headers,
+        });
+    }
+    async fetchApplicationWithComponents({ applicationId, branch, headers = {}, viewMode = "export-live", }) {
         return (0, client_1.fetchApplicationWithComponents)({
             applicationId,
+            branch,
             token: this.token,
             superblocksBaseUrl: this.superblocksBaseUrl,
             viewMode,
@@ -39,17 +49,28 @@ class SuperblocksSdk {
     async registerComponents(applicationId, componentConfigs, injectedHeaders) {
         return (0, client_1.registerComponents)(applicationId, componentConfigs, this.token, this.superblocksBaseUrl, injectedHeaders);
     }
-    async uploadComponents(applicationId, componentConfigs, files) {
+    async uploadComponents(applicationId, componentConfigs, files, branch) {
         return (0, client_1.uploadComponents)({
             applicationId,
             componentConfigs,
             files,
             token: this.token,
             superblocksBaseUrl: this.superblocksBaseUrl,
+            branch,
         });
     }
     async fetchCurrentUser() {
         return (0, client_1.fetchCurrentUser)(this.token, this.superblocksBaseUrl);
     }
+    async pushApplication({ applicationId, applicationConfig, branch, headers = {}, }) {
+        return (0, client_1.pushApplication)({
+            applicationId,
+            token: this.token,
+            superblocksBaseUrl: this.superblocksBaseUrl,
+            branch,
+            injectedHeaders: headers,
+            applicationConfig,
+        });
+    }
 }
 exports.SuperblocksSdk = SuperblocksSdk;

package/package.json

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

package/src/client.ts

@@ -33,23 +33,39 @@ export interface ApplicationWrapper {
   apis: Record<string, any>[];
 }
 
+export type PushApplicationWithCommitConfig = ApplicationWrapper & {
+  commitId: string;
+  commitMessage: string;
+};
+
+export type Branches = {
+  branches: Branch[];
+};
+
+export type Branch = {
+  name: string;
+  isDefault: boolean;
+};
+
 type ResponseWithMeta<T> = { responseMeta: unknown; data: T };
 
 export async function fetchApplication({
   applicationId,
+  branch,
   token,
   superblocksBaseUrl,
   viewMode,
   injectedHeaders = {},
 }: {
   applicationId: string;
+  branch: string;
   token: string;
   superblocksBaseUrl: string;
   viewMode: ViewMode;
   injectedHeaders: Record<string, string>;
 }): Promise<ApplicationWrapper | undefined> {
   const serverURL = new URL(
-    `api/v2/applications/${applicationId}?viewMode=${viewMode}`,
+    `api/v2/applications/${applicationId}/branches/${branch}?viewMode=${viewMode}`,
     superblocksBaseUrl
   );
   let serverResponse;
@@ -74,14 +90,53 @@ export async function fetchApplication({
   return serverResponse?.data?.data;
 }
 
+export async function fetchApplicationBranches({
+  applicationId,
+  token,
+  superblocksBaseUrl,
+  injectedHeaders = {},
+}: {
+  applicationId: string;
+  token: string;
+  superblocksBaseUrl: string;
+  injectedHeaders: Record<string, string>;
+}): Promise<Branches | undefined> {
+  const serverURL = new URL(
+    `api/v2/applications/${applicationId}/branches`,
+    superblocksBaseUrl
+  );
+  let serverResponse;
+
+  try {
+    const config: AxiosRequestConfig = {
+      method: "get",
+      url: serverURL.toString(),
+      headers: {
+        Authorization: "Bearer " + token,
+        ...injectedHeaders,
+      },
+    };
+    serverResponse = await axios<ResponseWithMeta<Branches>>(config);
+  } catch (e: any) {
+    if (axios.isAxiosError(e) && e.response?.status === 404) {
+      throw new NotFoundError(`Application ${applicationId} was not found`);
+    }
+    throw new Error(`Could not fetch application branches: ${e.message}`);
+  }
+
+  return serverResponse?.data?.data;
+}
+
 export async function fetchApplicationWithComponents({
   applicationId,
+  branch,
   token,
   superblocksBaseUrl,
   viewMode,
   injectedHeaders = {},
 }: {
   applicationId: string;
+  branch: string;
   token: string;
   superblocksBaseUrl: string;
   viewMode: ViewMode;
@@ -89,6 +144,7 @@ export async function fetchApplicationWithComponents({
 }): Promise<(ApplicationWrapper & { componentFiles: any }) | undefined> {
   const applicationWrapper = await fetchApplication({
     applicationId,
+    branch,
     token,
     superblocksBaseUrl,
     viewMode,
@@ -253,12 +309,14 @@ export async function uploadComponents({
   files,
   token,
   superblocksBaseUrl,
+  branch,
 }: {
   applicationId: string;
   componentConfigs: Record<string, any>;
   files: string[];
   token: string;
   superblocksBaseUrl: string;
+  branch: string | null;
 }) {
   superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
   const bucketeerBaseUrl =
@@ -286,6 +344,7 @@ export async function uploadComponents({
 
   const formatJSON = JSON.stringify({
     applicationId,
+    branch,
     registeredComponents: componentConfigs,
     srcFiles,
     buildFiles,
@@ -335,12 +394,11 @@ You can reduce your component bundle size by uploading static assets to a separa
         `Could not upload application components, file size limit exceeded`
       );
     } else {
-      let message: any;
+      let message: string;
       if (e instanceof AxiosError) {
-        message =
-          e.response?.data?.responseMeta?.message ?? e.response?.data ?? e.response?.statusText;
+        message = e.response?.data?.responseMeta?.message || e.response?.data || e.response?.statusText;
       } else {
-        message = e.message;
+        message = e.message as string;
       }
       if (typeof message !== "string") {
         message = JSON.stringify(message, null, 2);
@@ -369,3 +427,60 @@ export async function fetchCurrentUser(
     throw new Error("Could not fetch current user");
   }
 }
+
+export async function pushApplication({
+  applicationId,
+  token,
+  superblocksBaseUrl,
+  applicationConfig,
+  branch,
+  injectedHeaders = {},
+}: {
+  applicationId: string;
+  token: string;
+  superblocksBaseUrl: string;
+  branch: string;
+  injectedHeaders: Record<string, string>;
+  applicationConfig: ApplicationWrapper;
+}): Promise<ApplicationWrapper | undefined> {
+  const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
+  const serverURL = new URL(
+    `${BASE_SERVER_URL}/public/applications/${applicationId}/branches/${encodeURIComponent(
+      branch
+    )}/push`,
+    superblocksBaseUrl
+  );
+  let serverResponse;
+
+  try {
+    const config: AxiosRequestConfig = {
+      method: "post",
+      url: serverURL.toString(),
+      headers: {
+        Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+        ...injectedHeaders,
+      },
+      data: applicationConfig,
+    };
+    serverResponse = await axios<ResponseWithMeta<ApplicationWrapper>>(config);
+  } catch (e) {
+    if (axios.isAxiosError(e)) {
+      const message: string =
+        (e.response?.data?.responseMeta?.message as string) ??
+        JSON.stringify(e.response?.data) ??
+        e.response?.statusText;
+
+      throw new Error(
+        `Could not push application ${message ? "\n" + message : ""}`
+      );
+    }
+    throw new Error(
+      `Could not push application ${
+        (e as Error).message ? "\n" + (e as Error).message : ""
+      }`
+    );
+  }
+
+  return serverResponse?.data?.data;
+}

package/src/sdk.ts

@@ -8,6 +8,9 @@ import {
   uploadComponents,
   fetchCurrentUser,
   ViewMode,
+  pushApplication,
+  PushApplicationWithCommitConfig,
+  fetchApplicationBranches,
 } from "./client";
 
 export class SuperblocksSdk {
@@ -21,15 +24,18 @@ export class SuperblocksSdk {
 
   async fetchApplication({
     applicationId,
+    branch,
     headers = {},
     viewMode = "export-live",
   }: {
     applicationId: string;
+    branch: string;
     headers?: Record<string, string>;
     viewMode?: ViewMode;
   }) {
     return fetchApplication({
       applicationId,
+      branch,
       token: this.token,
       superblocksBaseUrl: this.superblocksBaseUrl,
       viewMode,
@@ -37,17 +43,29 @@ export class SuperblocksSdk {
     });
   }
 
+  async fetchApplicationBranches(applicationId: string, headers = {}) {
+    return fetchApplicationBranches({
+      applicationId,
+      token: this.token,
+      superblocksBaseUrl: this.superblocksBaseUrl,
+      injectedHeaders: headers,
+    });
+  }
+
   async fetchApplicationWithComponents({
     applicationId,
+    branch,
     headers = {},
     viewMode = "export-live",
   }: {
     applicationId: string;
+    branch: string;
     headers?: Record<string, string>;
     viewMode?: ViewMode;
   }) {
     return fetchApplicationWithComponents({
       applicationId,
+      branch,
       token: this.token,
       superblocksBaseUrl: this.superblocksBaseUrl,
       viewMode,
@@ -84,7 +102,8 @@ export class SuperblocksSdk {
   async uploadComponents(
     applicationId: string,
     componentConfigs: Record<string, any>,
-    files: string[]
+    files: string[],
+    branch: string | null
   ) {
     return uploadComponents({
       applicationId,
@@ -92,10 +111,32 @@ export class SuperblocksSdk {
       files,
       token: this.token,
       superblocksBaseUrl: this.superblocksBaseUrl,
+      branch,
     });
   }
 
   async fetchCurrentUser() {
     return fetchCurrentUser(this.token, this.superblocksBaseUrl);
   }
+
+  async pushApplication({
+    applicationId,
+    applicationConfig,
+    branch,
+    headers = {},
+  }: {
+    applicationId: string;
+    applicationConfig: PushApplicationWithCommitConfig;
+    branch: string;
+    headers?: Record<string, string>;
+  }) {
+    return pushApplication({
+      applicationId,
+      token: this.token,
+      superblocksBaseUrl: this.superblocksBaseUrl,
+      branch,
+      injectedHeaders: headers,
+      applicationConfig,
+    });
+  }
 }