@instruments/materialgraph 0.29.0 → 0.31.0

package/substitute-types.d.ts

@@ -1,102 +0,0 @@
-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 type SubstituteSignatureCriterion = {
-    role: "primary_material" | "performance";
-    attributeId: string;
-    term: string;
-};
-export type AvailableSubstituteSignature = {
-    family: SubstituteSignatureFamily;
-    form: string;
-    criteria: [SubstituteSignatureCriterion, SubstituteSignatureCriterion];
-};
-export type UnsupportedSubstituteSignature = {
-    family: SubstituteSignatureFamily;
-    form: string;
-    reason: string;
-};
-export type InsufficientSubstituteSignature = {
-    family: SubstituteSignatureFamily;
-    form: string;
-    missingRoles: ("primary_material" | "performance")[];
-};
-export type FindSubstitutesOptions = {
-    excludeBrands?: string[];
-    diversityBoost?: number;
-    limit?: number;
-    cursor?: string;
-    includeSamplingArtifacts?: boolean;
-    includeUnavailable?: boolean;
-};
-export type SubstituteMatchedCriterion = {
-    attributeId: string;
-    confidence: number | null;
-    sourceBasis: string | null;
-};
-export type SubstituteResultItem = {
-    variantId: VariantId;
-    brandSlug: string;
-    brand: string;
-    product: string;
-    variant: string;
-    color: string | null;
-    imageUrl: string | null;
-    hex: string | null;
-    matched: SubstituteMatchedCriterion[];
-    minConfidence: number | null;
-    baseScore: number;
-    diversityAdjustment: number;
-    score: number;
-    verdict: BySpecVerdict;
-};
-export type AvailableSubstitutesResponse = {
-    status: "available";
-    signatureUsed: AvailableSubstituteSignature;
-    items: SubstituteResultItem[];
-    candidatePoolSize: number;
-    droppedUnavailable: number;
-    /**
-     * MG-1686, MG-1783. True when the candidate read hit the bounded pool ceiling,
-     * so more materials match the signature than were ranked. A cut pool is an
-     * even SAMPLE across the id keyspace rather than its lowest window, so the
-     * ranked set is representative of the match set without being all of it —
-     * treat the items as the best of a sample, never as the best that exist. A cut
-     * pool that produced NO items answers `inconclusive` instead, so `available`
-     * with an empty `items` always means a complete search that found nothing.
-     */
-    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
- * answer of "nothing can replace this" — that answer is `available` with an
- * empty `items`. `reason` names what happened and the next move; follow
- * `nextCursor` when it is present.
- */
-export type InconclusiveSubstitutesResponse = {
-    status: "inconclusive";
-    signatureUsed: AvailableSubstituteSignature;
-    items: [];
-    candidatePoolSize: number;
-    droppedUnavailable: number;
-    reason: string;
-    supersededBy: MaterialSuccessor | null;
-    nextCursor?: string;
-};
-export type UnsupportedSubstitutesResponse = {
-    status: "unsupported";
-    signature: UnsupportedSubstituteSignature;
-    items: [];
-    supersededBy: MaterialSuccessor | null;
-};
-export type InsufficientSubstitutesResponse = {
-    status: "insufficient_signature";
-    signature: InsufficientSubstituteSignature;
-    items: [];
-    supersededBy: MaterialSuccessor | null;
-};
-export type FindSubstitutesResponse = AvailableSubstitutesResponse | InconclusiveSubstitutesResponse | UnsupportedSubstitutesResponse | InsufficientSubstitutesResponse;

package/substitute-types.js

@@ -1 +0,0 @@
-export {};

package/suggest-types.d.ts

@@ -1,67 +0,0 @@
-/**
- * Entity typeahead (MG-654) — the hand-mirrored wire types for
- * `GET /api/v1/search/suggest`, plus the one query-shaping rule the endpoint
- * imposes.
- *
- * Split out of `types.ts` for the repository's source-file size budget, the same
- * reason `catalog-discovery-types.ts` sits beside it; both are re-exported from
- * `types.ts`, so importers see no difference.
- *
- * THE LENS: entity typeahead — it ranks NAMES, not materials. `mg.search()` is
- * what answers a committed query; `mg.suggestColour()` covers colour names and
- * `mg.listAttributes({ query })` covers attributes. Suggestions are a page
- * of the best matches, never a census of matching entities.
- */
-/** Which kind of entity a suggestion is — and therefore what `refId` means. */
-export type SuggestKind = "product" | "brand" | "category";
-/** How the query met the suggestion's label. Strongest first. */
-export type SuggestMatch = "prefix" | "word" | "fuzzy";
-/** One ranked typeahead suggestion, carrying the identity it resolves to. */
-export type Suggestion = {
-    kind: SuggestKind;
-    /** The entity's name as written, for display. */
-    label: string;
-    /**
-     * The resolvable identity: a product id, a brand slug, or a product-type key.
-     * Selecting a suggestion should navigate to this, not re-search `label`.
-     */
-    refId: string;
-    match: SuggestMatch;
-    brandSlug: string | null;
-    brandName: string | null;
-    categoryKey: string | null;
-    /**
-     * A representative variant, so a client can open a material record directly.
-     * Opaque, and null when none was picked — not a product without variants.
-     */
-    variantId: string | null;
-    /** How many of this entity's variants the search index holds: a coverage figure. */
-    variantCount: number;
-};
-/** The suggest response: the query as interpreted, plus the ranked suggestions. */
-export type SuggestResponse = {
-    /** The typed words the search index was matched against. */
-    query: string;
-    /** Ranked best-match-first. Empty when nothing came close: a miss, not an error. */
-    suggestions: Suggestion[];
-};
-/** Options for {@link MaterialGraphClient.suggest}. */
-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[];
-};
-/**
- * Shape the query string for a suggest call.
- *
- * The only non-obvious rule: `kind` is a COMMA LIST on the wire (`product,brand`),
- * which is the house convention for multi-value v1 params, so an array is joined
- * here rather than being sent as repeated `?kind=` pairs the route would ignore.
- * Undefined members are dropped by the transport.
- */
-export declare const suggestQuery: (q: string, options?: SuggestOptions) => {
-    q: string;
-    limit?: number;
-    kind?: string;
-};

