@instruments/materialgraph 0.24.0 → 0.26.0

package/sse.js

@@ -26,13 +26,15 @@ export class SseDecoder {
         const frames = [];
         for (;;) {
             const lineEnd = this.#nextLineEnd();
-            if (lineEnd === null)
+            if (lineEnd === null) {
                 break;
+            }
             const line = this.#buffer.slice(0, lineEnd.index);
             this.#buffer = this.#buffer.slice(lineEnd.nextIndex);
             const frame = this.#consumeLine(line);
-            if (frame)
+            if (frame) {
                 frames.push(frame);
+            }
         }
         return frames;
     }
@@ -45,8 +47,9 @@ export class SseDecoder {
                 : this.#buffer;
             this.#buffer = "";
             const frame = this.#consumeLine(line);
-            if (frame)
+            if (frame) {
                 return [frame];
+            }
         }
         const frame = this.#dispatch();
         return frame ? [frame] : [];
@@ -55,11 +58,13 @@ export class SseDecoder {
     #nextLineEnd() {
         for (let i = 0; i < this.#buffer.length; i += 1) {
             const char = this.#buffer[i];
-            if (char === "\n")
+            if (char === "\n") {
                 return { index: i, nextIndex: i + 1 };
+            }
             if (char === "\r") {
-                if (i === this.#buffer.length - 1)
+                if (i === this.#buffer.length - 1) {
                     return null;
+                }
                 return this.#buffer[i + 1] === "\n"
                     ? { index: i, nextIndex: i + 2 }
                     : { index: i, nextIndex: i + 1 };
@@ -68,15 +73,18 @@ export class SseDecoder {
         return null;
     }
     #consumeLine(line) {
-        if (line.length === 0)
+        if (line.length === 0) {
             return this.#dispatch();
-        if (line.startsWith(":"))
+        }
+        if (line.startsWith(":")) {
             return undefined;
+        }
         const colon = line.indexOf(":");
         const field = colon === -1 ? line : line.slice(0, colon);
         let value = colon === -1 ? "" : line.slice(colon + 1);
-        if (value.startsWith(" "))
+        if (value.startsWith(" ")) {
             value = value.slice(1);
+        }
         if (field === "data") {
             this.#dataLines.push(value);
             this.#hasFields = true;
@@ -92,13 +100,16 @@ export class SseDecoder {
         return undefined;
     }
     #dispatch() {
-        if (!this.#hasFields)
+        if (!this.#hasFields) {
             return undefined;
+        }
         const frame = { data: this.#dataLines.join("\n") };
-        if (this.#event !== undefined)
+        if (this.#event !== undefined) {
             frame.event = this.#event;
-        if (this.#id !== undefined)
+        }
+        if (this.#id !== undefined) {
             frame.id = this.#id;
+        }
         this.#dataLines = [];
         this.#event = undefined;
         this.#id = undefined;
@@ -117,28 +128,33 @@ export async function* readSseFrames(body, signal) {
     const sse = new SseDecoder();
     try {
         for (;;) {
-            if (signal?.aborted)
+            if (signal?.aborted) {
                 return;
+            }
             let result;
             try {
                 result = await reader.read();
             }
             catch (error) {
-                if (signal?.aborted)
+                if (signal?.aborted) {
                     return;
+                }
                 throw error;
             }
             if (result.done) {
-                for (const frame of sse.push(decoder.decode()))
+                for (const frame of sse.push(decoder.decode())) {
                     yield frame;
-                for (const frame of sse.flush())
+                }
+                for (const frame of sse.flush()) {
                     yield frame;
+                }
                 return;
             }
             const text = decoder.decode(result.value, { stream: true });
             for (const frame of sse.push(text)) {
-                if (signal?.aborted)
+                if (signal?.aborted) {
                     return;
+                }
                 yield frame;
             }
         }

package/substitute-types.d.ts

@@ -2,40 +2,40 @@ import type { BySpecVerdict } from "./by-spec-types.js";
 import type { VariantId } from "./identifiers.js";
 import type { MaterialSuccessor } from "./material-types.js";
 export type SubstituteSignatureFamily = "textile" | "tile" | "coating" | "lighting_electrical" | "acoustic" | "surface" | "furniture" | "sanitaryware" | "fittings" | "architectural_hardware";
-export interface SubstituteSignatureCriterion {
+export type SubstituteSignatureCriterion = {
     role: "primary_material" | "performance";
     attributeId: string;
     term: string;
-}
-export interface AvailableSubstituteSignature {
+};
+export type AvailableSubstituteSignature = {
     family: SubstituteSignatureFamily;
     form: string;
     criteria: [SubstituteSignatureCriterion, SubstituteSignatureCriterion];
-}
-export interface UnsupportedSubstituteSignature {
+};
+export type UnsupportedSubstituteSignature = {
     family: SubstituteSignatureFamily;
     form: string;
     reason: string;
-}
-export interface InsufficientSubstituteSignature {
+};
+export type InsufficientSubstituteSignature = {
     family: SubstituteSignatureFamily;
     form: string;
     missingRoles: ("primary_material" | "performance")[];
-}
-export interface FindSubstitutesOptions {
+};
+export type FindSubstitutesOptions = {
     excludeBrands?: string[];
     diversityBoost?: number;
     limit?: number;
     cursor?: string;
     includeSamplingArtifacts?: boolean;
     includeUnavailable?: boolean;
-}
-export interface SubstituteMatchedCriterion {
+};
+export type SubstituteMatchedCriterion = {
     attributeId: string;
     confidence: number | null;
     sourceBasis: string | null;
-}
-export interface SubstituteResultItem {
+};
+export type SubstituteResultItem = {
     variantId: VariantId;
     brandSlug: string;
     brand: string;
@@ -50,8 +50,8 @@ export interface SubstituteResultItem {
     diversityAdjustment: number;
     score: number;
     verdict: BySpecVerdict;
-}
-export interface AvailableSubstitutesResponse {
+};
+export type AvailableSubstitutesResponse = {
     status: "available";
     signatureUsed: AvailableSubstituteSignature;
     items: SubstituteResultItem[];
@@ -69,7 +69,7 @@ export interface AvailableSubstitutesResponse {
     poolTruncated: boolean;
     supersededBy: MaterialSuccessor | null;
     nextCursor?: string;
-}
+};
 /**
  * MG-1686. The search read a bounded window of the matches and nothing in it
  * reached the page, while more matches existed past the window. It is not an
@@ -77,7 +77,7 @@ export interface AvailableSubstitutesResponse {
  * empty `items`. `reason` names what happened and the next move; follow
  * `nextCursor` when it is present.
  */
-export interface InconclusiveSubstitutesResponse {
+export type InconclusiveSubstitutesResponse = {
     status: "inconclusive";
     signatureUsed: AvailableSubstituteSignature;
     items: [];
@@ -86,17 +86,17 @@ export interface InconclusiveSubstitutesResponse {
     reason: string;
     supersededBy: MaterialSuccessor | null;
     nextCursor?: string;
-}
-export interface UnsupportedSubstitutesResponse {
+};
+export type UnsupportedSubstitutesResponse = {
     status: "unsupported";
     signature: UnsupportedSubstituteSignature;
     items: [];
     supersededBy: MaterialSuccessor | null;
-}
-export interface InsufficientSubstitutesResponse {
+};
+export type InsufficientSubstitutesResponse = {
     status: "insufficient_signature";
     signature: InsufficientSubstituteSignature;
     items: [];
     supersededBy: MaterialSuccessor | null;
-}
+};
 export type FindSubstitutesResponse = AvailableSubstitutesResponse | InconclusiveSubstitutesResponse | UnsupportedSubstitutesResponse | InsufficientSubstitutesResponse;

package/suggest-types.d.ts

@@ -18,7 +18,7 @@ export type SuggestKind = "product" | "brand" | "category";
 /** How the query met the suggestion's label. Strongest first. */
 export type SuggestMatch = "prefix" | "word" | "contains" | "fuzzy";
 /** One ranked typeahead suggestion, carrying the identity it resolves to. */
-export interface Suggestion {
+export type Suggestion = {
     kind: SuggestKind;
     /** The entity's name as written, for display. */
     label: string;
@@ -38,25 +38,25 @@ export interface Suggestion {
     variantId: string | null;
     /** Variants behind this entity IN MATERIALGRAPH — a coverage figure. */
     variantCount: number;
-}
+};
 /** The suggest response: the query as interpreted, plus the ranked suggestions. */
-export interface SuggestResponse {
+export type SuggestResponse = {
     /** The normalised query the corpus was matched against. */
     query: string;
     /** Ranked best-match-first. Empty when nothing came close — a miss, not an error. */
     suggestions: Suggestion[];
     /** Present only when a narrowing governed corpus was applied. */
     corpusScope?: CorpusScopeReceipt;
-}
+};
 /** Options for {@link MaterialGraphClient.suggest}. */
-export interface SuggestOptions {
+export type SuggestOptions = {
     /** How many suggestions to return (1–20, default 8). */
     limit?: number;
     /** Restrict to these kinds. Omit for all of them. */
     kind?: SuggestKind | SuggestKind[];
     /** Governed corpus membership; absent means the whole graph. */
     corpusScope?: CorpusScope;
-}
+};
 /**
  * Shape the query string for a suggest call.
  *
@@ -65,7 +65,7 @@ export interface SuggestOptions {
  * here rather than being sent as repeated `?kind=` pairs the route would ignore.
  * Undefined members are dropped by the transport.
  */
-export declare function suggestQuery(q: string, options?: SuggestOptions): {
+export declare const suggestQuery: (q: string, options?: SuggestOptions) => {
     q: string;
     limit?: number;
     kind?: string;

package/suggest-types.js

@@ -20,9 +20,9 @@
  * here rather than being sent as repeated `?kind=` pairs the route would ignore.
  * Undefined members are dropped by the transport.
  */
-export function suggestQuery(q, options) {
+export const suggestQuery = (q, options) => {
     const kind = Array.isArray(options?.kind)
         ? options.kind.join(",")
         : options?.kind;
-    return { q, limit: options?.limit, kind, corpusScope: options?.corpusScope };
-}
+    return { corpusScope: options?.corpusScope, kind, limit: options?.limit, q };
+};

package/taxonomy-coverage-types.d.ts

@@ -1,5 +1,5 @@
 /** Exact, source-path-grained status coverage for primary product typing. */
-export interface ProductTypeStatusCoverageCounts {
+export type ProductTypeStatusCoverageCounts = {
     variants: number;
     accepted: number;
     proposed: number;
@@ -8,13 +8,13 @@ export interface ProductTypeStatusCoverageCounts {
     proposedUnknownConfidence: number;
     otherStatus: number;
     missingPrimary: number;
-}
-export interface ProductTypeStatusCoverageSourcePath extends ProductTypeStatusCoverageCounts {
+};
+export type ProductTypeStatusCoverageSourcePath = {
     /** Complete stored source path; null means the product retained no path. */
     sourcePath: string | null;
-}
+} & ProductTypeStatusCoverageCounts;
 /** Current primary-assignment coverage, never an inferred acceptance decision. */
-export interface ProductTypeStatusCoverage {
+export type ProductTypeStatusCoverage = {
     computedAt: string;
     basis: {
         count: "exact";
@@ -26,9 +26,9 @@ export interface ProductTypeStatusCoverage {
     };
     totals: ProductTypeStatusCoverageCounts;
     sourcePaths: ProductTypeStatusCoverageSourcePath[];
-}
-export interface ProductTypeCoverageOptions {
+};
+export type ProductTypeCoverageOptions = {
     [key: string]: number | undefined;
     /** Reporting cutoff in [0,1], default 0.85; it never accepts a proposal. */
     comparisonThreshold?: number;
-}
+};