@instruments/materialgraph 0.24.0 → 0.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/association-types.d.ts +20 -20
- package/associations-client.d.ts +4 -4
- package/associations-client.js +3 -10
- package/attribution-types.d.ts +3 -3
- package/brand-most-sampled-types.d.ts +4 -4
- package/brand-types.d.ts +6 -6
- package/brands-client.d.ts +4 -4
- package/brands-client.js +9 -13
- package/browse-types.d.ts +8 -8
- package/by-colour-types.d.ts +18 -18
- package/by-spec-types.d.ts +14 -14
- package/catalog-discovery-types.d.ts +14 -14
- package/catalogue-client.d.ts +4 -4
- package/catalogue-client.js +38 -37
- package/catalogue-types.d.ts +4 -4
- package/citation-types.d.ts +4 -4
- package/client-browse.d.ts +4 -4
- package/client-browse.js +24 -25
- package/client-config.d.ts +2 -2
- package/client-exploration.d.ts +3 -3
- package/client-exploration.js +4 -6
- package/client-source-material-comments.d.ts +4 -4
- package/client-source-material-comments.js +4 -38
- package/client-vocabulary.d.ts +8 -8
- package/client-vocabulary.js +20 -30
- package/client.d.ts +11 -45
- package/client.js +143 -188
- package/codes-client.d.ts +2 -2
- package/codes-client.js +8 -8
- package/codes-types.d.ts +34 -34
- package/colour-aggregate-types.d.ts +24 -24
- package/colours-client.d.ts +2 -2
- package/colours-client.js +15 -15
- package/compare-types.d.ts +10 -10
- package/composition-client.d.ts +3 -3
- package/composition-client.js +8 -7
- package/composition-types.d.ts +12 -12
- package/coordinate-client.d.ts +2 -2
- package/coordinate-client.js +1 -13
- package/corpus-scope-types.d.ts +3 -3
- package/corpus-scope-types.js +1 -25
- package/correction-types.d.ts +10 -10
- package/demand-batch-types.d.ts +18 -18
- package/demand-types.d.ts +24 -24
- package/errors.d.ts +12 -12
- package/errors.js +53 -52
- package/exploration-types.d.ts +29 -22
- package/fan-deck-types.d.ts +6 -6
- package/http-transport.d.ts +13 -21
- package/http-transport.js +31 -28
- package/identify-types.d.ts +10 -10
- package/index.d.ts +0 -6
- package/index.js +0 -2
- package/match-rejection-types.d.ts +6 -6
- package/match-stream-types.d.ts +32 -32
- package/match-stream.d.ts +2 -2
- package/match-stream.js +55 -41
- package/match-types.d.ts +8 -8
- package/material-asset-types.d.ts +26 -26
- package/material-block-types.d.ts +6 -6
- package/material-query-plan-types.d.ts +26 -26
- package/material-resources-client.d.ts +5 -5
- package/material-resources-client.js +10 -20
- package/material-types.d.ts +12 -12
- package/ndjson.js +16 -8
- package/operations.d.ts +6 -6
- package/operations.js +9 -39
- package/package.json +2 -2
- package/palette-completion-types.d.ts +22 -22
- package/palette-search-types.d.ts +28 -28
- package/query-understanding-types.d.ts +43 -36
- package/render-assets-types.d.ts +8 -8
- package/resolve-client.d.ts +2 -2
- package/resolve-client.js +4 -6
- package/resolve-colour-types.d.ts +22 -6
- package/resolve-types.d.ts +10 -10
- package/run-types.d.ts +70 -70
- package/runs.d.ts +13 -26
- package/runs.js +77 -89
- package/samplize-catalogue-types.d.ts +18 -18
- package/samplize-colorvec.d.ts +20 -20
- package/samplize-colorvec.js +66 -42
- package/schema-resource-types.d.ts +38 -38
- package/schema-resource-types.js +5 -5
- package/search-card-types.d.ts +14 -5
- package/search-collapse-types.d.ts +4 -4
- package/search-mood-types.d.ts +2 -2
- package/search-refinement-types.d.ts +8 -8
- package/search-request-types.d.ts +6 -6
- package/search-response-receipt-types.d.ts +135 -34
- package/search-response-types.d.ts +2 -2
- package/search-result-validation.d.ts +3 -3
- package/search-result-validation.js +53 -36
- package/search-window-types.d.ts +2 -2
- package/slot-pool-types.d.ts +20 -20
- package/source-material-validation.d.ts +3 -3
- package/source-material-validation.js +35 -39
- package/spec-facet-types.d.ts +10 -10
- package/spec-types.d.ts +6 -6
- package/specifications.d.ts +9 -25
- package/specifications.js +15 -21
- package/sse.d.ts +2 -2
- package/sse.js +32 -16
- package/substitute-types.d.ts +22 -22
- package/suggest-types.d.ts +7 -7
- package/suggest-types.js +3 -3
- package/taxonomy-coverage-types.d.ts +8 -8
- package/types.d.ts +119 -119
- package/validation.d.ts +26 -26
- package/validation.js +97 -92
- package/webmcp.d.ts +2 -2
- package/webmcp.generated.js +94 -87
- package/project-types.d.ts +0 -79
- package/project-types.js +0 -9
- package/projects.d.ts +0 -13
- package/projects.js +0 -46
- package/run-events.d.ts +0 -106
- package/run-events.js +0 -32
- package/schedule-reference-types.d.ts +0 -46
- package/schedule-reference-types.js +0 -1
- package/schedule-references-client.d.ts +0 -14
- package/schedule-references-client.js +0 -26
- package/schedule-types.d.ts +0 -261
- package/schedule-types.js +0 -1
package/client.d.ts
CHANGED
|
@@ -1,36 +1,33 @@
|
|
|
1
|
-
import { CatalogueClient } from "./catalogue-client.js";
|
|
2
|
-
import type { MaterialGraphClientOptions } from "./client-config.js";
|
|
3
|
-
import { type RateLimit } from "./errors.js";
|
|
4
|
-
import { ScheduleReferencesClient } from "./schedule-references-client.js";
|
|
5
|
-
export * from "./client-config.js";
|
|
6
|
-
import { type BrowseNamespace } from "./client-browse.js";
|
|
7
|
-
import { type ExplorationNamespace } from "./client-exploration.js";
|
|
8
|
-
export type { BrowseNamespace } from "./client-browse.js";
|
|
9
|
-
export type { ExplorationNamespace } from "./client-exploration.js";
|
|
10
|
-
import { type SourceMaterialCommentsNamespace } from "./client-source-material-comments.js";
|
|
11
|
-
export type { SourceMaterialCommentsNamespace } from "./client-source-material-comments.js";
|
|
12
1
|
import type { ApplicabilityOptions, AssociatedOptions } from "./association-types.js";
|
|
13
2
|
import type { BrandsOptions } from "./brand-types.js";
|
|
14
3
|
import type { ByColourParams, ByColourResponse } from "./by-colour-types.js";
|
|
4
|
+
import { CatalogueClient } from "./catalogue-client.js";
|
|
15
5
|
import type { ResolvedVerdictCitation } from "./citation-types.js";
|
|
6
|
+
import type { BrowseNamespace } from "./client-browse.js";
|
|
7
|
+
import type { MaterialGraphClientOptions } from "./client-config.js";
|
|
8
|
+
import type { ExplorationNamespace } from "./client-exploration.js";
|
|
9
|
+
import type { SourceMaterialCommentsNamespace } from "./client-source-material-comments.js";
|
|
16
10
|
import { CodesClient } from "./codes-client.js";
|
|
17
11
|
import type { CodeAdvisoryInput, CodeAdvisoryResponse } from "./codes-types.js";
|
|
18
12
|
import { ColoursClient } from "./colours-client.js";
|
|
19
13
|
import type { VarySchemesRequest, VarySchemesResponse } from "./composition-types.js";
|
|
20
|
-
import type {
|
|
14
|
+
import type { RateLimit } from "./errors.js";
|
|
15
|
+
import type { BatchId, RunId, VariantId } from "./identifiers.js";
|
|
21
16
|
import type { MatchStreamEvent } from "./match-stream-types.js";
|
|
22
17
|
import type { MatchInput, MatchResponse } from "./match-types.js";
|
|
23
18
|
import type { MaterialDocumentPageOptions } from "./material-asset-types.js";
|
|
24
19
|
import type { MaterialQueryPlan } from "./material-query-plan-types.js";
|
|
25
|
-
import type { AppendProjectEventRequest, CreateProjectRequest, ProjectEventReceipt, ProjectListResponse, ProjectState } from "./project-types.js";
|
|
26
20
|
import { resolvePhrasesRequest as resolvePhrases } from "./resolve-client.js";
|
|
27
21
|
import type { CapabilityManifestResponse, CreatePublicRunRequest, CreatePublicRunResponse, DrainRunEventsOptions, ListRunsOptions, PublicRunListResponse, PublicRunResponse, ResumeRunOptions, RunEvent, SourceMaterialBatchDetail, SourceMaterialBatchReceipt, StreamRunEventsOptions, UploadSourceMaterialInput } from "./run-types.js";
|
|
28
|
-
import type { FinishScheduleResponse, GetRunScheduleOptions } from "./schedule-types.js";
|
|
29
22
|
import type { SchemaResource, SchemaResourceResponse } from "./schema-resource-types.js";
|
|
30
23
|
import type { SlotPoolsRequest, SlotPoolsResponse } from "./slot-pool-types.js";
|
|
31
24
|
import type { FindSubstitutesOptions, FindSubstitutesResponse } from "./substitute-types.js";
|
|
32
25
|
import type { ProductTypeCoverageOptions, ProductTypeStatusCoverage } from "./taxonomy-coverage-types.js";
|
|
33
26
|
import type { ApplicableSpecsResponse, BrandOptions, BySpecOptions, BySpecResponse, ColourFacetsResponse, CoordinateInput, CoordinateResponse, DemandBatchInput, DemandBatchResponse, DemandParams, DemandResponse, ExtractPaletteInput, ExtractPaletteResponse, GlossaryTermResponse, MaterialResponse, MaterialsBatchDetailResponse, MaterialsBatchGetOptions, MaterialsBatchOptions, MaterialsBatchTileResponse, PairingsOptions, PairingsResponse, ResolveAttributeOptions, ResolveAttributeResponse, ResolveAttributeValueOptions, ResolveAttributeValueResponse, ResolveColourOptions, ResolveColourResponse, SearchGetParams, SearchInput, SearchResponse, SiblingsResponse, SpecFacetsDistributionResponse, SpecFacetsListResponse, SuggestColourResponse, SuggestOptions, SuggestResponse, TaxonomyResponse, VocabularySearchOptions, WhoamiResponse } from "./types.js";
|
|
27
|
+
export * from "./client-config.js";
|
|
28
|
+
export type { BrowseNamespace } from "./client-browse.js";
|
|
29
|
+
export type { ExplorationNamespace } from "./client-exploration.js";
|
|
30
|
+
export type { SourceMaterialCommentsNamespace } from "./client-source-material-comments.js";
|
|
34
31
|
/**
|
|
35
32
|
* The MaterialGraph client — every lens on the graph, on one object.
|
|
36
33
|
*
|
|
@@ -68,7 +65,6 @@ import type { ApplicableSpecsResponse, BrandOptions, BySpecOptions, BySpecRespon
|
|
|
68
65
|
*/
|
|
69
66
|
export declare class MaterialGraphClient extends CatalogueClient {
|
|
70
67
|
#private;
|
|
71
|
-
readonly scheduleReferences: ScheduleReferencesClient;
|
|
72
68
|
readonly baseUrl: string;
|
|
73
69
|
/**
|
|
74
70
|
* THE QUESTION: "show me everything in this category / this brand, in a plain
|
|
@@ -502,14 +498,6 @@ export declare class MaterialGraphClient extends CatalogueClient {
|
|
|
502
498
|
* it is ABSENT — a full page is not the signal to stop.
|
|
503
499
|
*/
|
|
504
500
|
listRuns(options?: ListRunsOptions): Promise<PublicRunListResponse>;
|
|
505
|
-
/**
|
|
506
|
-
* Export a completed compose Run's scheme as a finish schedule — one row per
|
|
507
|
-
* slot, every attribute value carrying its source and verification state
|
|
508
|
-
* (GET `/api/v1/runs/{runId}/schedule`). Unknown values are explicit
|
|
509
|
-
* `missing` cells, never blanks. The `.xlsx` form is a direct-URL download:
|
|
510
|
-
* `GET /api/v1/runs/{runId}/schedule.xlsx` with the same bearer key.
|
|
511
|
-
*/
|
|
512
|
-
runSchedule(runId: RunId, options?: GetRunScheduleOptions): Promise<FinishScheduleResponse>;
|
|
513
501
|
/** Follow a verdict cell's citation handle to its canonical claim source. */
|
|
514
502
|
citation(citationId: string, signal?: AbortSignal): Promise<ResolvedVerdictCitation>;
|
|
515
503
|
/**
|
|
@@ -536,28 +524,6 @@ export declare class MaterialGraphClient extends CatalogueClient {
|
|
|
536
524
|
* signal aborts; pass `after` to resume from the last observed sequence.
|
|
537
525
|
*/
|
|
538
526
|
streamRunEvents(runId: RunId, options?: StreamRunEventsOptions): AsyncGenerator<RunEvent>;
|
|
539
|
-
/**
|
|
540
|
-
* Create a persistent project owned by the caller (POST `/api/v1/projects`).
|
|
541
|
-
* Returns the freshly assembled state (an empty event log). Requires the
|
|
542
|
-
* `mg:ingest` scope.
|
|
543
|
-
*/
|
|
544
|
-
createProject(body?: CreateProjectRequest, signal?: AbortSignal): Promise<ProjectState>;
|
|
545
|
-
/**
|
|
546
|
-
* THE QUESTION: "what has happened on this project?" — the append-only event log
|
|
547
|
-
* FOLDED into a read model, plus the raw `events`. Read the folded collections;
|
|
548
|
-
* the log is there for audit.
|
|
549
|
-
*/
|
|
550
|
-
getProject(projectId: ProjectId, signal?: AbortSignal): Promise<ProjectState>;
|
|
551
|
-
/**
|
|
552
|
-
* Append one event to a project's append-only process trail (POST
|
|
553
|
-
* `/api/v1/projects/{projectId}/events`). Requires the `mg:ingest` scope.
|
|
554
|
-
*/
|
|
555
|
-
appendProjectEvent(projectId: ProjectId, body: AppendProjectEventRequest, signal?: AbortSignal): Promise<ProjectEventReceipt>;
|
|
556
|
-
/**
|
|
557
|
-
* THE QUESTION: "what Boxes do I have?" Scoped to the authenticated principal —
|
|
558
|
-
* another key's projects are invisible, not forbidden.
|
|
559
|
-
*/
|
|
560
|
-
listProjects(signal?: AbortSignal): Promise<ProjectListResponse>;
|
|
561
527
|
/**
|
|
562
528
|
* Collect Run events until a terminal event, the deadline, or the stream ends
|
|
563
529
|
* — the bounded events-log pattern (a single pass over {@link streamRunEvents}).
|