@metabase/client 0.0.0-stage → 0.1.0

package/dist/transport-E0ZaPNWJ.d.ts

@@ -0,0 +1,462 @@
+import { a as Credential, o as CredentialRefresher } from "./credential-6aOEGqMH.js";
+import { n as TokenFeatures, t as SessionProperties } from "./session-properties-COtlxAcK.js";
+import { i as FeatureName, r as FeatureGap } from "./features-CnFkUCj2.js";
+import { i as ServerVersion, n as Edition } from "./tag-qzjGGci8.js";
+import { ZodError, ZodType, z } from "zod";
+//#region src/version/probe.d.ts
+declare const PROBE_PATH = "/api/session/properties";
+declare const PROBE_TIMEOUT_MS = 10000;
+interface ServerInfo {
+  readonly version: ServerVersion;
+  readonly edition: Edition | null;
+  readonly date: string | null;
+  readonly hash: string | null;
+  readonly tokenFeatures: Readonly<TokenFeatures> | null;
+}
+interface ProbeOptions {
+  timeoutMs?: number;
+  retries?: number;
+}
+interface ProbeBudget {
+  timeoutMs: number;
+  retries: number;
+}
+type ProbeTransport = Pick<Transport, "requestParsed">;
+declare function probeServer(client: ProbeTransport, opts?: ProbeOptions): Promise<ServerInfo>;
+declare function probeBudget(opts: ProbeOptions): ProbeBudget;
+declare function serverInfoFromProperties(properties: SessionProperties): ServerInfo;
+declare function profileFromProperties(properties: SessionProperties): ServerProfile;
+//#endregion
+//#region src/version/profile.d.ts
+declare const Skew: z.ZodEnum<{
+  development: "development";
+  supported: "supported";
+  "older-than-known": "older-than-known";
+  "newer-than-known": "newer-than-known";
+}>;
+type Skew = z.infer<typeof Skew>;
+declare const ServerProfile: z.ZodObject<{
+  version: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"release">;
+    tag: z.ZodString;
+    major: z.ZodNumber;
+    patch: z.ZodNumber;
+  }, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"development">;
+    tag: z.ZodString;
+  }, z.core.$strip>], "kind">;
+  buildDate: z.ZodNullable<z.ZodString>;
+  hash: z.ZodNullable<z.ZodString>;
+  edition: z.ZodEnum<{
+    oss: "oss";
+    ee: "ee";
+  }>;
+  tokenFeatures: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+  features: z.ZodRecord<z.ZodEnum<{
+    contentTranslation: "contentTranslation";
+    dataActionCollections: "dataActionCollections";
+    dataActionsWithoutModel: "dataActionsWithoutModel";
+    transforms: "transforms";
+    transformJobActivation: "transformJobActivation";
+    measures: "measures";
+    library: "library";
+    libraryDashboards: "libraryDashboards";
+    remoteSync: "remoteSync";
+    remoteSyncRemoteChanges: "remoteSyncRemoteChanges";
+    remoteSyncCollectionsOnlyUpdate: "remoteSyncCollectionsOnlyUpdate";
+    remoteSyncExportPreflight: "remoteSyncExportPreflight";
+    remoteSyncBranchGuard: "remoteSyncBranchGuard";
+    remoteSyncMerge: "remoteSyncMerge";
+    contentVerification: "contentVerification";
+    transformTargetTableId: "transformTargetTableId";
+    transformTargetTableLinkedOnCreate: "transformTargetTableLinkedOnCreate";
+    transformJobRunIdIsNumeric: "transformJobRunIdIsNumeric";
+    transformCheckpointReset: "transformCheckpointReset";
+    fieldDataSensitivity: "fieldDataSensitivity";
+    fieldRemappingAppendsDisplayColumns: "fieldRemappingAppendsDisplayColumns";
+    transformDagRuns: "transformDagRuns";
+    unifiedTransformRuns: "unifiedTransformRuns";
+    transformTests: "transformTests";
+    libraryChildrenCarryType: "libraryChildrenCarryType";
+    collectionItemsTotalOnEmptyPage: "collectionItemsTotalOnEmptyPage";
+    invalidMbqlIsBadRequest: "invalidMbqlIsBadRequest";
+    boxplotDisplay: "boxplotDisplay";
+    nativeTableTemplateTag: "nativeTableTemplateTag";
+    smartLinkMeasureModel: "smartLinkMeasureModel";
+    dashboardSubscriptionFilters: "dashboardSubscriptionFilters";
+    dependencyGraph: "dependencyGraph";
+    dependencyItemListings: "dependencyItemListings";
+    dependencyAsyncBackfill: "dependencyAsyncBackfill";
+    measureDependencyGraph: "measureDependencyGraph";
+    tableListAccessFilters: "tableListAccessFilters";
+    tableListTransformTargets: "tableListTransformTargets";
+    tableListPublishedFilter: "tableListPublishedFilter";
+    tableUnusedFilter: "tableUnusedFilter";
+    tableDataLayerTiers: "tableDataLayerTiers";
+    bulkTableEdit: "bulkTableEdit";
+    tableUserValueWithdrawal: "tableUserValueWithdrawal";
+    bulkTableSync: "bulkTableSync";
+    erd: "erd";
+    documentCopy: "documentCopy";
+    transformInspector: "transformInspector";
+    pythonLibrary: "pythonLibrary";
+    pythonTestRun: "pythonTestRun";
+    sourceReplacement: "sourceReplacement";
+    metricDefinitionQuery: "metricDefinitionQuery";
+    metricDimensionListing: "metricDimensionListing";
+    oauthFullAccessScopeUnadvertised: "oauthFullAccessScopeUnadvertised";
+    exportCsvByteOrderMark: "exportCsvByteOrderMark";
+  }>, z.ZodBoolean>;
+  skew: z.ZodEnum<{
+    development: "development";
+    supported: "supported";
+    "older-than-known": "older-than-known";
+    "newer-than-known": "newer-than-known";
+  }>;
+}, z.core.$strip>;
+type ServerProfile = z.infer<typeof ServerProfile>;
+declare function createServerProfile(info: ServerInfo): ServerProfile;
+declare function featureGap(profile: ServerProfile, feature: FeatureName): FeatureGap | null;
+//#endregion
+//#region src/errors.d.ts
+type ErrorCategory = "network" | "http" | "validation" | "response-shape" | "timeout" | "config" | "capability" | "partial-write" | "abort" | "internal" | "failed" | "unknown";
+interface NetworkErrorDetail {
+  method: string;
+  url: string;
+  cause: string;
+}
+interface HttpTimeoutDetail {
+  kind: "http";
+  method: string;
+  url: string;
+  timeoutMs: number;
+}
+interface PollingTimeoutDetail {
+  kind: "polling";
+  timeoutMs: number;
+  attempts: number;
+}
+type TimeoutErrorDetail = HttpTimeoutDetail | PollingTimeoutDetail;
+interface ValidationErrorDetail {
+  source: string;
+  zodIssues: ZodError["issues"];
+}
+interface ZodResponseShapeDetail {
+  kind: "zod";
+  method: string;
+  url: string;
+  status: number;
+  zodIssues: ZodError["issues"];
+  serverTag: string | null;
+  serverSkew: Skew | null;
+}
+interface DecodedResponseShapeDetail {
+  kind: "decoded";
+  source: string;
+  value: string | null;
+}
+type ResponseShapeErrorDetail = ZodResponseShapeDetail | DecodedResponseShapeDetail;
+interface UnknownErrorDetail {
+  originalMessage: string;
+  stack: string | null;
+}
+declare abstract class MetabaseError extends Error {
+  abstract readonly category: ErrorCategory;
+  abstract readonly isRetryable: boolean;
+  abstract readonly developerDetail: unknown;
+  get userMessage(): string;
+}
+declare class NetworkError extends MetabaseError {
+  readonly category = "network";
+  readonly isRetryable = true;
+  readonly developerDetail: NetworkErrorDetail;
+  constructor(message: string, developerDetail: NetworkErrorDetail);
+}
+declare class TimeoutError extends MetabaseError {
+  readonly category = "timeout";
+  readonly isRetryable = true;
+  readonly developerDetail: TimeoutErrorDetail;
+  constructor(message: string, developerDetail: TimeoutErrorDetail);
+}
+declare class ValidationError extends MetabaseError {
+  readonly category = "validation";
+  readonly isRetryable = false;
+  readonly developerDetail: ValidationErrorDetail;
+  constructor(message: string, developerDetail: ValidationErrorDetail);
+  get userMessage(): string;
+}
+declare class ResponseShapeError extends MetabaseError {
+  readonly category = "response-shape";
+  readonly isRetryable = false;
+  readonly developerDetail: ResponseShapeErrorDetail;
+  constructor(message: string, developerDetail: ResponseShapeErrorDetail);
+  static fromZodIssues(developerDetail: ZodResponseShapeDetail): ResponseShapeError;
+}
+declare class ConfigError extends MetabaseError {
+  readonly category = "config";
+  readonly isRetryable = false;
+  readonly developerDetail: null;
+  constructor(message: string);
+}
+declare class InternalError extends MetabaseError {
+  readonly category = "internal";
+  readonly isRetryable = false;
+  readonly developerDetail: null;
+  constructor(message: string);
+}
+declare class FailedResultError extends MetabaseError {
+  readonly category = "failed";
+  readonly isRetryable = false;
+  readonly developerDetail: null;
+  constructor(message: string);
+}
+declare class AbortError extends MetabaseError {
+  readonly category = "abort";
+  readonly isRetryable = false;
+  readonly developerDetail: null;
+  constructor(message?: string);
+}
+declare function isNonInterruptFailure(error: unknown): error is MetabaseError;
+declare class ChainedRequestError extends MetabaseError {
+  readonly cause: MetabaseError;
+  constructor(message: string, cause: MetabaseError);
+  get category(): ErrorCategory;
+  get isRetryable(): boolean;
+  get developerDetail(): unknown;
+}
+declare class UnknownError extends MetabaseError {
+  readonly category = "unknown";
+  readonly isRetryable = false;
+  readonly developerDetail: UnknownErrorDetail;
+  constructor(input: UnknownErrorDetail);
+}
+interface PartialWriteReported {
+  kind: "reported";
+  value: number | null;
+}
+interface PartialWriteUnreported {
+  kind: "unreported";
+}
+type PartialWriteAnswer = PartialWriteReported | PartialWriteUnreported;
+interface PartialWriteDetail {
+  method: string;
+  path: string;
+  field: string;
+  requested: number;
+  answered: PartialWriteAnswer;
+}
+declare class PartialWriteError extends MetabaseError {
+  readonly category = "partial-write";
+  readonly isRetryable = false;
+  readonly developerDetail: PartialWriteDetail;
+  constructor(message: string, developerDetail: PartialWriteDetail);
+}
+declare function toMetabaseError(error: unknown): MetabaseError;
+declare function formatZodIssue(issue: ZodError["issues"][number]): string;
+declare function isFileNotFoundError(value: unknown): boolean;
+declare function errorMessage(value: unknown): string;
+//#endregion
+//#region src/http/sanitize.d.ts
+interface RedactionContext {
+  knownSecrets: ReadonlySet<string>;
+}
+//#endregion
+//#region src/http/errors.d.ts
+type HttpErrorKind = "route-missing" | "resource-missing" | "auth" | "forbidden" | "conflict" | "rate-limit" | "server-error" | "generic";
+declare const BAD_REQUEST_STATUS = 400;
+declare const UNAUTHORIZED_STATUS = 401;
+declare const PAYMENT_REQUIRED_STATUS = 402;
+declare const FORBIDDEN_STATUS = 403;
+declare const NOT_FOUND_STATUS = 404;
+declare const CONFLICT_STATUS = 409;
+declare const TOO_MANY_REQUESTS_STATUS = 429;
+declare const INTERNAL_SERVER_ERROR_STATUS = 500;
+declare const RemoteSyncedDependent: z.ZodRecord<z.ZodString, z.ZodNumber>;
+type RemoteSyncedDependent = z.infer<typeof RemoteSyncedDependent>;
+type FieldErrors = Record<string, string>;
+declare const FIELD_PATH_SEPARATOR = ".";
+interface HttpErrorDetail {
+  status: number;
+  statusText: string;
+  method: string;
+  url: string;
+  responseHeaders: Record<string, string>;
+  body: string | null;
+  fieldErrors: FieldErrors | null;
+  specificFieldErrors: FieldErrors | null;
+  errorCode: string | null;
+  nonRemoteSyncedDependencies: number[] | null;
+  remoteSyncedDependents: RemoteSyncedDependent[] | null;
+}
+interface HttpErrorInput {
+  status: number;
+  statusText: string;
+  method: string;
+  url: string;
+  responseHeaders: Headers | Record<string, string>;
+  rawBody: string | null;
+  serverTag?: string | null;
+  overrideUserMessage?: string;
+  redactionContext?: RedactionContext;
+}
+declare class HttpError extends MetabaseError {
+  readonly category = "http";
+  readonly status: number;
+  readonly kind: HttpErrorKind;
+  readonly serverMessage: string | null;
+  readonly developerDetail: HttpErrorDetail;
+  constructor(input: HttpErrorInput);
+  get isRetryable(): boolean;
+  get fieldErrors(): FieldErrors | null;
+  get specificFieldErrors(): FieldErrors | null;
+  get errorCode(): string | null;
+  get nonRemoteSyncedDependencies(): number[] | null;
+  get remoteSyncedDependents(): RemoteSyncedDependent[] | null;
+}
+declare function isHttpNotFound(error: unknown): boolean;
+declare function chainRequestFailure(cause: MetabaseError, message: string): MetabaseError;
+declare function isRetryableStatus(status: number): boolean;
+//#endregion
+//#region src/version/capability-error.d.ts
+declare const RequirementReason: z.ZodEnum<{
+  "version-too-old": "version-too-old";
+  "missing-token-feature": "missing-token-feature";
+  "superseded-by-feature": "superseded-by-feature";
+}>;
+type RequirementReason = z.infer<typeof RequirementReason>;
+declare const RequirementFailure: z.ZodObject<{
+  reason: z.ZodEnum<{
+    "version-too-old": "version-too-old";
+    "missing-token-feature": "missing-token-feature";
+    "superseded-by-feature": "superseded-by-feature";
+  }>;
+  detail: z.ZodString;
+  feature: z.ZodEnum<{
+    contentTranslation: "contentTranslation";
+    dataActionCollections: "dataActionCollections";
+    dataActionsWithoutModel: "dataActionsWithoutModel";
+    transforms: "transforms";
+    transformJobActivation: "transformJobActivation";
+    measures: "measures";
+    library: "library";
+    libraryDashboards: "libraryDashboards";
+    remoteSync: "remoteSync";
+    remoteSyncRemoteChanges: "remoteSyncRemoteChanges";
+    remoteSyncCollectionsOnlyUpdate: "remoteSyncCollectionsOnlyUpdate";
+    remoteSyncExportPreflight: "remoteSyncExportPreflight";
+    remoteSyncBranchGuard: "remoteSyncBranchGuard";
+    remoteSyncMerge: "remoteSyncMerge";
+    contentVerification: "contentVerification";
+    transformTargetTableId: "transformTargetTableId";
+    transformTargetTableLinkedOnCreate: "transformTargetTableLinkedOnCreate";
+    transformJobRunIdIsNumeric: "transformJobRunIdIsNumeric";
+    transformCheckpointReset: "transformCheckpointReset";
+    fieldDataSensitivity: "fieldDataSensitivity";
+    fieldRemappingAppendsDisplayColumns: "fieldRemappingAppendsDisplayColumns";
+    transformDagRuns: "transformDagRuns";
+    unifiedTransformRuns: "unifiedTransformRuns";
+    transformTests: "transformTests";
+    libraryChildrenCarryType: "libraryChildrenCarryType";
+    collectionItemsTotalOnEmptyPage: "collectionItemsTotalOnEmptyPage";
+    invalidMbqlIsBadRequest: "invalidMbqlIsBadRequest";
+    boxplotDisplay: "boxplotDisplay";
+    nativeTableTemplateTag: "nativeTableTemplateTag";
+    smartLinkMeasureModel: "smartLinkMeasureModel";
+    dashboardSubscriptionFilters: "dashboardSubscriptionFilters";
+    dependencyGraph: "dependencyGraph";
+    dependencyItemListings: "dependencyItemListings";
+    dependencyAsyncBackfill: "dependencyAsyncBackfill";
+    measureDependencyGraph: "measureDependencyGraph";
+    tableListAccessFilters: "tableListAccessFilters";
+    tableListTransformTargets: "tableListTransformTargets";
+    tableListPublishedFilter: "tableListPublishedFilter";
+    tableUnusedFilter: "tableUnusedFilter";
+    tableDataLayerTiers: "tableDataLayerTiers";
+    bulkTableEdit: "bulkTableEdit";
+    tableUserValueWithdrawal: "tableUserValueWithdrawal";
+    bulkTableSync: "bulkTableSync";
+    erd: "erd";
+    documentCopy: "documentCopy";
+    transformInspector: "transformInspector";
+    pythonLibrary: "pythonLibrary";
+    pythonTestRun: "pythonTestRun";
+    sourceReplacement: "sourceReplacement";
+    metricDefinitionQuery: "metricDefinitionQuery";
+    metricDimensionListing: "metricDimensionListing";
+    oauthFullAccessScopeUnadvertised: "oauthFullAccessScopeUnadvertised";
+    exportCsvByteOrderMark: "exportCsvByteOrderMark";
+  }>;
+  since: z.ZodNumber;
+  tokenFeature: z.ZodNullable<z.ZodString>;
+  serverVersion: z.ZodString;
+}, z.core.$strip>;
+type RequirementFailure = z.infer<typeof RequirementFailure>;
+declare function versionTooOldMessage(since: number, serverVersion: string): string;
+declare function missingTokenFeatureMessage(tokenFeature: string): string;
+declare class CapabilityError extends MetabaseError {
+  readonly category = "capability";
+  readonly isRetryable = false;
+  readonly developerDetail: RequirementFailure;
+  constructor(failure: RequirementFailure, refusal?: HttpError | null);
+}
+//#endregion
+//#region src/http/transport.d.ts
+type HttpMethod = "GET" | "HEAD" | "OPTIONS" | "POST" | "PUT" | "PATCH" | "DELETE";
+type ExpectedContentType = "json" | "text" | "binary";
+declare const DEFAULT_METHOD: HttpMethod;
+declare const DEFAULT_TIMEOUT_MS = 30000;
+type QueryPrimitive = string | number | boolean;
+type QueryValue = QueryPrimitive | ReadonlyArray<QueryPrimitive> | undefined;
+interface RequestOptions {
+  signal?: AbortSignal;
+  timeoutMs?: number;
+  retries?: number;
+  idempotent?: boolean;
+}
+interface TransportRequestOptions extends RequestOptions {
+  method?: HttpMethod;
+  query?: Record<string, QueryValue>;
+  body?: unknown;
+  expectContentType?: ExpectedContentType;
+}
+interface Transport {
+  requestParsed<T>(schema: ZodType<T>, path: string, opts?: TransportRequestOptions): Promise<T>;
+  requestRaw(path: string, opts?: TransportRequestOptions): Promise<Response>;
+  requestStream(path: string, opts?: TransportRequestOptions): Promise<ReadableStream<Uint8Array>>;
+  server(options?: WaitOptions): Promise<ServerProfile>;
+  verifiedServer(options?: WaitOptions): Promise<ServerProfile>;
+  probe<T extends SessionProperties>(reader: ZodType<T>, options?: ProbeReadOptions): Promise<T>;
+  requireFeatures(features: readonly FeatureName[], options?: WaitOptions): Promise<void>;
+  preflightServer(options?: WaitOptions): Promise<ServerProfile | null>;
+  refuseBeforeSending(refusal: CapabilityError): void;
+  probesSettled(): Promise<void>;
+}
+type WaitOptions = Pick<RequestOptions, "signal">;
+type ProbeReadOptions = Pick<RequestOptions, "signal" | "timeoutMs" | "retries">;
+interface PreflightRefused {
+  kind: "refused";
+  refusal: CapabilityError;
+}
+interface PreflightUnverified {
+  kind: "unverified";
+  failure: MetabaseError;
+}
+type SkippedPreflight = PreflightRefused | PreflightUnverified;
+interface ClientCredentials {
+  url: string;
+  credential: Credential;
+}
+type ServerTagResolver = () => Promise<string | null>;
+interface ClientOptions {
+  userAgent: string;
+  fetchImpl?: typeof fetch;
+  server?: ServerProfile;
+  getServerTag?: ServerTagResolver;
+  refreshCredential?: CredentialRefresher;
+  onServerProbed?: (info: ServerInfo, profile: ServerProfile) => void;
+  onPreflightSkipped?: (skipped: SkippedPreflight) => void;
+  signal?: AbortSignal;
+}
+declare function createTransport(config: ClientCredentials, options: ClientOptions): Transport;
+//#endregion
+export { PartialWriteAnswer as $, HttpErrorDetail as A, profileFromProperties as At, isHttpNotFound as B, versionTooOldMessage as C, PROBE_PATH as Ct, FORBIDDEN_STATUS as D, ServerInfo as Dt, FIELD_PATH_SEPARATOR as E, ProbeOptions as Et, PAYMENT_REQUIRED_STATUS as F, DecodedResponseShapeDetail as G, AbortError as H, RemoteSyncedDependent as I, HttpTimeoutDetail as J, ErrorCategory as K, TOO_MANY_REQUESTS_STATUS as L, HttpErrorKind as M, INTERNAL_SERVER_ERROR_STATUS as N, FieldErrors as O, probeBudget as Ot, NOT_FOUND_STATUS as P, NetworkErrorDetail as Q, UNAUTHORIZED_STATUS as R, missingTokenFeatureMessage as S, featureGap as St, CONFLICT_STATUS as T, ProbeBudget as Tt, ChainedRequestError as U, isRetryableStatus as V, ConfigError as W, MetabaseError as X, InternalError as Y, NetworkError as Z, WaitOptions as _, isNonInterruptFailure as _t, ExpectedContentType as a, ResponseShapeError as at, RequirementFailure as b, Skew as bt, PreflightUnverified as c, TimeoutErrorDetail as ct, QueryValue as d, ValidationError as dt, PartialWriteDetail as et, RequestOptions as f, ValidationErrorDetail as ft, TransportRequestOptions as g, isFileNotFoundError as gt, Transport as h, formatZodIssue as ht, DEFAULT_TIMEOUT_MS as i, PollingTimeoutDetail as it, HttpErrorInput as j, serverInfoFromProperties as jt, HttpError as k, probeServer as kt, ProbeReadOptions as l, UnknownError as lt, SkippedPreflight as m, errorMessage as mt, ClientOptions as n, PartialWriteReported as nt, HttpMethod as o, ResponseShapeErrorDetail as ot, ServerTagResolver as p, ZodResponseShapeDetail as pt, FailedResultError as q, DEFAULT_METHOD as r, PartialWriteUnreported as rt, PreflightRefused as s, TimeoutError as st, ClientCredentials as t, PartialWriteError as tt, QueryPrimitive as u, UnknownErrorDetail as ut, createTransport as v, toMetabaseError as vt, BAD_REQUEST_STATUS as w, PROBE_TIMEOUT_MS as wt, RequirementReason as x, createServerProfile as xt, CapabilityError as y, ServerProfile as yt, chainRequestFailure as z };