@distilled.cloud/apache-superset 1.0.0-rc.11 → 1.0.0-rc.13

package/README.md

@@ -0,0 +1,34 @@
+# @distilled.cloud/apache-superset
+
+Effect-native SDK for [apache-superset](https://www.npmjs.com/package/@distilled.cloud/apache-superset).
+
+## Installation
+
+```bash
+npm install @distilled.cloud/apache-superset effect
+```
+
+## Quick start
+
+```ts
+import { Effect, Layer } from "effect";
+import * as FetchHttpClient from "effect/http/FetchHttpClient";
+import * as ApacheSuperset from "@distilled.cloud/apache-superset";
+
+const program = Effect.gen(function* () {
+  const result = yield* ApacheSuperset.getApiV1Dashboard({});
+  return result;
+});
+
+const Live = Layer.mergeAll(
+  FetchHttpClient.layer,
+  ApacheSuperset.CredentialsFromEnv,
+  ApacheSuperset.ApacheSupersetProtocol,
+);
+
+program.pipe(Effect.provide(Live), Effect.runPromise);
+```
+
+## Auth
+
+Required: `SUPERSET_ACCESS_TOKEN`. Optional: `SUPERSET_URL`. Sent as `Authorization: Bearer`.

package/lib/protocol.d.ts

@@ -1,10 +1,10 @@
 import type * as Layer from "effect/Layer";
-import type * as HttpClient from "effect/unstable/http/HttpClient";
-import type * as HttpClientError from "effect/unstable/http/HttpClientError";
+import type * as HttpClient from "effect/http/HttpClient";
+import type * as HttpClientError from "effect/http/HttpClientError";
 import type * as API from "@distilled.cloud/core/api";
 import type { API_ERRORS, ConfigError } from "@distilled.cloud/core/errors";
 import { Credentials } from "./credentials.ts";
-import { UnknownApacheSupersetError } from "./errors.ts";
+import { UnknownApacheSupersetError, ApacheSupersetParseError } from "./errors.ts";
 /**
  * Error channel shared by every generated Apache Superset operation.
  * Generated service files annotate operations with
@@ -12,7 +12,7 @@ import { UnknownApacheSupersetError } from "./errors.ts";
  * explicitly so the compiler never infers these back out of the schema
  * generics.
  */
-export type ApacheSupersetOpError = InstanceType<(typeof API_ERRORS)[number]> | UnknownApacheSupersetError | ConfigError | HttpClientError.HttpClientError;
+export type ApacheSupersetOpError = InstanceType<(typeof API_ERRORS)[number]> | UnknownApacheSupersetError | ConfigError | HttpClientError.HttpClientError | ApacheSupersetParseError;
 /** Context (requirements) shared by every generated Apache Superset operation. */
 export type ApacheSupersetOpContext = Credentials | HttpClient.HttpClient;
 export declare const ApacheSupersetProtocol: Layer.Layer<API.Protocol>;

package/lib/protocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,KAAK,KAAK,UAAU,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,KAAK,eAAe,MAAM,sCAAsC,CAAC;AAC7E,OAAO,KAAK,KAAK,GAAG,MAAM,2BAA2B,CAAC;AAEtD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAEzD;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAC7B,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GACzC,0BAA0B,GAC1B,WAAW,GACX,eAAe,CAAC,eAAe,CAAC;AAEpC,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC;AAE1E,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAuBzD,CAAC"}
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,KAAK,KAAK,UAAU,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,KAAK,eAAe,MAAM,6BAA6B,CAAC;AACpE,OAAO,KAAK,KAAK,GAAG,MAAM,2BAA2B,CAAC;AAEtD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,EACzB,MAAM,aAAa,CAAC;AAErB;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAC7B,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GACzC,0BAA0B,GAC1B,WAAW,GACX,eAAe,CAAC,eAAe,GAC/B,wBAAwB,CAAC;AAE7B,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC;AAE1E,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAyBzD,CAAC"}

package/lib/protocol.js

@@ -19,7 +19,7 @@ import * as Effect from "effect/Effect";
 import * as Redacted from "effect/Redacted";
 import { makeRestProtocol } from "@distilled.cloud/core/protocol-rest";
 import { Credentials } from "./credentials.js";
-import { UnknownApacheSupersetError } from "./errors.js";
+import { UnknownApacheSupersetError, ApacheSupersetParseError, } from "./errors.js";
 export const ApacheSupersetProtocol = makeRestProtocol({
     // The Credentials service holds an effect — resolving it here (per
     // request, on the calling fiber) picks up context-provided credentials.
@@ -40,5 +40,6 @@ export const ApacheSupersetProtocol = makeRestProtocol({
         message,
         body,
     }),
+    parseError: ({ body, cause }) => new ApacheSupersetParseError({ body, cause }),
 });
 //# sourceMappingURL=protocol.js.map

package/lib/protocol.js.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAI5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAkBzD,MAAM,CAAC,MAAM,sBAAsB,GACjC,gBAAgB,CAAS;IACvB,mEAAmE;IACnE,wEAAwE;IACxE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC;QACnC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC;IACxB,CAAC,CAAC;IACF,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU;IACpC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACnB,aAAa,EAAE,UAAU,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;KACxD,CAAC;IACF,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CACxC,IAAI,0BAA0B,CAAC;QAC7B,IAAI,EACF,OAAO,IAAI,KAAK,QAAQ;YACtB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,KAAK,SAAS;gBAClB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;gBACd,CAAC,CAAC,SAAS;QACjB,OAAO;QACP,IAAI;KACL,CAAC;CACL,CAAC,CAAC"}
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAI5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,GACzB,MAAM,aAAa,CAAC;AAmBrB,MAAM,CAAC,MAAM,sBAAsB,GACjC,gBAAgB,CAAS;IACvB,mEAAmE;IACnE,wEAAwE;IACxE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC;QACnC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC;IACxB,CAAC,CAAC;IACF,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU;IACpC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACnB,aAAa,EAAE,UAAU,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;KACxD,CAAC;IACF,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CACxC,IAAI,0BAA0B,CAAC;QAC7B,IAAI,EACF,OAAO,IAAI,KAAK,QAAQ;YACtB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,KAAK,SAAS;gBAClB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;gBACd,CAAC,CAAC,SAAS;QACjB,OAAO;QACP,IAAI;KACL,CAAC;IACJ,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAC9B,IAAI,wBAAwB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;CAChD,CAAC,CAAC"}

package/lib/response-validation.test.d.ts

@@ -0,0 +1,6 @@
+import { ApacheSupersetParseError } from "./errors.ts";
+import type { ApacheSupersetOpError } from "./protocol.ts";
+export declare const parseErrorIsDeclared: [ApacheSupersetParseError] extends [
+    ApacheSupersetOpError
+] ? true : false;
+//# sourceMappingURL=response-validation.test.d.ts.map

package/lib/response-validation.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-validation.test.d.ts","sourceRoot":"","sources":["../src/response-validation.test.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAGvD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAmC3D,eAAO,MAAM,oBAAoB,EAAE,CAAC,wBAAwB,CAAC,SAAS;IACpE,qBAAqB;CACtB,GACG,IAAI,GACJ,KAAY,CAAC"}

package/lib/response-validation.test.js

@@ -0,0 +1,34 @@
+import { describe, expect, test } from "bun:test";
+import { runValidationModes } from "@distilled.cloud/core/testing";
+import * as Effect from "effect/Effect";
+import { fromApiKey } from "./credentials.js";
+import { ApacheSupersetParseError } from "./errors.js";
+import * as Retry from "./retry.js";
+import { getMe } from "./services/superset.js";
+// getMe declares `{ result?: UserResponseSchema }`; every member is optional,
+// so the mismatch is a wrong primitive (`result.id` must be a number).
+const run = (body) => runValidationModes(getMe({}).pipe(Retry.none, Effect.provide(fromApiKey({ apiKey: "test" }))), { body });
+describe("Apache Superset response validation", () => {
+    test("a matching body succeeds unchanged in both modes", async () => {
+        const body = { result: { id: 1, username: "admin", is_active: true } };
+        const { lenient, strict } = await run(JSON.stringify(body));
+        expect(lenient).toMatchObject({ _tag: "Success", success: body });
+        expect(strict).toMatchObject({ _tag: "Success", success: body });
+    });
+    test("a body with a wrong primitive type: lenient returns it, strict fails", async () => {
+        const body = { result: { id: "one" } };
+        const { lenient, strict } = await run(JSON.stringify(body));
+        expect(lenient).toMatchObject({ _tag: "Success", success: body });
+        expect(strict._tag).toBe("Failure");
+        expect(strict.failure).toBeInstanceOf(ApacheSupersetParseError);
+    });
+    test("a non-JSON body: lenient returns the text, strict fails", async () => {
+        const { lenient, strict } = await run("not json");
+        expect(lenient).toMatchObject({ _tag: "Success", success: "not json" });
+        expect(strict._tag).toBe("Failure");
+        expect(strict.failure).toBeInstanceOf(ApacheSupersetParseError);
+    });
+});
+// ApacheSupersetParseError is part of every operation's declared error type.
+export const parseErrorIsDeclared = true;
+//# sourceMappingURL=response-validation.test.js.map

package/lib/response-validation.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-validation.test.js","sourceRoot":"","sources":["../src/response-validation.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAG/C,8EAA8E;AAC9E,uEAAuE;AACvE,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,EAAE,CAC3B,kBAAkB,CAChB,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAC1E,EAAE,IAAI,EAAE,CACT,CAAC;AAEJ,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;IACnD,IAAI,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,IAAI,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC;QACvE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACtF,MAAM,IAAI,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC;QACvC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,CAAE,MAAc,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,CAAE,MAAc,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,6EAA6E;AAC7E,MAAM,CAAC,MAAM,oBAAoB,GAIrB,IAAI,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@distilled.cloud/apache-superset",
-  "version": "1.0.0-rc.11",
+  "version": "1.0.0-rc.13",
   "repository": {
     "type": "git",
     "url": "https://github.com/alchemy-run/distilled",
@@ -64,15 +64,15 @@
     }
   },
   "dependencies": {
-    "@distilled.cloud/core": "1.0.0-rc.11"
+    "@distilled.cloud/core": "1.0.0-rc.13"
   },
   "devDependencies": {
     "@types/bun": "1.3.14",
     "@types/node": "26.2.0",
-    "@effect/platform-bun": ">=4.0.0-rc.115 || >=4.0.0"
+    "@effect/platform-bun": "^4.0.0"
   },
   "peerDependencies": {
-    "effect": ">=4.0.0-rc.115 || >=4.0.0"
+    "effect": "^4.0.0"
   },
   "scripts": {
     "build": "tsc -b",

package/src/protocol.ts

@@ -18,13 +18,16 @@
 import * as Effect from "effect/Effect";
 import type * as Layer from "effect/Layer";
 import * as Redacted from "effect/Redacted";
-import type * as HttpClient from "effect/unstable/http/HttpClient";
-import type * as HttpClientError from "effect/unstable/http/HttpClientError";
+import type * as HttpClient from "effect/http/HttpClient";
+import type * as HttpClientError from "effect/http/HttpClientError";
 import type * as API from "@distilled.cloud/core/api";
 import { makeRestProtocol } from "@distilled.cloud/core/protocol-rest";
 import type { API_ERRORS, ConfigError } from "@distilled.cloud/core/errors";
 import { Credentials, type Config } from "./credentials.ts";
-import { UnknownApacheSupersetError } from "./errors.ts";
+import {
+  UnknownApacheSupersetError,
+  ApacheSupersetParseError,
+} from "./errors.ts";
 
 /**
  * Error channel shared by every generated Apache Superset operation.
@@ -37,7 +40,8 @@ export type ApacheSupersetOpError =
   | InstanceType<(typeof API_ERRORS)[number]>
   | UnknownApacheSupersetError
   | ConfigError
-  | HttpClientError.HttpClientError;
+  | HttpClientError.HttpClientError
+  | ApacheSupersetParseError;
 
 /** Context (requirements) shared by every generated Apache Superset operation. */
 export type ApacheSupersetOpContext = Credentials | HttpClient.HttpClient;
@@ -65,4 +69,6 @@ export const ApacheSupersetProtocol: Layer.Layer<API.Protocol> =
         message,
         body,
       }),
