npm - @superblocksteam/sdk - Versions diffs - 1.3.1 → 1.4.2 - Mend

@superblocksteam/sdk 1.3.1 → 1.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/.eslintrc.json CHANGED Viewed

@@ -26,6 +26,7 @@
     "@typescript-eslint/no-var-requires": "off",
     "@typescript-eslint/no-unsafe-return": "off",
     "@typescript-eslint/no-unsafe-member-access": "off",
+    "@typescript-eslint/restrict-template-expressions": "off",
     "import/order": [
       "error",
       {

package/dist/client.d.ts CHANGED Viewed

@@ -14,6 +14,15 @@ export type PushApplicationWithCommitConfig = ApplicationWrapper & {
     commitId: string;
     commitMessage: string;
 };
+export interface ApiWrapper {
+    apiPb: Record<string, any>;
+    name?: string;
+}
+export type PushApiWithCommitConfig = {
+    apiPb: Record<string, any>;
+    commitId: string;
+    commitMessage: string;
+};
 export type Branches = {
     branches: Branch[];
 };
@@ -21,7 +30,8 @@ export type Branch = {
     name: string;
     isDefault: boolean;
 };
-export declare function fetchApplication({ applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
+export declare function fetchApplication({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
+    cliVersion: string;
     applicationId: string;
     branch?: string;
     token: string;
@@ -29,13 +39,15 @@ export declare function fetchApplication({ applicationId, branch, token, superbl
     viewMode: ViewMode;
     injectedHeaders: Record<string, string>;
 }): Promise<ApplicationWrapper | undefined>;
-export declare function fetchApplicationBranches({ applicationId, token, superblocksBaseUrl, injectedHeaders, }: {
+export declare function fetchApplicationBranches({ cliVersion, applicationId, token, superblocksBaseUrl, injectedHeaders, }: {
+    cliVersion: string;
     applicationId: string;
     token: string;
     superblocksBaseUrl: string;
     injectedHeaders: Record<string, string>;
 }): Promise<Branches | undefined>;
-export declare function fetchApplicationWithComponents({ applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
+export declare function fetchApplicationWithComponents({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
+    cliVersion: string;
     applicationId: string;
     branch: string;
     token: string;
@@ -45,14 +57,15 @@ export declare function fetchApplicationWithComponents({ applicationId, branch,
 }): Promise<(ApplicationWrapper & {
     componentFiles: any;
 }) | undefined>;
-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<{
+export declare function fetchApplications(cliVersion: string, token: string, superblocksBaseUrl: string, injectedHeaders?: Record<string, string>): Promise<any>;
+export declare function fetchApi(cliVersion: string, apiId: string, token: string, superblocksBaseUrl: string, viewMode: ViewMode, branch?: string): Promise<any>;
+export declare function fetchApis(cliVersion: string, token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function validateGitSetup(cliVersion: string, resourceId: string, resourceType: SuperblocksResourceType, 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, }: {
+export declare function registerComponents(cliVersion: string, applicationId: string, componentConfigs: Record<string, any>, token: string, superblocksBaseUrl: string, branch: string | null, injectedHeaders?: Record<string, string>): Promise<any>;
+export declare function uploadComponents({ cliVersion, applicationId, componentConfigs, files, token, superblocksBaseUrl, branch, }: {
+    cliVersion: string;
     applicationId: string;
     componentConfigs: Record<string, any>;
     files: string[];
@@ -60,8 +73,9 @@ export declare function uploadComponents({ applicationId, componentConfigs, file
     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, }: {
+export declare function fetchCurrentUser(cliVersion: string, token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function pushApplication({ cliVersion, applicationId, token, superblocksBaseUrl, applicationConfig, branch, injectedHeaders, }: {
+    cliVersion: string;
     applicationId: string;
     token: string;
     superblocksBaseUrl: string;
@@ -69,3 +83,14 @@ export declare function pushApplication({ applicationId, token, superblocksBaseU
     injectedHeaders: Record<string, string>;
     applicationConfig: PushApplicationWithCommitConfig;
 }): Promise<ApplicationWrapper | undefined>;
+export declare function pushApi({ cliVersion, apiId, token, superblocksBaseUrl, apiConfig, branch, injectedHeaders, }: {
+    cliVersion: string;
+    apiId: string;
+    token: string;
+    superblocksBaseUrl: string;
+    apiConfig: PushApiWithCommitConfig;
+    branch: string;
+    injectedHeaders: Record<string, string>;
+}): Promise<{
+    commitId: string;
+} | undefined>;

package/dist/client.js CHANGED Viewed

@@ -1,22 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pushApplication = exports.fetchCurrentUser = exports.uploadComponents = exports.registerComponents = exports.validateGitSetup = exports.fetchApis = exports.fetchApi = exports.fetchApplications = exports.fetchApplicationWithComponents = exports.fetchApplicationBranches = exports.fetchApplication = void 0;
+exports.pushApi = 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 BASE_SERVER_PUBLIC_API_URL = "api/v1/public";
 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, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
+async function fetchApplication({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
     var _a, _b;
     const serverURL = branch
-        ? new URL(`api/v2/applications/${applicationId}/branches/${branch}?viewMode=${viewMode}`, superblocksBaseUrl)
-        : new URL(`api/v2/applications/${applicationId}?viewMode=${viewMode}`, superblocksBaseUrl);
+        ? new URL(`${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}/branches/${encodeURIComponent(branch)}?viewMode=${viewMode}`, superblocksBaseUrl)
+        : new URL(`${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}?viewMode=${viewMode}`, superblocksBaseUrl);
     let serverResponse;
     try {
         const config = {
@@ -24,6 +24,7 @@ async function fetchApplication({ applicationId, branch, token, superblocksBaseU
             url: serverURL.toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: cliVersion,
                 ...injectedHeaders,
             },
         };
@@ -38,9 +39,9 @@ async function fetchApplication({ applicationId, branch, token, superblocksBaseU
     return (_b = serverResponse === null || serverResponse === void 0 ? void 0 : serverResponse.data) === null || _b === void 0 ? void 0 : _b.data;
 }
 exports.fetchApplication = fetchApplication;
-async function fetchApplicationBranches({ applicationId, token, superblocksBaseUrl, injectedHeaders = {}, }) {
+async function fetchApplicationBranches({ cliVersion, applicationId, token, superblocksBaseUrl, injectedHeaders = {}, }) {
     var _a, _b;
-    const serverURL = new URL(`api/v2/applications/${applicationId}/branches`, superblocksBaseUrl);
+    const serverURL = new URL(`public/applications/${applicationId}/branches`, superblocksBaseUrl);
     let serverResponse;
     try {
         const config = {
@@ -48,6 +49,7 @@ async function fetchApplicationBranches({ applicationId, token, superblocksBaseU
             url: serverURL.toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: cliVersion,
                 ...injectedHeaders,
             },
         };
@@ -62,9 +64,10 @@ async function fetchApplicationBranches({ applicationId, token, superblocksBaseU
     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 = {}, }) {
+async function fetchApplicationWithComponents({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
     var _a, _b, _c;
     const applicationWrapper = await fetchApplication({
+        cliVersion,
         applicationId,
         branch,
         token,
@@ -110,13 +113,15 @@ async function fetchApplicationWithComponents({ applicationId, branch, token, su
     }
 }
 exports.fetchApplicationWithComponents = fetchApplicationWithComponents;
-async function fetchApplications(token, superblocksBaseUrl, injectedHeaders = {}) {
+async function fetchApplications(cliVersion, token, superblocksBaseUrl, injectedHeaders = {}) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     try {
         const config = {
             method: "get",
-            url: new URL(`/api/v2/applications`, superblocksBaseUrl).toString(),
+            url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/applications`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: cliVersion,
                 ...injectedHeaders,
             },
         };
@@ -124,18 +129,30 @@ async function fetchApplications(token, superblocksBaseUrl, injectedHeaders = {}
         return response.data.data.applications;
     }
     catch (e) {
-        throw new Error("Could not fetch applications");
+        let message;
+        if (e instanceof axios_1.AxiosError) {
+            message =
+                (_j = (_h = (_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) !== null && _h !== void 0 ? _h : e === null || e === void 0 ? void 0 : e.message) !== null && _j !== void 0 ? _j : `${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 fetch applications: ${message}`);
     }
 }
 exports.fetchApplications = fetchApplications;
-async function fetchApi(apiId, token, superblocksBaseUrl, viewMode) {
+async function fetchApi(cliVersion, apiId, token, superblocksBaseUrl, viewMode, branch) {
     var _a;
     try {
+        const serverURL = branch
+            ? new URL(`${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}/branches/${encodeURIComponent(branch)}?viewMode=${viewMode}`, superblocksBaseUrl)
+            : new URL(`${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}?viewMode=${viewMode}`, superblocksBaseUrl);
         const config = {
             method: "get",
-            url: new URL(`/api/v3/apis/${apiId}?viewMode=${viewMode}`, superblocksBaseUrl).toString(),
+            url: new URL(serverURL, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: cliVersion,
             },
         };
         const response = await (0, axios_1.default)(config);
@@ -149,30 +166,28 @@ async function fetchApi(apiId, token, superblocksBaseUrl, viewMode) {
     }
 }
 exports.fetchApi = fetchApi;
-async function fetchApis(token, superblocksBaseUrl) {
+async function fetchApis(cliVersion, token, superblocksBaseUrl) {
     try {
         const config = {
             method: "get",
-            url: new URL(`/api/v3/apis`, superblocksBaseUrl).toString(),
+            url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/apis`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: cliVersion,
             },
         };
         const response = await (0, axios_1.default)(config);
-        return response.data.data;
+        return response.data.data.apis;
     }
     catch (e) {
         throw new Error("Could not fetch apis");
     }
 }
 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) {
+async function validateGitSetup(cliVersion, resourceId, 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,
@@ -180,7 +195,11 @@ resourceType, event, localGitRepoState, token, superblocksBaseUrl, injectedHeade
         let path;
         switch (resourceType) {
             case "APPLICATION": {
-                path = `/public/application/${resourceId}/validate-git-setup`;
+                path = `/application/${resourceId}/validate-git-setup`;
+                break;
+            }
+            case "BACKEND": {
+                path = `/api/${resourceId}/validate-git-setup`;
                 break;
             }
             default:
@@ -188,10 +207,10 @@ resourceType, event, localGitRepoState, token, superblocksBaseUrl, injectedHeade
         }
         const config = {
             method: "post",
-            url: new URL(`${BASE_SERVER_URL}/${path}`, superblocksBaseUrl).toString(),
+            url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/${path}`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
-                [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+                [CLI_VERSION_HEADER]: cliVersion,
                 ...injectedHeaders,
             },
             data: requestBody,
@@ -221,17 +240,16 @@ resourceType, event, localGitRepoState, token, superblocksBaseUrl, injectedHeade
     }
 }
 exports.validateGitSetup = validateGitSetup;
-async function registerComponents(applicationId, componentConfigs, token, superblocksBaseUrl, branch, injectedHeaders) {
+async function registerComponents(cliVersion, applicationId, componentConfigs, token, superblocksBaseUrl, branch, injectedHeaders) {
     var _a, _b, _c, _d, _e, _f, _g;
     try {
-        const [rootSettings] = await (0, util_1.getSuperblocksMonorepoConfigJson)(true);
         const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
         const config = {
             method: "put",
-            url: new URL(`${BASE_SERVER_URL}/public/application/${applicationId}${branchPath}/components`, superblocksBaseUrl).toString(),
+            url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/application/${applicationId}${branchPath}/components`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
-                [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+                [CLI_VERSION_HEADER]: cliVersion,
                 ...injectedHeaders,
             },
             data: { components: componentConfigs },
@@ -248,7 +266,7 @@ async function registerComponents(applicationId, componentConfigs, token, superb
     }
 }
 exports.registerComponents = registerComponents;
-async function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, branch, }) {
+async function uploadComponents({ cliVersion, applicationId, componentConfigs, files, token, superblocksBaseUrl, branch, }) {
     var _a, _b, _c, _d, _e, _f;
     superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
     const bucketeerBaseUrl = (0, util_1.getBucketeerUrlFromSuperblocksUrl)(superblocksBaseUrl);
@@ -293,11 +311,10 @@ You can reduce your component bundle size by uploading static assets to a separa
     }
     const formHeaders = formData.getHeaders();
     try {
-        const [rootSettings] = await (0, util_1.getSuperblocksMonorepoConfigJson)(true);
         const config = {
             headers: {
                 Authorization: "Bearer " + token,
-                [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+                [CLI_VERSION_HEADER]: cliVersion,
                 [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.UPLOAD,
                 [SUPERBLOCKS_URL_HEADER]: superblocksBaseUrl,
                 ...formHeaders,
@@ -313,10 +330,9 @@ You can reduce your component bundle size by uploading static assets to a separa
         else {
             let message;
             if (e instanceof axios_1.AxiosError) {
-                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);
+                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;
@@ -329,13 +345,15 @@ You can reduce your component bundle size by uploading static assets to a separa
     }
 }
 exports.uploadComponents = uploadComponents;
-async function fetchCurrentUser(token, superblocksBaseUrl) {
+async function fetchCurrentUser(cliVersion, token, superblocksBaseUrl) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     try {
         const config = {
             method: "get",
-            url: new URL(`/api/v1/users/me`, superblocksBaseUrl).toString(),
+            url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/users/me`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: cliVersion,
                 [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.LOGIN,
             },
         };
@@ -343,14 +361,21 @@ async function fetchCurrentUser(token, superblocksBaseUrl) {
         return response.data.data.user;
     }
     catch (e) {
-        throw new Error("Could not fetch current user");
+        let message;
+        if (e instanceof axios_1.AxiosError) {
+            message =
+                (_j = (_h = (_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) !== null && _h !== void 0 ? _h : e === null || e === void 0 ? void 0 : e.message) !== null && _j !== void 0 ? _j : `${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 fetch current user: ${message}`);
     }
 }
 exports.fetchCurrentUser = fetchCurrentUser;
-async function pushApplication({ applicationId, token, superblocksBaseUrl, applicationConfig, branch, injectedHeaders = {}, }) {
+async function pushApplication({ cliVersion, applicationId, token, superblocksBaseUrl, applicationConfig, branch, injectedHeaders = {}, }) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
-    const [rootSettings] = await (0, util_1.getSuperblocksMonorepoConfigJson)(true);
-    const serverURL = new URL(`${BASE_SERVER_URL}/public/applications/${applicationId}/branches/${encodeURIComponent(branch)}/push`, superblocksBaseUrl);
+    const serverURL = new URL(`${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}/branches/${encodeURIComponent(branch)}/push`, superblocksBaseUrl);
     let serverResponse;
     try {
         const config = {
@@ -358,7 +383,7 @@ async function pushApplication({ applicationId, token, superblocksBaseUrl, appli
             url: serverURL.toString(),
             headers: {
                 Authorization: "Bearer " + token,
-                [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+                [CLI_VERSION_HEADER]: cliVersion,
                 ...injectedHeaders,
             },
             data: applicationConfig,
@@ -382,3 +407,36 @@ async function pushApplication({ applicationId, token, superblocksBaseUrl, appli
     return (_o = serverResponse === null || serverResponse === void 0 ? void 0 : serverResponse.data) === null || _o === void 0 ? void 0 : _o.data;
 }
 exports.pushApplication = pushApplication;
+async function pushApi({ cliVersion, apiId, token, superblocksBaseUrl, apiConfig, branch, injectedHeaders = {}, }) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+    const serverURL = new URL(`${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}/branches/${encodeURIComponent(branch)}/push`, superblocksBaseUrl);
+    let serverResponse;
+    try {
+        const config = {
+            method: "post",
+            url: serverURL.toString(),
+            headers: {
+                Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: cliVersion,
+                ...injectedHeaders,
+            },
+            data: apiConfig,
+        };
+        serverResponse = await (0, axios_1.default)(config);
+    }
+    catch (e) {
+        if (axios_1.default.isAxiosError(e)) {
+            if (((_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) === 405) {
+                throw new errors_1.BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
+            }
+            else if (((_f = (_e = (_d = e.response) === null || _d === void 0 ? void 0 : _d.data) === null || _e === void 0 ? void 0 : _e.responseMeta) === null || _f === void 0 ? void 0 : _f.status) === 409) {
+                throw new errors_1.CommitAlreadyExistsError(`Commit ${apiConfig.commitId} already exists`);
+            }
+            const message = (_m = (_k = (_j = (_h = (_g = e.response) === null || _g === void 0 ? void 0 : _g.data) === null || _h === void 0 ? void 0 : _h.responseMeta) === null || _j === void 0 ? void 0 : _j.message) !== null && _k !== void 0 ? _k : JSON.stringify((_l = e.response) === null || _l === void 0 ? void 0 : _l.data)) !== null && _m !== void 0 ? _m : (_o = e.response) === null || _o === void 0 ? void 0 : _o.statusText;
+            throw new Error(`Could not push api ${message ? "\n" + message : ""}`);
+        }
+        throw new Error(`Could not push api ${e.message ? "\n" + e.message : ""}`);
+    }
+    return (_p = serverResponse === null || serverResponse === void 0 ? void 0 : serverResponse.data) === null || _p === void 0 ? void 0 : _p.data;
+}
+exports.pushApi = pushApi;

package/dist/sdk.d.ts CHANGED Viewed

@@ -1,10 +1,11 @@
 import { ComponentEvent, LocalGitRepoState, SuperblocksResourceType } from "@superblocksteam/util";
-import { ViewMode, PushApplicationWithCommitConfig } from "./client";
+import { ViewMode, PushApplicationWithCommitConfig, PushApiWithCommitConfig } from "./client";
 export * from "./errors";
 export declare class SuperblocksSdk {
     token: string;
     superblocksBaseUrl: string;
-    constructor(accessToken: string, superblocksBaseUrl: string);
+    cliVersion: string;
+    constructor(accessToken: string, superblocksBaseUrl: string, cliVersion: string);
     fetchApplication({ applicationId, branch, headers, viewMode, }: {
         applicationId: string;
         branch?: string;
@@ -21,9 +22,9 @@ export declare class SuperblocksSdk {
         componentFiles: any;
     }) | undefined>;
     fetchApplications(headers?: Record<string, string>): Promise<any>;
-    fetchApi(apiId: string, viewMode?: ViewMode): Promise<any>;
+    fetchApi(apiId: string, viewMode?: ViewMode, branch?: string): Promise<any>;
     fetchApis(): Promise<any>;
-    validateGitSetup(resourceId: string, resourceType: Exclude<SuperblocksResourceType, "BACKEND">, event: ComponentEvent, localGitRepoState: LocalGitRepoState, injectedHeaders?: Record<string, string>): Promise<{
+    validateGitSetup(resourceId: string, resourceType: SuperblocksResourceType, 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>;
@@ -35,4 +36,12 @@ export declare class SuperblocksSdk {
         branch: string;
         headers?: Record<string, string>;
     }): Promise<import("./client").ApplicationWrapper | undefined>;
+    pushApi({ apiId, apiConfig, branch, headers, }: {
+        apiId: string;
+        apiConfig: PushApiWithCommitConfig;
+        branch: string;
+        headers?: Record<string, string>;
+    }): Promise<{
+        commitId: string;
+    } | undefined>;
 }

package/dist/sdk.js CHANGED Viewed

@@ -6,14 +6,17 @@ 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) {
+    constructor(accessToken, superblocksBaseUrl, cliVersion) {
         this.token = "";
         this.superblocksBaseUrl = "";
+        this.cliVersion = "";
         this.token = accessToken;
         this.superblocksBaseUrl = superblocksBaseUrl;
+        this.cliVersion = cliVersion;
     }
     async fetchApplication({ applicationId, branch, headers = {}, viewMode = "export-live", }) {
         return (0, client_1.fetchApplication)({
+            cliVersion: this.cliVersion,
             applicationId,
             branch,
             token: this.token,
@@ -24,6 +27,7 @@ class SuperblocksSdk {
     }
     async fetchApplicationBranches(applicationId, headers = {}) {
         return (0, client_1.fetchApplicationBranches)({
+            cliVersion: this.cliVersion,
             applicationId,
             token: this.token,
             superblocksBaseUrl: this.superblocksBaseUrl,
@@ -32,6 +36,7 @@ class SuperblocksSdk {
     }
     async fetchApplicationWithComponents({ applicationId, branch, headers = {}, viewMode = "export-live", }) {
         return (0, client_1.fetchApplicationWithComponents)({
+            cliVersion: this.cliVersion,
             applicationId,
             branch,
             token: this.token,
@@ -41,24 +46,23 @@ class SuperblocksSdk {
         });
     }
     async fetchApplications(headers) {
-        return (0, client_1.fetchApplications)(this.token, this.superblocksBaseUrl, headers);
+        return (0, client_1.fetchApplications)(this.cliVersion, this.token, this.superblocksBaseUrl, headers);
     }
-    async fetchApi(apiId, viewMode = "export-live") {
-        return (0, client_1.fetchApi)(apiId, this.token, this.superblocksBaseUrl, viewMode);
+    async fetchApi(apiId, viewMode = "export-live", branch) {
+        return (0, client_1.fetchApi)(this.cliVersion, apiId, this.token, this.superblocksBaseUrl, viewMode, branch);
     }
     async fetchApis() {
-        return (0, client_1.fetchApis)(this.token, this.superblocksBaseUrl);
+        return (0, client_1.fetchApis)(this.cliVersion, 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 validateGitSetup(resourceId, resourceType, event, localGitRepoState, injectedHeaders) {
+        return (0, client_1.validateGitSetup)(this.cliVersion, 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);
+        return (0, client_1.registerComponents)(this.cliVersion, applicationId, componentConfigs, this.token, this.superblocksBaseUrl, branch, injectedHeaders);
     }
     async uploadComponents(applicationId, componentConfigs, files, branch) {
         return (0, client_1.uploadComponents)({
+            cliVersion: this.cliVersion,
             applicationId,
             componentConfigs,
             files,
@@ -68,10 +72,11 @@ class SuperblocksSdk {
         });
     }
     async fetchCurrentUser() {
-        return (0, client_1.fetchCurrentUser)(this.token, this.superblocksBaseUrl);
+        return (0, client_1.fetchCurrentUser)(this.cliVersion, this.token, this.superblocksBaseUrl);
     }
     async pushApplication({ applicationId, applicationConfig, branch, headers = {}, }) {
         return (0, client_1.pushApplication)({
+            cliVersion: this.cliVersion,
             applicationId,
             token: this.token,
             superblocksBaseUrl: this.superblocksBaseUrl,
@@ -80,5 +85,16 @@ class SuperblocksSdk {
             applicationConfig,
         });
     }
+    async pushApi({ apiId, apiConfig, branch, headers = {}, }) {
+        return (0, client_1.pushApi)({
+            cliVersion: this.cliVersion,
+            apiId,
+            apiConfig,
+            token: this.token,
+            superblocksBaseUrl: this.superblocksBaseUrl,
+            branch,
+            injectedHeaders: headers,
+        });
+    }
 }
 exports.SuperblocksSdk = SuperblocksSdk;

package/package.json CHANGED Viewed

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

package/src/client.ts CHANGED Viewed

@@ -2,7 +2,6 @@ import * as fs from "fs";
 import {
   ComponentEvent,
   getBucketeerUrlFromSuperblocksUrl,
-  getSuperblocksMonorepoConfigJson,
   getContentType,
   COMPONENT_EVENT_HEADER,
   NotFoundError,
@@ -16,8 +15,8 @@ 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";
+const BASE_SERVER_PUBLIC_API_URL = "api/v1/public";
 const SUPERBLOCKS_MAX_FILE_SIZE_MB = 10;
@@ -43,6 +42,17 @@ export type PushApplicationWithCommitConfig = ApplicationWrapper & {
   commitMessage: string;
 };
+export interface ApiWrapper {
+  apiPb: Record<string, any>;
+  name?: string; //@deprecated this attribute is used for getting a name for backends(jobs and workflows) that were never migrated to the new API version.
+}
+export type PushApiWithCommitConfig = {
+  apiPb: Record<string, any>;
+  commitId: string;
+  commitMessage: string;
+};
 export type Branches = {
   branches: Branch[];
 };
@@ -55,6 +65,7 @@ export type Branch = {
 type ResponseWithMeta<T> = { responseMeta: unknown; data: T };
 export async function fetchApplication({
+  cliVersion,
   applicationId,
   branch,
   token,
@@ -62,6 +73,7 @@ export async function fetchApplication({
   viewMode,
   injectedHeaders = {},
 }: {
+  cliVersion: string;
   applicationId: string;
   branch?: string;
   token: string;
@@ -71,11 +83,13 @@ export async function fetchApplication({
 }): Promise<ApplicationWrapper | undefined> {
   const serverURL = branch
     ? new URL(
-        `api/v2/applications/${applicationId}/branches/${branch}?viewMode=${viewMode}`,
+        `${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}/branches/${encodeURIComponent(
+          branch
+        )}?viewMode=${viewMode}`,
         superblocksBaseUrl
       )
     : new URL(
-        `api/v2/applications/${applicationId}?viewMode=${viewMode}`,
+        `${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}?viewMode=${viewMode}`,
         superblocksBaseUrl
       );
@@ -87,6 +101,7 @@ export async function fetchApplication({
       url: serverURL.toString(),
       headers: {
         Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
         ...injectedHeaders,
       },
     };
@@ -102,18 +117,20 @@ export async function fetchApplication({
 }
 export async function fetchApplicationBranches({
+  cliVersion,
   applicationId,
   token,
   superblocksBaseUrl,
   injectedHeaders = {},
 }: {
+  cliVersion: string;
   applicationId: string;
   token: string;
   superblocksBaseUrl: string;
   injectedHeaders: Record<string, string>;
 }): Promise<Branches | undefined> {
   const serverURL = new URL(
-    `api/v2/applications/${applicationId}/branches`,
+    `public/applications/${applicationId}/branches`,
     superblocksBaseUrl
   );
   let serverResponse;
@@ -124,6 +141,7 @@ export async function fetchApplicationBranches({
       url: serverURL.toString(),
       headers: {
         Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
         ...injectedHeaders,
       },
     };
@@ -139,6 +157,7 @@ export async function fetchApplicationBranches({
 }
 export async function fetchApplicationWithComponents({
+  cliVersion,
   applicationId,
   branch,
   token,
@@ -146,6 +165,7 @@ export async function fetchApplicationWithComponents({
   viewMode,
   injectedHeaders = {},
 }: {
+  cliVersion: string;
   applicationId: string;
   branch: string;
   token: string;
@@ -154,6 +174,7 @@ export async function fetchApplicationWithComponents({
   injectedHeaders: Record<string, string>;
 }): Promise<(ApplicationWrapper & { componentFiles: any }) | undefined> {
   const applicationWrapper = await fetchApplication({
+    cliVersion,
     applicationId,
     branch,
     token,
@@ -208,6 +229,7 @@ export async function fetchApplicationWithComponents({
 }
 export async function fetchApplications(
+  cliVersion: string,
   token: string,
   superblocksBaseUrl: string,
   injectedHeaders: Record<string, string> = {}
@@ -215,34 +237,61 @@ export async function fetchApplications(
   try {
     const config: AxiosRequestConfig = {
       method: "get",
-      url: new URL(`/api/v2/applications`, superblocksBaseUrl).toString(),
+      url: new URL(
+        `${BASE_SERVER_PUBLIC_API_URL}/applications`,
+        superblocksBaseUrl
+      ).toString(),
       headers: {
         Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
         ...injectedHeaders,
       },
     };
     const response = await axios(config);
     return response.data.data.applications;
-  } catch (e) {
-    throw new Error("Could not fetch applications");
+  } 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 fetch applications: ${message}`);
   }
 }
 export async function fetchApi(
+  cliVersion: string,
   apiId: string,
   token: string,
   superblocksBaseUrl: string,
-  viewMode: ViewMode
+  viewMode: ViewMode,
+  branch?: string
 ) {
   try {
+    const serverURL = branch
+      ? new URL(
+          `${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}/branches/${encodeURIComponent(
+            branch
+          )}?viewMode=${viewMode}`,
+          superblocksBaseUrl
+        )
+      : new URL(
+          `${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}?viewMode=${viewMode}`,
+          superblocksBaseUrl
+        );
     const config: AxiosRequestConfig = {
       method: "get",
-      url: new URL(
-        `/api/v3/apis/${apiId}?viewMode=${viewMode}`,
-        superblocksBaseUrl
-      ).toString(),
+      url: new URL(serverURL, superblocksBaseUrl).toString(),
       headers: {
         Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
       },
     };
     const response = await axios(config);
@@ -255,26 +304,34 @@ export async function fetchApi(
   }
 }
-export async function fetchApis(token: string, superblocksBaseUrl: string) {
+export async function fetchApis(
+  cliVersion: string,
+  token: string,
+  superblocksBaseUrl: string
+) {
   try {
     const config: AxiosRequestConfig = {
       method: "get",
-      url: new URL(`/api/v3/apis`, superblocksBaseUrl).toString(),
+      url: new URL(
+        `${BASE_SERVER_PUBLIC_API_URL}/apis`,
+        superblocksBaseUrl
+      ).toString(),
       headers: {
         Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
       },
     };
     const response = await axios(config);
-    return response.data.data;
+    return response.data.data.apis;
   } catch (e) {
     throw new Error("Could not fetch apis");
   }
 }
 export async function validateGitSetup(
+  cliVersion: string,
   resourceId: string,
-  // TODO: change the type to `SuperblocksResourceType` once we support other resource types
-  resourceType: Exclude<SuperblocksResourceType, "BACKEND">,
+  resourceType: SuperblocksResourceType,
   event: ComponentEvent,
   localGitRepoState: LocalGitRepoState,
   token: string,
@@ -283,7 +340,6 @@ export async function validateGitSetup(
 ) {
   let resourceName: string | undefined;
   try {
-    const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
     const requestBody: ValidateGitSetupRequestBody = {
       event,
       gitState: localGitRepoState,
@@ -291,7 +347,11 @@ export async function validateGitSetup(
     let path: string;
     switch (resourceType) {
       case "APPLICATION": {
-        path = `/public/application/${resourceId}/validate-git-setup`;
+        path = `/application/${resourceId}/validate-git-setup`;
+        break;
+      }
+      case "BACKEND": {
+        path = `/api/${resourceId}/validate-git-setup`;
         break;
       }
       default:
@@ -299,10 +359,13 @@ export async function validateGitSetup(
     }
     const config: AxiosRequestConfig = {
       method: "post",
-      url: new URL(`${BASE_SERVER_URL}/${path}`, superblocksBaseUrl).toString(),
+      url: new URL(
+        `${BASE_SERVER_PUBLIC_API_URL}/${path}`,
+        superblocksBaseUrl
+      ).toString(),
       headers: {
         Authorization: "Bearer " + token,
-        [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+        [CLI_VERSION_HEADER]: cliVersion,
         ...injectedHeaders,
       },
       data: requestBody,
@@ -339,6 +402,7 @@ export async function validateGitSetup(
 }
 export async function registerComponents(
+  cliVersion: string,
   applicationId: string,
   componentConfigs: Record<string, any>,
   token: string,
@@ -347,17 +411,16 @@ export async function registerComponents(
   injectedHeaders?: Record<string, string>
 ) {
   try {
-    const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
     const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
     const config: AxiosRequestConfig = {
       method: "put",
       url: new URL(
-        `${BASE_SERVER_URL}/public/application/${applicationId}${branchPath}/components`,
+        `${BASE_SERVER_PUBLIC_API_URL}/application/${applicationId}${branchPath}/components`,
         superblocksBaseUrl
       ).toString(),
       headers: {
         Authorization: "Bearer " + token,
-        [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+        [CLI_VERSION_HEADER]: cliVersion,
         ...injectedHeaders,
       },
       data: { components: componentConfigs },
@@ -385,6 +448,7 @@ export async function registerComponents(
 }
 export async function uploadComponents({
+  cliVersion,
   applicationId,
   componentConfigs,
   files,
@@ -392,6 +456,7 @@ export async function uploadComponents({
   superblocksBaseUrl,
   branch,
 }: {
+  cliVersion: string;
   applicationId: string;
   componentConfigs: Record<string, any>;
   files: string[];
@@ -455,11 +520,10 @@ You can reduce your component bundle size by uploading static assets to a separa
   const formHeaders = formData.getHeaders();
   try {
-    const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
     const config: AxiosRequestConfig = {
       headers: {
         Authorization: "Bearer " + token,
-        [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+        [CLI_VERSION_HEADER]: cliVersion,
         [COMPONENT_EVENT_HEADER]: ComponentEvent.UPLOAD,
         [SUPERBLOCKS_URL_HEADER]: superblocksBaseUrl,
         ...formHeaders,
@@ -477,10 +541,9 @@ You can reduce your component bundle size by uploading static assets to a separa
     } else {
       let message: string;
       if (e instanceof AxiosError) {
-        message =
-          e.response?.data?.responseMeta?.message ||
+        message = (e.response?.data?.responseMeta?.message ||
           e.response?.data ||
-          e.response?.statusText;
+          e.response?.statusText) as string;
       } else {
         message = e.message as string;
       }
@@ -493,26 +556,43 @@ You can reduce your component bundle size by uploading static assets to a separa
 }
 export async function fetchCurrentUser(
+  cliVersion: string,
   token: string,
   superblocksBaseUrl: string
 ) {
   try {
     const config: AxiosRequestConfig = {
       method: "get",
-      url: new URL(`/api/v1/users/me`, superblocksBaseUrl).toString(),
+      url: new URL(
+        `${BASE_SERVER_PUBLIC_API_URL}/users/me`,
+        superblocksBaseUrl
+      ).toString(),
       headers: {
         Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
         [COMPONENT_EVENT_HEADER]: ComponentEvent.LOGIN,
       },
     };
     const response = await axios(config);
     return response.data.data.user;
-  } catch (e) {
-    throw new Error("Could not fetch current user");
+  } 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 fetch current user: ${message}`);
   }
 }
 export async function pushApplication({
+  cliVersion,
   applicationId,
   token,
   superblocksBaseUrl,
@@ -520,6 +600,7 @@ export async function pushApplication({
   branch,
   injectedHeaders = {},
 }: {
+  cliVersion: string;
   applicationId: string;
   token: string;
   superblocksBaseUrl: string;
@@ -527,9 +608,8 @@ export async function pushApplication({
   injectedHeaders: Record<string, string>;
   applicationConfig: PushApplicationWithCommitConfig;
 }): Promise<ApplicationWrapper | undefined> {
-  const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
   const serverURL = new URL(
-    `${BASE_SERVER_URL}/public/applications/${applicationId}/branches/${encodeURIComponent(
+    `${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}/branches/${encodeURIComponent(
       branch
     )}/push`,
     superblocksBaseUrl
@@ -542,7 +622,7 @@ export async function pushApplication({
       url: serverURL.toString(),
       headers: {
         Authorization: "Bearer " + token,
-        [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+        [CLI_VERSION_HEADER]: cliVersion,
         ...injectedHeaders,
       },
       data: applicationConfig,
@@ -579,3 +659,70 @@ export async function pushApplication({
   return serverResponse?.data?.data;
 }
+export async function pushApi({
+  cliVersion,
+  apiId,
+  token,
+  superblocksBaseUrl,
+  apiConfig,
+  branch,
+  injectedHeaders = {},
+}: {
+  cliVersion: string;
+  apiId: string;
+  token: string;
+  superblocksBaseUrl: string;
+  apiConfig: PushApiWithCommitConfig;
+  branch: string;
+  injectedHeaders: Record<string, string>;
+}): Promise<{ commitId: string } | undefined> {
+  const serverURL = new URL(
+    `${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}/branches/${encodeURIComponent(
+      branch
+    )}/push`,
+    superblocksBaseUrl
+  );
+  let serverResponse;
+  try {
+    const config: AxiosRequestConfig = {
+      method: "post",
+      url: serverURL.toString(),
+      headers: {
+        Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
+        ...injectedHeaders,
+      },
+      data: apiConfig,
+    };
+    serverResponse = await axios<ResponseWithMeta<{ commitId: string }>>(
+      config
+    );
+  } catch (e) {
+    if (axios.isAxiosError(e)) {
+      if (e.response?.data?.responseMeta?.status === 405) {
+        throw new BranchNotCheckedOutError(
+          `Branch ${branch} is not checked out`
+        );
+      } else if (e.response?.data?.responseMeta?.status === 409) {
+        throw new CommitAlreadyExistsError(
+          `Commit ${apiConfig.commitId} already exists`
+        );
+      }
+      const message: string =
+        (e.response?.data?.responseMeta?.message as string) ??
+        JSON.stringify(e.response?.data) ??
+        e.response?.statusText;
+      throw new Error(`Could not push api ${message ? "\n" + message : ""}`);
+    }
+    throw new Error(
+      `Could not push api ${
+        (e as Error).message ? "\n" + (e as Error).message : ""
+      }`
+    );
+  }
+  return serverResponse?.data?.data;
+}

package/src/sdk.ts CHANGED Viewed

@@ -16,6 +16,8 @@ import {
   pushApplication,
   PushApplicationWithCommitConfig,
   fetchApplicationBranches,
+  PushApiWithCommitConfig,
+  pushApi,
   validateGitSetup,
 } from "./client";
@@ -25,10 +27,16 @@ export * from "./errors";
 export class SuperblocksSdk {
   token = "";
   superblocksBaseUrl = "";
+  cliVersion = "";
-  constructor(accessToken: string, superblocksBaseUrl: string) {
+  constructor(
+    accessToken: string,
+    superblocksBaseUrl: string,
+    cliVersion: string
+  ) {
     this.token = accessToken;
     this.superblocksBaseUrl = superblocksBaseUrl;
+    this.cliVersion = cliVersion;
   }
   async fetchApplication({
@@ -43,6 +51,7 @@ export class SuperblocksSdk {
     viewMode?: ViewMode;
   }) {
     return fetchApplication({
+      cliVersion: this.cliVersion,
       applicationId,
       branch,
       token: this.token,
@@ -54,6 +63,7 @@ export class SuperblocksSdk {
   async fetchApplicationBranches(applicationId: string, headers = {}) {
     return fetchApplicationBranches({
+      cliVersion: this.cliVersion,
       applicationId,
       token: this.token,
       superblocksBaseUrl: this.superblocksBaseUrl,
@@ -73,6 +83,7 @@ export class SuperblocksSdk {
     viewMode?: ViewMode;
   }) {
     return fetchApplicationWithComponents({
+      cliVersion: this.cliVersion,
       applicationId,
       branch,
       token: this.token,
@@ -83,26 +94,42 @@ export class SuperblocksSdk {
   }
   async fetchApplications(headers?: Record<string, string>) {
-    return fetchApplications(this.token, this.superblocksBaseUrl, headers);
+    return fetchApplications(
+      this.cliVersion,
+      this.token,
+      this.superblocksBaseUrl,
+      headers
+    );
   }
-  async fetchApi(apiId: string, viewMode: ViewMode = "export-live") {
-    return fetchApi(apiId, this.token, this.superblocksBaseUrl, viewMode);
+  async fetchApi(
+    apiId: string,
+    viewMode: ViewMode = "export-live",
+    branch?: string
+  ) {
+    return fetchApi(
+      this.cliVersion,
+      apiId,
+      this.token,
+      this.superblocksBaseUrl,
+      viewMode,
+      branch
+    );
   }
   async fetchApis() {
-    return fetchApis(this.token, this.superblocksBaseUrl);
+    return fetchApis(this.cliVersion, this.token, this.superblocksBaseUrl);
   }
   async validateGitSetup(
     resourceId: string,
-    // TODO: change the type to `SuperblocksResourceType` once we support other resource types
-    resourceType: Exclude<SuperblocksResourceType, "BACKEND">,
+    resourceType: SuperblocksResourceType,
     event: ComponentEvent,
     localGitRepoState: LocalGitRepoState,
     injectedHeaders?: Record<string, string>
   ) {
     return validateGitSetup(
+      this.cliVersion,
       resourceId,
       resourceType,
       event,
@@ -120,6 +147,7 @@ export class SuperblocksSdk {
     injectedHeaders?: Record<string, string>
   ) {
     return registerComponents(
+      this.cliVersion,
       applicationId,
       componentConfigs,
       this.token,
@@ -136,6 +164,7 @@ export class SuperblocksSdk {
     branch: string | null
   ) {
     return uploadComponents({
+      cliVersion: this.cliVersion,
       applicationId,
       componentConfigs,
       files,
@@ -146,7 +175,11 @@ export class SuperblocksSdk {
   }
   async fetchCurrentUser() {
-    return fetchCurrentUser(this.token, this.superblocksBaseUrl);
+    return fetchCurrentUser(
+      this.cliVersion,
+      this.token,
+      this.superblocksBaseUrl
+    );
   }
   async pushApplication({
@@ -161,6 +194,7 @@ export class SuperblocksSdk {
     headers?: Record<string, string>;
   }) {
     return pushApplication({
+      cliVersion: this.cliVersion,
       applicationId,
       token: this.token,
       superblocksBaseUrl: this.superblocksBaseUrl,
@@ -169,4 +203,25 @@ export class SuperblocksSdk {
       applicationConfig,
     });
   }
+  async pushApi({
+    apiId,
+    apiConfig,
+    branch,
+    headers = {},
+  }: {
+    apiId: string;
+    apiConfig: PushApiWithCommitConfig;
+    branch: string;
+    headers?: Record<string, string>;
+  }) {
+    return pushApi({
+      cliVersion: this.cliVersion,
+      apiId,
+      apiConfig,
+      token: this.token,
+      superblocksBaseUrl: this.superblocksBaseUrl,
+      branch,
+      injectedHeaders: headers,
+    });
+  }
 }