@superblocksteam/sdk 1.9.3 → 1.11.0

package/src/sdk.ts

@@ -21,7 +21,8 @@ import {
   uploadComponents,
   validateGitSetup,
 } from "./client";
-import { ViewMode } from "./types";
+import { FeatureFlags } from "./flag";
+import { UserMeDto, ViewMode } from "./types";
 
 // Exporting here instead of index.ts because only sdk.ts is exposed outside in package.json
 export * from "./errors";
@@ -34,13 +35,22 @@ export class SuperblocksSdk {
   constructor(
     accessToken: string,
     superblocksBaseUrl: string,
-    cliVersion: string
+    cliVersion: string,
   ) {
     this.token = accessToken;
     this.superblocksBaseUrl = superblocksBaseUrl;
     this.cliVersion = cliVersion;
   }
 
+  async getFeatureFlagsForCurrentUser(): Promise<FeatureFlags> {
+    const user = await this.fetchCurrentUser();
+    return new FeatureFlags(user.flagBootstrap);
+  }
+
+  getFeatureFlagsForUser(user: UserMeDto): FeatureFlags {
+    return new FeatureFlags(user.flagBootstrap);
+  }
+
   async fetchApplication({
     applicationId,
     branch,
@@ -159,7 +169,7 @@ export class SuperblocksSdk {
       this.cliVersion,
       this.token,
       this.superblocksBaseUrl,
-      headers
+      headers,
     );
   }
 
@@ -184,7 +194,7 @@ export class SuperblocksSdk {
       viewMode,
       branch,
       commitId,
-      skipSigningVerification
+      skipSigningVerification,
     );
   }
 
@@ -197,7 +207,7 @@ export class SuperblocksSdk {
     resourceType: SuperblocksResourceType,
     event: ComponentEvent,
     localGitRepoState: LocalGitRepoState,
-    injectedHeaders?: Record<string, string>
+    injectedHeaders?: Record<string, string>,
   ) {
     return validateGitSetup(
       this.cliVersion,
@@ -207,7 +217,7 @@ export class SuperblocksSdk {
       localGitRepoState,
       this.token,
       this.superblocksBaseUrl,
-      injectedHeaders
+      injectedHeaders,
     );
   }
 
@@ -215,7 +225,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,
@@ -224,7 +234,7 @@ export class SuperblocksSdk {
       this.token,
       this.superblocksBaseUrl,
       branch,
-      injectedHeaders
+      injectedHeaders,
     );
   }
 
@@ -232,7 +242,7 @@ export class SuperblocksSdk {
     applicationId: string,
     componentConfigs: Record<string, any>,
     files: string[],
-    branch: string | null
+    branch: string | null,
   ) {
     return uploadComponents({
       cliVersion: this.cliVersion,
@@ -249,7 +259,7 @@ export class SuperblocksSdk {
     return fetchCurrentUser(
       this.cliVersion,
       this.token,
-      this.superblocksBaseUrl
+      this.superblocksBaseUrl,
     );
   }
 

package/src/socket/handlers.ts

@@ -181,7 +181,7 @@ export function createRequestHandlers({
             }) => {
               if (!agentUrl) {
                 throw new Error(
-                  "Agent url not specified. This shouldn't happen."
+                  "Agent url not specified. This shouldn't happen.",
                 );
               }
               const signature = await signResource({
@@ -209,7 +209,7 @@ export function createRequestHandlers({
               for (const { apiPb } of toSign) {
                 if (!agentUrl) {
                   throw new Error(
-                    "Agent url not specified. This shouldn't happen."
+                    "Agent url not specified. This shouldn't happen.",
                   );
                 }
                 const signature = await signResource({
@@ -234,7 +234,7 @@ export function createRequestHandlers({
               try {
                 if (!agentUrl) {
                   throw new Error(
-                    "Agent url not specified. This shouldn't happen."
+                    "Agent url not specified. This shouldn't happen.",
                   );
                 }
                 await verifyResources({
@@ -268,7 +268,7 @@ export function createRequestHandlers({
               try {
                 if (!agentUrl) {
                   throw new Error(
-                    "Agent url not specified. This shouldn't happen."
+                    "Agent url not specified. This shouldn't happen.",
                   );
                 }
                 await verifyResources({

package/src/socket/index.ts

@@ -50,7 +50,7 @@ export async function connectToISocketRPCServer({
     {
       connectionTimeoutInSeconds: 6 * 60, // 6 minutes
       noResponseTimeoutInSeconds: 5 * 60, // 5 minutes
-    }
+    },
   );
 }
 
@@ -60,7 +60,7 @@ export async function connectToISocketRPCServer({
 export class ISocketWithClientAuth<
   ImplementedMethods,
   CallableMethods,
-  RequestContext extends RequestContextBase
+  RequestContext extends RequestContextBase,
 > extends ISocket<ImplementedMethods, CallableMethods, RequestContext> {
   private readonly authorization?: string;
   private hasSentAuth = false;
@@ -74,7 +74,7 @@ export class ISocketWithClientAuth<
       RequestContext
     >,
     globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[],
-    timeouts?: SocketTimeouts
+    timeouts?: SocketTimeouts,
   ) {
     super(ws, requestHandlers, globalMiddlewares, timeouts);
     this.authorization = authorization;
@@ -83,14 +83,14 @@ export class ISocketWithClientAuth<
   // override `request` from the base class to send `authorization` when appropriate
   async request<Params, Result>(
     method: string,
-    params: Params
+    params: Params,
   ): Promise<Result> {
     // only send `authorization` on the first request
     const authorization = this.hasSentAuth ? undefined : this.authorization;
     const result = await super.request<Params, Result>(
       method,
       params,
-      authorization
+      authorization,
     );
     this.hasSentAuth = true;
     return result;
@@ -100,7 +100,7 @@ export class ISocketWithClientAuth<
 export async function connectISocket<
   CallableMethods,
   ImplementedMethods,
-  RequestContext extends RequestContextBase = RequestContextBase
+  RequestContext extends RequestContextBase = RequestContextBase,
 >(
   wsUrl: string,
   authorization: string | undefined,
@@ -110,7 +110,7 @@ export async function connectISocket<
     RequestContext
   >,
   globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[],
-  timeouts?: SocketTimeouts
+  timeouts?: SocketTimeouts,
 ): Promise<ISocketClient<CallableMethods>> {
   const ws = await connectWebSocket(wsUrl);
   const isocket = new ISocketWithClientAuth(
@@ -118,7 +118,7 @@ export async function connectISocket<
     authorization,
     requestHandlers,
     globalMiddlewares,
-    timeouts
+    timeouts,
   );
   return createISocketClient(isocket);
 }

package/src/socket/socket.ts

@@ -25,7 +25,7 @@ interface SocketResponse<Payload = unknown> {
 
 export interface SocketMessage<
   RequestPayload = unknown,
-  ResponsePayload = unknown
+  ResponsePayload = unknown,
 > {
   request?: SocketRequest<RequestPayload>;
   response?: SocketResponse<ResponsePayload>;
@@ -52,7 +52,7 @@ export interface SocketError {
 export class ISocket<
   ImplementedMethods,
   CallableMethods,
-  RequestContext extends RequestContextBase
+  RequestContext extends RequestContextBase,
 > {
   private readonly ws: WebSocket;
   private readonly requestHandlers: MethodHandlers<
@@ -88,7 +88,7 @@ export class ISocket<
     >,
     globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[],
     timeouts?: SocketTimeouts,
-    logger?: { error: (message?: string) => void }
+    logger?: { error: (message?: string) => void },
   ) {
     this.ws = ws;
     this.requestHandlers = requestHandlers;
@@ -103,9 +103,10 @@ export class ISocket<
       "message",
       // eslint-disable-next-line @typescript-eslint/no-misused-promises
       async (event: WebSocket.MessageEvent) => {
+        // eslint-disable-next-line @typescript-eslint/no-base-to-string
         const eventData: SocketMessage = JSON.parse(event.data.toString());
         return this.handleMessage(eventData);
-      }
+      },
     );
   }
 
@@ -153,7 +154,7 @@ export class ISocket<
           if (alreadyResponded) {
             throw new SocketErrorException(
               4,
-              "next() was called after the response was sent"
+              "next() was called after the response was sent",
             );
           }
           const handler = (
@@ -164,13 +165,13 @@ export class ISocket<
           if (!handler) {
             throw new SocketErrorException(
               5,
-              "cannot call past the last handler in the chain"
+              "cannot call past the last handler in the chain",
             );
           }
           if (wasCalled) {
             throw new SocketErrorException(
               6,
-              "next() was called multiple times"
+              "next() was called multiple times",
             );
           }
           wasCalled = true;
@@ -179,7 +180,7 @@ export class ISocket<
             payload,
             reqCtx,
             client,
-            generateNextFn(idx + 1)
+            generateNextFn(idx + 1),
           );
         };
       };
@@ -220,13 +221,13 @@ export class ISocket<
     Params,
     Result,
     CallableMethods,
-    RequestContext extends RequestContextBase
+    RequestContext extends RequestContextBase,
   >(
     handler: MethodHandler<Params, Result, CallableMethods, RequestContext>,
     params: Params,
     ctx: RequestContext,
     client: ISocketClient<CallableMethods>,
-    next: () => Promise<Result>
+    next: () => Promise<Result>,
   ): Promise<Result> {
     return handler(params, ctx, client, next);
   }
@@ -234,12 +235,13 @@ export class ISocket<
   public request<Params, Result>(
     method: string,
     params: Params,
-    authorization?: string
+    authorization?: string,
   ): Promise<Result> {
     return new Promise<Result>((resolve, reject) => {
       const requestId = ++this.nxtRequestId;
       this.responseHandler.set(requestId, {
         resolve: (result) => resolve(result as Result),
+        // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
         reject: (error: SocketError) => reject(error),
       });
       const toSend: SocketMessage = {
@@ -287,14 +289,14 @@ export class ISocket<
     // Set a new timeout for the next message
     this.connectionTimeout = setTimeout(
       this.handleConnectionTimeout(),
-      this.timeouts?.connectionTimeoutInSeconds * 1000
+      this.timeouts?.connectionTimeoutInSeconds * 1000,
     );
   }
 
   private handleConnectionTimeout() {
     return () => {
       this.logger.error(
-        `Connection timed out after ${this.timeouts?.connectionTimeoutInSeconds} seconds`
+        `Connection timed out after ${this.timeouts?.connectionTimeoutInSeconds} seconds`,
       );
       this.close();
     };
@@ -316,7 +318,7 @@ export class ISocket<
     // Set a new timeout for the next message
     responseHandler.timeout = setTimeout(
       this.handleNoResponseTimeout(reject),
-      this.timeouts?.noResponseTimeoutInSeconds * 1000
+      this.timeouts?.noResponseTimeoutInSeconds * 1000,
     );
   }
 
@@ -333,7 +335,7 @@ export class ISocket<
     this.responseHandler.forEach((handler, key) => {
       clearTimeout(handler.timeout);
       this.logger.error(
-        `Rejecting pending requestId ${key} due to connection close`
+        `Rejecting pending requestId ${key} due to connection close`,
       );
       handler.reject({ code: 8, message: "Connection closed" });
     });
@@ -348,11 +350,11 @@ const proxyTarget = Object.freeze(() => {
 function createIsocketProxy<
   ImplementedMethods,
   CallableMethods,
-  RequestContext extends RequestContextBase
+  RequestContext extends RequestContextBase,
 >(
   socket: ISocket<ImplementedMethods, CallableMethods, RequestContext>,
   // if path is undefined, it means the current object is the root object
-  path: string | undefined
+  path: string | undefined,
 ): unknown {
   return new Proxy(proxyTarget, {
     get(_target, prop: string) {
@@ -386,9 +388,9 @@ function createIsocketProxy<
 export function createISocketClient<
   CallableMethods,
   ImplementedMethods,
-  RequestContext extends RequestContextBase
+  RequestContext extends RequestContextBase,
 >(
-  socket: ISocket<ImplementedMethods, CallableMethods, RequestContext>
+  socket: ISocket<ImplementedMethods, CallableMethods, RequestContext>,
 ): ISocketClient<CallableMethods> {
   return {
     close: () => socket.close(),

package/src/types/common.ts

@@ -7,6 +7,9 @@ export interface UserMeDto {
 
 export interface FlagBootstrap {
   "ui.enable-resource-signing"?: boolean;
+  "superblocks.git.split.large.steps.enabled"?: boolean;
+  "superblocks.git.split.large.steps.new.enabled"?: boolean;
+  "superblocks.git.split.large.step.lines"?: number;
 }
 
 export type User = {
@@ -116,7 +119,7 @@ export type Api = {
     };
     folder?: string;
   };
-  blocks?: any[];
+  blocks?: Block[];
   trigger: any;
   signature?: Signature;
 };
@@ -127,6 +130,95 @@ export type ApiWithPb = {
   apiPb: Api;
 };
 
+export type Block = {
+  name: string;
+  step?: Step;
+  loop?: Loop;
+  tryCatch?: TryCatch;
+  conditional?: Conditional;
+  parallel?: Parallel;
+  stream?: Stream;
+};
+
+export type Step = {
+  integration: string;
+  javascript?: LanguageContent;
+  python?: LanguageContent;
+};
+
+export type Loop = {
+  blocks: Block[];
+  range: string;
+  type: LoopType;
+  variables?: Variables;
+};
+
+export enum LoopType {
+  FOR = "TYPE_FOR",
+  FOR_EACH = "TYPE_FOREACH",
+  WHILE = "TYPE_WHILE",
+  UNSPECIFIED = "TYPE_UNSPECIFIED",
+}
+
+export type TryCatch = {
+  try?: Blocks;
+  catch?: Blocks;
+  finally?: Blocks;
+  variables?: Variables;
+};
+
+export type Conditional = {
+  if?: ConditionalBlockWithCondition;
+  elseIf: ConditionalBlockWithCondition[];
+  else?: Blocks;
+};
+
+export type Blocks = {
+  blocks: Block[];
+};
+
+export type ConditionalBlockWithCondition = Blocks & {
+  condition?: string;
+};
+
+export type Parallel = {
+  static?: {
+    paths: Record<string, Blocks>;
+  };
+  dynamic?: {
+    blocks: Block[];
+    variables?: Variables;
+    paths?: string;
+  };
+  poolSize?: number;
+  wait?: WAIT_TYPE;
+};
+
+export type Stream = {
+  trigger?: StreamTrigger;
+  process?: Blocks;
+  variables?: Variables;
+};
+
+export type StreamTrigger = {
+  name: string;
+  step?: Step;
+};
+
+export enum WAIT_TYPE {
+  ALL = "WAIT_ALL",
+  ANY = "WAIT_NONE",
+  UNSPECIFIED = "WAIT_UNSPECIFIED",
+}
+
+export type Variables = Record<string, string>;
+
+export type LanguageContent = {
+  body: Body;
+};
+
+export type Body = string | { path: string };
+
 export type Page = {
   id: string;
   applicationId: string;

package/src/types/socket.ts

@@ -8,7 +8,7 @@ export type MethodHandler<Params, Result, PeerMethods, RequestContext> = (
   params: Params,
   ctx: RequestContext,
   peer: ISocketClient<PeerMethods>,
-  next: () => Promise<Result>
+  next: () => Promise<Result>,
 ) => Promise<Result>;
 
 // A  generic middleware is a method handler that can be chained with any other method handler, so it uses `any` for the params and result types
@@ -24,22 +24,22 @@ export type NonEmptyArray<T> = [...T[], T];
 
 export type MethodHandlers<Methods, PeerMethods, RequestContext> = {
   [Key in keyof Methods]: Methods[Key] extends (
-    params: infer Params
+    params: infer Params,
   ) => Promise<infer Result>
     ? NonEmptyArray<MethodHandler<Params, Result, PeerMethods, RequestContext>>
     : Methods[Key] extends Record<string, unknown>
-    ? MethodHandlers<Methods[Key], PeerMethods, RequestContext>
-    : never;
+      ? MethodHandlers<Methods[Key], PeerMethods, RequestContext>
+      : never;
 };
 
 type ISocketClientMethodCall<Methods> = {
   [Key in keyof Methods]: Methods[Key] extends (
-    params: infer P
+    params: infer P,
   ) => Promise<infer R>
     ? (params: P) => Promise<R>
     : Methods[Key] extends Record<string, unknown>
-    ? ISocketClientMethodCall<Methods[Key]>
-    : never;
+      ? ISocketClientMethodCall<Methods[Key]>
+      : never;
 };
 
 export type ISocketClient<Methods> = {
@@ -48,7 +48,7 @@ export type ISocketClient<Methods> = {
 };
 
 export type MethodSchema<Params, Response> = (
-  params: Params
+  params: Params,
 ) => Promise<Response>;
 
 /** The exception type can be thrown to cause the default error handler to write a raw error response to the socket */

package/src/utils.ts

@@ -12,16 +12,16 @@ export async function getAgentUrl(
   agents: Agent[],
   agentType: AgentType,
   profile?: string,
-  healthCheck = true
+  healthCheck = true,
 ): Promise<string> {
   let filtered = agents.filter(
-    (a) => a.type === agentType && a.status === AgentStatus.ACTIVE
+    (a) => a.type === agentType && a.status === AgentStatus.ACTIVE,
   );
   if (profile) {
     filtered = agents.filter(
       (a) =>
         a.tags.profile &&
-        (a.tags.profile.includes("*") || a.tags.profile.includes(profile))
+        (a.tags.profile.includes("*") || a.tags.profile.includes(profile)),
     );
   }
   if (healthCheck) {
@@ -41,7 +41,7 @@ export async function getAgentUrl(
     }
     try {
       return await Promise.any(coroutines);
-    } catch (e) {
+    } catch {
       throw new Error("No available agents");
     }
   } else {
@@ -51,7 +51,7 @@ export async function getAgentUrl(
 }
 
 export const sanitizeV2RequestBody = (
-  apiBody: Record<string, unknown>
+  apiBody: Record<string, unknown>,
 ): Record<string, unknown> => {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const traverseJSON = (obj: any) => {
@@ -72,7 +72,7 @@ export const sanitizeV2RequestBody = (
 
 export const getSanitizedApi = (api: Api): any => {
   const sanitizedBlocks = (api.blocks ?? [])?.map(
-    (block: Record<string, unknown>) => sanitizeV2RequestBody(block)
+    (block: Record<string, unknown>) => sanitizeV2RequestBody(block),
   );
   return {
     ...api,

package/tsconfig.json

@@ -6,7 +6,7 @@
     "outDir": "dist",
     "rootDir": "src",
     "strict": true,
-    "target": "es2021",
+    "target": "es2022",
     "esModuleInterop": true,
     "skipLibCheck": true
   },

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/client.ts","./src/errors.ts","./src/flag.ts","./src/index.ts","./src/sdk.ts","./src/utils.ts","./src/socket/handlers.ts","./src/socket/index.ts","./src/socket/signing.ts","./src/socket/socket.ts","./src/types/common.ts","./src/types/index.ts","./src/types/plugin.ts","./src/types/signing.ts","./src/types/socket.ts"],"version":"5.7.3"}