@superblocksteam/sdk 1.3.1 → 1.4.1

package/.eslintrc.json

@@ -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

@@ -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[];
 };
@@ -48,7 +57,7 @@ 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<{
+export declare function validateGitSetup(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>;
@@ -69,3 +78,13 @@ export declare function pushApplication({ applicationId, token, superblocksBaseU
     injectedHeaders: Record<string, string>;
     applicationConfig: PushApplicationWithCommitConfig;
 }): Promise<ApplicationWrapper | undefined>;
+export declare function pushApi({ apiId, token, superblocksBaseUrl, apiConfig, branch, injectedHeaders, }: {
+    apiId: string;
+    token: string;
+    superblocksBaseUrl: string;
+    apiConfig: PushApiWithCommitConfig;
+    branch: string;
+    injectedHeaders: Record<string, string>;
+}): Promise<{
+    commitId: string;
+} | undefined>;

package/dist/client.js

@@ -1,6 +1,6 @@
 "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");
@@ -166,9 +166,7 @@ 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) {
+async function validateGitSetup(resourceId, resourceType, event, localGitRepoState, token, superblocksBaseUrl, injectedHeaders) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
     let resourceName;
     try {
@@ -183,6 +181,10 @@ resourceType, event, localGitRepoState, token, superblocksBaseUrl, injectedHeade
                 path = `/public/application/${resourceId}/validate-git-setup`;
                 break;
             }
+            case "BACKEND": {
+                path = `/public/api/${resourceId}/validate-git-setup`;
+                break;
+            }
             default:
                 (0, util_1.unreachable)(resourceType);
         }
@@ -313,10 +315,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;
@@ -382,3 +383,37 @@ 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({ apiId, token, superblocksBaseUrl, apiConfig, branch, injectedHeaders = {}, }) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+    const [rootSettings] = await (0, util_1.getSuperblocksMonorepoConfigJson)(true);
+    const serverURL = new URL(`${BASE_SERVER_URL}/public/apis/${apiId}/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: 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

@@ -1,5 +1,5 @@
 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;
@@ -23,7 +23,7 @@ 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<{
+    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 +35,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

@@ -49,9 +49,7 @@ 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) {
+    async validateGitSetup(resourceId, resourceType, event, localGitRepoState, injectedHeaders) {
         return (0, client_1.validateGitSetup)(resourceId, resourceType, event, localGitRepoState, this.token, this.superblocksBaseUrl, injectedHeaders);
     }
     async registerComponents(applicationId, componentConfigs, branch, injectedHeaders) {
@@ -80,5 +78,15 @@ class SuperblocksSdk {
             applicationConfig,
         });
     }
+    async pushApi({ apiId, apiConfig, branch, headers = {}, }) {
+        return (0, client_1.pushApi)({
+            apiId,
+            apiConfig,
+            token: this.token,
+            superblocksBaseUrl: this.superblocksBaseUrl,
+            branch,
+            injectedHeaders: headers,
+        });
+    }
 }
 exports.SuperblocksSdk = SuperblocksSdk;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "1.3.1",
+  "version": "1.4.1",
   "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.1",
     "axios": "^1.3.5"
   },
   "homepage": "https://www.superblocks.com",

package/src/client.ts

@@ -43,6 +43,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[];
 };
@@ -273,8 +284,7 @@ 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">,
+  resourceType: SuperblocksResourceType,
   event: ComponentEvent,
   localGitRepoState: LocalGitRepoState,
   token: string,
@@ -294,6 +304,10 @@ export async function validateGitSetup(
         path = `/public/application/${resourceId}/validate-git-setup`;
         break;
       }
+      case "BACKEND": {
+        path = `/public/api/${resourceId}/validate-git-setup`;
+        break;
+      }
       default:
         unreachable(resourceType);
     }
@@ -477,10 +491,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;
       }
@@ -579,3 +592,69 @@ export async function pushApplication({
 
   return serverResponse?.data?.data;
 }
+
+export async function pushApi({
+  apiId,
+  token,
+  superblocksBaseUrl,
+  apiConfig,
+  branch,
+  injectedHeaders = {},
+}: {
+  apiId: string;
+  token: string;
+  superblocksBaseUrl: string;
+  apiConfig: PushApiWithCommitConfig;
+  branch: string;
+  injectedHeaders: Record<string, string>;
+}): Promise<{ commitId: string } | undefined> {
+  const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
+  const serverURL = new URL(
+    `${BASE_SERVER_URL}/public/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]: rootSettings.metadata.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

@@ -16,6 +16,8 @@ import {
   pushApplication,
   PushApplicationWithCommitConfig,
   fetchApplicationBranches,
+  PushApiWithCommitConfig,
+  pushApi,
   validateGitSetup,
 } from "./client";
 
@@ -96,8 +98,7 @@ export class SuperblocksSdk {
 
   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>
@@ -169,4 +170,24 @@ export class SuperblocksSdk {
       applicationConfig,
     });
   }
+  async pushApi({
+    apiId,
+    apiConfig,
+    branch,
+    headers = {},
+  }: {
+    apiId: string;
+    apiConfig: PushApiWithCommitConfig;
+    branch: string;
+    headers?: Record<string, string>;
+  }) {
+    return pushApi({
+      apiId,
+      apiConfig,
+      token: this.token,
+      superblocksBaseUrl: this.superblocksBaseUrl,
+      branch,
+      injectedHeaders: headers,
+    });
+  }
 }