@metabase/client 0.1.2 → 0.1.3

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 Notable changes to `@metabase/client`.
 
+## 0.1.3
+
+- `dataAction.create` creates an implicit action on a table as well as a query action. `DataActionCreateInput` is a union on `type`: a `"query"` body takes `dataset_query`, an `"implicit"` one takes `kind` (`ImplicitActionKind`, on the barrel) and `table_id`. Neither takes `database_id`, which the server derives from the query.
+- `DataActionUpdateInput` patches a query action's `dataset_query` or an implicit action's `kind` and `table_id`, never both, and takes no `database_id`. `dataAction.update` refuses a `table_id` before the request on a server without `dataActionsWithoutModel`, which would drop it unread; `DATA_ACTION_TABLE_GATE` records the gate.
+- `DataAction` and `DataActionCompact` read an implicit action's `kind` and `table_id`.
+- `DataActionExecuteResult` reads an implicit action's `rows-updated`, `rows-deleted` or `created-row`, and `rows-affected` is optional.
+
 ## 0.1.2
 
 - `oauthLogin` takes an optional `signal`. Aborting it, before or during the flow, rejects with the signal's reason when that is a `MetabaseError`, else with an `AbortError` carrying its message, frees the loopback callback port at once, and cancels discovery, client registration or the token exchange in flight. `tryDiscoverMetadata`, `discoverLoginMetadata`, `registerClient` and `exchangeCode` on `@metabase/client/http/oauth` take a signal too, and `@metabase/client/signal` exports `whenAborted`.

package/README.md