+    parseError: ({ body, cause }) =>
+      new ApacheSupersetParseError({ body, cause }),
   });

package/src/response-validation.test.ts

@@ -0,0 +1,47 @@
+import { describe, expect, test } from "bun:test";
+import { runValidationModes } from "@distilled.cloud/core/testing";
+import * as Effect from "effect/Effect";
+import { fromApiKey } from "./credentials.ts";
+import { ApacheSupersetParseError } from "./errors.ts";
+import * as Retry from "./retry.ts";
+import { getMe } from "./services/superset.ts";
+import type { ApacheSupersetOpError } from "./protocol.ts";
+
+// getMe declares `{ result?: UserResponseSchema }`; every member is optional,
+// so the mismatch is a wrong primitive (`result.id` must be a number).
+const run = (body: string) =>
+  runValidationModes(
+    getMe({}).pipe(Retry.none, Effect.provide(fromApiKey({ apiKey: "test" }))),
+    { body },
+  );
+
+describe("Apache Superset response validation", () => {
+  test("a matching body succeeds unchanged in both modes", async () => {
+    const body = { result: { id: 1, username: "admin", is_active: true } };
+    const { lenient, strict } = await run(JSON.stringify(body));
+    expect(lenient).toMatchObject({ _tag: "Success", success: body });
+    expect(strict).toMatchObject({ _tag: "Success", success: body });
+  });
+
+  test("a body with a wrong primitive type: lenient returns it, strict fails", async () => {
+    const body = { result: { id: "one" } };
+    const { lenient, strict } = await run(JSON.stringify(body));
+    expect(lenient).toMatchObject({ _tag: "Success", success: body });
+    expect(strict._tag).toBe("Failure");
+    expect((strict as any).failure).toBeInstanceOf(ApacheSupersetParseError);
+  });
+
+  test("a non-JSON body: lenient returns the text, strict fails", async () => {
+    const { lenient, strict } = await run("not json");
+    expect(lenient).toMatchObject({ _tag: "Success", success: "not json" });
+    expect(strict._tag).toBe("Failure");
+    expect((strict as any).failure).toBeInstanceOf(ApacheSupersetParseError);
+  });
+});
+
+// ApacheSupersetParseError is part of every operation's declared error type.
+export const parseErrorIsDeclared: [ApacheSupersetParseError] extends [
+  ApacheSupersetOpError,
+]
+  ? true
+  : false = true;