@superblocksteam/sdk 1.8.2 → 1.9.1

package/src/client.ts

@@ -12,34 +12,35 @@ import {
 } from "@superblocksteam/util";
 import axios, { AxiosError, AxiosRequestConfig } from "axios";
 import FormData from "form-data";
-import { isEmpty } from "lodash";
+import { isEqual, isEmpty } from "lodash";
 import {
   BranchNotCheckedOutError,
   CommitAlreadyExistsError,
   ValidateGitSetupError,
 } from "./errors";
 import { signingEnabled } from "./flag";
-import { connectToISocketRPCServer } from "./socket";
+import { connectToISocketRPCServer, StdISocketRPCClient } from "./socket";
 import {
   AgentType,
   ApiWithPb,
   Page,
   RemoteCommitDto,
   UserMeDto,
+  ViewMode,
 } from "./types";
 import { getAgentUrl } from "./utils";
 
 const BASE_BUCKETEER_URL = "api";
 const BASE_SERVER_PUBLIC_API_URL_V1 = "api/v1/public";
 const BASE_SERVER_PUBLIC_API_URL_v2 = "api/v2/public";
+const BASE_SERVER_API_URL_V2 = "api/v2";
+const BASE_SERVER_API_URL_V3 = "api/v3";
 
 const SUPERBLOCKS_MAX_FILE_SIZE_MB = 10;
 
 const CLI_VERSION_HEADER = "x-superblocks-cli-version";
 const SUPERBLOCKS_URL_HEADER = "x-superblocks-url";
 
