@instruments/materialgraph 0.45.0 → 1.0.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.
Files changed (49) hide show
  1. package/association-types.d.ts +2 -2
  2. package/brand-types.d.ts +3 -3
  3. package/brands-client.d.ts +3 -3
  4. package/brands-client.js +3 -3
  5. package/{catalogue-client.d.ts → catalog-client.d.ts} +13 -13
  6. package/{catalogue-client.js → catalog-client.js} +13 -13
  7. package/{catalogue-types.d.ts → catalog-types.d.ts} +42 -42
  8. package/client-config.d.ts +7 -0
  9. package/client-response-schema.js +1 -1
  10. package/client-vocabulary.js +1 -1
  11. package/client.d.ts +13 -12
  12. package/client.js +19 -14
  13. package/color-profiles-types.d.ts +1 -1
  14. package/colors-client.d.ts +6 -6
  15. package/colors-client.js +3 -3
  16. package/errors.d.ts +2 -0
  17. package/errors.js +21 -3
  18. package/find-sampled-together-types.d.ts +2 -2
  19. package/find-variants-by-color-types.d.ts +6 -6
  20. package/find-variants-by-vector-types.d.ts +12 -11
  21. package/get-variant-types.d.ts +26 -0
  22. package/http-transport.d.ts +2 -0
  23. package/http-transport.js +17 -3
  24. package/identifiers.d.ts +1 -1
  25. package/image-reference-types.d.ts +2 -2
  26. package/index.d.ts +5 -5
  27. package/list-variant-facets-types.d.ts +2 -2
  28. package/list-variants-types.d.ts +14 -5
  29. package/material-asset-types.d.ts +1 -1
  30. package/operation-responses.d.ts +8 -8
  31. package/operations.generated.d.ts +1 -1
  32. package/operations.generated.js +14 -14
  33. package/package.json +2 -2
  34. package/resolve-color-types.d.ts +13 -13
  35. package/resolve-variant-types.d.ts +1 -1
  36. package/response-schemas.generated.d.ts +2 -2
  37. package/response-schemas.generated.js +43 -42
  38. package/response-schemas.js +20 -20
  39. package/runs.js +1 -1
  40. package/{samplize-catalogue-types.d.ts → samplize-catalog-types.d.ts} +5 -5
  41. package/samplize-colorvec.d.ts +1 -1
  42. package/samplize-colorvec.js +2 -2
  43. package/{search-catalogue-subset-types.d.ts → search-catalog-subset-types.d.ts} +5 -5
  44. package/search-variants-types.d.ts +4 -4
  45. package/types.d.ts +6 -6
  46. package/webmcp.generated.js +4 -4
  47. /package/{catalogue-types.js → catalog-types.js} +0 -0
  48. /package/{samplize-catalogue-types.js → samplize-catalog-types.js} +0 -0
  49. /package/{search-catalogue-subset-types.js → search-catalog-subset-types.js} +0 -0
@@ -8,10 +8,10 @@ const OPERATION_DEFINITIONS = [
8
8
  "find_nearest_paints",
9
9
  ],
10
10
  [
11
- "getCatalogueGeneration",
11
+ "getCatalogGeneration",
12
12
  "GET",
13
13
  "/api/v1/catalog/generation",
14
- "get_catalogue_generation",
14
+ "get_catalog_generation",
15
15
  ],
16
16
  ["catalogs", "GET", "/api/v1/catalogs", "list_catalog_documents"],
