@distilled.cloud/apache-superset 0.0.0 → 1.0.0-rc.9

package/lib/traits.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Apache Superset SDK trait surface — hand-written.
+ *
+ * Re-exports the generic protocol traits from core (so generated operations
+ * import everything from one place). Apache Superset has no envelope of its
+ * own; the REST-protocol traits (SensitiveValue / RawResponse) come from
+ * `core/protocol-rest`.
+ */
+export { Body, Header, Query, Label, Http, ResponseCode, HttpBody, FormDataFile, KeyDictionary, UnionCases, applyErrorMatchers, getErrorMatchers, type HttpTrait, type ErrorMatcher, bodySymbol, headerSymbol, querySymbol, labelSymbol, httpSymbol, responseCodeSymbol, httpBodySymbol, formDataFileSymbol, keyDictionarySymbol, unionCasesSymbol, errorMatchersSymbol, } from "@distilled.cloud/core/trait";
+export { SensitiveValue, RawResponse, RawResponseRoot, sensitiveValueSymbol, rawResponseSymbol, rawResponseRootSymbol, } from "@distilled.cloud/core/protocol-rest";
+//# sourceMappingURL=traits.d.ts.map

package/lib/traits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traits.d.ts","sourceRoot":"","sources":["../src/traits.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EACL,IAAI,EACJ,MAAM,EACN,KAAK,EACL,KAAK,EACL,IAAI,EACJ,YAAY,EACZ,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,UAAU,EACV,YAAY,EACZ,WAAW,EACX,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EACL,cAAc,EACd,WAAW,EACX,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,qCAAqC,CAAC"}

package/lib/traits.js

@@ -0,0 +1,11 @@
+/**
+ * Apache Superset SDK trait surface — hand-written.
+ *
+ * Re-exports the generic protocol traits from core (so generated operations
+ * import everything from one place). Apache Superset has no envelope of its
+ * own; the REST-protocol traits (SensitiveValue / RawResponse) come from
+ * `core/protocol-rest`.
+ */
+export { Body, Header, Query, Label, Http, ResponseCode, HttpBody, FormDataFile, KeyDictionary, UnionCases, applyErrorMatchers, getErrorMatchers, bodySymbol, headerSymbol, querySymbol, labelSymbol, httpSymbol, responseCodeSymbol, httpBodySymbol, formDataFileSymbol, keyDictionarySymbol, unionCasesSymbol, errorMatchersSymbol, } from "@distilled.cloud/core/trait";
+export { SensitiveValue, RawResponse, RawResponseRoot, sensitiveValueSymbol, rawResponseSymbol, rawResponseRootSymbol, } from "@distilled.cloud/core/protocol-rest";
+//# sourceMappingURL=traits.js.map

package/lib/traits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traits.js","sourceRoot":"","sources":["../src/traits.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EACL,IAAI,EACJ,MAAM,EACN,KAAK,EACL,KAAK,EACL,IAAI,EACJ,YAAY,EACZ,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAGhB,UAAU,EACV,YAAY,EACZ,WAAW,EACX,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EACL,cAAc,EACd,WAAW,EACX,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,qCAAqC,CAAC"}

package/package.json

