@homeflare/distilled-grafana 0.2.0

package/dist/services/index.d.ts

@@ -0,0 +1,2 @@
+export * as grafana from "./grafana.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC"}

package/dist/services/index.js

@@ -0,0 +1,3 @@
+// AUTO-GENERATED by scripts/generate.ts. Do not edit.
+export * as grafana from "./grafana.js";
+//# sourceMappingURL=index.js.map

package/dist/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC"}

package/dist/traits.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Grafana SDK trait surface — hand-written.
+ *
+ * Re-exports the generic protocol traits from core (so generated operations
+ * import everything from one place). Grafana 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/dist/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/dist/traits.js

@@ -0,0 +1,11 @@
+/**
+ * Grafana SDK trait surface — hand-written.
+ *
+ * Re-exports the generic protocol traits from core (so generated operations
+ * import everything from one place). Grafana 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/dist/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

@@ -0,0 +1,81 @@
+{
+  "name": "@homeflare/distilled-grafana",
+  "version": "0.2.0",
+  "description": "Interim npm home for @distilled.cloud/grafana — see docs/distilled-interim.md. Not published upstream yet; the kit aliases @distilled.cloud/grafana onto this package until it is.",
+  "homepage": "https://github.com/taslabs-net/homeflare-kit/tree/main/packages/distilled-grafana#readme",
+  "bugs": "https://github.com/taslabs-net/homeflare-kit/issues",
+  "license": "Apache-2.0",
+  "author": "Timothy Schneider",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/taslabs-net/homeflare-kit.git",
+    "directory": "packages/distilled-grafana"
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "bun": "./src/index.ts",
+      "worker": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./Credentials": {
+      "types": "./dist/credentials.d.ts",
+      "bun": "./src/credentials.ts",
+      "worker": "./src/credentials.ts",
+      "default": "./dist/credentials.js"
+    },
+    "./Errors": {
+      "types": "./dist/errors.d.ts",
+      "bun": "./src/errors.ts",
+      "worker": "./src/errors.ts",
+      "default": "./dist/errors.js"
+    },
+    "./Traits": {
+      "types": "./dist/traits.d.ts",
+      "bun": "./src/traits.ts",
+      "worker": "./src/traits.ts",
+      "default": "./dist/traits.js"
+    },
+    "./Pagination": {
+      "types": "./dist/pagination.d.ts",
+      "bun": "./src/pagination.ts",
+      "worker": "./src/pagination.ts",
+      "default": "./dist/pagination.js"
+    },
+    "./Protocol": {
+      "types": "./dist/protocol.d.ts",
+      "bun": "./src/protocol.ts",
+      "worker": "./src/protocol.ts",
+      "default": "./dist/protocol.js"
+    },
+    "./Retry": {
+      "types": "./dist/retry.d.ts",
+      "bun": "./src/retry.ts",
+      "worker": "./src/retry.ts",
+      "default": "./dist/retry.js"
+    },
+    "./*": {
+      "types": "./dist/services/*.d.ts",
+      "bun": "./src/services/*.ts",
+      "worker": "./src/services/*.ts",
+      "default": "./dist/services/*.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@distilled.cloud/core": "1.0.0-rc.12"
+  },
+  "peerDependencies": {
+    "effect": "4.0.0-rc.115"
+  }
+}

package/src/credentials.ts

@@ -0,0 +1,72 @@
+/**
+ * Grafana 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).
+ *
+ * Grafana authenticates HTTP API requests with a service account token
+ * (`Authorization: Bearer <token>`). The optional `X-Grafana-Org-Id` header
+ * selects the organization the action applies to.
+ *
+ * The published OpenAPI document's server URL is `/api` and every path is
+ * relative to that prefix, so the protocol appends `/api` to the instance
+ * origin (`apiBaseUrl`).
+ */
+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";
+
+/** Grafana OSS default listen address (the instance origin, not `/api`). */
+export const DEFAULT_API_BASE_URL = "http://localhost:3000";
+
+export interface Config {
+  readonly token: Redacted.Redacted<string>;
+  readonly apiBaseUrl: string;
+  readonly orgId?: number | string;
+}
+
+export class Credentials extends Context.Service<
+  Credentials,
+  Effect.Effect<Config>
+>()("GrafanaCredentials") {}
+
+/** Layer from a plain service-account token + optional instance URL / org. */
+export const fromApiKey = (config: {
+  readonly apiKey: string;
+  readonly apiBaseUrl?: string;
+  readonly orgId?: number | string;
+}): Layer.Layer<Credentials> =>
+  Layer.succeed(
+    Credentials,
+    Effect.succeed({
+      token: Redacted.make(config.apiKey),
+      apiBaseUrl: config.apiBaseUrl ?? DEFAULT_API_BASE_URL,
+      orgId: config.orgId,
+    }),
+  );
+
+/**
+ * Reads GRAFANA_TOKEN (required), GRAFANA_URL (optional instance origin),
+ * and GRAFANA_ORG_ID (optional).
+ */
+export const CredentialsFromEnv: Layer.Layer<Credentials> = Layer.succeed(
+  Credentials,
+  Effect.gen(function* () {
+    const token = process.env.GRAFANA_TOKEN;
+
+    if (!token) {
+      return yield* new ConfigError({
+        message: "GRAFANA_TOKEN environment variable is required",
+      });
+    }
+
+    return {
+      token: Redacted.make(token),
+      apiBaseUrl: process.env.GRAFANA_URL ?? DEFAULT_API_BASE_URL,
+      orgId: process.env.GRAFANA_ORG_ID,
+    };
+  }).pipe(Effect.orDie),
+);

