@superblocksteam/sdk 1.10.0 → 1.11.0

package/src/client.ts

@@ -135,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,
@@ -158,7 +158,7 @@ export async function fetchApplication({
       ? await createSocketConnectionIfNeeded(
           cliVersion,
           token,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         )
       : undefined;
     if (socket) {
@@ -183,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) {
@@ -195,7 +194,7 @@ export async function fetchApplication({
     throw new Error(
       `Could not fetch application: ${
         typeof e === "object" && e && "message" in e ? e.message : e
-      }`
+      }`,
     );
   }
 }
@@ -215,7 +214,7 @@ export async function fetchApplicationBranches({
 }): Promise<Branches | undefined> {
   const serverURL = new URL(
     `public/applications/${applicationId}/branches`,
-    superblocksBaseUrl
+    superblocksBaseUrl,
   );
   let serverResponse;
 
@@ -297,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 {
@@ -318,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",
       );
     }
 
@@ -339,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,
@@ -363,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}`;
     }
@@ -380,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,
@@ -402,7 +400,7 @@ export async function fetchApi(
       ? await createSocketConnectionIfNeeded(
           cliVersion,
           token,
-          superblocksBaseUrl
+          superblocksBaseUrl,
         )
       : undefined;
 
@@ -436,7 +434,7 @@ export async function fetchApi(
     throw new Error(
       `Could not fetch api: ${
         typeof e === "object" && e && "message" in e ? e.message : e
-      }`
+      }`,
     );
   }
 }
@@ -444,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,
@@ -460,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");
   }
 }
@@ -473,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 {
@@ -498,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,
@@ -525,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}`;
     }
@@ -552,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({
@@ -576,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,
@@ -597,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 : ""
-      }`
+      }`,
     );
   }
 }
@@ -643,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({
@@ -658,7 +655,7 @@ export async function uploadComponents({
   });
   const postURL = new URL(
     `${BASE_BUCKETEER_URL}/v2/components/upload`,
-    bucketeerBaseUrl
+    bucketeerBaseUrl,
   ).toString();
 
   let totalFileSizeMB = 0;
@@ -696,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 ??
@@ -722,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;
@@ -744,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,
@@ -768,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}`;
     }
@@ -780,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];
@@ -792,7 +788,7 @@ export const createSocketConnectionIfNeeded = async (
     const agentUrl = await getAgentUrl(
       userMe.agents,
       organization.agentType,
-      profile
+      profile,
     );
     return await connectToISocketRPCServer({
       agentUrl,
@@ -824,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`,
       );
     }
   };
@@ -832,7 +828,7 @@ export async function pushApplication({
     const socket = await createSocketConnectionIfNeeded(
       cliVersion,
       token,
-      superblocksBaseUrl
+      superblocksBaseUrl,
     );
 
     if (socket) {
@@ -861,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",
@@ -876,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) ??
@@ -905,7 +902,7 @@ export async function pushApplication({
     throw new Error(
       `Could not push application ${
         (e as Error).message ? "\n" + (e as Error).message : ""
-      }`
+      }`,
     );
   }
 }
@@ -932,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({
@@ -979,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)) {
@@ -1006,7 +1004,7 @@ export async function pushApi({
     throw new Error(
       `Could not push api ${
         (e as Error).message ? "\n" + (e as Error).message : ""
-      }`
+      }`,
     );
   }
 }
@@ -1034,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",
@@ -1056,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) {
@@ -1091,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",
@@ -1113,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

@@ -4,7 +4,7 @@ export const signingEnabled = (flags: FlagBootstrap): boolean => {
   return flags["ui.enable-resource-signing"] ?? false;
 };
 
-export const DEFAULT_LINES_FOR_LARGE_STEPS = 10;
+export const DEFAULT_LINES_FOR_LARGE_STEPS = 1;
 
 export class FeatureFlags {
   constructor(private flags: FlagBootstrap) {}

package/src/index.ts

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

package/src/sdk.ts

@@ -35,7 +35,7 @@ export class SuperblocksSdk {
   constructor(
     accessToken: string,
     superblocksBaseUrl: string,
-    cliVersion: string
+    cliVersion: string,
   ) {
     this.token = accessToken;
     this.superblocksBaseUrl = superblocksBaseUrl;
@@ -169,7 +169,7 @@ export class SuperblocksSdk {
       this.cliVersion,
       this.token,
       this.superblocksBaseUrl,
-      headers
+      headers,
     );
   }
 
@@ -194,7 +194,7 @@ export class SuperblocksSdk {
       viewMode,
       branch,
       commitId,
-      skipSigningVerification
+      skipSigningVerification,
     );
   }
 
@@ -207,7 +207,7 @@ export class SuperblocksSdk {
     resourceType: SuperblocksResourceType,
     event: ComponentEvent,
     localGitRepoState: LocalGitRepoState,
-    injectedHeaders?: Record<string, string>
+    injectedHeaders?: Record<string, string>,
   ) {
     return validateGitSetup(
       this.cliVersion,
@@ -217,7 +217,7 @@ export class SuperblocksSdk {
       localGitRepoState,
       this.token,
       this.superblocksBaseUrl,
-      injectedHeaders
+      injectedHeaders,
     );
   }
 
@@ -225,7 +225,7 @@ export class SuperblocksSdk {
     applicationId: string,
     componentConfigs: Record<string, any>,
     branch: string | null,
-    injectedHeaders: Record<string, string>
+    injectedHeaders: Record<string, string>,
   ) {
     return registerComponents(
       this.cliVersion,
@@ -234,7 +234,7 @@ export class SuperblocksSdk {
       this.token,
       this.superblocksBaseUrl,
       branch,
-      injectedHeaders
+      injectedHeaders,
     );
   }
 
@@ -242,7 +242,7 @@ export class SuperblocksSdk {
     applicationId: string,
     componentConfigs: Record<string, any>,
     files: string[],
-    branch: string | null
+    branch: string | null,
   ) {
     return uploadComponents({
       cliVersion: this.cliVersion,
@@ -259,7 +259,7 @@ export class SuperblocksSdk {
     return fetchCurrentUser(
       this.cliVersion,
       this.token,
-      this.superblocksBaseUrl
+      this.superblocksBaseUrl,
     );
   }
 

package/src/socket/handlers.ts

@@ -181,7 +181,7 @@ export function createRequestHandlers({
             }) => {
               if (!agentUrl) {
                 throw new Error(
-                  "Agent url not specified. This shouldn't happen."
+                  "Agent url not specified. This shouldn't happen.",
                 );
               }
               const signature = await signResource({
@@ -209,7 +209,7 @@ export function createRequestHandlers({
               for (const { apiPb } of toSign) {
                 if (!agentUrl) {
                   throw new Error(
-                    "Agent url not specified. This shouldn't happen."
+                    "Agent url not specified. This shouldn't happen.",
                   );
                 }
                 const signature = await signResource({
@@ -234,7 +234,7 @@ export function createRequestHandlers({
               try {
                 if (!agentUrl) {
                   throw new Error(
-                    "Agent url not specified. This shouldn't happen."
+                    "Agent url not specified. This shouldn't happen.",
                   );
                 }
                 await verifyResources({
@@ -268,7 +268,7 @@ export function createRequestHandlers({
               try {
                 if (!agentUrl) {
                   throw new Error(
-                    "Agent url not specified. This shouldn't happen."
+                    "Agent url not specified. This shouldn't happen.",
                   );
                 }
                 await verifyResources({

package/src/socket/index.ts

@@ -50,7 +50,7 @@ export async function connectToISocketRPCServer({
     {
       connectionTimeoutInSeconds: 6 * 60, // 6 minutes
       noResponseTimeoutInSeconds: 5 * 60, // 5 minutes
-    }
+    },
   );
 }
 
@@ -60,7 +60,7 @@ export async function connectToISocketRPCServer({
 export class ISocketWithClientAuth<
   ImplementedMethods,
   CallableMethods,
-  RequestContext extends RequestContextBase
+  RequestContext extends RequestContextBase,
 > extends ISocket<ImplementedMethods, CallableMethods, RequestContext> {
   private readonly authorization?: string;
   private hasSentAuth = false;
@@ -74,7 +74,7 @@ export class ISocketWithClientAuth<
       RequestContext
     >,
     globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[],
-    timeouts?: SocketTimeouts
+    timeouts?: SocketTimeouts,
   ) {
     super(ws, requestHandlers, globalMiddlewares, timeouts);
     this.authorization = authorization;
@@ -83,14 +83,14 @@ export class ISocketWithClientAuth<
   // override `request` from the base class to send `authorization` when appropriate
   async request<Params, Result>(
     method: string,
-    params: Params
+    params: Params,
   ): Promise<Result> {
     // only send `authorization` on the first request
     const authorization = this.hasSentAuth ? undefined : this.authorization;
     const result = await super.request<Params, Result>(
       method,
       params,
-      authorization
+      authorization,
     );
     this.hasSentAuth = true;
     return result;
@@ -100,7 +100,7 @@ export class ISocketWithClientAuth<
 export async function connectISocket<
   CallableMethods,
   ImplementedMethods,
-  RequestContext extends RequestContextBase = RequestContextBase
+  RequestContext extends RequestContextBase = RequestContextBase,
 >(
   wsUrl: string,
   authorization: string | undefined,
@@ -110,7 +110,7 @@ export async function connectISocket<
     RequestContext
   >,
   globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[],
-  timeouts?: SocketTimeouts
+  timeouts?: SocketTimeouts,
 ): Promise<ISocketClient<CallableMethods>> {
   const ws = await connectWebSocket(wsUrl);
   const isocket = new ISocketWithClientAuth(
@@ -118,7 +118,7 @@ export async function connectISocket<
     authorization,
     requestHandlers,
     globalMiddlewares,
-    timeouts
+    timeouts,
   );
   return createISocketClient(isocket);
 }