@@ -1,14 +1,85 @@
 {
   "name": "@distilled.cloud/apache-superset",
-  "version": "0.0.0",
-  "description": "Placeholder package for an upcoming distilled SDK.",
-  "license": "Apache-2.0",
+  "version": "1.0.0-rc.9",
   "repository": {
     "type": "git",
     "url": "https://github.com/alchemy-run/distilled",
     "directory": "packages/apache-superset"
   },
-  "publishConfig": {
-    "access": "public"
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "lib",
+    "src"
+  ],
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "bun": "./src/index.ts",
+      "worker": "./src/index.ts",
+      "default": "./lib/index.js"
+    },
+    "./Credentials": {
+      "types": "./lib/credentials.d.ts",
+      "bun": "./src/credentials.ts",
+      "worker": "./src/credentials.ts",
+      "default": "./lib/credentials.js"
+    },
+    "./Errors": {
+      "types": "./lib/errors.d.ts",
+      "bun": "./src/errors.ts",
+      "worker": "./src/errors.ts",
+      "default": "./lib/errors.js"
+    },
+    "./Traits": {
+      "types": "./lib/traits.d.ts",
+      "bun": "./src/traits.ts",
+      "worker": "./src/traits.ts",
+      "default": "./lib/traits.js"
+    },
+    "./Pagination": {
+      "types": "./lib/pagination.d.ts",
+      "bun": "./src/pagination.ts",
+      "worker": "./src/pagination.ts",
+      "default": "./lib/pagination.js"
+    },
+    "./Protocol": {
+      "types": "./lib/protocol.d.ts",
+      "bun": "./src/protocol.ts",
+      "worker": "./src/protocol.ts",
+      "default": "./lib/protocol.js"
+    },
+    "./Retry": {
+      "types": "./lib/retry.d.ts",
+      "bun": "./src/retry.ts",
+      "worker": "./src/retry.ts",
+      "default": "./lib/retry.js"
+    },
+    "./*": {
+      "types": "./lib/services/*.d.ts",
+      "bun": "./src/services/*.ts",
+      "worker": "./src/services/*.ts",
+      "default": "./lib/services/*.js"
+    }
+  },
+  "dependencies": {
+    "@distilled.cloud/core": "1.0.0-rc.9"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/node": "latest",
+    "@effect/platform-bun": ">=4.0.0-rc.112 || >=4.0.0"
+  },
+  "peerDependencies": {
+    "effect": ">=4.0.0-rc.112 || >=4.0.0"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "convert": "bun scripts/convert.ts",
+    "generate": "bun scripts/convert.ts && bun scripts/generate.ts",
+    "typecheck": "tsc -p tsconfig.json",
+    "specs:fetch": "git submodule update --force --init --depth=1 specs/spec-mirror-apache-superset",
+    "specs:update": "git submodule update --remote --force --depth=1 specs/spec-mirror-apache-superset"
   }
-}
+}

package/src/credentials.ts

@@ -0,0 +1,65 @@
+/**
+ * Apache Superset credentials — hand-written.
+ *
+ * The `Credentials` service holds an *effect* that resolves the current
+ * credentials on every request (the protocol layer resolves it per request
+ * on the calling fiber).
+ *
+ * Superset authenticates HTTP API requests with a JWT access token
+ * (`Authorization: Bearer <token>`), typically obtained from
+ * `POST /api/v1/security/login`. Spec paths already include `/api/v1`, so
+ * `apiBaseUrl` is the instance origin.
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+import { ConfigError } from "@distilled.cloud/core/errors";
+
+/** Common local Superset listen address (the instance origin, not `/api/v1`). */
+export const DEFAULT_API_BASE_URL = "http://localhost:8088";
+
+export interface Config {
+  readonly apiKey: Redacted.Redacted<string>;
+  readonly apiBaseUrl: string;
+}
+
+export class Credentials extends Context.Service<
+  Credentials,
+  Effect.Effect<Config>
+>()("ApacheSupersetCredentials") {}
+
+/** Layer from a JWT access token + optional instance URL. */
+export const fromApiKey = (config: {
+  readonly apiKey: string;
+  readonly apiBaseUrl?: string;
+}): Layer.Layer<Credentials> =>
+  Layer.succeed(
+    Credentials,
+    Effect.succeed({
+      apiKey: Redacted.make(config.apiKey),
+      apiBaseUrl: config.apiBaseUrl ?? DEFAULT_API_BASE_URL,
+    }),
+  );
+
+/**
+ * Reads SUPERSET_ACCESS_TOKEN (required) and SUPERSET_URL (optional instance
+ * origin).
+ */
+export const CredentialsFromEnv: Layer.Layer<Credentials> = Layer.succeed(
+  Credentials,
+  Effect.gen(function* () {
+    const apiKey = process.env.SUPERSET_ACCESS_TOKEN;
+
+    if (!apiKey) {
+      return yield* new ConfigError({
+        message: "SUPERSET_ACCESS_TOKEN environment variable is required",
+      });
+    }
+
+    return {
+      apiKey: Redacted.make(apiKey),
+      apiBaseUrl: process.env.SUPERSET_URL ?? DEFAULT_API_BASE_URL,
+    };
+  }).pipe(Effect.orDie),
+);

