@milaboratories/pl-model-common 1.33.0 → 1.34.1

package/src/drivers/pframe/spec/discovered_column.ts

@@ -0,0 +1,65 @@
+import { Branded, throwError } from "@milaboratories/helpers";
+import { PObjectId } from "../../../pool";
+import { AxisQualification } from "../spec_driver";
+import { canonicalizeJson } from "../../../json";
+
+export type DiscoveredPColumn = {
+  path: PathItem[];
+  column: PObjectId;
+  columnQualifications: AxisQualification[];
+  queriesQualifications: Record<PObjectId, AxisQualification[]>;
+};
+
+export type DiscoveredPColumnId = Branded<PObjectId, "DiscoveredPColumnId">; // CanonicalizedJson<DiscoveredPColumn>;
+
+type PathItem = {
+  type: "linker";
+  column: PObjectId;
+  qualifications: AxisQualification[];
+};
+
+export function isDiscoveredPColumn(obj: unknown): obj is DiscoveredPColumn {
+  return (
+    typeof obj === "object" &&
+    obj !== null &&
+    "path" in obj &&
+    "column" in obj &&
+    "columnQualifications" in obj &&
+    "queriesQualifications" in obj
+  );
+}
+
+export function createDiscoveredPColumn(props: {
+  column: PObjectId;
+  path: PathItem[];
+  columnQualifications: AxisQualification[];
+  queriesQualifications: Record<PObjectId, AxisQualification[]>;
+}): DiscoveredPColumn {
+  return JSON.parse(JSON.stringify(props));
+}
+
+export function createDiscoveredPColumnId(props: {
+  column: PObjectId;
+  path: PathItem[];
+  columnQualifications: AxisQualification[];
+  queriesQualifications: Record<PObjectId, AxisQualification[]>;
+}): DiscoveredPColumnId {
+  return stringifyDiscoveredPColumnId(createDiscoveredPColumn(props));
+}
+
+export function parseDiscoveredPColumnId(id: DiscoveredPColumnId): DiscoveredPColumn {
+  try {
+    const parsed = JSON.parse(id);
+    return isDiscoveredPColumn(parsed)
+      ? parsed
+      : throwError("Parsed object is not a valid DiscoveredPColumn");
+  } catch {
+    throw new Error(
+      "Invalid DiscoveredPColumnId: not a valid JSON or does not conform to DiscoveredPColumn structure",
+    );
+  }
+}
+
+export function stringifyDiscoveredPColumnId(id: DiscoveredPColumn) {
+  return canonicalizeJson<DiscoveredPColumn>(id) as string as DiscoveredPColumnId;
+}

package/src/drivers/pframe/spec/ids.ts

@@ -3,10 +3,12 @@ import type { AnchoredPColumnId } from "./selectors";
 import type { FilteredPColumnId } from "./filtered_column";
 import canonicalize from "canonicalize";
 import type { PObjectId } from "../../../pool";
+import { DiscoveredPColumn } from "./discovered_column";
+
 /**
  * Universal column identifier optionally anchored and optionally filtered.
  */
-export type UniversalPColumnId = AnchoredPColumnId | FilteredPColumnId;
+export type UniversalPColumnId = AnchoredPColumnId | FilteredPColumnId | DiscoveredPColumn;
 
 /**
  * Canonically serialized {@link UniversalPColumnId}.

package/src/drivers/pframe/spec/index.ts

@@ -4,3 +4,4 @@ export * from "./filtered_column";
 export * from "./spec";
 export * from "./selectors";
 export * from "./native_id";
+export * from "./discovered_column";

package/src/drivers/pframe/spec/spec.ts

@@ -164,6 +164,7 @@ export const Annotation = {
     FontFamily: "pl7.app/table/fontFamily",
     OrderPriority: "pl7.app/table/orderPriority",
     Visibility: "pl7.app/table/visibility",
+    Info: "pl7.app/table/info",
   },
   Trace: "pl7.app/trace",
   VDJ: {
@@ -205,6 +206,7 @@ export type Annotation = Metadata &
     [Annotation.Table.FontFamily]: string;
     [Annotation.Table.OrderPriority]: StringifiedJson<number>;
     [Annotation.Table.Visibility]: "hidden" | "optional" | (string & {});
+    [Annotation.Table.Info]: string;
     [Annotation.Trace]: StringifiedJson<Trace>;
     [Annotation.VDJ.IsAssemblingFeature]: StringifiedJson<boolean>;
   }>;

package/src/services/service_types.ts

@@ -78,28 +78,32 @@ export interface ServiceDispatch {
 // Auto-derived types from the Services const in service_declarations.ts.
 // Adding a service to Services automatically updates all of these.
 
-type SMap = typeof Services;
+type TServices = typeof Services;
 
 type ExtractServiceName<T> = T extends Branded<infer N extends string, any> ? N : never;
 
 /** Model-side service interfaces keyed by service name literal. */
 export type ModelServices = {
-  [K in keyof SMap as ExtractServiceName<SMap[K]>]: InferServiceModel<ServiceBrand<SMap[K]>>;
+  [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceModel<
+    ServiceBrand<TServices[K]>
+  >;
 };
 
 /** UI-side service interfaces keyed by service name literal. */
 export type UiServices = {
-  [K in keyof SMap as ExtractServiceName<SMap[K]>]: InferServiceUi<ServiceBrand<SMap[K]>>;
+  [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceUi<
+    ServiceBrand<TServices[K]>
+  >;
 };
 
 /** Map from Services keys to their unbranded string name literals. */
 export type ServiceNameLiterals = {
-  [K in keyof SMap]: ExtractServiceName<SMap[K]>;
+  [K in keyof TServices]: ExtractServiceName<TServices[K]>;
 };
 
 /** Auto-derived requires* feature flags from Services keys. */
 export type ServiceRequireFlags = {
-  [K in keyof SMap as `requires${K & string}`]?: boolean;
+  [K in keyof TServices as `requires${K & string}`]?: boolean;
 };
 
 export type RequireServices<T extends ServiceName> = UnionToIntersection<