-export type ViewMode = "export-deployed" | "export-latest" | "export-live";
-
 export interface UploadFile {
   name: string;
   filename: string;
@@ -58,17 +59,12 @@ export interface MultiPageApplicationWrapper {
   apis: Record<string, any>[];
 }
 
-export type PushApplicationWithCommitConfig = ApplicationWrapper & {
-  commitId: string;
-  commitMessage: string;
-  gitState: LocalGitRepoState;
-};
-
 export type PushMultiPageApplicationWithCommitConfig =
   MultiPageApplicationWrapper & {
-    commitId: string;
-    commitMessage: string;
+    commitId?: string;
+    commitMessage?: string;
     gitState: LocalGitRepoState;
+    skipCommit: boolean;
   };
 
 export interface ApiWrapper {
@@ -78,9 +74,10 @@ export interface ApiWrapper {
 
 export type PushApiWithCommitConfig = {
   apiPb: Record<string, any>;
-  commitId: string;
-  commitMessage: string;
+  commitId?: string;
+  commitMessage?: string;
   gitState: LocalGitRepoState;
+  skipCommit: boolean;
 };
 
 export type Branches = {
@@ -94,6 +91,26 @@ export type Branch = {
 
 type ResponseWithMeta<T> = { responseMeta: unknown; data: T };
 
+export interface CommitDto {
+  commitMessage: string;
+  committer: {
+    name?: string;
+    email: string;
+  };
+  commitId: string;
+  commitDate: number;
+  branch?: string;
+  autosave?: boolean;
+  tag: string;
+  externalCommitId?: string | null;
+  externalCommitDate?: number | null;
+}
+
+export interface GetCommitsResponseBody {
+  autosaves: CommitDto[];
+  commits: CommitDto[];
+}
+
 export async function fetchApplication({
   cliVersion,
   applicationId,
@@ -101,8 +118,9 @@ export async function fetchApplication({
   token,
   superblocksBaseUrl,
   viewMode,
+  commitId,
+  skipSigningVerification = false,
   injectedHeaders = {},
-  fetchSinglePageApplication,
 }: {
   cliVersion: string;
   applicationId: string;
@@ -110,24 +128,51 @@ export async function fetchApplication({
   token: string;
   superblocksBaseUrl: string;
   viewMode: ViewMode;
+  commitId?: string;
+  skipSigningVerification?: boolean;
   injectedHeaders: Record<string, string>;
-  fetchSinglePageApplication: boolean;
-}): Promise<ApplicationWrapper | MultiPageApplicationWrapper | undefined> {
+}): Promise<MultiPageApplicationWrapper | undefined> {
+  if (commitId && viewMode !== "export-commit") {
+    throw new Error(
+      `If commitId ${commitId} is provided, viewMode cannot be ${viewMode}`
+    );
+  }
   try {
-    const baseServerUrl = fetchSinglePageApplication
-      ? BASE_SERVER_PUBLIC_API_URL_V1
-      : BASE_SERVER_PUBLIC_API_URL_v2;
     const serverURL = branch
       ? new URL(
-          `${baseServerUrl}/applications/${applicationId}/branches/${encodeURIComponent(
+          `${BASE_SERVER_PUBLIC_API_URL_v2}/applications/${applicationId}/branches/${encodeURIComponent(
             branch
-          )}?viewMode=${viewMode}`,
+          )}`,
           superblocksBaseUrl
         )
       : new URL(
-          `${baseServerUrl}/applications/${applicationId}?viewMode=${viewMode}`,
+          `${BASE_SERVER_PUBLIC_API_URL_v2}/applications/${applicationId}`,
           superblocksBaseUrl
         );
+    serverURL.search = new URLSearchParams({
+      viewMode,
+      ...(commitId ? { commitId } : {}),
+    }).toString();
+    const socket = !skipSigningVerification
+      ? await createSocketConnectionIfNeeded(
+          cliVersion,
+          token,
+          superblocksBaseUrl
+        )
+      : undefined;
+    if (socket) {
+      try {
+        const resp = await socket.call.v2.public.application.get({
+          applicationId,
+          viewMode,
+          branchName: branch,
+          commitId,
+        });
+        return resp.data;
+      } finally {
+        socket.close();
+      }
+    }
     const config: AxiosRequestConfig = {
       method: "get",
       url: serverURL.toString(),
@@ -138,7 +183,7 @@ export async function fetchApplication({
       },
     };
     const serverResponse = await axios<
-      ResponseWithMeta<ApplicationWrapper | MultiPageApplicationWrapper>
+      ResponseWithMeta<MultiPageApplicationWrapper>
     >(config);
     const data = serverResponse?.data?.data;
     return data;
@@ -146,7 +191,11 @@ export async function fetchApplication({
     if (axios.isAxiosError(e) && e.response?.status === 404) {
       throw new NotFoundError(`Application ${applicationId} was not found`);
     }
-    throw new Error("Could not fetch application");
+    throw new Error(
+      `Could not fetch application: ${
+        typeof e === "object" && e && "message" in e ? e.message : e
+      }`
+    );
   }
 }
 
@@ -197,8 +246,9 @@ export async function fetchApplicationWithComponents({
   token,
   superblocksBaseUrl,
   viewMode,
+  commitId,
+  skipSigningVerification = false,
   injectedHeaders = {},
-  fetchSinglePageApplication = false,
 }: {
   cliVersion: string;
   applicationId: string;
@@ -206,10 +256,11 @@ export async function fetchApplicationWithComponents({
   token: string;
   superblocksBaseUrl: string;
   viewMode: ViewMode;
+  commitId?: string;
+  skipSigningVerification?: boolean;
   injectedHeaders: Record<string, string>;
-  fetchSinglePageApplication?: boolean;
 }): Promise<
-  | ((ApplicationWrapper | MultiPageApplicationWrapper) & {
+  | (MultiPageApplicationWrapper & {
       componentFiles: any;
     })
   | undefined
@@ -221,8 +272,9 @@ export async function fetchApplicationWithComponents({
     token,
     superblocksBaseUrl,
     viewMode,
+    commitId,
+    skipSigningVerification,
     injectedHeaders,
-    fetchSinglePageApplication,
   });
 
   if (isEmpty(applicationWrapper)) {
@@ -236,18 +288,14 @@ export async function fetchApplicationWithComponents({
       componentFiles: null,
     };
   }
-
-  // TODO(jason) update this with commit ID once we enable fetching by commit
-  const commitId = "latest";
   superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
   const bucketeerBaseUrl =
     getBucketeerUrlFromSuperblocksUrl(superblocksBaseUrl);
 
-  const multiPage = fetchSinglePageApplication ? "false" : "true";
   // fetch files from bucketeer
   const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
   const componentFileURL = new URL(
-    `${BASE_BUCKETEER_URL}/v1/components/${applicationId}${branchPath}?commit=${commitId}&viewMode=${viewMode}&multiPage=${multiPage}`,
+    `${BASE_BUCKETEER_URL}/v1/components/${applicationId}${branchPath}?commit=${commitId}&viewMode=${viewMode}&multiPage=true`,
     bucketeerBaseUrl
   ).toString();
 
@@ -261,8 +309,23 @@ export async function fetchApplicationWithComponents({
         ...injectedHeaders,
       },
     };
-    const response = await axios(config);
-    return response.data;
+    const bucketeerApp = (await axios(config))
+      .data as MultiPageApplicationWrapper & {
+      componentFiles: any;
+    };
+
+    if (
+      !isEqual(
+        applicationWrapper.application.settings,
+        bucketeerApp.application.settings
+      )
+    ) {
+      throw new Error(
+        "Application settings fetched from bucketeer do not match the settings fetched from the server"
+      );
+    }
+
+    return bucketeerApp;
   } catch (e) {
     if (axios.isAxiosError(e) && e.response?.status === 404) {
       throw new NotFoundError(`Application ${applicationId} was not found`);
@@ -314,36 +377,66 @@ export async function fetchApi(
   token: string,
   superblocksBaseUrl: string,
   viewMode: ViewMode,
-  branch?: string
+  branch?: string,
+  commitId?: string,
+  skipSigningVerification = false
 ) {
   try {
     const serverURL = branch
       ? new URL(
           `${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}/branches/${encodeURIComponent(
             branch
-          )}?viewMode=${viewMode}`,
+          )}`,
           superblocksBaseUrl
         )
       : new URL(
-          `${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}?viewMode=${viewMode}`,
+          `${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}`,
           superblocksBaseUrl
         );
+    serverURL.search = new URLSearchParams({
+      viewMode,
+      ...(commitId ? { commitId } : {}),
+    }).toString();
+    const socket = !skipSigningVerification
+      ? await createSocketConnectionIfNeeded(
+          cliVersion,
+          token,
+          superblocksBaseUrl
+        )
+      : undefined;
 
-    const config: AxiosRequestConfig = {
-      method: "get",
-      url: new URL(serverURL, superblocksBaseUrl).toString(),
-      headers: {
-        Authorization: "Bearer " + token,
-        [CLI_VERSION_HEADER]: cliVersion,
-      },
-    };
-    const response = await axios(config);
-    return response.data.data;
+    if (socket) {
+      try {
+        const resp = await socket.call.v1.public.api.get({
+          apiId,
+          viewMode,
+          branchName: branch,
+        });
+        return resp.data;
+      } finally {
+        socket.close();
+      }
+    } else {
+      const config: AxiosRequestConfig = {
+        method: "get",
+        url: new URL(serverURL, superblocksBaseUrl).toString(),
+        headers: {
+          Authorization: "Bearer " + token,
+          [CLI_VERSION_HEADER]: cliVersion,
+        },
+      };
+      const response = await axios(config);
+      return response.data.data;
+    }
   } catch (e) {
     if (axios.isAxiosError(e) && e.response?.status === 404) {
       throw new NotFoundError(`Api ${apiId} was not found`);
     }
-    throw new Error("Could not fetch api");
+    throw new Error(
+      `Could not fetch api: ${
+        typeof e === "object" && e && "message" in e ? e.message : e
+      }`
+    );
   }
 }
 
@@ -462,27 +555,12 @@ export async function registerComponents(
 ) {
   try {
     const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
-    const userMe = await fetchCurrentUser(
+    const socket = await createSocketConnectionIfNeeded(
       cliVersion,
       token,
       superblocksBaseUrl
     );
-    const organization = userMe.organizations[0];
-    if (
-      organization.agentType == AgentType.ONPREMISE &&
-      signingEnabled(userMe.flagBootstrap)
-    ) {
-      const profile = process.env.SUPERBLOCKS_PROFILE;
-      const agentUrl = await getAgentUrl(
-        userMe.agents,
-        organization.agentType,
-        profile
-      );
-      const socket = await connectToISocketRPCServer({
-        agentUrl,
-        superblocksBaseUrl,
-        token,
-      });
+    if (socket) {
       const resp = await socket.call.v1.public.application.component.register({
         applicationId,
         branchName: branch || "",
@@ -614,24 +692,18 @@ You can reduce your component bundle size by uploading static assets to a separa
 
     const uploadResponse = await axios.post(postURL, formData, config);
 
-    const userMe = await fetchCurrentUser(
+    const initialSocket = await createSocketConnectionIfNeeded(
       cliVersion,
       token,
       superblocksBaseUrl
     );
-    const organization = userMe.organizations[0];
-    let agentUrl: string | undefined;
-    const signingRequired =
-      organization.agentType == AgentType.ONPREMISE &&
-      signingEnabled(userMe.flagBootstrap);
-    if (signingRequired) {
-      agentUrl = await getAgentUrl(userMe.agents, organization.agentType);
-    }
-    const socket = await connectToISocketRPCServer({
-      agentUrl,
-      superblocksBaseUrl,
-      token,
-    });
+    const socket =
+      initialSocket ??
+      (await connectToISocketRPCServer({
+        agentUrl: undefined,
+        superblocksBaseUrl,
+        token,
+      }));
     try {
       await socket.call.v1.public.application.component.update({
         applicationId,
@@ -641,7 +713,7 @@ You can reduce your component bundle size by uploading static assets to a separa
         registeredComponents: componentConfigs,
         cliVersion,
         componentBaseUrl: uploadResponse.data.componentBaseUrl,
-        signingRequired,
+        signingRequired: !isEmpty(initialSocket),
       });
     } finally {
       socket.close();
@@ -704,6 +776,31 @@ export async function fetchCurrentUser(
   }
 }
 
+export const createSocketConnectionIfNeeded = async (
+  cliVersion: string,
+  token: string,
+  superblocksBaseUrl: string
+): Promise<StdISocketRPCClient | undefined> => {
+  const userMe = await fetchCurrentUser(cliVersion, token, superblocksBaseUrl);
+  const organization = userMe.organizations[0];
+  if (
+    organization.agentType == AgentType.ONPREMISE &&
+    signingEnabled(userMe.flagBootstrap)
+  ) {
+    const profile = process.env.SUPERBLOCKS_PROFILE;
+    const agentUrl = await getAgentUrl(
+      userMe.agents,
+      organization.agentType,
+      profile
+    );
+    return await connectToISocketRPCServer({
+      agentUrl,
+      superblocksBaseUrl,
+      token,
+    });
+  }
+};
+
 export async function pushApplication({
   cliVersion,
   applicationId,
@@ -712,7 +809,6 @@ export async function pushApplication({
   applicationConfig,
   branch,
   injectedHeaders = {},
-  multiPage = false,
 }: {
   cliVersion: string;
   applicationId: string;
@@ -720,11 +816,8 @@ export async function pushApplication({
   superblocksBaseUrl: string;
   branch: string;
   injectedHeaders: Record<string, string>;
-  applicationConfig:
-    | PushApplicationWithCommitConfig
-    | PushMultiPageApplicationWithCommitConfig;
-  multiPage?: boolean;
-}): Promise<RemoteCommitDto | undefined> {
+  applicationConfig: PushMultiPageApplicationWithCommitConfig;
+}): Promise<RemoteCommitDto | { updated: Date } | undefined> {
   const handleHttpError = (status: number) => {
     if (status === 405) {
       throw new BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
@@ -735,52 +828,26 @@ export async function pushApplication({
     }
   };
   try {
-    const userMe = await fetchCurrentUser(
+    const socket = await createSocketConnectionIfNeeded(
       cliVersion,
       token,
       superblocksBaseUrl
     );
-    const organization = userMe.organizations[0];
-    if (
-      organization.agentType == AgentType.ONPREMISE &&
-      signingEnabled(userMe.flagBootstrap)
-    ) {
-      const profile = process.env.SUPERBLOCKS_PROFILE;
-      const agentUrl = await getAgentUrl(
-        userMe.agents,
-        organization.agentType,
-        profile
-      );
-      const socket = await connectToISocketRPCServer({
-        agentUrl,
-        superblocksBaseUrl,
-        token,
+
+    if (socket) {
+      const resp = await socket.call.v2.public.application.pushCommit({
+        applicationId,
+        apis: applicationConfig.apis,
+        application: applicationConfig.application,
+        branchName: branch,
+        commitId: applicationConfig.commitId,
+        commitMessage: applicationConfig.commitMessage,
+        pages: (
+          applicationConfig as unknown as PushMultiPageApplicationWithCommitConfig
+        ).pages,
+        gitState: applicationConfig.gitState,
+        skipCommit: applicationConfig.skipCommit,
       });
-      const resp = multiPage
-        ? await socket.call.v2.public.application.pushCommit({
-            applicationId,
-            apis: applicationConfig.apis,
-            application: applicationConfig.application,
-            branchName: branch,
-            commitId: applicationConfig.commitId,
-            commitMessage: applicationConfig.commitMessage,
-            pages: (
-              applicationConfig as unknown as PushMultiPageApplicationWithCommitConfig
-            ).pages,
-            gitState: applicationConfig.gitState,
-          })
-        : await socket.call.v1.public.application.pushCommit({
-            applicationId,
-            apis: applicationConfig.apis,
-            application: applicationConfig.application,
-            branchName: branch,
-            commitId: applicationConfig.commitId,
-            commitMessage: applicationConfig.commitMessage,
-            page: (
-              applicationConfig as unknown as PushApplicationWithCommitConfig
-            ).page,
-            gitState: applicationConfig.gitState,
-          });
       socket.close();
       handleHttpError(resp.responseMeta.status);
       if (resp.responseMeta.status !== 200) {
@@ -791,12 +858,8 @@ export async function pushApplication({
       }
       return resp.data;
     } else {
-      // v1 calls can be removed once all customers move to multi page
-      const baseServerPublicApiUrl = multiPage
-        ? BASE_SERVER_PUBLIC_API_URL_v2
-        : BASE_SERVER_PUBLIC_API_URL_V1;
       const serverURL = new URL(
-        `${baseServerPublicApiUrl}/applications/${applicationId}/branches/${encodeURIComponent(
+        `${BASE_SERVER_PUBLIC_API_URL_v2}/applications/${applicationId}/branches/${encodeURIComponent(
           branch
         )}/push`,
         superblocksBaseUrl
@@ -812,9 +875,9 @@ export async function pushApplication({
         data: applicationConfig,
       };
       try {
-        const serverResponse = await axios<ResponseWithMeta<RemoteCommitDto>>(
-          config
-        );
+        const serverResponse = await axios<
+          ResponseWithMeta<RemoteCommitDto | { updated: Date }>
+        >(config);
         return serverResponse?.data?.data;
       } catch (e) {
         if (!axios.isAxiosError(e)) {
@@ -862,7 +925,7 @@ export async function pushApi({
   apiConfig: PushApiWithCommitConfig;
   branch: string;
   injectedHeaders: Record<string, string>;
-}): Promise<{ commitId: string } | undefined> {
+}): Promise<{ commitId: string } | { updated: Date } | undefined> {
   const handleHttpError = (status: number) => {
     if (status === 405) {
       throw new BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
@@ -879,22 +942,12 @@ export async function pushApi({
     superblocksBaseUrl
   );
   try {
-    const userMe = await fetchCurrentUser(
+    const socket = await createSocketConnectionIfNeeded(
       cliVersion,
       token,
       superblocksBaseUrl
     );
-    const organization = userMe.organizations[0];
-    if (
-      organization.agentType == AgentType.ONPREMISE &&
-      signingEnabled(userMe.flagBootstrap)
-    ) {
-      const agentUrl = await getAgentUrl(userMe.agents, organization.agentType);
-      const socket = await connectToISocketRPCServer({
-        agentUrl,
-        superblocksBaseUrl,
-        token,
-      });
+    if (socket) {
       const resp = await socket.call.v1.public.api.pushCommit({
         apiId,
         apiPb: apiConfig.apiPb,
@@ -902,6 +955,7 @@ export async function pushApi({
         commitId: apiConfig.commitId,
         commitMessage: apiConfig.commitMessage,
         gitState: apiConfig.gitState,
+        skipCommit: apiConfig.skipCommit,
       });
       socket.close();
       handleHttpError(resp.responseMeta.status);
@@ -925,7 +979,7 @@ export async function pushApi({
       };
       try {
         const serverResponse = await axios<
-          ResponseWithMeta<{ commitId: string }>
+          ResponseWithMeta<{ commitId: string } | { updated: Date }>
         >(config);
         return serverResponse?.data?.data;
       } catch (e) {
@@ -955,3 +1009,117 @@ export async function pushApi({
     );
   }
 }
+
+export async function fetchApplicationCommits({
+  cliVersion,
+  applicationId,
+  branch,
+  token,
+  superblocksBaseUrl,
+  injectedHeaders = {},
+  limit,
+  offset,
+}: {
+  cliVersion: string;
+  applicationId: string;
+  branch?: string;
+  token: string;
+  superblocksBaseUrl: string;
+  injectedHeaders: Record<string, string>;
+  limit?: number;
+  offset?: number;
+}): Promise<GetCommitsResponseBody> {
+  try {
+    const serverURL = branch
+      ? new URL(
+          `${BASE_SERVER_API_URL_V2}/applications/${applicationId}/branches/${encodeURIComponent(
+            branch
+          )}/commits`,
+          superblocksBaseUrl
+        )
+      : new URL(
+          `${BASE_SERVER_API_URL_V2}/applications/${applicationId}/commits`,
+          superblocksBaseUrl
+        );
+    serverURL.search = new URLSearchParams({
+      commitType: "commit",
+      ...(limit ? { limit: limit.toString() } : {}),
+      ...(offset ? { offset: offset.toString() } : {}),
+    }).toString();
+    const config: AxiosRequestConfig = {
+      method: "get",
+      url: serverURL.toString(),
+      headers: {
+        Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
+        ...injectedHeaders,
+      },
+    };
+    const serverResponse = await axios<
+      ResponseWithMeta<GetCommitsResponseBody>
+    >(config);
+    return serverResponse?.data?.data;
+  } catch (e) {
+    if (axios.isAxiosError(e) && e.response?.status === 404) {
+      throw new NotFoundError(`Application ${applicationId} was not found`);
+    }
+    throw new Error("Could not fetch application");
+  }
+}
+
+export async function fetchApiCommits({
+  cliVersion,
+  applicationId,
+  branch,
+  token,
+  superblocksBaseUrl,
+  injectedHeaders = {},
+  limit,
+  offset,
+}: {
+  cliVersion: string;
+  applicationId: string;
+  branch?: string;
+  token: string;
+  superblocksBaseUrl: string;
+  injectedHeaders: Record<string, string>;
+  limit?: number;
+  offset?: number;
+}): Promise<GetCommitsResponseBody> {
+  try {
+    const serverURL = branch
+      ? new URL(
+          `${BASE_SERVER_API_URL_V3}/apis/${applicationId}/branches/${encodeURIComponent(
+            branch
+          )}/commits`,
+          superblocksBaseUrl
+        )
+      : new URL(
+          `${BASE_SERVER_API_URL_V3}/apis/${applicationId}/commits`,
+          superblocksBaseUrl
+        );
+    serverURL.search = new URLSearchParams({
+      commitType: "commit",
+      ...(limit ? { limit: limit.toString() } : {}),
+      ...(offset ? { offset: offset.toString() } : {}),
+    }).toString();
+    const config: AxiosRequestConfig = {
+      method: "get",
+      url: serverURL.toString(),
+      headers: {
+        Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: cliVersion,
+        ...injectedHeaders,
+      },
+    };
+    const serverResponse = await axios<
+      ResponseWithMeta<GetCommitsResponseBody>
+    >(config);
+    return serverResponse?.data?.data;
+  } catch (e) {
+    if (axios.isAxiosError(e) && e.response?.status === 404) {
+      throw new NotFoundError(`Application ${applicationId} was not found`);
+    }
+    throw new Error("Could not fetch application");
+  }
+}