@@ -437,7 +437,7 @@ Unless the caller passes `metadata` from `tryDiscoverMetadata`, which makes the
 
 `METHOD_REQUIREMENTS` names, per client method (`"transform.get"`, `"gitSync.branches"` — the `MethodKey` as the method is reached on the client), the features it needs, strictest first; `methodRequirements(key)` reads one entry, `METHOD_KEYS` lists the keys, and `isMethodKey` narrows a string to one. When a gated method's request fails the way a server rejects what it lacks (a 402 premium refusal, an unrouted 404, or a 400 on a value outside an older enum or a body an older route reads in another shape), the client probes the server and throws a `CapabilityError` when that profile lacks a feature the method needs — a version gate reads `This operation requires Metabase v59+ (this server is v0.58.0). Upgrade Metabase to use it.`, a token gate `This operation requires the 'remote_sync' premium feature (not enabled on this server).` — and the error's `developerDetail` is a `RequirementFailure` carrying `reason`, `detail`, `feature`, `since`, `tokenFeature` and `serverVersion` — a Zod schema as well as a type (with `RequirementReason` for its `reason` enum), so a consumer that reports the refusal in its own output can describe it. A server that turns out to have every feature failed for another reason, and its own error stands. A 400 is also an ordinary validation failure, so it stands as the server's own `HttpError` when its field errors (`fieldErrors`, `specificFieldErrors`) name a field the missing parameter feature does not gate: a `mb.table.update` carrying a tier-named `data_layer` to a server that speaks medallions, alongside another field that server rejects, throws that field's rejection rather than the tier floor. A 400 that names no field, or one from a server lacking a feature the method itself needs, is the refusal. A method that needs nothing never consults the server; a newer release or a development build is placed past the newest known major, so only a token can explain a refusal there. `checkFeatures(features, profile)` is the check itself, over any feature list (`methodRequirements(key)` gives a method's), answering the first feature the profile lacks, and `featureFailures(features, profile)` answers every one, `featureGap(profile, feature)` says which half of a rule the profile fails (`FeatureGap`: `{ kind: "version" }` or `{ kind: "token", tokenFeature }`), and `ruleGap` is the same question asked of a bare rule. `featureAvailability(feature)` says which servers hold a feature, from its rule: `v64+`, or `token dashboard_subscription_filters` when every supported server meets the version floor. A consumer that describes what a server can do — gating a test lane, or filtering prose by the server it targets — reads the same check.
 
-Some input fields take a value only some servers accept. `@metabase/client/version/input-gates` records each such field on the input schema that holds it, in a registry of the client's own rather than Zod's global one. `inputGatesOf(schema)` answers the `InputGate` entries recorded on a property node, or `null` when every server takes all its values. A gate names a `feature`, an `effect` (`"needs"`: the server must hold the feature; `"supersededBy"`: a server holding it reads the value as something else; `"droppedBy"`: a server holding it drops the value unread), and the `when` that triggers it (`GateTrigger`: the field `present`, one of `values`, or a `nonEmpty` array). `gateTriggered(gate, value)` says whether a value passed for the field triggers the gate. A `droppedBy` gate is a note and nothing enforces it: `TABLE_FROM_DEFINITION_GATE` on `table_id` of `MeasureCreateInput` and `SegmentCreateInput`, which a server holding `tableFromDefinition` drops, and every server is sent because one without the feature requires it. The domain modules export every other gate as a const the resource enforces it by: `DATA_SENSITIVITY_GATE` on `FieldUpdateInput.data_sensitivity`, `DATA_LAYER_TIER_GATE` and `DATA_LAYER_MEDALLION_GATE` on `TableUpdateInput.data_layer`, `DATA_AUTHORITY_WITHDRAWAL_GATE` on `data_authority` of `TableUpdateInput` and `TableBulkEditInput`, `DATA_ACTION_COLLECTION_GATE` on `DataActionUpdateInput.collection_id`, `SUBSCRIPTION_FILTERS_GATE` on `parameters` of `PulseCreateInput` and `PulseUpdateInput`, and `REVISION_ENTITY_GATES` (`measure`, `transform`, `transform-test`) on `RevisionRevertInput.entity`. A server lacking the feature is refused or explained the way its method's own requirement is.
+Some input fields take a value only some servers accept. `@metabase/client/version/input-gates` records each such field on the input schema that holds it, in a registry of the client's own rather than Zod's global one. `inputGatesOf(schema)` answers the `InputGate` entries recorded on a property node, or `null` when every server takes all its values. A gate names a `feature`, an `effect` (`"needs"`: the server must hold the feature; `"supersededBy"`: a server holding it reads the value as something else; `"droppedBy"`: a server holding it drops the value unread), and the `when` that triggers it (`GateTrigger`: the field `present`, one of `values`, or a `nonEmpty` array). `gateTriggered(gate, value)` says whether a value passed for the field triggers the gate. A `droppedBy` gate is a note and nothing enforces it: `TABLE_FROM_DEFINITION_GATE` on `table_id` of `MeasureCreateInput` and `SegmentCreateInput`, which a server holding `tableFromDefinition` drops, and every server is sent because one without the feature requires it. The domain modules export every other gate as a const the resource enforces it by: `DATA_SENSITIVITY_GATE` on `FieldUpdateInput.data_sensitivity`, `DATA_LAYER_TIER_GATE` and `DATA_LAYER_MEDALLION_GATE` on `TableUpdateInput.data_layer`, `DATA_AUTHORITY_WITHDRAWAL_GATE` on `data_authority` of `TableUpdateInput` and `TableBulkEditInput`, `DATA_ACTION_COLLECTION_GATE` on `DataActionUpdateInput.collection_id`, `DATA_ACTION_TABLE_GATE` on `DataActionUpdateInput.table_id`, `SUBSCRIPTION_FILTERS_GATE` on `parameters` of `PulseCreateInput` and `PulseUpdateInput`, and `REVISION_ENTITY_GATES` (`measure`, `transform`, `transform-test`) on `RevisionRevertInput.entity`. A server lacking the feature is refused or explained the way its method's own requirement is.
 
 A resource whose wire shape differs between generations exports from its `@metabase/client/domain/<r>` module, beside the canonical schema, a reader that picks the exact schema for a `Features` and converts forward: `transformDetailSchema(features)` and `transformRowSchema(features)` read a `Transform` (the older generations' hydrated `table` on the detail endpoint, and no link on the rest, become `target_table_id`, and a Python source's `source-tables` keyed by alias becomes the list of `TransformSourceTableEntry`, whose `database_id`, `schema` and `table` are `null` for a table named by id alone; `transform.create`, `transform.update` and `transformPython.testRun` send the list back keyed by alias to such a server, `transformSourceBody(source, features)` and `pythonTestRunBody(params, features)` being the writers), `fieldDetailSchema(features)` reads a `FieldDetail`, which is a `FieldWithDataSensitivity` (its `data_sensitivity` `null` for an unlabelled field) on a generation with the label and a plain `Field` without the key elsewhere, told apart by `hasDataSensitivity`, `fieldRemappedValueSchema(features, sameField)` reads a `FieldRemappedValue` from the first cells of a row a generation pads with display columns, `transformJobSchema(features)` reads a `TransformJob` whose `active` is `null` on a generation that cannot switch jobs off, `transformJobRunResultSchema(features)` reads a `TransformJobRunResult` (`{ message, started, run_id }` — a stub id is `started: null, run_id: null`, the request accepted and the outcome unsaid; a numeric or null id is `started: id !== null, run_id: id`), and `libraryWireSchema(features)` with `toLibrary(wire, listing)` reads a `Library` whose `LibraryChild` entries carry `type` from the wire where the generation sends it and `is_remote_synced` from the collection listing on every generation (`LibraryCollectionInfo`, `LibraryListing`). Each `null` in a canonical field means "this server cannot say". `ResponseShapeError.developerDetail.serverSkew` carries the profile's `skew`, and a `newer-than-known` server is named as such in the message's lead line.
 

package/dist/{card-CrSywvOt.d.ts → card-BBLDmhtp.d.ts}

@@ -1,18 +1,18 @@
 import { z } from "zod";
 //#region src/domain/card.d.ts
 declare const CardType: z.ZodEnum<{
-  question: "question";
-  model: "model";
   metric: "metric";
+  model: "model";
+  question: "question";
 }>;
 type CardType = z.infer<typeof CardType>;
 declare const CardListFilter: z.ZodEnum<{
+  database: "database";
+  table: "table";
   archived: "archived";
   all: "all";
   mine: "mine";
   bookmarked: "bookmarked";
-  database: "database";
-  table: "table";
   using_model: "using_model";
   using_segment: "using_segment";
 }>;
@@ -278,16 +278,16 @@ declare const Card: z.ZodObject<{
   id: z.ZodNumber;
   name: z.ZodString;
   type: z.ZodEnum<{
-    question: "question";
-    model: "model";
     metric: "metric";
+    model: "model";
+    question: "question";
   }>;
   display: z.ZodString;
   description: z.ZodNullable<z.ZodString>;
   archived: z.ZodBoolean;
   query_type: z.ZodNullable<z.ZodEnum<{
-    native: "native";
     query: "query";
+    native: "native";
   }>>;
   database_id: z.ZodNullable<z.ZodNumber>;
   table_id: z.ZodNullable<z.ZodNumber>;
@@ -320,16 +320,16 @@ declare const CardDetail: z.ZodObject<{
   id: z.ZodNumber;
   name: z.ZodString;
   type: z.ZodEnum<{
-    question: "question";
-    model: "model";
     metric: "metric";
+    model: "model";
+    question: "question";
   }>;
   display: z.ZodString;
   description: z.ZodNullable<z.ZodString>;
   archived: z.ZodBoolean;
   query_type: z.ZodNullable<z.ZodEnum<{
-    native: "native";
     query: "query";
+    native: "native";
   }>>;
   database_id: z.ZodNullable<z.ZodNumber>;
   table_id: z.ZodNullable<z.ZodNumber>;
@@ -364,6 +364,7 @@ declare const CardDetail: z.ZodObject<{
       id: "id";
       date: "date";
       text: "text";
+      "temporal-unit": "temporal-unit";
       "date/single": "date/single";
       category: "category";
       "location/city": "location/city";
@@ -375,7 +376,6 @@ declare const CardDetail: z.ZodObject<{
       "date/quarter-year": "date/quarter-year";
       "date/relative": "date/relative";
       "date/all-options": "date/all-options";
-      "temporal-unit": "temporal-unit";
       "number/!=": "number/!=";
       "number/<=": "number/<=";
       "number/=": "number/=";
@@ -698,26 +698,26 @@ declare const CardDetail: z.ZodObject<{
 type CardDetail = z.infer<typeof CardDetail>;
 declare const CardCompact: z.ZodObject<{
   type: z.ZodEnum<{
-    question: "question";
-    model: "model";
     metric: "metric";
+    model: "model";
+    question: "question";
   }>;
   id: z.ZodNumber;
   name: z.ZodString;
   description: z.ZodNullable<z.ZodString>;
   archived: z.ZodBoolean;
+  collection_id: z.ZodNullable<z.ZodNumber>;
   display: z.ZodString;
   database_id: z.ZodNullable<z.ZodNumber>;
-  collection_id: z.ZodNullable<z.ZodNumber>;
   dashboard_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
 type CardCompact = z.infer<typeof CardCompact>;
 declare const CardCreateInput: z.ZodObject<{
   name: z.ZodString;
   type: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-    question: "question";
-    model: "model";
     metric: "metric";
+    model: "model";
+    question: "question";
   }>>>;
   dataset_query: z.ZodObject<{}, z.core.$loose>;
   display: z.ZodString;
@@ -737,6 +737,7 @@ declare const CardCreateInput: z.ZodObject<{
       id: "id";
       date: "date";
       text: "text";
+      "temporal-unit": "temporal-unit";
       "date/single": "date/single";
       category: "category";
       "location/city": "location/city";
@@ -748,7 +749,6 @@ declare const CardCreateInput: z.ZodObject<{
       "date/quarter-year": "date/quarter-year";
       "date/relative": "date/relative";
       "date/all-options": "date/all-options";
-      "temporal-unit": "temporal-unit";
       "number/!=": "number/!=";
       "number/<=": "number/<=";
       "number/=": "number/=";
@@ -826,9 +826,9 @@ type CardCreateInput = z.infer<typeof CardCreateInput>;
 declare const CardUpdateInput: z.ZodObject<{
   name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
   type: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-    question: "question";
-    model: "model";
     metric: "metric";
+    model: "model";
+    question: "question";
   }>>>;
   dataset_query: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
   display: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -838,8 +838,8 @@ declare const CardUpdateInput: z.ZodObject<{
   enable_embedding: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
   embedding_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
   embedding_params: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodEnum<{
-    disabled: "disabled";
     enabled: "enabled";
+    disabled: "disabled";
     locked: "locked";
   }>>>>;
   collection_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -856,6 +856,7 @@ declare const CardUpdateInput: z.ZodObject<{
       id: "id";
       date: "date";
       text: "text";
+      "temporal-unit": "temporal-unit";
       "date/single": "date/single";
       category: "category";
       "location/city": "location/city";
@@ -867,7 +868,6 @@ declare const CardUpdateInput: z.ZodObject<{
       "date/quarter-year": "date/quarter-year";
       "date/relative": "date/relative";
       "date/all-options": "date/all-options";
-      "temporal-unit": "temporal-unit";
       "number/!=": "number/!=";
       "number/<=": "number/<=";
       "number/=": "number/=";
@@ -1213,10 +1213,10 @@ declare const CardQueryResult: z.ZodObject<{
 type CardQueryResult = z.infer<typeof CardQueryResult>;
 declare const CardQueryResultCompact: z.ZodObject<{
   error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  error_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
   status: z.ZodString;
-  row_count: z.ZodOptional<z.ZodNumber>;
   cached: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-  error_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  row_count: z.ZodOptional<z.ZodNumber>;
   data: z.ZodOptional<z.ZodObject<{
     rows: z.ZodArray<z.ZodArray<z.ZodUnknown>>;
     cols: z.ZodArray<z.ZodObject<{

package/dist/{card-CbV6hLYH.d.ts → card-DkHtPMK4.d.ts}

@@ -1,7 +1,7 @@
-import { f as RequestOptions, h as Transport } from "./transport-CS11mEqI.js";
+import { f as RequestOptions, h as Transport } from "./transport-CyHAGDqx.js";
 import { t as ListResult } from "./list-BT_bBm9Z.js";
-import { a as CardListFilter, i as CardDetail, l as CardUpdateInput, o as CardQueryResult, r as CardCreateInput, t as Card } from "./card-CrSywvOt.js";
-import { r as QueryMetadata } from "./dataset-cg8ZZrOP.js";
+import { a as CardListFilter, i as CardDetail, l as CardUpdateInput, o as CardQueryResult, r as CardCreateInput, t as Card } from "./card-BBLDmhtp.js";
+import { r as QueryMetadata } from "./dataset-Du1GRHhd.js";
 import { n as ExportFormat } from "./query-Xsin530u.js";
 //#region src/resources/card.d.ts
 interface CardListParams {