@metabase/client 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Notable changes to `@metabase/client`.
 
+## 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`.
+
 ## 0.1.1
 
 - `DashboardCreateInput` holds only the fields `POST /api/dashboard` reads, so a layout passed to `dashboard.create` fails to compile; send it as a `DashboardLayoutInput` through `dashboard.update`. At run time `dashboard.create` drops any other key before the request, as the server does, and refuses a blank `name`, as the server does.

package/README.md

@@ -255,7 +255,7 @@ A 400 refusing a remote-sync move carries the content behind it: `nonRemoteSynce
 The client registers no signal handler and reads no process state, so cancellation reaches it as an
 `AbortSignal` the host owns. Three places take one and they compose: `ClientOptions.signal` cancels
 every request a client makes, `RequestOptions.signal` cancels a single request, and
-`PollOptions.signal` stops a wait loop. Each is folded together with the request timeout, so whichever
+`PollOptions.signal` stops a wait loop. `OAuthLoginInput.signal` cancels a login, which runs before there is a client (see Auth). Each is folded together with the request timeout, so whichever
 fires first ends the work. A method's first call may also wait on the client's one shared server probe; the method's `signal` ends that caller's wait, while the probe itself belongs to the client and is cancelled only by `ClientOptions.signal`, so a later call still finds it settled.
 
 ```ts
@@ -423,7 +423,9 @@ an `OAuthCredential`. `refreshOAuthCredential` exchanges the rotating refresh to
 revocation endpoint. Types: `Credential` (the `ApiKeyCredential | OAuthCredential` union),
 `OAuthLoginInput`, `OAuthLoginDeps`.
 
-Unless the caller passes `metadata` from `tryDiscoverMetadata`, which makes the same check, `oauthLogin` checks that the server grants the full-access scope the REST API needs: a discovery document that lists it in `scopes_supported` settles it (Metabase v62 from the patch that introduced the scope, and v63), and otherwise the server's version does (`oauthFullAccessScopeUnadvertised`), because v64 and newer grant the scope without advertising it; a server that cannot is refused with a `ConfigError`.
+`OAuthLoginInput.signal` cancels a login at any point: before it starts, during discovery, client registration or the token exchange, or while it waits for the browser's redirect. The request in flight is cancelled, the loopback callback port is freed at once, and the login rejects with the signal's reason when that is a `MetabaseError`, else with an `AbortError` carrying its message.
+
+Unless the caller passes `metadata` from `tryDiscoverMetadata`, which makes the same check, `oauthLogin` checks that the server grants the full-access scope the REST API needs: a discovery document that lists it in `scopes_supported` settles it (Metabase v62 from the patch that introduced the scope, and v63), and otherwise the server's version does (`oauthFullAccessScopeUnadvertised`), because v64 and newer grant the scope without advertising it; a server that cannot is refused with a `ConfigError`. `tryDiscoverMetadata` takes a signal as well.
 
 ### Versions and requirements
 

package/dist/auth/credential.d.ts

@@ -1,2 +1,2 @@
-import { a as Credential, c as OAuthCredential, d as credentialSecrets, f as expiresAtFromNow, i as AuthHeader, l as assertCredentialHeaderSafe, m as oauthCredentialFromTokens, n as AUTHORIZATION_HEADER, o as CredentialRefresher, p as isOAuthExpired, r as ApiKeyCredential, s as DEFAULT_EXPIRES_IN_SECONDS, t as API_KEY_HEADER, u as credentialAuthHeader } from "../credential-6aOEGqMH.js";
+import { a as Credential, c as OAuthCredential, d as credentialSecrets, f as expiresAtFromNow, i as AuthHeader, l as assertCredentialHeaderSafe, m as oauthCredentialFromTokens, n as AUTHORIZATION_HEADER, o as CredentialRefresher, p as isOAuthExpired, r as ApiKeyCredential, s as DEFAULT_EXPIRES_IN_SECONDS, t as API_KEY_HEADER, u as credentialAuthHeader } from "../credential-B6fKSvqp.js";
 export { API_KEY_HEADER, AUTHORIZATION_HEADER, ApiKeyCredential, AuthHeader, Credential, CredentialRefresher, DEFAULT_EXPIRES_IN_SECONDS, OAuthCredential, assertCredentialHeaderSafe, credentialAuthHeader, credentialSecrets, expiresAtFromNow, isOAuthExpired, oauthCredentialFromTokens };