package/src/errors.ts

@@ -0,0 +1,50 @@
+/**
+ * Grafana-specific error types.
+ *
+ * Re-exports the common HTTP errors from core and adds the Grafana 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 Grafana error — returned when nothing else matches the failure. */
+export class UnknownGrafanaError extends Schema.TaggedError<UnknownGrafanaError>()(
+  "UnknownGrafanaError",
+  {
+    code: Schema.optional(Schema.String),
+    message: Schema.optional(Schema.String),
+    body: Schema.Unknown,
+  },
+).pipe(Category.withServerError) {}
+
+/** Schema parse error wrapper. */
+export class GrafanaParseError extends Schema.TaggedError<GrafanaParseError>()(
+  "GrafanaParseError",
+  {
+    body: Schema.Unknown,
+    cause: Schema.Unknown,
+  },
+).pipe(Category.withParseError) {}

package/src/index.ts

@@ -0,0 +1,33 @@
+/**
+ * @distilled.cloud/grafana — Grafana HTTP 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 Grafana from "@distilled.cloud/grafana";
+ *
+ * const datasources = yield* Grafana.Services.grafana.getDataSources({});
+ * ```
+ */
+export * from "./credentials.ts";
+export * from "./errors.ts";
+export * as T from "./traits.ts";
+export {
+  GrafanaProtocol,
+  type GrafanaOpError,
+  type GrafanaOpContext,
+} from "./protocol.ts";
+export { paginateCursor } from "./pagination.ts";
+export * as Retry from "./retry.ts";
+export * as Services from "./services/index.ts";
+export * from "./services/grafana.ts";
+export {
+  BadRequest,
+  Conflict,
+  Forbidden,
+  NotFound,
+  UnprocessableEntity,
+} from "./services/grafana.ts";

package/src/pagination.ts

@@ -0,0 +1,10 @@
+/**
+ * Grafana pagination — hand-written.
+ *
+ * Grafana list endpoints mix `page`/`limit`/`perpage` query parameters and
+ * rarely return an in-body next-page token; generated operations that do
+ * not stamp `smithy.api#paginated` leave those fields as plain inputs.
+ * {@link paginateCursor} is re-exported for callers that want to drive a
+ * cursor loop themselves.
+ */
+export { paginateCursor } from "@distilled.cloud/core/pagination";

package/src/protocol.ts

@@ -0,0 +1,82 @@
+/**
+ * GrafanaProtocol — hand-written.
+ *
+ * Grafana speaks bearer-authenticated JSON REST (no response envelope),
+ * so the whole protocol is one `makeRestProtocol` call from
+ * `core/protocol-rest`:
+ *
+ *   request:  credentials → `Authorization: Bearer <token>` + optional
+ *             `X-Grafana-Org-Id`, resolved from the calling fiber on every
+ *             request. Paths in the spec are relative to `/api`, so the
+ *             instance origin is joined with that prefix.
+ *
+ *   response: 2xx JSON is the payload (sensitive members delivered as
+ *             `Redacted`); non-2xx `{ message?, status? }` bodies map to the
+ *             operation's typed error classes by status, then the shared
+ *             HTTP-status classes, then {@link UnknownGrafanaError}.
+ */
+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 { UnknownGrafanaError } from "./errors.ts";
+
+/**
+ * Error channel shared by every generated Grafana operation. Generated
+ * service files annotate operations with `API.OperationMethod<I, O,
+ * GrafanaOpError, GrafanaOpContext>` explicitly so the compiler never infers
+ * these back out of the schema generics.
+ */
+export type GrafanaOpError =
+  | InstanceType<(typeof API_ERRORS)[number]>
+  | UnknownGrafanaError
+  | ConfigError
+  | HttpClientError.HttpClientError;
+
+/** Context (requirements) shared by every generated Grafana operation. */
+export type GrafanaOpContext = Credentials | HttpClient.HttpClient;
+
+/** Join the instance origin with `/api` unless the caller already included it. */
+const apiBaseUrl = (origin: string): string => {
+  const trimmed = origin.replace(/\/+$/, "");
+  return trimmed.endsWith("/api") ? trimmed : `${trimmed}/api`;
+};
+
+export const GrafanaProtocol: 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) => apiBaseUrl(creds.apiBaseUrl),
+    headers: (creds) => {
+      const headers: Record<string, string> = {
+        Authorization: `Bearer ${Redacted.value(creds.token)}`,
+        Accept: "application/json",
+      };
+      if (creds.orgId !== undefined) {
+        headers["X-Grafana-Org-Id"] = String(creds.orgId);
+      }
+      return headers;
+    },
+    // Grafana's error body is `{ message?: string, status?: string }` — the
+    // factory's default lenient envelope covers it.
+    unknownError: ({ code, message, body }) =>
+      new UnknownGrafanaError({
+        code:
+          typeof code === "string"
+            ? code
+            : code !== undefined
+              ? String(code)
+              : undefined,
+        message,
+        body,
+      }),
+  });

package/src/retry.ts

@@ -0,0 +1,54 @@
+/**
+ * Grafana 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 Grafana API call below it pick it up:
+ *
+ * @example
+ * ```ts
+ * import * as Grafana from "@distilled.cloud/grafana";
+ *
+ * myEffect.pipe(Grafana.Retry.transient);
+ * Effect.provide(myEffect, Layer.succeed(Grafana.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 Grafana API calls. */
+export class Retry extends Context.Service<Retry, Policy>()("GrafanaRetry") {}
+
+/** Provides a custom retry policy to every Grafana 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);