@superblocksteam/sdk 0.0.21 → 0.0.23

package/dist/client.d.ts

@@ -4,16 +4,17 @@ export interface UploadFile {
     filename: string;
     ContentType: string;
 }
-export declare function fetchApplication({ applicationId, token, superblocksBaseUrl, viewMode, }: {
+export declare function fetchApplication({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders, }: {
     applicationId: string;
     token: string;
     superblocksBaseUrl: string;
     viewMode: ViewMode;
+    injectedHeaders: Record<string, string>;
 }): Promise<any>;
-export declare function fetchApplications(token: string, superblocksBaseUrl: string): Promise<any>;
+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>;
-export declare function registerComponents(applicationId: string, componentConfigs: Record<string, any>, token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function registerComponents(applicationId: string, componentConfigs: Record<string, any>, token: string, superblocksBaseUrl: string, injectedHeaders?: Record<string, string>): Promise<any>;
 export declare function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, }: {
     applicationId: string;
     componentConfigs: Record<string, any>;

package/dist/client.js

@@ -6,11 +6,37 @@ 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";
-async function fetchApplication({ applicationId, token, superblocksBaseUrl, viewMode, }) {
-    var _a;
+const SUPERBLOCKS_URL_HEADER = "x-superblocks-url";
+async function fetchApplication({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
+    var _a, _b, _c, _d, _e, _f;
+    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 Error(`Application ${applicationId} was not found`);
+        }
+        throw new Error("Could not fetch application");
+    }
+    // if there are no custom components, just return here without trying to initialize them using bucketeer
+    if ((0, lodash_1.isEmpty)((_e = (_d = (_c = (_b = serverResponse === null || serverResponse === void 0 ? void 0 : serverResponse.data) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.application) === null || _d === void 0 ? void 0 : _d.settings) === null || _e === void 0 ? void 0 : _e.registeredComponents)) {
+        return serverResponse.data.data;
+    }
     // TODO(jason) update this with commit ID once we enable fetching by commit
     const commitId = "latest";
     superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
@@ -23,27 +49,29 @@ async function fetchApplication({ applicationId, token, superblocksBaseUrl, view
             url: componentFileURL,
             headers: {
                 Authorization: "Bearer " + token,
-                "x-superblocks-url": superblocksBaseUrl,
+                [SUPERBLOCKS_URL_HEADER]: superblocksBaseUrl,
+                ...injectedHeaders,
             },
         };
         const response = await (0, axios_1.default)(config);
         return response.data;
     }
     catch (e) {
-        if (axios_1.default.isAxiosError(e) && ((_a = e.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+        if (axios_1.default.isAxiosError(e) && ((_f = e.response) === null || _f === void 0 ? void 0 : _f.status) === 404) {
             throw new Error(`Application ${applicationId} was not found`);
         }
         throw new Error("Could not fetch application");
     }
 }
 exports.fetchApplication = fetchApplication;
-async function fetchApplications(token, superblocksBaseUrl) {
+async function fetchApplications(token, superblocksBaseUrl, injectedHeaders = {}) {
     try {
         const config = {
             method: "get",
             url: new URL(`/api/v2/applications`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                ...injectedHeaders,
             },
         };
         const response = await (0, axios_1.default)(config);
@@ -92,7 +120,7 @@ async function fetchApis(token, superblocksBaseUrl) {
     }
 }
 exports.fetchApis = fetchApis;
-async function registerComponents(applicationId, componentConfigs, token, superblocksBaseUrl) {
+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);
@@ -102,6 +130,7 @@ async function registerComponents(applicationId, componentConfigs, token, superb
             headers: {
                 Authorization: "Bearer " + token,
                 [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+                ...injectedHeaders,
             },
             data: { components: componentConfigs },
         };
@@ -118,7 +147,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
@@ -129,7 +158,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,
         };
     });
@@ -142,11 +172,22 @@ 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);
@@ -154,7 +195,8 @@ async function uploadComponents({ applicationId, componentConfigs, files, token,
             headers: {
                 Authorization: "Bearer " + token,
                 [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
-                "x-superblocks-url": superblocksBaseUrl,
+                [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.UPLOAD,
+                [SUPERBLOCKS_URL_HEADER]: superblocksBaseUrl,
                 ...formHeaders,
             },
         };
@@ -162,10 +204,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}`);
@@ -179,6 +224,7 @@ async function fetchCurrentUser(token, superblocksBaseUrl) {
             url: new URL(`/api/v1/users/me`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.LOGIN,
             },
         };
         const response = await (0, axios_1.default)(config);

package/dist/sdk.d.ts

@@ -3,11 +3,15 @@ export declare class SuperblocksSdk {
     token: string;
     superblocksBaseUrl: string;
     constructor(accessToken: string, superblocksBaseUrl: string);
-    fetchApplication(applicationId: string, viewMode?: ViewMode): Promise<any>;
-    fetchApplications(): Promise<any>;
+    fetchApplication({ applicationId, headers, viewMode, }: {
+        applicationId: string;
+        headers?: Record<string, string>;
+        viewMode?: ViewMode;
+    }): Promise<any>;
+    fetchApplications(headers?: Record<string, string>): Promise<any>;
     fetchApi(apiId: string, viewMode?: ViewMode): Promise<any>;
     fetchApis(): Promise<any>;
-    registerComponents(applicationId: string, componentConfigs: Record<string, any>): Promise<any>;
+    registerComponents(applicationId: string, componentConfigs: Record<string, any>, injectedHeaders?: Record<string, string>): Promise<any>;
     uploadComponents(applicationId: string, componentConfigs: Record<string, any>, files: string[]): Promise<any>;
     fetchCurrentUser(): Promise<any>;
 }

package/dist/sdk.js

@@ -9,16 +9,17 @@ class SuperblocksSdk {
         this.token = accessToken;
         this.superblocksBaseUrl = superblocksBaseUrl;
     }
-    async fetchApplication(applicationId, viewMode = "export-live") {
+    async fetchApplication({ applicationId, headers = {}, viewMode = "export-live", }) {
         return (0, client_1.fetchApplication)({
             applicationId,
             token: this.token,
             superblocksBaseUrl: this.superblocksBaseUrl,
             viewMode,
+            injectedHeaders: headers,
         });
     }
-    async fetchApplications() {
-        return (0, client_1.fetchApplications)(this.token, this.superblocksBaseUrl);
+    async fetchApplications(headers) {
+        return (0, client_1.fetchApplications)(this.token, this.superblocksBaseUrl, headers);
     }
     async fetchApi(apiId, viewMode = "export-live") {
         return (0, client_1.fetchApi)(apiId, this.token, this.superblocksBaseUrl, viewMode);
@@ -26,8 +27,8 @@ class SuperblocksSdk {
     async fetchApis() {
         return (0, client_1.fetchApis)(this.token, this.superblocksBaseUrl);
     }
-    async registerComponents(applicationId, componentConfigs) {
-        return (0, client_1.registerComponents)(applicationId, componentConfigs, this.token, this.superblocksBaseUrl);
+    async registerComponents(applicationId, componentConfigs, injectedHeaders) {
+        return (0, client_1.registerComponents)(applicationId, componentConfigs, this.token, this.superblocksBaseUrl, injectedHeaders);
     }
     async uploadComponents(applicationId, componentConfigs, files) {
         return (0, client_1.uploadComponents)({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "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": "0.0.23",
     "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

@@ -1,16 +1,22 @@
 import * as fs from "fs";
 import {
+  ComponentEvent,
   getBucketeerUrlFromSuperblocksUrl,
   getContentType,
+  COMPONENT_EVENT_HEADER,
 } from "@superblocksteam/util";
 import { getSuperblocksMonorepoConfigJson } from "@superblocksteam/util";
 import axios, { AxiosError } 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";
 
 export type ViewMode = "export-deployed" | "export-latest" | "export-live";
 
@@ -25,12 +31,46 @@ export async function fetchApplication({
   token,
   superblocksBaseUrl,
   viewMode,
+  injectedHeaders = {},
 }: {
   applicationId: string;
   token: string;
   superblocksBaseUrl: string;
   viewMode: ViewMode;
+  injectedHeaders: Record<string, string>;
 }) {
+  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 axios(config);
+  } catch (e) {
+    if (axios.isAxiosError(e) && e.response?.status === 404) {
+      throw new Error(`Application ${applicationId} was not found`);
+    }
+    throw new Error("Could not fetch application");
+  }
+
+  // if there are no custom components, just return here without trying to initialize them using bucketeer
+  if (
+    isEmpty(
+      serverResponse?.data?.data?.application?.settings?.registeredComponents
+    )
+  ) {
+    return serverResponse.data.data;
+  }
+
   // TODO(jason) update this with commit ID once we enable fetching by commit
   const commitId = "latest";
   superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
@@ -49,7 +89,8 @@ export async function fetchApplication({
       url: componentFileURL,
       headers: {
         Authorization: "Bearer " + token,
-        "x-superblocks-url": superblocksBaseUrl,
+        [SUPERBLOCKS_URL_HEADER]: superblocksBaseUrl,
+        ...injectedHeaders,
       },
     };
     const response = await axios(config);
@@ -64,7 +105,8 @@ export async function fetchApplication({
 
 export async function fetchApplications(
   token: string,
-  superblocksBaseUrl: string
+  superblocksBaseUrl: string,
+  injectedHeaders: Record<string, string> = {}
 ) {
   try {
     const config = {
@@ -72,6 +114,7 @@ export async function fetchApplications(
       url: new URL(`/api/v2/applications`, superblocksBaseUrl).toString(),
       headers: {
         Authorization: "Bearer " + token,
+        ...injectedHeaders,
       },
     };
     const response = await axios(config);
@@ -128,7 +171,8 @@ export async function registerComponents(
   applicationId: string,
   componentConfigs: Record<string, any>,
   token: string,
-  superblocksBaseUrl: string
+  superblocksBaseUrl: string,
+  injectedHeaders?: Record<string, string>
 ) {
   try {
     const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
@@ -141,6 +185,7 @@ export async function registerComponents(
       headers: {
         Authorization: "Bearer " + token,
         [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+        ...injectedHeaders,
       },
       data: { components: componentConfigs },
     };
@@ -190,7 +235,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;
   });
@@ -213,11 +259,23 @@ 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 {
@@ -226,7 +284,8 @@ export async function uploadComponents({
       headers: {
         Authorization: "Bearer " + token,
         [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
-        "x-superblocks-url": superblocksBaseUrl,
+        [COMPONENT_EVENT_HEADER]: ComponentEvent.UPLOAD,
+        [SUPERBLOCKS_URL_HEADER]: superblocksBaseUrl,
         ...formHeaders,
       },
     };
@@ -235,7 +294,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
@@ -256,6 +319,7 @@ export async function fetchCurrentUser(
       url: new URL(`/api/v1/users/me`, superblocksBaseUrl).toString(),
       headers: {
         Authorization: "Bearer " + token,
+        [COMPONENT_EVENT_HEADER]: ComponentEvent.LOGIN,
       },
     };
     const response = await axios(config);

package/src/sdk.ts

@@ -1,7 +1,7 @@
 import {
   fetchApi,
   fetchApis,
-  fetchApplication,
+  fetchApplication as fetchApplicationClient,
   fetchApplications,
   registerComponents,
   uploadComponents,
@@ -18,20 +18,26 @@ export class SuperblocksSdk {
     this.superblocksBaseUrl = superblocksBaseUrl;
   }
 
-  async fetchApplication(
-    applicationId: string,
-    viewMode: ViewMode = "export-live"
-  ) {
-    return fetchApplication({
+  async fetchApplication({
+    applicationId,
+    headers = {},
+    viewMode = "export-live",
+  }: {
+    applicationId: string;
+    headers?: Record<string, string>;
+    viewMode?: ViewMode;
+  }) {
+    return fetchApplicationClient({
       applicationId,
       token: this.token,
       superblocksBaseUrl: this.superblocksBaseUrl,
       viewMode,
+      injectedHeaders: headers,
     });
   }
 
-  async fetchApplications() {
-    return fetchApplications(this.token, this.superblocksBaseUrl);
+  async fetchApplications(headers?: Record<string, string>) {
+    return fetchApplications(this.token, this.superblocksBaseUrl, headers);
   }
 
   async fetchApi(apiId: string, viewMode: ViewMode = "export-live") {
@@ -44,13 +50,15 @@ export class SuperblocksSdk {
 
   async registerComponents(
     applicationId: string,
-    componentConfigs: Record<string, any>
+    componentConfigs: Record<string, any>,
+    injectedHeaders?: Record<string, string>
   ) {
     return registerComponents(
       applicationId,
       componentConfigs,
       this.token,
-      this.superblocksBaseUrl
+      this.superblocksBaseUrl,
+      injectedHeaders
     );
   }