package/suggest-types.js

@@ -1,28 +0,0 @@
-/**
- * Entity typeahead (MG-654) — the hand-mirrored wire types for
- * `GET /api/v1/search/suggest`, plus the one query-shaping rule the endpoint
- * imposes.
- *
- * Split out of `types.ts` for the repository's source-file size budget, the same
- * reason `catalog-discovery-types.ts` sits beside it; both are re-exported from
- * `types.ts`, so importers see no difference.
- *
- * THE LENS: entity typeahead — it ranks NAMES, not materials. `mg.search()` is
- * what answers a committed query; `mg.suggestColour()` covers colour names and
- * `mg.listAttributes({ query })` covers attributes. Suggestions are a page
- * of the best matches, never a census of matching entities.
- */
-/**
- * Shape the query string for a suggest call.
- *
- * The only non-obvious rule: `kind` is a COMMA LIST on the wire (`product,brand`),
- * which is the house convention for multi-value v1 params, so an array is joined
- * here rather than being sent as repeated `?kind=` pairs the route would ignore.
- * Undefined members are dropped by the transport.
- */
-export const suggestQuery = (q, options) => {
-    const kind = Array.isArray(options?.kind)
-        ? options.kind.join(",")
-        : options?.kind;
-    return { kind, limit: options?.limit, q };
-};

package/taxonomy-coverage-types.d.ts

@@ -1,34 +0,0 @@
-/** Exact, source-path-grained status coverage for primary product typing. */
-export type ProductTypeStatusCoverageCounts = {
-    variants: number;
-    accepted: number;
-    proposed: number;
-    proposedBelowThreshold: number;
-    /** Proposed rows with no confidence remain explicit rather than thresholded. */
-    proposedUnknownConfidence: number;
-    otherStatus: number;
-    missingPrimary: number;
-};
-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 type ProductTypeStatusCoverage = {
-    computedAt: string;
-    basis: {
-        count: "exact";
-        universe: "non_superseded_variants";
-        assignment: "variant_primary_only";
-        sourcePath: "products.source_category_path";
-        /** Reporting cutoff only: higher-confidence proposals remain proposed. */
-        comparisonThreshold: number;
-    };
-    totals: ProductTypeStatusCoverageCounts;
-    sourcePaths: ProductTypeStatusCoverageSourcePath[];
-};
-export type ProductTypeCoverageOptions = {
-    [key: string]: number | undefined;
-    /** Reporting cutoff in [0,1], default 0.85; it never accepts a proposal. */
-    comparisonThreshold?: number;
-};

package/taxonomy-coverage-types.js

@@ -1 +0,0 @@
-export {};