17
17
  [
@@ -33,28 +33,28 @@ const OPERATION_DEFINITIONS = [
33
33
  "list_catalog_product_references",
34
34
  ],
35
35
  [
36
- "samplizeCatalogue",
36
+ "samplizeCatalog",
37
37
  "GET",
38
- "/api/v1/catalogues/samplize/products",
39
- "samplize_catalogue_products",
38
+ "/api/v1/catalogs/samplize/products",
39
+ "samplize_catalog_products",
40
40
  ],
41
41
  [
42
- "catalogueReferences",
42
+ "catalogReferencesForVariants",
43
43
  "POST",
44
- "/api/v1/catalogues/references",
45
- "get_catalogue_references_batch",
44
+ "/api/v1/catalogs/references",
45
+ "get_catalog_references_batch",
46
46
  ],
47
47
  [
48
- "catalogueCollections",
48
+ "catalogCollections",
49
49
  "GET",
50
- "/api/v1/catalogues/collections",
51
- "list_catalogue_channel_collections",
50
+ "/api/v1/catalogs/collections",
51
+ "list_catalog_channel_collections",
52
52
  ],
53
53
  [
54
- "catalogueDocumentAccess",
54
+ "catalogDocumentAccess",
55
55
  "GET",
56
- "/api/v1/catalogues/documents/{documentId}",
57
- "get_catalogue_document_access",
56
+ "/api/v1/catalogs/documents/{documentId}",
57
+ "get_catalog_document_access",
58
58
  ],
59
59
  [
60
60
  "materialBlocks",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@instruments/materialgraph",
3
- "version": "0.45.0",
3
+ "version": "1.0.0",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {
@@ -21,7 +21,7 @@
21
21
  }
22
22
  },
23
23
  "dependencies": {
24
- "@materialinstruments/colorscope": "10.2.1"
24
+ "@materialinstruments/colorscope": "10.6.1"
25
25
  },
26
26
  "license": "Proprietary",
27
27
  "engines": {
@@ -1,22 +1,22 @@
1
1
  import type { MatchTarget } from "@materialinstruments/colorscope/match";
2
2
  /**
3
3
  * Color-name resolution (GET `/api/v1/search/colors/resolve`): the resolved
4
- * color, and whether the named paint is a variant in the catalogue.
4
+ * color, and whether the named paint is a variant in the catalog.
5
5
  */
6
6
  import type { ColorResolution } from "@materialinstruments/colorscope/naming";
7
7
  import type { VariantId } from "./identifiers.js";
8
- import type { SearchCatalogueSubset } from "./search-catalogue-subset-types.js";
8
+ import type { SearchCatalogSubset } from "./search-catalog-subset-types.js";
9
9
  import type { OpenEnum } from "./types.js";
10
10
  /** Options for `resolveColor`. */
11
11
  export type ResolveColorOptions = {
12
12
  /**
13
- * Sets `inScope` on each catalogue variant the lookup reports. It never
13
+ * Sets `inScope` on each catalog variant the lookup reports. It never
14
14
  * narrows the lookup. Absent leaves every `inScope` null.
15
15
  */
16
- searchCatalogueSubset?: SearchCatalogueSubset;
16
+ searchCatalogSubset?: SearchCatalogSubset;
17
17
  };
18
- /** One catalogue variant carrying the named paint. */
19
- export type ResolveColorCatalogueVariant = {
18
+ /** One catalog variant carrying the named paint. */
19
+ export type ResolveColorCatalogVariant = {
20
20
  variantId: VariantId;
21
21
  /** The brand exactly as stored, suspect or not. */
22
22
  brand: {
@@ -34,18 +34,18 @@ export type ResolveColorCatalogueVariant = {
34
34
  parentageSuspect: boolean;
35
35
  };
36
36
  /**
37
- * Whether the named paint is a variant in the catalogue. Exact, global, and
38
- * never narrowed by `searchCatalogueSubset`, and run only for a `brand` library hit.
39
- * `not-in-catalogue` means the catalogue was searched and nothing carries the
37
+ * Whether the named paint is a variant in the catalog. Exact, global, and
38
+ * never narrowed by `searchCatalogSubset`, and run only for a `brand` library hit.
39
+ * `not-in-catalog` means the catalog was searched and nothing carries the
40
40
  * paint; `not-looked-up` means there was no one brand's paint to search for.
41
41
  */
42
42
  export type ResolveColorVariant = ({
43
43
  status: "matched";
44
- } & ResolveColorCatalogueVariant) | {
44
+ } & ResolveColorCatalogVariant) | {
45
45
  status: "ambiguous";
46
- candidates: ResolveColorCatalogueVariant[];
46
+ candidates: ResolveColorCatalogVariant[];
47
47
  } | {
48
- status: "not-in-catalogue";
48
+ status: "not-in-catalog";
49
49
  } | {
50
50
  status: "not-looked-up";
51
51
  reason: OpenEnum<"reference-color" | "descriptive-color" | "no-paint-identity" | "generic-color" | "several-paints">;
@@ -77,7 +77,7 @@ export type ResolveColorResponse = {
77
77
  * Present exactly when `libraryId` is. Only a `brand` hit is looked up.
78
78
  */
79
79
  libraryType?: OpenEnum<"brand" | "reference" | "core" | "consumer">;
80
- /** The catalogue lookup for the name. Absent from servers that predate it. */
80
+ /** The catalog lookup for the name. Absent from servers that predate it. */
81
81
  variant?: ResolveColorVariant;
82
82
  } | null;
83
83
  };
@@ -35,7 +35,7 @@ export type ResolveVariantEvidence = {
35
35
  url?: string;
36
36
  detail: string;
37
37
  };
38
- /** The submitted URL, normalised, and the steps that normalisation took. Absent for a code-only call. */
38
+ /** The submitted URL, normalized, and the steps that normalization took. Absent for a code-only call. */
39
39
  export type ResolveVariantReceipt = {
40
40
  submittedUrl: string;
41
41
  normalizedUrl: string;
@@ -1,5 +1,5 @@
1
1
  /** The API contract version the schemas were generated from. */
2
2
  export declare const RESPONSE_SCHEMA_API_VERSION = "0.8.0";
3
3
  /** Every SDK operation whose success response has a published JSON Schema. */
4
- export declare const RESPONSE_SCHEMA_OPERATION_IDS: readonly ["find_nearest_paints", "get_catalogue_generation", "list_catalog_documents", "list_catalog_pages", "get_catalog_page_representation", "list_catalog_product_references", "samplize_catalogue_products", "get_catalogue_references_batch", "list_catalogue_channel_collections", "get_catalogue_document_access", "list_material_blocks", "list_variant_assets", "list_material_documents", "list_schema_value_dictionaries", "get_material_pairings", "list_associated_finishes", "list_associated_products", "get_applicability", "list_variants", "list_variant_facets", "search_variants", "find_variants_by_color", "find_variants_by_vector", "find_sampled_together", "resolve_variant", "get_variant", "resolve_color_name", "catalog_list_attributes", "catalog_list_enum_values", "list_categories", "get_category", "whoami", "get_category_color_profiles", "extract_image_palette", "list_brands", "upload_source_material", "create_public_run", "get_public_run"];
5
- export declare const RESPONSE_SCHEMA_CATALOGUE_JSON: string;
4
+ export declare const RESPONSE_SCHEMA_OPERATION_IDS: readonly ["find_nearest_paints", "get_catalog_generation", "list_catalog_documents", "list_catalog_pages", "get_catalog_page_representation", "list_catalog_product_references", "samplize_catalog_products", "get_catalog_references_batch", "list_catalog_channel_collections", "get_catalog_document_access", "list_material_blocks", "list_variant_assets", "list_material_documents", "list_schema_value_dictionaries", "get_material_pairings", "list_associated_finishes", "list_associated_products", "get_applicability", "list_variants", "list_variant_facets", "search_variants", "find_variants_by_color", "find_variants_by_vector", "find_sampled_together", "resolve_variant", "get_variant", "resolve_color_name", "catalog_list_attributes", "catalog_list_enum_values", "list_categories", "get_category", "whoami", "get_category_color_profiles", "extract_image_palette", "list_brands", "upload_source_material", "create_public_run", "get_public_run"];
5
+ export declare const RESPONSE_SCHEMA_CATALOG_JSON: string;