@superblocksteam/sdk 1.14.2 → 2.0.3-next.50

package/src/flag.ts

@@ -1,11 +1,10 @@
-import { FlagBootstrap } from "./types";
+import { DEFAULT_LINES_FOR_LARGE_STEPS } from "@superblocksteam/util";
+import type { FlagBootstrap } from "./types/index.js";
 
 export const signingEnabled = (flags: FlagBootstrap): boolean => {
   return flags["ui.enable-resource-signing"] ?? false;
 };
 
-export const DEFAULT_LINES_FOR_LARGE_STEPS = 1;
-
 export class FeatureFlags {
   constructor(private flags: FlagBootstrap) {}
 

package/src/index.ts

@@ -1,4 +1,119 @@
-export * from "./client";
-export * from "./flag";
-export * from "./sdk";
-export * from "./types";
+export {
+  createSocketConnectionIfNeeded,
+  fetchApi,
+  fetchApiCommits,
+  fetchApis,
+  fetchApplication,
+  fetchApplicationBranches,
+  fetchApplicationCommits,
+  fetchApplicationWithComponents,
+  fetchApplications,
+  fetchCurrentUser,
+  pushApi,
+  pushApplication,
+  registerComponents,
+  uploadComponents,
+  validateGitSetup,
+  uploadApplication,
+  type ApplicationWrapper,
+  type Branch,
+  type Branches,
+  type CodeModeApplicationWrapper,
+  type CommitDto,
+  type GetCommitsResponseBody,
+  type MultiPageApplicationWrapper,
+  type MultiPageApplicationWrapperWithComponents,
+  type PushApiWithCommitConfig,
+  type PushMultiPageApplicationWithCommitConfig,
+  type UploadFile,
+} from "./client.js";
+
+export { signingEnabled, FeatureFlags } from "./flag.js";
+
+export {
+  BranchNotCheckedOutError,
+  CommitAlreadyExistsError,
+  SuperblocksSdk,
+  ValidateGitSetupError,
+} from "./sdk.js";
+
+export {
+  AgentStatus,
+  AgentType,
+  OpenAiPluginId,
+  Profile,
+  ProfileType,
+  SocketErrorException,
+  transcribeAudioToTextTranslateToEnglishTruthyValues,
+  type Agent,
+  type AgentTags,
+  type ApiResource,
+  type ApiToSign,
+  type ApiToVerify,
+  type ApiWithPb,
+  type AppToSign,
+  type AppToVerify,
+  type ApplicationSettingsHashes,
+  type ApplicationSignatureTree,
+  type ApplicationSignatureTreeSigned,
+  type FlagBootstrap,
+  type GenericMiddleware,
+  type GenericResource,
+  type ISocketClient,
+  type MethodHandler,
+  type MethodHandlers,
+  type MethodSchema,
+  type NonEmptyArray,
+  type Organization,
+  type Page,
+  type RemoteCommitDto,
+  type RequestContextBase,
+  type SignatureResponse,
+  type SocketTimeouts,
+  type User,
+  type UserMeDto,
+  type ViewMode,
+} from "./types/index.js";
+
+export {
+  DEFAULT_BRANCH,
+  DEPLOYED_MODE,
+  FileStructureType,
+  LATEST_EDITS_MODE,
+  MOST_RECENT_COMMIT_MODE,
+  MULTI_SELECT_PROMPT_HELP,
+  SELECT_PROMPT_HELP,
+  addExistingFilePathsForApi,
+  atLeastOneSelection,
+  deleteResourcesAndUpdateRootConfig,
+  extractApiName,
+  getApiRepresentation,
+  getCurrentGitBranch,
+  getCurrentGitBranchIfGit,
+  getFileStructureType,
+  getHeadCommit,
+  getLocalGitRepoState,
+  getMode,
+  isCI,
+  isGitRepoDirty,
+  modeFlagToViewMode,
+  modeFlagValuesMap,
+  readApiFromDisk,
+  readApplicationFromDisk,
+  readMultiPageApplicationFromDisk,
+  removeResourceFromDisk,
+  sortByKey,
+  validateLocalResource,
+  writeAppApi,
+  writeApplicationToDisk,
+  writeResourceToDisk,
+  type ApiRepresentation,
+  type ModeFlag,
+} from "./version-control.mjs";
+
+export { createDevServer } from "./dev-utils/dev-server.mjs";
+
+export { dev, type ApplicationConfig } from "./cli-replacement/dev.mjs";
+export { fetchAndWriteApplication } from "./cli-replacement/init.js";
+
+export { ExportViewMode } from "@superblocksteam/shared";

package/src/sdk.ts

@@ -1,8 +1,4 @@
-import {
-  ComponentEvent,
-  LocalGitRepoState,
-  SuperblocksResourceType,
-} from "@superblocksteam/util";
+import { ExportViewMode } from "@superblocksteam/shared";
 import {
   fetchApi,
   fetchApiCommits,
@@ -14,20 +10,35 @@ import {
   fetchApplicationWithComponents,
   fetchCurrentUser,
   pushApi,
-  PushApiWithCommitConfig,
   pushApplication,
-  PushMultiPageApplicationWithCommitConfig,
   registerComponents,
   uploadComponents,
   validateGitSetup,
   deployApplication,
   deployApi,
-} from "./client";
-import { FeatureFlags } from "./flag";
-import { UserMeDto, ViewMode } from "./types";
+} from "./client.js";
+import {
+  downloadApplicationDirectory,
+  uploadLocalApplication,
+  printDirectoryEntries,
+  printFileContents,
+  getApplicationDirectoryHash,
+} from "./dbfs/client.js";
+import { hashLocalDirectory } from "./dbfs/local.js";
+import { FeatureFlags } from "./flag.js";
+import type {
+  PushApiWithCommitConfig,
+  PushMultiPageApplicationWithCommitConfig,
+} from "./client.js";
+import type { UserMeDto } from "./types/index.js";
+import type {
+  ComponentEvent,
+  LocalGitRepoState,
+  SuperblocksResourceType,
+} from "@superblocksteam/util";
 
 // Exporting here instead of index.ts because only sdk.ts is exposed outside in package.json
-export * from "./errors";
+export * from "./errors.js";
 
 export class SuperblocksSdk {
   token = "";
@@ -57,13 +68,13 @@ export class SuperblocksSdk {
     applicationId,
     branch,
     headers = {},
-    viewMode = "export-live",
+    viewMode = ExportViewMode.EXPORT_LIVE,
     skipSigningVerification = false,
   }: {
     applicationId: string;
     branch?: string;
     headers?: Record<string, string>;
-    viewMode?: ViewMode;
+    viewMode?: ExportViewMode;
     skipSigningVerification?: boolean;
   }) {
     return fetchApplication({
@@ -92,14 +103,14 @@ export class SuperblocksSdk {
     applicationId,
     branch,
     headers = {},
-    viewMode = "export-live",
+    viewMode = ExportViewMode.EXPORT_LIVE,
     commitId,
     skipSigningVerification = false,
   }: {
     applicationId: string;
     branch: string;
     headers?: Record<string, string>;
-    viewMode?: ViewMode;
+    viewMode?: ExportViewMode;
     commitId?: string;
     skipSigningVerification?: boolean;
   }) {
@@ -178,12 +189,12 @@ export class SuperblocksSdk {
   async fetchApi({
     apiId,
     branch,
-    viewMode = "export-live",
+    viewMode = ExportViewMode.EXPORT_LIVE,
     commitId,
     skipSigningVerification = false,
   }: {
     apiId: string;
-    viewMode?: ViewMode;
+    viewMode?: ExportViewMode;
     branch?: string;
     commitId?: string;
     skipSigningVerification?: boolean;
@@ -308,6 +319,69 @@ export class SuperblocksSdk {
     });
   }
 
+  async dbfsGetApplication({
+    applicationId,
+    branch,
+    localDirectoryPath,
+  }: {
+    applicationId: string;
+    branch?: string;
+    localDirectoryPath: string;
+  }) {
+    await downloadApplicationDirectory(
+      this.token,
+      this.superblocksBaseUrl,
+      applicationId,
+      branch,
+      localDirectoryPath,
+    );
+  }
+
+  async dbfsPutApplication({
+    applicationId,
+    branch,
+    localDirectoryPath,
+  }: {
+    applicationId: string;
+    branch?: string;
+    localDirectoryPath: string;
+  }) {
+    await uploadLocalApplication(
+      this.token,
+      this.superblocksBaseUrl,
+      applicationId,
+      branch,
+      localDirectoryPath,
+    );
+  }
+
+  async dbfsGetApplicationDirectoryHash({
+    applicationId,
+    branch,
+  }: {
+    applicationId: string;
+    branch: string | undefined;
+  }) {
+    return getApplicationDirectoryHash(
+      this.token,
+      this.superblocksBaseUrl,
+      applicationId,
+      branch,
+    );
+  }
+
+  async dbfsList({ hash }: { hash: string }) {
+    await printDirectoryEntries(this.token, this.superblocksBaseUrl, hash);
+  }
+
+  async dbfsCat({ hash }: { hash: string }) {
+    await printFileContents(this.token, this.superblocksBaseUrl, hash);
+  }
+
+  async hashLocalDirectory(localDirectoryPath: string) {
+    return await hashLocalDirectory(localDirectoryPath);
+  }
+
   async deployApplication(applicationId: string, commitId?: string) {
     return deployApplication(
       this.cliVersion,

package/src/socket/handlers.ts

@@ -1,53 +1,15 @@
-import { LocalGitRepoState } from "@superblocksteam/util";
-import {
+import { signResource, verifyResources } from "./signing.js";
+import type { AppToSign, AppToVerify, MethodHandlers } from "../types/index.js";
+import type {
   ApiToSign,
   ApiToVerify,
-  AppToSign,
-  AppToVerify,
-  MethodHandlers,
-  RemoteCommitDto,
-  Signature,
-  ViewMode,
-} from "../types";
-import { signResource, verifyResources } from "./signing";
-
-type MethodSchema<Params, Response> = (params: Params) => Promise<Response>;
-
-export interface ClientMethods {
-  v1: {
-    signing: {
-      signApplication: MethodSchema<
-        { branchName: string; toSign: AppToSign },
-        { signature: Signature }
-      >;
-      signApis: MethodSchema<
-        { branchName: string; toSign: ApiToSign[] },
-        { signatures: Signature[] }
-      >;
-      verifyApplication: MethodSchema<
-        { branchName: string; toVerify: AppToVerify },
-        { ok: boolean }
-      >;
-      verifyApi: MethodSchema<
-        { branchName: string; toVerify: ApiToVerify[] },
-        { ok: boolean }
-      >;
-    };
-  };
-}
-
-type ServerMethodSchema<Params, Response> = MethodSchema<
-  Params,
-  ResponseDto<Response>
->;
+  ClientMethods,
+  ServerMethods,
+} from "@superblocksteam/shared";
+import type { Signature } from "@superblocksteam/util";
 
 // This file contains the definition of the protocol used for communication between the SB server and clients
 
-type ResponseDto<T> = {
-  responseMeta: ResponseMeta;
-  data: T;
-};
-
 export type ResponseMeta = {
   status: number;
   success: boolean;
@@ -60,106 +22,6 @@ type APIResponseError = {
   message: string;
 };
 
-export interface ServerMethods {
-  v1: {
-    echo: MethodSchema<{ message: string }, { message: string }>;
-    public: {
-      application: {
-        component: {
-          register: ServerMethodSchema<
-            {
-              applicationId: string;
-              branchName: string;
-              cliVersion: string;
-              componentEvent: string;
-              components: Record<string, unknown>;
-            },
-            { success: boolean }
-          >;
-          update: ServerMethodSchema<
-            {
-              applicationId: string;
-              branchName?: string;
-              srcFiles: string[];
-              buildFiles: string[];
-              registeredComponents: Record<string, unknown>;
-              cliVersion: string | undefined;
-              componentBaseUrl: string;
-              signingRequired: boolean;
-            },
-            { success: boolean }
-          >;
-        };
-        pushCommit: ServerMethodSchema<
-          {
-            applicationId: string;
-            branchName: string;
-            commitId: string;
-            commitMessage: string;
-            application: Record<string, unknown>;
-            page: Record<string, unknown>;
-            apis: Record<string, unknown>[];
-            gitState: LocalGitRepoState;
-          },
-          RemoteCommitDto
-        >;
-      };
-      api: {
-        pushCommit: ServerMethodSchema<
-          {
-            apiId: string;
-            branchName: string;
-            commitId?: string;
-            commitMessage?: string;
-            apiPb: Record<string, unknown>;
-            gitState: LocalGitRepoState;
-            skipCommit: boolean;
-          },
-          RemoteCommitDto | { updated: Date }
-        >;
-        get: ServerMethodSchema<
-          {
-            apiId: string;
-            branchName?: string;
-            viewMode: ViewMode;
-            commitId?: string;
-          },
-          any
-        >;
-      };
-    };
-  };
-  v2: {
-    public: {
-      application: {
-        pushCommit: ServerMethodSchema<
-          {
-            applicationId: string;
-            branchName: string;
-            commitId?: string;
-            commitMessage?: string;
-            application: Record<string, unknown>;
-            pages: Record<string, unknown>[];
-            apis: Record<string, unknown>[];
-            gitState: LocalGitRepoState;
-            skipCommit: boolean;
-          },
-          RemoteCommitDto | { updated: Date }
-        >;
-        get: ServerMethodSchema<
-          {
-            applicationId: string;
-            viewMode: ViewMode;
-            branchName?: string;
-            commitId?: string;
-          },
-          any
-        >;
-      };
-    };
-  };
-}
-
 export function createRequestHandlers({
   agentUrl,
   token,
@@ -216,7 +78,7 @@ export function createRequestHandlers({
                   agentUrl,
                   token: token,
                   branchName,
-                  resource: { api: apiPb },
+                  resource: { api: apiPb as any },
                 });
                 signatures.push(signature);
               }
@@ -276,7 +138,7 @@ export function createRequestHandlers({
                   token,
                   branchName,
                   resources: toVerify.map(({ apiPb }) => ({
-                    api: apiPb,
+                    api: apiPb as any,
                   })),
                 });
                 return { ok: true };

package/src/socket/index.ts

@@ -1,17 +1,14 @@
 import WebSocket from "ws";
-import {
+import { createRequestHandlers } from "./handlers.js";
+import { createISocketClient, ISocket } from "./socket.js";
+import type {
   GenericMiddleware,
   ISocketClient,
   MethodHandlers,
   RequestContextBase,
   SocketTimeouts,
-} from "../types";
-import {
-  ClientMethods,
-  createRequestHandlers,
-  ServerMethods,
-} from "./handlers";
-import { createISocketClient, ISocket } from "./socket";
+} from "../types/index.js";
+import type { ClientMethods, ServerMethods } from "@superblocksteam/shared";
 
 export type StdISocketRPCClient = ISocketClient<ServerMethods>;
 
@@ -36,7 +33,7 @@ export async function connectToISocketRPCServer({
     wsUrl.protocol = "wss:";
   }
 
-  if (wsUrl.host === "localhost:3000") {
+  if (wsUrl.host === "localhost:3000" || wsUrl.host === "127.0.0.1:3000") {
     wsUrl.host = "127.0.0.1:8080";
   } else if (wsUrl.hostname === "localhost") {
     wsUrl.hostname = "127.0.0.1";

package/src/socket/signing.ts

@@ -1,11 +1,12 @@
-import axios, { AxiosRequestConfig, Method } from "axios";
-import {
+import axios from "axios";
+import { getSanitizedApi } from "../utils.js";
+import type {
   ApiResource,
   GenericResource,
-  Signature,
   SignatureResponse,
-} from "../types";
-import { getSanitizedApi } from "../utils";
+} from "../types/index.js";
+import type { Signature } from "@superblocksteam/util";
+import type { AxiosRequestConfig, Method } from "axios";
 
 export async function signResource({
   token,
@@ -22,7 +23,6 @@ export async function signResource({
     branchName: branchName ?? "main",
   };
   if ((resource as ApiResource).api) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     requestResource.api = getSanitizedApi((resource as ApiResource).api);
   } else {
     requestResource.literal = (resource as GenericResource).literal;
@@ -58,7 +58,6 @@ export async function verifyResources({
       resources: resources.map((res) => {
         if ((res as ApiResource).api) {
           return {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             api: getSanitizedApi((res as ApiResource).api),
             branchName: branchName ?? "main",
           };
@@ -93,7 +92,7 @@ async function callAgent<T>({
       headers: {
         Authorization: "Bearer " + token,
       },
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+
       data: data,
     };
     const resp = await axios<T>(config);

package/src/socket/socket.ts

@@ -1,14 +1,14 @@
-import WebSocket from "ws";
-import {
+import { SocketErrorException } from "../types/index.js";
+import type {
   ISocketClient,
   MethodHandler,
   MethodHandlers,
   RequestContextBase,
   SocketTimeouts,
-  SocketErrorException,
   GenericMiddleware,
   NonEmptyArray,
-} from "../types";
+} from "../types/index.js";
+import type WebSocket from "ws";
 
 interface SocketRequest<Payload = unknown> {
   method: string;
@@ -101,9 +101,8 @@ export class ISocket<
 
     this.ws.addEventListener(
       "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);
       },
@@ -205,7 +204,7 @@ export class ISocket<
       if (message.response.error) {
         responseHandler.reject(message.response.error);
       }
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
       responseHandler.resolve(message.response.payload as any);
       clearTimeout(responseHandler.timeout);
       this.responseHandler.delete(message.response.id);
@@ -241,7 +240,7 @@ export class ISocket<
       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 = {
@@ -394,7 +393,7 @@ export function createISocketClient<
 ): ISocketClient<CallableMethods> {
   return {
     close: () => socket.close(),
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
     call: createIsocketProxy(socket, undefined) as any,
   };
 }