@metabase/client 0.0.0-stage → 0.1.0

package/dist/version/known-range.js

@@ -0,0 +1,7 @@
+//#region src/version/known-range.ts
+const KNOWN_RANGE = {
+	min: 58,
+	max: 64
+};
+//#endregion
+export { KNOWN_RANGE };

package/dist/version/probe.d.ts

@@ -0,0 +1,2 @@
+import { At as profileFromProperties, Ct as PROBE_PATH, Dt as ServerInfo, Et as ProbeOptions, Ot as probeBudget, Tt as ProbeBudget, jt as serverInfoFromProperties, kt as probeServer, wt as PROBE_TIMEOUT_MS } from "../transport-E0ZaPNWJ.js";
+export { PROBE_PATH, PROBE_TIMEOUT_MS, ProbeBudget, ProbeOptions, ServerInfo, probeBudget, probeServer, profileFromProperties, serverInfoFromProperties };

package/dist/version/probe.js

@@ -0,0 +1,30 @@
+import { SessionProperties } from "../domain/session-properties.js";
+import { editionFromTag, parseTag } from "./tag.js";
+import { createServerProfile } from "./profile.js";
+//#region src/version/probe.ts
+const PROBE_PATH = "/api/session/properties";
+const PROBE_TIMEOUT_MS = 1e4;
+async function probeServer(client, opts = {}) {
+	return serverInfoFromProperties(await client.requestParsed(SessionProperties, PROBE_PATH, probeBudget(opts)));
+}
+function probeBudget(opts) {
+	return {
+		timeoutMs: opts.timeoutMs ?? 1e4,
+		retries: opts.retries ?? 0
+	};
+}
+function serverInfoFromProperties(properties) {
+	const { tag } = properties.version;
+	return {
+		version: parseTag(tag),
+		edition: editionFromTag(tag),
+		date: properties.version.date ?? null,
+		hash: properties.version.hash ?? null,
+		tokenFeatures: properties["token-features"] ?? null
+	};
+}
+function profileFromProperties(properties) {
+	return createServerProfile(serverInfoFromProperties(properties));
+}
+//#endregion
+export { PROBE_PATH, PROBE_TIMEOUT_MS, probeBudget, probeServer, profileFromProperties, serverInfoFromProperties };

package/dist/version/profile.d.ts

@@ -0,0 +1,2 @@
+import { St as featureGap, bt as Skew, xt as createServerProfile, yt as ServerProfile } from "../transport-E0ZaPNWJ.js";
+export { ServerProfile, Skew, createServerProfile, featureGap };

package/dist/version/profile.js

@@ -0,0 +1,64 @@
+import { TokenFeatures } from "../domain/session-properties.js";
+import { KNOWN_RANGE } from "./known-range.js";
+import { FEATURE_RULES, Features, evaluateFeatures, ruleGap } from "./features.js";
+import { Edition, ServerVersion } from "./tag.js";
+import { z } from "zod";
+//#region src/version/profile.ts
+const Skew = z.enum([
+	"supported",
+	"older-than-known",
+	"newer-than-known",
+	"development"
+]);
+const ServerProfile = z.object({
+	version: ServerVersion,
+	buildDate: z.string().nullable(),
+	hash: z.string().nullable(),
+	edition: Edition,
+	tokenFeatures: TokenFeatures.nullable(),
+	features: Features,
+	skew: Skew
+});
+function createServerProfile(info) {
+	const placement = place(info.version);
+	return {
+		version: info.version,
+		buildDate: info.date,
+		hash: info.hash,
+		edition: detectEdition(info),
+		tokenFeatures: info.tokenFeatures,
+		features: evaluateFeatures(placement.major, info.tokenFeatures),
+		skew: placement.skew
+	};
+}
+function featureGap(profile, feature) {
+	const placement = place(profile.version);
+	return ruleGap(FEATURE_RULES[feature], placement.major, profile.tokenFeatures);
+}
+function place(version) {
+	if (version.kind === "development") return {
+		major: "development",
+		skew: "development"
+	};
+	if (version.major > KNOWN_RANGE.max) return {
+		major: KNOWN_RANGE.max + 1,
+		skew: "newer-than-known"
+	};
+	if (version.major < KNOWN_RANGE.min) return {
+		major: version.major,
+		skew: "older-than-known"
+	};
+	return {
+		major: version.major,
+		skew: "supported"
+	};
+}
+function detectEdition(info) {
+	if (info.edition !== null) return info.edition;
+	return grantsAnyFeature(info.tokenFeatures) ? "ee" : "oss";
+}
+function grantsAnyFeature(tokenFeatures) {
+	return tokenFeatures !== null && Object.values(tokenFeatures).some((enabled) => enabled);
+}
+//#endregion
+export { ServerProfile, Skew, createServerProfile, featureGap };

