@superblocksteam/sdk 1.5.2 → 1.7.0

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { ComponentEvent, LocalGitRepoState, SuperblocksResourceType } from "@superblocksteam/util";
-import { RemoteCommitDto, UserMeDto } from "./types";
+import { ApiWithPb, Page, RemoteCommitDto, UserMeDto } from "./types";
 export type ViewMode = "export-deployed" | "export-latest" | "export-live";
 export interface UploadFile {
     name: string;
@@ -8,13 +8,22 @@ export interface UploadFile {
 }
 export interface ApplicationWrapper {
     application: Record<string, any>;
-    page: Record<string, any>;
+    page: Page;
+    apis: ApiWithPb[];
+}
+export interface MultiPageApplicationWrapper {
+    application: Record<string, any>;
+    pages: Page[];
     apis: Record<string, any>[];
 }
 export type PushApplicationWithCommitConfig = ApplicationWrapper & {
     commitId: string;
     commitMessage: string;
 };
+export type PushMultiPageApplicationWithCommitConfig = MultiPageApplicationWrapper & {
+    commitId: string;
+    commitMessage: string;
+};
 export interface ApiWrapper {
     apiPb: Record<string, any>;
     name?: string;
@@ -31,7 +40,7 @@ export type Branch = {
     name: string;
     isDefault: boolean;
 };
-export declare function fetchApplication({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
+export declare function fetchApplication({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, fetchSinglePageApplication, }: {
     cliVersion: string;
     applicationId: string;
     branch?: string;
@@ -39,7 +48,8 @@ export declare function fetchApplication({ cliVersion, applicationId, branch, to
     superblocksBaseUrl: string;
     viewMode: ViewMode;
     injectedHeaders: Record<string, string>;
-}): Promise<ApplicationWrapper | undefined>;
+    fetchSinglePageApplication: boolean;
+}): Promise<ApplicationWrapper | MultiPageApplicationWrapper | undefined>;
 export declare function fetchApplicationBranches({ cliVersion, applicationId, token, superblocksBaseUrl, injectedHeaders, }: {
     cliVersion: string;
     applicationId: string;
@@ -47,7 +57,7 @@ export declare function fetchApplicationBranches({ cliVersion, applicationId, to
     superblocksBaseUrl: string;
     injectedHeaders: Record<string, string>;
 }): Promise<Branches | undefined>;
-export declare function fetchApplicationWithComponents({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
+export declare function fetchApplicationWithComponents({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders, fetchSinglePageApplication, }: {
     cliVersion: string;
     applicationId: string;
     branch: string;
@@ -55,7 +65,8 @@ export declare function fetchApplicationWithComponents({ cliVersion, application
     superblocksBaseUrl: string;
     viewMode: ViewMode;
     injectedHeaders: Record<string, string>;
-}): Promise<(ApplicationWrapper & {
+    fetchSinglePageApplication?: boolean;
+}): Promise<((ApplicationWrapper | MultiPageApplicationWrapper) & {
     componentFiles: any;
 }) | undefined>;
 export declare function fetchApplications(cliVersion: string, token: string, superblocksBaseUrl: string, injectedHeaders?: Record<string, string>): Promise<any>;
@@ -75,14 +86,15 @@ export declare function uploadComponents({ cliVersion, applicationId, componentC
     branch: string | null;
 }): Promise<void>;
 export declare function fetchCurrentUser(cliVersion: string, token: string, superblocksBaseUrl: string): Promise<UserMeDto>;
-export declare function pushApplication({ cliVersion, applicationId, token, superblocksBaseUrl, applicationConfig, branch, injectedHeaders, }: {
+export declare function pushApplication({ cliVersion, applicationId, token, superblocksBaseUrl, applicationConfig, branch, injectedHeaders, multiPage, }: {
     cliVersion: string;
     applicationId: string;
     token: string;
     superblocksBaseUrl: string;
     branch: string;
     injectedHeaders: Record<string, string>;
-    applicationConfig: PushApplicationWithCommitConfig;
+    applicationConfig: PushApplicationWithCommitConfig | PushMultiPageApplicationWithCommitConfig;
+    multiPage?: boolean;
 }): Promise<RemoteCommitDto | undefined>;
 export declare function pushApi({ cliVersion, apiId, token, superblocksBaseUrl, apiConfig, branch, injectedHeaders, }: {
     cliVersion: string;

package/dist/client.js

@@ -13,16 +13,19 @@ const socket_1 = require("./socket");
 const types_1 = require("./types");
 const utils_1 = require("./utils");
 const BASE_BUCKETEER_URL = "api";
-const BASE_SERVER_PUBLIC_API_URL = "api/v1/public";
+const BASE_SERVER_PUBLIC_API_URL_V1 = "api/v1/public";
+const BASE_SERVER_PUBLIC_API_URL_v2 = "api/v2/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({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
-    const serverURL = branch
-        ? 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;
+async function fetchApplication({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, fetchSinglePageApplication, }) {
     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(branch)}?viewMode=${viewMode}`, superblocksBaseUrl)
+            : new URL(`${baseServerUrl}/applications/${applicationId}?viewMode=${viewMode}`, superblocksBaseUrl);
         const config = {
             method: "get",
             url: serverURL.toString(),
@@ -32,7 +35,9 @@ async function fetchApplication({ cliVersion, applicationId, branch, token, supe
                 ...injectedHeaders,
             },
         };
-        serverResponse = await (0, axios_1.default)(config);
+        const serverResponse = await (0, axios_1.default)(config);
+        const data = serverResponse?.data?.data;
+        return data;
     }
     catch (e) {
         if (axios_1.default.isAxiosError(e) && e.response?.status === 404) {
@@ -40,7 +45,6 @@ async function fetchApplication({ cliVersion, applicationId, branch, token, supe
         }
         throw new Error("Could not fetch application");
     }
-    return serverResponse?.data?.data;
 }
 exports.fetchApplication = fetchApplication;
 async function fetchApplicationBranches({ cliVersion, applicationId, token, superblocksBaseUrl, injectedHeaders = {}, }) {
@@ -67,7 +71,7 @@ async function fetchApplicationBranches({ cliVersion, applicationId, token, supe
     return serverResponse?.data?.data;
 }
 exports.fetchApplicationBranches = fetchApplicationBranches;
-async function fetchApplicationWithComponents({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
+async function fetchApplicationWithComponents({ cliVersion, applicationId, branch, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, fetchSinglePageApplication = false, }) {
     const applicationWrapper = await fetchApplication({
         cliVersion,
         applicationId,
@@ -76,6 +80,7 @@ async function fetchApplicationWithComponents({ cliVersion, applicationId, branc
         superblocksBaseUrl,
         viewMode,
         injectedHeaders,
+        fetchSinglePageApplication,
     });
     if ((0, lodash_1.isEmpty)(applicationWrapper)) {
         return;
@@ -91,9 +96,10 @@ async function fetchApplicationWithComponents({ cliVersion, applicationId, branc
     const commitId = "latest";
     superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
     const bucketeerBaseUrl = (0, util_1.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}`, bucketeerBaseUrl).toString();
+    const componentFileURL = new URL(`${BASE_BUCKETEER_URL}/v1/components/${applicationId}${branchPath}?commit=${commitId}&viewMode=${viewMode}&multiPage=${multiPage}`, bucketeerBaseUrl).toString();
     try {
         const config = {
             method: "get",
@@ -119,7 +125,7 @@ async function fetchApplications(cliVersion, token, superblocksBaseUrl, injected
     try {
         const config = {
             method: "get",
-            url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/applications`, superblocksBaseUrl).toString(),
+            url: new URL(`${BASE_SERVER_PUBLIC_API_URL_V1}/applications`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
                 [CLI_VERSION_HEADER]: cliVersion,
@@ -149,8 +155,8 @@ exports.fetchApplications = fetchApplications;
 async function fetchApi(cliVersion, apiId, token, superblocksBaseUrl, viewMode, branch) {
     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);
+            ? 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}`, superblocksBaseUrl);
         const config = {
             method: "get",
             url: new URL(serverURL, superblocksBaseUrl).toString(),
@@ -174,7 +180,7 @@ async function fetchApis(cliVersion, token, superblocksBaseUrl) {
     try {
         const config = {
             method: "get",
-            url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/apis`, superblocksBaseUrl).toString(),
+            url: new URL(`${BASE_SERVER_PUBLIC_API_URL_V1}/apis`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
                 [CLI_VERSION_HEADER]: cliVersion,
@@ -210,7 +216,7 @@ async function validateGitSetup(cliVersion, resourceId, resourceType, event, loc
         }
         const config = {
             method: "post",
-            url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/${path}`, superblocksBaseUrl).toString(),
+            url: new URL(`${BASE_SERVER_PUBLIC_API_URL_V1}/${path}`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
                 [CLI_VERSION_HEADER]: cliVersion,
@@ -241,9 +247,17 @@ async function validateGitSetup(cliVersion, resourceId, resourceType, event, loc
                     `${e}`;
         }
         else {
-            message = `${e?.message ? e?.message : e}`;
+            message = `${e?.message ? e.message : e}`;
+        }
+        const errorMessage = `Could not validate your git setup against Superblocks for the ${resourceType.toLowerCase()} ${resourceName ?? resourceId}${message ? "\n" + message : ""}`;
+        // TODO(@taha-au @gpoulios-sb) Replace this check with a more robust one that uses error codes once
+        // the backend starts returning them as part of the response body
+        if (message.includes("Please initialize git locally")) {
+            throw new errors_1.ValidateGitSetupError(errorMessage);
+        }
+        else {
+            throw new Error(errorMessage);
         }
-        throw new Error(`Could not validate your git setup against Superblocks for the ${resourceType.toLowerCase()} ${resourceName ?? resourceId}${message ? "\n" + message : ""}`);
     }
 }
 exports.validateGitSetup = validateGitSetup;
@@ -274,7 +288,7 @@ async function registerComponents(cliVersion, applicationId, componentConfigs, t
         else {
             const config = {
                 method: "put",
-                url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/application/${applicationId}${branchPath}/components`, superblocksBaseUrl).toString(),
+                url: new URL(`${BASE_SERVER_PUBLIC_API_URL_V1}/application/${applicationId}${branchPath}/components`, superblocksBaseUrl).toString(),
                 headers: {
                     Authorization: "Bearer " + token,
                     [CLI_VERSION_HEADER]: cliVersion,
@@ -406,7 +420,7 @@ async function fetchCurrentUser(cliVersion, token, superblocksBaseUrl) {
     try {
         const config = {
             method: "get",
-            url: new URL(`${BASE_SERVER_PUBLIC_API_URL}/users/me`, superblocksBaseUrl).toString(),
+            url: new URL(`${BASE_SERVER_PUBLIC_API_URL_V1}/users/me`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
                 [CLI_VERSION_HEADER]: cliVersion,
@@ -433,7 +447,7 @@ async function fetchCurrentUser(cliVersion, token, superblocksBaseUrl) {
     }
 }
 exports.fetchCurrentUser = fetchCurrentUser;
-async function pushApplication({ cliVersion, applicationId, token, superblocksBaseUrl, applicationConfig, branch, injectedHeaders = {}, }) {
+async function pushApplication({ cliVersion, applicationId, token, superblocksBaseUrl, applicationConfig, branch, injectedHeaders = {}, multiPage = false, }) {
     const handleHttpError = (status) => {
         if (status === 405) {
             throw new errors_1.BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
@@ -454,15 +468,25 @@ async function pushApplication({ cliVersion, applicationId, token, superblocksBa
                 superblocksBaseUrl,
                 token,
             });
-            const resp = await socket.call.v1.public.application.pushCommit({
-                applicationId,
-                apis: applicationConfig.apis,
-                application: applicationConfig.application,
-                branchName: branch,
-                commitId: applicationConfig.commitId,
-                commitMessage: applicationConfig.commitMessage,
-                page: applicationConfig.page,
-            });
+            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.pages,
+                })
+                : await socket.call.v1.public.application.pushCommit({
+                    applicationId,
+                    apis: applicationConfig.apis,
+                    application: applicationConfig.application,
+                    branchName: branch,
+                    commitId: applicationConfig.commitId,
+                    commitMessage: applicationConfig.commitMessage,
+                    page: applicationConfig.page,
+                });
             socket.close();
             handleHttpError(resp.responseMeta.status);
             if (resp.responseMeta.status !== 200) {
@@ -473,7 +497,11 @@ async function pushApplication({ cliVersion, applicationId, token, superblocksBa
             return resp.data;
         }
         else {
-            const serverURL = new URL(`${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}/branches/${encodeURIComponent(branch)}/push`, superblocksBaseUrl);
+            // 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(branch)}/push`, superblocksBaseUrl);
             const config = {
                 method: "post",
                 url: serverURL.toString(),
@@ -503,6 +531,7 @@ async function pushApplication({ cliVersion, applicationId, token, superblocksBa
     catch (e) {
         if (e instanceof errors_1.BranchNotCheckedOutError ||
             e instanceof errors_1.CommitAlreadyExistsError) {
+            // Rethrow these exceptions because they will be handled higher up the call stack
             throw e;
         }
         throw new Error(`Could not push application ${e.message ? "\n" + e.message : ""}`);
@@ -518,7 +547,7 @@ async function pushApi({ cliVersion, apiId, token, superblocksBaseUrl, apiConfig
             throw new errors_1.CommitAlreadyExistsError(`Commit ${apiConfig.commitId} already exists`);
         }
     };
-    const serverURL = new URL(`${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}/branches/${encodeURIComponent(branch)}/push`, superblocksBaseUrl);
+    const serverURL = new URL(`${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}/branches/${encodeURIComponent(branch)}/push`, superblocksBaseUrl);
     try {
         const userMe = await fetchCurrentUser(cliVersion, token, superblocksBaseUrl);
         const organization = userMe.organizations[0];
@@ -576,6 +605,7 @@ async function pushApi({ cliVersion, apiId, token, superblocksBaseUrl, apiConfig
     catch (e) {
         if (e instanceof errors_1.BranchNotCheckedOutError ||
             e instanceof errors_1.CommitAlreadyExistsError) {
+            // Rethrow these exceptions because they will be handled higher up the call stack
             throw e;
         }
         throw new Error(`Could not push api ${e.message ? "\n" + e.message : ""}`);

package/dist/errors.d.ts

@@ -4,3 +4,6 @@ export declare class BranchNotCheckedOutError extends Error {
 export declare class CommitAlreadyExistsError extends Error {
     constructor(message: string);
 }
+export declare class ValidateGitSetupError extends Error {
+    constructor(message: string);
+}

package/dist/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommitAlreadyExistsError = exports.BranchNotCheckedOutError = void 0;
+exports.ValidateGitSetupError = exports.CommitAlreadyExistsError = exports.BranchNotCheckedOutError = void 0;
 class BranchNotCheckedOutError extends Error {
     constructor(message) {
         super(message);
@@ -15,3 +15,10 @@ class CommitAlreadyExistsError extends Error {
     }
 }
 exports.CommitAlreadyExistsError = CommitAlreadyExistsError;
+class ValidateGitSetupError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ValidateGitSetupError";
+    }
+}
+exports.ValidateGitSetupError = ValidateGitSetupError;

package/dist/sdk.d.ts

@@ -1,24 +1,26 @@
 import { ComponentEvent, LocalGitRepoState, SuperblocksResourceType } from "@superblocksteam/util";
-import { PushApiWithCommitConfig, PushApplicationWithCommitConfig, ViewMode } from "./client";
+import { PushApiWithCommitConfig, PushApplicationWithCommitConfig, PushMultiPageApplicationWithCommitConfig, ViewMode } from "./client";
 export * from "./errors";
 export declare class SuperblocksSdk {
     token: string;
     superblocksBaseUrl: string;
     cliVersion: string;
     constructor(accessToken: string, superblocksBaseUrl: string, cliVersion: string);
-    fetchApplication({ applicationId, branch, headers, viewMode, }: {
+    fetchApplication({ applicationId, branch, headers, viewMode, fetchSinglePageApplication, }: {
         applicationId: string;
         branch?: string;
         headers?: Record<string, string>;
         viewMode?: ViewMode;
-    }): Promise<import("./client").ApplicationWrapper | undefined>;
+        fetchSinglePageApplication?: boolean;
+    }): Promise<import("./client").ApplicationWrapper | import("./client").MultiPageApplicationWrapper | undefined>;
     fetchApplicationBranches(applicationId: string, headers?: {}): Promise<import("./client").Branches | undefined>;
-    fetchApplicationWithComponents({ applicationId, branch, headers, viewMode, }: {
+    fetchApplicationWithComponents({ applicationId, branch, headers, viewMode, fetchSinglePageApplication, }: {
         applicationId: string;
         branch: string;
         headers?: Record<string, string>;
         viewMode?: ViewMode;
-    }): Promise<(import("./client").ApplicationWrapper & {
+        fetchSinglePageApplication?: boolean;
+    }): Promise<((import("./client").ApplicationWrapper | import("./client").MultiPageApplicationWrapper) & {
         componentFiles: any;
     }) | undefined>;
     fetchApplications(headers?: Record<string, string>): Promise<any>;
@@ -30,11 +32,12 @@ export declare class SuperblocksSdk {
     registerComponents(applicationId: string, componentConfigs: Record<string, any>, branch: string | null, injectedHeaders: Record<string, string>): Promise<any>;
     uploadComponents(applicationId: string, componentConfigs: Record<string, any>, files: string[], branch: string | null): Promise<void>;
     fetchCurrentUser(): Promise<import("./types").UserMeDto>;
-    pushApplication({ applicationId, applicationConfig, branch, headers, }: {
+    pushApplication({ applicationId, applicationConfig, branch, headers, multiPage, }: {
         applicationId: string;
-        applicationConfig: PushApplicationWithCommitConfig;
+        applicationConfig: PushApplicationWithCommitConfig | PushMultiPageApplicationWithCommitConfig;
         branch: string;
         headers?: Record<string, string>;
+        multiPage?: boolean;
     }): Promise<import("./types").RemoteCommitDto | undefined>;
     pushApi({ apiId, apiConfig, branch, headers, }: {
         apiId: string;

package/dist/sdk.js

@@ -14,7 +14,7 @@ class SuperblocksSdk {
         this.superblocksBaseUrl = superblocksBaseUrl;
         this.cliVersion = cliVersion;
     }
-    async fetchApplication({ applicationId, branch, headers = {}, viewMode = "export-live", }) {
+    async fetchApplication({ applicationId, branch, headers = {}, viewMode = "export-live", fetchSinglePageApplication = false, }) {
         return (0, client_1.fetchApplication)({
             cliVersion: this.cliVersion,
             applicationId,
@@ -23,6 +23,7 @@ class SuperblocksSdk {
             superblocksBaseUrl: this.superblocksBaseUrl,
             viewMode,
             injectedHeaders: headers,
+            fetchSinglePageApplication,
         });
     }
     async fetchApplicationBranches(applicationId, headers = {}) {
@@ -34,7 +35,7 @@ class SuperblocksSdk {
             injectedHeaders: headers,
         });
     }
-    async fetchApplicationWithComponents({ applicationId, branch, headers = {}, viewMode = "export-live", }) {
+    async fetchApplicationWithComponents({ applicationId, branch, headers = {}, viewMode = "export-live", fetchSinglePageApplication = false, }) {
         return (0, client_1.fetchApplicationWithComponents)({
             cliVersion: this.cliVersion,
             applicationId,
@@ -43,6 +44,7 @@ class SuperblocksSdk {
             superblocksBaseUrl: this.superblocksBaseUrl,
             viewMode,
             injectedHeaders: headers,
+            fetchSinglePageApplication,
         });
     }
     async fetchApplications(headers) {
@@ -74,7 +76,7 @@ class SuperblocksSdk {
     async fetchCurrentUser() {
         return (0, client_1.fetchCurrentUser)(this.cliVersion, this.token, this.superblocksBaseUrl);
     }
-    async pushApplication({ applicationId, applicationConfig, branch, headers = {}, }) {
+    async pushApplication({ applicationId, applicationConfig, branch, headers = {}, multiPage = false, }) {
         return (0, client_1.pushApplication)({
             cliVersion: this.cliVersion,
             applicationId,
@@ -83,6 +85,7 @@ class SuperblocksSdk {
             branch,
             injectedHeaders: headers,
             applicationConfig,
+            multiPage,
         });
     }
     async pushApi({ apiId, apiConfig, branch, headers = {}, }) {

package/dist/socket/handlers.d.ts

@@ -98,6 +98,21 @@ export interface ServerMethods {
             };
         };
     };
+    v2: {
+        public: {
+            application: {
+                pushCommit: ServerMethodSchema<{
+                    applicationId: string;
+                    branchName: string;
+                    commitId: string;
+                    commitMessage: string;
+                    application: Record<string, unknown>;
+                    pages: Record<string, unknown>[];
+                    apis: Record<string, unknown>[];
+                }, RemoteCommitDto>;
+            };
+        };
+    };
 }
 export declare function createRequestHandlers({ agentUrl, token, }: {
     token: string;

package/dist/types/common.d.ts

@@ -6,6 +6,7 @@ export interface UserMeDto {
 }
 export interface FlagBootstrap {
     "ui.enable-resource-signing"?: boolean;
+    "server.multipage.enabled"?: boolean;
 }
 export type User = {
     id: string;
@@ -95,6 +96,19 @@ export type Api = {
     trigger: any;
     signature?: Signature;
 };
+export type ApiWithPb = {
+    id: string;
+    pageId?: string;
+    apiPb: Api;
+};
+export type Page = {
+    id: string;
+    applicationId: string;
+    isHidden: boolean;
+    layouts: Record<string, unknown>[];
+    name: string;
+    apis: ApiWithPb[];
+};
 /** A signature, as produced by the agent. */
 export interface Signature {
     /** The id of the key used to sign the data. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "1.5.2",
+  "version": "1.7.0",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {
@@ -31,7 +31,7 @@
     "typescript": "^5.1.3"
   },
   "dependencies": {
-    "@superblocksteam/util": "1.5.2",
+    "@superblocksteam/util": "1.7.0",
     "axios": "^1.3.5",
     "isomorphic-ws": "^5.0.0"
   },

package/src/client.ts

@@ -13,14 +13,25 @@ import {
 import axios, { AxiosError, AxiosRequestConfig } from "axios";
 import FormData from "form-data";
 import { isEmpty } from "lodash";
-import { BranchNotCheckedOutError, CommitAlreadyExistsError } from "./errors";
+import {
+  BranchNotCheckedOutError,
+  CommitAlreadyExistsError,
+  ValidateGitSetupError,
+} from "./errors";
 import { signingEnabled } from "./flag";
 import { connectToISocketRPCServer } from "./socket";
-import { AgentType, RemoteCommitDto, UserMeDto } from "./types";
+import {
+  AgentType,
+  ApiWithPb,
+  Page,
+  RemoteCommitDto,
+  UserMeDto,
+} from "./types";
 import { getAgentUrl } from "./utils";
 
 const BASE_BUCKETEER_URL = "api";
-const BASE_SERVER_PUBLIC_API_URL = "api/v1/public";
+const BASE_SERVER_PUBLIC_API_URL_V1 = "api/v1/public";
+const BASE_SERVER_PUBLIC_API_URL_v2 = "api/v2/public";
 
 const SUPERBLOCKS_MAX_FILE_SIZE_MB = 10;
 
@@ -37,7 +48,13 @@ export interface UploadFile {
 
 export interface ApplicationWrapper {
   application: Record<string, any>;
-  page: Record<string, any>;
+  page: Page;
+  apis: ApiWithPb[];
+}
+
+export interface MultiPageApplicationWrapper {
+  application: Record<string, any>;
+  pages: Page[];
   apis: Record<string, any>[];
 }
 
@@ -46,6 +63,12 @@ export type PushApplicationWithCommitConfig = ApplicationWrapper & {
   commitMessage: string;
 };
 
+export type PushMultiPageApplicationWithCommitConfig =
+  MultiPageApplicationWrapper & {
+    commitId: string;
+    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.
@@ -76,6 +99,7 @@ export async function fetchApplication({
   superblocksBaseUrl,
   viewMode,
   injectedHeaders = {},
+  fetchSinglePageApplication,
 }: {
   cliVersion: string;
   applicationId: string;
@@ -84,22 +108,24 @@ export async function fetchApplication({
   superblocksBaseUrl: string;
   viewMode: ViewMode;
   injectedHeaders: Record<string, string>;
-}): Promise<ApplicationWrapper | undefined> {
-  const serverURL = branch
-    ? 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;
-
+  fetchSinglePageApplication: boolean;
+}): Promise<ApplicationWrapper | MultiPageApplicationWrapper | undefined> {
   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(
+            branch
+          )}?viewMode=${viewMode}`,
+          superblocksBaseUrl
+        )
+      : new URL(
+          `${baseServerUrl}/applications/${applicationId}?viewMode=${viewMode}`,
+          superblocksBaseUrl
+        );
     const config: AxiosRequestConfig = {
       method: "get",
       url: serverURL.toString(),
@@ -109,15 +135,17 @@ export async function fetchApplication({
         ...injectedHeaders,
       },
     };
-    serverResponse = await axios<ResponseWithMeta<ApplicationWrapper>>(config);
+    const serverResponse = await axios<
+      ResponseWithMeta<ApplicationWrapper | MultiPageApplicationWrapper>
+    >(config);
+    const data = serverResponse?.data?.data;
+    return 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");
   }
-
-  return serverResponse?.data?.data;
 }
 
 export async function fetchApplicationBranches({
@@ -168,6 +196,7 @@ export async function fetchApplicationWithComponents({
   superblocksBaseUrl,
   viewMode,
   injectedHeaders = {},
+  fetchSinglePageApplication = false,
 }: {
   cliVersion: string;
   applicationId: string;
@@ -176,7 +205,13 @@ export async function fetchApplicationWithComponents({
   superblocksBaseUrl: string;
   viewMode: ViewMode;
   injectedHeaders: Record<string, string>;
-}): Promise<(ApplicationWrapper & { componentFiles: any }) | undefined> {
+  fetchSinglePageApplication?: boolean;
+}): Promise<
+  | ((ApplicationWrapper | MultiPageApplicationWrapper) & {
+      componentFiles: any;
+    })
+  | undefined
+> {
   const applicationWrapper = await fetchApplication({
     cliVersion,
     applicationId,
@@ -185,6 +220,7 @@ export async function fetchApplicationWithComponents({
     superblocksBaseUrl,
     viewMode,
     injectedHeaders,
+    fetchSinglePageApplication,
   });
 
   if (isEmpty(applicationWrapper)) {
@@ -205,10 +241,11 @@ export async function fetchApplicationWithComponents({
   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}`,
+    `${BASE_BUCKETEER_URL}/v1/components/${applicationId}${branchPath}?commit=${commitId}&viewMode=${viewMode}&multiPage=${multiPage}`,
     bucketeerBaseUrl
   ).toString();
 
@@ -242,7 +279,7 @@ export async function fetchApplications(
     const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(
-        `${BASE_SERVER_PUBLIC_API_URL}/applications`,
+        `${BASE_SERVER_PUBLIC_API_URL_V1}/applications`,
         superblocksBaseUrl
       ).toString(),
       headers: {
@@ -280,13 +317,13 @@ export async function fetchApi(
   try {
     const serverURL = branch
       ? new URL(
-          `${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}/branches/${encodeURIComponent(
+          `${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}/branches/${encodeURIComponent(
             branch
           )}?viewMode=${viewMode}`,
           superblocksBaseUrl
         )
       : new URL(
-          `${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}?viewMode=${viewMode}`,
+          `${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}?viewMode=${viewMode}`,
           superblocksBaseUrl
         );
 
@@ -317,7 +354,7 @@ export async function fetchApis(
     const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(
-        `${BASE_SERVER_PUBLIC_API_URL}/apis`,
+        `${BASE_SERVER_PUBLIC_API_URL_V1}/apis`,
         superblocksBaseUrl
       ).toString(),
       headers: {
@@ -364,7 +401,7 @@ export async function validateGitSetup(
     const config: AxiosRequestConfig = {
       method: "post",
       url: new URL(
-        `${BASE_SERVER_PUBLIC_API_URL}/${path}`,
+        `${BASE_SERVER_PUBLIC_API_URL_V1}/${path}`,
         superblocksBaseUrl
       ).toString(),
       headers: {
@@ -395,13 +432,20 @@ export async function validateGitSetup(
         e?.message ??
         `${e}`;
     } else {
-      message = `${e?.message ? e?.message : e}`;
+      message = `${e?.message ? e.message : e}`;
+    }
+
+    const errorMessage = `Could not validate your git setup against Superblocks for the ${resourceType.toLowerCase()} ${
+      resourceName ?? resourceId
+    }${message ? "\n" + message : ""}`;
+
+    // TODO(@taha-au @gpoulios-sb) Replace this check with a more robust one that uses error codes once
+    // the backend starts returning them as part of the response body
+    if (message.includes("Please initialize git locally")) {
+      throw new ValidateGitSetupError(errorMessage);
+    } else {
+      throw new Error(errorMessage);
     }
-    throw new Error(
-      `Could not validate your git setup against Superblocks for the ${resourceType.toLowerCase()} ${
-        resourceName ?? resourceId
-      }${message ? "\n" + message : ""}`
-    );
   }
 }
 
@@ -450,7 +494,7 @@ export async function registerComponents(
       const config: AxiosRequestConfig = {
         method: "put",
         url: new URL(
-          `${BASE_SERVER_PUBLIC_API_URL}/application/${applicationId}${branchPath}/components`,
+          `${BASE_SERVER_PUBLIC_API_URL_V1}/application/${applicationId}${branchPath}/components`,
           superblocksBaseUrl
         ).toString(),
         headers: {
@@ -631,7 +675,7 @@ export async function fetchCurrentUser(
     const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(
-        `${BASE_SERVER_PUBLIC_API_URL}/users/me`,
+        `${BASE_SERVER_PUBLIC_API_URL_V1}/users/me`,
         superblocksBaseUrl
       ).toString(),
       headers: {
@@ -666,6 +710,7 @@ export async function pushApplication({
   applicationConfig,
   branch,
   injectedHeaders = {},
+  multiPage = false,
 }: {
   cliVersion: string;
   applicationId: string;
@@ -673,7 +718,10 @@ export async function pushApplication({
   superblocksBaseUrl: string;
   branch: string;
   injectedHeaders: Record<string, string>;
-  applicationConfig: PushApplicationWithCommitConfig;
+  applicationConfig:
+    | PushApplicationWithCommitConfig
+    | PushMultiPageApplicationWithCommitConfig;
+  multiPage?: boolean;
 }): Promise<RemoteCommitDto | undefined> {
   const handleHttpError = (status: number) => {
     if (status === 405) {
@@ -706,15 +754,29 @@ export async function pushApplication({
         superblocksBaseUrl,
         token,
       });
-      const resp = await socket.call.v1.public.application.pushCommit({
-        applicationId,
-        apis: applicationConfig.apis,
-        application: applicationConfig.application,
-        branchName: branch,
-        commitId: applicationConfig.commitId,
-        commitMessage: applicationConfig.commitMessage,
-        page: applicationConfig.page,
-      });
+      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,
+          })
+        : 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,
+          });
       socket.close();
       handleHttpError(resp.responseMeta.status);
       if (resp.responseMeta.status !== 200) {
@@ -725,8 +787,12 @@ 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(
-        `${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}/branches/${encodeURIComponent(
+        `${baseServerPublicApiUrl}/applications/${applicationId}/branches/${encodeURIComponent(
           branch
         )}/push`,
         superblocksBaseUrl
@@ -765,6 +831,7 @@ export async function pushApplication({
       e instanceof BranchNotCheckedOutError ||
       e instanceof CommitAlreadyExistsError
     ) {
+      // Rethrow these exceptions because they will be handled higher up the call stack
       throw e;
     }
     throw new Error(
@@ -802,7 +869,7 @@ export async function pushApi({
     }
   };
   const serverURL = new URL(
-    `${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}/branches/${encodeURIComponent(
+    `${BASE_SERVER_PUBLIC_API_URL_V1}/apis/${apiId}/branches/${encodeURIComponent(
       branch
     )}/push`,
     superblocksBaseUrl
@@ -873,6 +940,7 @@ export async function pushApi({
       e instanceof BranchNotCheckedOutError ||
       e instanceof CommitAlreadyExistsError
     ) {
+      // Rethrow these exceptions because they will be handled higher up the call stack
       throw e;
     }
     throw new Error(

package/src/errors.ts

@@ -11,3 +11,10 @@ export class CommitAlreadyExistsError extends Error {
     this.name = "CommitAlreadyExistsError";
   }
 }
+
+export class ValidateGitSetupError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = "ValidateGitSetupError";
+  }
+}

package/src/sdk.ts

@@ -15,6 +15,7 @@ import {
   PushApiWithCommitConfig,
   pushApplication,
   PushApplicationWithCommitConfig,
+  PushMultiPageApplicationWithCommitConfig,
   registerComponents,
   uploadComponents,
   validateGitSetup,
@@ -44,11 +45,13 @@ export class SuperblocksSdk {
     branch,
     headers = {},
     viewMode = "export-live",
+    fetchSinglePageApplication = false,
   }: {
     applicationId: string;
     branch?: string;
     headers?: Record<string, string>;
     viewMode?: ViewMode;
+    fetchSinglePageApplication?: boolean;
   }) {
     return fetchApplication({
       cliVersion: this.cliVersion,
@@ -58,6 +61,7 @@ export class SuperblocksSdk {
       superblocksBaseUrl: this.superblocksBaseUrl,
       viewMode,
       injectedHeaders: headers,
+      fetchSinglePageApplication,
     });
   }
 
@@ -76,11 +80,13 @@ export class SuperblocksSdk {
     branch,
     headers = {},
     viewMode = "export-live",
+    fetchSinglePageApplication = false,
   }: {
     applicationId: string;
     branch: string;
     headers?: Record<string, string>;
     viewMode?: ViewMode;
+    fetchSinglePageApplication?: boolean;
   }) {
     return fetchApplicationWithComponents({
       cliVersion: this.cliVersion,
@@ -90,6 +96,7 @@ export class SuperblocksSdk {
       superblocksBaseUrl: this.superblocksBaseUrl,
       viewMode,
       injectedHeaders: headers,
+      fetchSinglePageApplication,
     });
   }
 
@@ -187,11 +194,15 @@ export class SuperblocksSdk {
     applicationConfig,
     branch,
     headers = {},
+    multiPage = false,
   }: {
     applicationId: string;
-    applicationConfig: PushApplicationWithCommitConfig;
+    applicationConfig:
+      | PushApplicationWithCommitConfig
+      | PushMultiPageApplicationWithCommitConfig;
     branch: string;
     headers?: Record<string, string>;
+    multiPage?: boolean;
   }) {
     return pushApplication({
       cliVersion: this.cliVersion,
@@ -201,6 +212,7 @@ export class SuperblocksSdk {
       branch,
       injectedHeaders: headers,
       applicationConfig,
+      multiPage,
     });
   }
   async pushApi({

package/src/socket/handlers.ts

@@ -115,6 +115,24 @@ export interface ServerMethods {
       };
     };
   };
+  v2: {
+    public: {
+      application: {
+        pushCommit: ServerMethodSchema<
+          {
+            applicationId: string;
+            branchName: string;
+            commitId: string;
+            commitMessage: string;
+            application: Record<string, unknown>;
+            pages: Record<string, unknown>[];
+            apis: Record<string, unknown>[];
+          },
+          RemoteCommitDto
+        >;
+      };
+    };
+  };
 }
 
 export function createRequestHandlers({

package/src/types/common.ts

@@ -7,6 +7,7 @@ export interface UserMeDto {
 
 export interface FlagBootstrap {
   "ui.enable-resource-signing"?: boolean;
+  "server.multipage.enabled"?: boolean;
 }
 
 export type User = {
@@ -121,6 +122,21 @@ export type Api = {
   signature?: Signature;
 };
 
+export type ApiWithPb = {
+  id: string;
+  pageId?: string;
+  apiPb: Api;
+};
+
+export type Page = {
+  id: string;
+  applicationId: string;
+  isHidden: boolean;
+  layouts: Record<string, unknown>[];
+  name: string;
+  apis: ApiWithPb[];
+};
+
 /** A signature, as produced by the agent. */
 export interface Signature {
   /** The id of the key used to sign the data. */