@ethlete/query-devtools 1.0.0-next.1 → 1.0.0-next.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/query-devtools",
-  "version": "1.0.0-next.1",
+  "version": "1.0.0-next.3",
   "license": "MIT",
   "sideEffects": false,
   "peerDependencies": {

package/types/ethlete-query-devtools.d.ts

@@ -1,7 +1,7 @@
 import * as _angular_core from '@angular/core';
 import { Signal, WritableSignal, OnInit } from '@angular/core';
 import * as _ethlete_query from '@ethlete/query';
-import { JsonPath, QueryDevtoolsOverridesRecorder, QueryRefreshCause, QueryRepositoryEntryDestroyedCause, Query, QueryRepositoryCacheEntry, HttpRequestRetryState, HttpRequestLoadingProgressState, QueryDevtoolsStats, QueryDevtoolsStatsHandle, QueryDevtoolsEntry, QueryRepository, QueryClient, QueryKeyLockState, QueryDevtoolsFeature, QueryDevtoolsFault, AnyQueryStack, AnyPagedQueryStack, QuerySequence, AnyBearerAuthProvider, WebSocketDevtoolsHandle, QueryDevtoolsFormHandle, QuerySequenceStatus, AnyQuerySnapshot, QueryDevtoolsRun, QueryDevtoolsRunError, WebSocketDevtoolsMessage, QueryDevtoolsStorageScope } from '@ethlete/query';
+import { JsonPath, QueryDevtoolsOverridesRecorder, QueryRefreshCause, QueryRepositoryEntryDestroyedCause, Query, QueryRepositoryCacheEntry, HttpRequestRetryState, HttpRequestLoadingProgressState, QueryDevtoolsStats, QueryDevtoolsStatsHandle, QueryDevtoolsEntry, AnyQueryBatchItemResult, QueryRepository, QueryClient, QueryKeyLockState, QueryDevtoolsFeature, QueryDevtoolsFault, AnyQueryStack, AnyPagedQueryStack, QuerySequence, AnyQueryBatch, AnyBearerAuthProvider, WebSocketDevtoolsHandle, QueryDevtoolsFormHandle, QuerySequenceStatus, AnyQuerySnapshot, QueryDevtoolsRun, QueryDevtoolsRunError, WebSocketDevtoolsMessage, QueryDevtoolsStorageScope } from '@ethlete/query';
 import { ResizeEdge, DragMoveEvent, ResizeMoveEvent } from '@ethlete/core';
 
 type AboutRow = {
@@ -202,7 +202,7 @@ type QueryDevtoolsSelection = {
  * to count, so the badge/overflow logic would push it behind **More** - it is reached from the header's
  * gear instead.
  */
-type DevtoolsTab = 'queries' | 'stacks' | 'sequences' | 'forms' | 'auth' | 'ws' | 'cache' | 'locks' | 'timeline' | 'events' | 'faults' | 'mocks' | 'about' | 'settings';
+type DevtoolsTab = 'queries' | 'stacks' | 'sequences' | 'batches' | 'forms' | 'auth' | 'ws' | 'cache' | 'locks' | 'timeline' | 'events' | 'faults' | 'mocks' | 'about' | 'settings';
 /**
  * The sections of the query detail drawer. The head and its actions stay pinned above them - the detail
  * holds more than fits a column, and everything below the actions is reading material.
@@ -261,6 +261,20 @@ type QueryLink = {
     clientBaseUrl: string;
     stats?: QueryDevtoolsStatsHandle;
 };
+/** One settled item of a query batch, with the route the args it was sent with resolve to. */
+type BatchItemRow = {
+    result: AnyQueryBatchItemResult;
+    segments: RouteSegment[];
+};
+/**
+ * A batch's settled items as its card lists them. Capped, and `hidden` says by how much - a bulk run
+ * settles more items than a list can hold, and a truncated one must not read as the whole run.
+ */
+type BatchItemView = {
+    rows: BatchItemRow[];
+    total: number;
+    hidden: number;
+};
 /**
  * Query stats plus the numbers the panel derives from them rather than storing: an execution that never
  * reached the network was answered from the cache, and the averages come from the running totals.
@@ -391,6 +405,7 @@ type QueryDevtoolsHost = {
     queryEntries: Signal<QueryDevtoolsEntry[]>;
     stackEntries: Signal<QueryDevtoolsEntry[]>;
     sequenceEntries: Signal<QueryDevtoolsEntry[]>;
+    batchEntries: Signal<QueryDevtoolsEntry[]>;
     formEntries: Signal<QueryDevtoolsEntry[]>;
     authEntries: Signal<QueryDevtoolsEntry[]>;
     wsEntries: Signal<QueryDevtoolsEntry[]>;
@@ -450,6 +465,7 @@ type QueryDevtoolsHost = {
     asStack(entry: QueryDevtoolsEntry): AnyQueryStack;
     asPagedStack(entry: QueryDevtoolsEntry): AnyPagedQueryStack;
     asSequence(entry: QueryDevtoolsEntry): QuerySequence<unknown[]>;
+    asBatch(entry: QueryDevtoolsEntry): AnyQueryBatch;
     asAuth(entry: QueryDevtoolsEntry): AnyBearerAuthProvider;
     asWs(entry: QueryDevtoolsEntry): WebSocketDevtoolsHandle;
     asForm(entry: QueryDevtoolsEntry): QueryDevtoolsFormHandle;
@@ -492,6 +508,30 @@ type QueryDevtoolsHost = {
     /** Whether a sequence step's in/out detail (`<entryId>:<stepIndex>`) is expanded - persisted. */
     isStepExpanded(entryId: string, index: number): boolean;
     toggleStep(entryId: string, index: number): void;
+    /** A batch's route with its path params left as `:name` - a batch fills them in per item, not once. */
+    batchRouteSegments(entry: QueryDevtoolsEntry): RouteSegment[];
+    /**
+     * The batch entry that created a query, or `null` for a query no batch did. What lets the Queries list
+     * fold a bulk run's items under one row instead of listing whatever it has in flight.
+     */
+    batchOf(entry: QueryDevtoolsEntry): QueryDevtoolsEntry | null;
+    /**
+     * The item queries a batch has in flight. Only those: a batch destroys each item's query the moment
+     * that item settles, so a settled item is read from {@link batchItems} instead.
+     */
+    queriesForBatch(entry: QueryDevtoolsEntry): QueryLink[];
+    /** A batch's settled items, failures first and capped - see {@link BatchItemView}. */
+    batchItems(entry: QueryDevtoolsEntry): BatchItemView;
+    /**
+     * The registry entry of one of a batch's items, or `null` once it has fallen out of the batch's capped
+     * tombstone tail - which is what makes an item row openable only while its query is still kept.
+     */
+    batchItemQueryId(entry: QueryDevtoolsEntry, index: number): string | null;
+    /** An item's throughput line (`12.4 items/s · ~8s left`), or `null` before there is a rate to show. */
+    batchThroughput(batch: AnyQueryBatch): string | null;
+    /** Whether a batch item's args/response detail (`<entryId>:<itemIndex>`) is expanded - persisted. */
+    isBatchItemExpanded(entryId: string, index: number): boolean;
+    toggleBatchItem(entryId: string, index: number): void;
     /** Keys of the Queries-list groups of identical rows the user opened - persisted. */
     expandedQueryGroups: Signal<ReadonlySet<string>>;
     toggleQueryGroup(key: string): void;
@@ -632,6 +672,16 @@ type QueryDevtoolsHost = {
         entry: QueryDevtoolsEntry;
         query: AnyQuery;
     } | null>;
+    batchSelectedQueryId: WritableSignal<string | null>;
+    batchSelectedQuery: Signal<{
+        entry: QueryDevtoolsEntry;
+        query: AnyQuery;
+    } | null>;
+    eventSelectedQueryId: WritableSignal<string | null>;
+    eventSelectedQuery: Signal<{
+        entry: QueryDevtoolsEntry;
+        query: AnyQuery;
+    } | null>;
     formSelectedQueryId: WritableSignal<string | null>;
     formSelectedQuery: Signal<{
         entry: QueryDevtoolsEntry;
@@ -785,12 +835,19 @@ type PersistedState = {
     listHeight?: number | null;
     drawerHeight?: number | null;
     dock?: DevtoolsDock;
+    reservesSpace?: boolean;
     floatRect?: FloatRect;
     floatParked?: boolean;
     activeTab?: DevtoolsTab;
     detailTab?: DetailTab;
     selectedClientName?: string | null;
     selectedQueryId?: string | null;
+    stackSelectedQueryId?: string | null;
+    sequenceSelectedQueryId?: string | null;
+    batchSelectedQueryId?: string | null;
+    eventSelectedQueryId?: string | null;
+    formSelectedQueryId?: string | null;
+    timelineSelectedQueryId?: string | null;
     selectedFormId?: string | null;
     inspectFilterIds?: string[] | null;
     queryFilter?: string;
@@ -803,6 +860,7 @@ type PersistedState = {
     socketFilter?: string;
     jsonSearch?: string;
     expandedSteps?: string[];
+    expandedBatchItems?: string[];
     expandedQueryGroups?: string[];
     jsonExpanded?: string[];
     jsonCollapsed?: string[];
@@ -875,6 +933,9 @@ declare class QueryDevtoolsComponent implements OnInit {
     } | {
         id: "sequences";
         label: string;
+    } | {
+        id: "batches";
+        label: string;
     } | {
         id: "forms";
         label: string;
@@ -992,6 +1053,11 @@ declare class QueryDevtoolsComponent implements OnInit {
         readonly label: "Pop out";
         readonly hint: "Move the panel into a window of its own - the same live panel, on your other screen";
     }>;
+    /**
+     * Whether a docked panel takes its size out of the page instead of covering it - so the last rows of a
+     * long page can still be scrolled to. Only docks can: a float sits wherever it was dragged.
+     */
+    protected reservesSpace: WritableSignal<boolean>;
     /** Where the floating panel sits and how big it is. Kept while docked, so a return to float restores it. */
     private floatRect;
     /** The rect a resize gesture started from, or `null` outside one. */
@@ -1029,6 +1095,13 @@ declare class QueryDevtoolsComponent implements OnInit {
     /** The floating panel's offset from the viewport's top-left, or `null` while it is docked. */
     protected panelInsetBlock: _angular_core.Signal<number | null>;
     protected panelInsetInline: _angular_core.Signal<number | null>;
+    /**
+     * The panel's rendered size, not its dragged one - the stylesheet clamps a dock (`min-block-size`,
+     * `max-block-size: 90vh`) and it is the clamped size the page has to give up.
+     */
+    private panelSize;
+    /** Which padding a docked panel asks of the page and how much, or `null` when it asks for none. */
+    private pageReservation;
     /** Which section of the query detail is showing. Shared by the Queries tab and both drawers. */
     detailTab: WritableSignal<DetailTab>;
     selectedClientName: WritableSignal<string | null>;
@@ -1037,6 +1110,8 @@ declare class QueryDevtoolsComponent implements OnInit {
     selectedFormId: WritableSignal<string | null>;
     stackSelectedQueryId: WritableSignal<string | null>;
     sequenceSelectedQueryId: WritableSignal<string | null>;
+    batchSelectedQueryId: WritableSignal<string | null>;
+    eventSelectedQueryId: WritableSignal<string | null>;
     formSelectedQueryId: WritableSignal<string | null>;
     timelineSelectedQueryId: WritableSignal<string | null>;
     /** Free-text narrowing of the Queries list. Every whitespace-separated term has to match. */
@@ -1082,6 +1157,8 @@ declare class QueryDevtoolsComponent implements OnInit {
     private socketEmitError;
     /** Keys (`<entryId>:<stepIndex>`) of the sequence steps whose in/out detail is expanded. */
     private expandedSteps;
+    /** Keys (`<entryId>:<itemIndex>`) of the batch items whose args/response detail is expanded. */
+    private expandedBatchItems;
     /** Keys of the Queries-list groups the user opened - the tab is rebuilt on every switch back. */
     expandedQueryGroups: WritableSignal<ReadonlySet<string>>;
     /** Shared value-explorer search term. */
@@ -1155,6 +1232,7 @@ declare class QueryDevtoolsComponent implements OnInit {
     protected panelTampered: _angular_core.Signal<boolean>;
     stackEntries: _angular_core.Signal<QueryDevtoolsEntry[]>;
     sequenceEntries: _angular_core.Signal<QueryDevtoolsEntry[]>;
+    batchEntries: _angular_core.Signal<QueryDevtoolsEntry[]>;
     formEntries: _angular_core.Signal<QueryDevtoolsEntry[]>;
     authEntries: _angular_core.Signal<QueryDevtoolsEntry[]>;
     wsEntries: _angular_core.Signal<QueryDevtoolsEntry[]>;
@@ -1212,6 +1290,9 @@ declare class QueryDevtoolsComponent implements OnInit {
     } | {
         id: "sequences";
         label: string;
+    } | {
+        id: "batches";
+        label: string;
     } | {
         id: "forms";
         label: string;
@@ -1253,6 +1334,9 @@ declare class QueryDevtoolsComponent implements OnInit {
     } | {
         id: "sequences";
         label: string;
+    } | {
+        id: "batches";
+        label: string;
     } | {
         id: "forms";
         label: string;
@@ -1296,6 +1380,14 @@ declare class QueryDevtoolsComponent implements OnInit {
         entry: QueryDevtoolsEntry;
         query: AnyQuery;
     } | null>;
+    batchSelectedQuery: _angular_core.Signal<{
+        entry: QueryDevtoolsEntry;
+        query: AnyQuery;
+    } | null>;
+    eventSelectedQuery: _angular_core.Signal<{
+        entry: QueryDevtoolsEntry;
+        query: AnyQuery;
+    } | null>;
     formSelectedQuery: _angular_core.Signal<{
         entry: QueryDevtoolsEntry;
         query: AnyQuery;
@@ -1598,6 +1690,7 @@ declare class QueryDevtoolsComponent implements OnInit {
     asStack(entry: QueryDevtoolsEntry): AnyQueryStack;
     asPagedStack(entry: QueryDevtoolsEntry): AnyPagedQueryStack;
     asSequence(entry: QueryDevtoolsEntry): QuerySequence<unknown[]>;
+    asBatch(entry: QueryDevtoolsEntry): AnyQueryBatch;
     asAuth(entry: QueryDevtoolsEntry): AnyBearerAuthProvider;
     asWs(entry: QueryDevtoolsEntry): WebSocketDevtoolsHandle;
     /**
@@ -1662,6 +1755,19 @@ declare class QueryDevtoolsComponent implements OnInit {
     expandQueryGroup(key: string): void;
     isStepExpanded(entryId: string, index: number): boolean;
     toggleStep(entryId: string, index: number): void;
+    /** A batch's route with its path params left as `:name` - a batch fills them in per item, not once. */
+    batchRouteSegments(entry: QueryDevtoolsEntry): RouteSegment[];
+    batchOf(entry: QueryDevtoolsEntry): QueryDevtoolsEntry | null;
+    queriesForBatch(entry: QueryDevtoolsEntry): QueryLink[];
+    /**
+     * The registry entry of one of a batch's items, or `null` once it has fallen out of the batch's capped
+     * tombstone tail - which is what makes an item row openable only while its query is still kept.
+     */
+    batchItemQueryId(entry: QueryDevtoolsEntry, index: number): string | null;
+    batchItems(entry: QueryDevtoolsEntry): BatchItemView;
+    batchThroughput(batch: AnyQueryBatch): string | null;
+    isBatchItemExpanded(entryId: string, index: number): boolean;
+    toggleBatchItem(entryId: string, index: number): void;
     /** Dedents a GraphQL document (template-literal indentation) for readable display. */
     gqlDocument(doc: string): string;
     featureLabel(type: string): string;
@@ -1687,6 +1793,12 @@ declare class QueryDevtoolsComponent implements OnInit {
         content: string;
         type: string;
     }): void;
+    /**
+     * The same route rendered from a set of args rather than from a query, which is what a batch item leaves
+     * behind: the batch destroys its query the moment the item settles.
+     */
+    private argsRouteSegments;
+    private renderRoute;
     /**
      * Takes - or gives back - the lock whose name only this tab can have produced. Its `clientId` in the
      * snapshot is what tells this tab's rows from another tab's: `LockInfo` carries no tab identity, and
@@ -1779,6 +1891,7 @@ declare class QueryDevtoolsComponent implements OnInit {
     private sessionQuery;
     private sessionActivity;
     private sessionSequence;
+    private sessionBatch;
     private sessionForm;
     /**
      * An auth provider without its tokens. A session report is a file that gets attached to a ticket, and
@@ -1830,7 +1943,7 @@ declare class QueryDevtoolsComponent implements OnInit {
 declare const QUERY_DEVTOOLS_IMPORTS: readonly [typeof QueryDevtoolsComponent];
 
 /** The version of `@ethlete/query-devtools` this build was cut from. */
-declare const QUERY_DEVTOOLS_VERSION = "1.0.0-next.1";
+declare const QUERY_DEVTOOLS_VERSION = "1.0.0-next.3";
 
 export { QUERY_DEVTOOLS_IMPORTS, QUERY_DEVTOOLS_VERSION, QueryDevtoolsAboutComponent, QueryDevtoolsComponent, QueryDevtoolsJsonComponent, QueryDevtoolsJsonStylesComponent, QueryDevtoolsSettingsComponent, QueryDevtoolsTimelineStylesComponent, clampFloatToPeek, kindOf, resizedFloatRect, settledFloatRect };
 export type { JsonKind };