@superblocksteam/sdk 0.0.22 → 1.0.0

package/dist/client.d.ts

@@ -4,13 +4,27 @@ export interface UploadFile {
     filename: string;
     ContentType: string;
 }
+export interface ApplicationWrapper {
+    application: Record<string, any>;
+    page: Record<string, any>;
+    apis: Record<string, any>[];
+}
 export declare function fetchApplication({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
     applicationId: string;
     token: string;
     superblocksBaseUrl: string;
     viewMode: ViewMode;
     injectedHeaders: Record<string, string>;
-}): Promise<any>;
+}): Promise<ApplicationWrapper | undefined>;
+export declare function fetchApplicationWithComponents({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
+    applicationId: string;
+    token: string;
+    superblocksBaseUrl: string;
+    viewMode: ViewMode;
+    injectedHeaders: Record<string, string>;
+}): Promise<(ApplicationWrapper & {
+    componentFiles: any;
+}) | undefined>;
 export declare function fetchApplications(token: string, superblocksBaseUrl: string, injectedHeaders?: Record<string, string>): Promise<any>;
 export declare function fetchApi(apiId: string, token: string, superblocksBaseUrl: string, viewMode: ViewMode): Promise<any>;
 export declare function fetchApis(token: string, superblocksBaseUrl: string): Promise<any>;

package/dist/client.js

@@ -1,17 +1,59 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchCurrentUser = exports.uploadComponents = exports.registerComponents = exports.fetchApis = exports.fetchApi = exports.fetchApplications = exports.fetchApplication = void 0;
+exports.fetchCurrentUser = exports.uploadComponents = exports.registerComponents = exports.fetchApis = exports.fetchApi = exports.fetchApplications = exports.fetchApplicationWithComponents = exports.fetchApplication = void 0;
 const fs = require("fs");
 const util_1 = require("@superblocksteam/util");
-const util_2 = require("@superblocksteam/util");
 const axios_1 = require("axios");
 const FormData = require("form-data");
+const lodash_1 = require("lodash");
 const BASE_SERVER_URL = "api/v1";
 const BASE_BUCKETEER_URL = "api/v1";