package/dist/version/requirement-check.d.ts

@@ -0,0 +1,2 @@
+import { n as featureFailures, r as supersedingFeature, t as checkFeatures } from "../requirement-check-CIA5IHC1.js";
+export { checkFeatures, featureFailures, supersedingFeature };

package/dist/version/requirement-check.js

@@ -0,0 +1,62 @@
+import { FEATURE_RULES } from "./features.js";
+import { missingTokenFeatureMessage, versionTooOldMessage } from "./capability-error.js";
+import { describeVersion } from "./tag.js";
+import { featureGap } from "./profile.js";
+//#region src/version/requirement-check.ts
+/** The first of `features` the profile lacks, or `null` when it has every one. */
+function checkFeatures(features, profile) {
+	for (const feature of features) {
+		const gap = featureGap(profile, feature);
+		if (gap !== null) return describeGap(gap, feature, profile);
+	}
+	return null;
+}
+/**
+* The verdict that the profile has `feature`, which takes the value `detail` describes out of the
+* server's vocabulary, or `null` when the profile lacks it.
+*/
+function supersedingFeature(feature, profile, detail) {
+	if (featureGap(profile, feature) !== null) return null;
+	const rule = FEATURE_RULES[feature];
+	return {
+		reason: "superseded-by-feature",
+		detail,
+		feature,
+		since: rule.since,
+		tokenFeature: rule.tokenFeature ?? null,
+		serverVersion: profile.version.tag
+	};
+}
+/**
+* Every one of `features` the profile lacks, each once and in the order given, so a caller that
+* goes on past the first still hears of the rest.
+*/
+function featureFailures(features, profile) {
+	return [...new Set(features)].flatMap((feature) => {
+		const failure = checkFeatures([feature], profile);
+		return failure === null ? [] : [failure];
+	});
+}
+function describeGap(gap, feature, profile) {
+	const rule = FEATURE_RULES[feature];
+	const serverVersion = profile.version.tag;
+	const tokenFeature = rule.tokenFeature ?? null;
+	if (gap.kind === "token") return {
+		reason: "missing-token-feature",
+		detail: missingTokenFeatureMessage(gap.tokenFeature),
+		feature,
+		since: rule.since,
+		tokenFeature,
+		serverVersion
+	};
+	return {
+		reason: "version-too-old",
+		detail: versionTooOldMessage(rule.since, describeVersion(profile.version)),
+		feature,
+		since: rule.since,
+		tokenFeature,
+		serverVersion
+	};
+}
+//#endregion
+export { checkFeatures, featureFailures, supersedingFeature };

package/dist/version/requirements.d.ts

@@ -0,0 +1,2 @@
+import { a as methodRequirements, i as isMethodKey, n as METHOD_REQUIREMENTS, r as MethodKey, t as METHOD_KEYS } from "../requirements-C0txASN8.js";
+export { METHOD_KEYS, METHOD_REQUIREMENTS, MethodKey, isMethodKey, methodRequirements };

package/dist/version/requirements.js

