@superblocksteam/sdk 1.9.3 → 1.11.0

package/dist/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSanitizedApi = exports.sanitizeV2RequestBody = exports.getAgentUrl = void 0;
+exports.getSanitizedApi = exports.sanitizeV2RequestBody = void 0;
+exports.getAgentUrl = getAgentUrl;
 const tslib_1 = require("tslib");
 const axios_1 = tslib_1.__importDefault(require("axios"));
 const types_1 = require("./types");
@@ -28,7 +29,7 @@ async function getAgentUrl(agents, agentType, profile, healthCheck = true) {
         try {
             return await Promise.any(coroutines);
         }
-        catch (e) {
+        catch {
             throw new Error("No available agents");
         }
     }
@@ -37,7 +38,6 @@ async function getAgentUrl(agents, agentType, profile, healthCheck = true) {
         return filtered[randomIndex].url;
     }
 }
-exports.getAgentUrl = getAgentUrl;
 const sanitizeV2RequestBody = (apiBody) => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const traverseJSON = (obj) => {

package/package.json

@@ -1,43 +1,49 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "1.9.3",
+  "version": "1.11.0",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {
     ".": {
-      "import": "./dist/sdk.js",
-      "require": "./dist/sdk.js",
-      "types": "./dist/sdk.d.ts"
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
     }
   },
   "types": "./dist/index.d.ts",
-  "scripts": {
-    "dev": "tsc --watch",
-    "build": "tsc --build",
-    "clean": "npm run clean:build && rm -rf node_modules",
-    "clean:build": "tsc --build --clean && rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint . --ext .ts --config .eslintrc.json",
-    "lint:fix": "eslint . --ext .ts --config .eslintrc.json --fix",
-    "typecheck": "tsc --noEmit"
-  },
   "license": "Superblocks Community Software License",
   "devDependencies": {
+    "@types/lodash": "^4.17.7",
+    "@types/node": "^20.11.22",
     "@types/ws": "^8.5.10",
     "@typescript-eslint/eslint-plugin": "^5.60.1",
     "@typescript-eslint/parser": "^5.60.1",
     "eslint": "^8.48.0",
     "eslint-plugin-unicorn": "^47.0.0",
     "prettier": "^2.8.8",
+    "tslib": "^2.5.0",
     "typescript": "^5.1.3"
   },
   "dependencies": {
-    "@superblocksteam/util": "1.9.3",
     "axios": "^1.3.5",
-    "ws": "^8.17.0"
+    "form-data": "^4.0.0",
+    "lodash": "^4.17.21",
+    "ws": "^8.17.0",
+    "@superblocksteam/util": "1.11.0"
   },
   "homepage": "https://www.superblocks.com",
   "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=8.0.0"
+    "node": ">=20.0.0",
+    "npm": ">=9.0.0"
+  },
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "tsc --build",
+    "clean": "npm run clean:build && rm -rf node_modules",
+    "clean:build": "tsc --build --clean && rm -rf dist tsconfig.tsbuildinfo",
+    "lint": "eslint . --ext .ts --config .eslintrc.json",
+    "lint:fix": "eslint . --ext .ts --config .eslintrc.json --fix",
+    "typecheck": "tsc --noEmit",
+    "check": "pnpm run lint && pnpm run typecheck"
   }
-}
+}

package/src/client.ts

@@ -22,6 +22,7 @@ import { signingEnabled } from "./flag";
 import { connectToISocketRPCServer, StdISocketRPCClient } from "./socket";
 import {
   AgentType,
+  Api,
   ApiWithPb,
   Page,
   RemoteCommitDto,
@@ -68,7 +69,7 @@ export type PushMultiPageApplicationWithCommitConfig =
   };
 
 export interface ApiWrapper {
-  apiPb: Record<string, any>;
+  apiPb: Api;
   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.
 }
 