package/dist/auth/oauth-login.d.ts

@@ -1,2 +1,2 @@
-import { n as OAuthLoginInput, r as oauthLogin, t as OAuthLoginDeps } from "../oauth-login-CJsT_3EE.js";
+import { n as OAuthLoginInput, r as oauthLogin, t as OAuthLoginDeps } from "../oauth-login-SZ4Csai8.js";
 export { OAuthLoginDeps, OAuthLoginInput, oauthLogin };

package/dist/auth/oauth-login.js

@@ -1,2 +1,2 @@
-import { t as oauthLogin } from "../oauth-login-D734Jvbq.js";
+import { t as oauthLogin } from "../oauth-login--tDagiZu.js";
 export { oauthLogin };

package/dist/auth/oauth-session.d.ts

@@ -1,2 +1,2 @@
-import { n as revokeOAuthCredential, t as refreshOAuthCredential } from "../oauth-session-BlIlcd8Q.js";
+import { n as revokeOAuthCredential, t as refreshOAuthCredential } from "../oauth-session-COLH4puN.js";
 export { refreshOAuthCredential, revokeOAuthCredential };

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

@@ -1,7 +1,7 @@
-import { f as RequestOptions, h as Transport } from "./transport-BsXqRujn.js";
+import { f as RequestOptions, h as Transport } from "./transport-CS11mEqI.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-BxBzr5Uj.js";
-import { r as QueryMetadata } from "./dataset-BBNGPVec.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 { n as ExportFormat } from "./query-Xsin530u.js";
 //#region src/resources/card.d.ts
 interface CardListParams {

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

@@ -1,18 +1,18 @@
 import { z } from "zod";
 //#region src/domain/card.d.ts
 declare const CardType: z.ZodEnum<{
-  metric: "metric";
-  model: "model";
   question: "question";
+  model: "model";
+  metric: "metric";
 }>;
 type CardType = z.infer<typeof CardType>;
 declare const CardListFilter: z.ZodEnum<{
   archived: "archived";
-  database: "database";
-  table: "table";
   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<{
-    metric: "metric";
-    model: "model";
     question: "question";
+    model: "model";
+    metric: "metric";
   }>;
   display: z.ZodString;
   description: z.ZodNullable<z.ZodString>;
   archived: z.ZodBoolean;
   query_type: z.ZodNullable<z.ZodEnum<{
-    query: "query";
     native: "native";
+    query: "query";
   }>>;
   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<{
-    metric: "metric";
-    model: "model";
     question: "question";
+    model: "model";
+    metric: "metric";
   }>;
   display: z.ZodString;
   description: z.ZodNullable<z.ZodString>;
   archived: z.ZodBoolean;
   query_type: z.ZodNullable<z.ZodEnum<{
-    query: "query";
     native: "native";
+    query: "query";
   }>>;
   database_id: z.ZodNullable<z.ZodNumber>;
   table_id: z.ZodNullable<z.ZodNumber>;
@@ -364,7 +364,6 @@ 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";
@@ -376,6 +375,7 @@ 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<{
-    metric: "metric";
-    model: "model";
     question: "question";
+    model: "model";
+    metric: "metric";
   }>;
   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<{
-    metric: "metric";
-    model: "model";
     question: "question";
+    model: "model";
+    metric: "metric";
   }>>>;
   dataset_query: z.ZodObject<{}, z.core.$loose>;
   display: z.ZodString;
@@ -737,7 +737,6 @@ 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";
@@ -749,6 +748,7 @@ 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<{
-    metric: "metric";
-    model: "model";
     question: "question";
+    model: "model";
+    metric: "metric";
   }>>>;
   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<{
-    enabled: "enabled";
     disabled: "disabled";
+    enabled: "enabled";
     locked: "locked";
   }>>>>;
   collection_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -856,7 +856,6 @@ 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";
@@ -868,6 +867,7 @@ 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;
-  cached: z.ZodOptional<z.ZodNullable<z.ZodString>>;
   row_count: z.ZodOptional<z.ZodNumber>;
+  cached: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  error_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
   data: z.ZodOptional<z.ZodObject<{
     rows: z.ZodArray<z.ZodArray<z.ZodUnknown>>;
     cols: z.ZodArray<z.ZodObject<{