@@ -0,0 +1,219 @@
+//#region src/version/requirements.ts
+const METHOD_REQUIREMENTS = {
+	"card.list": [],
+	"card.get": [],
+	"card.create": [],
+	"card.update": [],
+	"card.archive": [],
+	"card.query": [],
+	"card.exportQuery": [],
+	"card.queryMetadata": [],
+	"collection.list": [],
+	"collection.get": [],
+	"collection.create": [],
+	"collection.update": [],
+	"collection.archive": [],
+	"collection.itemPages": [],
+	"collection.tree": [],
+	"contentTranslation.download": ["contentTranslation"],
+	"contentTranslation.upload": ["contentTranslation"],
+	"dashboard.list": [],
+	"dashboard.get": [],
+	"dashboard.create": [],
+	"dashboard.update": [],
+	"dashboard.archive": [],
+	"dashboard.copy": [],
+	"dashboard.updateDashcard": [],
+	"dashboard.checkCardReferences": [],
+	"dashboard.parameterValues": [],
+	"dashboard.searchParameterValues": [],
+	"dataAction.list": [],
+	"dataAction.get": [],
+	"dataAction.create": ["dataActionsWithoutModel"],
+	"dataAction.update": [],
+	"dataAction.archive": [],
+	"dataAction.delete": [],
+	"dataAction.execute": [],
+	"database.list": [],
+	"database.get": [],
+	"database.update": [],
+	"database.schemas": [],
+	"database.schemaTables": [],
+	"database.syncSchema": [],
+	"database.rescanValues": [],
+	"dataset.query": [],
+	"dataset.native": [],
+	"dataset.queryMetadata": [],
+	"dataset.exportQuery": [],
+	"dependency.breakingPages": ["dependencyItemListings"],
+	"dependency.broken": ["dependencyItemListings"],
+	"dependency.dependents": ["dependencyItemListings"],
+	"dependency.graph": ["dependencyGraph"],
+	"dependency.unreferencedPages": ["dependencyItemListings"],
+	"document.list": [],
+	"document.get": [],
+	"document.create": [],
+	"document.update": [],
+	"document.archive": [],
+	"document.copy": ["documentCopy"],
+	"eidTranslation.translate": [],
+	"erd.get": ["erd"],
+	"field.get": [],
+	"field.update": [],
+	"field.setDataSensitivity": ["fieldDataSensitivity"],
+	"field.search": [],
+	"field.remapping": [],
+	"field.summary": [],
+	"field.values": [],
+	"gitSync.currentTask": ["remoteSync"],
+	"gitSync.cancelTask": ["remoteSync"],
+	"gitSync.isDirty": ["remoteSync"],
+	"gitSync.dirty": ["remoteSync"],
+	"gitSync.hasRemoteChanges": ["remoteSyncRemoteChanges"],
+	"gitSync.import": ["remoteSync"],
+	"gitSync.export": ["remoteSync"],
+	"gitSync.exportPreflight": ["remoteSyncExportPreflight"],
+	"gitSync.stash": ["remoteSync"],
+	"gitSync.branches": ["remoteSync"],
+	"gitSync.createBranch": ["remoteSync"],
+	"gitSync.setCollectionSynced": ["remoteSync"],
+	"gitSync.syncedCollections": ["remoteSync"],
+	"gitSync.remoteUrl": [],
+	"gitSync.branch": ["remoteSync"],
+	"gitSync.remote": ["remoteSync"],
+	"gitSync.trackedBranch": ["remoteSync"],
+	"gitSync.waitForTask": ["remoteSync"],
+	"glossary.list": [],
+	"glossary.create": [],
+	"glossary.update": [],
+	"glossary.delete": [],
+	"library.get": ["library"],
+	"library.create": ["library"],
+	"library.ensureDataCollectionId": ["library"],
+	"library.publishTables": ["library"],
+	"library.unpublishTables": ["library"],
+	"metric.query": ["metricDefinitionQuery"],
+	"metric.breakoutValues": ["metricDefinitionQuery"],
+	"metric.dimensions": ["metricDimensionListing"],
+	"measure.list": ["measures"],
+	"measure.get": ["measures"],
+	"measure.create": ["measures"],
+	"measure.update": ["measures"],
+	"measure.archive": ["measures"],
+	"moderationReview.create": ["contentVerification"],
+	"notification.list": [],
+	"notification.get": [],
+	"notification.create": [],
+	"notification.update": [],
+	"notification.archive": [],
+	"notification.send": [],
+	"permission.graph": [],
+	"permission.databaseGraph": [],
+	"permission.groupGraph": [],
+	"pulse.list": [],
+	"pulse.get": [],
+	"pulse.create": [],
+	"pulse.update": [],
+	"pulse.archive": [],
+	"replacement.checkReplaceSource": ["sourceReplacement"],
+	"replacement.replaceSource": ["sourceReplacement"],
+	"replacement.replaceModelWithTransform": ["sourceReplacement"],
+	"replacement.listRuns": ["sourceReplacement"],
+	"replacement.getRun": ["sourceReplacement"],
+	"replacement.cancelRun": ["sourceReplacement"],
+	"revision.list": [],
+	"revision.revert": [],
+	"search.query": [],
+	"segment.list": [],
+	"segment.get": [],
+	"segment.create": [],
+	"segment.update": [],
+	"segment.archive": [],
+	"setting.list": [],
+	"setting.get": [],
+	"setting.set": [],
+	"setup.create": [],
+	"snippet.list": [],
+	"snippet.get": [],
+	"snippet.create": [],
+	"snippet.update": [],
+	"snippet.archive": [],
+	"table.list": [],
+	"table.get": [],
+	"table.update": [],
+	"table.queryMetadata": [],
+	"table.fks": [],
+	"table.syncSchema": [],
+	"table.rescanValues": [],
+	"table.discardValues": [],
+	"table.bulkEdit": ["bulkTableEdit"],
+	"table.bulkSyncSchema": ["bulkTableSync"],
+	"table.bulkRescanValues": ["bulkTableSync"],
+	"table.bulkDiscardValues": ["bulkTableSync"],
+	"table.appendCsv": [],
+	"table.replaceCsv": [],
+	"timeline.list": [],
+	"timeline.get": [],
+	"timeline.events": [],
+	"timeline.create": [],
+	"timeline.update": [],
+	"timeline.archive": [],
+	"timeline.delete": [],
+	"timelineEvent.get": [],
+	"timelineEvent.create": [],
+	"timelineEvent.update": [],
+	"timelineEvent.archive": [],
+	"timelineEvent.delete": [],
+	"transform.list": ["transforms"],
+	"transform.get": ["transforms"],
+	"transform.create": ["transforms"],
+	"transform.update": ["transforms"],
+	"transform.delete": ["transforms"],
+	"transform.deleteTable": ["transforms"],
+	"transform.dependencies": ["transforms"],
+	"transform.cancel": ["transforms"],
+	"transform.getRun": ["transforms"],
+	"transform.runPages": ["transforms"],
+	"transform.runSummaryPages": ["unifiedTransformRuns", "transforms"],
+	"transform.resetCheckpoint": ["transformCheckpointReset", "transforms"],
+	"transform.runDag": ["transformDagRuns", "transforms"],
+	"transform.dagTransforms": ["transformDagRuns", "transforms"],
+	"transform.run": ["transforms"],
+	"transformDagRun.transformRuns": ["transformDagRuns", "transforms"],
+	"transformDagRun.cancel": ["transformDagRuns", "transforms"],
+	"transformInspector.discover": ["transformInspector"],
+	"transformInspector.lens": ["transformInspector"],
+	"transformInspector.query": ["transformInspector"],
+	"transformJob.list": ["transforms"],
+	"transformJob.get": ["transforms"],
+	"transformJob.create": ["transforms"],
+	"transformJob.update": ["transforms"],
+	"transformJob.delete": ["transforms"],
+	"transformJob.run": ["transforms"],
+	"transformJob.transforms": ["transforms"],
+	"transformJob.setActive": ["transformJobActivation", "transforms"],
+	"transformPython.getLibrary": ["pythonLibrary"],
+	"transformPython.updateLibrary": ["pythonLibrary"],
+	"transformPython.testRun": ["pythonTestRun"],
+	"transformTag.list": ["transforms"],
+	"transformTag.create": ["transforms"],
+	"transformTag.update": ["transforms"],
+	"transformTag.delete": ["transforms"],
+	"transformTest.list": ["transformTests"],
+	"transformTest.get": ["transformTests"],
+	"transformTest.create": ["transformTests"],
+	"transformTest.update": ["transformTests"],
+	"transformTest.delete": ["transformTests"],
+	"transformTest.run": ["transformTests"],
+	"upload.createFromCsv": [],
+	"user.current": []
+};
+function isMethodKey(key) {
+	return Object.hasOwn(METHOD_REQUIREMENTS, key);
+}
+const METHOD_KEYS = Object.keys(METHOD_REQUIREMENTS).filter(isMethodKey);
+function methodRequirements(key) {
+	return METHOD_REQUIREMENTS[key];
+}
+//#endregion
+export { METHOD_KEYS, METHOD_REQUIREMENTS, isMethodKey, methodRequirements };