package/src/errors.ts

@@ -0,0 +1,50 @@
+/**
+ * Apache Superset-specific error types.
+ *
+ * Re-exports the common HTTP errors from core and adds the Apache Superset
+ * fallback errors. Note the generated service module additionally defines its
+ * own per-status matcher classes (BadRequest/NotFound/…) for the statuses each
+ * operation declares — those share `_tag`s with the core classes here, so
+ * `catchTag` works against either.
+ */
+export {
+  BadGateway,
+  BadRequest,
+  Conflict,
+  ConfigError,
+  Forbidden,
+  GatewayTimeout,
+  InternalServerError,
+  Locked,
+  NotFound,
+  ServiceUnavailable,
+  TooManyRequests,
+  Unauthorized,
+  UnprocessableEntity,
+  HTTP_STATUS_MAP,
+  DEFAULT_ERRORS,
+  API_ERRORS,
+} from "@distilled.cloud/core/errors";
+export type { DefaultErrors } from "@distilled.cloud/core/errors";
+
+import * as Schema from "effect/Schema";
+import * as Category from "@distilled.cloud/core/category";
+
+/** Unknown Apache Superset error — returned when nothing else matches. */
+export class UnknownApacheSupersetError extends Schema.TaggedError<UnknownApacheSupersetError>()(
+  "UnknownApacheSupersetError",
+  {
+    code: Schema.optional(Schema.String),
+    message: Schema.optional(Schema.String),
+    body: Schema.Unknown,
+  },
+).pipe(Category.withServerError) {}
+
+/** Schema parse error wrapper. */
+export class ApacheSupersetParseError extends Schema.TaggedError<ApacheSupersetParseError>()(
+  "ApacheSupersetParseError",
+  {
+    body: Schema.Unknown,
+    cause: Schema.Unknown,
+  },
+).pipe(Category.withParseError) {}

package/src/index.ts

@@ -0,0 +1,32 @@
+/**
+ * @distilled.cloud/apache-superset — Apache Superset REST API SDK for Effect.
+ *
+ * `./services` is generated by `scripts/generate.ts` from the Smithy model
+ * in `.generated-specs` (written by `scripts/convert.ts` from the OpenAPI
+ * spec). Everything else in this folder is hand-written.
+ *
+ * @example
+ * ```ts
+ * import * as ApacheSuperset from "@distilled.cloud/apache-superset";
+ *
+ * const dashboards = yield* ApacheSuperset.Services.superset.getApiV1Dashboard({});
+ * ```
+ */
+export * from "./credentials.ts";
+export * from "./errors.ts";
+export * as T from "./traits.ts";
+export {
+  ApacheSupersetProtocol,
+  type ApacheSupersetOpError,
+  type ApacheSupersetOpContext,
+} from "./protocol.ts";
+export { paginateCursor } from "./pagination.ts";
+export * as Retry from "./retry.ts";
+export * as Services from "./services/index.ts";
+export * from "./services/superset.ts";
+export {
+  BadRequest,
+  Forbidden,
+  NotFound,
+  UnprocessableEntity,
+} from "./services/superset.ts";

package/src/pagination.ts

@@ -0,0 +1,8 @@
+/**
+ * Apache Superset pagination — hand-written.
+ *
+ * List operations that stamp `smithy.api#paginated` are traversed by core's
+ * {@link paginateCursor}. Other list endpoints leave page/limit as plain
+ * inputs.
+ */
+export { paginateCursor } from "@distilled.cloud/core/pagination";

package/src/protocol.ts

