@superblocksteam/sdk 0.0.17 → 0.0.18

package/dist/client.d.ts

@@ -1,8 +1,19 @@
 export type ViewMode = "export-deployed" | "export-latest" | "export-live";
+export interface UploadFile {
+    name: string;
+    filename: string;
+    ContentType: string;
+}
 export declare function fetchApplication(applicationId: string, token: string, superblocksBaseUrl: string, viewMode: ViewMode): Promise<any>;
 export declare function fetchApplications(token: string, superblocksBaseUrl: 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 uploadComponents(applicationId: string, componentConfigs: Record<string, any>, files: string[], token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, }: {
+    applicationId: string;
+    componentConfigs: Record<string, any>;
+    files: string[];
+    token: string;
+    superblocksBaseUrl: string;
+}): Promise<any>;
 export declare function fetchCurrentUser(token: string, superblocksBaseUrl: string): Promise<any>;

package/dist/client.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchCurrentUser = exports.uploadComponents = exports.registerComponents = exports.fetchApis = exports.fetchApi = exports.fetchApplications = 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 BASE_SERVER_URL = "api/v1";
+const BASE_BUCKETEER_URL = "api/v1";
+const CLI_VERSION_HEADER = "X-Superblocks-CLI-Version";
 async function fetchApplication(applicationId, token, superblocksBaseUrl, viewMode) {
     var _a;
     const url = `/api/v2/applications/${applicationId}?viewMode=${viewMode}`;
@@ -81,12 +87,15 @@ async function fetchApis(token, superblocksBaseUrl) {
 }
 exports.fetchApis = fetchApis;
 async function registerComponents(applicationId, componentConfigs, token, superblocksBaseUrl) {
+    var _a, _b, _c;
     try {
+        const [rootSettings] = await (0, util_2.getSuperblocksMonorepoConfigJson)(true);
         const config = {
             method: "put",
             url: new URL(`${BASE_SERVER_URL}/public/application/${applicationId}/components`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
             },
             data: { components: componentConfigs },
         };
@@ -94,25 +103,67 @@ async function registerComponents(applicationId, componentConfigs, token, superb
         return response.data;
     }
     catch (e) {
-        throw new Error("Could not register application components");
+        if (e instanceof axios_1.AxiosError) {
+            const message = (_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;
+            throw new Error(`Could not register application components
+${message !== null && message !== void 0 ? message : ""}`);
+        }
+        throw new Error(`Could not register application components
+${e.message}`);
     }
 }
 exports.registerComponents = registerComponents;
-async function uploadComponents(applicationId, componentConfigs, files, token, superblocksBaseUrl) {
+async function uploadComponents({ applicationId, componentConfigs, files, token, superblocksBaseUrl, }) {
+    var _a, _b, _c;
+    const bucketeerBaseUrl = (0, util_1.getBucketeerUrlFromSuperblocksUrl)(superblocksBaseUrl);
+    // parse files to source and bundled files based on path
+    const uploadFiles = files.map((file, ind) => {
+        let contentType = (0, util_1.getContentType)(file);
+        if (contentType.length === 0) {
+            contentType = "application/octet-stream"; // default case when we don't know the encoding
+        }
+        return {
+            name: `file${ind + 1}`,
+            filename: file,
+            ContentType: contentType,
+        };
+    });
+    const buildFiles = uploadFiles.filter((uploadFile) => uploadFile.filename.startsWith("dist/"));
+    const srcFiles = uploadFiles.filter((uploadFile) => !uploadFile.filename.startsWith("dist/"));
+    const formatJSON = JSON.stringify({
+        applicationId,
+        registeredComponents: componentConfigs,
+        srcFiles,
+        buildFiles,
+    });
+    const postURL = new URL(`${BASE_BUCKETEER_URL}/components/upload`, bucketeerBaseUrl).toString();
+    const formData = new FormData();
+    formData.append("format", formatJSON);
+    uploadFiles.forEach((uploadFile) => {
+        formData.append(uploadFile.name, fs.createReadStream(uploadFile.filename));
+    });
+    const formHeaders = formData.getHeaders();
     try {
+        const [rootSettings] = await (0, util_2.getSuperblocksMonorepoConfigJson)(true);
         const config = {
-            method: "post",
-            url: new URL(`${BASE_SERVER_URL}/public/application/${applicationId}/publish`, superblocksBaseUrl).toString(),
             headers: {
                 Authorization: "Bearer " + token,
+                [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+                "x-superblocks-url": superblocksBaseUrl,
+                ...formHeaders,
             },
-            data: { components: componentConfigs, files },
         };
-        const response = await (0, axios_1.default)(config);
+        const response = await axios_1.default.post(postURL, formData, config);
         return response.data;
     }
     catch (e) {
-        throw new Error("Could not upload application components");
+        if (e instanceof axios_1.AxiosError) {
+            const message = (_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;
+            throw new Error(`Could not upload application components
+${message}`);
+        }
+        throw new Error(`Could not upload application components
+${e.message}`);
     }
 }
 exports.uploadComponents = uploadComponents;

package/dist/sdk.js

@@ -25,7 +25,13 @@ class SuperblocksSdk {
         return (0, client_1.registerComponents)(applicationId, componentConfigs, this.token, this.superblocksBaseUrl);
     }
     async uploadComponents(applicationId, componentConfigs, files) {
-        return (0, client_1.uploadComponents)(applicationId, componentConfigs, files, this.token, this.superblocksBaseUrl);
+        return (0, client_1.uploadComponents)({
+            applicationId,
+            componentConfigs,
+            files,
+            token: this.token,
+            superblocksBaseUrl: this.superblocksBaseUrl,
+        });
     }
     async fetchCurrentUser() {
         return (0, client_1.fetchCurrentUser)(this.token, this.superblocksBaseUrl);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {
@@ -29,6 +29,7 @@
     "typescript": "^5.1.3"
   },
   "dependencies": {
+    "@superblocksteam/util": "*",
     "axios": "^1.3.5"
   },
   "homepage": "https://www.superblocks.com",

package/src/client.ts

@@ -1,9 +1,25 @@
-import axios from "axios";
+import * as fs from "fs";
+import {
+  getBucketeerUrlFromSuperblocksUrl,
+  getContentType,
+} from "@superblocksteam/util";
+import { getSuperblocksMonorepoConfigJson } from "@superblocksteam/util";
+import axios, { AxiosError } from "axios";
+import * as FormData from "form-data";
 
 const BASE_SERVER_URL = "api/v1";
+const BASE_BUCKETEER_URL = "api/v1";
+
+const CLI_VERSION_HEADER = "X-Superblocks-CLI-Version";
 
 export type ViewMode = "export-deployed" | "export-latest" | "export-live";
 
+export interface UploadFile {
+  name: string;
+  filename: string;
+  ContentType: string;
+}
+
 export async function fetchApplication(
   applicationId: string,
   token: string,
@@ -98,6 +114,7 @@ export async function registerComponents(
   superblocksBaseUrl: string
 ) {
   try {
+    const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
     const config = {
       method: "put",
       url: new URL(
@@ -106,39 +123,98 @@ export async function registerComponents(
       ).toString(),
       headers: {
         Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
       },
       data: { components: componentConfigs },
     };
     const response = await axios(config);
     return response.data;
-  } catch (e) {
-    throw new Error("Could not register application components");
+  } catch (e: any) {
+    if (e instanceof AxiosError) {
+      const message = e.response?.data?.responseMeta?.message as string;
+      throw new Error(`Could not register application components
+${message ?? ""}`);
+    }
+    throw new Error(`Could not register application components
+${e.message as string}`);
   }
 }
 
-export async function uploadComponents(
-  applicationId: string,
-  componentConfigs: Record<string, any>,
-  files: string[],
-  token: string,
-  superblocksBaseUrl: string
-) {
+export async function uploadComponents({
+  applicationId,
+  componentConfigs,
+  files,
+  token,
+  superblocksBaseUrl,
+}: {
+  applicationId: string;
+  componentConfigs: Record<string, any>;
+  files: string[];
+  token: string;
+  superblocksBaseUrl: string;
+}) {
+  const bucketeerBaseUrl =
+    getBucketeerUrlFromSuperblocksUrl(superblocksBaseUrl);
+  // parse files to source and bundled files based on path
+  const uploadFiles: UploadFile[] = files.map((file, ind) => {
+    let contentType: string = getContentType(file);
+    if (contentType.length === 0) {
+      contentType = "application/octet-stream"; // default case when we don't know the encoding
+    }
+    return {
+      name: `file${ind + 1}`,
+      filename: file,
+      ContentType: contentType,
+    } as UploadFile;
+  });
+
+  const buildFiles: UploadFile[] = uploadFiles.filter((uploadFile) =>
+    uploadFile.filename.startsWith("dist/")
+  );
+  const srcFiles: UploadFile[] = uploadFiles.filter(
+    (uploadFile) => !uploadFile.filename.startsWith("dist/")
+  );
+
+  const formatJSON = JSON.stringify({
+    applicationId,
+    registeredComponents: componentConfigs,
+    srcFiles,
+    buildFiles,
+  });
+  const postURL = new URL(
+    `${BASE_BUCKETEER_URL}/components/upload`,
+    bucketeerBaseUrl
+  ).toString();
+
+  const formData = new FormData();
+  formData.append("format", formatJSON);
+  uploadFiles.forEach((uploadFile) => {
+    formData.append(uploadFile.name, fs.createReadStream(uploadFile.filename));
+  });
+  const formHeaders = formData.getHeaders();
+
   try {
+    const [rootSettings] = await getSuperblocksMonorepoConfigJson(true);
     const config = {
-      method: "post",
-      url: new URL(
-        `${BASE_SERVER_URL}/public/application/${applicationId}/publish`,
-        superblocksBaseUrl
-      ).toString(),
       headers: {
         Authorization: "Bearer " + token,
+        [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+        "x-superblocks-url": superblocksBaseUrl,
+        ...formHeaders,
       },
-      data: { components: componentConfigs, files },
     };
-    const response = await axios(config);
+
+    const response = await axios.post(postURL, formData, config);
+
     return response.data;
-  } catch (e) {
-    throw new Error("Could not upload application components");
+  } catch (e: any) {
+    if (e instanceof AxiosError) {
+      const message = e.response?.data?.responseMeta?.message as string;
+      throw new Error(`Could not upload application components
+${message}`);
+    }
+    throw new Error(`Could not upload application components
+${e.message as string}`);
   }
 }
 

package/src/sdk.ts

@@ -59,13 +59,13 @@ export class SuperblocksSdk {
     componentConfigs: Record<string, any>,
     files: string[]
   ) {
-    return uploadComponents(
+    return uploadComponents({
       applicationId,
       componentConfigs,
       files,
-      this.token,
-      this.superblocksBaseUrl
-    );
+      token: this.token,
+      superblocksBaseUrl: this.superblocksBaseUrl,
+    });
   }
 
   async fetchCurrentUser() {