@alpamayo-solutions/colca-client 0.16.0 → 0.17.0

package/dist/catalog.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Product and recipe records of a node's catalog: the `json` value of the `_Constant`
+ * at `catalog/products/{sku}` and at `catalog/recipes/{id}`. The node checks only that
+ * the value is JSON; `colca_data_contracts.catalog` holds the rules and the JSON Schema.
+ */
+/** Who wrote a record or a field: an external system's key, `manual` for a person, `default` for
+ * a placeholder. */
+export interface CatalogProvenance {
+    source: string;
+    set_by?: string | null;
+    /** RFC 3339. */
+    set_at?: string | null;
+}
+export interface CatalogProduct {
+    sku: string;
+    name?: string | null;
+    substrate?: string | null;
+    thickness_mm?: number | null;
+    length_mm?: number | null;
+    width_mm?: number | null;
+    /** What sanding takes off the board, both sides together. */
+    sandoff_mm?: number | null;
+    density_kg_m3?: number | null;
+    /** The grit of the last belt the board sees, FEPA P. */
+    final_grit?: number | null;
+    /** The recipe, by key: many products share one. */
+    recipe_id?: string | null;
+    /** The product a line runs when nobody chose one. */
+    is_default?: boolean;
+    /** Whatever the plant keeps beyond the standard fields. */
+    attributes?: Record<string, unknown>;
+    provenance?: CatalogProvenance;
+    /** Placeholders (`default`) and fields someone other than `provenance.source` set. */
+    field_provenance?: Partial<Record<CatalogProductField, CatalogProvenance>>;
+}
+export interface CatalogRecipe {
+    id: string;
+    name?: string | null;
+    is_default?: boolean;
+    /** One grit per head, keyed by the head's path below the line (`mas2/sta1/aggos`);
+     * `null` for a head the recipe leaves without a belt. */
+    grits?: Record<string, number | null>;
+    attributes?: Record<string, unknown>;
+    provenance?: CatalogProvenance;
+    field_provenance?: Partial<Record<CatalogRecipeField, CatalogProvenance>>;
+}
+export declare const CATALOG_PRODUCT_FIELDS: readonly ["sku", "name", "substrate", "thickness_mm", "length_mm", "width_mm", "sandoff_mm", "density_kg_m3", "final_grit", "recipe_id", "is_default", "attributes"];
+export type CatalogProductField = (typeof CATALOG_PRODUCT_FIELDS)[number];
+export declare const CATALOG_RECIPE_FIELDS: readonly ["id", "name", "is_default", "grits", "attributes"];
+export type CatalogRecipeField = (typeof CATALOG_RECIPE_FIELDS)[number];
+export declare const CATALOG_PRODUCTS = "catalog/products";
+export declare const CATALOG_RECIPES = "catalog/recipes";
+//# sourceMappingURL=catalog.d.ts.map

package/dist/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;oBACoB;AACpB,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,gBAAgB;IAChB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wDAAwD;IACxD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,qDAAqD;IACrD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,sFAAsF;IACtF,gBAAgB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC,CAAC;CAC5E;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;6DACyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,gBAAgB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,CAAC,CAAC;CAC3E;AAED,eAAO,MAAM,sBAAsB,sKAazB,CAAC;AACX,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,eAAO,MAAM,qBAAqB,8DAA+D,CAAC;AAClG,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAExE,eAAO,MAAM,gBAAgB,qBAAqB,CAAC;AACnD,eAAO,MAAM,eAAe,oBAAoB,CAAC"}

package/dist/catalog.js

