@superblocksteam/sdk 0.0.21 → 0.0.22

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

@@ -9,7 +9,8 @@ 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, }) {
+const SUPERBLOCKS_URL_HEADER = "x-superblocks-url";
+async function fetchApplication({ applicationId, token, superblocksBaseUrl, viewMode, injectedHeaders = {}, }) {
     var _a;
     // TODO(jason) update this with commit ID once we enable fetching by commit
     const commitId = "latest";
@@ -23,7 +24,8 @@ 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);
@@ -37,13 +39,14 @@ async function fetchApplication({ applicationId, token, superblocksBaseUrl, view
     }
 }
 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 +95,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 +105,7 @@ async function registerComponents(applicationId, componentConfigs, token, superb
             headers: {
                 Authorization: "Bearer " + token,
                 [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+                ...injectedHeaders,
             },
             data: { components: componentConfigs },
         };
@@ -154,7 +158,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,
             },
         };
@@ -179,6 +184,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.22",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {

package/src/client.ts

@@ -1,7 +1,9 @@
 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";
@@ -11,6 +13,7 @@ const BASE_SERVER_URL = "api/v1";
 const BASE_BUCKETEER_URL = "api/v1";
 
 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,11 +28,13 @@ export async function fetchApplication({
   token,
   superblocksBaseUrl,
   viewMode,
+  injectedHeaders = {},
 }: {
   applicationId: string;
   token: string;
   superblocksBaseUrl: string;
   viewMode: ViewMode;
+  injectedHeaders: Record<string, string>;
 }) {
   // TODO(jason) update this with commit ID once we enable fetching by commit
   const commitId = "latest";
@@ -49,7 +54,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 +70,8 @@ export async function fetchApplication({
 
 export async function fetchApplications(
   token: string,
-  superblocksBaseUrl: string
+  superblocksBaseUrl: string,
+  injectedHeaders: Record<string, string> = {}
 ) {
   try {
     const config = {
@@ -72,6 +79,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 +136,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 +150,7 @@ export async function registerComponents(
       headers: {
         Authorization: "Bearer " + token,
         [CLI_VERSION_HEADER]: rootSettings.metadata.cliVersion,
+        ...injectedHeaders,
       },
       data: { components: componentConfigs },
     };
@@ -226,7 +236,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,
       },
     };
@@ -256,6 +267,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
     );
   }