@adventurelabs/scout-core 2.1.2 → 2.1.3

package/dist/helpers/parts.js

@@ -1,6 +1,6 @@
 import { IWebResponse } from "../types/requests";
 import { update_part_lifecycle } from "./lifecycle";
-import { build_product_catalog, EMPTY_PRODUCT_CATALOG, } from "./product_catalog";
+import { build_product_catalog, catalog_product_from_join, EMPTY_PRODUCT_CATALOG, } from "./product_catalog";
 export async function get_parts_by_device_id(client, device_id) {
     const { data, error } = await client
         .from("parts")
@@ -185,7 +185,10 @@ export async function get_parts_by_herd_ids(client, herd_ids) {
       *,
       devices!parts_device_id_fkey(herd_id),
       product_numbers!parts_product_number_fkey(
-        products!product_numbers_product_id_fkey(*)
+        products!product_numbers_product_id_fkey(
+          *,
+          manufacturers!products_manufacturer_id_fkey(name)
+        )
       )
     `)
         .in("devices.herd_id", herd_ids)
@@ -204,7 +207,7 @@ export async function get_parts_by_herd_ids(client, herd_ids) {
         const part = partRow;
         product_entries.push({
             product_number: part.product_number,
-            product: product_numbers?.products ?? null,
+            product: catalog_product_from_join(product_numbers?.products),
         });
         (parts_by_device[_a = row.device_id] ?? (parts_by_device[_a] = [])).push(part);
     }

package/dist/helpers/product_catalog.d.ts

@@ -1,9 +1,12 @@
-import { IDevice, IPart, IProduct, IProductCatalog } from "../types/db";
+import { ICatalogProduct, IDevice, IManufacturer, IPart, IProduct, IProductCatalog } from "../types/db";
 export declare const EMPTY_PRODUCT_CATALOG: IProductCatalog;
+export declare function catalog_product_from_join(product: (IProduct & {
+    manufacturers?: Pick<IManufacturer, "name"> | null;
+}) | null | undefined): ICatalogProduct | null;
 export declare function build_product_catalog(entries: Iterable<{
     product_number: string;
-    product: IProduct | null | undefined;
+    product: ICatalogProduct | IProduct | null | undefined;
 }>): IProductCatalog;
-export declare function get_product_for_part(catalog: IProductCatalog | null | undefined, part: Pick<IPart, "product_number"> | null | undefined): IProduct | null;
+export declare function get_product_for_part(catalog: IProductCatalog | null | undefined, part: Pick<IPart, "product_number"> | null | undefined): ICatalogProduct | null;
 /** Distinct products across a device's parts, in part order. */
-export declare function get_products_for_device(catalog: IProductCatalog | null | undefined, device: Pick<IDevice, "parts"> | null | undefined): IProduct[];
+export declare function get_products_for_device(catalog: IProductCatalog | null | undefined, device: Pick<IDevice, "parts"> | null | undefined): ICatalogProduct[];

package/dist/helpers/product_catalog.js

@@ -2,6 +2,15 @@ export const EMPTY_PRODUCT_CATALOG = {
     products: {},
     product_id_by_number: {},
 };
+export function catalog_product_from_join(product) {
+    if (!product)
+        return null;
+    const { manufacturers, ...row } = product;
+    return {
+        ...row,
+        manufacturers: manufacturers ?? null,
+    };
+}
 export function build_product_catalog(entries) {
     var _a, _b;
     const catalog = {
@@ -9,10 +18,11 @@ export function build_product_catalog(entries) {
         product_id_by_number: {},
     };
     for (const { product_number, product } of entries) {
-        if (!product)
+        const catalog_product = catalog_product_from_join(product);
+        if (!catalog_product)
             continue;
-        catalog.product_id_by_number[product_number] = product.id;
-        (_a = catalog.products)[_b = product.id] ?? (_a[_b] = product);
+        catalog.product_id_by_number[product_number] = catalog_product.id;
+        (_a = catalog.products)[_b = catalog_product.id] ?? (_a[_b] = catalog_product);
     }
     return catalog;
 }

package/dist/helpers/product_numbers.d.ts

@@ -1,7 +1,7 @@
-import { IProduct, IProductNumber, ProductNumberInsert, ProductNumberUpdate } from "../types/db";
+import { ICatalogProduct, IProductNumber, ProductNumberInsert, ProductNumberUpdate } from "../types/db";
 import { IWebResponseCompatible } from "../types/requests";
 export declare function server_get_product_numbers_by_product(product_id: number): Promise<IWebResponseCompatible<IProductNumber[]>>;
 export declare function server_get_product_number(product_number: string): Promise<IWebResponseCompatible<IProductNumber | null>>;
-export declare function server_get_product_for_product_number(product_number: string): Promise<IWebResponseCompatible<IProduct | null>>;
+export declare function server_get_product_for_product_number(product_number: string): Promise<IWebResponseCompatible<ICatalogProduct | null>>;
 export declare function server_create_product_number(row: ProductNumberInsert): Promise<IWebResponseCompatible<IProductNumber | null>>;
 export declare function server_update_product_number(product_number: string, updates: ProductNumberUpdate): Promise<IWebResponseCompatible<IProductNumber | null>>;

package/dist/helpers/product_numbers.queries.d.ts

@@ -1,9 +1,9 @@
 import { SupabaseClient } from "@supabase/supabase-js";
-import { IProduct, IProductNumber, ProductNumberInsert, ProductNumberUpdate } from "../types/db";
+import { ICatalogProduct, IProductNumber, ProductNumberInsert, ProductNumberUpdate } from "../types/db";
 import { IWebResponseCompatible } from "../types/requests";
 import { Database } from "../types/supabase";
 export declare function get_product_numbers_by_product_query(client: SupabaseClient<Database>, product_id: number): Promise<IWebResponseCompatible<IProductNumber[]>>;
 export declare function get_product_number_query(client: SupabaseClient<Database>, product_number: string): Promise<IWebResponseCompatible<IProductNumber | null>>;
-export declare function get_product_for_product_number_query(client: SupabaseClient<Database>, product_number: string): Promise<IWebResponseCompatible<IProduct | null>>;
+export declare function get_product_for_product_number_query(client: SupabaseClient<Database>, product_number: string): Promise<IWebResponseCompatible<ICatalogProduct | null>>;
 export declare function create_product_number_query(client: SupabaseClient<Database>, row: ProductNumberInsert): Promise<IWebResponseCompatible<IProductNumber | null>>;
 export declare function update_product_number_query(client: SupabaseClient<Database>, product_number: string, updates: ProductNumberUpdate): Promise<IWebResponseCompatible<IProductNumber | null>>;

package/dist/helpers/product_numbers.queries.js

@@ -1,4 +1,5 @@
 import { EnumWebResponse, IWebResponse, } from "../types/requests";
+import { catalog_product_from_join } from "./product_catalog";
 export async function get_product_numbers_by_product_query(client, product_id) {
     const { data, error } = await client
         .from("product_numbers")
@@ -24,14 +25,13 @@ export async function get_product_number_query(client, product_number) {
 export async function get_product_for_product_number_query(client, product_number) {
     const { data, error } = await client
         .from("product_numbers")
-        .select("products!product_numbers_product_id_fkey(*)")
+        .select("products!product_numbers_product_id_fkey(*, manufacturers!products_manufacturer_id_fkey(name))")
         .eq("product_number", product_number)
         .maybeSingle();
     if (error) {
         return { status: EnumWebResponse.ERROR, msg: error.message, data: null };
     }
-    const product = data?.products ?? null;
-    return IWebResponse.success(product).to_compatible();
+    return IWebResponse.success(catalog_product_from_join(data?.products)).to_compatible();
 }
 export async function create_product_number_query(client, row) {
     const { data, error } = await client

package/dist/store/hooks.d.ts

@@ -1,5 +1,5 @@
 import { LoadingPerformance } from "./scout";
-import { IDevice, IPart, IProduct, IProductCatalog, ISessionSummary } from "../types/db";
+import { ICatalogProduct, IDevice, IPart, IProductCatalog, ISessionSummary } from "../types/db";
 export declare const useAppDispatch: import("react-redux").UseDispatch<import("redux").Dispatch<import("redux").UnknownAction>>;
 export declare const useHerdModulesLoadingState: () => any;
 export declare const useIsHerdModulesLoading: () => boolean;
@@ -11,6 +11,6 @@ export declare const useLoadingPerformance: () => LoadingPerformance;
 export declare const useSessionSummariesByHerd: (herdId: number) => ISessionSummary | null;
 export declare const useHasSessionSummaries: (herdId: number) => boolean;
 export declare const useProductCatalog: () => IProductCatalog;
-export declare const useProductForPart: (part: Pick<IPart, "product_number"> | null | undefined) => IProduct | null;
-export declare const useProductsForDevice: (device: Pick<IDevice, "parts"> | null | undefined) => IProduct[];
+export declare const useProductForPart: (part: Pick<IPart, "product_number"> | null | undefined) => ICatalogProduct | null;
+export declare const useProductsForDevice: (device: Pick<IDevice, "parts"> | null | undefined) => ICatalogProduct[];
 export declare const useHerdModulesLoadingTimeAgo: () => string | null;

package/dist/types/db.d.ts

@@ -63,6 +63,10 @@ export type IProvider = Database["public"]["Tables"]["providers"]["Row"];
 export type IPart = Database["public"]["Tables"]["parts"]["Row"];
 export type IManufacturer = Database["public"]["Tables"]["manufacturers"]["Row"];
 export type IProduct = Database["public"]["Tables"]["products"]["Row"];
+/** Product in `IProductCatalog`, with manufacturer name from the products join. */
+export type ICatalogProduct = IProduct & {
+    manufacturers?: Pick<IManufacturer, "name"> | null;
+};
 export type IProductNumber = Database["public"]["Tables"]["product_numbers"]["Row"];
 export type IProductCompatibility = Database["public"]["Tables"]["product_compatibilities"]["Row"];
 export type ISensorPose = Database["public"]["Tables"]["sensor_poses"]["Row"];
@@ -200,10 +204,10 @@ export type HerdOperatingPermissionCreateInput = Pick<HerdOperatingPermissionIns
 export type HerdOperatingPermissionUpdateInput = Partial<Pick<HerdOperatingPermissionCreateInput, "operating_permission_id">> & LifecyclePatch;
 /**
  * Products stored once and shared by every part that references them
- * (parts.product_number -> product_numbers -> products).
+ * (parts.product_number -> product_numbers -> products -> manufacturers).
  */
 export interface IProductCatalog {
-    products: Record<number, IProduct>;
+    products: Record<number, ICatalogProduct>;
     product_id_by_number: Record<string, number>;
 }
 export type IUserCredential = Database["public"]["Tables"]["user_credentials"]["Row"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adventurelabs/scout-core",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "description": "Core utilities and helpers for Adventure Labs Scout applications",
   "exports": {
     "./client": {