@@ -0,0 +1,68 @@
+/**
+ * ApacheSupersetProtocol — hand-written.
+ *
+ * Apache Superset speaks plain bearer-authenticated JSON REST (no response
+ * envelope), so the whole protocol is one `makeRestProtocol` call from
+ * `core/protocol-rest`:
+ *
+ *   request:  credentials → `Authorization: Bearer <apiKey>` + instance origin
+ *             (default http://localhost:8088), resolved from the calling
+ *             fiber on every request. Spec paths already include `/api/v1`.
+ *
+ *   response: 2xx JSON is the payload (sensitive members delivered as
+ *             `Redacted`); non-2xx `{ message?, message_text? }` bodies map
+ *             to the operation's typed error classes by status, then the
+ *             shared HTTP-status classes, then
+ *             {@link UnknownApacheSupersetError}.
+ */
+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 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";
+
+/**
+ * Error channel shared by every generated Apache Superset operation.
+ * Generated service files annotate operations with
+ * `API.OperationMethod<I, O, ApacheSupersetOpError, ApacheSupersetOpContext>`
+ * 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;
+
+/** Context (requirements) shared by every generated Apache Superset operation. */
+export type ApacheSupersetOpContext = Credentials | HttpClient.HttpClient;
+
+export const ApacheSupersetProtocol: Layer.Layer<API.Protocol> =
+  makeRestProtocol<Config>({
+    // The Credentials service holds an effect — resolving it here (per
+    // request, on the calling fiber) picks up context-provided credentials.
+    credentials: Effect.gen(function* () {
+      const resolve = yield* Credentials;
+      return yield* resolve;
+    }),
+    baseUrl: (creds) => creds.apiBaseUrl,
+    headers: (creds) => ({
+      Authorization: `Bearer ${Redacted.value(creds.apiKey)}`,
+    }),
+    unknownError: ({ code, message, body }) =>
+      new UnknownApacheSupersetError({
+        code:
+          typeof code === "string"
+            ? code
+            : code !== undefined
+              ? String(code)
+              : undefined,
+        message,
+        body,
+      }),
+  });

package/src/retry.ts

@@ -0,0 +1,56 @@
+/**
+ * Apache Superset retry configuration.
+ *
+ * Defines the per-SDK `Retry` Context.Service tag that generated operations
+ * wire into `API.make`. Callers can install a blanket retry policy at the
+ * layer level and have every Apache Superset API call below it pick it up:
+ *
+ * @example
+ * ```ts
+ * import * as ApacheSuperset from "@distilled.cloud/apache-superset";
+ *
+ * myEffect.pipe(ApacheSuperset.Retry.transient);
+ * Effect.provide(myEffect, Layer.succeed(ApacheSuperset.Retry.Retry, customPolicy));
+ * ```
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import {
+  type Policy,
+  throttlingFactory,
+  transientFactory,
+} from "@distilled.cloud/core/retry";
+
+export {
+  type Options,
+  type Factory,
+  type Policy,
+  makeDefault,
+  jittered,
+  capped,
+  throttlingOptions,
+  transientOptions,
+  throttlingFactory,
+  transientFactory,
+} from "@distilled.cloud/core/retry";
+
+/** Context tag for configuring retry behavior of Apache Superset API calls. */
+export class Retry extends Context.Service<Retry, Policy>()(
+  "ApacheSupersetRetry",
+) {}
+
+/** Provides a custom retry policy to every Apache Superset API call below it. */
+export const policy = (optionsOrFactory: Policy) =>
+  Effect.provide(Layer.succeed(Retry, optionsOrFactory));
+
+/** Disables all automatic retries. */
+export const none = Effect.provide(
+  Layer.succeed(Retry, { while: () => false }),
+);
+
+/** Apply the throttling retry policy (retries throttling errors indefinitely). */
+export const throttling = policy(throttlingFactory);
+
+/** Apply the transient retry policy (retries all transient errors indefinitely). */
+export const transient = policy(transientFactory);

package/src/services/index.ts

@@ -0,0 +1,2 @@
+// AUTO-GENERATED by scripts/generate.ts. Do not edit.
+export * as superset from "./superset.ts";