+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({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
-    var _a;
+    var _a, _b;
+    const serverURL = new URL(`api/v2/applications/${applicationId}?viewMode=${viewMode}`, superblocksBaseUrl);
+    let serverResponse;
+    try {
+        const config = {
+            method: "get",
+            url: serverURL.toString(),
+            headers: {
+                Authorization: "Bearer " + token,
+                ...injectedHeaders,
+            },
+        };
+        serverResponse = await (0, axios_1.default)(config);
+    }
+    catch (e) {
+        if (axios_1.default.isAxiosError(e) && ((_a = e.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+            throw new util_1.NotFoundError(`Application ${applicationId} was not found`);
+        }
+        throw new Error("Could not fetch application");
+    }
+    return (_b = serverResponse === null || serverResponse === void 0 ? void 0 : serverResponse.data) === null || _b === void 0 ? void 0 : _b.data;
+}
+exports.fetchApplication = fetchApplication;
+async function fetchApplicationWithComponents({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
+    var _a, _b, _c;
+    const applicationWrapper = await fetchApplication({
+        applicationId,
+        token,
+        superblocksBaseUrl,
+        viewMode,
+        injectedHeaders,
+    });
+    if ((0, lodash_1.isEmpty)(applicationWrapper)) {
+        return;
+    }
+    // if there are no custom components, just return here without trying to initialize them using bucketeer
+    if ((0, lodash_1.isEmpty)((_b = (_a = applicationWrapper.application) === null || _a === void 0 ? void 0 : _a.settings) === null || _b === void 0 ? void 0 : _b.registeredComponents)) {
+        return {
+            ...applicationWrapper,
+            componentFiles: null,
+        };
+    }
     // TODO(jason) update this with commit ID once we enable fetching by commit
     const commitId = "latest";
     superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
@@ -32,13 +74,13 @@ async function fetchApplication({ applicationId, token, superblocksBaseUrl, view
         return response.data;
     }
     catch (e) {
-        if (axios_1.default.isAxiosError(e) && ((_a = e.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
-            throw new Error(`Application ${applicationId} was not found`);
+        if (axios_1.default.isAxiosError(e) && ((_c = e.response) === null || _c === void 0 ? void 0 : _c.status) === 404) {
+            throw new util_1.NotFoundError(`Application ${applicationId} was not found`);
         }
         throw new Error("Could not fetch application");
     }
 }
-exports.fetchApplication = fetchApplication;
+exports.fetchApplicationWithComponents = fetchApplicationWithComponents;
 async function fetchApplications(token, superblocksBaseUrl, injectedHeaders = {}) {
     try {
         const config = {
@@ -72,7 +114,7 @@ async function fetchApi(apiId, token, superblocksBaseUrl, viewMode) {
     }
     catch (e) {
         if (axios_1.default.isAxiosError(e) && ((_a = e.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
-            throw new Error(`Api ${apiId} was not found`);
+            throw new util_1.NotFoundError(`Api ${apiId} was not found`);
         }
         throw new Error("Could not fetch api");
     }
@@ -98,7 +140,7 @@ exports.fetchApis = fetchApis;
 async function registerComponents(applicationId, componentConfigs, token, superblocksBaseUrl, injectedHeaders) {
     var _a, _b, _c, _d, _e, _f, _g;
     try {
-        const [rootSettings] = await (0, util_2.getSuperblocksMonorepoConfigJson)(true);
+        const [rootSettings] = await (0, util_1.getSuperblocksMonorepoConfigJson)(true);
         const config = {
             method: "put",
             url: new URL(`${BASE_SERVER_URL}/public/application/${applicationId}/components`, superblocksBaseUrl).toString(),
@@ -122,7 +164,7 @@ async function registerComponents(applicationId, componentConfigs, token, superb
 }
 exports.registerComponents = registerComponents;
 async function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, }) {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
     superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
     const bucketeerBaseUrl = (0, util_1.getBucketeerUrlFromSuperblocksUrl)(superblocksBaseUrl);
     // parse files to source and bundled files based on path
@@ -133,7 +175,8 @@ async function uploadComponents({ applicationId, componentConfigs, files, token,
         }
         return {
             name: `file${ind + 1}`,
-            filename: file,
+            // win32 => posix filepath. Bucketeer does not accept windows style filepaths
+            filename: file.replace(/\\/g, "/"),
             ContentType: contentType,
         };
     });
@@ -146,14 +189,25 @@ async function uploadComponents({ applicationId, componentConfigs, files, token,
         buildFiles,
     });
     const postURL = new URL(`${BASE_BUCKETEER_URL}/components/upload`, bucketeerBaseUrl).toString();
+    let totalFileSizeMB = 0;
     const formData = new FormData();
     formData.append("format", formatJSON);
     uploadFiles.forEach((uploadFile) => {
+        const uploadFileStats = fs.statSync(uploadFile.filename);
+        totalFileSizeMB += uploadFileStats.size / (1024 * 1024);
         formData.append(uploadFile.name, fs.createReadStream(uploadFile.filename));
     });
+    if (totalFileSizeMB > SUPERBLOCKS_MAX_FILE_SIZE_MB) {
+        throw new Error(`upload size exceeded maximum allowed size.
+
+Current Size: ${totalFileSizeMB.toFixed(2)} MB
+Max Allowed Size: ${SUPERBLOCKS_MAX_FILE_SIZE_MB.toFixed(0)} MB
+
+You can reduce your component bundle size by uploading static assets to a separate service.`);
+    }
     const formHeaders = formData.getHeaders();
     try {
-        const [rootSettings] = await (0, util_2.getSuperblocksMonorepoConfigJson)(true);
+        const [rootSettings] = await (0, util_1.getSuperblocksMonorepoConfigJson)(true);
         const config = {
             headers: {
                 Authorization: "Bearer " + token,
@@ -167,10 +221,13 @@ async function uploadComponents({ applicationId, componentConfigs, files, token,
         return response.data;
     }
     catch (e) {
-        if (e instanceof axios_1.AxiosError) {
-            const message = (_d = (_c = (_b = (_a = e.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.responseMeta) === null || _c === void 0 ? void 0 : _c.message) !== null && _d !== void 0 ? _d : (_e = e.response) === null || _e === void 0 ? void 0 : _e.data;
+        if (e instanceof axios_1.AxiosError && ((_a = e.response) === null || _a === void 0 ? void 0 : _a.status) === 413) {
+            throw new Error(`Could not upload application components, file size limit exceeded`);
+        }
+        else if (e instanceof axios_1.AxiosError) {
+            const message = (_e = (_d = (_c = (_b = e.response) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.responseMeta) === null || _d === void 0 ? void 0 : _d.message) !== null && _e !== void 0 ? _e : (_f = e.response) === null || _f === void 0 ? void 0 : _f.data;
             throw new Error(`Could not upload application components
-${message !== null && message !== void 0 ? message : (_f = e.response) === null || _f === void 0 ? void 0 : _f.statusText}`);
+${message !== null && message !== void 0 ? message : (_g = e.response) === null || _g === void 0 ? void 0 : _g.statusText}`);
         }
         throw new Error(`Could not upload application components
 ${e.message}`);

package/dist/sdk.d.ts

@@ -7,7 +7,14 @@ export declare class SuperblocksSdk {
         applicationId: string;
         headers?: Record<string, string>;
         viewMode?: ViewMode;
-    }): Promise<any>;
+    }): Promise<import("./client").ApplicationWrapper | undefined>;
+    fetchApplicationWithComponents({ applicationId, headers, viewMode, }: {
+        applicationId: string;
+        headers?: Record<string, string>;
+        viewMode?: ViewMode;
+    }): Promise<(import("./client").ApplicationWrapper & {
+        componentFiles: any;
+    }) | undefined>;
     fetchApplications(headers?: Record<string, string>): Promise<any>;
     fetchApi(apiId: string, viewMode?: ViewMode): Promise<any>;
     fetchApis(): Promise<any>;

package/dist/sdk.js

@@ -18,6 +18,15 @@ class SuperblocksSdk {
             injectedHeaders: headers,
         });
     }
+    async fetchApplicationWithComponents({ applicationId, headers = {}, viewMode = "export-live", }) {
+        return (0, client_1.fetchApplicationWithComponents)({
+            applicationId,
+            token: this.token,
+            superblocksBaseUrl: this.superblocksBaseUrl,
+            viewMode,
+            injectedHeaders: headers,
+        });
+    }
     async fetchApplications(headers) {
         return (0, client_1.fetchApplications)(this.token, this.superblocksBaseUrl, headers);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "0.0.22",
+  "version": "1.0.0",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {
@@ -17,7 +17,8 @@
     "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"
+    "lint:fix": "eslint . --ext .ts --config .eslintrc.json --fix",
+    "typecheck": "tsc --noEmit"
   },
   "license": "Superblocks Community Software License",
   "devDependencies": {
@@ -29,11 +30,12 @@
     "typescript": "^5.1.3"
   },
   "dependencies": {
-    "@superblocksteam/util": "*",
+    "@superblocksteam/util": "1.0.0",
     "axios": "^1.3.5"
   },
   "homepage": "https://www.superblocks.com",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=16.0.0",
+    "npm": ">=8.0.0"
   }
 }

package/src/client.ts

@@ -2,16 +2,20 @@ import * as fs from "fs";
 import {
   ComponentEvent,
   getBucketeerUrlFromSuperblocksUrl,
+  getSuperblocksMonorepoConfigJson,
   getContentType,
   COMPONENT_EVENT_HEADER,
+  NotFoundError,
 } from "@superblocksteam/util";
-import { getSuperblocksMonorepoConfigJson } from "@superblocksteam/util";
-import axios, { AxiosError } from "axios";
+import axios, { AxiosError, AxiosRequestConfig } from "axios";
 import * as FormData from "form-data";
+import { isEmpty } from "lodash";
 
 const BASE_SERVER_URL = "api/v1";
 const BASE_BUCKETEER_URL = "api/v1";
 
+const SUPERBLOCKS_MAX_FILE_SIZE_MB = 10;
+
 const CLI_VERSION_HEADER = "x-superblocks-cli-version";
 const SUPERBLOCKS_URL_HEADER = "x-superblocks-url";
 
@@ -23,6 +27,14 @@ export interface UploadFile {
   ContentType: string;
 }
 
+export interface ApplicationWrapper {
+  application: Record<string, any>;
+  page: Record<string, any>;
+  apis: Record<string, any>[];
+}
+
+type ResponseWithMeta<T> = { responseMeta: unknown; data: T };
+
 export async function fetchApplication({
   applicationId,
   token,
@@ -35,7 +47,66 @@ export async function fetchApplication({
   superblocksBaseUrl: string;
   viewMode: ViewMode;
   injectedHeaders: Record<string, string>;
-}) {
+}): Promise<ApplicationWrapper | undefined> {
+  const serverURL = new URL(
+    `api/v2/applications/${applicationId}?viewMode=${viewMode}`,
+    superblocksBaseUrl
+  );
+  let serverResponse;
+
+  try {
+    const config: AxiosRequestConfig = {
+      method: "get",
+      url: serverURL.toString(),
+      headers: {
+        Authorization: "Bearer " + token,
+        ...injectedHeaders,
+      },
+    };
+    serverResponse = await axios<ResponseWithMeta<ApplicationWrapper>>(config);
+  } 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 fetchApplicationWithComponents({
+  applicationId,
+  token,
+  superblocksBaseUrl,
+  viewMode,
+  injectedHeaders = {},
+}: {
+  applicationId: string;
+  token: string;
+  superblocksBaseUrl: string;
+  viewMode: ViewMode;
+  injectedHeaders: Record<string, string>;
+}): Promise<(ApplicationWrapper & { componentFiles: any }) | undefined> {
+  const applicationWrapper = await fetchApplication({
+    applicationId,
+    token,
+    superblocksBaseUrl,
+    viewMode,
+    injectedHeaders,
+  });
+
+  if (isEmpty(applicationWrapper)) {
+    return;
+  }
+
+  // if there are no custom components, just return here without trying to initialize them using bucketeer
+  if (isEmpty(applicationWrapper.application?.settings?.registeredComponents)) {
+    return {
+      ...applicationWrapper,
+      componentFiles: null,
+    };
+  }
+
   // TODO(jason) update this with commit ID once we enable fetching by commit
   const commitId = "latest";
   superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
@@ -49,7 +120,7 @@ export async function fetchApplication({
   ).toString();
 
   try {
-    const config = {
+    const config: AxiosRequestConfig = {
       method: "get",
       url: componentFileURL,
       headers: {
@@ -62,7 +133,7 @@ export async function fetchApplication({
     return response.data;
   } catch (e) {
     if (axios.isAxiosError(e) && e.response?.status === 404) {
-      throw new Error(`Application ${applicationId} was not found`);
+      throw new NotFoundError(`Application ${applicationId} was not found`);
     }
     throw new Error("Could not fetch application");
   }
@@ -74,7 +145,7 @@ export async function fetchApplications(
   injectedHeaders: Record<string, string> = {}
 ) {
   try {
-    const config = {
+    const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(`/api/v2/applications`, superblocksBaseUrl).toString(),
       headers: {
@@ -96,7 +167,7 @@ export async function fetchApi(
   viewMode: ViewMode
 ) {
   try {
-    const config = {
+    const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(
         `/api/v3/apis/${apiId}?viewMode=${viewMode}`,
@@ -110,7 +181,7 @@ export async function fetchApi(
     return response.data.data;
   } catch (e) {
     if (axios.isAxiosError(e) && e.response?.status === 404) {
-      throw new Error(`Api ${apiId} was not found`);
+      throw new NotFoundError(`Api ${apiId} was not found`);
     }
     throw new Error("Could not fetch api");
   }
@@ -118,7 +189,7 @@ export async function fetchApi(
 
 export async function fetchApis(token: string, superblocksBaseUrl: string) {
   try {
-    const config = {
+    const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(`/api/v3/apis`, superblocksBaseUrl).toString(),
       headers: {
@@ -141,7 +212,7 @@ export async function registerComponents(
 ) {
   try {
     const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
-    const config = {
+    const config: AxiosRequestConfig = {
       method: "put",
       url: new URL(
         `${BASE_SERVER_URL}/public/application/${applicationId}/components`,
@@ -200,7 +271,8 @@ export async function uploadComponents({
     }
     return {
       name: `file${ind + 1}`,
-      filename: file,
+      // win32 => posix filepath. Bucketeer does not accept windows style filepaths
+      filename: file.replace(/\\/g, "/"),
       ContentType: contentType,
     } as UploadFile;
   });
@@ -223,16 +295,28 @@ export async function uploadComponents({
     bucketeerBaseUrl
   ).toString();
 
+  let totalFileSizeMB = 0;
   const formData = new FormData();
   formData.append("format", formatJSON);
   uploadFiles.forEach((uploadFile) => {
+    const uploadFileStats = fs.statSync(uploadFile.filename);
+    totalFileSizeMB += uploadFileStats.size / (1024 * 1024);
     formData.append(uploadFile.name, fs.createReadStream(uploadFile.filename));
   });
+
+  if (totalFileSizeMB > SUPERBLOCKS_MAX_FILE_SIZE_MB) {
+    throw new Error(`upload size exceeded maximum allowed size.
+
+Current Size: ${totalFileSizeMB.toFixed(2)} MB
+Max Allowed Size: ${SUPERBLOCKS_MAX_FILE_SIZE_MB.toFixed(0)} MB
+
+You can reduce your component bundle size by uploading static assets to a separate service.`);
+  }
   const formHeaders = formData.getHeaders();
 
   try {
     const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
-    const config = {
+    const config: AxiosRequestConfig = {
       headers: {
         Authorization: "Bearer " + token,
         [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
@@ -246,7 +330,11 @@ export async function uploadComponents({
 
     return response.data;
   } catch (e: any) {
-    if (e instanceof AxiosError) {
+    if (e instanceof AxiosError && e.response?.status === 413) {
+      throw new Error(
+        `Could not upload application components, file size limit exceeded`
+      );
+    } else if (e instanceof AxiosError) {
       const message =
         (e.response?.data?.responseMeta?.message as string) ?? e.response?.data;
       throw new Error(`Could not upload application components
@@ -262,7 +350,7 @@ export async function fetchCurrentUser(
   superblocksBaseUrl: string
 ) {
   try {
-    const config = {
+    const config: AxiosRequestConfig = {
       method: "get",
       url: new URL(`/api/v1/users/me`, superblocksBaseUrl).toString(),
       headers: {

package/src/sdk.ts

@@ -1,7 +1,8 @@
 import {
   fetchApi,
   fetchApis,
-  fetchApplication as fetchApplicationClient,
+  fetchApplication,
+  fetchApplicationWithComponents,
   fetchApplications,
   registerComponents,
   uploadComponents,
@@ -27,7 +28,25 @@ export class SuperblocksSdk {
     headers?: Record<string, string>;
     viewMode?: ViewMode;
   }) {
-    return fetchApplicationClient({
+    return fetchApplication({
+      applicationId,
+      token: this.token,
+      superblocksBaseUrl: this.superblocksBaseUrl,
+      viewMode,
+      injectedHeaders: headers,
+    });
+  }
+
+  async fetchApplicationWithComponents({
+    applicationId,
+    headers = {},
+    viewMode = "export-live",
+  }: {
+    applicationId: string;
+    headers?: Record<string, string>;
+    viewMode?: ViewMode;
+  }) {
+    return fetchApplicationWithComponents({
       applicationId,
       token: this.token,
       superblocksBaseUrl: this.superblocksBaseUrl,