@superblocksteam/sdk 1.4.1 → 1.5.0

package/dist/types/common.d.ts

@@ -0,0 +1,111 @@
+export interface UserMeDto {
+    user: User;
+    organizations: Organization[];
+    agents: Agent[];
+    flagBootstrap: FlagBootstrap;
+}
+export interface FlagBootstrap {
+    "ui.enable-resource-signing"?: boolean;
+}
+export type User = {
+    id: string;
+    email: string;
+    currentOrganizationId: string;
+    organizationIds: string[];
+    username: string;
+    name: string;
+    anonymousId: string;
+    isAnonymous: boolean;
+    isAdmin: boolean;
+    metadata: Record<string, unknown>;
+};
+export interface Organization {
+    id: string;
+    name: string;
+    displayName: string;
+    agents?: Agent[];
+    apiKey: string;
+    agentType: AgentType;
+    minExternalAgentVersion: string;
+    profiles?: Profile[];
+}
+export type Agent = {
+    id: string;
+    key: string;
+    environment: string;
+    status: AgentStatus;
+    version: string;
+    versionExternal: string;
+    url: string;
+    type: AgentType;
+    updated: Date;
+    created: Date;
+    tags: AgentTags;
+    verificationKeyIds?: null | string[];
+    signingKeyId?: null | string;
+};
+export declare enum AgentStatus {
+    ACTIVE = "Active",
+    DISCONNECTED = "Disconnected",
+    BROWSER_UNREACHABLE = "Browser Unreachable",
+    PENDING_REGISTRATION = "Pending Registration",
+    STALE = "Stale"
+}
+export declare enum AgentType {
+    MULTITENANT = 0,
+    DEDICATED = 1,
+    ONPREMISE = 2
+}
+export type AgentTags = Record<string, string[]>;
+export declare class Profile {
+    id: string;
+    key: string;
+    displayName: string;
+    description: string;
+    type: ProfileType;
+    constructor({ id, key, displayName, description, type, }: {
+        id: string;
+        key: string;
+        displayName: string;
+        description: string;
+        type: ProfileType;
+    });
+}
+export declare enum ProfileType {
+    RESERVED = "RESERVED",
+    CUSTOM = "CUSTOM"
+}
+export type Api = {
+    metadata: {
+        name: string;
+        id: string;
+        organization: string;
+        timestamps?: {
+            created: string;
+            updated: string;
+            deactivated: boolean;
+        };
+        creator?: {
+            id: string;
+            name: string;
+        };
+        folder?: string;
+    };
+    blocks?: any[];
+    trigger: any;
+    signature?: Signature;
+};
+/** A signature, as produced by the agent. */
+export interface Signature {
+    /** The id of the key used to sign the data. */
+    keyId: string;
+    /** The actual signature, in base64. */
+    data: string;
+}
+export interface RemoteCommitDto {
+    commitId: string;
+    remoteCommitId: string;
+    remoteCommitDate: Date;
+    branchName: string;
+    repositoryId: string;
+}

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 getAgentUrls(agents: Agent[], agentType: AgentType): 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,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSanitizedApi = exports.sanitizeV2RequestBody = exports.getAgentUrls = void 0;
+const types_1 = require("./types");
+function getAgentUrls(agents, agentType) {
+    const filtered = agents.filter((a) => a.type === agentType && a.status === types_1.AgentStatus.ACTIVE);
+    return filtered.map((f) => f.url);
+}
+exports.getAgentUrls = getAgentUrls;
+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) => {
+    var _a, _b;
+    const sanitizedBlocks = (_b = ((_a = api.blocks) !== null && _a !== void 0 ? _a : [])) === null || _b === void 0 ? void 0 : _b.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.1",
+  "version": "1.5.0",
   "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.1",
-    "axios": "^1.3.5"
+    "@superblocksteam/util": "1.5.0",
+    "axios": "^1.3.5",
+    "isomorphic-ws": "^5.0.0"
   },
   "homepage": "https://www.superblocks.com",
   "engines": {