@@ -0,0 +1,23 @@
+/**
+ * Product and recipe records of a node's catalog: the `json` value of the `_Constant`
+ * at `catalog/products/{sku}` and at `catalog/recipes/{id}`. The node checks only that
+ * the value is JSON; `colca_data_contracts.catalog` holds the rules and the JSON Schema.
+ */
+export const CATALOG_PRODUCT_FIELDS = [
+    "sku",
+    "name",
+    "substrate",
+    "thickness_mm",
+    "length_mm",
+    "width_mm",
+    "sandoff_mm",
+    "density_kg_m3",
+    "final_grit",
+    "recipe_id",
+    "is_default",
+    "attributes",
+];
+export const CATALOG_RECIPE_FIELDS = ["id", "name", "is_default", "grits", "attributes"];
+export const CATALOG_PRODUCTS = "catalog/products";
+export const CATALOG_RECIPES = "catalog/recipes";
+//# sourceMappingURL=catalog.js.map

package/dist/catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA8CH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,KAAK;IACL,MAAM;IACN,WAAW;IACX,cAAc;IACd,WAAW;IACX,UAAU;IACV,YAAY;IACZ,eAAe;IACf,YAAY;IACZ,WAAW;IACX,YAAY;IACZ,YAAY;CACJ,CAAC;AAGX,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,CAAU,CAAC;AAGlG,MAAM,CAAC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AACnD,MAAM,CAAC,MAAM,eAAe,GAAG,iBAAiB,CAAC"}

package/dist/index.d.ts

@@ -17,5 +17,7 @@ export { DEFAULT_ROOT, TOPIC_VERSION, parseTopic, topic, topicMatches, topicPref
 export type { TopicOptions, TopicParts } from "./topics.js";
 export { annotationIdMaterial, deriveAnnotationId, newUlid, ulidFromBytes } from "./ids.js";
 export type { AnnotationIdInput } from "./ids.js";
+export { CATALOG_PRODUCTS, CATALOG_PRODUCT_FIELDS, CATALOG_RECIPES, CATALOG_RECIPE_FIELDS, } from "./catalog.js";
+export type { CatalogProduct, CatalogProductField, CatalogProvenance, CatalogRecipe, CatalogRecipeField, } from "./catalog.js";
 export * from "./generated/contracts.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC5C,YAAY,EACV,WAAW,EACX,WAAW,EACX,UAAU,EACV,YAAY,EACZ,GAAG,EACH,OAAO,EACP,IAAI,EACJ,aAAa,EACb,QAAQ,GACT,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACxG,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE5D,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC5F,YAAY,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAGlD,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC5C,YAAY,EACV,WAAW,EACX,WAAW,EACX,UAAU,EACV,YAAY,EACZ,GAAG,EACH,OAAO,EACP,IAAI,EACJ,aAAa,EACb,QAAQ,GACT,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACxG,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE5D,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC5F,YAAY,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,qBAAqB,GACtB,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,kBAAkB,GACnB,MAAM,cAAc,CAAC;AAGtB,cAAc,0BAA0B,CAAC"}

package/dist/index.js

@@ -13,6 +13,7 @@ export { Door, DoorError } from "./door.js";
 export { Stream } from "./stream.js";
 export { DEFAULT_ROOT, TOPIC_VERSION, parseTopic, topic, topicMatches, topicPrefix } from "./topics.js";
 export { annotationIdMaterial, deriveAnnotationId, newUlid, ulidFromBytes } from "./ids.js";
+export { CATALOG_PRODUCTS, CATALOG_PRODUCT_FIELDS, CATALOG_RECIPES, CATALOG_RECIPE_FIELDS, } from "./catalog.js";
 // The 32 contracts, straight from the bundle the node validates against.
 export * from "./generated/contracts.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAa5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAGrC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAGxG,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG5F,yEAAyE;AACzE,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAa5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAGrC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAGxG,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG5F,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,eAAe,EACf,qBAAqB,GACtB,MAAM,cAAc,CAAC;AAStB,yEAAyE;AACzE,cAAc,0BAA0B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alpamayo-solutions/colca-client",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "Client for a Colca node's door: fetch, ack, publish, kv, self.",
   "keywords": [
     "colca",