@dbx-tools/appkit 0.3.37 → 0.3.39

package/package.json

@@ -18,21 +18,25 @@
     "@databricks/sdk-experimental": "^0.17.0",
     "yaml": "^2.9.0",
     "zod": "4.3.6",
-    "@dbx-tools/core": "0.3.37",
-    "@dbx-tools/shared-core": "0.3.37"
+    "@dbx-tools/core": "0.3.39",
+    "@dbx-tools/shared-core": "0.3.39"
   },
   "main": "index.ts",
   "license": "UNLICENSED",
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.3.37",
+  "version": "0.3.39",
   "types": "index.ts",
   "type": "module",
   "exports": {
     ".": "./index.ts",
     "./package.json": "./package.json"
   },
+  "files": [
+    "index.ts",
+    "src"
+  ],
   "peerDependenciesMeta": {
     "@databricks/appkit": {
       "optional": true

package/test/config.test.ts

@@ -1,63 +0,0 @@
-import assert from "node:assert/strict";
-import { afterEach, describe, it } from "node:test";
-import { ValidationError } from "@databricks/appkit";
-import { resolveConfigValue, withCliSources, type ConfigSource } from "../src/config";
-
-const ENV_KEY = "DBX_TOOLS_APPKIT_TEST_VALUE";
-
-afterEach(() => {
-  delete process.env[ENV_KEY];
-});
-
-describe("config precedence", () => {
-  it("prefers explicit config over the environment", async () => {
-    process.env[ENV_KEY] = "from-env";
-    const value = await resolveConfigValue(ENV_KEY, {
-      explicit: { [ENV_KEY]: "from-explicit" },
-    });
-    assert.equal(value, "from-explicit");
-  });
-
-  it("falls back to the environment when explicit config omits the key", async () => {
-    process.env[ENV_KEY] = "from-env";
-    const value = await resolveConfigValue(ENV_KEY, { explicit: { OTHER_KEY: "x" } });
-    assert.equal(value, "from-env");
-  });
-
-  it("prepends explicit even when the caller passes its own source list", async () => {
-    process.env[ENV_KEY] = "from-env";
-    const value = await resolveConfigValue(ENV_KEY, {
-      sources: ["env"],
-      explicit: { [ENV_KEY]: "from-explicit" },
-    });
-    assert.equal(value, "from-explicit");
-  });
-
-  it("lets a cli flag win when cli sources are requested", async () => {
-    process.env[ENV_KEY] = "from-env";
-    const value = await resolveConfigValue(ENV_KEY, {
-      sources: withCliSources(),
-      cli: { [ENV_KEY]: "from-cli" },
-      explicit: { [ENV_KEY]: "from-explicit" },
-    });
-    assert.equal(value, "from-cli");
-  });
-
-  it("orders cli sources ahead of explicit and the default sources", () => {
-    assert.deepEqual(withCliSources(), ["cli", "explicit", "env", "bundle"]);
-    assert.deepEqual(withCliSources(["explicit", "env"]), ["cli", "explicit", "env"]);
-  });
-
-  it("skips blank values instead of treating them as resolved", async () => {
-    process.env[ENV_KEY] = "from-env";
-    const value = await resolveConfigValue(ENV_KEY, { explicit: { [ENV_KEY]: "   " } });
-    assert.equal(value, "from-env");
-  });
-
-  it("rejects an unknown source", async () => {
-    await assert.rejects(
-      () => resolveConfigValue(ENV_KEY, { sources: ["nope" as ConfigSource] }),
-      ValidationError,
-    );
-  });
-});

package/test/lakebase-resolver.test.ts

@@ -1,82 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { ValidationError } from "@databricks/appkit";
-import { nextPollDelay, parsePort, parseSslMode, pollDelay } from "../src/lakebase-resolver";
-
-describe("PGPORT validation", () => {
-  it("accepts a numeric string and a number", () => {
-    assert.equal(parsePort("5433"), 5433);
-    assert.equal(parsePort(5432), 5432);
-  });
-
-  it("treats absent and empty values as unset", () => {
-    assert.equal(parsePort(undefined), undefined);
-    assert.equal(parsePort(""), undefined);
-  });
-
-  it("rejects anything that is not a TCP port instead of yielding NaN", () => {
-    for (const bad of ["abc", "0", "70000", "5432.5"]) {
-      assert.throws(
-        () => parsePort(bad),
-        (err) => {
-          assert.ok(err instanceof ValidationError);
-          assert.match(err.message, /PGPORT/);
-          return true;
-        },
-      );
-    }
-  });
-});
-
-describe("PGSSLMODE validation", () => {
-  it("normalizes case and surrounding space", () => {
-    assert.equal(parseSslMode(" Require "), "require");
-    assert.equal(parseSslMode("disable"), "disable");
-  });
-
-  it("treats absent and empty values as unset", () => {
-    assert.equal(parseSslMode(undefined), undefined);
-    assert.equal(parseSslMode(""), undefined);
-  });
-
-  it("rejects a mode pg does not accept", () => {
-    assert.throws(
-      () => parseSslMode("verify-full"),
-      (err) => {
-        assert.ok(err instanceof ValidationError);
-        assert.match(err.message, /PGSSLMODE/);
-        return true;
-      },
-    );
-  });
-});
-
-describe("poll backoff", () => {
-  it("grows with the attempt and stays inside the jitter band", () => {
-    const base = 2_000;
-    for (let attempt = 0; attempt < 10; attempt++) {
-      const delay = nextPollDelay(attempt, base);
-      assert.ok(delay >= 0);
-      assert.ok(delay <= 15_000 * 1.2 + 1, `attempt ${attempt} produced ${delay}`);
-    }
-    const first = Array.from({ length: 20 }, () => nextPollDelay(0, base));
-    const later = Array.from({ length: 20 }, () => nextPollDelay(4, base));
-    assert.ok(Math.max(...first) < Math.min(...later));
-  });
-
-  it("caps the delay so a long wait keeps polling", () => {
-    assert.ok(nextPollDelay(50, 2_000) <= 15_000 * 1.2 + 1);
-  });
-
-  it("rejects with the abort reason when cancelled mid-wait", async () => {
-    const controller = new AbortController();
-    const waiting = pollDelay(5, 10_000, controller.signal);
-    const reason = new Error("boot cancelled");
-    controller.abort(reason);
-    await assert.rejects(waiting, reason);
-  });
-
-  it("rejects immediately for an already-aborted signal", async () => {
-    await assert.rejects(pollDelay(0, 10_000, AbortSignal.abort(new Error("gone"))), /gone/);
-  });
-});

package/test/pgaddress.test.ts

@@ -1,76 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { parseAddress, parseResourcePath, SSL_MODES } from "../src/pgaddress";
-
-describe("pgaddress parseAddress", () => {
-  it("returns nothing for empty and unrecognized input", () => {
-    assert.deepEqual(parseAddress(undefined), {});
-    assert.deepEqual(parseAddress(""), {});
-    assert.deepEqual(parseAddress("   "), {});
-    assert.deepEqual(parseAddress("Not An Address"), {});
-  });
-
-  it("splits a Postgres URI into host, user, database, port and ssl mode", () => {
-    const parsed = parseAddress(
-      "postgresql://me%40acme.com@ep-1.database.eastus2.azuredatabricks.net:5433/app?sslmode=disable",
-    );
-    assert.equal(parsed.host, "ep-1.database.eastus2.azuredatabricks.net");
-    assert.equal(parsed.user, "me@acme.com");
-    assert.equal(parsed.database, "app");
-    assert.equal(parsed.port, 5433);
-    assert.equal(parsed.sslMode, "disable");
-  });
-
-  it("ignores an ssl mode the driver does not accept", () => {
-    assert.equal(
-      parseAddress("postgres://h.example.com/db?sslmode=verify-full").sslMode,
-      undefined,
-    );
-    assert.deepEqual([...SSL_MODES], ["require", "disable", "prefer"]);
-  });
-
-  it("recovers project, branch and endpoint from a canonical endpoint path", () => {
-    const path = "projects/demo/branches/production/endpoints/ep-1";
-    assert.deepEqual(parseAddress(path), {
-      project: "demo",
-      branch: "production",
-      endpointId: "ep-1",
-      endpoint: path,
-    });
-  });
-
-  it("keeps a database resource id separate from PGDATABASE", () => {
-    assert.deepEqual(
-      parseAddress("projects/demo/branches/production/databases/databricks-postgres"),
-      {
-        project: "demo",
-        branch: "production",
-        databaseResourceId: "databricks-postgres",
-      },
-    );
-  });
-
-  it("reads shorter resource paths", () => {
-    assert.deepEqual(parseAddress("projects/demo"), { project: "demo" });
-    assert.deepEqual(parseAddress("projects/demo/branches/main"), {
-      project: "demo",
-      branch: "main",
-    });
-    assert.deepEqual(parseAddress("projects/demo/branches"), {});
-  });
-
-  it("treats a dotted value as a hostname and a bare slug as a project id", () => {
-    assert.deepEqual(parseAddress("ep-1.database.azuredatabricks.net"), {
-      host: "ep-1.database.azuredatabricks.net",
-    });
-    assert.deepEqual(parseAddress("dbx-tools-demo"), { project: "dbx-tools-demo" });
-  });
-});
-
-describe("pgaddress parseResourcePath", () => {
-  it("only accepts `projects/` paths so a bare branch id is not read as a project", () => {
-    assert.deepEqual(parseResourcePath("production"), {});
-    assert.deepEqual(parseResourcePath(undefined), {});
-    assert.equal(parseResourcePath("projects/demo/branches/main").branch, "main");
-  });
-});

package/test/plugin.test.ts

@@ -1,64 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { ConfigurationError } from "@databricks/appkit";
-import { data, instance, require as requirePlugin, type PluginContextLike } from "../src/plugin";
-
-class FakeLakebasePlugin {
-  exports() {
-    return { pool: "pool" };
-  }
-}
-
-function fakeFactory(name: string, calls: { count: number }) {
-  return () => {
-    calls.count += 1;
-    return { plugin: FakeLakebasePlugin, name };
-  };
-}
-
-function fakeContext(entries: Record<string, unknown>): PluginContextLike {
-  const plugins = new Map(Object.entries(entries));
-  return { getPlugins: () => plugins };
-}
-
-describe("plugin lookup", () => {
-  it("caches the factory descriptor per factory", () => {
-    const calls = { count: 0 };
-    const factory = fakeFactory("lakebase", calls);
-    assert.equal(data(factory).name, "lakebase");
-    assert.equal(data(factory).name, "lakebase");
-    assert.equal(calls.count, 1);
-  });
-
-  it("returns the registered instance, or undefined without a context", () => {
-    const factory = fakeFactory("lakebase", { count: 0 });
-    const plugin = new FakeLakebasePlugin();
-    assert.equal(instance(fakeContext({ lakebase: plugin }), factory), plugin);
-    assert.equal(instance(fakeContext({}), factory), undefined);
-    assert.equal(instance(undefined, factory), undefined);
-  });
-
-  it("require returns the instance when registered", () => {
-    const factory = fakeFactory("lakebase", { count: 0 });
-    const plugin = new FakeLakebasePlugin();
-    assert.equal(requirePlugin(fakeContext({ lakebase: plugin }), factory), plugin);
-  });
-
-  it("require throws a ConfigurationError naming the plugin and the caller", () => {
-    const factory = fakeFactory("lakebase", { count: 0 });
-    assert.throws(
-      () => requirePlugin(fakeContext({ server: {} }), factory, "mastra"),
-      (err) => {
-        assert.ok(err instanceof ConfigurationError);
-        assert.match(err.message, /mastra/);
-        assert.match(err.message, /lakebase/);
-        return true;
-      },
-    );
-  });
-
-  it("require throws without a context at all", () => {
-    const factory = fakeFactory("lakebase", { count: 0 });
-    assert.throws(() => requirePlugin(undefined, factory), ConfigurationError);
-  });
-});

package/test/provision.test.ts

@@ -1,35 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { ValidationError } from "@databricks/appkit";
-import { cacheGrantStatements } from "../src/provision";
-
-describe("cache schema grants", () => {
-  it("quotes the schema and an email-shaped role", () => {
-    const statements = cacheGrantStatements("me@acme.com");
-    assert.equal(statements.length, 5);
-    for (const sql of statements) {
-      assert.match(sql, /"appkit"/);
-      assert.match(sql, /"me@acme\.com"/);
-    }
-    assert.equal(statements[0], 'GRANT USAGE, CREATE ON SCHEMA "appkit" TO "me@acme.com"');
-  });
-
-  it("rejects a role name that could not be an identifier", () => {
-    for (const bad of ['ev"il', "role; DROP SCHEMA appkit", "", "a b"]) {
-      assert.throws(
-        () => cacheGrantStatements(bad),
-        (err) => {
-          assert.ok(err instanceof ValidationError);
-          assert.match(err.message, /role/);
-          return true;
-        },
-      );
-    }
-  });
-
-  it("keeps the grants idempotent and scoped to the cache schema", () => {
-    const statements = cacheGrantStatements("sp-1234").join("\n");
-    assert.match(statements, /ALTER DEFAULT PRIVILEGES IN SCHEMA "appkit"/);
-    assert.doesNotMatch(statements, /public/);
-  });
-});

package/test/tsconfig.json

@@ -1,14 +0,0 @@
-// ~~ Generated by projen. To modify, edit .projenrc.js and run "pnpm exec projen".
-{
-  "extends": "../tsconfig.json",
-  "compilerOptions": {
-    "noEmit": true,
-    "rootDir": ".."
-  },
-  "include": [
-    "**/*.ts"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
-}

package/tsconfig.json

@@ -1,41 +0,0 @@
-// ~~ Generated by projen. To modify, edit .projenrc.js and run "pnpm exec projen".
-{
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "lib",
-    "alwaysStrict": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "inlineSourceMap": true,
-    "inlineSources": true,
-    "lib": [
-      "ES2022"
-    ],
-    "module": "ESNext",
-    "noEmitOnError": false,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitAny": true,
-    "noImplicitReturns": true,
-    "noImplicitThis": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "resolveJsonModule": true,
-    "strict": true,
-    "strictNullChecks": true,
-    "strictPropertyInitialization": true,
-    "stripInternal": true,
-    "target": "ES2022",
-    "types": [
-      "node"
-    ],
-    "moduleResolution": "bundler",
-    "skipLibCheck": true
-  },
-  "include": [
-    "src/**/*.ts"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
-}