@superblocksteam/util 1.99.99-next.3 → 2.0.0-SNAPSHOT.fefa63e659e53195

package/dist/index.js

@@ -29,4 +29,5 @@ __exportStar(require("./api-files/types.js"), exports);
 __exportStar(require("./api-files/index.js"), exports);
 __exportStar(require("./api-files/constants.js"), exports);
 __exportStar(require("./mask-unix-signals.js"), exports);
+__exportStar(require("./token-manager.js"), exports);
 //# sourceMappingURL=index.js.map

package/{eslint.config.js → eslint.config.mjs}

@@ -1,38 +1,38 @@
-const js = require("@eslint/js");
-const importPlugin = require("eslint-plugin-import");
-const prettier = require("eslint-plugin-prettier");
-const eslintPluginPrettierRecommended = require("eslint-plugin-prettier/recommended");
-const unicorn = require("eslint-plugin-unicorn");
-const globals = require("globals");
-const tseslint = require("typescript-eslint");
+import js from "@eslint/js";
+import prettier from "eslint-config-prettier";
+import turbo from "eslint-config-turbo/flat";
+import importPlugin from "eslint-plugin-import";
+import unicorn from "eslint-plugin-unicorn";
+import { defineConfig } from "eslint/config";
+import globals from "globals";
+import tseslint from "typescript-eslint";
 
