@superblocksteam/sdk 1.4.2 → 1.5.1

package/dist/types/common.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProfileType = exports.Profile = exports.AgentType = exports.AgentStatus = void 0;
+var AgentStatus;
+(function (AgentStatus) {
+    AgentStatus["ACTIVE"] = "Active";
+    AgentStatus["DISCONNECTED"] = "Disconnected";
+    AgentStatus["BROWSER_UNREACHABLE"] = "Browser Unreachable";
+    // TODO: remove PENDING_REGISTRATION after the DB migration
+    AgentStatus["PENDING_REGISTRATION"] = "Pending Registration";
+    AgentStatus["STALE"] = "Stale";
+})(AgentStatus || (exports.AgentStatus = AgentStatus = {}));
+var AgentType;
+(function (AgentType) {
+    AgentType[AgentType["MULTITENANT"] = 0] = "MULTITENANT";
+    AgentType[AgentType["DEDICATED"] = 1] = "DEDICATED";
+    AgentType[AgentType["ONPREMISE"] = 2] = "ONPREMISE";
+})(AgentType || (exports.AgentType = AgentType = {}));
+class Profile {
+    constructor({ id, key, displayName, description, type, }) {
+        this.id = id;
+        this.key = key;
+        this.displayName = displayName;
+        this.description = description;
+        this.type = type;
+    }
+}
+exports.Profile = Profile;
+var ProfileType;
+(function (ProfileType) {
+    ProfileType["RESERVED"] = "RESERVED";
+    ProfileType["CUSTOM"] = "CUSTOM";
+})(ProfileType || (exports.ProfileType = ProfileType = {}));

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./common";
+export * from "./socket";
+export * from "./plugin";
+export * from "./signing";

package/dist/types/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./common"), exports);
+tslib_1.__exportStar(require("./socket"), exports);
+tslib_1.__exportStar(require("./plugin"), exports);
+tslib_1.__exportStar(require("./signing"), exports);

package/dist/types/plugin.d.ts

@@ -0,0 +1,2 @@
+export declare const transcribeAudioToTextTranslateToEnglishTruthyValues: (string | boolean)[];
+export declare const OpenAiPluginId = "openai";

package/dist/types/plugin.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAiPluginId = exports.transcribeAudioToTextTranslateToEnglishTruthyValues = void 0;
+exports.transcribeAudioToTextTranslateToEnglishTruthyValues = [
+    "checked",
+    "true",
+    true,
+];
+exports.OpenAiPluginId = "openai";

package/dist/types/signing.d.ts

@@ -0,0 +1,51 @@
+import { Api as ApiPb, Signature } from "./common";
+export type SignatureResponse = {
+    signature: Signature;
+};
+export type ApiResource = {
+    api: ApiPb;
+};
+export type GenericResource = {
+    literal: {
+        data: any;
+        signature?: Signature;
+    };
+};
+interface PageHash {
+    /** The version of the page DSL. */
+    version: number;
+    /** The SHA-256 hash of the page DSL (i.e. `page.layouts[0].dsl`), in base64. */
+    hash: string;
+}
+export interface ApplicationSettingsHashes {
+    /** The SHA-256 hash of all custom components related properties from settings, in base64. */
+    components: string;
+    /** The SHA-256 hash of settings without the custom components related properties, in base64. */
+    rest: string;
+}
+export interface ApplicationSignatureTree {
+    /** The version of the signature tree. */
+    v: 1;
+    settings: ApplicationSettingsHashes;
+    page: PageHash;
+}
+export interface ApplicationSignatureTreeSigned {
+    /** The SHA-256 hash of `root`, in base64. */
+    signature: Signature;
+    root: ApplicationSignatureTree;
+}
+export type AppToSign = {
+    rootHash: string;
+};
+export type AppToVerify = {
+    rootHash: string;
+    signature?: Signature;
+};
+export type ApiToSign = {
+    apiPb: ApiPb;
+};
+export type ApiToVerify = {
+    apiPb: ApiPb;
+    signature?: Signature;
+};
+export {};

package/dist/types/signing.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/socket.d.ts