@@ -134,20 +135,20 @@ export async function fetchApplication({
 }): Promise<MultiPageApplicationWrapper | undefined> {
   if (commitId && viewMode !== "export-commit") {
     throw new Error(
-      `If commitId ${commitId} is provided, viewMode cannot be ${viewMode}`
+      `If commitId ${commitId} is provided, viewMode cannot be ${viewMode}`,
     );
   }
   try {
     const serverURL = branch
       ? new URL(
           `${BASE_SERVER_PUBLIC_API_URL_v2}/applications/${applicationId}/branches/${encodeURIComponent(
-            branch
+            branch,
           )}`,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         )
       : new URL(
           `${BASE_SERVER_PUBLIC_API_URL_v2}/applications/${applicationId}`,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         );
     serverURL.search = new URLSearchParams({
       viewMode,
@@ -157,7 +158,7 @@ export async function fetchApplication({
       ? await createSocketConnectionIfNeeded(
           cliVersion,
           token,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         )
       : undefined;
     if (socket) {
@@ -182,9 +183,8 @@ export async function fetchApplication({
         ...injectedHeaders,
       },
     };
-    const serverResponse = await axios<
-      ResponseWithMeta<MultiPageApplicationWrapper>
-    >(config);
+    const serverResponse =
+      await axios<ResponseWithMeta<MultiPageApplicationWrapper>>(config);
     const data = serverResponse?.data?.data;
     return data;
   } catch (e) {
@@ -194,7 +194,7 @@ export async function fetchApplication({
     throw new Error(
       `Could not fetch application: ${
         typeof e === "object" && e && "message" in e ? e.message : e
-      }`
+      }`,
     );
   }
 }
@@ -214,7 +214,7 @@ export async function fetchApplicationBranches({
 }): Promise<Branches | undefined> {
   const serverURL = new URL(
     `public/applications/${applicationId}/branches`,
-    superblocksBaseUrl
+    superblocksBaseUrl,
   );
   let serverResponse;
 
@@ -296,7 +296,7 @@ export async function fetchApplicationWithComponents({
   const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
   const componentFileURL = new URL(
     `${BASE_BUCKETEER_URL}/v1/components/${applicationId}${branchPath}?commit=${commitId}&viewMode=${viewMode}&multiPage=true`,
-    bucketeerBaseUrl
+    bucketeerBaseUrl,
   ).toString();
 
   try {
@@ -317,11 +317,11 @@ export async function fetchApplicationWithComponents({
     if (
       !isEqual(
         applicationWrapper.application.settings,
-        bucketeerApp.application.settings
+        bucketeerApp.application.settings,
       )
     ) {
       throw new Error(
-        "Application settings fetched from bucketeer do not match the settings fetched from the server"
+        "Application settings fetched from bucketeer do not match the settings fetched from the server",
       );
     }
 
@@ -338,14 +338,14 @@ export async function fetchApplications(
   cliVersion: string,
   token: string,
   superblocksBaseUrl: string,
-  injectedHeaders: Record<string, string> = {}
+  injectedHeaders: Record<string, string> = {},
 ) {
   try {
     const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(
         `${BASE_SERVER_PUBLIC_API_URL_V1}/applications`,
-        superblocksBaseUrl
+        superblocksBaseUrl,
       ).toString(),
       headers: {
         Authorization: "Bearer " + token,
@@ -362,8 +362,7 @@ export async function fetchApplications(
         (e.response?.data?.responseMeta?.message as string) ??
         JSON.stringify(e.response?.data) ??
         e.response?.statusText ??
-        e?.message ??
-        `${e}`;
+        e?.message;
     } else {
       message = `${e?.message ? e?.message : e}`;
     }
@@ -379,19 +378,19 @@ export async function fetchApi(
   viewMode: ViewMode,
   branch?: string,
   commitId?: string,
-  skipSigningVerification = false
+  skipSigningVerification = false,
 ) {
   try {
     const serverURL = branch
       ? new URL(
           `${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}/branches/${encodeURIComponent(
-            branch
+            branch,
           )}`,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         )
       : new URL(
           `${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}`,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         );
     serverURL.search = new URLSearchParams({
       viewMode,
@@ -401,7 +400,7 @@ export async function fetchApi(
       ? await createSocketConnectionIfNeeded(
           cliVersion,
           token,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         )
       : undefined;
 
@@ -435,7 +434,7 @@ export async function fetchApi(
     throw new Error(
       `Could not fetch api: ${
         typeof e === "object" && e && "message" in e ? e.message : e
-      }`
+      }`,
     );
   }
 }
@@ -443,14 +442,14 @@ export async function fetchApi(
 export async function fetchApis(
   cliVersion: string,
   token: string,
-  superblocksBaseUrl: string
+  superblocksBaseUrl: string,
 ) {
   try {
     const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(
         `${BASE_SERVER_PUBLIC_API_URL_V1}/apis`,
-        superblocksBaseUrl
+        superblocksBaseUrl,
       ).toString(),
       headers: {
         Authorization: "Bearer " + token,
@@ -459,7 +458,7 @@ export async function fetchApis(
     };
     const response = await axios(config);
     return response.data.data.apis;
-  } catch (e) {
+  } catch {
     throw new Error("Could not fetch apis");
   }
 }
@@ -472,7 +471,7 @@ export async function validateGitSetup(
   localGitRepoState: LocalGitRepoState,
   token: string,
   superblocksBaseUrl: string,
-  injectedHeaders?: Record<string, string>
+  injectedHeaders?: Record<string, string>,
 ) {
   let resourceName: string | undefined;
   try {
@@ -497,7 +496,7 @@ export async function validateGitSetup(
       method: "post",
       url: new URL(
         `${BASE_SERVER_PUBLIC_API_URL_V1}/${path}`,
-        superblocksBaseUrl
+        superblocksBaseUrl,
       ).toString(),
       headers: {
         Authorization: "Bearer " + token,
@@ -524,8 +523,7 @@ export async function validateGitSetup(
         (e.response?.data?.responseMeta?.message as string) ??
         JSON.stringify(e.response?.data) ??
         e.response?.statusText ??
-        e?.message ??
-        `${e}`;
+        e?.message;
     } else {
       message = `${e?.message ? e.message : e}`;
     }
@@ -551,14 +549,14 @@ export async function registerComponents(
   token: string,
   superblocksBaseUrl: string,
   branch: string | null,
-  injectedHeaders: Record<string, string>
+  injectedHeaders: Record<string, string>,
 ) {
   try {
     const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
     const socket = await createSocketConnectionIfNeeded(
       cliVersion,
       token,
-      superblocksBaseUrl
+      superblocksBaseUrl,
     );
     if (socket) {
       const resp = await socket.call.v1.public.application.component.register({
@@ -575,7 +573,7 @@ export async function registerComponents(
         method: "put",
         url: new URL(
           `${BASE_SERVER_PUBLIC_API_URL_V1}/application/${applicationId}${branchPath}/components`,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         ).toString(),
         headers: {
           Authorization: "Bearer " + token,
@@ -596,13 +594,13 @@ export async function registerComponents(
       throw new Error(
         `Could not register application components ${
           message ? "\n" + message : ""
-        }`
+        }`,
       );
     }
     throw new Error(
       `Could not register application components ${
         e.message ? "\n" + (e as Error).message : ""
-      }`
+      }`,
     );
   }
 }
@@ -642,10 +640,10 @@ export async function uploadComponents({
   });
 
   const buildFiles: UploadFile[] = uploadFiles.filter((uploadFile) =>
-    uploadFile.filename.startsWith("dist/")
+    uploadFile.filename.startsWith("dist/"),
   );
   const srcFiles: UploadFile[] = uploadFiles.filter(
-    (uploadFile) => !uploadFile.filename.startsWith("dist/")
+    (uploadFile) => !uploadFile.filename.startsWith("dist/"),
   );
 
   const formatJSON = JSON.stringify({
@@ -657,7 +655,7 @@ export async function uploadComponents({
   });
   const postURL = new URL(
     `${BASE_BUCKETEER_URL}/v2/components/upload`,
-    bucketeerBaseUrl
+    bucketeerBaseUrl,
   ).toString();
 
   let totalFileSizeMB = 0;
@@ -695,7 +693,7 @@ You can reduce your component bundle size by uploading static assets to a separa
     const initialSocket = await createSocketConnectionIfNeeded(
       cliVersion,
       token,
-      superblocksBaseUrl
+      superblocksBaseUrl,
     );
     const socket =
       initialSocket ??
@@ -721,7 +719,7 @@ You can reduce your component bundle size by uploading static assets to a separa
   } catch (e: any) {
     if (e instanceof AxiosError && e.response?.status === 413) {
       throw new Error(
-        `Could not upload application components, file size limit exceeded`
+        `Could not upload application components, file size limit exceeded`,
       );
     } else {
       let message: string;
@@ -743,14 +741,14 @@ You can reduce your component bundle size by uploading static assets to a separa
 export async function fetchCurrentUser(
   cliVersion: string,
   token: string,
-  superblocksBaseUrl: string
+  superblocksBaseUrl: string,
 ): Promise<UserMeDto> {
   try {
     const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(
         `${BASE_SERVER_PUBLIC_API_URL_V1}/users/me`,
-        superblocksBaseUrl
+        superblocksBaseUrl,
       ).toString(),
       headers: {
         Authorization: "Bearer " + token,
@@ -767,8 +765,7 @@ export async function fetchCurrentUser(
         (e.response?.data?.responseMeta?.message as string) ??
         JSON.stringify(e.response?.data) ??
         e.response?.statusText ??
-        e?.message ??
-        `${e}`;
+        e?.message;
     } else {
       message = `${e?.message ? e?.message : e}`;
     }
@@ -779,7 +776,7 @@ export async function fetchCurrentUser(
 export const createSocketConnectionIfNeeded = async (
   cliVersion: string,
   token: string,
-  superblocksBaseUrl: string
+  superblocksBaseUrl: string,
 ): Promise<StdISocketRPCClient | undefined> => {
   const userMe = await fetchCurrentUser(cliVersion, token, superblocksBaseUrl);
   const organization = userMe.organizations[0];
@@ -791,7 +788,7 @@ export const createSocketConnectionIfNeeded = async (
     const agentUrl = await getAgentUrl(
       userMe.agents,
       organization.agentType,
-      profile
+      profile,
     );
     return await connectToISocketRPCServer({
       agentUrl,
@@ -823,7 +820,7 @@ export async function pushApplication({
       throw new BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
     } else if (status === 409) {
       throw new CommitAlreadyExistsError(
-        `Commit ${applicationConfig.commitId} already exists`
+        `Commit ${applicationConfig.commitId} already exists`,
       );
     }
   };
@@ -831,7 +828,7 @@ export async function pushApplication({
     const socket = await createSocketConnectionIfNeeded(
       cliVersion,
       token,
-      superblocksBaseUrl
+      superblocksBaseUrl,
     );
 
     if (socket) {
@@ -860,9 +857,9 @@ export async function pushApplication({
     } else {
       const serverURL = new URL(
         `${BASE_SERVER_PUBLIC_API_URL_v2}/applications/${applicationId}/branches/${encodeURIComponent(
-          branch
+          branch,
         )}/push`,
-        superblocksBaseUrl
+        superblocksBaseUrl,
       );
       const config: AxiosRequestConfig = {
         method: "post",
@@ -875,16 +872,17 @@ export async function pushApplication({
         data: applicationConfig,
       };
       try {
-        const serverResponse = await axios<
-          ResponseWithMeta<RemoteCommitDto | { updated: Date }>
-        >(config);
+        const serverResponse =
+          await axios<ResponseWithMeta<RemoteCommitDto | { updated: Date }>>(
+            config,
+          );
         return serverResponse?.data?.data;
       } catch (e) {
         if (!axios.isAxiosError(e)) {
           throw e;
         }
         handleHttpError(
-          e.response?.data?.responseMeta?.status ?? e.response?.status
+          e.response?.data?.responseMeta?.status ?? e.response?.status,
         );
         const message =
           (e.response?.data?.responseMeta?.message as string) ??
@@ -904,7 +902,7 @@ export async function pushApplication({
     throw new Error(
       `Could not push application ${
         (e as Error).message ? "\n" + (e as Error).message : ""
-      }`
+      }`,
     );
   }
 }
@@ -931,21 +929,21 @@ export async function pushApi({
       throw new BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
     } else if (status === 409) {
       throw new CommitAlreadyExistsError(
-        `Commit ${apiConfig.commitId} already exists`
+        `Commit ${apiConfig.commitId} already exists`,
       );
     }
   };
   const serverURL = new URL(
     `${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}/branches/${encodeURIComponent(
-      branch
+      branch,
     )}/push`,
-    superblocksBaseUrl
+    superblocksBaseUrl,
   );
   try {
     const socket = await createSocketConnectionIfNeeded(
       cliVersion,
       token,
-      superblocksBaseUrl
+      superblocksBaseUrl,
     );
     if (socket) {
       const resp = await socket.call.v1.public.api.pushCommit({
@@ -978,9 +976,10 @@ export async function pushApi({
         data: apiConfig,
       };
       try {
-        const serverResponse = await axios<
-          ResponseWithMeta<{ commitId: string } | { updated: Date }>
-        >(config);
+        const serverResponse =
+          await axios<
+            ResponseWithMeta<{ commitId: string } | { updated: Date }>
+          >(config);
         return serverResponse?.data?.data;
       } catch (e) {
         if (!axios.isAxiosError(e)) {
@@ -1005,7 +1004,7 @@ export async function pushApi({
     throw new Error(
       `Could not push api ${
         (e as Error).message ? "\n" + (e as Error).message : ""
-      }`
+      }`,
     );
   }
 }
@@ -1033,13 +1032,13 @@ export async function fetchApplicationCommits({
     const serverURL = branch
       ? new URL(
           `${BASE_SERVER_API_URL_V2}/applications/${applicationId}/branches/${encodeURIComponent(
-            branch
+            branch,
           )}/commits`,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         )
       : new URL(
           `${BASE_SERVER_API_URL_V2}/applications/${applicationId}/commits`,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         );
     serverURL.search = new URLSearchParams({
       commitType: "commit",
@@ -1055,9 +1054,8 @@ export async function fetchApplicationCommits({
         ...injectedHeaders,
       },
     };
-    const serverResponse = await axios<
-      ResponseWithMeta<GetCommitsResponseBody>
-    >(config);
+    const serverResponse =
+      await axios<ResponseWithMeta<GetCommitsResponseBody>>(config);
     return serverResponse?.data?.data;
   } catch (e) {
     if (axios.isAxiosError(e) && e.response?.status === 404) {
@@ -1090,13 +1088,13 @@ export async function fetchApiCommits({
     const serverURL = branch
       ? new URL(
           `${BASE_SERVER_API_URL_V3}/apis/${applicationId}/branches/${encodeURIComponent(
-            branch
+            branch,
           )}/commits`,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         )
       : new URL(
           `${BASE_SERVER_API_URL_V3}/apis/${applicationId}/commits`,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         );
     serverURL.search = new URLSearchParams({
       commitType: "commit",
@@ -1112,9 +1110,8 @@ export async function fetchApiCommits({
         ...injectedHeaders,
       },
     };
-    const serverResponse = await axios<
-      ResponseWithMeta<GetCommitsResponseBody>
-    >(config);
+    const serverResponse =
+      await axios<ResponseWithMeta<GetCommitsResponseBody>>(config);
     return serverResponse?.data?.data;
   } catch (e) {
     if (axios.isAxiosError(e) && e.response?.status === 404) {

package/src/flag.ts

@@ -3,3 +3,28 @@ import { FlagBootstrap } from "./types";
 export const signingEnabled = (flags: FlagBootstrap): boolean => {
   return flags["ui.enable-resource-signing"] ?? false;
 };
+
+export const DEFAULT_LINES_FOR_LARGE_STEPS = 1;
+
+export class FeatureFlags {
+  constructor(private flags: FlagBootstrap) {}
+
+  signingEnabled(): boolean {
+    return this.flags["ui.enable-resource-signing"] ?? false;
+  }
+
+  splitLargeApiStepsEnabled(): boolean {
+    return this.flags["superblocks.git.split.large.steps.enabled"] ?? false;
+  }
+
+  splitLargeApiStepsInNewEnabled(): boolean {
+    return this.flags["superblocks.git.split.large.steps.new.enabled"] ?? false;
+  }
+
+  linesForLargeSteps(): number {
+    return (
+      this.flags["superblocks.git.split.large.step.lines"] ??
+      DEFAULT_LINES_FOR_LARGE_STEPS
+    );
+  }
+}

package/src/index.ts

@@ -1,2 +1,4 @@
 export * from "./client";
+export * from "./flag";
 export * from "./sdk";
+export * from "./types";