-const config = [
+export default defineConfig(
   {
-    ignores: [
-      "**/public/*",
-      "**/build/*",
-      "**/node_modules/*",
-      "**/dist/*",
-      "**/assets/",
-      "**/.*",
-      "eslint.config.js",
-      "tsup.config.ts",
-    ],
+    ignores: ["dist/**/*", ".turbo/**/*"],
   },
   js.configs.recommended,
-  ...tseslint.configs.recommended,
-  { files: ["./*", "src/**"], ...eslintPluginPrettierRecommended },
+  tseslint.configs.recommended,
+  turbo,
   {
     plugins: {
-      "@typescript-eslint": tseslint.plugin,
-      prettier,
       import: importPlugin,
       unicorn,
     },
     languageOptions: {
-      ecmaVersion: 2020,
+      ecmaVersion: 2024,
       sourceType: "commonjs",
       globals: globals.node,
+      parserOptions: {
+        projectService: {
+          allowDefaultProject: [
+            "eslint.config.mjs",
+            "lint-staged.config.mjs",
+            "vitest.config.ts",
+          ],
+        },
+        tsconfigRootDir: import.meta.dirname,
+      },
     },
     rules: {
       "@typescript-eslint/explicit-module-boundary-types": "off",
@@ -42,22 +42,7 @@ const config = [
       "@typescript-eslint/no-import-type-side-effects": "error",
       "@typescript-eslint/consistent-type-imports": "error",
       "unicorn/no-nested-ternary": "off",
-      "import/order": [
-        "error",
-        {
-          alphabetize: { order: "asc" },
-          groups: [
-            "builtin",
-            "external",
-            "internal",
-            "parent",
-            "sibling",
-            "index",
-            "object",
-            "type",
-          ],
-        },
-      ],
+      "import/order": "off",
       "import/no-cycle": "error",
       "import/extensions": [
         "error",
@@ -78,6 +63,5 @@ const config = [
       "@typescript-eslint/no-unused-expressions": "off",
     },
   },
-];
-
-module.exports = config;
+  prettier,
+);

package/lint-staged.config.mjs

@@ -0,0 +1,6 @@
+export default {
+  "*.{js,jsx,ts,tsx,mjs,mts}":
+    "eslint --fix --max-warnings 0 --no-warn-ignored --concurrency=auto",
+  "*": "oxfmt --no-error-on-unmatched-pattern",
+  "**/*.{ts,tsx,mts}": () => "pnpm typecheck",
+};

package/package.json

@@ -1,38 +1,35 @@
 {
   "name": "@superblocksteam/util",
+  "version": "2.0.0-SNAPSHOT.fefa63e659e53195",
   "description": "",
-  "version": "1.99.99-next.3",
   "homepage": "https://www.superblocks.com",
   "license": "Superblocks Community Software License",
+  "sideEffects": false,
   "main": "dist/index.js",
   "dependencies": {
-    "ajv": "^8.12.0",
+    "ajv": "^8.20.0",
     "better-ajv-errors": "1.2.0",
     "fs-extra": "^11.1.1",
-    "lodash": "^4.17.21",
-    "lodash-es": "^4.17.21",
+    "lodash-es": "^4.18.1",
     "mime-types": "^2.1.35",
     "slugify": "^1.6.6",
-    "typescript": "^5.1.3",
+    "typescript": "^6.0.3",
     "yaml": "^2.4.2"
   },
   "devDependencies": {
-    "@eslint/js": "^9.16.0",
+    "@eslint/js": "^9.39.2",
     "@types/fs-extra": "^11.0.1",
-    "@types/lodash": "^4.17.7",
     "@types/lodash-es": "^4.17.12",
     "@types/mime-types": "^2.1.1",
-    "@types/node": "^20.11.18",
-    "@typescript-eslint/eslint-plugin": "^8.25.0",
-    "@typescript-eslint/parser": "^8.25.0",
-    "eslint": "^9.21.0",
-    "eslint-plugin-import": "2.31.0",
-    "eslint-plugin-mocha": "^10.5.0",
-    "eslint-plugin-prettier": "^5.2.5",
-    "eslint-plugin-unicorn": "^47.0.0",
-    "prettier": "^3.5.2",
-    "tslib": "^2.5.0",
-    "typescript-eslint": "^8.18.0"
+    "@types/node": "^24",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-config-turbo": "^2.9.16",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-unicorn": "^62.0.0",
+    "globals": "^17.3.0",
+    "typescript-eslint": "^8.59.2",
+    "vitest": "^4.0.17"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
@@ -40,10 +37,13 @@
   "scripts": {
     "build": "tsc --build",
     "check": "pnpm run lint && pnpm run typecheck",
-    "clean": "rm -rf dist tsconfig.tsbuildinfo",
-    "dev": "tsc --build --watch",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
+    "clean": "premove dist/ tsconfig.tsbuildinfo",
+    "dev": "tsc --build --watch --preserveWatchOutput",
+    "lint": "eslint --concurrency=auto",
+    "lint:fix": "eslint --fix --concurrency=auto",
+    "publish-package": "pnpm publish",
+    "test": "vitest run",
+    "test:watch": "vitest",
     "typecheck": "tsc --noEmit"
   }
 }

package/src/api-files/api.mts

@@ -2,6 +2,7 @@ import fs from "fs-extra";
 import { cloneDeep } from "lodash-es";
 import slugify from "slugify";
 import { parse, stringify as ymlstringify } from "yaml";
+
 import {
   DEFAULT_LINES_FOR_LARGE_STEPS,
   LANGUAGE_STEP_EXTENSIONS,
@@ -257,7 +258,7 @@ async function readYamlFile(path: string): Promise<any> {
   return parse(await fs.readFile(path, "utf8"));
 }
 
-async function resolveLanguageSpecificStepContentFromBlocks(
+export async function resolveLanguageSpecificStepContentFromBlocks(
   parentPath: string,
   blocks: Block[],
   stepPathMap: Record<string, string>,
@@ -464,12 +465,13 @@ export async function writeApiFiles(
 export async function readAppApiYamlFile(
   parentDirectory: string,
   apiName?: string,
+  slugifyDirectoryName: boolean = true,
 ): Promise<{ api: Api; stepPathMap: Record<string, string> }> {
   // The API is either stored in its entirety in a single YAML file, or
   // or in a subdirectory containing the YAML file and zero or more language-specific files.
   const apiNameSlug = slugifyName(apiName ?? "api");
   const singularApiYamlPath = `${parentDirectory}/${apiNameSlug}.yaml`;
-  const apiDirPath = `${parentDirectory}/${apiNameSlug}`;
+  const apiDirPath = `${parentDirectory}/${slugifyDirectoryName ? apiNameSlug : apiName}`;
   const nestedApiYamlPath = `${apiDirPath}/api.yaml`;
 
   // Read the YAML file

package/src/api-files/index.ts

@@ -13,3 +13,10 @@ export async function readAppApiYamlFile(
   const esmFunction = await import("./api.mjs");
   return esmFunction.readAppApiYamlFile(...args);
 }
+
+export async function resolveLanguageSpecificStepContentFromBlocks(
+  ...args: Parameters<typeof Api.resolveLanguageSpecificStepContentFromBlocks>
+) {
+  const esmFunction = await import("./api.mjs");
+  return esmFunction.resolveLanguageSpecificStepContentFromBlocks(...args);
+}

package/src/api-files/types.ts

@@ -60,7 +60,7 @@ export type Step = {
   python?: LanguageContent;
 };
 
-export type Loop = {
+type Loop = {
   blocks: Block[];
   range: string;
   type: LoopType;
@@ -68,34 +68,31 @@ export type Loop = {
 };
 
 export enum LoopType {
-  FOR = "TYPE_FOR",
   FOR_EACH = "TYPE_FOREACH",
-  WHILE = "TYPE_WHILE",
-  UNSPECIFIED = "TYPE_UNSPECIFIED",
 }
 
-export type TryCatch = {
+type TryCatch = {
   try?: Blocks;
   catch?: Blocks;
   finally?: Blocks;
   variables?: Variables;
 };
 
-export type Conditional = {
+type Conditional = {
   if?: ConditionalBlockWithCondition;
   elseIf: ConditionalBlockWithCondition[];
   else?: Blocks;
 };
 
-export type Blocks = {
+type Blocks = {
   blocks: Block[];
 };
 
-export type ConditionalBlockWithCondition = Blocks & {
+type ConditionalBlockWithCondition = Blocks & {
   condition?: string;
 };
 
-export type Parallel = {
+type Parallel = {
   static?: {
     paths: Record<string, Blocks>;
   };
@@ -108,27 +105,27 @@ export type Parallel = {
   wait?: WAIT_TYPE;
 };
 
-export type Stream = {
+type Stream = {
   trigger?: StreamTrigger;
   process?: Blocks;
   variables?: Variables;
 };
 
-export type StreamTrigger = {
+type StreamTrigger = {
   name: string;
   step?: Step;
 };
 
-export enum WAIT_TYPE {
+enum WAIT_TYPE {
   ALL = "WAIT_ALL",
   ANY = "WAIT_NONE",
   UNSPECIFIED = "WAIT_UNSPECIFIED",
 }
 
-export type Variables = Record<string, string>;
+type Variables = Record<string, string>;
 
 export type LanguageContent = {
   body: Body;
 };
 
-export type Body = string | { path: string };
+type Body = string | { path: string };

package/src/component-configs.ts

@@ -2,8 +2,10 @@ import { execFile } from "node:child_process";
 import os from "node:os";
 import path from "node:path";
 import * as util from "node:util";
-import * as fs from "fs-extra";
-import * as mimeTypes from "mime-types";
+
+import fs from "fs-extra";
+import mimeTypes from "mime-types";
+
 import { CUSTOM_COMPONENTS_PATH } from "./constants.js";
 import { generateComponentTypesFile } from "./generate-component-types.js";
 import { validateCustomComponents } from "./validation.js";
@@ -31,7 +33,7 @@ async function compileTypeScript(
         "--moduleResolution",
         "node",
         "--module",
-        "commonjs",
+        "es2022",
         "--strict",
         "true",
         "--skipLibCheck",

package/src/constants.ts

@@ -1,21 +1,7 @@
 export const SUPERBLOCKS_HOME_FOLDER_NAME = ".superblocks";
 export const TOKEN_CONFIG_PATH = ".superblocks/auth.json";
 export const RESOURCE_CONFIG_PATH = ".superblocks/superblocks.json";
-
-/* It's a relative path from resource's directory to a project's root
-├── apps
-│   ├── <app_name>
-│   │   ├── apis
-│   │   │   ├── <api_name1>
-...
-│   │   │   ├── <api_nameN>
-│   │   ├── application.yaml
-│   │   └── page.yaml
-├── backends
-│   └── <scheduled job|workflow_name>
-│       └── api.yaml
-*/
-export const ROOT_CONFIG_RELATIVE_PATH = "../..";
+export const DEV_ENVIRONMENT_CONFIG_PATH = ".superblocks/dev-environment.json";
 
 export const CUSTOM_COMPONENTS_PATH = "components";
 

package/src/data-types.ts

@@ -1,11 +1,4 @@
-export const supportedDataTypes = [
-  "string",
-  "number",
-  "boolean",
-  "any",
-] as const;
-
-export type DataType = (typeof supportedDataTypes)[number];
+export type DataType = "string" | "number" | "boolean" | "any";
 
 interface TypeInfo {
   tsType: string;
@@ -30,10 +23,3 @@ export const dataTypeDefinions: Record<DataType, TypeInfo> = {
     prompt: "any (raw js expression)",
   },
 };
-
-export function isValidDataType(input: string): input is DataType {
-  return Object.prototype.hasOwnProperty.call(
-    dataTypeDefinions,
-    input as DataType,
-  );
-}

package/src/file-uploader.test.ts

@@ -0,0 +1,69 @@
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+
+import { getBucketeerUrlFromSuperblocksUrl } from "./file-uploader.js";
+
+describe("getBucketeerUrlFromSuperblocksUrl", () => {
+  let originalUrl: string | undefined;
+
+  beforeEach(() => {
+    originalUrl = process.env.SUPERBLOCKS_BUCKETEER_URL;
+    delete process.env.SUPERBLOCKS_BUCKETEER_URL;
+  });
+
+  afterEach(() => {
+    if (originalUrl === undefined) {
+      delete process.env.SUPERBLOCKS_BUCKETEER_URL;
+    } else {
+      process.env.SUPERBLOCKS_BUCKETEER_URL = originalUrl;
+    }
+  });
+
+  it("returns the default localhost bucketeer URL for localhost servers", () => {
+    expect(getBucketeerUrlFromSuperblocksUrl("http://localhost:8080")).toBe(
+      "http://localhost:8030",
+    );
+    expect(getBucketeerUrlFromSuperblocksUrl("http://127.0.0.1:8080")).toBe(
+      "http://localhost:8030",
+    );
+  });
+
+  it("honors SUPERBLOCKS_BUCKETEER_URL for localhost servers (slot-aware worktrees)", () => {
+    process.env.SUPERBLOCKS_BUCKETEER_URL = "http://localhost:8330";
+    expect(getBucketeerUrlFromSuperblocksUrl("http://localhost:8380")).toBe(
+      "http://localhost:8330",
+    );
+    expect(getBucketeerUrlFromSuperblocksUrl("http://127.0.0.1:8380")).toBe(
+      "http://localhost:8330",
+    );
+  });
+
+  it("falls back to localhost default when the input URL is unparseable", () => {
+    expect(getBucketeerUrlFromSuperblocksUrl("not a url")).toBe(
+      "http://localhost:8030",
+    );
+  });
+
+  it("uses SUPERBLOCKS_BUCKETEER_URL when the input URL is unparseable", () => {
+    process.env.SUPERBLOCKS_BUCKETEER_URL = "http://localhost:8330";
+    expect(getBucketeerUrlFromSuperblocksUrl("not a url")).toBe(
+      "http://localhost:8330",
+    );
+  });
+
+  it("ignores SUPERBLOCKS_BUCKETEER_URL for non-localhost hostnames", () => {
+    process.env.SUPERBLOCKS_BUCKETEER_URL = "http://localhost:8330";
+
+    expect(
+      getBucketeerUrlFromSuperblocksUrl("https://app.superblocks.com"),
+    ).toBe("https://bucketeer.superblocks.com");
+    expect(
+      getBucketeerUrlFromSuperblocksUrl("https://staging.superblocks.com"),
+    ).toBe("https://bucketeer.staging.superblocks.com");
+    expect(
+      getBucketeerUrlFromSuperblocksUrl("https://eu.superblocks.com"),
+    ).toBe("https://bucketeer.eu.superblocks.com");
+    expect(
+      getBucketeerUrlFromSuperblocksUrl("https://pr-123.superblocks.dev"),
+    ).toBe("https://bucketeer.dev.superblocks.com");
+  });
+});

package/src/file-uploader.ts

@@ -1,28 +1,42 @@
-import { isEmpty } from "lodash";
-
 export const COMPONENT_EVENT_HEADER = "x-superblocks-component-event";
 
+// SUPERBLOCKS_BUCKETEER_URL lets slot-N Tilt worktrees override the default
+// localhost bucketeer URL (http://localhost:8030) when the server runs on a
+// different slot offset. The local-orch Tilt profile injects this variable
+// for the server's serve env.
+const localhostBucketeerUrl = (): string =>
+  process.env.SUPERBLOCKS_BUCKETEER_URL ?? "http://localhost:8030";
+
 // retrieves bucketeer base URL given the superblocks server base URL
 export const getBucketeerUrlFromSuperblocksUrl = (
   superblocksBaseUrl: string,
 ): string => {
-  // if superblocks base URL is an EE, return bucketeer's dev URL
-  if (!isEmpty(superblocksBaseUrl.match(new RegExp("pr-.*.superblocks.dev")))) {
+  let hostname: string;
+  try {
+    hostname = new URL(superblocksBaseUrl).hostname;
+  } catch {
+    return localhostBucketeerUrl();
+  }
+
+  if (/^pr-.*\.superblocks\.dev$/u.test(hostname)) {
     return "https://bucketeer.dev.superblocks.com";
   }
 
-  switch (superblocksBaseUrl) {
-    case "https://eu.superblocks.com":
+  switch (hostname) {
+    case "eu.superblocks.com":
+    case "prod-eu.superblocks.com":
       return "https://bucketeer.eu.superblocks.com";
-    case "https://staging.superblocks.com":
+    case "app.staging.superblocks.com":
+    case "staging.superblocks.com":
       return "https://bucketeer.staging.superblocks.com";
-    case "https://app.superblocks.com":
-    case "https://app.superblockshq.com":
+    case "app.superblocks.com":
+    case "app.superblockshq.com":
       return "https://bucketeer.superblocks.com";
-    case "https://dev.superblocks.com":
+    case "dev.superblocks.com":
       return "https://bucketeer.dev.superblocks.com";
-    case "http://localhost:3000":
+    case "127.0.0.1":
+    case "localhost":
     default:
-      return "http://localhost:8030";
+      return localhostBucketeerUrl();
   }
 };

package/src/index.ts

@@ -13,3 +13,4 @@ export * from "./api-files/types.js";
 export * from "./api-files/index.js";
 export * from "./api-files/constants.js";
 export * from "./mask-unix-signals.js";
+export * from "./token-manager.js";

package/src/login.ts

@@ -1,6 +1,8 @@
 import { homedir } from "node:os";
-import { join } from "node:path";
-import * as fs from "fs-extra";
+import { dirname, join } from "node:path";
+
+import fs from "fs-extra";
+
 import { FileAccessError, TOKEN_CONFIG_PATH } from "./constants.js";
 
 type BaseUrl = {
@@ -11,20 +13,32 @@ type TokenWithBaseUrl = BaseUrl & {
   token: string;
 };
 
+/**
+ * Returns the resolved auth file path, honoring the SUPERBLOCKS_AUTH_FILE
+ * environment variable. Both reads and writes MUST use this so the CLI
+ * never writes to one file and reads from another.
+ */
+export function resolveAuthFilePath(): string {
+  return (
+    process.env.SUPERBLOCKS_AUTH_FILE || join(homedir(), TOKEN_CONFIG_PATH)
+  );
+}
+
 export async function saveApiToken(superblocksBaseUrl: string, token?: string) {
   try {
-    await fs.ensureDir(join(homedir(), ".superblocks"));
+    const authFile = resolveAuthFilePath();
+    await fs.ensureDir(dirname(authFile));
     if (token) {
       const tokenConfig: TokenWithBaseUrl = {
         superblocksBaseUrl,
         token,
       };
-      await fs.writeJSON(join(homedir(), TOKEN_CONFIG_PATH), tokenConfig);
+      await fs.writeJSON(authFile, tokenConfig);
     } else {
       const tokenConfig: BaseUrl = {
         superblocksBaseUrl,
       };
-      await fs.writeJSON(join(homedir(), TOKEN_CONFIG_PATH), tokenConfig);
+      await fs.writeJSON(authFile, tokenConfig);
     }
   } catch {
     throw new FileAccessError("Could not save token");
@@ -46,18 +60,20 @@ export async function getLocalTokenWithUrl(): Promise<
 > {
   try {
     const tokenConfig: TokenWithBaseUrl = await fs.readJSON(
-      process.env.SUPERBLOCKS_AUTH_FILE || join(homedir(), TOKEN_CONFIG_PATH),
+      resolveAuthFilePath(),
     );
+    const superblocksBaseUrl =
+      process.env.SUPERBLOCKS_BASE_URL || tokenConfig.superblocksBaseUrl;
     if (tokenConfig.token) {
       // user logged in
       return {
         token: tokenConfig.token,
-        superblocksBaseUrl: tokenConfig.superblocksBaseUrl,
+        superblocksBaseUrl,
       };
     } else {
       // user not logged in, but set domain
       return {
-        superblocksBaseUrl: tokenConfig.superblocksBaseUrl,
+        superblocksBaseUrl,
       };
     }
   } catch {

package/src/mask-unix-signals.ts

@@ -3,7 +3,7 @@ const unixSignalsToMask: NodeJS.Signals[] = ["SIGINT", "SIGTERM", "SIGHUP"];
 // The exit code that is used when the process is aborted due to a unix signal
 const exitCode = 254;
 
-export type ActionResult<T> =
+type ActionResult<T> =
   | { success: true; returnValue: T }
   | { success: false; error: unknown };