package/dist/version/tag.d.ts

@@ -0,0 +1,2 @@
+import { a as StoredServerVersion, c as parseTag, i as ServerVersion, n as Edition, o as describeVersion, r as ReleaseVersion, s as editionFromTag, t as DevelopmentBuild } from "../tag-qzjGGci8.js";
+export { DevelopmentBuild, Edition, ReleaseVersion, ServerVersion, StoredServerVersion, describeVersion, editionFromTag, parseTag };

package/dist/version/tag.js

@@ -0,0 +1,52 @@
+import { z } from "zod";
+//#region src/version/tag.ts
+const ReleaseVersion = z.object({
+	kind: z.literal("release"),
+	tag: z.string(),
+	major: z.number().int().nonnegative(),
+	patch: z.number().int().nonnegative()
+});
+const DevelopmentBuild = z.object({
+	kind: z.literal("development"),
+	tag: z.string()
+});
+const ServerVersion = z.discriminatedUnion("kind", [ReleaseVersion, DevelopmentBuild]);
+const Edition = z.enum(["oss", "ee"]);
+const TAG = /^v?([01])\.(\d+)\.(\d+)(?:\.\d+)?(?:-([0-9A-Za-z.-]+))?$/;
+const OSS_EDITION_NUMBER = "0";
+const DEV_BUILD_SUFFIX = "SNAPSHOT";
+function tagParts(tag) {
+	const match = TAG.exec(tag);
+	if (match === null) return null;
+	const [, editionNumber, major, patch, prerelease] = match;
+	if (editionNumber === void 0 || major === void 0 || patch === void 0) return null;
+	return {
+		edition: editionNumber === OSS_EDITION_NUMBER ? "oss" : "ee",
+		major: Number(major),
+		patch: Number(patch),
+		prerelease: prerelease ?? null
+	};
+}
+function parseTag(tag) {
+	const parts = tagParts(tag);
+	if (parts === null || parts.prerelease === DEV_BUILD_SUFFIX) return {
+		kind: "development",
+		tag
+	};
+	return {
+		kind: "release",
+		tag,
+		major: parts.major,
+		patch: parts.patch
+	};
+}
+function editionFromTag(tag) {
+	const parts = tagParts(tag);
+	return parts === null ? null : parts.edition;
+}
+function describeVersion(version) {
+	return version.kind === "release" ? version.tag : `development build ${version.tag}`;
+}
+const StoredServerVersion = z.object({ tag: z.string() }).loose().transform(({ tag }) => parseTag(tag));
+//#endregion
+export { DevelopmentBuild, Edition, ReleaseVersion, ServerVersion, StoredServerVersion, describeVersion, editionFromTag, parseTag };

