@superblocksteam/sdk 1.9.2 → 1.10.0

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import { ComponentEvent, LocalGitRepoState, SuperblocksResourceType } from "@superblocksteam/util";
 import { StdISocketRPCClient } from "./socket";
-import { ApiWithPb, Page, RemoteCommitDto, UserMeDto, ViewMode } from "./types";
+import { Api, ApiWithPb, Page, RemoteCommitDto, UserMeDto, ViewMode } from "./types";
 export interface UploadFile {
     name: string;
     filename: string;
@@ -23,7 +23,7 @@ export type PushMultiPageApplicationWithCommitConfig = MultiPageApplicationWrapp
     skipCommit: boolean;
 };
 export interface ApiWrapper {
-    apiPb: Record<string, any>;
+    apiPb: Api;
     name?: string;
 }
 export type PushApiWithCommitConfig = {

package/dist/flag.d.ts

@@ -1,2 +1,11 @@
 import { FlagBootstrap } from "./types";
 export declare const signingEnabled: (flags: FlagBootstrap) => boolean;
+export declare const DEFAULT_LINES_FOR_LARGE_STEPS = 10;
+export declare class FeatureFlags {
+    private flags;
+    constructor(flags: FlagBootstrap);
+    signingEnabled(): boolean;
+    splitLargeApiStepsEnabled(): boolean;
+    splitLargeApiStepsInNewEnabled(): boolean;
+    linesForLargeSteps(): number;
+}

package/dist/flag.js

@@ -1,7 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.signingEnabled = void 0;
+exports.FeatureFlags = exports.DEFAULT_LINES_FOR_LARGE_STEPS = exports.signingEnabled = void 0;
 const signingEnabled = (flags) => {
     return flags["ui.enable-resource-signing"] ?? false;
 };
 exports.signingEnabled = signingEnabled;
+exports.DEFAULT_LINES_FOR_LARGE_STEPS = 10;
+class FeatureFlags {
+    constructor(flags) {
+        this.flags = flags;
+    }
+    signingEnabled() {
+        return this.flags["ui.enable-resource-signing"] ?? false;
+    }
+    splitLargeApiStepsEnabled() {
+        return this.flags["superblocks.git.split.large.steps.enabled"] ?? false;
+    }
+    splitLargeApiStepsInNewEnabled() {
+        return this.flags["superblocks.git.split.large.steps.new.enabled"] ?? false;
+    }
+    linesForLargeSteps() {
+        return (this.flags["superblocks.git.split.large.step.lines"] ??
+            exports.DEFAULT_LINES_FOR_LARGE_STEPS);
+    }
+}
+exports.FeatureFlags = FeatureFlags;

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./client";
+export * from "./flag";
 export * from "./sdk";

package/dist/index.js

@@ -2,4 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./client"), exports);
+tslib_1.__exportStar(require("./flag"), exports);
 tslib_1.__exportStar(require("./sdk"), exports);

package/dist/sdk.d.ts

@@ -1,12 +1,15 @@
 import { ComponentEvent, LocalGitRepoState, SuperblocksResourceType } from "@superblocksteam/util";
 import { PushApiWithCommitConfig, PushMultiPageApplicationWithCommitConfig } from "./client";
-import { ViewMode } from "./types";
+import { FeatureFlags } from "./flag";
+import { UserMeDto, ViewMode } from "./types";
 export * from "./errors";
 export declare class SuperblocksSdk {
     token: string;
     superblocksBaseUrl: string;
     cliVersion: string;
     constructor(accessToken: string, superblocksBaseUrl: string, cliVersion: string);
+    getFeatureFlagsForCurrentUser(): Promise<FeatureFlags>;
+    getFeatureFlagsForUser(user: UserMeDto): FeatureFlags;
     fetchApplication({ applicationId, branch, headers, viewMode, skipSigningVerification, }: {
         applicationId: string;
         branch?: string;
@@ -53,7 +56,7 @@ export declare class SuperblocksSdk {
     }>;
     registerComponents(applicationId: string, componentConfigs: Record<string, any>, branch: string | null, injectedHeaders: Record<string, string>): Promise<any>;
     uploadComponents(applicationId: string, componentConfigs: Record<string, any>, files: string[], branch: string | null): Promise<void>;
-    fetchCurrentUser(): Promise<import("./types").UserMeDto>;
+    fetchCurrentUser(): Promise<UserMeDto>;
     pushApplication({ applicationId, applicationConfig, branch, headers, }: {
         applicationId: string;
         applicationConfig: PushMultiPageApplicationWithCommitConfig;

package/dist/sdk.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SuperblocksSdk = void 0;
 const tslib_1 = require("tslib");
 const client_1 = require("./client");
+const flag_1 = require("./flag");
 // Exporting here instead of index.ts because only sdk.ts is exposed outside in package.json
 tslib_1.__exportStar(require("./errors"), exports);
 class SuperblocksSdk {
@@ -14,6 +15,13 @@ class SuperblocksSdk {
         this.superblocksBaseUrl = superblocksBaseUrl;
         this.cliVersion = cliVersion;
     }
+    async getFeatureFlagsForCurrentUser() {
+        const user = await this.fetchCurrentUser();
+        return new flag_1.FeatureFlags(user.flagBootstrap);
+    }
+    getFeatureFlagsForUser(user) {
+        return new flag_1.FeatureFlags(user.flagBootstrap);
+    }
     async fetchApplication({ applicationId, branch, headers = {}, viewMode = "export-live", skipSigningVerification = false, }) {
         return (0, client_1.fetchApplication)({
             cliVersion: this.cliVersion,

package/dist/types/common.d.ts

@@ -6,6 +6,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 = {
     id: string;
@@ -91,7 +94,7 @@ export type Api = {
         };
         folder?: string;
     };
-    blocks?: any[];
+    blocks?: Block[];
     trigger: any;
     signature?: Signature;
 };
@@ -100,6 +103,82 @@ export type ApiWithPb = {
     pageId?: string;
     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 declare 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 declare 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/dist/types/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProfileType = exports.Profile = exports.AgentType = exports.AgentStatus = void 0;
+exports.WAIT_TYPE = exports.LoopType = exports.ProfileType = exports.Profile = exports.AgentType = exports.AgentStatus = void 0;
 var AgentStatus;
 (function (AgentStatus) {
     AgentStatus["ACTIVE"] = "Active";
@@ -31,3 +31,16 @@ var ProfileType;
     ProfileType["RESERVED"] = "RESERVED";
     ProfileType["CUSTOM"] = "CUSTOM";
 })(ProfileType || (exports.ProfileType = ProfileType = {}));
+var LoopType;
+(function (LoopType) {
+    LoopType["FOR"] = "TYPE_FOR";
+    LoopType["FOR_EACH"] = "TYPE_FOREACH";
+    LoopType["WHILE"] = "TYPE_WHILE";
+    LoopType["UNSPECIFIED"] = "TYPE_UNSPECIFIED";
+})(LoopType || (exports.LoopType = LoopType = {}));
+var WAIT_TYPE;
+(function (WAIT_TYPE) {
+    WAIT_TYPE["ALL"] = "WAIT_ALL";
+    WAIT_TYPE["ANY"] = "WAIT_NONE";
+    WAIT_TYPE["UNSPECIFIED"] = "WAIT_UNSPECIFIED";
+})(WAIT_TYPE || (exports.WAIT_TYPE = WAIT_TYPE = {}));

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "1.9.2",
+  "version": "1.10.0",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {
     ".": {
-      "import": "./dist/sdk.mjs",
+      "import": "./dist/sdk.js",
       "require": "./dist/sdk.js",
       "types": "./dist/sdk.d.ts"
     }
@@ -31,7 +31,7 @@
     "typescript": "^5.1.3"
   },
   "dependencies": {
-    "@superblocksteam/util": "1.9.2",
+    "@superblocksteam/util": "1.10.0",
     "axios": "^1.3.5",
     "ws": "^8.17.0"
   },

package/src/client.ts

@@ -22,6 +22,7 @@ import { signingEnabled } from "./flag";
 import { connectToISocketRPCServer, StdISocketRPCClient } from "./socket";
 import {
   AgentType,
+  Api,
   ApiWithPb,
   Page,
   RemoteCommitDto,
@@ -68,7 +69,7 @@ export type PushMultiPageApplicationWithCommitConfig =
   };
 
 export interface ApiWrapper {
-  apiPb: Record<string, any>;
+  apiPb: Api;
   name?: string; //@deprecated this attribute is used for getting a name for backends(jobs and workflows) that were never migrated to the new API version.
 }
 

package/src/flag.ts

@@ -3,3 +3,28 @@ import { FlagBootstrap } from "./types";
 export const signingEnabled = (flags: FlagBootstrap): boolean => {
   return flags["ui.enable-resource-signing"] ?? false;
 };
+
+export const DEFAULT_LINES_FOR_LARGE_STEPS = 10;
+
+export class FeatureFlags {
+  constructor(private flags: FlagBootstrap) {}
+
+  signingEnabled(): boolean {
+    return this.flags["ui.enable-resource-signing"] ?? false;
+  }
+
+  splitLargeApiStepsEnabled(): boolean {
+    return this.flags["superblocks.git.split.large.steps.enabled"] ?? false;
+  }
+
+  splitLargeApiStepsInNewEnabled(): boolean {
+    return this.flags["superblocks.git.split.large.steps.new.enabled"] ?? false;
+  }
+
+  linesForLargeSteps(): number {
+    return (
+      this.flags["superblocks.git.split.large.step.lines"] ??
+      DEFAULT_LINES_FOR_LARGE_STEPS
+    );
+  }
+}

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from "./client";
+export * from "./flag";
 export * from "./sdk";

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";
@@ -41,6 +42,15 @@ export class SuperblocksSdk {
     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,

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;