@@ -0,0 +1,17 @@
+export type MethodHandler<Params, Result, PeerMethods, RequestContext> = (params: Params, peer: ISocketClient<PeerMethods>, ctx: RequestContext) => Promise<Result>;
+export type MiddlewareHandler<Params, PeerMethods, RequestContext> = (params: Params, peerAuthorization: string | undefined, peer: ISocketClient<PeerMethods>, ctx: RequestContext) => Promise<void>;
+export type MethodHandlers<Methods, PeerMethods, RequestContext> = {
+    [Key in keyof Methods]: Methods[Key] extends (params: infer Params) => Promise<infer Result> ? [
+        ...middlewareHandlers: MiddlewareHandler<Params, PeerMethods, RequestContext>[],
+        handler: MethodHandler<Params, Result, PeerMethods, RequestContext>
+    ] : Methods[Key] extends Record<string, unknown> ? MethodHandlers<Methods[Key], PeerMethods, RequestContext> : never;
+};
+type ISocketClientMethodCall<Methods> = {
+    [Key in keyof Methods]: Methods[Key] extends (params: infer P) => Promise<infer R> ? (params: P) => Promise<R> : Methods[Key] extends Record<string, unknown> ? ISocketClientMethodCall<Methods[Key]> : never;
+};
+export type ISocketClient<Methods> = {
+    close: () => void;
+    call: ISocketClientMethodCall<Methods>;
+};
+export type MethodSchema<Params, Response> = (params: Params) => Promise<Response>;
+export {};

package/dist/types/socket.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.d.ts

@@ -0,0 +1,4 @@
+import { Agent, AgentType, Api } from "./types";
+export declare function getAgentUrl(agents: Agent[], agentType: AgentType, profile?: string, healthCheck?: boolean): Promise<string>;
+export declare const sanitizeV2RequestBody: (apiBody: Record<string, unknown>) => Record<string, unknown>;
+export declare const getSanitizedApi: (api: Api) => any;