package/package.json

@@ -1,6 +1,67 @@
 {
   "name": "@metabase/client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Metabase API client",
+  "license": "AGPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/metabase/mb-cli.git",
+    "directory": "packages/client"
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./client": "./dist/client.js",
+    "./errors": "./dist/errors.js",
+    "./json": "./dist/json.js",
+    "./json-pointer": "./dist/json-pointer.js",
+    "./list": "./dist/list.js",
+    "./paginate": "./dist/paginate.js",
+    "./poll": "./dist/poll.js",
+    "./predicates": "./dist/predicates.js",
+    "./signal": "./dist/signal.js",
+    "./url": "./dist/url.js",
+    "./auth/credential": "./dist/auth/credential.js",
+    "./auth/oauth-login": "./dist/auth/oauth-login.js",
+    "./auth/oauth-session": "./dist/auth/oauth-session.js",
+    "./http/errors": "./dist/http/errors.js",
+    "./http/oauth": "./dist/http/oauth.js",
+    "./http/retry": "./dist/http/retry.js",
+    "./http/transport": "./dist/http/transport.js",
+    "./version/features": "./dist/version/features.js",
+    "./version/known-range": "./dist/version/known-range.js",
+    "./version/profile": "./dist/version/profile.js",
+    "./version/capability-error": "./dist/version/capability-error.js",
+    "./version/probe": "./dist/version/probe.js",
+    "./version/requirement-check": "./dist/version/requirement-check.js",
+    "./version/requirements": "./dist/version/requirements.js",
+    "./version/tag": "./dist/version/tag.js",
+    "./domain/*.test": null,
+    "./domain/*": "./dist/domain/*.js",
+    "./resources/*.test": null,
+    "./resources/*": "./dist/resources/*.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown",
+    "prepublishOnly": "tsdown && publint"
+  },
+  "peerDependencies": {
+    "zod": "^4.0.0"
+  },
+  "engines": {
+    "node": ">=20.3"
+  }
+}