package/dist/utils.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSanitizedApi = exports.sanitizeV2RequestBody = exports.getAgentUrl = void 0;
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const types_1 = require("./types");
+async function getAgentUrl(agents, agentType, profile, healthCheck = true) {
+    let filtered = agents.filter((a) => a.type === agentType && a.status === types_1.AgentStatus.ACTIVE);
+    if (profile) {
+        filtered = agents.filter((a) => a.tags.profile &&
+            (a.tags.profile.includes("*") || a.tags.profile.includes(profile)));
+    }
+    if (healthCheck) {
+        const coroutines = [];
+        for (const agent of filtered) {
+            const p = (async () => {
+                const url = new URL("health", agent.url);
+                const config = {
+                    url: url.toString(),
+                    method: "get",
+                    headers: {},
+                };
+                await (0, axios_1.default)(config);
+                return agent.url;
+            })();
+            coroutines.push(p);
+        }
+        try {
+            return await Promise.any(coroutines);
+        }
+        catch (e) {
+            throw new Error("No available agents");
+        }
+    }
+    else {
+        const randomIndex = Math.floor(Math.random() * filtered.length);
+        return filtered[randomIndex].url;
+    }
+}
+exports.getAgentUrl = getAgentUrl;
+const sanitizeV2RequestBody = (apiBody) => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const traverseJSON = (obj) => {
+        for (const key in obj) {
+            if (key === "step" && obj.step[types_1.OpenAiPluginId]) {
+                const value = obj.step[types_1.OpenAiPluginId].transcribeAudioToTextTranslateToEnglish;
+                obj.step[types_1.OpenAiPluginId].transcribeAudioToTextTranslateToEnglish =
+                    types_1.transcribeAudioToTextTranslateToEnglishTruthyValues.includes(value);
+            }
+            else if (typeof obj[key] === "object") {
+                (0, exports.sanitizeV2RequestBody)(obj[key]);
+            }
+        }
+    };
+    traverseJSON(apiBody);
+    return apiBody;
+};
+exports.sanitizeV2RequestBody = sanitizeV2RequestBody;
+const getSanitizedApi = (api) => {
+    const sanitizedBlocks = (api.blocks ?? [])?.map((block) => (0, exports.sanitizeV2RequestBody)(block));
+    return {
+        ...api,
+        blocks: sanitizedBlocks,
+    };
+};
+exports.getSanitizedApi = getSanitizedApi;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "1.4.2",
+  "version": "1.5.1",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {
@@ -22,6 +22,7 @@
   },
   "license": "Superblocks Community Software License",
   "devDependencies": {
+    "@types/ws": "^8.5.10",
     "@typescript-eslint/eslint-plugin": "^5.60.1",
     "@typescript-eslint/parser": "^5.60.1",
     "eslint": "^8.48.0",
@@ -30,8 +31,9 @@
     "typescript": "^5.1.3"
   },
   "dependencies": {
-    "@superblocksteam/util": "1.4.2",
-    "axios": "^1.3.5"
+    "@superblocksteam/util": "1.5.1",
+    "axios": "^1.3.5",
+    "isomorphic-ws": "^5.0.0"
   },
   "homepage": "https://www.superblocks.com",
   "engines": {

package/src/client.ts

@@ -1,21 +1,25 @@
 import * as fs from "fs";
 import {
+  COMPONENT_EVENT_HEADER,
   ComponentEvent,
   getBucketeerUrlFromSuperblocksUrl,
   getContentType,
-  COMPONENT_EVENT_HEADER,
-  NotFoundError,
   LocalGitRepoState,
-  ValidateGitSetupRequestBody,
+  NotFoundError,
   SuperblocksResourceType,
   unreachable,
+  ValidateGitSetupRequestBody,
 } from "@superblocksteam/util";
 import axios, { AxiosError, AxiosRequestConfig } from "axios";
-import * as FormData from "form-data";
+import FormData from "form-data";
 import { isEmpty } from "lodash";
 import { BranchNotCheckedOutError, CommitAlreadyExistsError } from "./errors";
+import { signingEnabled } from "./flag";
+import { connectToISocketRPCServer } from "./socket";
+import { AgentType, RemoteCommitDto, UserMeDto } from "./types";
+import { getAgentUrl } from "./utils";
 
-const BASE_BUCKETEER_URL = "api/v1";
+const BASE_BUCKETEER_URL = "api";
 const BASE_SERVER_PUBLIC_API_URL = "api/v1/public";
 
 const SUPERBLOCKS_MAX_FILE_SIZE_MB = 10;
@@ -204,7 +208,7 @@ export async function fetchApplicationWithComponents({
   // fetch files from bucketeer
   const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
   const componentFileURL = new URL(
-    `${BASE_BUCKETEER_URL}/components/${applicationId}${branchPath}?commit=${commitId}&viewMode=${viewMode}`,
+    `${BASE_BUCKETEER_URL}/v1/components/${applicationId}${branchPath}?commit=${commitId}&viewMode=${viewMode}`,
     bucketeerBaseUrl
   ).toString();
 
@@ -408,25 +412,57 @@ export async function registerComponents(
   token: string,
   superblocksBaseUrl: string,
   branch: string | null,
-  injectedHeaders?: Record<string, string>
+  injectedHeaders: Record<string, string>
 ) {
   try {
     const branchPath = branch ? `/branches/${encodeURIComponent(branch)}` : "";
-    const config: AxiosRequestConfig = {
-      method: "put",
-      url: new URL(
-        `${BASE_SERVER_PUBLIC_API_URL}/application/${applicationId}${branchPath}/components`,
-        superblocksBaseUrl
-      ).toString(),
-      headers: {
-        Authorization: "Bearer " + token,
-        [CLI_VERSION_HEADER]: cliVersion,
-        ...injectedHeaders,
-      },
-      data: { components: componentConfigs },
-    };
-    const response = await axios(config);
-    return response.data;
+    const userMe = await fetchCurrentUser(
+      cliVersion,
+      token,
+      superblocksBaseUrl
+    );
+    const organization = userMe.organizations[0];
+    if (
+      organization.agentType == AgentType.ONPREMISE &&
+      signingEnabled(userMe.flagBootstrap)
+    ) {
+      const profile = process.env.SUPERBLOCKS_PROFILE;
+      const agentUrl = await getAgentUrl(
+        userMe.agents,
+        organization.agentType,
+        profile
+      );
+      const socket = await connectToISocketRPCServer({
+        agentUrl,
+        superblocksBaseUrl,
+        token,
+      });
+      const resp = await socket.call.v1.public.application.component.register({
+        applicationId,
+        branchName: branch || "",
+        cliVersion: cliVersion,
+        componentEvent: injectedHeaders[COMPONENT_EVENT_HEADER],
+        components: componentConfigs,
+      });
+      socket.close();
+      return resp.data;
+    } else {
+      const config: AxiosRequestConfig = {
+        method: "put",
+        url: new URL(
+          `${BASE_SERVER_PUBLIC_API_URL}/application/${applicationId}${branchPath}/components`,
+          superblocksBaseUrl
+        ).toString(),
+        headers: {
+          Authorization: "Bearer " + token,
+          [CLI_VERSION_HEADER]: cliVersion,
+          ...injectedHeaders,
+        },
+        data: { components: componentConfigs },
+      };
+      const response = await axios(config);
+      return response.data;
+    }
   } catch (e: any) {
     if (e instanceof AxiosError) {
       const message: string =
@@ -496,7 +532,7 @@ export async function uploadComponents({
     buildFiles,
   });
   const postURL = new URL(
-    `${BASE_BUCKETEER_URL}/components/upload`,
+    `${BASE_BUCKETEER_URL}/v2/components/upload`,
     bucketeerBaseUrl
   ).toString();
 
@@ -530,9 +566,40 @@ You can reduce your component bundle size by uploading static assets to a separa
       },
     };
 
-    const response = await axios.post(postURL, formData, config);
+    const uploadResponse = await axios.post(postURL, formData, config);
 
-    return response.data;
+    const userMe = await fetchCurrentUser(
+      cliVersion,
+      token,
+      superblocksBaseUrl
+    );
+    const organization = userMe.organizations[0];
+    let agentUrl: string | undefined;
+    const signingRequired =
+      organization.agentType == AgentType.ONPREMISE &&
+      signingEnabled(userMe.flagBootstrap);
+    if (signingRequired) {
+      agentUrl = await getAgentUrl(userMe.agents, organization.agentType);
+    }
+    const socket = await connectToISocketRPCServer({
+      agentUrl,
+      superblocksBaseUrl,
+      token,
+    });
+    try {
+      await socket.call.v1.public.application.component.update({
+        applicationId,
+        branchName: branch ?? undefined,
+        srcFiles: srcFiles.map((file) => file.filename),
+        buildFiles: buildFiles.map((file) => file.filename),
+        registeredComponents: componentConfigs,
+        cliVersion,
+        componentBaseUrl: uploadResponse.data.componentBaseUrl,
+        signingRequired,
+      });
+    } finally {
+      socket.close();
+    }
   } catch (e: any) {
     if (e instanceof AxiosError && e.response?.status === 413) {
       throw new Error(
@@ -559,7 +626,7 @@ export async function fetchCurrentUser(
   cliVersion: string,
   token: string,
   superblocksBaseUrl: string
-) {
+): Promise<UserMeDto> {
   try {
     const config: AxiosRequestConfig = {
       method: "get",
@@ -574,7 +641,7 @@ export async function fetchCurrentUser(
       },
     };
     const response = await axios(config);
-    return response.data.data.user;
+    return response.data.data as UserMeDto;
   } catch (e: any) {
     let message: string;
     if (e instanceof AxiosError) {
@@ -607,7 +674,7 @@ export async function pushApplication({
   branch: string;
   injectedHeaders: Record<string, string>;
   applicationConfig: PushApplicationWithCommitConfig;
-}): Promise<ApplicationWrapper | undefined> {
+}): Promise<RemoteCommitDto | undefined> {
   const serverURL = new URL(
     `${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}/branches/${encodeURIComponent(
       branch
@@ -617,17 +684,51 @@ export async function pushApplication({
   let serverResponse;
 
   try {
-    const config: AxiosRequestConfig = {
-      method: "post",
-      url: serverURL.toString(),
-      headers: {
-        Authorization: "Bearer " + token,
-        [CLI_VERSION_HEADER]: cliVersion,
-        ...injectedHeaders,
-      },
-      data: applicationConfig,
-    };
-    serverResponse = await axios<ResponseWithMeta<ApplicationWrapper>>(config);
+    const userMe = await fetchCurrentUser(
+      cliVersion,
+      token,
+      superblocksBaseUrl
+    );
+    const organization = userMe.organizations[0];
+    if (
+      organization.agentType == AgentType.ONPREMISE &&
+      signingEnabled(userMe.flagBootstrap)
+    ) {
+      const profile = process.env.SUPERBLOCKS_PROFILE;
+      const agentUrl = await getAgentUrl(
+        userMe.agents,
+        organization.agentType,
+        profile
+      );
+      const socket = await connectToISocketRPCServer({
+        agentUrl,
+        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,
+      });
+      socket.close();
+      return resp.data;
+    } else {
+      const config: AxiosRequestConfig = {
+        method: "post",
+        url: serverURL.toString(),
+        headers: {
+          Authorization: "Bearer " + token,
+          [CLI_VERSION_HEADER]: cliVersion,
+          ...injectedHeaders,
+        },
+        data: applicationConfig,
+      };
+      serverResponse = await axios<ResponseWithMeta<RemoteCommitDto>>(config);
+    }
   } catch (e) {
     if (axios.isAxiosError(e)) {
       const respCode =
@@ -686,19 +787,46 @@ export async function pushApi({
   let serverResponse;
 
   try {
-    const config: AxiosRequestConfig = {
-      method: "post",
-      url: serverURL.toString(),
-      headers: {
-        Authorization: "Bearer " + token,
-        [CLI_VERSION_HEADER]: cliVersion,
-        ...injectedHeaders,
-      },
-      data: apiConfig,
-    };
-    serverResponse = await axios<ResponseWithMeta<{ commitId: string }>>(
-      config
+    const userMe = await fetchCurrentUser(
+      cliVersion,
+      token,
+      superblocksBaseUrl
     );
+    const organization = userMe.organizations[0];
+    if (
+      organization.agentType == AgentType.ONPREMISE &&
+      signingEnabled(userMe.flagBootstrap)
+    ) {
+      const agentUrl = await getAgentUrl(userMe.agents, organization.agentType);
+      const socket = await connectToISocketRPCServer({
+        agentUrl,
+        superblocksBaseUrl,
+        token,
+      });
+      const resp = await socket.call.v1.public.api.pushCommit({
+        apiId,
+        apiPb: apiConfig.apiPb,
+        branchName: branch,
+        commitId: apiConfig.commitId,
+        commitMessage: apiConfig.commitMessage,
+      });
+      socket.close();
+      return resp.data;
+    } else {
+      const config: AxiosRequestConfig = {
+        method: "post",
+        url: serverURL.toString(),
+        headers: {
+          Authorization: "Bearer " + token,
+          [CLI_VERSION_HEADER]: cliVersion,
+          ...injectedHeaders,
+        },
+        data: apiConfig,
+      };
+      serverResponse = await axios<ResponseWithMeta<{ commitId: string }>>(
+        config
+      );
+    }
   } catch (e) {
     if (axios.isAxiosError(e)) {
       if (e.response?.data?.responseMeta?.status === 405) {

package/src/flag.ts

@@ -0,0 +1,5 @@
+import { FlagBootstrap } from "./types";
+
+export const signingEnabled = (flags: FlagBootstrap): boolean => {
+  return flags["ui.enable-resource-signing"] ?? false;
+};

package/src/sdk.ts

@@ -7,18 +7,18 @@ import {
   fetchApi,
   fetchApis,
   fetchApplication,
-  fetchApplicationWithComponents,
+  fetchApplicationBranches,
   fetchApplications,
-  registerComponents,
-  uploadComponents,
+  fetchApplicationWithComponents,
   fetchCurrentUser,
-  ViewMode,
+  pushApi,
+  PushApiWithCommitConfig,
   pushApplication,
   PushApplicationWithCommitConfig,
-  fetchApplicationBranches,
-  PushApiWithCommitConfig,
-  pushApi,
+  registerComponents,
+  uploadComponents,
   validateGitSetup,
+  ViewMode,
 } from "./client";
 
 // Exporting here instead of index.ts because only sdk.ts is exposed outside in package.json
@@ -144,7 +144,7 @@ export class SuperblocksSdk {
     applicationId: string,
     componentConfigs: Record<string, any>,
     branch: string | null,
-    injectedHeaders?: Record<string, string>
+    injectedHeaders: Record<string, string>
   ) {
     return registerComponents(
       this.cliVersion,