@milaboratories/pl-model-common 1.27.0 → 1.29.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.
@@ -24,7 +24,7 @@ import { DataExprAxisRef, DataExprColumnRef, DataQuery, DataQueryBooleanExpressi
24
24
  import { collectSpecQueryColumns, isBooleanExpression, mapSpecQueryColumns, sortSpecQuery, traverseQuerySpec } from "./pframe/query/utils.js";
25
25
  import { PFrameDriver, PFrameHandle, PTableHandle } from "./pframe/driver.js";
26
26
  import { CompositeLinkerMap, LinkerMap } from "./pframe/linker_columns.js";
27
+ import { AxisQualification, ColumnAxesWithQualifications, DiscoverColumnsConstraints, DiscoverColumnsLinkerStep, DiscoverColumnsMappingVariant, DiscoverColumnsRequest, DiscoverColumnsResponse, DiscoverColumnsResponseHit, DiscoverColumnsResponseQualifications, DiscoverColumnsStepInfo, MatcherMap, MultiAxisSelector, MultiColumnSelector, PFrameSpecDriver, SpecFrameHandle, StringMatcher } from "./pframe/spec_driver.js";
27
28
  import "./pframe/index.js";
28
29
  import { FileRange, ImportFileHandle, ImportFileHandleIndex, ImportFileHandleUpload, ListFilesResult, LocalImportFileHandle, LsDriver, LsEntry, OpenDialogFilter, OpenDialogOps, OpenMultipleFilesResponse, OpenSingleFileResponse, StorageEntry, StorageHandle, StorageHandleLocal, StorageHandleRemote, getFileNameFromHandle, getFilePathFromHandle, isImportFileHandleIndex, isImportFileHandleUpload } from "./ls.js";
29
- import { AxisQualification, ColumnAxesWithQualifications, DiscoverColumnsConstraints, DiscoverColumnsMappingVariant, DiscoverColumnsRequest, DiscoverColumnsResponse, DiscoverColumnsResponseHit, DiscoverColumnsResponseQualifications, MatcherMap, MultiAxisSelector, MultiColumnSelector, PSpecDriver, SpecFrameHandle, StringMatcher } from "./pspec.js";
30
30
  import { ChunkedStreamReader, ChunkedStreamReaderOptions, ErrorHandlerStatus } from "./ChunkedStreamReader.js";
@@ -20,4 +20,5 @@ import { DataExprAxisRef, DataExprColumnRef, DataQuery, DataQueryBooleanExpressi
20
20
  import { collectSpecQueryColumns, isBooleanExpression, mapSpecQueryColumns, sortSpecQuery, traverseQuerySpec } from "./query/utils.js";
21
21
  import "./query/index.js";
22
22
  import { PFrameDriver, PFrameHandle, PTableHandle } from "./driver.js";
23
- import { CompositeLinkerMap, LinkerMap } from "./linker_columns.js";
23
+ import { CompositeLinkerMap, LinkerMap } from "./linker_columns.js";
24
+ import { AxisQualification, ColumnAxesWithQualifications, DiscoverColumnsConstraints, DiscoverColumnsLinkerStep, DiscoverColumnsMappingVariant, DiscoverColumnsRequest, DiscoverColumnsResponse, DiscoverColumnsResponseHit, DiscoverColumnsResponseQualifications, DiscoverColumnsStepInfo, MatcherMap, MultiAxisSelector, MultiColumnSelector, PFrameSpecDriver, SpecFrameHandle, StringMatcher } from "./spec_driver.js";
@@ -1 +1 @@
1
- {"version":3,"file":"spec.cjs","names":["ensureError","z","canonicalizeJson"],"sources":["../../../../src/drivers/pframe/spec/spec.ts"],"sourcesContent":["import { ensureError } from \"../../../errors\";\nimport { canonicalizeJson, type CanonicalizedJson, type StringifiedJson } from \"../../../json\";\nimport type { PObject, PObjectId, PObjectSpec } from \"../../../pool\";\nimport { z } from \"zod\";\n\nexport const ValueType = {\n Int: \"Int\",\n Long: \"Long\",\n Float: \"Float\",\n Double: \"Double\",\n String: \"String\",\n Bytes: \"Bytes\",\n} as const;\n\nexport type AxisValueType = Extract<ValueType, \"Int\" | \"Long\" | \"String\">;\nexport type ColumnValueType = ValueType;\n\n/** PFrame columns and axes within them may store one of these types. */\nexport type ValueType = (typeof ValueType)[keyof typeof ValueType];\n\nexport type Metadata = Record<string, string>;\n\nexport function readMetadata<U extends Metadata, T extends keyof U = keyof U>(\n metadata: Metadata | undefined,\n key: T,\n): U[T] | undefined {\n return (metadata as U | undefined)?.[key];\n}\n\ntype MetadataJsonImpl<M> = {\n [P in keyof M as M[P] extends StringifiedJson ? P : never]: M[P] extends StringifiedJson<infer U>\n ? z.ZodType<U>\n : never;\n};\nexport type MetadataJson<M> = MetadataJsonImpl<Required<M>>;\n\nexport function readMetadataJsonOrThrow<M extends Metadata, T extends keyof MetadataJson<M>>(\n metadata: Metadata | undefined,\n metadataJson: MetadataJson<M>,\n key: T,\n methodNameInError: string = \"readMetadataJsonOrThrow\",\n): z.infer<MetadataJson<M>[T]> | undefined {\n const json = readMetadata<M, T>(metadata, key);\n if (json === undefined) return undefined;\n\n const schema = metadataJson[key];\n try {\n const value = JSON.parse(json);\n return schema.parse(value);\n } catch (error: unknown) {\n throw new Error(\n `${methodNameInError} failed, ` +\n `key: ${String(key)}, ` +\n `value: ${json}, ` +\n `error: ${ensureError(error)}`,\n );\n }\n}\n\nexport function readMetadataJson<M extends Metadata, T extends keyof MetadataJson<M>>(\n metadata: Metadata | undefined,\n metadataJson: MetadataJson<M>,\n key: T,\n): z.infer<MetadataJson<M>[T]> | undefined {\n try {\n return readMetadataJsonOrThrow(metadata, metadataJson, key);\n } catch {\n return undefined; // treat invalid values as unset\n }\n}\n\n/// Well-known domains\nexport const Domain = {\n Alphabet: \"pl7.app/alphabet\",\n BlockId: \"pl7.app/blockId\",\n VDJ: {\n Clustering: {\n BlockId: \"pl7.app/vdj/clustering/blockId\",\n },\n ScClonotypeChain: {\n Index: \"pl7.app/vdj/scClonotypeChain/index\",\n },\n },\n} as const;\n\nexport type Domain = Metadata &\n Partial<{\n [Domain.Alphabet]: \"nucleotide\" | \"aminoacid\" | (string & {});\n [Domain.BlockId]: string;\n [Domain.VDJ.ScClonotypeChain.Index]: \"primary\" | \"secondary\" | (string & {});\n }>;\n\nexport type DomainJson = MetadataJson<Domain>;\nexport const DomainJson: DomainJson = {};\n\n/// Helper function for reading plain domain values\nexport function readDomain<T extends keyof Domain>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): Domain[T] | undefined {\n return readMetadata<Domain, T>(spec?.domain, key);\n}\n\n/// Helper function for reading json-encoded domain values, throws on JSON parsing error\nexport function readDomainJsonOrThrow<T extends keyof DomainJson>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<DomainJson[T]> | undefined {\n return readMetadataJsonOrThrow<Domain, T>(spec?.domain, DomainJson, key, \"readDomainJsonOrThrow\");\n}\n\n/// Helper function for reading json-encoded domain values, returns undefined on JSON parsing error\nexport function readDomainJson<T extends keyof DomainJson>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<DomainJson[T]> | undefined {\n return readMetadataJson<Domain, T>(spec?.domain, DomainJson, key);\n}\n\n/// Well-known annotations\nexport const Annotation = {\n AxisNature: \"pl7.app/axisNature\",\n Alphabet: \"pl7.app/alphabet\",\n Description: \"pl7.app/description\",\n DiscreteValues: \"pl7.app/discreteValues\",\n Format: \"pl7.app/format\",\n Graph: {\n Axis: {\n HighCardinality: \"pl7.app/graph/axis/highCardinality\",\n LowerLimit: \"pl7.app/graph/axis/lowerLimit\",\n SymmetricRange: \"pl7.app/graph/axis/symmetricRange\",\n UpperLimit: \"pl7.app/graph/axis/upperLimit\",\n },\n IsDenseAxis: \"pl7.app/graph/isDenseAxis\",\n IsVirtual: \"pl7.app/graph/isVirtual\",\n Palette: \"pl7.app/graph/palette\",\n Thresholds: \"pl7.app/graph/thresholds\",\n TreatAbsentValuesAs: \"pl7.app/graph/treatAbsentValuesAs\",\n },\n HideDataFromUi: \"pl7.app/hideDataFromUi\",\n HideDataFromGraphs: \"pl7.app/hideDataFromGraphs\",\n IsDiscreteFilter: \"pl7.app/isDiscreteFilter\",\n IsAnchor: \"pl7.app/isAnchor\",\n IsLinkerColumn: \"pl7.app/isLinkerColumn\",\n IsScore: \"pl7.app/isScore\",\n IsSubset: \"pl7.app/isSubset\",\n Label: \"pl7.app/label\",\n Max: \"pl7.app/max\",\n Min: \"pl7.app/min\",\n MultipliesBy: \"pl7.app/multipliesBy\",\n Parents: \"pl7.app/parents\",\n Score: {\n DefaultCutoff: \"pl7.app/score/defaultCutoff\",\n RankingOrder: \"pl7.app/score/rankingOrder\",\n },\n Sequence: {\n Annotation: {\n Mapping: \"pl7.app/sequence/annotation/mapping\",\n },\n IsAnnotation: \"pl7.app/sequence/isAnnotation\",\n },\n Table: {\n FontFamily: \"pl7.app/table/fontFamily\",\n OrderPriority: \"pl7.app/table/orderPriority\",\n Visibility: \"pl7.app/table/visibility\",\n },\n Trace: \"pl7.app/trace\",\n VDJ: {\n IsAssemblingFeature: \"pl7.app/vdj/isAssemblingFeature\",\n IsMainSequence: \"pl7.app/vdj/isMainSequence\",\n },\n} as const;\n\nexport type Annotation = Metadata &\n Partial<{\n [Annotation.Alphabet]: \"nucleotide\" | \"aminoacid\" | (string & {});\n [Annotation.AxisNature]: \"homogeneous\" | \"heterogeneous\" | \"scaleCompatible\" | (string & {});\n [Annotation.Description]: string;\n [Annotation.DiscreteValues]: StringifiedJson<number[]> | StringifiedJson<string[]>;\n [Annotation.Format]: string;\n [Annotation.Graph.Axis.HighCardinality]: StringifiedJson<boolean>;\n [Annotation.Graph.Axis.LowerLimit]: StringifiedJson<number>;\n [Annotation.Graph.Axis.SymmetricRange]: StringifiedJson<boolean>;\n [Annotation.Graph.Axis.UpperLimit]: StringifiedJson<number>;\n [Annotation.Graph.IsDenseAxis]: StringifiedJson<boolean>;\n [Annotation.Graph.IsVirtual]: StringifiedJson<boolean>;\n [Annotation.Graph.Palette]: StringifiedJson<{ mapping: Record<string, number>; name: string }>;\n [Annotation.Graph.Thresholds]: StringifiedJson<\n { columnId: { valueType: ValueType; name: string }; value: number }[]\n >;\n [Annotation.Graph.TreatAbsentValuesAs]: StringifiedJson<number>;\n [Annotation.HideDataFromGraphs]: StringifiedJson<boolean>;\n [Annotation.HideDataFromUi]: StringifiedJson<boolean>;\n [Annotation.IsDiscreteFilter]: StringifiedJson<boolean>;\n [Annotation.IsLinkerColumn]: StringifiedJson<boolean>;\n [Annotation.IsSubset]: StringifiedJson<boolean>;\n [Annotation.Label]: string;\n [Annotation.Max]: StringifiedJson<number>;\n [Annotation.Min]: StringifiedJson<number>;\n [Annotation.MultipliesBy]: StringifiedJson<AxisSpec[\"name\"][]>;\n [Annotation.Parents]: StringifiedJson<AxisSpec[\"name\"][]>;\n [Annotation.Sequence.Annotation.Mapping]: StringifiedJson<Record<string, string>>;\n [Annotation.Sequence.IsAnnotation]: StringifiedJson<boolean>;\n [Annotation.Table.FontFamily]: string;\n [Annotation.Table.OrderPriority]: StringifiedJson<number>;\n [Annotation.Table.Visibility]: \"hidden\" | \"optional\" | (string & {});\n [Annotation.Trace]: StringifiedJson<Record<string, unknown>>;\n [Annotation.VDJ.IsAssemblingFeature]: StringifiedJson<boolean>;\n }>;\n\n// export const AxisSpec = z.object({\n// type: z.nativeEnum(ValueType),\n// name: z.string(),\n// domain: z.record(z.string(), z.string()).optional(),\n// annotations: z.record(z.string(), z.string()).optional(),\n// parentAxes: z.array(z.number()).optional(),\n// }).passthrough();\n//\n// type Expect<T extends true> = T;\n// type Equal<X, Y> =\n// (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;\n//\n// type _test = Expect<Equal<\n// Readonly<z.infer<typeof AxisSpec>>,\n// Readonly<AxisSpec & Record<string, unknown>>\n// >>;\n\nexport type AnnotationJson = MetadataJson<Annotation>;\n\nconst ValueTypeSchema = z.enum([\"Int\", \"Long\", \"Float\", \"Double\", \"String\"] as const);\nexport const AnnotationJson: AnnotationJson = {\n [Annotation.DiscreteValues]: z.array(z.string()).or(z.array(z.number())),\n [Annotation.Graph.Axis.HighCardinality]: z.boolean(),\n [Annotation.Graph.Axis.LowerLimit]: z.number(),\n [Annotation.Graph.Axis.UpperLimit]: z.number(),\n [Annotation.Graph.Axis.SymmetricRange]: z.boolean(),\n [Annotation.Graph.IsDenseAxis]: z.boolean(),\n [Annotation.Graph.Palette]: z.object({ mapping: z.record(z.number()), name: z.string() }),\n [Annotation.Graph.Thresholds]: z.array(\n z.object({\n columnId: z.object({ valueType: ValueTypeSchema, name: z.string() }),\n value: z.number(),\n }),\n ),\n [Annotation.Graph.TreatAbsentValuesAs]: z.number(),\n [Annotation.Graph.IsVirtual]: z.boolean(),\n [Annotation.HideDataFromUi]: z.boolean(),\n [Annotation.HideDataFromGraphs]: z.boolean(),\n [Annotation.IsDiscreteFilter]: z.boolean(),\n [Annotation.IsLinkerColumn]: z.boolean(),\n [Annotation.IsSubset]: z.boolean(),\n [Annotation.Max]: z.number(),\n [Annotation.Min]: z.number(),\n [Annotation.MultipliesBy]: z.array(z.string()),\n [Annotation.Parents]: z.array(z.string()),\n [Annotation.Sequence.Annotation.Mapping]: z.record(z.string(), z.string()),\n [Annotation.Sequence.IsAnnotation]: z.boolean(),\n [Annotation.Table.OrderPriority]: z.number(),\n [Annotation.Trace]: z.record(z.string(), z.unknown()),\n [Annotation.VDJ.IsAssemblingFeature]: z.boolean(),\n};\n\n/// Helper function for reading plain annotation values\nexport function readAnnotation<T extends keyof Annotation>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): Annotation[T] | undefined {\n return readMetadata<Annotation, T>(spec?.annotations, key);\n}\n\n/// Helper function for reading json-encoded annotation values, throws on JSON parsing error\nexport function readAnnotationJsonOrThrow<T extends keyof AnnotationJson>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<AnnotationJson[T]> | undefined {\n return readMetadataJsonOrThrow<Annotation, T>(\n spec?.annotations,\n AnnotationJson,\n key,\n \"readAnnotationJsonOrThrow\",\n );\n}\n\n/// Helper function for reading json-encoded annotation values, returns undefined on JSON parsing error\nexport function readAnnotationJson<T extends keyof AnnotationJson>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<AnnotationJson[T]> | undefined {\n return readMetadataJson<Annotation, T>(spec?.annotations, AnnotationJson, key);\n}\n\nexport function isLinkerColumn(column: PColumnSpec): boolean {\n return !!readAnnotationJson(column, Annotation.IsLinkerColumn);\n}\n\n/**\n * Specification of an individual axis.\n *\n * Each axis is a part of a composite key that addresses data inside the PColumn.\n *\n * Each record inside a PColumn is addressed by a unique tuple of values set for\n * all the axes specified in the column spec.\n */\nexport type AxisSpec = {\n /** Type of the axis value. Should not use non-key types like float or double. */\n readonly type: ValueType;\n\n /** Name of the axis */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional axis identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** Any additional information attached to the axis that does not affect its\n * identifier */\n readonly annotations?: Record<string, string>;\n\n /**\n * Parent axes provide contextual grouping for the axis in question, establishing\n * a hierarchy where the current axis is dependent on one or more axes for its\n * full definition and meaning. For instance, in a data structure where each\n * \"container\" axis may contain multiple \"item\" axes, the `item` axis would\n * list the index of the `container` axis in this field to denote its dependency.\n *\n * This means that the identity or significance of the `item` axis is only\n * interpretable when combined with its parent `container` axis. An `item` axis\n * index by itself may be non-unique and only gains uniqueness within the context\n * of its parent `container`. Therefore, the `parentAxes` field is essential for\n * mapping these relationships and ensuring data coherence across nested or\n * multi-level data models.\n *\n * A list of zero-based indices of parent axes in the overall axes specification\n * from the column spec. Each index corresponds to the position of a parent axis\n * in the list that defines the structure of the data model.\n */\n readonly parentAxes?: number[];\n};\n\n/** Parents are specs, not indexes; normalized axis can be used considering its parents independently from column */\nexport interface AxisSpecNormalized extends Omit<AxisSpec, \"parentAxes\"> {\n parentAxesSpec: AxisSpecNormalized[];\n}\n\n/** Tree: axis is a root, its parents are children */\nexport type AxisTree = {\n axis: AxisSpecNormalized;\n children: AxisTree[]; // parents\n};\n\nfunction makeAxisTree(axis: AxisSpecNormalized): AxisTree {\n return { axis, children: [] };\n}\n\n/** Build tree by axis parents annotations */\nexport function getAxesTree(rootAxis: AxisSpecNormalized): AxisTree {\n const root = makeAxisTree(rootAxis);\n let nodesQ = [root];\n while (nodesQ.length) {\n const nextNodes: AxisTree[] = [];\n for (const node of nodesQ) {\n node.children = node.axis.parentAxesSpec.map(makeAxisTree);\n nextNodes.push(...node.children);\n }\n nodesQ = nextNodes;\n }\n return root;\n}\n\n/** Get set of canonicalized axisIds from axisTree */\nexport function getSetFromAxisTree(tree: AxisTree): Set<CanonicalizedJson<AxisId>> {\n const set = new Set([canonicalizeJson(getAxisId(tree.axis))]);\n let nodesQ = [tree];\n while (nodesQ.length) {\n const nextNodes = [];\n for (const node of nodesQ) {\n for (const parent of node.children) {\n set.add(canonicalizeJson(getAxisId(parent.axis)));\n nextNodes.push(parent);\n }\n }\n nodesQ = nextNodes;\n }\n return set;\n}\n\n/** Get array of axisSpecs from axisTree */\nexport function getArrayFromAxisTree(tree: AxisTree): AxisSpecNormalized[] {\n const res = [tree.axis];\n let nodesQ = [tree];\n while (nodesQ.length) {\n const nextNodes = [];\n for (const node of nodesQ) {\n for (const parent of node.children) {\n res.push(parent.axis);\n nextNodes.push(parent);\n }\n }\n nodesQ = nextNodes;\n }\n return res;\n}\n\nexport function canonicalizeAxisWithParents(axis: AxisSpecNormalized) {\n return canonicalizeJson(getArrayFromAxisTree(getAxesTree(axis)).map(getAxisId));\n}\n\nfunction normalizingAxesComparator(\n axis1: AxisSpecNormalized,\n axis2: AxisSpecNormalized,\n): 1 | -1 | 0 {\n if (axis1.name !== axis2.name) {\n return axis1.name < axis2.name ? 1 : -1;\n }\n if (axis1.type !== axis2.type) {\n return axis1.type < axis2.type ? 1 : -1;\n }\n const domain1 = canonicalizeJson(axis1.domain ?? {});\n const domain2 = canonicalizeJson(axis2.domain ?? {});\n if (domain1 !== domain2) {\n return domain1 < domain2 ? 1 : -1;\n }\n\n const contextDomain1 = canonicalizeJson(axis1.contextDomain ?? {});\n const contextDomain2 = canonicalizeJson(axis2.contextDomain ?? {});\n if (contextDomain1 !== contextDomain2) {\n return contextDomain1 < contextDomain2 ? 1 : -1;\n }\n\n const parents1 = canonicalizeAxisWithParents(axis1);\n const parents2 = canonicalizeAxisWithParents(axis2);\n\n if (parents1 !== parents2) {\n return parents1 < parents2 ? 1 : -1;\n }\n\n const annotation1 = canonicalizeJson(axis1.annotations ?? {});\n const annotation2 = canonicalizeJson(axis2.annotations ?? {});\n if (annotation1 !== annotation2) {\n return annotation1 < annotation2 ? 1 : -1;\n }\n return 0;\n}\n\nfunction parseParentsFromAnnotations(axis: AxisSpec) {\n const parentsList = readAnnotationJson(axis, Annotation.Parents);\n if (parentsList === undefined) {\n return [];\n }\n return parentsList;\n}\n\nfunction sortParentsDeep(axisSpec: AxisSpecNormalized) {\n axisSpec.parentAxesSpec.forEach(sortParentsDeep);\n axisSpec.parentAxesSpec.sort(normalizingAxesComparator);\n}\n\nfunction hasCycleOfParents(axisSpec: AxisSpecNormalized) {\n const root = makeAxisTree(axisSpec);\n let nodesQ = [root];\n const ancestors = new Set(canonicalizeJson(getAxisId(axisSpec)));\n while (nodesQ.length) {\n const nextNodes: AxisTree[] = [];\n const levelIds = new Set<CanonicalizedJson<AxisId>>();\n for (const node of nodesQ) {\n node.children = node.axis.parentAxesSpec.map(makeAxisTree);\n for (const child of node.children) {\n const childId = canonicalizeJson(getAxisId(child.axis));\n if (!levelIds.has(childId)) {\n nextNodes.push(child);\n levelIds.add(childId);\n if (ancestors.has(childId)) {\n return true;\n }\n ancestors.add(childId);\n }\n }\n }\n nodesQ = nextNodes;\n }\n return false;\n}\n\n/** Create list of normalized axisSpec (parents are in array of specs, not indexes) */\nexport function getNormalizedAxesList(axes: AxisSpec[]): AxisSpecNormalized[] {\n if (!axes.length) {\n return [];\n }\n const modifiedAxes: AxisSpecNormalized[] = axes.map((axis) => {\n const { parentAxes: _, ...copiedRest } = axis;\n return { ...copiedRest, annotations: { ...copiedRest.annotations }, parentAxesSpec: [] };\n });\n\n axes.forEach((axis, idx) => {\n const modifiedAxis = modifiedAxes[idx];\n if (axis.parentAxes) {\n // if we have parents by indexes then take from the list\n modifiedAxis.parentAxesSpec = axis.parentAxes.map((idx) => modifiedAxes[idx]);\n } else {\n // else try to parse from annotation name\n const parents = parseParentsFromAnnotations(axis).map((name) =>\n modifiedAxes.find((axis) => axis.name === name),\n );\n modifiedAxis.parentAxesSpec = parents.some((p) => p === undefined)\n ? []\n : (parents as AxisSpecNormalized[]);\n\n delete modifiedAxis.annotations?.[Annotation.Parents];\n }\n });\n\n if (modifiedAxes.some(hasCycleOfParents)) {\n // Axes list is broken\n modifiedAxes.forEach((axis) => {\n axis.parentAxesSpec = [];\n });\n } else {\n modifiedAxes.forEach((axis) => {\n sortParentsDeep(axis);\n });\n }\n\n return modifiedAxes;\n}\n\n/** Create list of regular axisSpec from normalized (parents are indexes, inside of current axes list) */\nexport function getDenormalizedAxesList(axesSpec: AxisSpecNormalized[]): AxisSpec[] {\n const idsList = axesSpec.map((axisSpec) => canonicalizeJson(getAxisId(axisSpec)));\n return axesSpec.map((axisSpec) => {\n const parentsIds = axisSpec.parentAxesSpec.map((axisSpec) =>\n canonicalizeJson(getAxisId(axisSpec)),\n );\n const parentIdxs = parentsIds.map((id) => idsList.indexOf(id));\n const { parentAxesSpec: _, ...copiedRest } = axisSpec;\n if (parentIdxs.length) {\n return { ...copiedRest, parentAxes: parentIdxs } as AxisSpec;\n }\n return copiedRest;\n });\n}\n\n/** Common type representing spec for all the axes in a column */\nexport type AxesSpec = AxisSpec[];\n\n/// Well-known column names\nexport const PColumnName = {\n Label: \"pl7.app/label\",\n Table: {\n RowSelection: \"pl7.app/table/row-selection\",\n },\n VDJ: {\n LeadSelection: \"pl7.app/vdj/lead-selection\",\n RankingOrder: \"pl7.app/vdj/ranking-order\",\n Sequence: \"pl7.app/vdj/sequence\",\n },\n} as const;\n\n/// Well-known axis names\nexport const PAxisName = {\n SampleId: \"pl7.app/sampleId\",\n VDJ: {\n Assay: {\n SequenceId: \"pl7.app/vdj/assay/sequenceId\",\n },\n ClusterId: \"pl7.app/vdj/clusterId\",\n ClonotypeKey: \"pl7.app/vdj/clonotypeKey\",\n ScClonotypeKey: \"pl7.app/vdj/scClonotypeKey\",\n },\n} as const;\n\nexport function isLabelColumn(column: PColumnSpec) {\n return column.axesSpec.length === 1 && column.name === PColumnName.Label;\n}\n\n/**\n * Full column specification including all axes specs and specs of the column\n * itself.\n *\n * A PColumn in its essence represents a mapping from a fixed size, explicitly\n * typed tuple to an explicitly typed value.\n *\n * (axis1Value1, axis2Value1, ...) -> columnValue\n *\n * Each element in tuple correspond to the axis having the same index in axesSpec.\n */\nexport type PUniversalColumnSpec = PObjectSpec & {\n /** Defines specific type of BObject, the most generic type of unit of\n * information in Platforma Project. */\n readonly kind: \"PColumn\";\n\n /** Type of column values */\n readonly valueType: string;\n\n /** Column name */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional column identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** Any additional information attached to the column that does not affect its\n * identifier */\n readonly annotations?: Record<string, string>;\n\n /** A list of zero-based indices of parent axes from the {@link axesSpec} array. */\n readonly parentAxes?: number[];\n\n /** Axes specifications */\n readonly axesSpec: AxesSpec;\n};\n\n/**\n * Specification of a data column.\n *\n * Data column is a specialized type of PColumn that stores only simple values (strings and numbers)\n * addressed by multiple keys. This is in contrast to other PColumn variants that can store more complex\n * values like files or other abstract data types. Data columns are optimized for storing and processing\n * basic tabular data.\n */\nexport type PDataColumnSpec = PUniversalColumnSpec & {\n /** Type of column values */\n readonly valueType: ValueType;\n};\n\n// @todo: change this to PUniversalColumnSpec\nexport type PColumnSpec = PDataColumnSpec;\n\n/** Unique PColumnSpec identifier */\nexport type PColumnSpecId = {\n /** Defines specific type of BObject, the most generic type of unit of\n * information in Platforma Project. */\n readonly kind: \"PColumn\";\n\n /** Type of column values */\n readonly valueType: ValueType;\n\n /** Column name */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional column identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** A list of zero-based indices of parent axes from the {@link axesSpec} array. */\n readonly parentAxes?: number[];\n\n /** Axes id */\n readonly axesId: AxesId;\n};\n\nexport function getPColumnSpecId(spec: PColumnSpec): PColumnSpecId {\n return {\n kind: spec.kind,\n valueType: spec.valueType,\n name: spec.name,\n domain: spec.domain,\n contextDomain: spec.contextDomain,\n parentAxes: spec.parentAxes,\n axesId: getAxesId(spec.axesSpec),\n };\n}\n\nexport interface PColumn<Data> extends PObject<Data> {\n /** PColumn spec, allowing it to be found among other PObjects */\n readonly spec: PColumnSpec;\n}\n\nexport type PColumnLazy<T> = PColumn<() => T>;\n\n/** Columns in a PFrame also have internal identifier, this object represents\n * combination of specs and such id */\nexport interface PColumnIdAndSpec {\n /** Internal column id within the PFrame */\n readonly columnId: PObjectId;\n\n /** Column spec */\n readonly spec: PColumnSpec;\n}\n\n/** Get column id and spec from a column */\nexport function getColumnIdAndSpec<Data>(column: PColumn<Data>): PColumnIdAndSpec {\n return {\n columnId: column.id,\n spec: column.spec,\n };\n}\n\n/** Information returned by {@link PFrame.listColumns} method */\nexport interface PColumnInfo extends PColumnIdAndSpec {\n /** True if data was associated with this PColumn */\n readonly hasData: boolean;\n}\n\nexport interface AxisId {\n /** Type of the axis or column value. For an axis should not use non-key\n * types like float or double. */\n readonly type: ValueType;\n\n /** Name of the axis or column */\n readonly name: string;\n\n /** Adds auxiliary information to the axis or column name and type to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional axis identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n}\n\n/** Array of axis ids */\nexport type AxesId = AxisId[];\n\n/** Extracts axis ids from axis spec */\nexport function getAxisId(spec: AxisSpec): AxisId {\n const { type, name, domain, contextDomain } = spec;\n const result: AxisId = { type, name };\n if (domain && Object.entries(domain).length > 0) {\n Object.assign(result, { domain });\n }\n if (contextDomain && Object.entries(contextDomain).length > 0) {\n Object.assign(result, { contextDomain });\n }\n return result;\n}\n\n/** Extracts axes ids from axes spec array from column spec */\nexport function getAxesId(spec: AxesSpec): AxesId {\n return spec.map(getAxisId);\n}\n\n/** Canonicalizes axis id */\nexport function canonicalizeAxisId(id: AxisId): CanonicalizedJson<AxisId> {\n return canonicalizeJson(getAxisId(id));\n}\n\n/** Returns true if all domains from query are found in target */\nfunction matchDomain(query?: Record<string, string>, target?: Record<string, string>) {\n if (query === undefined) return target === undefined;\n if (target === undefined) return true;\n for (const k in target) {\n if (query[k] !== target[k]) return false;\n }\n return true;\n}\n\n/** Returns whether \"match\" axis id is compatible with the \"query\" */\nexport function matchAxisId(query: AxisId, target: AxisId): boolean {\n return (\n query.name === target.name &&\n matchDomain(query.domain, target.domain) &&\n matchDomain(query.contextDomain, target.contextDomain)\n );\n}\n\nexport function getTypeFromPColumnOrAxisSpec(spec: PColumnSpec | AxisSpec): ValueType {\n return \"valueType\" in spec ? spec.valueType : spec.type;\n}\n\nexport function isAxisId(id: unknown): id is AxisId {\n return typeof id === \"object\" && id !== null && \"name\" in id && \"type\" in id;\n}\n"],"mappings":";;;;;;AAKA,MAAa,YAAY;CACvB,KAAK;CACL,MAAM;CACN,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,OAAO;CACR;AAUD,SAAgB,aACd,UACA,KACkB;AAClB,QAAQ,WAA6B;;AAUvC,SAAgB,wBACd,UACA,cACA,KACA,oBAA4B,2BACa;CACzC,MAAM,OAAO,aAAmB,UAAU,IAAI;AAC9C,KAAI,SAAS,OAAW,QAAO;CAE/B,MAAM,SAAS,aAAa;AAC5B,KAAI;EACF,MAAM,QAAQ,KAAK,MAAM,KAAK;AAC9B,SAAO,OAAO,MAAM,MAAM;UACnB,OAAgB;AACvB,QAAM,IAAI,MACR,GAAG,kBAAkB,gBACX,OAAO,IAAI,CAAC,WACV,KAAK,WACLA,2BAAY,MAAM,GAC/B;;;AAIL,SAAgB,iBACd,UACA,cACA,KACyC;AACzC,KAAI;AACF,SAAO,wBAAwB,UAAU,cAAc,IAAI;SACrD;AACN;;;AAKJ,MAAa,SAAS;CACpB,UAAU;CACV,SAAS;CACT,KAAK;EACH,YAAY,EACV,SAAS,kCACV;EACD,kBAAkB,EAChB,OAAO,sCACR;EACF;CACF;AAUD,MAAa,aAAyB,EAAE;AAGxC,SAAgB,WACd,MACA,KACuB;AACvB,QAAO,aAAwB,MAAM,QAAQ,IAAI;;AAInD,SAAgB,sBACd,MACA,KACoC;AACpC,QAAO,wBAAmC,MAAM,QAAQ,YAAY,KAAK,wBAAwB;;AAInG,SAAgB,eACd,MACA,KACoC;AACpC,QAAO,iBAA4B,MAAM,QAAQ,YAAY,IAAI;;AAInE,MAAa,aAAa;CACxB,YAAY;CACZ,UAAU;CACV,aAAa;CACb,gBAAgB;CAChB,QAAQ;CACR,OAAO;EACL,MAAM;GACJ,iBAAiB;GACjB,YAAY;GACZ,gBAAgB;GAChB,YAAY;GACb;EACD,aAAa;EACb,WAAW;EACX,SAAS;EACT,YAAY;EACZ,qBAAqB;EACtB;CACD,gBAAgB;CAChB,oBAAoB;CACpB,kBAAkB;CAClB,UAAU;CACV,gBAAgB;CAChB,SAAS;CACT,UAAU;CACV,OAAO;CACP,KAAK;CACL,KAAK;CACL,cAAc;CACd,SAAS;CACT,OAAO;EACL,eAAe;EACf,cAAc;EACf;CACD,UAAU;EACR,YAAY,EACV,SAAS,uCACV;EACD,cAAc;EACf;CACD,OAAO;EACL,YAAY;EACZ,eAAe;EACf,YAAY;EACb;CACD,OAAO;CACP,KAAK;EACH,qBAAqB;EACrB,gBAAgB;EACjB;CACF;AA0DD,MAAM,kBAAkBC,MAAE,KAAK;CAAC;CAAO;CAAQ;CAAS;CAAU;CAAS,CAAU;AACrF,MAAa,iBAAiC;EAC3C,WAAW,iBAAiBA,MAAE,MAAMA,MAAE,QAAQ,CAAC,CAAC,GAAGA,MAAE,MAAMA,MAAE,QAAQ,CAAC,CAAC;EACvE,WAAW,MAAM,KAAK,kBAAkBA,MAAE,SAAS;EACnD,WAAW,MAAM,KAAK,aAAaA,MAAE,QAAQ;EAC7C,WAAW,MAAM,KAAK,aAAaA,MAAE,QAAQ;EAC7C,WAAW,MAAM,KAAK,iBAAiBA,MAAE,SAAS;EAClD,WAAW,MAAM,cAAcA,MAAE,SAAS;EAC1C,WAAW,MAAM,UAAUA,MAAE,OAAO;EAAE,SAASA,MAAE,OAAOA,MAAE,QAAQ,CAAC;EAAE,MAAMA,MAAE,QAAQ;EAAE,CAAC;EACxF,WAAW,MAAM,aAAaA,MAAE,MAC/BA,MAAE,OAAO;EACP,UAAUA,MAAE,OAAO;GAAE,WAAW;GAAiB,MAAMA,MAAE,QAAQ;GAAE,CAAC;EACpE,OAAOA,MAAE,QAAQ;EAClB,CAAC,CACH;EACA,WAAW,MAAM,sBAAsBA,MAAE,QAAQ;EACjD,WAAW,MAAM,YAAYA,MAAE,SAAS;EACxC,WAAW,iBAAiBA,MAAE,SAAS;EACvC,WAAW,qBAAqBA,MAAE,SAAS;EAC3C,WAAW,mBAAmBA,MAAE,SAAS;EACzC,WAAW,iBAAiBA,MAAE,SAAS;EACvC,WAAW,WAAWA,MAAE,SAAS;EACjC,WAAW,MAAMA,MAAE,QAAQ;EAC3B,WAAW,MAAMA,MAAE,QAAQ;EAC3B,WAAW,eAAeA,MAAE,MAAMA,MAAE,QAAQ,CAAC;EAC7C,WAAW,UAAUA,MAAE,MAAMA,MAAE,QAAQ,CAAC;EACxC,WAAW,SAAS,WAAW,UAAUA,MAAE,OAAOA,MAAE,QAAQ,EAAEA,MAAE,QAAQ,CAAC;EACzE,WAAW,SAAS,eAAeA,MAAE,SAAS;EAC9C,WAAW,MAAM,gBAAgBA,MAAE,QAAQ;EAC3C,WAAW,QAAQA,MAAE,OAAOA,MAAE,QAAQ,EAAEA,MAAE,SAAS,CAAC;EACpD,WAAW,IAAI,sBAAsBA,MAAE,SAAS;CAClD;AAGD,SAAgB,eACd,MACA,KAC2B;AAC3B,QAAO,aAA4B,MAAM,aAAa,IAAI;;AAI5D,SAAgB,0BACd,MACA,KACwC;AACxC,QAAO,wBACL,MAAM,aACN,gBACA,KACA,4BACD;;AAIH,SAAgB,mBACd,MACA,KACwC;AACxC,QAAO,iBAAgC,MAAM,aAAa,gBAAgB,IAAI;;AAGhF,SAAgB,eAAe,QAA8B;AAC3D,QAAO,CAAC,CAAC,mBAAmB,QAAQ,WAAW,eAAe;;AA8DhE,SAAS,aAAa,MAAoC;AACxD,QAAO;EAAE;EAAM,UAAU,EAAE;EAAE;;;AAI/B,SAAgB,YAAY,UAAwC;CAClE,MAAM,OAAO,aAAa,SAAS;CACnC,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAwB,EAAE;AAChC,OAAK,MAAM,QAAQ,QAAQ;AACzB,QAAK,WAAW,KAAK,KAAK,eAAe,IAAI,aAAa;AAC1D,aAAU,KAAK,GAAG,KAAK,SAAS;;AAElC,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,mBAAmB,MAAgD;CACjF,MAAM,MAAM,IAAI,IAAI,CAACC,8BAAiB,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC;CAC7D,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAY,EAAE;AACpB,OAAK,MAAM,QAAQ,OACjB,MAAK,MAAM,UAAU,KAAK,UAAU;AAClC,OAAI,IAAIA,8BAAiB,UAAU,OAAO,KAAK,CAAC,CAAC;AACjD,aAAU,KAAK,OAAO;;AAG1B,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,qBAAqB,MAAsC;CACzE,MAAM,MAAM,CAAC,KAAK,KAAK;CACvB,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAY,EAAE;AACpB,OAAK,MAAM,QAAQ,OACjB,MAAK,MAAM,UAAU,KAAK,UAAU;AAClC,OAAI,KAAK,OAAO,KAAK;AACrB,aAAU,KAAK,OAAO;;AAG1B,WAAS;;AAEX,QAAO;;AAGT,SAAgB,4BAA4B,MAA0B;AACpE,QAAOA,8BAAiB,qBAAqB,YAAY,KAAK,CAAC,CAAC,IAAI,UAAU,CAAC;;AAGjF,SAAS,0BACP,OACA,OACY;AACZ,KAAI,MAAM,SAAS,MAAM,KACvB,QAAO,MAAM,OAAO,MAAM,OAAO,IAAI;AAEvC,KAAI,MAAM,SAAS,MAAM,KACvB,QAAO,MAAM,OAAO,MAAM,OAAO,IAAI;CAEvC,MAAM,UAAUA,8BAAiB,MAAM,UAAU,EAAE,CAAC;CACpD,MAAM,UAAUA,8BAAiB,MAAM,UAAU,EAAE,CAAC;AACpD,KAAI,YAAY,QACd,QAAO,UAAU,UAAU,IAAI;CAGjC,MAAM,iBAAiBA,8BAAiB,MAAM,iBAAiB,EAAE,CAAC;CAClE,MAAM,iBAAiBA,8BAAiB,MAAM,iBAAiB,EAAE,CAAC;AAClE,KAAI,mBAAmB,eACrB,QAAO,iBAAiB,iBAAiB,IAAI;CAG/C,MAAM,WAAW,4BAA4B,MAAM;CACnD,MAAM,WAAW,4BAA4B,MAAM;AAEnD,KAAI,aAAa,SACf,QAAO,WAAW,WAAW,IAAI;CAGnC,MAAM,cAAcA,8BAAiB,MAAM,eAAe,EAAE,CAAC;CAC7D,MAAM,cAAcA,8BAAiB,MAAM,eAAe,EAAE,CAAC;AAC7D,KAAI,gBAAgB,YAClB,QAAO,cAAc,cAAc,IAAI;AAEzC,QAAO;;AAGT,SAAS,4BAA4B,MAAgB;CACnD,MAAM,cAAc,mBAAmB,MAAM,WAAW,QAAQ;AAChE,KAAI,gBAAgB,OAClB,QAAO,EAAE;AAEX,QAAO;;AAGT,SAAS,gBAAgB,UAA8B;AACrD,UAAS,eAAe,QAAQ,gBAAgB;AAChD,UAAS,eAAe,KAAK,0BAA0B;;AAGzD,SAAS,kBAAkB,UAA8B;CAEvD,IAAI,SAAS,CADA,aAAa,SAAS,CAChB;CACnB,MAAM,YAAY,IAAI,IAAIA,8BAAiB,UAAU,SAAS,CAAC,CAAC;AAChE,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAwB,EAAE;EAChC,MAAM,2BAAW,IAAI,KAAgC;AACrD,OAAK,MAAM,QAAQ,QAAQ;AACzB,QAAK,WAAW,KAAK,KAAK,eAAe,IAAI,aAAa;AAC1D,QAAK,MAAM,SAAS,KAAK,UAAU;IACjC,MAAM,UAAUA,8BAAiB,UAAU,MAAM,KAAK,CAAC;AACvD,QAAI,CAAC,SAAS,IAAI,QAAQ,EAAE;AAC1B,eAAU,KAAK,MAAM;AACrB,cAAS,IAAI,QAAQ;AACrB,SAAI,UAAU,IAAI,QAAQ,CACxB,QAAO;AAET,eAAU,IAAI,QAAQ;;;;AAI5B,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,sBAAsB,MAAwC;AAC5E,KAAI,CAAC,KAAK,OACR,QAAO,EAAE;CAEX,MAAM,eAAqC,KAAK,KAAK,SAAS;EAC5D,MAAM,EAAE,YAAY,GAAG,GAAG,eAAe;AACzC,SAAO;GAAE,GAAG;GAAY,aAAa,EAAE,GAAG,WAAW,aAAa;GAAE,gBAAgB,EAAE;GAAE;GACxF;AAEF,MAAK,SAAS,MAAM,QAAQ;EAC1B,MAAM,eAAe,aAAa;AAClC,MAAI,KAAK,WAEP,cAAa,iBAAiB,KAAK,WAAW,KAAK,QAAQ,aAAa,KAAK;OACxE;GAEL,MAAM,UAAU,4BAA4B,KAAK,CAAC,KAAK,SACrD,aAAa,MAAM,SAAS,KAAK,SAAS,KAAK,CAChD;AACD,gBAAa,iBAAiB,QAAQ,MAAM,MAAM,MAAM,OAAU,GAC9D,EAAE,GACD;AAEL,UAAO,aAAa,cAAc,WAAW;;GAE/C;AAEF,KAAI,aAAa,KAAK,kBAAkB,CAEtC,cAAa,SAAS,SAAS;AAC7B,OAAK,iBAAiB,EAAE;GACxB;KAEF,cAAa,SAAS,SAAS;AAC7B,kBAAgB,KAAK;GACrB;AAGJ,QAAO;;;AAIT,SAAgB,wBAAwB,UAA4C;CAClF,MAAM,UAAU,SAAS,KAAK,aAAaA,8BAAiB,UAAU,SAAS,CAAC,CAAC;AACjF,QAAO,SAAS,KAAK,aAAa;EAIhC,MAAM,aAHa,SAAS,eAAe,KAAK,aAC9CA,8BAAiB,UAAU,SAAS,CAAC,CACtC,CAC6B,KAAK,OAAO,QAAQ,QAAQ,GAAG,CAAC;EAC9D,MAAM,EAAE,gBAAgB,GAAG,GAAG,eAAe;AAC7C,MAAI,WAAW,OACb,QAAO;GAAE,GAAG;GAAY,YAAY;GAAY;AAElD,SAAO;GACP;;AAOJ,MAAa,cAAc;CACzB,OAAO;CACP,OAAO,EACL,cAAc,+BACf;CACD,KAAK;EACH,eAAe;EACf,cAAc;EACd,UAAU;EACX;CACF;AAGD,MAAa,YAAY;CACvB,UAAU;CACV,KAAK;EACH,OAAO,EACL,YAAY,gCACb;EACD,WAAW;EACX,cAAc;EACd,gBAAgB;EACjB;CACF;AAED,SAAgB,cAAc,QAAqB;AACjD,QAAO,OAAO,SAAS,WAAW,KAAK,OAAO,SAAS,YAAY;;AAuFrE,SAAgB,iBAAiB,MAAkC;AACjE,QAAO;EACL,MAAM,KAAK;EACX,WAAW,KAAK;EAChB,MAAM,KAAK;EACX,QAAQ,KAAK;EACb,eAAe,KAAK;EACpB,YAAY,KAAK;EACjB,QAAQ,UAAU,KAAK,SAAS;EACjC;;;AAqBH,SAAgB,mBAAyB,QAAyC;AAChF,QAAO;EACL,UAAU,OAAO;EACjB,MAAM,OAAO;EACd;;;AA8BH,SAAgB,UAAU,MAAwB;CAChD,MAAM,EAAE,MAAM,MAAM,QAAQ,kBAAkB;CAC9C,MAAM,SAAiB;EAAE;EAAM;EAAM;AACrC,KAAI,UAAU,OAAO,QAAQ,OAAO,CAAC,SAAS,EAC5C,QAAO,OAAO,QAAQ,EAAE,QAAQ,CAAC;AAEnC,KAAI,iBAAiB,OAAO,QAAQ,cAAc,CAAC,SAAS,EAC1D,QAAO,OAAO,QAAQ,EAAE,eAAe,CAAC;AAE1C,QAAO;;;AAIT,SAAgB,UAAU,MAAwB;AAChD,QAAO,KAAK,IAAI,UAAU;;;AAI5B,SAAgB,mBAAmB,IAAuC;AACxE,QAAOA,8BAAiB,UAAU,GAAG,CAAC;;;AAIxC,SAAS,YAAY,OAAgC,QAAiC;AACpF,KAAI,UAAU,OAAW,QAAO,WAAW;AAC3C,KAAI,WAAW,OAAW,QAAO;AACjC,MAAK,MAAM,KAAK,OACd,KAAI,MAAM,OAAO,OAAO,GAAI,QAAO;AAErC,QAAO;;;AAIT,SAAgB,YAAY,OAAe,QAAyB;AAClE,QACE,MAAM,SAAS,OAAO,QACtB,YAAY,MAAM,QAAQ,OAAO,OAAO,IACxC,YAAY,MAAM,eAAe,OAAO,cAAc;;AAI1D,SAAgB,6BAA6B,MAAyC;AACpF,QAAO,eAAe,OAAO,KAAK,YAAY,KAAK;;AAGrD,SAAgB,SAAS,IAA2B;AAClD,QAAO,OAAO,OAAO,YAAY,OAAO,QAAQ,UAAU,MAAM,UAAU"}
1
+ {"version":3,"file":"spec.cjs","names":["ensureError","z","canonicalizeJson"],"sources":["../../../../src/drivers/pframe/spec/spec.ts"],"sourcesContent":["import { ensureError } from \"../../../errors\";\nimport { canonicalizeJson, type CanonicalizedJson, type StringifiedJson } from \"../../../json\";\nimport type { PObject, PObjectId, PObjectSpec } from \"../../../pool\";\nimport { z } from \"zod\";\n\nexport const ValueType = {\n Int: \"Int\",\n Long: \"Long\",\n Float: \"Float\",\n Double: \"Double\",\n String: \"String\",\n Bytes: \"Bytes\",\n} as const;\n\nexport type AxisValueType = Extract<ValueType, \"Int\" | \"Long\" | \"String\">;\nexport type ColumnValueType = ValueType;\n\n/** PFrame columns and axes within them may store one of these types. */\nexport type ValueType = (typeof ValueType)[keyof typeof ValueType];\n\nexport type Metadata = Record<string, string>;\n\nexport function readMetadata<U extends Metadata, T extends keyof U = keyof U>(\n metadata: Metadata | undefined,\n key: T,\n): U[T] | undefined {\n return (metadata as U | undefined)?.[key];\n}\n\ntype MetadataJsonImpl<M> = {\n [P in keyof M as M[P] extends StringifiedJson ? P : never]: M[P] extends StringifiedJson<infer U>\n ? z.ZodType<U>\n : never;\n};\nexport type MetadataJson<M> = MetadataJsonImpl<Required<M>>;\n\nexport function readMetadataJsonOrThrow<M extends Metadata, T extends keyof MetadataJson<M>>(\n metadata: Metadata | undefined,\n metadataJson: MetadataJson<M>,\n key: T,\n methodNameInError: string = \"readMetadataJsonOrThrow\",\n): z.infer<MetadataJson<M>[T]> | undefined {\n const json = readMetadata<M, T>(metadata, key);\n if (json === undefined) return undefined;\n\n const schema = metadataJson[key];\n try {\n const value = JSON.parse(json);\n return schema.parse(value);\n } catch (error: unknown) {\n throw new Error(\n `${methodNameInError} failed, ` +\n `key: ${String(key)}, ` +\n `value: ${json}, ` +\n `error: ${ensureError(error)}`,\n );\n }\n}\n\nexport function readMetadataJson<M extends Metadata, T extends keyof MetadataJson<M>>(\n metadata: Metadata | undefined,\n metadataJson: MetadataJson<M>,\n key: T,\n): z.infer<MetadataJson<M>[T]> | undefined {\n try {\n return readMetadataJsonOrThrow(metadata, metadataJson, key);\n } catch {\n return undefined; // treat invalid values as unset\n }\n}\n\n/// Well-known domains\nexport const Domain = {\n Alphabet: \"pl7.app/alphabet\",\n BlockId: \"pl7.app/blockId\",\n VDJ: {\n Clustering: {\n BlockId: \"pl7.app/vdj/clustering/blockId\",\n },\n ScClonotypeChain: {\n Index: \"pl7.app/vdj/scClonotypeChain/index\",\n },\n },\n} as const;\n\nexport type Domain = Metadata &\n Partial<{\n [Domain.Alphabet]: \"nucleotide\" | \"aminoacid\" | (string & {});\n [Domain.BlockId]: string;\n [Domain.VDJ.ScClonotypeChain.Index]: \"primary\" | \"secondary\" | (string & {});\n }>;\n\nexport type DomainJson = MetadataJson<Domain>;\nexport const DomainJson: DomainJson = {};\n\n/// Helper function for reading plain domain values\nexport function readDomain<T extends keyof Domain>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): Domain[T] | undefined {\n return readMetadata<Domain, T>(spec?.domain, key);\n}\n\n/// Helper function for reading json-encoded domain values, throws on JSON parsing error\nexport function readDomainJsonOrThrow<T extends keyof DomainJson>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<DomainJson[T]> | undefined {\n return readMetadataJsonOrThrow<Domain, T>(spec?.domain, DomainJson, key, \"readDomainJsonOrThrow\");\n}\n\n/// Helper function for reading json-encoded domain values, returns undefined on JSON parsing error\nexport function readDomainJson<T extends keyof DomainJson>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<DomainJson[T]> | undefined {\n return readMetadataJson<Domain, T>(spec?.domain, DomainJson, key);\n}\n\n/// Well-known annotations\nexport const Annotation = {\n AxisNature: \"pl7.app/axisNature\",\n Alphabet: \"pl7.app/alphabet\",\n Description: \"pl7.app/description\",\n DiscreteValues: \"pl7.app/discreteValues\",\n Format: \"pl7.app/format\",\n Graph: {\n Axis: {\n HighCardinality: \"pl7.app/graph/axis/highCardinality\",\n LowerLimit: \"pl7.app/graph/axis/lowerLimit\",\n SymmetricRange: \"pl7.app/graph/axis/symmetricRange\",\n UpperLimit: \"pl7.app/graph/axis/upperLimit\",\n },\n IsDenseAxis: \"pl7.app/graph/isDenseAxis\",\n IsVirtual: \"pl7.app/graph/isVirtual\",\n Palette: \"pl7.app/graph/palette\",\n Thresholds: \"pl7.app/graph/thresholds\",\n TreatAbsentValuesAs: \"pl7.app/graph/treatAbsentValuesAs\",\n },\n HideDataFromUi: \"pl7.app/hideDataFromUi\",\n HideDataFromGraphs: \"pl7.app/hideDataFromGraphs\",\n IsDiscreteFilter: \"pl7.app/isDiscreteFilter\",\n IsAnchor: \"pl7.app/isAnchor\",\n IsLinkerColumn: \"pl7.app/isLinkerColumn\",\n IsScore: \"pl7.app/isScore\",\n IsSubset: \"pl7.app/isSubset\",\n Label: \"pl7.app/label\",\n Max: \"pl7.app/max\",\n Min: \"pl7.app/min\",\n MultipliesBy: \"pl7.app/multipliesBy\",\n Parents: \"pl7.app/parents\",\n Score: {\n DefaultCutoff: \"pl7.app/score/defaultCutoff\",\n RankingOrder: \"pl7.app/score/rankingOrder\",\n },\n Sequence: {\n Annotation: {\n Mapping: \"pl7.app/sequence/annotation/mapping\",\n },\n IsAnnotation: \"pl7.app/sequence/isAnnotation\",\n },\n Table: {\n FontFamily: \"pl7.app/table/fontFamily\",\n OrderPriority: \"pl7.app/table/orderPriority\",\n Visibility: \"pl7.app/table/visibility\",\n },\n Trace: \"pl7.app/trace\",\n VDJ: {\n IsAssemblingFeature: \"pl7.app/vdj/isAssemblingFeature\",\n IsMainSequence: \"pl7.app/vdj/isMainSequence\",\n },\n} as const;\n\nexport type Annotation = Metadata &\n Partial<{\n [Annotation.Alphabet]: \"nucleotide\" | \"aminoacid\" | (string & {});\n [Annotation.AxisNature]: \"homogeneous\" | \"heterogeneous\" | \"scaleCompatible\" | (string & {});\n [Annotation.Description]: string;\n [Annotation.DiscreteValues]: StringifiedJson<number[]> | StringifiedJson<string[]>;\n [Annotation.Format]: string;\n [Annotation.Graph.Axis.HighCardinality]: StringifiedJson<boolean>;\n [Annotation.Graph.Axis.LowerLimit]: StringifiedJson<number>;\n [Annotation.Graph.Axis.SymmetricRange]: StringifiedJson<boolean>;\n [Annotation.Graph.Axis.UpperLimit]: StringifiedJson<number>;\n [Annotation.Graph.IsDenseAxis]: StringifiedJson<boolean>;\n [Annotation.Graph.IsVirtual]: StringifiedJson<boolean>;\n [Annotation.Graph.Palette]: StringifiedJson<{ mapping: Record<string, number>; name: string }>;\n [Annotation.Graph.Thresholds]: StringifiedJson<\n { columnId: { valueType: ValueType; name: string }; value: number }[]\n >;\n [Annotation.Graph.TreatAbsentValuesAs]: StringifiedJson<number>;\n [Annotation.HideDataFromGraphs]: StringifiedJson<boolean>;\n [Annotation.HideDataFromUi]: StringifiedJson<boolean>;\n [Annotation.IsDiscreteFilter]: StringifiedJson<boolean>;\n [Annotation.IsLinkerColumn]: StringifiedJson<boolean>;\n [Annotation.IsSubset]: StringifiedJson<boolean>;\n [Annotation.Label]: string;\n [Annotation.Max]: StringifiedJson<number>;\n [Annotation.Min]: StringifiedJson<number>;\n [Annotation.MultipliesBy]: StringifiedJson<AxisSpec[\"name\"][]>;\n [Annotation.Parents]: StringifiedJson<AxisSpec[\"name\"][]>;\n [Annotation.Sequence.Annotation.Mapping]: StringifiedJson<Record<string, string>>;\n [Annotation.Sequence.IsAnnotation]: StringifiedJson<boolean>;\n [Annotation.Table.FontFamily]: string;\n [Annotation.Table.OrderPriority]: StringifiedJson<number>;\n [Annotation.Table.Visibility]: \"hidden\" | \"optional\" | (string & {});\n [Annotation.Trace]: StringifiedJson<Record<string, unknown>>;\n [Annotation.VDJ.IsAssemblingFeature]: StringifiedJson<boolean>;\n }>;\n\n// export const AxisSpec = z.object({\n// type: z.nativeEnum(ValueType),\n// name: z.string(),\n// domain: z.record(z.string(), z.string()).optional(),\n// annotations: z.record(z.string(), z.string()).optional(),\n// parentAxes: z.array(z.number()).optional(),\n// }).passthrough();\n//\n// type Expect<T extends true> = T;\n// type Equal<X, Y> =\n// (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;\n//\n// type _test = Expect<Equal<\n// Readonly<z.infer<typeof AxisSpec>>,\n// Readonly<AxisSpec & Record<string, unknown>>\n// >>;\n\nexport type AnnotationJson = MetadataJson<Annotation>;\n\nconst ValueTypeSchema = z.enum([\"Int\", \"Long\", \"Float\", \"Double\", \"String\"] as const);\nexport const AnnotationJson: AnnotationJson = {\n [Annotation.DiscreteValues]: z.array(z.string()).or(z.array(z.number())),\n [Annotation.Graph.Axis.HighCardinality]: z.boolean(),\n [Annotation.Graph.Axis.LowerLimit]: z.number(),\n [Annotation.Graph.Axis.UpperLimit]: z.number(),\n [Annotation.Graph.Axis.SymmetricRange]: z.boolean(),\n [Annotation.Graph.IsDenseAxis]: z.boolean(),\n [Annotation.Graph.Palette]: z.object({ mapping: z.record(z.number()), name: z.string() }),\n [Annotation.Graph.Thresholds]: z.array(\n z.object({\n columnId: z.object({ valueType: ValueTypeSchema, name: z.string() }),\n value: z.number(),\n }),\n ),\n [Annotation.Graph.TreatAbsentValuesAs]: z.number(),\n [Annotation.Graph.IsVirtual]: z.boolean(),\n [Annotation.HideDataFromUi]: z.boolean(),\n [Annotation.HideDataFromGraphs]: z.boolean(),\n [Annotation.IsDiscreteFilter]: z.boolean(),\n [Annotation.IsLinkerColumn]: z.boolean(),\n [Annotation.IsSubset]: z.boolean(),\n [Annotation.Max]: z.number(),\n [Annotation.Min]: z.number(),\n [Annotation.MultipliesBy]: z.array(z.string()),\n [Annotation.Parents]: z.array(z.string()),\n [Annotation.Sequence.Annotation.Mapping]: z.record(z.string(), z.string()),\n [Annotation.Sequence.IsAnnotation]: z.boolean(),\n [Annotation.Table.OrderPriority]: z.number(),\n [Annotation.Trace]: z.record(z.string(), z.unknown()),\n [Annotation.VDJ.IsAssemblingFeature]: z.boolean(),\n};\n\n/// Helper function for reading plain annotation values\nexport function readAnnotation<T extends keyof Annotation>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): Annotation[T] | undefined {\n return readMetadata<Annotation, T>(spec?.annotations, key);\n}\n\n/// Helper function for reading json-encoded annotation values, throws on JSON parsing error\nexport function readAnnotationJsonOrThrow<T extends keyof AnnotationJson>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<AnnotationJson[T]> | undefined {\n return readMetadataJsonOrThrow<Annotation, T>(\n spec?.annotations,\n AnnotationJson,\n key,\n \"readAnnotationJsonOrThrow\",\n );\n}\n\n/// Helper function for reading json-encoded annotation values, returns undefined on JSON parsing error\nexport function readAnnotationJson<T extends keyof AnnotationJson>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<AnnotationJson[T]> | undefined {\n return readMetadataJson<Annotation, T>(spec?.annotations, AnnotationJson, key);\n}\n\nexport function isLinkerColumn(column: PColumnSpec): boolean {\n return !!readAnnotationJson(column, Annotation.IsLinkerColumn);\n}\n\n/**\n * Specification of an individual axis.\n *\n * Each axis is a part of a composite key that addresses data inside the PColumn.\n *\n * Each record inside a PColumn is addressed by a unique tuple of values set for\n * all the axes specified in the column spec.\n */\nexport type AxisSpec = {\n /** Type of the axis value. Should not use non-key types like float or double. */\n readonly type: AxisValueType;\n\n /** Name of the axis */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional axis identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** Any additional information attached to the axis that does not affect its\n * identifier */\n readonly annotations?: Record<string, string>;\n\n /**\n * Parent axes provide contextual grouping for the axis in question, establishing\n * a hierarchy where the current axis is dependent on one or more axes for its\n * full definition and meaning. For instance, in a data structure where each\n * \"container\" axis may contain multiple \"item\" axes, the `item` axis would\n * list the index of the `container` axis in this field to denote its dependency.\n *\n * This means that the identity or significance of the `item` axis is only\n * interpretable when combined with its parent `container` axis. An `item` axis\n * index by itself may be non-unique and only gains uniqueness within the context\n * of its parent `container`. Therefore, the `parentAxes` field is essential for\n * mapping these relationships and ensuring data coherence across nested or\n * multi-level data models.\n *\n * A list of zero-based indices of parent axes in the overall axes specification\n * from the column spec. Each index corresponds to the position of a parent axis\n * in the list that defines the structure of the data model.\n */\n readonly parentAxes?: number[];\n};\n\n/** Parents are specs, not indexes; normalized axis can be used considering its parents independently from column */\nexport interface AxisSpecNormalized extends Omit<AxisSpec, \"parentAxes\"> {\n parentAxesSpec: AxisSpecNormalized[];\n}\n\n/** Tree: axis is a root, its parents are children */\nexport type AxisTree = {\n axis: AxisSpecNormalized;\n children: AxisTree[]; // parents\n};\n\nfunction makeAxisTree(axis: AxisSpecNormalized): AxisTree {\n return { axis, children: [] };\n}\n\n/** Build tree by axis parents annotations */\nexport function getAxesTree(rootAxis: AxisSpecNormalized): AxisTree {\n const root = makeAxisTree(rootAxis);\n let nodesQ = [root];\n while (nodesQ.length) {\n const nextNodes: AxisTree[] = [];\n for (const node of nodesQ) {\n node.children = node.axis.parentAxesSpec.map(makeAxisTree);\n nextNodes.push(...node.children);\n }\n nodesQ = nextNodes;\n }\n return root;\n}\n\n/** Get set of canonicalized axisIds from axisTree */\nexport function getSetFromAxisTree(tree: AxisTree): Set<CanonicalizedJson<AxisId>> {\n const set = new Set([canonicalizeJson(getAxisId(tree.axis))]);\n let nodesQ = [tree];\n while (nodesQ.length) {\n const nextNodes = [];\n for (const node of nodesQ) {\n for (const parent of node.children) {\n set.add(canonicalizeJson(getAxisId(parent.axis)));\n nextNodes.push(parent);\n }\n }\n nodesQ = nextNodes;\n }\n return set;\n}\n\n/** Get array of axisSpecs from axisTree */\nexport function getArrayFromAxisTree(tree: AxisTree): AxisSpecNormalized[] {\n const res = [tree.axis];\n let nodesQ = [tree];\n while (nodesQ.length) {\n const nextNodes = [];\n for (const node of nodesQ) {\n for (const parent of node.children) {\n res.push(parent.axis);\n nextNodes.push(parent);\n }\n }\n nodesQ = nextNodes;\n }\n return res;\n}\n\nexport function canonicalizeAxisWithParents(axis: AxisSpecNormalized) {\n return canonicalizeJson(getArrayFromAxisTree(getAxesTree(axis)).map(getAxisId));\n}\n\nfunction normalizingAxesComparator(\n axis1: AxisSpecNormalized,\n axis2: AxisSpecNormalized,\n): 1 | -1 | 0 {\n if (axis1.name !== axis2.name) {\n return axis1.name < axis2.name ? 1 : -1;\n }\n if (axis1.type !== axis2.type) {\n return axis1.type < axis2.type ? 1 : -1;\n }\n const domain1 = canonicalizeJson(axis1.domain ?? {});\n const domain2 = canonicalizeJson(axis2.domain ?? {});\n if (domain1 !== domain2) {\n return domain1 < domain2 ? 1 : -1;\n }\n\n const contextDomain1 = canonicalizeJson(axis1.contextDomain ?? {});\n const contextDomain2 = canonicalizeJson(axis2.contextDomain ?? {});\n if (contextDomain1 !== contextDomain2) {\n return contextDomain1 < contextDomain2 ? 1 : -1;\n }\n\n const parents1 = canonicalizeAxisWithParents(axis1);\n const parents2 = canonicalizeAxisWithParents(axis2);\n\n if (parents1 !== parents2) {\n return parents1 < parents2 ? 1 : -1;\n }\n\n const annotation1 = canonicalizeJson(axis1.annotations ?? {});\n const annotation2 = canonicalizeJson(axis2.annotations ?? {});\n if (annotation1 !== annotation2) {\n return annotation1 < annotation2 ? 1 : -1;\n }\n return 0;\n}\n\nfunction parseParentsFromAnnotations(axis: AxisSpec) {\n const parentsList = readAnnotationJson(axis, Annotation.Parents);\n if (parentsList === undefined) {\n return [];\n }\n return parentsList;\n}\n\nfunction sortParentsDeep(axisSpec: AxisSpecNormalized) {\n axisSpec.parentAxesSpec.forEach(sortParentsDeep);\n axisSpec.parentAxesSpec.sort(normalizingAxesComparator);\n}\n\nfunction hasCycleOfParents(axisSpec: AxisSpecNormalized) {\n const root = makeAxisTree(axisSpec);\n let nodesQ = [root];\n const ancestors = new Set(canonicalizeJson(getAxisId(axisSpec)));\n while (nodesQ.length) {\n const nextNodes: AxisTree[] = [];\n const levelIds = new Set<CanonicalizedJson<AxisId>>();\n for (const node of nodesQ) {\n node.children = node.axis.parentAxesSpec.map(makeAxisTree);\n for (const child of node.children) {\n const childId = canonicalizeJson(getAxisId(child.axis));\n if (!levelIds.has(childId)) {\n nextNodes.push(child);\n levelIds.add(childId);\n if (ancestors.has(childId)) {\n return true;\n }\n ancestors.add(childId);\n }\n }\n }\n nodesQ = nextNodes;\n }\n return false;\n}\n\n/** Create list of normalized axisSpec (parents are in array of specs, not indexes) */\nexport function getNormalizedAxesList(axes: AxisSpec[]): AxisSpecNormalized[] {\n if (!axes.length) {\n return [];\n }\n const modifiedAxes: AxisSpecNormalized[] = axes.map((axis) => {\n const { parentAxes: _, ...copiedRest } = axis;\n return { ...copiedRest, annotations: { ...copiedRest.annotations }, parentAxesSpec: [] };\n });\n\n axes.forEach((axis, idx) => {\n const modifiedAxis = modifiedAxes[idx];\n if (axis.parentAxes) {\n // if we have parents by indexes then take from the list\n modifiedAxis.parentAxesSpec = axis.parentAxes.map((idx) => modifiedAxes[idx]);\n } else {\n // else try to parse from annotation name\n const parents = parseParentsFromAnnotations(axis).map((name) =>\n modifiedAxes.find((axis) => axis.name === name),\n );\n modifiedAxis.parentAxesSpec = parents.some((p) => p === undefined)\n ? []\n : (parents as AxisSpecNormalized[]);\n\n delete modifiedAxis.annotations?.[Annotation.Parents];\n }\n });\n\n if (modifiedAxes.some(hasCycleOfParents)) {\n // Axes list is broken\n modifiedAxes.forEach((axis) => {\n axis.parentAxesSpec = [];\n });\n } else {\n modifiedAxes.forEach((axis) => {\n sortParentsDeep(axis);\n });\n }\n\n return modifiedAxes;\n}\n\n/** Create list of regular axisSpec from normalized (parents are indexes, inside of current axes list) */\nexport function getDenormalizedAxesList(axesSpec: AxisSpecNormalized[]): AxisSpec[] {\n const idsList = axesSpec.map((axisSpec) => canonicalizeJson(getAxisId(axisSpec)));\n return axesSpec.map((axisSpec) => {\n const parentsIds = axisSpec.parentAxesSpec.map((axisSpec) =>\n canonicalizeJson(getAxisId(axisSpec)),\n );\n const parentIdxs = parentsIds.map((id) => idsList.indexOf(id));\n const { parentAxesSpec: _, ...copiedRest } = axisSpec;\n if (parentIdxs.length) {\n return { ...copiedRest, parentAxes: parentIdxs } as AxisSpec;\n }\n return copiedRest;\n });\n}\n\n/** Common type representing spec for all the axes in a column */\nexport type AxesSpec = AxisSpec[];\n\n/// Well-known column names\nexport const PColumnName = {\n Label: \"pl7.app/label\",\n Table: {\n RowSelection: \"pl7.app/table/row-selection\",\n },\n VDJ: {\n LeadSelection: \"pl7.app/vdj/lead-selection\",\n RankingOrder: \"pl7.app/vdj/ranking-order\",\n Sequence: \"pl7.app/vdj/sequence\",\n },\n} as const;\n\n/// Well-known axis names\nexport const PAxisName = {\n SampleId: \"pl7.app/sampleId\",\n VDJ: {\n Assay: {\n SequenceId: \"pl7.app/vdj/assay/sequenceId\",\n },\n ClusterId: \"pl7.app/vdj/clusterId\",\n ClonotypeKey: \"pl7.app/vdj/clonotypeKey\",\n ScClonotypeKey: \"pl7.app/vdj/scClonotypeKey\",\n },\n} as const;\n\nexport function isLabelColumn(column: PColumnSpec) {\n return column.axesSpec.length === 1 && column.name === PColumnName.Label;\n}\n\n/**\n * Full column specification including all axes specs and specs of the column\n * itself.\n *\n * A PColumn in its essence represents a mapping from a fixed size, explicitly\n * typed tuple to an explicitly typed value.\n *\n * (axis1Value1, axis2Value1, ...) -> columnValue\n *\n * Each element in tuple correspond to the axis having the same index in axesSpec.\n */\nexport type PUniversalColumnSpec = PObjectSpec & {\n /** Defines specific type of BObject, the most generic type of unit of\n * information in Platforma Project. */\n readonly kind: \"PColumn\";\n\n /** Type of column values */\n readonly valueType: string;\n\n /** Column name */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional column identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** Any additional information attached to the column that does not affect its\n * identifier */\n readonly annotations?: Record<string, string>;\n\n /** A list of zero-based indices of parent axes from the {@link axesSpec} array. */\n readonly parentAxes?: number[];\n\n /** Axes specifications */\n readonly axesSpec: AxesSpec;\n};\n\n/**\n * Specification of a data column.\n *\n * Data column is a specialized type of PColumn that stores only simple values (strings and numbers)\n * addressed by multiple keys. This is in contrast to other PColumn variants that can store more complex\n * values like files or other abstract data types. Data columns are optimized for storing and processing\n * basic tabular data.\n */\nexport type PDataColumnSpec = PUniversalColumnSpec & {\n /** Type of column values */\n readonly valueType: ValueType;\n};\n\n// @todo: change this to PUniversalColumnSpec\nexport type PColumnSpec = PDataColumnSpec;\n\n/** Unique PColumnSpec identifier */\nexport type PColumnSpecId = {\n /** Defines specific type of BObject, the most generic type of unit of\n * information in Platforma Project. */\n readonly kind: \"PColumn\";\n\n /** Type of column values */\n readonly valueType: ValueType;\n\n /** Column name */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional column identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** A list of zero-based indices of parent axes from the {@link axesSpec} array. */\n readonly parentAxes?: number[];\n\n /** Axes id */\n readonly axesId: AxesId;\n};\n\nexport function getPColumnSpecId(spec: PColumnSpec): PColumnSpecId {\n return {\n kind: spec.kind,\n valueType: spec.valueType,\n name: spec.name,\n domain: spec.domain,\n contextDomain: spec.contextDomain,\n parentAxes: spec.parentAxes,\n axesId: getAxesId(spec.axesSpec),\n };\n}\n\nexport interface PColumn<Data> extends PObject<Data> {\n /** PColumn spec, allowing it to be found among other PObjects */\n readonly spec: PColumnSpec;\n}\n\nexport type PColumnLazy<T> = PColumn<() => T>;\n\n/** Columns in a PFrame also have internal identifier, this object represents\n * combination of specs and such id */\nexport interface PColumnIdAndSpec {\n /** Internal column id within the PFrame */\n readonly columnId: PObjectId;\n\n /** Column spec */\n readonly spec: PColumnSpec;\n}\n\n/** Get column id and spec from a column */\nexport function getColumnIdAndSpec<Data>(column: PColumn<Data>): PColumnIdAndSpec {\n return {\n columnId: column.id,\n spec: column.spec,\n };\n}\n\n/** Information returned by {@link PFrame.listColumns} method */\nexport interface PColumnInfo extends PColumnIdAndSpec {\n /** True if data was associated with this PColumn */\n readonly hasData: boolean;\n}\n\nexport interface AxisId {\n /** Type of the axis or column value. For an axis should not use non-key\n * types like float or double. */\n readonly type: AxisValueType;\n\n /** Name of the axis or column */\n readonly name: string;\n\n /** Adds auxiliary information to the axis or column name and type to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional axis identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n}\n\n/** Array of axis ids */\nexport type AxesId = AxisId[];\n\n/** Extracts axis ids from axis spec */\nexport function getAxisId(spec: AxisSpec): AxisId {\n const { type, name, domain, contextDomain } = spec;\n const result: AxisId = { type, name };\n if (domain && Object.entries(domain).length > 0) {\n Object.assign(result, { domain });\n }\n if (contextDomain && Object.entries(contextDomain).length > 0) {\n Object.assign(result, { contextDomain });\n }\n return result;\n}\n\n/** Extracts axes ids from axes spec array from column spec */\nexport function getAxesId(spec: AxesSpec): AxesId {\n return spec.map(getAxisId);\n}\n\n/** Canonicalizes axis id */\nexport function canonicalizeAxisId(id: AxisId): CanonicalizedJson<AxisId> {\n return canonicalizeJson(getAxisId(id));\n}\n\n/** Returns true if all domains from query are found in target */\nfunction matchDomain(query?: Record<string, string>, target?: Record<string, string>) {\n if (query === undefined) return target === undefined;\n if (target === undefined) return true;\n for (const k in target) {\n if (query[k] !== target[k]) return false;\n }\n return true;\n}\n\n/** Returns whether \"match\" axis id is compatible with the \"query\" */\nexport function matchAxisId(query: AxisId, target: AxisId): boolean {\n return (\n query.name === target.name &&\n matchDomain(query.domain, target.domain) &&\n matchDomain(query.contextDomain, target.contextDomain)\n );\n}\n\nexport function getTypeFromPColumnOrAxisSpec(spec: PColumnSpec | AxisSpec): ValueType {\n return \"valueType\" in spec ? spec.valueType : spec.type;\n}\n\nexport function isAxisId(id: unknown): id is AxisId {\n return typeof id === \"object\" && id !== null && \"name\" in id && \"type\" in id;\n}\n"],"mappings":";;;;;;AAKA,MAAa,YAAY;CACvB,KAAK;CACL,MAAM;CACN,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,OAAO;CACR;AAUD,SAAgB,aACd,UACA,KACkB;AAClB,QAAQ,WAA6B;;AAUvC,SAAgB,wBACd,UACA,cACA,KACA,oBAA4B,2BACa;CACzC,MAAM,OAAO,aAAmB,UAAU,IAAI;AAC9C,KAAI,SAAS,OAAW,QAAO;CAE/B,MAAM,SAAS,aAAa;AAC5B,KAAI;EACF,MAAM,QAAQ,KAAK,MAAM,KAAK;AAC9B,SAAO,OAAO,MAAM,MAAM;UACnB,OAAgB;AACvB,QAAM,IAAI,MACR,GAAG,kBAAkB,gBACX,OAAO,IAAI,CAAC,WACV,KAAK,WACLA,2BAAY,MAAM,GAC/B;;;AAIL,SAAgB,iBACd,UACA,cACA,KACyC;AACzC,KAAI;AACF,SAAO,wBAAwB,UAAU,cAAc,IAAI;SACrD;AACN;;;AAKJ,MAAa,SAAS;CACpB,UAAU;CACV,SAAS;CACT,KAAK;EACH,YAAY,EACV,SAAS,kCACV;EACD,kBAAkB,EAChB,OAAO,sCACR;EACF;CACF;AAUD,MAAa,aAAyB,EAAE;AAGxC,SAAgB,WACd,MACA,KACuB;AACvB,QAAO,aAAwB,MAAM,QAAQ,IAAI;;AAInD,SAAgB,sBACd,MACA,KACoC;AACpC,QAAO,wBAAmC,MAAM,QAAQ,YAAY,KAAK,wBAAwB;;AAInG,SAAgB,eACd,MACA,KACoC;AACpC,QAAO,iBAA4B,MAAM,QAAQ,YAAY,IAAI;;AAInE,MAAa,aAAa;CACxB,YAAY;CACZ,UAAU;CACV,aAAa;CACb,gBAAgB;CAChB,QAAQ;CACR,OAAO;EACL,MAAM;GACJ,iBAAiB;GACjB,YAAY;GACZ,gBAAgB;GAChB,YAAY;GACb;EACD,aAAa;EACb,WAAW;EACX,SAAS;EACT,YAAY;EACZ,qBAAqB;EACtB;CACD,gBAAgB;CAChB,oBAAoB;CACpB,kBAAkB;CAClB,UAAU;CACV,gBAAgB;CAChB,SAAS;CACT,UAAU;CACV,OAAO;CACP,KAAK;CACL,KAAK;CACL,cAAc;CACd,SAAS;CACT,OAAO;EACL,eAAe;EACf,cAAc;EACf;CACD,UAAU;EACR,YAAY,EACV,SAAS,uCACV;EACD,cAAc;EACf;CACD,OAAO;EACL,YAAY;EACZ,eAAe;EACf,YAAY;EACb;CACD,OAAO;CACP,KAAK;EACH,qBAAqB;EACrB,gBAAgB;EACjB;CACF;AA0DD,MAAM,kBAAkBC,MAAE,KAAK;CAAC;CAAO;CAAQ;CAAS;CAAU;CAAS,CAAU;AACrF,MAAa,iBAAiC;EAC3C,WAAW,iBAAiBA,MAAE,MAAMA,MAAE,QAAQ,CAAC,CAAC,GAAGA,MAAE,MAAMA,MAAE,QAAQ,CAAC,CAAC;EACvE,WAAW,MAAM,KAAK,kBAAkBA,MAAE,SAAS;EACnD,WAAW,MAAM,KAAK,aAAaA,MAAE,QAAQ;EAC7C,WAAW,MAAM,KAAK,aAAaA,MAAE,QAAQ;EAC7C,WAAW,MAAM,KAAK,iBAAiBA,MAAE,SAAS;EAClD,WAAW,MAAM,cAAcA,MAAE,SAAS;EAC1C,WAAW,MAAM,UAAUA,MAAE,OAAO;EAAE,SAASA,MAAE,OAAOA,MAAE,QAAQ,CAAC;EAAE,MAAMA,MAAE,QAAQ;EAAE,CAAC;EACxF,WAAW,MAAM,aAAaA,MAAE,MAC/BA,MAAE,OAAO;EACP,UAAUA,MAAE,OAAO;GAAE,WAAW;GAAiB,MAAMA,MAAE,QAAQ;GAAE,CAAC;EACpE,OAAOA,MAAE,QAAQ;EAClB,CAAC,CACH;EACA,WAAW,MAAM,sBAAsBA,MAAE,QAAQ;EACjD,WAAW,MAAM,YAAYA,MAAE,SAAS;EACxC,WAAW,iBAAiBA,MAAE,SAAS;EACvC,WAAW,qBAAqBA,MAAE,SAAS;EAC3C,WAAW,mBAAmBA,MAAE,SAAS;EACzC,WAAW,iBAAiBA,MAAE,SAAS;EACvC,WAAW,WAAWA,MAAE,SAAS;EACjC,WAAW,MAAMA,MAAE,QAAQ;EAC3B,WAAW,MAAMA,MAAE,QAAQ;EAC3B,WAAW,eAAeA,MAAE,MAAMA,MAAE,QAAQ,CAAC;EAC7C,WAAW,UAAUA,MAAE,MAAMA,MAAE,QAAQ,CAAC;EACxC,WAAW,SAAS,WAAW,UAAUA,MAAE,OAAOA,MAAE,QAAQ,EAAEA,MAAE,QAAQ,CAAC;EACzE,WAAW,SAAS,eAAeA,MAAE,SAAS;EAC9C,WAAW,MAAM,gBAAgBA,MAAE,QAAQ;EAC3C,WAAW,QAAQA,MAAE,OAAOA,MAAE,QAAQ,EAAEA,MAAE,SAAS,CAAC;EACpD,WAAW,IAAI,sBAAsBA,MAAE,SAAS;CAClD;AAGD,SAAgB,eACd,MACA,KAC2B;AAC3B,QAAO,aAA4B,MAAM,aAAa,IAAI;;AAI5D,SAAgB,0BACd,MACA,KACwC;AACxC,QAAO,wBACL,MAAM,aACN,gBACA,KACA,4BACD;;AAIH,SAAgB,mBACd,MACA,KACwC;AACxC,QAAO,iBAAgC,MAAM,aAAa,gBAAgB,IAAI;;AAGhF,SAAgB,eAAe,QAA8B;AAC3D,QAAO,CAAC,CAAC,mBAAmB,QAAQ,WAAW,eAAe;;AA8DhE,SAAS,aAAa,MAAoC;AACxD,QAAO;EAAE;EAAM,UAAU,EAAE;EAAE;;;AAI/B,SAAgB,YAAY,UAAwC;CAClE,MAAM,OAAO,aAAa,SAAS;CACnC,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAwB,EAAE;AAChC,OAAK,MAAM,QAAQ,QAAQ;AACzB,QAAK,WAAW,KAAK,KAAK,eAAe,IAAI,aAAa;AAC1D,aAAU,KAAK,GAAG,KAAK,SAAS;;AAElC,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,mBAAmB,MAAgD;CACjF,MAAM,MAAM,IAAI,IAAI,CAACC,8BAAiB,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC;CAC7D,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAY,EAAE;AACpB,OAAK,MAAM,QAAQ,OACjB,MAAK,MAAM,UAAU,KAAK,UAAU;AAClC,OAAI,IAAIA,8BAAiB,UAAU,OAAO,KAAK,CAAC,CAAC;AACjD,aAAU,KAAK,OAAO;;AAG1B,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,qBAAqB,MAAsC;CACzE,MAAM,MAAM,CAAC,KAAK,KAAK;CACvB,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAY,EAAE;AACpB,OAAK,MAAM,QAAQ,OACjB,MAAK,MAAM,UAAU,KAAK,UAAU;AAClC,OAAI,KAAK,OAAO,KAAK;AACrB,aAAU,KAAK,OAAO;;AAG1B,WAAS;;AAEX,QAAO;;AAGT,SAAgB,4BAA4B,MAA0B;AACpE,QAAOA,8BAAiB,qBAAqB,YAAY,KAAK,CAAC,CAAC,IAAI,UAAU,CAAC;;AAGjF,SAAS,0BACP,OACA,OACY;AACZ,KAAI,MAAM,SAAS,MAAM,KACvB,QAAO,MAAM,OAAO,MAAM,OAAO,IAAI;AAEvC,KAAI,MAAM,SAAS,MAAM,KACvB,QAAO,MAAM,OAAO,MAAM,OAAO,IAAI;CAEvC,MAAM,UAAUA,8BAAiB,MAAM,UAAU,EAAE,CAAC;CACpD,MAAM,UAAUA,8BAAiB,MAAM,UAAU,EAAE,CAAC;AACpD,KAAI,YAAY,QACd,QAAO,UAAU,UAAU,IAAI;CAGjC,MAAM,iBAAiBA,8BAAiB,MAAM,iBAAiB,EAAE,CAAC;CAClE,MAAM,iBAAiBA,8BAAiB,MAAM,iBAAiB,EAAE,CAAC;AAClE,KAAI,mBAAmB,eACrB,QAAO,iBAAiB,iBAAiB,IAAI;CAG/C,MAAM,WAAW,4BAA4B,MAAM;CACnD,MAAM,WAAW,4BAA4B,MAAM;AAEnD,KAAI,aAAa,SACf,QAAO,WAAW,WAAW,IAAI;CAGnC,MAAM,cAAcA,8BAAiB,MAAM,eAAe,EAAE,CAAC;CAC7D,MAAM,cAAcA,8BAAiB,MAAM,eAAe,EAAE,CAAC;AAC7D,KAAI,gBAAgB,YAClB,QAAO,cAAc,cAAc,IAAI;AAEzC,QAAO;;AAGT,SAAS,4BAA4B,MAAgB;CACnD,MAAM,cAAc,mBAAmB,MAAM,WAAW,QAAQ;AAChE,KAAI,gBAAgB,OAClB,QAAO,EAAE;AAEX,QAAO;;AAGT,SAAS,gBAAgB,UAA8B;AACrD,UAAS,eAAe,QAAQ,gBAAgB;AAChD,UAAS,eAAe,KAAK,0BAA0B;;AAGzD,SAAS,kBAAkB,UAA8B;CAEvD,IAAI,SAAS,CADA,aAAa,SAAS,CAChB;CACnB,MAAM,YAAY,IAAI,IAAIA,8BAAiB,UAAU,SAAS,CAAC,CAAC;AAChE,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAwB,EAAE;EAChC,MAAM,2BAAW,IAAI,KAAgC;AACrD,OAAK,MAAM,QAAQ,QAAQ;AACzB,QAAK,WAAW,KAAK,KAAK,eAAe,IAAI,aAAa;AAC1D,QAAK,MAAM,SAAS,KAAK,UAAU;IACjC,MAAM,UAAUA,8BAAiB,UAAU,MAAM,KAAK,CAAC;AACvD,QAAI,CAAC,SAAS,IAAI,QAAQ,EAAE;AAC1B,eAAU,KAAK,MAAM;AACrB,cAAS,IAAI,QAAQ;AACrB,SAAI,UAAU,IAAI,QAAQ,CACxB,QAAO;AAET,eAAU,IAAI,QAAQ;;;;AAI5B,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,sBAAsB,MAAwC;AAC5E,KAAI,CAAC,KAAK,OACR,QAAO,EAAE;CAEX,MAAM,eAAqC,KAAK,KAAK,SAAS;EAC5D,MAAM,EAAE,YAAY,GAAG,GAAG,eAAe;AACzC,SAAO;GAAE,GAAG;GAAY,aAAa,EAAE,GAAG,WAAW,aAAa;GAAE,gBAAgB,EAAE;GAAE;GACxF;AAEF,MAAK,SAAS,MAAM,QAAQ;EAC1B,MAAM,eAAe,aAAa;AAClC,MAAI,KAAK,WAEP,cAAa,iBAAiB,KAAK,WAAW,KAAK,QAAQ,aAAa,KAAK;OACxE;GAEL,MAAM,UAAU,4BAA4B,KAAK,CAAC,KAAK,SACrD,aAAa,MAAM,SAAS,KAAK,SAAS,KAAK,CAChD;AACD,gBAAa,iBAAiB,QAAQ,MAAM,MAAM,MAAM,OAAU,GAC9D,EAAE,GACD;AAEL,UAAO,aAAa,cAAc,WAAW;;GAE/C;AAEF,KAAI,aAAa,KAAK,kBAAkB,CAEtC,cAAa,SAAS,SAAS;AAC7B,OAAK,iBAAiB,EAAE;GACxB;KAEF,cAAa,SAAS,SAAS;AAC7B,kBAAgB,KAAK;GACrB;AAGJ,QAAO;;;AAIT,SAAgB,wBAAwB,UAA4C;CAClF,MAAM,UAAU,SAAS,KAAK,aAAaA,8BAAiB,UAAU,SAAS,CAAC,CAAC;AACjF,QAAO,SAAS,KAAK,aAAa;EAIhC,MAAM,aAHa,SAAS,eAAe,KAAK,aAC9CA,8BAAiB,UAAU,SAAS,CAAC,CACtC,CAC6B,KAAK,OAAO,QAAQ,QAAQ,GAAG,CAAC;EAC9D,MAAM,EAAE,gBAAgB,GAAG,GAAG,eAAe;AAC7C,MAAI,WAAW,OACb,QAAO;GAAE,GAAG;GAAY,YAAY;GAAY;AAElD,SAAO;GACP;;AAOJ,MAAa,cAAc;CACzB,OAAO;CACP,OAAO,EACL,cAAc,+BACf;CACD,KAAK;EACH,eAAe;EACf,cAAc;EACd,UAAU;EACX;CACF;AAGD,MAAa,YAAY;CACvB,UAAU;CACV,KAAK;EACH,OAAO,EACL,YAAY,gCACb;EACD,WAAW;EACX,cAAc;EACd,gBAAgB;EACjB;CACF;AAED,SAAgB,cAAc,QAAqB;AACjD,QAAO,OAAO,SAAS,WAAW,KAAK,OAAO,SAAS,YAAY;;AAuFrE,SAAgB,iBAAiB,MAAkC;AACjE,QAAO;EACL,MAAM,KAAK;EACX,WAAW,KAAK;EAChB,MAAM,KAAK;EACX,QAAQ,KAAK;EACb,eAAe,KAAK;EACpB,YAAY,KAAK;EACjB,QAAQ,UAAU,KAAK,SAAS;EACjC;;;AAqBH,SAAgB,mBAAyB,QAAyC;AAChF,QAAO;EACL,UAAU,OAAO;EACjB,MAAM,OAAO;EACd;;;AA8BH,SAAgB,UAAU,MAAwB;CAChD,MAAM,EAAE,MAAM,MAAM,QAAQ,kBAAkB;CAC9C,MAAM,SAAiB;EAAE;EAAM;EAAM;AACrC,KAAI,UAAU,OAAO,QAAQ,OAAO,CAAC,SAAS,EAC5C,QAAO,OAAO,QAAQ,EAAE,QAAQ,CAAC;AAEnC,KAAI,iBAAiB,OAAO,QAAQ,cAAc,CAAC,SAAS,EAC1D,QAAO,OAAO,QAAQ,EAAE,eAAe,CAAC;AAE1C,QAAO;;;AAIT,SAAgB,UAAU,MAAwB;AAChD,QAAO,KAAK,IAAI,UAAU;;;AAI5B,SAAgB,mBAAmB,IAAuC;AACxE,QAAOA,8BAAiB,UAAU,GAAG,CAAC;;;AAIxC,SAAS,YAAY,OAAgC,QAAiC;AACpF,KAAI,UAAU,OAAW,QAAO,WAAW;AAC3C,KAAI,WAAW,OAAW,QAAO;AACjC,MAAK,MAAM,KAAK,OACd,KAAI,MAAM,OAAO,OAAO,GAAI,QAAO;AAErC,QAAO;;;AAIT,SAAgB,YAAY,OAAe,QAAyB;AAClE,QACE,MAAM,SAAS,OAAO,QACtB,YAAY,MAAM,QAAQ,OAAO,OAAO,IACxC,YAAY,MAAM,eAAe,OAAO,cAAc;;AAI1D,SAAgB,6BAA6B,MAAyC;AACpF,QAAO,eAAe,OAAO,KAAK,YAAY,KAAK;;AAGrD,SAAgB,SAAS,IAA2B;AAClD,QAAO,OAAO,OAAO,YAAY,OAAO,QAAQ,UAAU,MAAM,UAAU"}
@@ -165,7 +165,7 @@ declare function isLinkerColumn(column: PColumnSpec): boolean;
165
165
  * all the axes specified in the column spec.
166
166
  */
167
167
  type AxisSpec = {
168
- /** Type of the axis value. Should not use non-key types like float or double. */readonly type: ValueType; /** Name of the axis */
168
+ /** Type of the axis value. Should not use non-key types like float or double. */readonly type: AxisValueType; /** Name of the axis */
169
169
  readonly name: string;
170
170
  /** Adds auxiliary information to the axis name, type and parents to form a
171
171
  * unique identifier */
@@ -324,7 +324,7 @@ interface PColumnInfo extends PColumnIdAndSpec {
324
324
  interface AxisId {
325
325
  /** Type of the axis or column value. For an axis should not use non-key
326
326
  * types like float or double. */
327
- readonly type: ValueType;
327
+ readonly type: AxisValueType;
328
328
  /** Name of the axis or column */
329
329
  readonly name: string;
330
330
  /** Adds auxiliary information to the axis or column name and type to form a
@@ -1 +1 @@
1
- {"version":3,"file":"spec.js","names":[],"sources":["../../../../src/drivers/pframe/spec/spec.ts"],"sourcesContent":["import { ensureError } from \"../../../errors\";\nimport { canonicalizeJson, type CanonicalizedJson, type StringifiedJson } from \"../../../json\";\nimport type { PObject, PObjectId, PObjectSpec } from \"../../../pool\";\nimport { z } from \"zod\";\n\nexport const ValueType = {\n Int: \"Int\",\n Long: \"Long\",\n Float: \"Float\",\n Double: \"Double\",\n String: \"String\",\n Bytes: \"Bytes\",\n} as const;\n\nexport type AxisValueType = Extract<ValueType, \"Int\" | \"Long\" | \"String\">;\nexport type ColumnValueType = ValueType;\n\n/** PFrame columns and axes within them may store one of these types. */\nexport type ValueType = (typeof ValueType)[keyof typeof ValueType];\n\nexport type Metadata = Record<string, string>;\n\nexport function readMetadata<U extends Metadata, T extends keyof U = keyof U>(\n metadata: Metadata | undefined,\n key: T,\n): U[T] | undefined {\n return (metadata as U | undefined)?.[key];\n}\n\ntype MetadataJsonImpl<M> = {\n [P in keyof M as M[P] extends StringifiedJson ? P : never]: M[P] extends StringifiedJson<infer U>\n ? z.ZodType<U>\n : never;\n};\nexport type MetadataJson<M> = MetadataJsonImpl<Required<M>>;\n\nexport function readMetadataJsonOrThrow<M extends Metadata, T extends keyof MetadataJson<M>>(\n metadata: Metadata | undefined,\n metadataJson: MetadataJson<M>,\n key: T,\n methodNameInError: string = \"readMetadataJsonOrThrow\",\n): z.infer<MetadataJson<M>[T]> | undefined {\n const json = readMetadata<M, T>(metadata, key);\n if (json === undefined) return undefined;\n\n const schema = metadataJson[key];\n try {\n const value = JSON.parse(json);\n return schema.parse(value);\n } catch (error: unknown) {\n throw new Error(\n `${methodNameInError} failed, ` +\n `key: ${String(key)}, ` +\n `value: ${json}, ` +\n `error: ${ensureError(error)}`,\n );\n }\n}\n\nexport function readMetadataJson<M extends Metadata, T extends keyof MetadataJson<M>>(\n metadata: Metadata | undefined,\n metadataJson: MetadataJson<M>,\n key: T,\n): z.infer<MetadataJson<M>[T]> | undefined {\n try {\n return readMetadataJsonOrThrow(metadata, metadataJson, key);\n } catch {\n return undefined; // treat invalid values as unset\n }\n}\n\n/// Well-known domains\nexport const Domain = {\n Alphabet: \"pl7.app/alphabet\",\n BlockId: \"pl7.app/blockId\",\n VDJ: {\n Clustering: {\n BlockId: \"pl7.app/vdj/clustering/blockId\",\n },\n ScClonotypeChain: {\n Index: \"pl7.app/vdj/scClonotypeChain/index\",\n },\n },\n} as const;\n\nexport type Domain = Metadata &\n Partial<{\n [Domain.Alphabet]: \"nucleotide\" | \"aminoacid\" | (string & {});\n [Domain.BlockId]: string;\n [Domain.VDJ.ScClonotypeChain.Index]: \"primary\" | \"secondary\" | (string & {});\n }>;\n\nexport type DomainJson = MetadataJson<Domain>;\nexport const DomainJson: DomainJson = {};\n\n/// Helper function for reading plain domain values\nexport function readDomain<T extends keyof Domain>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): Domain[T] | undefined {\n return readMetadata<Domain, T>(spec?.domain, key);\n}\n\n/// Helper function for reading json-encoded domain values, throws on JSON parsing error\nexport function readDomainJsonOrThrow<T extends keyof DomainJson>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<DomainJson[T]> | undefined {\n return readMetadataJsonOrThrow<Domain, T>(spec?.domain, DomainJson, key, \"readDomainJsonOrThrow\");\n}\n\n/// Helper function for reading json-encoded domain values, returns undefined on JSON parsing error\nexport function readDomainJson<T extends keyof DomainJson>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<DomainJson[T]> | undefined {\n return readMetadataJson<Domain, T>(spec?.domain, DomainJson, key);\n}\n\n/// Well-known annotations\nexport const Annotation = {\n AxisNature: \"pl7.app/axisNature\",\n Alphabet: \"pl7.app/alphabet\",\n Description: \"pl7.app/description\",\n DiscreteValues: \"pl7.app/discreteValues\",\n Format: \"pl7.app/format\",\n Graph: {\n Axis: {\n HighCardinality: \"pl7.app/graph/axis/highCardinality\",\n LowerLimit: \"pl7.app/graph/axis/lowerLimit\",\n SymmetricRange: \"pl7.app/graph/axis/symmetricRange\",\n UpperLimit: \"pl7.app/graph/axis/upperLimit\",\n },\n IsDenseAxis: \"pl7.app/graph/isDenseAxis\",\n IsVirtual: \"pl7.app/graph/isVirtual\",\n Palette: \"pl7.app/graph/palette\",\n Thresholds: \"pl7.app/graph/thresholds\",\n TreatAbsentValuesAs: \"pl7.app/graph/treatAbsentValuesAs\",\n },\n HideDataFromUi: \"pl7.app/hideDataFromUi\",\n HideDataFromGraphs: \"pl7.app/hideDataFromGraphs\",\n IsDiscreteFilter: \"pl7.app/isDiscreteFilter\",\n IsAnchor: \"pl7.app/isAnchor\",\n IsLinkerColumn: \"pl7.app/isLinkerColumn\",\n IsScore: \"pl7.app/isScore\",\n IsSubset: \"pl7.app/isSubset\",\n Label: \"pl7.app/label\",\n Max: \"pl7.app/max\",\n Min: \"pl7.app/min\",\n MultipliesBy: \"pl7.app/multipliesBy\",\n Parents: \"pl7.app/parents\",\n Score: {\n DefaultCutoff: \"pl7.app/score/defaultCutoff\",\n RankingOrder: \"pl7.app/score/rankingOrder\",\n },\n Sequence: {\n Annotation: {\n Mapping: \"pl7.app/sequence/annotation/mapping\",\n },\n IsAnnotation: \"pl7.app/sequence/isAnnotation\",\n },\n Table: {\n FontFamily: \"pl7.app/table/fontFamily\",\n OrderPriority: \"pl7.app/table/orderPriority\",\n Visibility: \"pl7.app/table/visibility\",\n },\n Trace: \"pl7.app/trace\",\n VDJ: {\n IsAssemblingFeature: \"pl7.app/vdj/isAssemblingFeature\",\n IsMainSequence: \"pl7.app/vdj/isMainSequence\",\n },\n} as const;\n\nexport type Annotation = Metadata &\n Partial<{\n [Annotation.Alphabet]: \"nucleotide\" | \"aminoacid\" | (string & {});\n [Annotation.AxisNature]: \"homogeneous\" | \"heterogeneous\" | \"scaleCompatible\" | (string & {});\n [Annotation.Description]: string;\n [Annotation.DiscreteValues]: StringifiedJson<number[]> | StringifiedJson<string[]>;\n [Annotation.Format]: string;\n [Annotation.Graph.Axis.HighCardinality]: StringifiedJson<boolean>;\n [Annotation.Graph.Axis.LowerLimit]: StringifiedJson<number>;\n [Annotation.Graph.Axis.SymmetricRange]: StringifiedJson<boolean>;\n [Annotation.Graph.Axis.UpperLimit]: StringifiedJson<number>;\n [Annotation.Graph.IsDenseAxis]: StringifiedJson<boolean>;\n [Annotation.Graph.IsVirtual]: StringifiedJson<boolean>;\n [Annotation.Graph.Palette]: StringifiedJson<{ mapping: Record<string, number>; name: string }>;\n [Annotation.Graph.Thresholds]: StringifiedJson<\n { columnId: { valueType: ValueType; name: string }; value: number }[]\n >;\n [Annotation.Graph.TreatAbsentValuesAs]: StringifiedJson<number>;\n [Annotation.HideDataFromGraphs]: StringifiedJson<boolean>;\n [Annotation.HideDataFromUi]: StringifiedJson<boolean>;\n [Annotation.IsDiscreteFilter]: StringifiedJson<boolean>;\n [Annotation.IsLinkerColumn]: StringifiedJson<boolean>;\n [Annotation.IsSubset]: StringifiedJson<boolean>;\n [Annotation.Label]: string;\n [Annotation.Max]: StringifiedJson<number>;\n [Annotation.Min]: StringifiedJson<number>;\n [Annotation.MultipliesBy]: StringifiedJson<AxisSpec[\"name\"][]>;\n [Annotation.Parents]: StringifiedJson<AxisSpec[\"name\"][]>;\n [Annotation.Sequence.Annotation.Mapping]: StringifiedJson<Record<string, string>>;\n [Annotation.Sequence.IsAnnotation]: StringifiedJson<boolean>;\n [Annotation.Table.FontFamily]: string;\n [Annotation.Table.OrderPriority]: StringifiedJson<number>;\n [Annotation.Table.Visibility]: \"hidden\" | \"optional\" | (string & {});\n [Annotation.Trace]: StringifiedJson<Record<string, unknown>>;\n [Annotation.VDJ.IsAssemblingFeature]: StringifiedJson<boolean>;\n }>;\n\n// export const AxisSpec = z.object({\n// type: z.nativeEnum(ValueType),\n// name: z.string(),\n// domain: z.record(z.string(), z.string()).optional(),\n// annotations: z.record(z.string(), z.string()).optional(),\n// parentAxes: z.array(z.number()).optional(),\n// }).passthrough();\n//\n// type Expect<T extends true> = T;\n// type Equal<X, Y> =\n// (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;\n//\n// type _test = Expect<Equal<\n// Readonly<z.infer<typeof AxisSpec>>,\n// Readonly<AxisSpec & Record<string, unknown>>\n// >>;\n\nexport type AnnotationJson = MetadataJson<Annotation>;\n\nconst ValueTypeSchema = z.enum([\"Int\", \"Long\", \"Float\", \"Double\", \"String\"] as const);\nexport const AnnotationJson: AnnotationJson = {\n [Annotation.DiscreteValues]: z.array(z.string()).or(z.array(z.number())),\n [Annotation.Graph.Axis.HighCardinality]: z.boolean(),\n [Annotation.Graph.Axis.LowerLimit]: z.number(),\n [Annotation.Graph.Axis.UpperLimit]: z.number(),\n [Annotation.Graph.Axis.SymmetricRange]: z.boolean(),\n [Annotation.Graph.IsDenseAxis]: z.boolean(),\n [Annotation.Graph.Palette]: z.object({ mapping: z.record(z.number()), name: z.string() }),\n [Annotation.Graph.Thresholds]: z.array(\n z.object({\n columnId: z.object({ valueType: ValueTypeSchema, name: z.string() }),\n value: z.number(),\n }),\n ),\n [Annotation.Graph.TreatAbsentValuesAs]: z.number(),\n [Annotation.Graph.IsVirtual]: z.boolean(),\n [Annotation.HideDataFromUi]: z.boolean(),\n [Annotation.HideDataFromGraphs]: z.boolean(),\n [Annotation.IsDiscreteFilter]: z.boolean(),\n [Annotation.IsLinkerColumn]: z.boolean(),\n [Annotation.IsSubset]: z.boolean(),\n [Annotation.Max]: z.number(),\n [Annotation.Min]: z.number(),\n [Annotation.MultipliesBy]: z.array(z.string()),\n [Annotation.Parents]: z.array(z.string()),\n [Annotation.Sequence.Annotation.Mapping]: z.record(z.string(), z.string()),\n [Annotation.Sequence.IsAnnotation]: z.boolean(),\n [Annotation.Table.OrderPriority]: z.number(),\n [Annotation.Trace]: z.record(z.string(), z.unknown()),\n [Annotation.VDJ.IsAssemblingFeature]: z.boolean(),\n};\n\n/// Helper function for reading plain annotation values\nexport function readAnnotation<T extends keyof Annotation>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): Annotation[T] | undefined {\n return readMetadata<Annotation, T>(spec?.annotations, key);\n}\n\n/// Helper function for reading json-encoded annotation values, throws on JSON parsing error\nexport function readAnnotationJsonOrThrow<T extends keyof AnnotationJson>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<AnnotationJson[T]> | undefined {\n return readMetadataJsonOrThrow<Annotation, T>(\n spec?.annotations,\n AnnotationJson,\n key,\n \"readAnnotationJsonOrThrow\",\n );\n}\n\n/// Helper function for reading json-encoded annotation values, returns undefined on JSON parsing error\nexport function readAnnotationJson<T extends keyof AnnotationJson>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<AnnotationJson[T]> | undefined {\n return readMetadataJson<Annotation, T>(spec?.annotations, AnnotationJson, key);\n}\n\nexport function isLinkerColumn(column: PColumnSpec): boolean {\n return !!readAnnotationJson(column, Annotation.IsLinkerColumn);\n}\n\n/**\n * Specification of an individual axis.\n *\n * Each axis is a part of a composite key that addresses data inside the PColumn.\n *\n * Each record inside a PColumn is addressed by a unique tuple of values set for\n * all the axes specified in the column spec.\n */\nexport type AxisSpec = {\n /** Type of the axis value. Should not use non-key types like float or double. */\n readonly type: ValueType;\n\n /** Name of the axis */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional axis identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** Any additional information attached to the axis that does not affect its\n * identifier */\n readonly annotations?: Record<string, string>;\n\n /**\n * Parent axes provide contextual grouping for the axis in question, establishing\n * a hierarchy where the current axis is dependent on one or more axes for its\n * full definition and meaning. For instance, in a data structure where each\n * \"container\" axis may contain multiple \"item\" axes, the `item` axis would\n * list the index of the `container` axis in this field to denote its dependency.\n *\n * This means that the identity or significance of the `item` axis is only\n * interpretable when combined with its parent `container` axis. An `item` axis\n * index by itself may be non-unique and only gains uniqueness within the context\n * of its parent `container`. Therefore, the `parentAxes` field is essential for\n * mapping these relationships and ensuring data coherence across nested or\n * multi-level data models.\n *\n * A list of zero-based indices of parent axes in the overall axes specification\n * from the column spec. Each index corresponds to the position of a parent axis\n * in the list that defines the structure of the data model.\n */\n readonly parentAxes?: number[];\n};\n\n/** Parents are specs, not indexes; normalized axis can be used considering its parents independently from column */\nexport interface AxisSpecNormalized extends Omit<AxisSpec, \"parentAxes\"> {\n parentAxesSpec: AxisSpecNormalized[];\n}\n\n/** Tree: axis is a root, its parents are children */\nexport type AxisTree = {\n axis: AxisSpecNormalized;\n children: AxisTree[]; // parents\n};\n\nfunction makeAxisTree(axis: AxisSpecNormalized): AxisTree {\n return { axis, children: [] };\n}\n\n/** Build tree by axis parents annotations */\nexport function getAxesTree(rootAxis: AxisSpecNormalized): AxisTree {\n const root = makeAxisTree(rootAxis);\n let nodesQ = [root];\n while (nodesQ.length) {\n const nextNodes: AxisTree[] = [];\n for (const node of nodesQ) {\n node.children = node.axis.parentAxesSpec.map(makeAxisTree);\n nextNodes.push(...node.children);\n }\n nodesQ = nextNodes;\n }\n return root;\n}\n\n/** Get set of canonicalized axisIds from axisTree */\nexport function getSetFromAxisTree(tree: AxisTree): Set<CanonicalizedJson<AxisId>> {\n const set = new Set([canonicalizeJson(getAxisId(tree.axis))]);\n let nodesQ = [tree];\n while (nodesQ.length) {\n const nextNodes = [];\n for (const node of nodesQ) {\n for (const parent of node.children) {\n set.add(canonicalizeJson(getAxisId(parent.axis)));\n nextNodes.push(parent);\n }\n }\n nodesQ = nextNodes;\n }\n return set;\n}\n\n/** Get array of axisSpecs from axisTree */\nexport function getArrayFromAxisTree(tree: AxisTree): AxisSpecNormalized[] {\n const res = [tree.axis];\n let nodesQ = [tree];\n while (nodesQ.length) {\n const nextNodes = [];\n for (const node of nodesQ) {\n for (const parent of node.children) {\n res.push(parent.axis);\n nextNodes.push(parent);\n }\n }\n nodesQ = nextNodes;\n }\n return res;\n}\n\nexport function canonicalizeAxisWithParents(axis: AxisSpecNormalized) {\n return canonicalizeJson(getArrayFromAxisTree(getAxesTree(axis)).map(getAxisId));\n}\n\nfunction normalizingAxesComparator(\n axis1: AxisSpecNormalized,\n axis2: AxisSpecNormalized,\n): 1 | -1 | 0 {\n if (axis1.name !== axis2.name) {\n return axis1.name < axis2.name ? 1 : -1;\n }\n if (axis1.type !== axis2.type) {\n return axis1.type < axis2.type ? 1 : -1;\n }\n const domain1 = canonicalizeJson(axis1.domain ?? {});\n const domain2 = canonicalizeJson(axis2.domain ?? {});\n if (domain1 !== domain2) {\n return domain1 < domain2 ? 1 : -1;\n }\n\n const contextDomain1 = canonicalizeJson(axis1.contextDomain ?? {});\n const contextDomain2 = canonicalizeJson(axis2.contextDomain ?? {});\n if (contextDomain1 !== contextDomain2) {\n return contextDomain1 < contextDomain2 ? 1 : -1;\n }\n\n const parents1 = canonicalizeAxisWithParents(axis1);\n const parents2 = canonicalizeAxisWithParents(axis2);\n\n if (parents1 !== parents2) {\n return parents1 < parents2 ? 1 : -1;\n }\n\n const annotation1 = canonicalizeJson(axis1.annotations ?? {});\n const annotation2 = canonicalizeJson(axis2.annotations ?? {});\n if (annotation1 !== annotation2) {\n return annotation1 < annotation2 ? 1 : -1;\n }\n return 0;\n}\n\nfunction parseParentsFromAnnotations(axis: AxisSpec) {\n const parentsList = readAnnotationJson(axis, Annotation.Parents);\n if (parentsList === undefined) {\n return [];\n }\n return parentsList;\n}\n\nfunction sortParentsDeep(axisSpec: AxisSpecNormalized) {\n axisSpec.parentAxesSpec.forEach(sortParentsDeep);\n axisSpec.parentAxesSpec.sort(normalizingAxesComparator);\n}\n\nfunction hasCycleOfParents(axisSpec: AxisSpecNormalized) {\n const root = makeAxisTree(axisSpec);\n let nodesQ = [root];\n const ancestors = new Set(canonicalizeJson(getAxisId(axisSpec)));\n while (nodesQ.length) {\n const nextNodes: AxisTree[] = [];\n const levelIds = new Set<CanonicalizedJson<AxisId>>();\n for (const node of nodesQ) {\n node.children = node.axis.parentAxesSpec.map(makeAxisTree);\n for (const child of node.children) {\n const childId = canonicalizeJson(getAxisId(child.axis));\n if (!levelIds.has(childId)) {\n nextNodes.push(child);\n levelIds.add(childId);\n if (ancestors.has(childId)) {\n return true;\n }\n ancestors.add(childId);\n }\n }\n }\n nodesQ = nextNodes;\n }\n return false;\n}\n\n/** Create list of normalized axisSpec (parents are in array of specs, not indexes) */\nexport function getNormalizedAxesList(axes: AxisSpec[]): AxisSpecNormalized[] {\n if (!axes.length) {\n return [];\n }\n const modifiedAxes: AxisSpecNormalized[] = axes.map((axis) => {\n const { parentAxes: _, ...copiedRest } = axis;\n return { ...copiedRest, annotations: { ...copiedRest.annotations }, parentAxesSpec: [] };\n });\n\n axes.forEach((axis, idx) => {\n const modifiedAxis = modifiedAxes[idx];\n if (axis.parentAxes) {\n // if we have parents by indexes then take from the list\n modifiedAxis.parentAxesSpec = axis.parentAxes.map((idx) => modifiedAxes[idx]);\n } else {\n // else try to parse from annotation name\n const parents = parseParentsFromAnnotations(axis).map((name) =>\n modifiedAxes.find((axis) => axis.name === name),\n );\n modifiedAxis.parentAxesSpec = parents.some((p) => p === undefined)\n ? []\n : (parents as AxisSpecNormalized[]);\n\n delete modifiedAxis.annotations?.[Annotation.Parents];\n }\n });\n\n if (modifiedAxes.some(hasCycleOfParents)) {\n // Axes list is broken\n modifiedAxes.forEach((axis) => {\n axis.parentAxesSpec = [];\n });\n } else {\n modifiedAxes.forEach((axis) => {\n sortParentsDeep(axis);\n });\n }\n\n return modifiedAxes;\n}\n\n/** Create list of regular axisSpec from normalized (parents are indexes, inside of current axes list) */\nexport function getDenormalizedAxesList(axesSpec: AxisSpecNormalized[]): AxisSpec[] {\n const idsList = axesSpec.map((axisSpec) => canonicalizeJson(getAxisId(axisSpec)));\n return axesSpec.map((axisSpec) => {\n const parentsIds = axisSpec.parentAxesSpec.map((axisSpec) =>\n canonicalizeJson(getAxisId(axisSpec)),\n );\n const parentIdxs = parentsIds.map((id) => idsList.indexOf(id));\n const { parentAxesSpec: _, ...copiedRest } = axisSpec;\n if (parentIdxs.length) {\n return { ...copiedRest, parentAxes: parentIdxs } as AxisSpec;\n }\n return copiedRest;\n });\n}\n\n/** Common type representing spec for all the axes in a column */\nexport type AxesSpec = AxisSpec[];\n\n/// Well-known column names\nexport const PColumnName = {\n Label: \"pl7.app/label\",\n Table: {\n RowSelection: \"pl7.app/table/row-selection\",\n },\n VDJ: {\n LeadSelection: \"pl7.app/vdj/lead-selection\",\n RankingOrder: \"pl7.app/vdj/ranking-order\",\n Sequence: \"pl7.app/vdj/sequence\",\n },\n} as const;\n\n/// Well-known axis names\nexport const PAxisName = {\n SampleId: \"pl7.app/sampleId\",\n VDJ: {\n Assay: {\n SequenceId: \"pl7.app/vdj/assay/sequenceId\",\n },\n ClusterId: \"pl7.app/vdj/clusterId\",\n ClonotypeKey: \"pl7.app/vdj/clonotypeKey\",\n ScClonotypeKey: \"pl7.app/vdj/scClonotypeKey\",\n },\n} as const;\n\nexport function isLabelColumn(column: PColumnSpec) {\n return column.axesSpec.length === 1 && column.name === PColumnName.Label;\n}\n\n/**\n * Full column specification including all axes specs and specs of the column\n * itself.\n *\n * A PColumn in its essence represents a mapping from a fixed size, explicitly\n * typed tuple to an explicitly typed value.\n *\n * (axis1Value1, axis2Value1, ...) -> columnValue\n *\n * Each element in tuple correspond to the axis having the same index in axesSpec.\n */\nexport type PUniversalColumnSpec = PObjectSpec & {\n /** Defines specific type of BObject, the most generic type of unit of\n * information in Platforma Project. */\n readonly kind: \"PColumn\";\n\n /** Type of column values */\n readonly valueType: string;\n\n /** Column name */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional column identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** Any additional information attached to the column that does not affect its\n * identifier */\n readonly annotations?: Record<string, string>;\n\n /** A list of zero-based indices of parent axes from the {@link axesSpec} array. */\n readonly parentAxes?: number[];\n\n /** Axes specifications */\n readonly axesSpec: AxesSpec;\n};\n\n/**\n * Specification of a data column.\n *\n * Data column is a specialized type of PColumn that stores only simple values (strings and numbers)\n * addressed by multiple keys. This is in contrast to other PColumn variants that can store more complex\n * values like files or other abstract data types. Data columns are optimized for storing and processing\n * basic tabular data.\n */\nexport type PDataColumnSpec = PUniversalColumnSpec & {\n /** Type of column values */\n readonly valueType: ValueType;\n};\n\n// @todo: change this to PUniversalColumnSpec\nexport type PColumnSpec = PDataColumnSpec;\n\n/** Unique PColumnSpec identifier */\nexport type PColumnSpecId = {\n /** Defines specific type of BObject, the most generic type of unit of\n * information in Platforma Project. */\n readonly kind: \"PColumn\";\n\n /** Type of column values */\n readonly valueType: ValueType;\n\n /** Column name */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional column identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** A list of zero-based indices of parent axes from the {@link axesSpec} array. */\n readonly parentAxes?: number[];\n\n /** Axes id */\n readonly axesId: AxesId;\n};\n\nexport function getPColumnSpecId(spec: PColumnSpec): PColumnSpecId {\n return {\n kind: spec.kind,\n valueType: spec.valueType,\n name: spec.name,\n domain: spec.domain,\n contextDomain: spec.contextDomain,\n parentAxes: spec.parentAxes,\n axesId: getAxesId(spec.axesSpec),\n };\n}\n\nexport interface PColumn<Data> extends PObject<Data> {\n /** PColumn spec, allowing it to be found among other PObjects */\n readonly spec: PColumnSpec;\n}\n\nexport type PColumnLazy<T> = PColumn<() => T>;\n\n/** Columns in a PFrame also have internal identifier, this object represents\n * combination of specs and such id */\nexport interface PColumnIdAndSpec {\n /** Internal column id within the PFrame */\n readonly columnId: PObjectId;\n\n /** Column spec */\n readonly spec: PColumnSpec;\n}\n\n/** Get column id and spec from a column */\nexport function getColumnIdAndSpec<Data>(column: PColumn<Data>): PColumnIdAndSpec {\n return {\n columnId: column.id,\n spec: column.spec,\n };\n}\n\n/** Information returned by {@link PFrame.listColumns} method */\nexport interface PColumnInfo extends PColumnIdAndSpec {\n /** True if data was associated with this PColumn */\n readonly hasData: boolean;\n}\n\nexport interface AxisId {\n /** Type of the axis or column value. For an axis should not use non-key\n * types like float or double. */\n readonly type: ValueType;\n\n /** Name of the axis or column */\n readonly name: string;\n\n /** Adds auxiliary information to the axis or column name and type to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional axis identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n}\n\n/** Array of axis ids */\nexport type AxesId = AxisId[];\n\n/** Extracts axis ids from axis spec */\nexport function getAxisId(spec: AxisSpec): AxisId {\n const { type, name, domain, contextDomain } = spec;\n const result: AxisId = { type, name };\n if (domain && Object.entries(domain).length > 0) {\n Object.assign(result, { domain });\n }\n if (contextDomain && Object.entries(contextDomain).length > 0) {\n Object.assign(result, { contextDomain });\n }\n return result;\n}\n\n/** Extracts axes ids from axes spec array from column spec */\nexport function getAxesId(spec: AxesSpec): AxesId {\n return spec.map(getAxisId);\n}\n\n/** Canonicalizes axis id */\nexport function canonicalizeAxisId(id: AxisId): CanonicalizedJson<AxisId> {\n return canonicalizeJson(getAxisId(id));\n}\n\n/** Returns true if all domains from query are found in target */\nfunction matchDomain(query?: Record<string, string>, target?: Record<string, string>) {\n if (query === undefined) return target === undefined;\n if (target === undefined) return true;\n for (const k in target) {\n if (query[k] !== target[k]) return false;\n }\n return true;\n}\n\n/** Returns whether \"match\" axis id is compatible with the \"query\" */\nexport function matchAxisId(query: AxisId, target: AxisId): boolean {\n return (\n query.name === target.name &&\n matchDomain(query.domain, target.domain) &&\n matchDomain(query.contextDomain, target.contextDomain)\n );\n}\n\nexport function getTypeFromPColumnOrAxisSpec(spec: PColumnSpec | AxisSpec): ValueType {\n return \"valueType\" in spec ? spec.valueType : spec.type;\n}\n\nexport function isAxisId(id: unknown): id is AxisId {\n return typeof id === \"object\" && id !== null && \"name\" in id && \"type\" in id;\n}\n"],"mappings":";;;;;AAKA,MAAa,YAAY;CACvB,KAAK;CACL,MAAM;CACN,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,OAAO;CACR;AAUD,SAAgB,aACd,UACA,KACkB;AAClB,QAAQ,WAA6B;;AAUvC,SAAgB,wBACd,UACA,cACA,KACA,oBAA4B,2BACa;CACzC,MAAM,OAAO,aAAmB,UAAU,IAAI;AAC9C,KAAI,SAAS,OAAW,QAAO;CAE/B,MAAM,SAAS,aAAa;AAC5B,KAAI;EACF,MAAM,QAAQ,KAAK,MAAM,KAAK;AAC9B,SAAO,OAAO,MAAM,MAAM;UACnB,OAAgB;AACvB,QAAM,IAAI,MACR,GAAG,kBAAkB,gBACX,OAAO,IAAI,CAAC,WACV,KAAK,WACL,YAAY,MAAM,GAC/B;;;AAIL,SAAgB,iBACd,UACA,cACA,KACyC;AACzC,KAAI;AACF,SAAO,wBAAwB,UAAU,cAAc,IAAI;SACrD;AACN;;;AAKJ,MAAa,SAAS;CACpB,UAAU;CACV,SAAS;CACT,KAAK;EACH,YAAY,EACV,SAAS,kCACV;EACD,kBAAkB,EAChB,OAAO,sCACR;EACF;CACF;AAUD,MAAa,aAAyB,EAAE;AAGxC,SAAgB,WACd,MACA,KACuB;AACvB,QAAO,aAAwB,MAAM,QAAQ,IAAI;;AAInD,SAAgB,sBACd,MACA,KACoC;AACpC,QAAO,wBAAmC,MAAM,QAAQ,YAAY,KAAK,wBAAwB;;AAInG,SAAgB,eACd,MACA,KACoC;AACpC,QAAO,iBAA4B,MAAM,QAAQ,YAAY,IAAI;;AAInE,MAAa,aAAa;CACxB,YAAY;CACZ,UAAU;CACV,aAAa;CACb,gBAAgB;CAChB,QAAQ;CACR,OAAO;EACL,MAAM;GACJ,iBAAiB;GACjB,YAAY;GACZ,gBAAgB;GAChB,YAAY;GACb;EACD,aAAa;EACb,WAAW;EACX,SAAS;EACT,YAAY;EACZ,qBAAqB;EACtB;CACD,gBAAgB;CAChB,oBAAoB;CACpB,kBAAkB;CAClB,UAAU;CACV,gBAAgB;CAChB,SAAS;CACT,UAAU;CACV,OAAO;CACP,KAAK;CACL,KAAK;CACL,cAAc;CACd,SAAS;CACT,OAAO;EACL,eAAe;EACf,cAAc;EACf;CACD,UAAU;EACR,YAAY,EACV,SAAS,uCACV;EACD,cAAc;EACf;CACD,OAAO;EACL,YAAY;EACZ,eAAe;EACf,YAAY;EACb;CACD,OAAO;CACP,KAAK;EACH,qBAAqB;EACrB,gBAAgB;EACjB;CACF;AA0DD,MAAM,kBAAkB,EAAE,KAAK;CAAC;CAAO;CAAQ;CAAS;CAAU;CAAS,CAAU;AACrF,MAAa,iBAAiC;EAC3C,WAAW,iBAAiB,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;EACvE,WAAW,MAAM,KAAK,kBAAkB,EAAE,SAAS;EACnD,WAAW,MAAM,KAAK,aAAa,EAAE,QAAQ;EAC7C,WAAW,MAAM,KAAK,aAAa,EAAE,QAAQ;EAC7C,WAAW,MAAM,KAAK,iBAAiB,EAAE,SAAS;EAClD,WAAW,MAAM,cAAc,EAAE,SAAS;EAC1C,WAAW,MAAM,UAAU,EAAE,OAAO;EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC;EAAE,MAAM,EAAE,QAAQ;EAAE,CAAC;EACxF,WAAW,MAAM,aAAa,EAAE,MAC/B,EAAE,OAAO;EACP,UAAU,EAAE,OAAO;GAAE,WAAW;GAAiB,MAAM,EAAE,QAAQ;GAAE,CAAC;EACpE,OAAO,EAAE,QAAQ;EAClB,CAAC,CACH;EACA,WAAW,MAAM,sBAAsB,EAAE,QAAQ;EACjD,WAAW,MAAM,YAAY,EAAE,SAAS;EACxC,WAAW,iBAAiB,EAAE,SAAS;EACvC,WAAW,qBAAqB,EAAE,SAAS;EAC3C,WAAW,mBAAmB,EAAE,SAAS;EACzC,WAAW,iBAAiB,EAAE,SAAS;EACvC,WAAW,WAAW,EAAE,SAAS;EACjC,WAAW,MAAM,EAAE,QAAQ;EAC3B,WAAW,MAAM,EAAE,QAAQ;EAC3B,WAAW,eAAe,EAAE,MAAM,EAAE,QAAQ,CAAC;EAC7C,WAAW,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC;EACxC,WAAW,SAAS,WAAW,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,QAAQ,CAAC;EACzE,WAAW,SAAS,eAAe,EAAE,SAAS;EAC9C,WAAW,MAAM,gBAAgB,EAAE,QAAQ;EAC3C,WAAW,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,SAAS,CAAC;EACpD,WAAW,IAAI,sBAAsB,EAAE,SAAS;CAClD;AAGD,SAAgB,eACd,MACA,KAC2B;AAC3B,QAAO,aAA4B,MAAM,aAAa,IAAI;;AAI5D,SAAgB,0BACd,MACA,KACwC;AACxC,QAAO,wBACL,MAAM,aACN,gBACA,KACA,4BACD;;AAIH,SAAgB,mBACd,MACA,KACwC;AACxC,QAAO,iBAAgC,MAAM,aAAa,gBAAgB,IAAI;;AAGhF,SAAgB,eAAe,QAA8B;AAC3D,QAAO,CAAC,CAAC,mBAAmB,QAAQ,WAAW,eAAe;;AA8DhE,SAAS,aAAa,MAAoC;AACxD,QAAO;EAAE;EAAM,UAAU,EAAE;EAAE;;;AAI/B,SAAgB,YAAY,UAAwC;CAClE,MAAM,OAAO,aAAa,SAAS;CACnC,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAwB,EAAE;AAChC,OAAK,MAAM,QAAQ,QAAQ;AACzB,QAAK,WAAW,KAAK,KAAK,eAAe,IAAI,aAAa;AAC1D,aAAU,KAAK,GAAG,KAAK,SAAS;;AAElC,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,mBAAmB,MAAgD;CACjF,MAAM,MAAM,IAAI,IAAI,CAAC,iBAAiB,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC;CAC7D,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAY,EAAE;AACpB,OAAK,MAAM,QAAQ,OACjB,MAAK,MAAM,UAAU,KAAK,UAAU;AAClC,OAAI,IAAI,iBAAiB,UAAU,OAAO,KAAK,CAAC,CAAC;AACjD,aAAU,KAAK,OAAO;;AAG1B,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,qBAAqB,MAAsC;CACzE,MAAM,MAAM,CAAC,KAAK,KAAK;CACvB,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAY,EAAE;AACpB,OAAK,MAAM,QAAQ,OACjB,MAAK,MAAM,UAAU,KAAK,UAAU;AAClC,OAAI,KAAK,OAAO,KAAK;AACrB,aAAU,KAAK,OAAO;;AAG1B,WAAS;;AAEX,QAAO;;AAGT,SAAgB,4BAA4B,MAA0B;AACpE,QAAO,iBAAiB,qBAAqB,YAAY,KAAK,CAAC,CAAC,IAAI,UAAU,CAAC;;AAGjF,SAAS,0BACP,OACA,OACY;AACZ,KAAI,MAAM,SAAS,MAAM,KACvB,QAAO,MAAM,OAAO,MAAM,OAAO,IAAI;AAEvC,KAAI,MAAM,SAAS,MAAM,KACvB,QAAO,MAAM,OAAO,MAAM,OAAO,IAAI;CAEvC,MAAM,UAAU,iBAAiB,MAAM,UAAU,EAAE,CAAC;CACpD,MAAM,UAAU,iBAAiB,MAAM,UAAU,EAAE,CAAC;AACpD,KAAI,YAAY,QACd,QAAO,UAAU,UAAU,IAAI;CAGjC,MAAM,iBAAiB,iBAAiB,MAAM,iBAAiB,EAAE,CAAC;CAClE,MAAM,iBAAiB,iBAAiB,MAAM,iBAAiB,EAAE,CAAC;AAClE,KAAI,mBAAmB,eACrB,QAAO,iBAAiB,iBAAiB,IAAI;CAG/C,MAAM,WAAW,4BAA4B,MAAM;CACnD,MAAM,WAAW,4BAA4B,MAAM;AAEnD,KAAI,aAAa,SACf,QAAO,WAAW,WAAW,IAAI;CAGnC,MAAM,cAAc,iBAAiB,MAAM,eAAe,EAAE,CAAC;CAC7D,MAAM,cAAc,iBAAiB,MAAM,eAAe,EAAE,CAAC;AAC7D,KAAI,gBAAgB,YAClB,QAAO,cAAc,cAAc,IAAI;AAEzC,QAAO;;AAGT,SAAS,4BAA4B,MAAgB;CACnD,MAAM,cAAc,mBAAmB,MAAM,WAAW,QAAQ;AAChE,KAAI,gBAAgB,OAClB,QAAO,EAAE;AAEX,QAAO;;AAGT,SAAS,gBAAgB,UAA8B;AACrD,UAAS,eAAe,QAAQ,gBAAgB;AAChD,UAAS,eAAe,KAAK,0BAA0B;;AAGzD,SAAS,kBAAkB,UAA8B;CAEvD,IAAI,SAAS,CADA,aAAa,SAAS,CAChB;CACnB,MAAM,YAAY,IAAI,IAAI,iBAAiB,UAAU,SAAS,CAAC,CAAC;AAChE,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAwB,EAAE;EAChC,MAAM,2BAAW,IAAI,KAAgC;AACrD,OAAK,MAAM,QAAQ,QAAQ;AACzB,QAAK,WAAW,KAAK,KAAK,eAAe,IAAI,aAAa;AAC1D,QAAK,MAAM,SAAS,KAAK,UAAU;IACjC,MAAM,UAAU,iBAAiB,UAAU,MAAM,KAAK,CAAC;AACvD,QAAI,CAAC,SAAS,IAAI,QAAQ,EAAE;AAC1B,eAAU,KAAK,MAAM;AACrB,cAAS,IAAI,QAAQ;AACrB,SAAI,UAAU,IAAI,QAAQ,CACxB,QAAO;AAET,eAAU,IAAI,QAAQ;;;;AAI5B,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,sBAAsB,MAAwC;AAC5E,KAAI,CAAC,KAAK,OACR,QAAO,EAAE;CAEX,MAAM,eAAqC,KAAK,KAAK,SAAS;EAC5D,MAAM,EAAE,YAAY,GAAG,GAAG,eAAe;AACzC,SAAO;GAAE,GAAG;GAAY,aAAa,EAAE,GAAG,WAAW,aAAa;GAAE,gBAAgB,EAAE;GAAE;GACxF;AAEF,MAAK,SAAS,MAAM,QAAQ;EAC1B,MAAM,eAAe,aAAa;AAClC,MAAI,KAAK,WAEP,cAAa,iBAAiB,KAAK,WAAW,KAAK,QAAQ,aAAa,KAAK;OACxE;GAEL,MAAM,UAAU,4BAA4B,KAAK,CAAC,KAAK,SACrD,aAAa,MAAM,SAAS,KAAK,SAAS,KAAK,CAChD;AACD,gBAAa,iBAAiB,QAAQ,MAAM,MAAM,MAAM,OAAU,GAC9D,EAAE,GACD;AAEL,UAAO,aAAa,cAAc,WAAW;;GAE/C;AAEF,KAAI,aAAa,KAAK,kBAAkB,CAEtC,cAAa,SAAS,SAAS;AAC7B,OAAK,iBAAiB,EAAE;GACxB;KAEF,cAAa,SAAS,SAAS;AAC7B,kBAAgB,KAAK;GACrB;AAGJ,QAAO;;;AAIT,SAAgB,wBAAwB,UAA4C;CAClF,MAAM,UAAU,SAAS,KAAK,aAAa,iBAAiB,UAAU,SAAS,CAAC,CAAC;AACjF,QAAO,SAAS,KAAK,aAAa;EAIhC,MAAM,aAHa,SAAS,eAAe,KAAK,aAC9C,iBAAiB,UAAU,SAAS,CAAC,CACtC,CAC6B,KAAK,OAAO,QAAQ,QAAQ,GAAG,CAAC;EAC9D,MAAM,EAAE,gBAAgB,GAAG,GAAG,eAAe;AAC7C,MAAI,WAAW,OACb,QAAO;GAAE,GAAG;GAAY,YAAY;GAAY;AAElD,SAAO;GACP;;AAOJ,MAAa,cAAc;CACzB,OAAO;CACP,OAAO,EACL,cAAc,+BACf;CACD,KAAK;EACH,eAAe;EACf,cAAc;EACd,UAAU;EACX;CACF;AAGD,MAAa,YAAY;CACvB,UAAU;CACV,KAAK;EACH,OAAO,EACL,YAAY,gCACb;EACD,WAAW;EACX,cAAc;EACd,gBAAgB;EACjB;CACF;AAED,SAAgB,cAAc,QAAqB;AACjD,QAAO,OAAO,SAAS,WAAW,KAAK,OAAO,SAAS,YAAY;;AAuFrE,SAAgB,iBAAiB,MAAkC;AACjE,QAAO;EACL,MAAM,KAAK;EACX,WAAW,KAAK;EAChB,MAAM,KAAK;EACX,QAAQ,KAAK;EACb,eAAe,KAAK;EACpB,YAAY,KAAK;EACjB,QAAQ,UAAU,KAAK,SAAS;EACjC;;;AAqBH,SAAgB,mBAAyB,QAAyC;AAChF,QAAO;EACL,UAAU,OAAO;EACjB,MAAM,OAAO;EACd;;;AA8BH,SAAgB,UAAU,MAAwB;CAChD,MAAM,EAAE,MAAM,MAAM,QAAQ,kBAAkB;CAC9C,MAAM,SAAiB;EAAE;EAAM;EAAM;AACrC,KAAI,UAAU,OAAO,QAAQ,OAAO,CAAC,SAAS,EAC5C,QAAO,OAAO,QAAQ,EAAE,QAAQ,CAAC;AAEnC,KAAI,iBAAiB,OAAO,QAAQ,cAAc,CAAC,SAAS,EAC1D,QAAO,OAAO,QAAQ,EAAE,eAAe,CAAC;AAE1C,QAAO;;;AAIT,SAAgB,UAAU,MAAwB;AAChD,QAAO,KAAK,IAAI,UAAU;;;AAI5B,SAAgB,mBAAmB,IAAuC;AACxE,QAAO,iBAAiB,UAAU,GAAG,CAAC;;;AAIxC,SAAS,YAAY,OAAgC,QAAiC;AACpF,KAAI,UAAU,OAAW,QAAO,WAAW;AAC3C,KAAI,WAAW,OAAW,QAAO;AACjC,MAAK,MAAM,KAAK,OACd,KAAI,MAAM,OAAO,OAAO,GAAI,QAAO;AAErC,QAAO;;;AAIT,SAAgB,YAAY,OAAe,QAAyB;AAClE,QACE,MAAM,SAAS,OAAO,QACtB,YAAY,MAAM,QAAQ,OAAO,OAAO,IACxC,YAAY,MAAM,eAAe,OAAO,cAAc;;AAI1D,SAAgB,6BAA6B,MAAyC;AACpF,QAAO,eAAe,OAAO,KAAK,YAAY,KAAK;;AAGrD,SAAgB,SAAS,IAA2B;AAClD,QAAO,OAAO,OAAO,YAAY,OAAO,QAAQ,UAAU,MAAM,UAAU"}
1
+ {"version":3,"file":"spec.js","names":[],"sources":["../../../../src/drivers/pframe/spec/spec.ts"],"sourcesContent":["import { ensureError } from \"../../../errors\";\nimport { canonicalizeJson, type CanonicalizedJson, type StringifiedJson } from \"../../../json\";\nimport type { PObject, PObjectId, PObjectSpec } from \"../../../pool\";\nimport { z } from \"zod\";\n\nexport const ValueType = {\n Int: \"Int\",\n Long: \"Long\",\n Float: \"Float\",\n Double: \"Double\",\n String: \"String\",\n Bytes: \"Bytes\",\n} as const;\n\nexport type AxisValueType = Extract<ValueType, \"Int\" | \"Long\" | \"String\">;\nexport type ColumnValueType = ValueType;\n\n/** PFrame columns and axes within them may store one of these types. */\nexport type ValueType = (typeof ValueType)[keyof typeof ValueType];\n\nexport type Metadata = Record<string, string>;\n\nexport function readMetadata<U extends Metadata, T extends keyof U = keyof U>(\n metadata: Metadata | undefined,\n key: T,\n): U[T] | undefined {\n return (metadata as U | undefined)?.[key];\n}\n\ntype MetadataJsonImpl<M> = {\n [P in keyof M as M[P] extends StringifiedJson ? P : never]: M[P] extends StringifiedJson<infer U>\n ? z.ZodType<U>\n : never;\n};\nexport type MetadataJson<M> = MetadataJsonImpl<Required<M>>;\n\nexport function readMetadataJsonOrThrow<M extends Metadata, T extends keyof MetadataJson<M>>(\n metadata: Metadata | undefined,\n metadataJson: MetadataJson<M>,\n key: T,\n methodNameInError: string = \"readMetadataJsonOrThrow\",\n): z.infer<MetadataJson<M>[T]> | undefined {\n const json = readMetadata<M, T>(metadata, key);\n if (json === undefined) return undefined;\n\n const schema = metadataJson[key];\n try {\n const value = JSON.parse(json);\n return schema.parse(value);\n } catch (error: unknown) {\n throw new Error(\n `${methodNameInError} failed, ` +\n `key: ${String(key)}, ` +\n `value: ${json}, ` +\n `error: ${ensureError(error)}`,\n );\n }\n}\n\nexport function readMetadataJson<M extends Metadata, T extends keyof MetadataJson<M>>(\n metadata: Metadata | undefined,\n metadataJson: MetadataJson<M>,\n key: T,\n): z.infer<MetadataJson<M>[T]> | undefined {\n try {\n return readMetadataJsonOrThrow(metadata, metadataJson, key);\n } catch {\n return undefined; // treat invalid values as unset\n }\n}\n\n/// Well-known domains\nexport const Domain = {\n Alphabet: \"pl7.app/alphabet\",\n BlockId: \"pl7.app/blockId\",\n VDJ: {\n Clustering: {\n BlockId: \"pl7.app/vdj/clustering/blockId\",\n },\n ScClonotypeChain: {\n Index: \"pl7.app/vdj/scClonotypeChain/index\",\n },\n },\n} as const;\n\nexport type Domain = Metadata &\n Partial<{\n [Domain.Alphabet]: \"nucleotide\" | \"aminoacid\" | (string & {});\n [Domain.BlockId]: string;\n [Domain.VDJ.ScClonotypeChain.Index]: \"primary\" | \"secondary\" | (string & {});\n }>;\n\nexport type DomainJson = MetadataJson<Domain>;\nexport const DomainJson: DomainJson = {};\n\n/// Helper function for reading plain domain values\nexport function readDomain<T extends keyof Domain>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): Domain[T] | undefined {\n return readMetadata<Domain, T>(spec?.domain, key);\n}\n\n/// Helper function for reading json-encoded domain values, throws on JSON parsing error\nexport function readDomainJsonOrThrow<T extends keyof DomainJson>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<DomainJson[T]> | undefined {\n return readMetadataJsonOrThrow<Domain, T>(spec?.domain, DomainJson, key, \"readDomainJsonOrThrow\");\n}\n\n/// Helper function for reading json-encoded domain values, returns undefined on JSON parsing error\nexport function readDomainJson<T extends keyof DomainJson>(\n spec: { domain?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<DomainJson[T]> | undefined {\n return readMetadataJson<Domain, T>(spec?.domain, DomainJson, key);\n}\n\n/// Well-known annotations\nexport const Annotation = {\n AxisNature: \"pl7.app/axisNature\",\n Alphabet: \"pl7.app/alphabet\",\n Description: \"pl7.app/description\",\n DiscreteValues: \"pl7.app/discreteValues\",\n Format: \"pl7.app/format\",\n Graph: {\n Axis: {\n HighCardinality: \"pl7.app/graph/axis/highCardinality\",\n LowerLimit: \"pl7.app/graph/axis/lowerLimit\",\n SymmetricRange: \"pl7.app/graph/axis/symmetricRange\",\n UpperLimit: \"pl7.app/graph/axis/upperLimit\",\n },\n IsDenseAxis: \"pl7.app/graph/isDenseAxis\",\n IsVirtual: \"pl7.app/graph/isVirtual\",\n Palette: \"pl7.app/graph/palette\",\n Thresholds: \"pl7.app/graph/thresholds\",\n TreatAbsentValuesAs: \"pl7.app/graph/treatAbsentValuesAs\",\n },\n HideDataFromUi: \"pl7.app/hideDataFromUi\",\n HideDataFromGraphs: \"pl7.app/hideDataFromGraphs\",\n IsDiscreteFilter: \"pl7.app/isDiscreteFilter\",\n IsAnchor: \"pl7.app/isAnchor\",\n IsLinkerColumn: \"pl7.app/isLinkerColumn\",\n IsScore: \"pl7.app/isScore\",\n IsSubset: \"pl7.app/isSubset\",\n Label: \"pl7.app/label\",\n Max: \"pl7.app/max\",\n Min: \"pl7.app/min\",\n MultipliesBy: \"pl7.app/multipliesBy\",\n Parents: \"pl7.app/parents\",\n Score: {\n DefaultCutoff: \"pl7.app/score/defaultCutoff\",\n RankingOrder: \"pl7.app/score/rankingOrder\",\n },\n Sequence: {\n Annotation: {\n Mapping: \"pl7.app/sequence/annotation/mapping\",\n },\n IsAnnotation: \"pl7.app/sequence/isAnnotation\",\n },\n Table: {\n FontFamily: \"pl7.app/table/fontFamily\",\n OrderPriority: \"pl7.app/table/orderPriority\",\n Visibility: \"pl7.app/table/visibility\",\n },\n Trace: \"pl7.app/trace\",\n VDJ: {\n IsAssemblingFeature: \"pl7.app/vdj/isAssemblingFeature\",\n IsMainSequence: \"pl7.app/vdj/isMainSequence\",\n },\n} as const;\n\nexport type Annotation = Metadata &\n Partial<{\n [Annotation.Alphabet]: \"nucleotide\" | \"aminoacid\" | (string & {});\n [Annotation.AxisNature]: \"homogeneous\" | \"heterogeneous\" | \"scaleCompatible\" | (string & {});\n [Annotation.Description]: string;\n [Annotation.DiscreteValues]: StringifiedJson<number[]> | StringifiedJson<string[]>;\n [Annotation.Format]: string;\n [Annotation.Graph.Axis.HighCardinality]: StringifiedJson<boolean>;\n [Annotation.Graph.Axis.LowerLimit]: StringifiedJson<number>;\n [Annotation.Graph.Axis.SymmetricRange]: StringifiedJson<boolean>;\n [Annotation.Graph.Axis.UpperLimit]: StringifiedJson<number>;\n [Annotation.Graph.IsDenseAxis]: StringifiedJson<boolean>;\n [Annotation.Graph.IsVirtual]: StringifiedJson<boolean>;\n [Annotation.Graph.Palette]: StringifiedJson<{ mapping: Record<string, number>; name: string }>;\n [Annotation.Graph.Thresholds]: StringifiedJson<\n { columnId: { valueType: ValueType; name: string }; value: number }[]\n >;\n [Annotation.Graph.TreatAbsentValuesAs]: StringifiedJson<number>;\n [Annotation.HideDataFromGraphs]: StringifiedJson<boolean>;\n [Annotation.HideDataFromUi]: StringifiedJson<boolean>;\n [Annotation.IsDiscreteFilter]: StringifiedJson<boolean>;\n [Annotation.IsLinkerColumn]: StringifiedJson<boolean>;\n [Annotation.IsSubset]: StringifiedJson<boolean>;\n [Annotation.Label]: string;\n [Annotation.Max]: StringifiedJson<number>;\n [Annotation.Min]: StringifiedJson<number>;\n [Annotation.MultipliesBy]: StringifiedJson<AxisSpec[\"name\"][]>;\n [Annotation.Parents]: StringifiedJson<AxisSpec[\"name\"][]>;\n [Annotation.Sequence.Annotation.Mapping]: StringifiedJson<Record<string, string>>;\n [Annotation.Sequence.IsAnnotation]: StringifiedJson<boolean>;\n [Annotation.Table.FontFamily]: string;\n [Annotation.Table.OrderPriority]: StringifiedJson<number>;\n [Annotation.Table.Visibility]: \"hidden\" | \"optional\" | (string & {});\n [Annotation.Trace]: StringifiedJson<Record<string, unknown>>;\n [Annotation.VDJ.IsAssemblingFeature]: StringifiedJson<boolean>;\n }>;\n\n// export const AxisSpec = z.object({\n// type: z.nativeEnum(ValueType),\n// name: z.string(),\n// domain: z.record(z.string(), z.string()).optional(),\n// annotations: z.record(z.string(), z.string()).optional(),\n// parentAxes: z.array(z.number()).optional(),\n// }).passthrough();\n//\n// type Expect<T extends true> = T;\n// type Equal<X, Y> =\n// (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;\n//\n// type _test = Expect<Equal<\n// Readonly<z.infer<typeof AxisSpec>>,\n// Readonly<AxisSpec & Record<string, unknown>>\n// >>;\n\nexport type AnnotationJson = MetadataJson<Annotation>;\n\nconst ValueTypeSchema = z.enum([\"Int\", \"Long\", \"Float\", \"Double\", \"String\"] as const);\nexport const AnnotationJson: AnnotationJson = {\n [Annotation.DiscreteValues]: z.array(z.string()).or(z.array(z.number())),\n [Annotation.Graph.Axis.HighCardinality]: z.boolean(),\n [Annotation.Graph.Axis.LowerLimit]: z.number(),\n [Annotation.Graph.Axis.UpperLimit]: z.number(),\n [Annotation.Graph.Axis.SymmetricRange]: z.boolean(),\n [Annotation.Graph.IsDenseAxis]: z.boolean(),\n [Annotation.Graph.Palette]: z.object({ mapping: z.record(z.number()), name: z.string() }),\n [Annotation.Graph.Thresholds]: z.array(\n z.object({\n columnId: z.object({ valueType: ValueTypeSchema, name: z.string() }),\n value: z.number(),\n }),\n ),\n [Annotation.Graph.TreatAbsentValuesAs]: z.number(),\n [Annotation.Graph.IsVirtual]: z.boolean(),\n [Annotation.HideDataFromUi]: z.boolean(),\n [Annotation.HideDataFromGraphs]: z.boolean(),\n [Annotation.IsDiscreteFilter]: z.boolean(),\n [Annotation.IsLinkerColumn]: z.boolean(),\n [Annotation.IsSubset]: z.boolean(),\n [Annotation.Max]: z.number(),\n [Annotation.Min]: z.number(),\n [Annotation.MultipliesBy]: z.array(z.string()),\n [Annotation.Parents]: z.array(z.string()),\n [Annotation.Sequence.Annotation.Mapping]: z.record(z.string(), z.string()),\n [Annotation.Sequence.IsAnnotation]: z.boolean(),\n [Annotation.Table.OrderPriority]: z.number(),\n [Annotation.Trace]: z.record(z.string(), z.unknown()),\n [Annotation.VDJ.IsAssemblingFeature]: z.boolean(),\n};\n\n/// Helper function for reading plain annotation values\nexport function readAnnotation<T extends keyof Annotation>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): Annotation[T] | undefined {\n return readMetadata<Annotation, T>(spec?.annotations, key);\n}\n\n/// Helper function for reading json-encoded annotation values, throws on JSON parsing error\nexport function readAnnotationJsonOrThrow<T extends keyof AnnotationJson>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<AnnotationJson[T]> | undefined {\n return readMetadataJsonOrThrow<Annotation, T>(\n spec?.annotations,\n AnnotationJson,\n key,\n \"readAnnotationJsonOrThrow\",\n );\n}\n\n/// Helper function for reading json-encoded annotation values, returns undefined on JSON parsing error\nexport function readAnnotationJson<T extends keyof AnnotationJson>(\n spec: { annotations?: Metadata | undefined } | undefined,\n key: T,\n): z.infer<AnnotationJson[T]> | undefined {\n return readMetadataJson<Annotation, T>(spec?.annotations, AnnotationJson, key);\n}\n\nexport function isLinkerColumn(column: PColumnSpec): boolean {\n return !!readAnnotationJson(column, Annotation.IsLinkerColumn);\n}\n\n/**\n * Specification of an individual axis.\n *\n * Each axis is a part of a composite key that addresses data inside the PColumn.\n *\n * Each record inside a PColumn is addressed by a unique tuple of values set for\n * all the axes specified in the column spec.\n */\nexport type AxisSpec = {\n /** Type of the axis value. Should not use non-key types like float or double. */\n readonly type: AxisValueType;\n\n /** Name of the axis */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional axis identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** Any additional information attached to the axis that does not affect its\n * identifier */\n readonly annotations?: Record<string, string>;\n\n /**\n * Parent axes provide contextual grouping for the axis in question, establishing\n * a hierarchy where the current axis is dependent on one or more axes for its\n * full definition and meaning. For instance, in a data structure where each\n * \"container\" axis may contain multiple \"item\" axes, the `item` axis would\n * list the index of the `container` axis in this field to denote its dependency.\n *\n * This means that the identity or significance of the `item` axis is only\n * interpretable when combined with its parent `container` axis. An `item` axis\n * index by itself may be non-unique and only gains uniqueness within the context\n * of its parent `container`. Therefore, the `parentAxes` field is essential for\n * mapping these relationships and ensuring data coherence across nested or\n * multi-level data models.\n *\n * A list of zero-based indices of parent axes in the overall axes specification\n * from the column spec. Each index corresponds to the position of a parent axis\n * in the list that defines the structure of the data model.\n */\n readonly parentAxes?: number[];\n};\n\n/** Parents are specs, not indexes; normalized axis can be used considering its parents independently from column */\nexport interface AxisSpecNormalized extends Omit<AxisSpec, \"parentAxes\"> {\n parentAxesSpec: AxisSpecNormalized[];\n}\n\n/** Tree: axis is a root, its parents are children */\nexport type AxisTree = {\n axis: AxisSpecNormalized;\n children: AxisTree[]; // parents\n};\n\nfunction makeAxisTree(axis: AxisSpecNormalized): AxisTree {\n return { axis, children: [] };\n}\n\n/** Build tree by axis parents annotations */\nexport function getAxesTree(rootAxis: AxisSpecNormalized): AxisTree {\n const root = makeAxisTree(rootAxis);\n let nodesQ = [root];\n while (nodesQ.length) {\n const nextNodes: AxisTree[] = [];\n for (const node of nodesQ) {\n node.children = node.axis.parentAxesSpec.map(makeAxisTree);\n nextNodes.push(...node.children);\n }\n nodesQ = nextNodes;\n }\n return root;\n}\n\n/** Get set of canonicalized axisIds from axisTree */\nexport function getSetFromAxisTree(tree: AxisTree): Set<CanonicalizedJson<AxisId>> {\n const set = new Set([canonicalizeJson(getAxisId(tree.axis))]);\n let nodesQ = [tree];\n while (nodesQ.length) {\n const nextNodes = [];\n for (const node of nodesQ) {\n for (const parent of node.children) {\n set.add(canonicalizeJson(getAxisId(parent.axis)));\n nextNodes.push(parent);\n }\n }\n nodesQ = nextNodes;\n }\n return set;\n}\n\n/** Get array of axisSpecs from axisTree */\nexport function getArrayFromAxisTree(tree: AxisTree): AxisSpecNormalized[] {\n const res = [tree.axis];\n let nodesQ = [tree];\n while (nodesQ.length) {\n const nextNodes = [];\n for (const node of nodesQ) {\n for (const parent of node.children) {\n res.push(parent.axis);\n nextNodes.push(parent);\n }\n }\n nodesQ = nextNodes;\n }\n return res;\n}\n\nexport function canonicalizeAxisWithParents(axis: AxisSpecNormalized) {\n return canonicalizeJson(getArrayFromAxisTree(getAxesTree(axis)).map(getAxisId));\n}\n\nfunction normalizingAxesComparator(\n axis1: AxisSpecNormalized,\n axis2: AxisSpecNormalized,\n): 1 | -1 | 0 {\n if (axis1.name !== axis2.name) {\n return axis1.name < axis2.name ? 1 : -1;\n }\n if (axis1.type !== axis2.type) {\n return axis1.type < axis2.type ? 1 : -1;\n }\n const domain1 = canonicalizeJson(axis1.domain ?? {});\n const domain2 = canonicalizeJson(axis2.domain ?? {});\n if (domain1 !== domain2) {\n return domain1 < domain2 ? 1 : -1;\n }\n\n const contextDomain1 = canonicalizeJson(axis1.contextDomain ?? {});\n const contextDomain2 = canonicalizeJson(axis2.contextDomain ?? {});\n if (contextDomain1 !== contextDomain2) {\n return contextDomain1 < contextDomain2 ? 1 : -1;\n }\n\n const parents1 = canonicalizeAxisWithParents(axis1);\n const parents2 = canonicalizeAxisWithParents(axis2);\n\n if (parents1 !== parents2) {\n return parents1 < parents2 ? 1 : -1;\n }\n\n const annotation1 = canonicalizeJson(axis1.annotations ?? {});\n const annotation2 = canonicalizeJson(axis2.annotations ?? {});\n if (annotation1 !== annotation2) {\n return annotation1 < annotation2 ? 1 : -1;\n }\n return 0;\n}\n\nfunction parseParentsFromAnnotations(axis: AxisSpec) {\n const parentsList = readAnnotationJson(axis, Annotation.Parents);\n if (parentsList === undefined) {\n return [];\n }\n return parentsList;\n}\n\nfunction sortParentsDeep(axisSpec: AxisSpecNormalized) {\n axisSpec.parentAxesSpec.forEach(sortParentsDeep);\n axisSpec.parentAxesSpec.sort(normalizingAxesComparator);\n}\n\nfunction hasCycleOfParents(axisSpec: AxisSpecNormalized) {\n const root = makeAxisTree(axisSpec);\n let nodesQ = [root];\n const ancestors = new Set(canonicalizeJson(getAxisId(axisSpec)));\n while (nodesQ.length) {\n const nextNodes: AxisTree[] = [];\n const levelIds = new Set<CanonicalizedJson<AxisId>>();\n for (const node of nodesQ) {\n node.children = node.axis.parentAxesSpec.map(makeAxisTree);\n for (const child of node.children) {\n const childId = canonicalizeJson(getAxisId(child.axis));\n if (!levelIds.has(childId)) {\n nextNodes.push(child);\n levelIds.add(childId);\n if (ancestors.has(childId)) {\n return true;\n }\n ancestors.add(childId);\n }\n }\n }\n nodesQ = nextNodes;\n }\n return false;\n}\n\n/** Create list of normalized axisSpec (parents are in array of specs, not indexes) */\nexport function getNormalizedAxesList(axes: AxisSpec[]): AxisSpecNormalized[] {\n if (!axes.length) {\n return [];\n }\n const modifiedAxes: AxisSpecNormalized[] = axes.map((axis) => {\n const { parentAxes: _, ...copiedRest } = axis;\n return { ...copiedRest, annotations: { ...copiedRest.annotations }, parentAxesSpec: [] };\n });\n\n axes.forEach((axis, idx) => {\n const modifiedAxis = modifiedAxes[idx];\n if (axis.parentAxes) {\n // if we have parents by indexes then take from the list\n modifiedAxis.parentAxesSpec = axis.parentAxes.map((idx) => modifiedAxes[idx]);\n } else {\n // else try to parse from annotation name\n const parents = parseParentsFromAnnotations(axis).map((name) =>\n modifiedAxes.find((axis) => axis.name === name),\n );\n modifiedAxis.parentAxesSpec = parents.some((p) => p === undefined)\n ? []\n : (parents as AxisSpecNormalized[]);\n\n delete modifiedAxis.annotations?.[Annotation.Parents];\n }\n });\n\n if (modifiedAxes.some(hasCycleOfParents)) {\n // Axes list is broken\n modifiedAxes.forEach((axis) => {\n axis.parentAxesSpec = [];\n });\n } else {\n modifiedAxes.forEach((axis) => {\n sortParentsDeep(axis);\n });\n }\n\n return modifiedAxes;\n}\n\n/** Create list of regular axisSpec from normalized (parents are indexes, inside of current axes list) */\nexport function getDenormalizedAxesList(axesSpec: AxisSpecNormalized[]): AxisSpec[] {\n const idsList = axesSpec.map((axisSpec) => canonicalizeJson(getAxisId(axisSpec)));\n return axesSpec.map((axisSpec) => {\n const parentsIds = axisSpec.parentAxesSpec.map((axisSpec) =>\n canonicalizeJson(getAxisId(axisSpec)),\n );\n const parentIdxs = parentsIds.map((id) => idsList.indexOf(id));\n const { parentAxesSpec: _, ...copiedRest } = axisSpec;\n if (parentIdxs.length) {\n return { ...copiedRest, parentAxes: parentIdxs } as AxisSpec;\n }\n return copiedRest;\n });\n}\n\n/** Common type representing spec for all the axes in a column */\nexport type AxesSpec = AxisSpec[];\n\n/// Well-known column names\nexport const PColumnName = {\n Label: \"pl7.app/label\",\n Table: {\n RowSelection: \"pl7.app/table/row-selection\",\n },\n VDJ: {\n LeadSelection: \"pl7.app/vdj/lead-selection\",\n RankingOrder: \"pl7.app/vdj/ranking-order\",\n Sequence: \"pl7.app/vdj/sequence\",\n },\n} as const;\n\n/// Well-known axis names\nexport const PAxisName = {\n SampleId: \"pl7.app/sampleId\",\n VDJ: {\n Assay: {\n SequenceId: \"pl7.app/vdj/assay/sequenceId\",\n },\n ClusterId: \"pl7.app/vdj/clusterId\",\n ClonotypeKey: \"pl7.app/vdj/clonotypeKey\",\n ScClonotypeKey: \"pl7.app/vdj/scClonotypeKey\",\n },\n} as const;\n\nexport function isLabelColumn(column: PColumnSpec) {\n return column.axesSpec.length === 1 && column.name === PColumnName.Label;\n}\n\n/**\n * Full column specification including all axes specs and specs of the column\n * itself.\n *\n * A PColumn in its essence represents a mapping from a fixed size, explicitly\n * typed tuple to an explicitly typed value.\n *\n * (axis1Value1, axis2Value1, ...) -> columnValue\n *\n * Each element in tuple correspond to the axis having the same index in axesSpec.\n */\nexport type PUniversalColumnSpec = PObjectSpec & {\n /** Defines specific type of BObject, the most generic type of unit of\n * information in Platforma Project. */\n readonly kind: \"PColumn\";\n\n /** Type of column values */\n readonly valueType: string;\n\n /** Column name */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional column identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** Any additional information attached to the column that does not affect its\n * identifier */\n readonly annotations?: Record<string, string>;\n\n /** A list of zero-based indices of parent axes from the {@link axesSpec} array. */\n readonly parentAxes?: number[];\n\n /** Axes specifications */\n readonly axesSpec: AxesSpec;\n};\n\n/**\n * Specification of a data column.\n *\n * Data column is a specialized type of PColumn that stores only simple values (strings and numbers)\n * addressed by multiple keys. This is in contrast to other PColumn variants that can store more complex\n * values like files or other abstract data types. Data columns are optimized for storing and processing\n * basic tabular data.\n */\nexport type PDataColumnSpec = PUniversalColumnSpec & {\n /** Type of column values */\n readonly valueType: ValueType;\n};\n\n// @todo: change this to PUniversalColumnSpec\nexport type PColumnSpec = PDataColumnSpec;\n\n/** Unique PColumnSpec identifier */\nexport type PColumnSpecId = {\n /** Defines specific type of BObject, the most generic type of unit of\n * information in Platforma Project. */\n readonly kind: \"PColumn\";\n\n /** Type of column values */\n readonly valueType: ValueType;\n\n /** Column name */\n readonly name: string;\n\n /** Adds auxiliary information to the axis name, type and parents to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional column identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n\n /** A list of zero-based indices of parent axes from the {@link axesSpec} array. */\n readonly parentAxes?: number[];\n\n /** Axes id */\n readonly axesId: AxesId;\n};\n\nexport function getPColumnSpecId(spec: PColumnSpec): PColumnSpecId {\n return {\n kind: spec.kind,\n valueType: spec.valueType,\n name: spec.name,\n domain: spec.domain,\n contextDomain: spec.contextDomain,\n parentAxes: spec.parentAxes,\n axesId: getAxesId(spec.axesSpec),\n };\n}\n\nexport interface PColumn<Data> extends PObject<Data> {\n /** PColumn spec, allowing it to be found among other PObjects */\n readonly spec: PColumnSpec;\n}\n\nexport type PColumnLazy<T> = PColumn<() => T>;\n\n/** Columns in a PFrame also have internal identifier, this object represents\n * combination of specs and such id */\nexport interface PColumnIdAndSpec {\n /** Internal column id within the PFrame */\n readonly columnId: PObjectId;\n\n /** Column spec */\n readonly spec: PColumnSpec;\n}\n\n/** Get column id and spec from a column */\nexport function getColumnIdAndSpec<Data>(column: PColumn<Data>): PColumnIdAndSpec {\n return {\n columnId: column.id,\n spec: column.spec,\n };\n}\n\n/** Information returned by {@link PFrame.listColumns} method */\nexport interface PColumnInfo extends PColumnIdAndSpec {\n /** True if data was associated with this PColumn */\n readonly hasData: boolean;\n}\n\nexport interface AxisId {\n /** Type of the axis or column value. For an axis should not use non-key\n * types like float or double. */\n readonly type: AxisValueType;\n\n /** Name of the axis or column */\n readonly name: string;\n\n /** Adds auxiliary information to the axis or column name and type to form a\n * unique identifier */\n readonly domain?: Record<string, string>;\n\n /** Context domain provides additional axis identity that is matched\n * by kinship rules (subset/superset/overlap) rather than exact equality */\n readonly contextDomain?: Record<string, string>;\n}\n\n/** Array of axis ids */\nexport type AxesId = AxisId[];\n\n/** Extracts axis ids from axis spec */\nexport function getAxisId(spec: AxisSpec): AxisId {\n const { type, name, domain, contextDomain } = spec;\n const result: AxisId = { type, name };\n if (domain && Object.entries(domain).length > 0) {\n Object.assign(result, { domain });\n }\n if (contextDomain && Object.entries(contextDomain).length > 0) {\n Object.assign(result, { contextDomain });\n }\n return result;\n}\n\n/** Extracts axes ids from axes spec array from column spec */\nexport function getAxesId(spec: AxesSpec): AxesId {\n return spec.map(getAxisId);\n}\n\n/** Canonicalizes axis id */\nexport function canonicalizeAxisId(id: AxisId): CanonicalizedJson<AxisId> {\n return canonicalizeJson(getAxisId(id));\n}\n\n/** Returns true if all domains from query are found in target */\nfunction matchDomain(query?: Record<string, string>, target?: Record<string, string>) {\n if (query === undefined) return target === undefined;\n if (target === undefined) return true;\n for (const k in target) {\n if (query[k] !== target[k]) return false;\n }\n return true;\n}\n\n/** Returns whether \"match\" axis id is compatible with the \"query\" */\nexport function matchAxisId(query: AxisId, target: AxisId): boolean {\n return (\n query.name === target.name &&\n matchDomain(query.domain, target.domain) &&\n matchDomain(query.contextDomain, target.contextDomain)\n );\n}\n\nexport function getTypeFromPColumnOrAxisSpec(spec: PColumnSpec | AxisSpec): ValueType {\n return \"valueType\" in spec ? spec.valueType : spec.type;\n}\n\nexport function isAxisId(id: unknown): id is AxisId {\n return typeof id === \"object\" && id !== null && \"name\" in id && \"type\" in id;\n}\n"],"mappings":";;;;;AAKA,MAAa,YAAY;CACvB,KAAK;CACL,MAAM;CACN,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,OAAO;CACR;AAUD,SAAgB,aACd,UACA,KACkB;AAClB,QAAQ,WAA6B;;AAUvC,SAAgB,wBACd,UACA,cACA,KACA,oBAA4B,2BACa;CACzC,MAAM,OAAO,aAAmB,UAAU,IAAI;AAC9C,KAAI,SAAS,OAAW,QAAO;CAE/B,MAAM,SAAS,aAAa;AAC5B,KAAI;EACF,MAAM,QAAQ,KAAK,MAAM,KAAK;AAC9B,SAAO,OAAO,MAAM,MAAM;UACnB,OAAgB;AACvB,QAAM,IAAI,MACR,GAAG,kBAAkB,gBACX,OAAO,IAAI,CAAC,WACV,KAAK,WACL,YAAY,MAAM,GAC/B;;;AAIL,SAAgB,iBACd,UACA,cACA,KACyC;AACzC,KAAI;AACF,SAAO,wBAAwB,UAAU,cAAc,IAAI;SACrD;AACN;;;AAKJ,MAAa,SAAS;CACpB,UAAU;CACV,SAAS;CACT,KAAK;EACH,YAAY,EACV,SAAS,kCACV;EACD,kBAAkB,EAChB,OAAO,sCACR;EACF;CACF;AAUD,MAAa,aAAyB,EAAE;AAGxC,SAAgB,WACd,MACA,KACuB;AACvB,QAAO,aAAwB,MAAM,QAAQ,IAAI;;AAInD,SAAgB,sBACd,MACA,KACoC;AACpC,QAAO,wBAAmC,MAAM,QAAQ,YAAY,KAAK,wBAAwB;;AAInG,SAAgB,eACd,MACA,KACoC;AACpC,QAAO,iBAA4B,MAAM,QAAQ,YAAY,IAAI;;AAInE,MAAa,aAAa;CACxB,YAAY;CACZ,UAAU;CACV,aAAa;CACb,gBAAgB;CAChB,QAAQ;CACR,OAAO;EACL,MAAM;GACJ,iBAAiB;GACjB,YAAY;GACZ,gBAAgB;GAChB,YAAY;GACb;EACD,aAAa;EACb,WAAW;EACX,SAAS;EACT,YAAY;EACZ,qBAAqB;EACtB;CACD,gBAAgB;CAChB,oBAAoB;CACpB,kBAAkB;CAClB,UAAU;CACV,gBAAgB;CAChB,SAAS;CACT,UAAU;CACV,OAAO;CACP,KAAK;CACL,KAAK;CACL,cAAc;CACd,SAAS;CACT,OAAO;EACL,eAAe;EACf,cAAc;EACf;CACD,UAAU;EACR,YAAY,EACV,SAAS,uCACV;EACD,cAAc;EACf;CACD,OAAO;EACL,YAAY;EACZ,eAAe;EACf,YAAY;EACb;CACD,OAAO;CACP,KAAK;EACH,qBAAqB;EACrB,gBAAgB;EACjB;CACF;AA0DD,MAAM,kBAAkB,EAAE,KAAK;CAAC;CAAO;CAAQ;CAAS;CAAU;CAAS,CAAU;AACrF,MAAa,iBAAiC;EAC3C,WAAW,iBAAiB,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;EACvE,WAAW,MAAM,KAAK,kBAAkB,EAAE,SAAS;EACnD,WAAW,MAAM,KAAK,aAAa,EAAE,QAAQ;EAC7C,WAAW,MAAM,KAAK,aAAa,EAAE,QAAQ;EAC7C,WAAW,MAAM,KAAK,iBAAiB,EAAE,SAAS;EAClD,WAAW,MAAM,cAAc,EAAE,SAAS;EAC1C,WAAW,MAAM,UAAU,EAAE,OAAO;EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC;EAAE,MAAM,EAAE,QAAQ;EAAE,CAAC;EACxF,WAAW,MAAM,aAAa,EAAE,MAC/B,EAAE,OAAO;EACP,UAAU,EAAE,OAAO;GAAE,WAAW;GAAiB,MAAM,EAAE,QAAQ;GAAE,CAAC;EACpE,OAAO,EAAE,QAAQ;EAClB,CAAC,CACH;EACA,WAAW,MAAM,sBAAsB,EAAE,QAAQ;EACjD,WAAW,MAAM,YAAY,EAAE,SAAS;EACxC,WAAW,iBAAiB,EAAE,SAAS;EACvC,WAAW,qBAAqB,EAAE,SAAS;EAC3C,WAAW,mBAAmB,EAAE,SAAS;EACzC,WAAW,iBAAiB,EAAE,SAAS;EACvC,WAAW,WAAW,EAAE,SAAS;EACjC,WAAW,MAAM,EAAE,QAAQ;EAC3B,WAAW,MAAM,EAAE,QAAQ;EAC3B,WAAW,eAAe,EAAE,MAAM,EAAE,QAAQ,CAAC;EAC7C,WAAW,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC;EACxC,WAAW,SAAS,WAAW,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,QAAQ,CAAC;EACzE,WAAW,SAAS,eAAe,EAAE,SAAS;EAC9C,WAAW,MAAM,gBAAgB,EAAE,QAAQ;EAC3C,WAAW,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,SAAS,CAAC;EACpD,WAAW,IAAI,sBAAsB,EAAE,SAAS;CAClD;AAGD,SAAgB,eACd,MACA,KAC2B;AAC3B,QAAO,aAA4B,MAAM,aAAa,IAAI;;AAI5D,SAAgB,0BACd,MACA,KACwC;AACxC,QAAO,wBACL,MAAM,aACN,gBACA,KACA,4BACD;;AAIH,SAAgB,mBACd,MACA,KACwC;AACxC,QAAO,iBAAgC,MAAM,aAAa,gBAAgB,IAAI;;AAGhF,SAAgB,eAAe,QAA8B;AAC3D,QAAO,CAAC,CAAC,mBAAmB,QAAQ,WAAW,eAAe;;AA8DhE,SAAS,aAAa,MAAoC;AACxD,QAAO;EAAE;EAAM,UAAU,EAAE;EAAE;;;AAI/B,SAAgB,YAAY,UAAwC;CAClE,MAAM,OAAO,aAAa,SAAS;CACnC,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAwB,EAAE;AAChC,OAAK,MAAM,QAAQ,QAAQ;AACzB,QAAK,WAAW,KAAK,KAAK,eAAe,IAAI,aAAa;AAC1D,aAAU,KAAK,GAAG,KAAK,SAAS;;AAElC,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,mBAAmB,MAAgD;CACjF,MAAM,MAAM,IAAI,IAAI,CAAC,iBAAiB,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC;CAC7D,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAY,EAAE;AACpB,OAAK,MAAM,QAAQ,OACjB,MAAK,MAAM,UAAU,KAAK,UAAU;AAClC,OAAI,IAAI,iBAAiB,UAAU,OAAO,KAAK,CAAC,CAAC;AACjD,aAAU,KAAK,OAAO;;AAG1B,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,qBAAqB,MAAsC;CACzE,MAAM,MAAM,CAAC,KAAK,KAAK;CACvB,IAAI,SAAS,CAAC,KAAK;AACnB,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAY,EAAE;AACpB,OAAK,MAAM,QAAQ,OACjB,MAAK,MAAM,UAAU,KAAK,UAAU;AAClC,OAAI,KAAK,OAAO,KAAK;AACrB,aAAU,KAAK,OAAO;;AAG1B,WAAS;;AAEX,QAAO;;AAGT,SAAgB,4BAA4B,MAA0B;AACpE,QAAO,iBAAiB,qBAAqB,YAAY,KAAK,CAAC,CAAC,IAAI,UAAU,CAAC;;AAGjF,SAAS,0BACP,OACA,OACY;AACZ,KAAI,MAAM,SAAS,MAAM,KACvB,QAAO,MAAM,OAAO,MAAM,OAAO,IAAI;AAEvC,KAAI,MAAM,SAAS,MAAM,KACvB,QAAO,MAAM,OAAO,MAAM,OAAO,IAAI;CAEvC,MAAM,UAAU,iBAAiB,MAAM,UAAU,EAAE,CAAC;CACpD,MAAM,UAAU,iBAAiB,MAAM,UAAU,EAAE,CAAC;AACpD,KAAI,YAAY,QACd,QAAO,UAAU,UAAU,IAAI;CAGjC,MAAM,iBAAiB,iBAAiB,MAAM,iBAAiB,EAAE,CAAC;CAClE,MAAM,iBAAiB,iBAAiB,MAAM,iBAAiB,EAAE,CAAC;AAClE,KAAI,mBAAmB,eACrB,QAAO,iBAAiB,iBAAiB,IAAI;CAG/C,MAAM,WAAW,4BAA4B,MAAM;CACnD,MAAM,WAAW,4BAA4B,MAAM;AAEnD,KAAI,aAAa,SACf,QAAO,WAAW,WAAW,IAAI;CAGnC,MAAM,cAAc,iBAAiB,MAAM,eAAe,EAAE,CAAC;CAC7D,MAAM,cAAc,iBAAiB,MAAM,eAAe,EAAE,CAAC;AAC7D,KAAI,gBAAgB,YAClB,QAAO,cAAc,cAAc,IAAI;AAEzC,QAAO;;AAGT,SAAS,4BAA4B,MAAgB;CACnD,MAAM,cAAc,mBAAmB,MAAM,WAAW,QAAQ;AAChE,KAAI,gBAAgB,OAClB,QAAO,EAAE;AAEX,QAAO;;AAGT,SAAS,gBAAgB,UAA8B;AACrD,UAAS,eAAe,QAAQ,gBAAgB;AAChD,UAAS,eAAe,KAAK,0BAA0B;;AAGzD,SAAS,kBAAkB,UAA8B;CAEvD,IAAI,SAAS,CADA,aAAa,SAAS,CAChB;CACnB,MAAM,YAAY,IAAI,IAAI,iBAAiB,UAAU,SAAS,CAAC,CAAC;AAChE,QAAO,OAAO,QAAQ;EACpB,MAAM,YAAwB,EAAE;EAChC,MAAM,2BAAW,IAAI,KAAgC;AACrD,OAAK,MAAM,QAAQ,QAAQ;AACzB,QAAK,WAAW,KAAK,KAAK,eAAe,IAAI,aAAa;AAC1D,QAAK,MAAM,SAAS,KAAK,UAAU;IACjC,MAAM,UAAU,iBAAiB,UAAU,MAAM,KAAK,CAAC;AACvD,QAAI,CAAC,SAAS,IAAI,QAAQ,EAAE;AAC1B,eAAU,KAAK,MAAM;AACrB,cAAS,IAAI,QAAQ;AACrB,SAAI,UAAU,IAAI,QAAQ,CACxB,QAAO;AAET,eAAU,IAAI,QAAQ;;;;AAI5B,WAAS;;AAEX,QAAO;;;AAIT,SAAgB,sBAAsB,MAAwC;AAC5E,KAAI,CAAC,KAAK,OACR,QAAO,EAAE;CAEX,MAAM,eAAqC,KAAK,KAAK,SAAS;EAC5D,MAAM,EAAE,YAAY,GAAG,GAAG,eAAe;AACzC,SAAO;GAAE,GAAG;GAAY,aAAa,EAAE,GAAG,WAAW,aAAa;GAAE,gBAAgB,EAAE;GAAE;GACxF;AAEF,MAAK,SAAS,MAAM,QAAQ;EAC1B,MAAM,eAAe,aAAa;AAClC,MAAI,KAAK,WAEP,cAAa,iBAAiB,KAAK,WAAW,KAAK,QAAQ,aAAa,KAAK;OACxE;GAEL,MAAM,UAAU,4BAA4B,KAAK,CAAC,KAAK,SACrD,aAAa,MAAM,SAAS,KAAK,SAAS,KAAK,CAChD;AACD,gBAAa,iBAAiB,QAAQ,MAAM,MAAM,MAAM,OAAU,GAC9D,EAAE,GACD;AAEL,UAAO,aAAa,cAAc,WAAW;;GAE/C;AAEF,KAAI,aAAa,KAAK,kBAAkB,CAEtC,cAAa,SAAS,SAAS;AAC7B,OAAK,iBAAiB,EAAE;GACxB;KAEF,cAAa,SAAS,SAAS;AAC7B,kBAAgB,KAAK;GACrB;AAGJ,QAAO;;;AAIT,SAAgB,wBAAwB,UAA4C;CAClF,MAAM,UAAU,SAAS,KAAK,aAAa,iBAAiB,UAAU,SAAS,CAAC,CAAC;AACjF,QAAO,SAAS,KAAK,aAAa;EAIhC,MAAM,aAHa,SAAS,eAAe,KAAK,aAC9C,iBAAiB,UAAU,SAAS,CAAC,CACtC,CAC6B,KAAK,OAAO,QAAQ,QAAQ,GAAG,CAAC;EAC9D,MAAM,EAAE,gBAAgB,GAAG,GAAG,eAAe;AAC7C,MAAI,WAAW,OACb,QAAO;GAAE,GAAG;GAAY,YAAY;GAAY;AAElD,SAAO;GACP;;AAOJ,MAAa,cAAc;CACzB,OAAO;CACP,OAAO,EACL,cAAc,+BACf;CACD,KAAK;EACH,eAAe;EACf,cAAc;EACd,UAAU;EACX;CACF;AAGD,MAAa,YAAY;CACvB,UAAU;CACV,KAAK;EACH,OAAO,EACL,YAAY,gCACb;EACD,WAAW;EACX,cAAc;EACd,gBAAgB;EACjB;CACF;AAED,SAAgB,cAAc,QAAqB;AACjD,QAAO,OAAO,SAAS,WAAW,KAAK,OAAO,SAAS,YAAY;;AAuFrE,SAAgB,iBAAiB,MAAkC;AACjE,QAAO;EACL,MAAM,KAAK;EACX,WAAW,KAAK;EAChB,MAAM,KAAK;EACX,QAAQ,KAAK;EACb,eAAe,KAAK;EACpB,YAAY,KAAK;EACjB,QAAQ,UAAU,KAAK,SAAS;EACjC;;;AAqBH,SAAgB,mBAAyB,QAAyC;AAChF,QAAO;EACL,UAAU,OAAO;EACjB,MAAM,OAAO;EACd;;;AA8BH,SAAgB,UAAU,MAAwB;CAChD,MAAM,EAAE,MAAM,MAAM,QAAQ,kBAAkB;CAC9C,MAAM,SAAiB;EAAE;EAAM;EAAM;AACrC,KAAI,UAAU,OAAO,QAAQ,OAAO,CAAC,SAAS,EAC5C,QAAO,OAAO,QAAQ,EAAE,QAAQ,CAAC;AAEnC,KAAI,iBAAiB,OAAO,QAAQ,cAAc,CAAC,SAAS,EAC1D,QAAO,OAAO,QAAQ,EAAE,eAAe,CAAC;AAE1C,QAAO;;;AAIT,SAAgB,UAAU,MAAwB;AAChD,QAAO,KAAK,IAAI,UAAU;;;AAI5B,SAAgB,mBAAmB,IAAuC;AACxE,QAAO,iBAAiB,UAAU,GAAG,CAAC;;;AAIxC,SAAS,YAAY,OAAgC,QAAiC;AACpF,KAAI,UAAU,OAAW,QAAO,WAAW;AAC3C,KAAI,WAAW,OAAW,QAAO;AACjC,MAAK,MAAM,KAAK,OACd,KAAI,MAAM,OAAO,OAAO,GAAI,QAAO;AAErC,QAAO;;;AAIT,SAAgB,YAAY,OAAe,QAAyB;AAClE,QACE,MAAM,SAAS,OAAO,QACtB,YAAY,MAAM,QAAQ,OAAO,OAAO,IACxC,YAAY,MAAM,eAAe,OAAO,cAAc;;AAI1D,SAAgB,6BAA6B,MAAyC;AACpF,QAAO,eAAe,OAAO,KAAK,YAAY,KAAK;;AAGrD,SAAgB,SAAS,IAA2B;AAClD,QAAO,OAAO,OAAO,YAAY,OAAO,QAAQ,UAAU,MAAM,UAAU"}
@@ -1,9 +1,10 @@
1
- import { AxisSpec, PColumnIdAndSpec, PColumnSpec, ValueType } from "./pframe/spec/spec.js";
2
- import { SingleAxisSelector } from "./pframe/spec/selectors.js";
3
- import "./pframe/index.js";
1
+ import { AxesId, AxesSpec, AxisSpec, AxisValueType, ColumnValueType, PColumnIdAndSpec, PColumnSpec } from "./spec/spec.js";
2
+ import { SingleAxisSelector } from "./spec/selectors.js";
3
+ import { PTableColumnId, PTableColumnSpec } from "./table_common.js";
4
+ import "./spec/index.js";
4
5
  import { Branded } from "@milaboratories/helpers";
5
6
 
6
- //#region src/drivers/pspec.d.ts
7
+ //#region src/drivers/pframe/spec_driver.d.ts
7
8
  /** Matches a string value either exactly or by regex pattern */
8
9
  type StringMatcher = {
9
10
  type: "exact";
@@ -17,7 +18,7 @@ type MatcherMap = Record<string, StringMatcher[]>;
17
18
  /** Selector for matching axes by various criteria */
18
19
  interface MultiAxisSelector {
19
20
  /** Match any of the axis types listed here */
20
- readonly type?: ValueType[];
21
+ readonly type?: AxisValueType[];
21
22
  /** Match any of the axis names listed here */
22
23
  readonly name?: StringMatcher[];
23
24
  /** Match requires all the domains listed here */
@@ -31,7 +32,7 @@ interface MultiAxisSelector {
31
32
  * Multiple selectors are OR-ed: a column matches if it satisfies any selector. */
32
33
  interface MultiColumnSelector {
33
34
  /** Match any of the value types listed here */
34
- readonly type?: ValueType[];
35
+ readonly type?: ColumnValueType[];
35
36
  /** Match any of the names listed here */
36
37
  readonly name?: StringMatcher[];
37
38
  /** Match requires all the domains listed here */
@@ -72,13 +73,27 @@ interface DiscoverColumnsConstraints {
72
73
  }
73
74
  /** Request for discovering columns compatible with a given axes integration */
74
75
  interface DiscoverColumnsRequest {
75
- /** Column filters (OR-ed); empty array matches all columns */
76
- columnFilter?: MultiColumnSelector[];
76
+ /** Include columns matching these selectors (OR-ed); empty or omitted matches all columns */
77
+ includeColumns?: MultiColumnSelector[];
78
+ /** Exclude columns matching these selectors (OR-ed); applied after include filter */
79
+ excludeColumns?: MultiColumnSelector[];
77
80
  /** Already integrated axes with qualifications */
78
81
  axes: ColumnAxesWithQualifications[];
82
+ /** Maximum number of hops allowed between provided axes integration and returned hits (0 = direct only) */
83
+ maxHops?: number;
79
84
  /** Constraints controlling axes matching and qualification behavior */
80
85
  constraints: DiscoverColumnsConstraints;
81
86
  }
87
+ /** Linker step: traversal through a linker column */
88
+ interface DiscoverColumnsLinkerStep {
89
+ type: "linker";
90
+ /** The linker column traversed in this step */
91
+ linker: PColumnIdAndSpec;
92
+ /** Axis qualifications produced when matching the linker's many-side axes */
93
+ qualifications: AxisQualification[];
94
+ }
95
+ /** A step traversed during path-based column discovery. Discriminated by `type`. */
96
+ type DiscoverColumnsStepInfo = DiscoverColumnsLinkerStep;
82
97
  /** Qualifications info for a discover columns response mapping variant */
83
98
  interface DiscoverColumnsResponseQualifications {
84
99
  /** Qualifications for each query (already-integrated) column set */
@@ -99,6 +114,8 @@ interface DiscoverColumnsResponseHit {
99
114
  hit: PColumnIdAndSpec;
100
115
  /** Possible ways to integrate this column with the existing set */
101
116
  mappingVariants: DiscoverColumnsMappingVariant[];
117
+ /** Linker steps traversed to reach this hit; empty for direct matches */
118
+ path: DiscoverColumnsStepInfo[];
102
119
  }
103
120
  /** Response from discover columns */
104
121
  interface DiscoverColumnsResponse {
@@ -114,14 +131,22 @@ type SpecFrameHandle = Branded<string, "SpecFrameHandle">;
114
131
  * operates on column specifications only. All methods are synchronous
115
132
  * because the underlying WASM PFrame computes results immediately.
116
133
  */
117
- interface PSpecDriver {
134
+ interface PFrameSpecDriver {
118
135
  /** Create a spec-only PFrame from column specs. Returns a handle. */
119
136
  createSpecFrame(specs: Record<string, PColumnSpec>): SpecFrameHandle;
120
137
  /** Discover columns compatible with given axes integration. */
121
138
  specFrameDiscoverColumns(handle: SpecFrameHandle, request: DiscoverColumnsRequest): DiscoverColumnsResponse;
122
139
  /** Dispose a spec frame, freeing WASM resources. */
123
140
  disposeSpecFrame(handle: SpecFrameHandle): void;
141
+ /** Expand index-based parentAxes in AxesSpec to resolved AxisId parents in AxesId. */
142
+ expandAxes(spec: AxesSpec): AxesId;
143
+ /** Collapse resolved AxisId parents back to index-based parentAxes in AxesSpec. */
144
+ collapseAxes(ids: AxesId): AxesSpec;
145
+ /** Find the index of an axis matching the given selector. Returns -1 if not found. */
146
+ findAxis(spec: AxesSpec, selector: SingleAxisSelector): number;
147
+ /** Find the flat index of a table column matching the given selector. Returns -1 if not found. */
148
+ findTableColumn(tableSpec: PTableColumnSpec[], selector: PTableColumnId): number;
124
149
  }
125
150
  //#endregion
126
- export { AxisQualification, ColumnAxesWithQualifications, DiscoverColumnsConstraints, DiscoverColumnsMappingVariant, DiscoverColumnsRequest, DiscoverColumnsResponse, DiscoverColumnsResponseHit, DiscoverColumnsResponseQualifications, MatcherMap, MultiAxisSelector, MultiColumnSelector, PSpecDriver, SpecFrameHandle, StringMatcher };
127
- //# sourceMappingURL=pspec.d.ts.map
151
+ export { AxisQualification, ColumnAxesWithQualifications, DiscoverColumnsConstraints, DiscoverColumnsLinkerStep, DiscoverColumnsMappingVariant, DiscoverColumnsRequest, DiscoverColumnsResponse, DiscoverColumnsResponseHit, DiscoverColumnsResponseQualifications, DiscoverColumnsStepInfo, MatcherMap, MultiAxisSelector, MultiColumnSelector, PFrameSpecDriver, SpecFrameHandle, StringMatcher };
152
+ //# sourceMappingURL=spec_driver.d.ts.map
package/dist/errors.cjs CHANGED
@@ -34,6 +34,12 @@ var PFrameDriverError = class extends PFrameError {
34
34
  function isPFrameDriverError(error) {
35
35
  return error instanceof Error && error.name === "PFrameError.Driver";
36
36
  }
37
+ var PFrameSpecDriverError = class extends PFrameError {
38
+ name = "PFrameError.SpecDriver";
39
+ };
40
+ function isPFrameSpecDriverError(error) {
41
+ return error instanceof Error && error.name === "PFrameError.SpecDriver";
42
+ }
37
43
  function stringifyValue(value) {
38
44
  if (typeof value === "string") return `String value was thrown: ${value}`;
39
45
  if (value && typeof value === "object") try {
@@ -101,6 +107,7 @@ async function wrapAndSerializeAsync(callback) {
101
107
  exports.AbortError = AbortError;
102
108
  exports.PFrameDriverError = PFrameDriverError;
103
109
  exports.PFrameError = PFrameError;
110
+ exports.PFrameSpecDriverError = PFrameSpecDriverError;
104
111
  exports.UiError = UiError;
105
112
  exports.deserializeError = deserializeError;
106
113
  exports.deserializeResult = deserializeResult;
@@ -110,6 +117,7 @@ exports.isAbortError = isAbortError;
110
117
  exports.isAggregateError = isAggregateError;
111
118
  exports.isPFrameDriverError = isPFrameDriverError;
112
119
  exports.isPFrameError = isPFrameError;
120
+ exports.isPFrameSpecDriverError = isPFrameSpecDriverError;
113
121
  exports.serializeError = serializeError;
114
122
  exports.serializeResult = serializeResult;
115
123
  exports.unwrapResult = unwrapResult;
@@ -1 +1 @@
1
- {"version":3,"file":"errors.cjs","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/**\n * Just for convenience, usually it is an Error with name 'AbortError'\n */\nexport class AbortError extends Error {\n name = \"AbortError\";\n}\n\n/**\n * Throw this to show a message without stack trace in UI\n */\nexport class UiError extends Error {\n name = \"UiError\";\n}\n\nexport function isAbortError(error: unknown): error is Error & { name: \"AbortError\" } {\n return error instanceof Error && error.name === \"AbortError\";\n}\n\nexport function hasAbortError(error: unknown): boolean {\n if (!(error instanceof Error)) {\n return false;\n }\n\n return error.name === \"AbortError\" || hasAbortError(error.cause);\n}\n\nexport function isAggregateError(error: unknown): error is AggregateError {\n return error instanceof Error && error.name === \"AggregateError\";\n}\n\nexport class PFrameError extends Error {\n name = \"PFrameError\";\n}\n\nexport function isPFrameError(error: unknown): error is PFrameError {\n return error instanceof Error && error.name === \"PFrameError\";\n}\n\nexport class PFrameDriverError extends PFrameError {\n name = \"PFrameError.Driver\";\n}\n\nexport function isPFrameDriverError(error: unknown): error is PFrameDriverError {\n return error instanceof Error && error.name === \"PFrameError.Driver\";\n}\n\nfunction stringifyValue(value: unknown): string {\n if (typeof value === \"string\") {\n return `String value was thrown: ${value}`;\n }\n\n if (value && typeof value === \"object\") {\n try {\n return `Plain object was thrown: ${JSON.stringify(value)}`;\n } catch (jsonError) {\n const errorMessage = jsonError instanceof Error ? jsonError.message : String(jsonError);\n return `Non-serializable object was thrown (JSON.stringify failed: ${errorMessage}): ${String(value)}`;\n }\n }\n\n return String(`Non-Error value (${typeof value}) was thrown: ${value}`);\n}\n\nexport function ensureError(value: unknown): Error {\n if (value instanceof Error) {\n return value;\n }\n\n return new Error(stringifyValue(value));\n}\n\n// Error serialization for IPC/network transmission (Error objects can't be JSON serialized)\n\nexport type SerializedError = {\n name: string;\n message: string;\n stack: string | undefined;\n cause?: SerializedError;\n};\n\nexport function deserializeError(obj: SerializedError): Error {\n const cause = obj.cause ? deserializeError(obj.cause) : undefined;\n\n const error = new Error(obj.message, cause !== undefined ? { cause } : undefined);\n error.name = obj.name || \"Error\";\n error.stack = obj.stack;\n\n return error;\n}\n\nexport function serializeError(e: unknown): SerializedError {\n const error = ensureError(e);\n const cause = error.cause ? serializeError(error.cause) : undefined;\n\n return {\n name: error.name,\n message: error.message,\n stack: error.stack,\n ...(error.cause !== undefined && { cause }),\n };\n}\n\nexport type ResultOrError<S, F = Error> =\n | {\n value: S;\n error?: undefined;\n }\n | {\n error: F;\n };\n\nexport function unwrapResult<T>(result: ResultOrError<T, Error | SerializedError>): T {\n if (result.error) {\n throw result.error instanceof Error ? result.error : deserializeError(result.error);\n }\n return result.value;\n}\n\nexport function serializeResult<T>(result: ResultOrError<T>): ResultOrError<T, SerializedError> {\n if (result.error) {\n return { error: serializeError(result.error) };\n }\n return { value: result.value };\n}\n\nexport function deserializeResult<T>(result: ResultOrError<T, SerializedError>): ResultOrError<T> {\n if (result.error) {\n return { error: deserializeError(result.error) };\n }\n return { value: result.value };\n}\n\nexport function wrapCallback<T>(callback: () => T): ResultOrError<T> {\n try {\n const value = callback();\n return { value };\n } catch (error) {\n return { error: ensureError(error) };\n }\n}\n\nexport async function wrapAsyncCallback<T>(callback: () => Promise<T>): Promise<ResultOrError<T>> {\n try {\n const value = await callback();\n return { value };\n } catch (error) {\n return { error: ensureError(error) };\n }\n}\n\nexport function wrapAndSerialize<T>(callback: () => T): ResultOrError<T, SerializedError> {\n const result = wrapCallback(callback);\n return serializeResult(result);\n}\n\nexport async function wrapAndSerializeAsync<T>(\n callback: () => Promise<T>,\n): Promise<ResultOrError<T, SerializedError>> {\n const result = await wrapAsyncCallback(callback);\n return serializeResult(result);\n}\n"],"mappings":";;;;;AAGA,IAAa,aAAb,cAAgC,MAAM;CACpC,OAAO;;;;;AAMT,IAAa,UAAb,cAA6B,MAAM;CACjC,OAAO;;AAGT,SAAgB,aAAa,OAAyD;AACpF,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,SAAgB,cAAc,OAAyB;AACrD,KAAI,EAAE,iBAAiB,OACrB,QAAO;AAGT,QAAO,MAAM,SAAS,gBAAgB,cAAc,MAAM,MAAM;;AAGlE,SAAgB,iBAAiB,OAAyC;AACxE,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,cAAb,cAAiC,MAAM;CACrC,OAAO;;AAGT,SAAgB,cAAc,OAAsC;AAClE,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,oBAAb,cAAuC,YAAY;CACjD,OAAO;;AAGT,SAAgB,oBAAoB,OAA4C;AAC9E,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,SAAS,eAAe,OAAwB;AAC9C,KAAI,OAAO,UAAU,SACnB,QAAO,4BAA4B;AAGrC,KAAI,SAAS,OAAO,UAAU,SAC5B,KAAI;AACF,SAAO,4BAA4B,KAAK,UAAU,MAAM;UACjD,WAAW;AAElB,SAAO,8DADc,qBAAqB,QAAQ,UAAU,UAAU,OAAO,UAAU,CACL,KAAK,OAAO,MAAM;;AAIxG,QAAO,OAAO,oBAAoB,OAAO,MAAM,gBAAgB,QAAQ;;AAGzE,SAAgB,YAAY,OAAuB;AACjD,KAAI,iBAAiB,MACnB,QAAO;AAGT,QAAO,IAAI,MAAM,eAAe,MAAM,CAAC;;AAYzC,SAAgB,iBAAiB,KAA6B;CAC5D,MAAM,QAAQ,IAAI,QAAQ,iBAAiB,IAAI,MAAM,GAAG;CAExD,MAAM,QAAQ,IAAI,MAAM,IAAI,SAAS,UAAU,SAAY,EAAE,OAAO,GAAG,OAAU;AACjF,OAAM,OAAO,IAAI,QAAQ;AACzB,OAAM,QAAQ,IAAI;AAElB,QAAO;;AAGT,SAAgB,eAAe,GAA6B;CAC1D,MAAM,QAAQ,YAAY,EAAE;CAC5B,MAAM,QAAQ,MAAM,QAAQ,eAAe,MAAM,MAAM,GAAG;AAE1D,QAAO;EACL,MAAM,MAAM;EACZ,SAAS,MAAM;EACf,OAAO,MAAM;EACb,GAAI,MAAM,UAAU,UAAa,EAAE,OAAO;EAC3C;;AAYH,SAAgB,aAAgB,QAAsD;AACpF,KAAI,OAAO,MACT,OAAM,OAAO,iBAAiB,QAAQ,OAAO,QAAQ,iBAAiB,OAAO,MAAM;AAErF,QAAO,OAAO;;AAGhB,SAAgB,gBAAmB,QAA6D;AAC9F,KAAI,OAAO,MACT,QAAO,EAAE,OAAO,eAAe,OAAO,MAAM,EAAE;AAEhD,QAAO,EAAE,OAAO,OAAO,OAAO;;AAGhC,SAAgB,kBAAqB,QAA6D;AAChG,KAAI,OAAO,MACT,QAAO,EAAE,OAAO,iBAAiB,OAAO,MAAM,EAAE;AAElD,QAAO,EAAE,OAAO,OAAO,OAAO;;AAGhC,SAAgB,aAAgB,UAAqC;AACnE,KAAI;AAEF,SAAO,EAAE,OADK,UAAU,EACR;UACT,OAAO;AACd,SAAO,EAAE,OAAO,YAAY,MAAM,EAAE;;;AAIxC,eAAsB,kBAAqB,UAAuD;AAChG,KAAI;AAEF,SAAO,EAAE,OADK,MAAM,UAAU,EACd;UACT,OAAO;AACd,SAAO,EAAE,OAAO,YAAY,MAAM,EAAE;;;AAIxC,SAAgB,iBAAoB,UAAsD;AAExF,QAAO,gBADQ,aAAa,SAAS,CACP;;AAGhC,eAAsB,sBACpB,UAC4C;AAE5C,QAAO,gBADQ,MAAM,kBAAkB,SAAS,CAClB"}
1
+ {"version":3,"file":"errors.cjs","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/**\n * Just for convenience, usually it is an Error with name 'AbortError'\n */\nexport class AbortError extends Error {\n name = \"AbortError\";\n}\n\n/**\n * Throw this to show a message without stack trace in UI\n */\nexport class UiError extends Error {\n name = \"UiError\";\n}\n\nexport function isAbortError(error: unknown): error is Error & { name: \"AbortError\" } {\n return error instanceof Error && error.name === \"AbortError\";\n}\n\nexport function hasAbortError(error: unknown): boolean {\n if (!(error instanceof Error)) {\n return false;\n }\n\n return error.name === \"AbortError\" || hasAbortError(error.cause);\n}\n\nexport function isAggregateError(error: unknown): error is AggregateError {\n return error instanceof Error && error.name === \"AggregateError\";\n}\n\nexport class PFrameError extends Error {\n name = \"PFrameError\";\n}\n\nexport function isPFrameError(error: unknown): error is PFrameError {\n return error instanceof Error && error.name === \"PFrameError\";\n}\n\nexport class PFrameDriverError extends PFrameError {\n name = \"PFrameError.Driver\";\n}\n\nexport function isPFrameDriverError(error: unknown): error is PFrameDriverError {\n return error instanceof Error && error.name === \"PFrameError.Driver\";\n}\n\nexport class PFrameSpecDriverError extends PFrameError {\n name = \"PFrameError.SpecDriver\";\n}\n\nexport function isPFrameSpecDriverError(error: unknown): error is PFrameSpecDriverError {\n return error instanceof Error && error.name === \"PFrameError.SpecDriver\";\n}\n\nfunction stringifyValue(value: unknown): string {\n if (typeof value === \"string\") {\n return `String value was thrown: ${value}`;\n }\n\n if (value && typeof value === \"object\") {\n try {\n return `Plain object was thrown: ${JSON.stringify(value)}`;\n } catch (jsonError) {\n const errorMessage = jsonError instanceof Error ? jsonError.message : String(jsonError);\n return `Non-serializable object was thrown (JSON.stringify failed: ${errorMessage}): ${String(value)}`;\n }\n }\n\n return String(`Non-Error value (${typeof value}) was thrown: ${value}`);\n}\n\nexport function ensureError(value: unknown): Error {\n if (value instanceof Error) {\n return value;\n }\n\n return new Error(stringifyValue(value));\n}\n\n// Error serialization for IPC/network transmission (Error objects can't be JSON serialized)\n\nexport type SerializedError = {\n name: string;\n message: string;\n stack: string | undefined;\n cause?: SerializedError;\n};\n\nexport function deserializeError(obj: SerializedError): Error {\n const cause = obj.cause ? deserializeError(obj.cause) : undefined;\n\n const error = new Error(obj.message, cause !== undefined ? { cause } : undefined);\n error.name = obj.name || \"Error\";\n error.stack = obj.stack;\n\n return error;\n}\n\nexport function serializeError(e: unknown): SerializedError {\n const error = ensureError(e);\n const cause = error.cause ? serializeError(error.cause) : undefined;\n\n return {\n name: error.name,\n message: error.message,\n stack: error.stack,\n ...(error.cause !== undefined && { cause }),\n };\n}\n\nexport type ResultOrError<S, F = Error> =\n | {\n value: S;\n error?: undefined;\n }\n | {\n error: F;\n };\n\nexport function unwrapResult<T>(result: ResultOrError<T, Error | SerializedError>): T {\n if (result.error) {\n throw result.error instanceof Error ? result.error : deserializeError(result.error);\n }\n return result.value;\n}\n\nexport function serializeResult<T>(result: ResultOrError<T>): ResultOrError<T, SerializedError> {\n if (result.error) {\n return { error: serializeError(result.error) };\n }\n return { value: result.value };\n}\n\nexport function deserializeResult<T>(result: ResultOrError<T, SerializedError>): ResultOrError<T> {\n if (result.error) {\n return { error: deserializeError(result.error) };\n }\n return { value: result.value };\n}\n\nexport function wrapCallback<T>(callback: () => T): ResultOrError<T> {\n try {\n const value = callback();\n return { value };\n } catch (error) {\n return { error: ensureError(error) };\n }\n}\n\nexport async function wrapAsyncCallback<T>(callback: () => Promise<T>): Promise<ResultOrError<T>> {\n try {\n const value = await callback();\n return { value };\n } catch (error) {\n return { error: ensureError(error) };\n }\n}\n\nexport function wrapAndSerialize<T>(callback: () => T): ResultOrError<T, SerializedError> {\n const result = wrapCallback(callback);\n return serializeResult(result);\n}\n\nexport async function wrapAndSerializeAsync<T>(\n callback: () => Promise<T>,\n): Promise<ResultOrError<T, SerializedError>> {\n const result = await wrapAsyncCallback(callback);\n return serializeResult(result);\n}\n"],"mappings":";;;;;AAGA,IAAa,aAAb,cAAgC,MAAM;CACpC,OAAO;;;;;AAMT,IAAa,UAAb,cAA6B,MAAM;CACjC,OAAO;;AAGT,SAAgB,aAAa,OAAyD;AACpF,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,SAAgB,cAAc,OAAyB;AACrD,KAAI,EAAE,iBAAiB,OACrB,QAAO;AAGT,QAAO,MAAM,SAAS,gBAAgB,cAAc,MAAM,MAAM;;AAGlE,SAAgB,iBAAiB,OAAyC;AACxE,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,cAAb,cAAiC,MAAM;CACrC,OAAO;;AAGT,SAAgB,cAAc,OAAsC;AAClE,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,oBAAb,cAAuC,YAAY;CACjD,OAAO;;AAGT,SAAgB,oBAAoB,OAA4C;AAC9E,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,wBAAb,cAA2C,YAAY;CACrD,OAAO;;AAGT,SAAgB,wBAAwB,OAAgD;AACtF,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,SAAS,eAAe,OAAwB;AAC9C,KAAI,OAAO,UAAU,SACnB,QAAO,4BAA4B;AAGrC,KAAI,SAAS,OAAO,UAAU,SAC5B,KAAI;AACF,SAAO,4BAA4B,KAAK,UAAU,MAAM;UACjD,WAAW;AAElB,SAAO,8DADc,qBAAqB,QAAQ,UAAU,UAAU,OAAO,UAAU,CACL,KAAK,OAAO,MAAM;;AAIxG,QAAO,OAAO,oBAAoB,OAAO,MAAM,gBAAgB,QAAQ;;AAGzE,SAAgB,YAAY,OAAuB;AACjD,KAAI,iBAAiB,MACnB,QAAO;AAGT,QAAO,IAAI,MAAM,eAAe,MAAM,CAAC;;AAYzC,SAAgB,iBAAiB,KAA6B;CAC5D,MAAM,QAAQ,IAAI,QAAQ,iBAAiB,IAAI,MAAM,GAAG;CAExD,MAAM,QAAQ,IAAI,MAAM,IAAI,SAAS,UAAU,SAAY,EAAE,OAAO,GAAG,OAAU;AACjF,OAAM,OAAO,IAAI,QAAQ;AACzB,OAAM,QAAQ,IAAI;AAElB,QAAO;;AAGT,SAAgB,eAAe,GAA6B;CAC1D,MAAM,QAAQ,YAAY,EAAE;CAC5B,MAAM,QAAQ,MAAM,QAAQ,eAAe,MAAM,MAAM,GAAG;AAE1D,QAAO;EACL,MAAM,MAAM;EACZ,SAAS,MAAM;EACf,OAAO,MAAM;EACb,GAAI,MAAM,UAAU,UAAa,EAAE,OAAO;EAC3C;;AAYH,SAAgB,aAAgB,QAAsD;AACpF,KAAI,OAAO,MACT,OAAM,OAAO,iBAAiB,QAAQ,OAAO,QAAQ,iBAAiB,OAAO,MAAM;AAErF,QAAO,OAAO;;AAGhB,SAAgB,gBAAmB,QAA6D;AAC9F,KAAI,OAAO,MACT,QAAO,EAAE,OAAO,eAAe,OAAO,MAAM,EAAE;AAEhD,QAAO,EAAE,OAAO,OAAO,OAAO;;AAGhC,SAAgB,kBAAqB,QAA6D;AAChG,KAAI,OAAO,MACT,QAAO,EAAE,OAAO,iBAAiB,OAAO,MAAM,EAAE;AAElD,QAAO,EAAE,OAAO,OAAO,OAAO;;AAGhC,SAAgB,aAAgB,UAAqC;AACnE,KAAI;AAEF,SAAO,EAAE,OADK,UAAU,EACR;UACT,OAAO;AACd,SAAO,EAAE,OAAO,YAAY,MAAM,EAAE;;;AAIxC,eAAsB,kBAAqB,UAAuD;AAChG,KAAI;AAEF,SAAO,EAAE,OADK,MAAM,UAAU,EACd;UACT,OAAO;AACd,SAAO,EAAE,OAAO,YAAY,MAAM,EAAE;;;AAIxC,SAAgB,iBAAoB,UAAsD;AAExF,QAAO,gBADQ,aAAa,SAAS,CACP;;AAGhC,eAAsB,sBACpB,UAC4C;AAE5C,QAAO,gBADQ,MAAM,kBAAkB,SAAS,CAClB"}
package/dist/errors.d.ts CHANGED
@@ -24,6 +24,10 @@ declare class PFrameDriverError extends PFrameError {
24
24
  name: string;
25
25
  }
26
26
  declare function isPFrameDriverError(error: unknown): error is PFrameDriverError;
27
+ declare class PFrameSpecDriverError extends PFrameError {
28
+ name: string;
29
+ }
30
+ declare function isPFrameSpecDriverError(error: unknown): error is PFrameSpecDriverError;
27
31
  declare function ensureError(value: unknown): Error;
28
32
  type SerializedError = {
29
33
  name: string;
@@ -47,5 +51,5 @@ declare function wrapAsyncCallback<T>(callback: () => Promise<T>): Promise<Resul
47
51
  declare function wrapAndSerialize<T>(callback: () => T): ResultOrError<T, SerializedError>;
48
52
  declare function wrapAndSerializeAsync<T>(callback: () => Promise<T>): Promise<ResultOrError<T, SerializedError>>;
49
53
  //#endregion
50
- export { AbortError, PFrameDriverError, PFrameError, ResultOrError, SerializedError, UiError, deserializeError, deserializeResult, ensureError, hasAbortError, isAbortError, isAggregateError, isPFrameDriverError, isPFrameError, serializeError, serializeResult, unwrapResult, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback };
54
+ export { AbortError, PFrameDriverError, PFrameError, PFrameSpecDriverError, ResultOrError, SerializedError, UiError, deserializeError, deserializeResult, ensureError, hasAbortError, isAbortError, isAggregateError, isPFrameDriverError, isPFrameError, isPFrameSpecDriverError, serializeError, serializeResult, unwrapResult, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback };
51
55
  //# sourceMappingURL=errors.d.ts.map
package/dist/errors.js CHANGED
@@ -33,6 +33,12 @@ var PFrameDriverError = class extends PFrameError {
33
33
  function isPFrameDriverError(error) {
34
34
  return error instanceof Error && error.name === "PFrameError.Driver";
35
35
  }
36
+ var PFrameSpecDriverError = class extends PFrameError {
37
+ name = "PFrameError.SpecDriver";
38
+ };
39
+ function isPFrameSpecDriverError(error) {
40
+ return error instanceof Error && error.name === "PFrameError.SpecDriver";
41
+ }
36
42
  function stringifyValue(value) {
37
43
  if (typeof value === "string") return `String value was thrown: ${value}`;
38
44
  if (value && typeof value === "object") try {
@@ -97,5 +103,5 @@ async function wrapAndSerializeAsync(callback) {
97
103
  }
98
104
 
99
105
  //#endregion
100
- export { AbortError, PFrameDriverError, PFrameError, UiError, deserializeError, deserializeResult, ensureError, hasAbortError, isAbortError, isAggregateError, isPFrameDriverError, isPFrameError, serializeError, serializeResult, unwrapResult, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback };
106
+ export { AbortError, PFrameDriverError, PFrameError, PFrameSpecDriverError, UiError, deserializeError, deserializeResult, ensureError, hasAbortError, isAbortError, isAggregateError, isPFrameDriverError, isPFrameError, isPFrameSpecDriverError, serializeError, serializeResult, unwrapResult, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback };
101
107
  //# sourceMappingURL=errors.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/**\n * Just for convenience, usually it is an Error with name 'AbortError'\n */\nexport class AbortError extends Error {\n name = \"AbortError\";\n}\n\n/**\n * Throw this to show a message without stack trace in UI\n */\nexport class UiError extends Error {\n name = \"UiError\";\n}\n\nexport function isAbortError(error: unknown): error is Error & { name: \"AbortError\" } {\n return error instanceof Error && error.name === \"AbortError\";\n}\n\nexport function hasAbortError(error: unknown): boolean {\n if (!(error instanceof Error)) {\n return false;\n }\n\n return error.name === \"AbortError\" || hasAbortError(error.cause);\n}\n\nexport function isAggregateError(error: unknown): error is AggregateError {\n return error instanceof Error && error.name === \"AggregateError\";\n}\n\nexport class PFrameError extends Error {\n name = \"PFrameError\";\n}\n\nexport function isPFrameError(error: unknown): error is PFrameError {\n return error instanceof Error && error.name === \"PFrameError\";\n}\n\nexport class PFrameDriverError extends PFrameError {\n name = \"PFrameError.Driver\";\n}\n\nexport function isPFrameDriverError(error: unknown): error is PFrameDriverError {\n return error instanceof Error && error.name === \"PFrameError.Driver\";\n}\n\nfunction stringifyValue(value: unknown): string {\n if (typeof value === \"string\") {\n return `String value was thrown: ${value}`;\n }\n\n if (value && typeof value === \"object\") {\n try {\n return `Plain object was thrown: ${JSON.stringify(value)}`;\n } catch (jsonError) {\n const errorMessage = jsonError instanceof Error ? jsonError.message : String(jsonError);\n return `Non-serializable object was thrown (JSON.stringify failed: ${errorMessage}): ${String(value)}`;\n }\n }\n\n return String(`Non-Error value (${typeof value}) was thrown: ${value}`);\n}\n\nexport function ensureError(value: unknown): Error {\n if (value instanceof Error) {\n return value;\n }\n\n return new Error(stringifyValue(value));\n}\n\n// Error serialization for IPC/network transmission (Error objects can't be JSON serialized)\n\nexport type SerializedError = {\n name: string;\n message: string;\n stack: string | undefined;\n cause?: SerializedError;\n};\n\nexport function deserializeError(obj: SerializedError): Error {\n const cause = obj.cause ? deserializeError(obj.cause) : undefined;\n\n const error = new Error(obj.message, cause !== undefined ? { cause } : undefined);\n error.name = obj.name || \"Error\";\n error.stack = obj.stack;\n\n return error;\n}\n\nexport function serializeError(e: unknown): SerializedError {\n const error = ensureError(e);\n const cause = error.cause ? serializeError(error.cause) : undefined;\n\n return {\n name: error.name,\n message: error.message,\n stack: error.stack,\n ...(error.cause !== undefined && { cause }),\n };\n}\n\nexport type ResultOrError<S, F = Error> =\n | {\n value: S;\n error?: undefined;\n }\n | {\n error: F;\n };\n\nexport function unwrapResult<T>(result: ResultOrError<T, Error | SerializedError>): T {\n if (result.error) {\n throw result.error instanceof Error ? result.error : deserializeError(result.error);\n }\n return result.value;\n}\n\nexport function serializeResult<T>(result: ResultOrError<T>): ResultOrError<T, SerializedError> {\n if (result.error) {\n return { error: serializeError(result.error) };\n }\n return { value: result.value };\n}\n\nexport function deserializeResult<T>(result: ResultOrError<T, SerializedError>): ResultOrError<T> {\n if (result.error) {\n return { error: deserializeError(result.error) };\n }\n return { value: result.value };\n}\n\nexport function wrapCallback<T>(callback: () => T): ResultOrError<T> {\n try {\n const value = callback();\n return { value };\n } catch (error) {\n return { error: ensureError(error) };\n }\n}\n\nexport async function wrapAsyncCallback<T>(callback: () => Promise<T>): Promise<ResultOrError<T>> {\n try {\n const value = await callback();\n return { value };\n } catch (error) {\n return { error: ensureError(error) };\n }\n}\n\nexport function wrapAndSerialize<T>(callback: () => T): ResultOrError<T, SerializedError> {\n const result = wrapCallback(callback);\n return serializeResult(result);\n}\n\nexport async function wrapAndSerializeAsync<T>(\n callback: () => Promise<T>,\n): Promise<ResultOrError<T, SerializedError>> {\n const result = await wrapAsyncCallback(callback);\n return serializeResult(result);\n}\n"],"mappings":";;;;AAGA,IAAa,aAAb,cAAgC,MAAM;CACpC,OAAO;;;;;AAMT,IAAa,UAAb,cAA6B,MAAM;CACjC,OAAO;;AAGT,SAAgB,aAAa,OAAyD;AACpF,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,SAAgB,cAAc,OAAyB;AACrD,KAAI,EAAE,iBAAiB,OACrB,QAAO;AAGT,QAAO,MAAM,SAAS,gBAAgB,cAAc,MAAM,MAAM;;AAGlE,SAAgB,iBAAiB,OAAyC;AACxE,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,cAAb,cAAiC,MAAM;CACrC,OAAO;;AAGT,SAAgB,cAAc,OAAsC;AAClE,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,oBAAb,cAAuC,YAAY;CACjD,OAAO;;AAGT,SAAgB,oBAAoB,OAA4C;AAC9E,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,SAAS,eAAe,OAAwB;AAC9C,KAAI,OAAO,UAAU,SACnB,QAAO,4BAA4B;AAGrC,KAAI,SAAS,OAAO,UAAU,SAC5B,KAAI;AACF,SAAO,4BAA4B,KAAK,UAAU,MAAM;UACjD,WAAW;AAElB,SAAO,8DADc,qBAAqB,QAAQ,UAAU,UAAU,OAAO,UAAU,CACL,KAAK,OAAO,MAAM;;AAIxG,QAAO,OAAO,oBAAoB,OAAO,MAAM,gBAAgB,QAAQ;;AAGzE,SAAgB,YAAY,OAAuB;AACjD,KAAI,iBAAiB,MACnB,QAAO;AAGT,QAAO,IAAI,MAAM,eAAe,MAAM,CAAC;;AAYzC,SAAgB,iBAAiB,KAA6B;CAC5D,MAAM,QAAQ,IAAI,QAAQ,iBAAiB,IAAI,MAAM,GAAG;CAExD,MAAM,QAAQ,IAAI,MAAM,IAAI,SAAS,UAAU,SAAY,EAAE,OAAO,GAAG,OAAU;AACjF,OAAM,OAAO,IAAI,QAAQ;AACzB,OAAM,QAAQ,IAAI;AAElB,QAAO;;AAGT,SAAgB,eAAe,GAA6B;CAC1D,MAAM,QAAQ,YAAY,EAAE;CAC5B,MAAM,QAAQ,MAAM,QAAQ,eAAe,MAAM,MAAM,GAAG;AAE1D,QAAO;EACL,MAAM,MAAM;EACZ,SAAS,MAAM;EACf,OAAO,MAAM;EACb,GAAI,MAAM,UAAU,UAAa,EAAE,OAAO;EAC3C;;AAYH,SAAgB,aAAgB,QAAsD;AACpF,KAAI,OAAO,MACT,OAAM,OAAO,iBAAiB,QAAQ,OAAO,QAAQ,iBAAiB,OAAO,MAAM;AAErF,QAAO,OAAO;;AAGhB,SAAgB,gBAAmB,QAA6D;AAC9F,KAAI,OAAO,MACT,QAAO,EAAE,OAAO,eAAe,OAAO,MAAM,EAAE;AAEhD,QAAO,EAAE,OAAO,OAAO,OAAO;;AAGhC,SAAgB,kBAAqB,QAA6D;AAChG,KAAI,OAAO,MACT,QAAO,EAAE,OAAO,iBAAiB,OAAO,MAAM,EAAE;AAElD,QAAO,EAAE,OAAO,OAAO,OAAO;;AAGhC,SAAgB,aAAgB,UAAqC;AACnE,KAAI;AAEF,SAAO,EAAE,OADK,UAAU,EACR;UACT,OAAO;AACd,SAAO,EAAE,OAAO,YAAY,MAAM,EAAE;;;AAIxC,eAAsB,kBAAqB,UAAuD;AAChG,KAAI;AAEF,SAAO,EAAE,OADK,MAAM,UAAU,EACd;UACT,OAAO;AACd,SAAO,EAAE,OAAO,YAAY,MAAM,EAAE;;;AAIxC,SAAgB,iBAAoB,UAAsD;AAExF,QAAO,gBADQ,aAAa,SAAS,CACP;;AAGhC,eAAsB,sBACpB,UAC4C;AAE5C,QAAO,gBADQ,MAAM,kBAAkB,SAAS,CAClB"}
1
+ {"version":3,"file":"errors.js","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/**\n * Just for convenience, usually it is an Error with name 'AbortError'\n */\nexport class AbortError extends Error {\n name = \"AbortError\";\n}\n\n/**\n * Throw this to show a message without stack trace in UI\n */\nexport class UiError extends Error {\n name = \"UiError\";\n}\n\nexport function isAbortError(error: unknown): error is Error & { name: \"AbortError\" } {\n return error instanceof Error && error.name === \"AbortError\";\n}\n\nexport function hasAbortError(error: unknown): boolean {\n if (!(error instanceof Error)) {\n return false;\n }\n\n return error.name === \"AbortError\" || hasAbortError(error.cause);\n}\n\nexport function isAggregateError(error: unknown): error is AggregateError {\n return error instanceof Error && error.name === \"AggregateError\";\n}\n\nexport class PFrameError extends Error {\n name = \"PFrameError\";\n}\n\nexport function isPFrameError(error: unknown): error is PFrameError {\n return error instanceof Error && error.name === \"PFrameError\";\n}\n\nexport class PFrameDriverError extends PFrameError {\n name = \"PFrameError.Driver\";\n}\n\nexport function isPFrameDriverError(error: unknown): error is PFrameDriverError {\n return error instanceof Error && error.name === \"PFrameError.Driver\";\n}\n\nexport class PFrameSpecDriverError extends PFrameError {\n name = \"PFrameError.SpecDriver\";\n}\n\nexport function isPFrameSpecDriverError(error: unknown): error is PFrameSpecDriverError {\n return error instanceof Error && error.name === \"PFrameError.SpecDriver\";\n}\n\nfunction stringifyValue(value: unknown): string {\n if (typeof value === \"string\") {\n return `String value was thrown: ${value}`;\n }\n\n if (value && typeof value === \"object\") {\n try {\n return `Plain object was thrown: ${JSON.stringify(value)}`;\n } catch (jsonError) {\n const errorMessage = jsonError instanceof Error ? jsonError.message : String(jsonError);\n return `Non-serializable object was thrown (JSON.stringify failed: ${errorMessage}): ${String(value)}`;\n }\n }\n\n return String(`Non-Error value (${typeof value}) was thrown: ${value}`);\n}\n\nexport function ensureError(value: unknown): Error {\n if (value instanceof Error) {\n return value;\n }\n\n return new Error(stringifyValue(value));\n}\n\n// Error serialization for IPC/network transmission (Error objects can't be JSON serialized)\n\nexport type SerializedError = {\n name: string;\n message: string;\n stack: string | undefined;\n cause?: SerializedError;\n};\n\nexport function deserializeError(obj: SerializedError): Error {\n const cause = obj.cause ? deserializeError(obj.cause) : undefined;\n\n const error = new Error(obj.message, cause !== undefined ? { cause } : undefined);\n error.name = obj.name || \"Error\";\n error.stack = obj.stack;\n\n return error;\n}\n\nexport function serializeError(e: unknown): SerializedError {\n const error = ensureError(e);\n const cause = error.cause ? serializeError(error.cause) : undefined;\n\n return {\n name: error.name,\n message: error.message,\n stack: error.stack,\n ...(error.cause !== undefined && { cause }),\n };\n}\n\nexport type ResultOrError<S, F = Error> =\n | {\n value: S;\n error?: undefined;\n }\n | {\n error: F;\n };\n\nexport function unwrapResult<T>(result: ResultOrError<T, Error | SerializedError>): T {\n if (result.error) {\n throw result.error instanceof Error ? result.error : deserializeError(result.error);\n }\n return result.value;\n}\n\nexport function serializeResult<T>(result: ResultOrError<T>): ResultOrError<T, SerializedError> {\n if (result.error) {\n return { error: serializeError(result.error) };\n }\n return { value: result.value };\n}\n\nexport function deserializeResult<T>(result: ResultOrError<T, SerializedError>): ResultOrError<T> {\n if (result.error) {\n return { error: deserializeError(result.error) };\n }\n return { value: result.value };\n}\n\nexport function wrapCallback<T>(callback: () => T): ResultOrError<T> {\n try {\n const value = callback();\n return { value };\n } catch (error) {\n return { error: ensureError(error) };\n }\n}\n\nexport async function wrapAsyncCallback<T>(callback: () => Promise<T>): Promise<ResultOrError<T>> {\n try {\n const value = await callback();\n return { value };\n } catch (error) {\n return { error: ensureError(error) };\n }\n}\n\nexport function wrapAndSerialize<T>(callback: () => T): ResultOrError<T, SerializedError> {\n const result = wrapCallback(callback);\n return serializeResult(result);\n}\n\nexport async function wrapAndSerializeAsync<T>(\n callback: () => Promise<T>,\n): Promise<ResultOrError<T, SerializedError>> {\n const result = await wrapAsyncCallback(callback);\n return serializeResult(result);\n}\n"],"mappings":";;;;AAGA,IAAa,aAAb,cAAgC,MAAM;CACpC,OAAO;;;;;AAMT,IAAa,UAAb,cAA6B,MAAM;CACjC,OAAO;;AAGT,SAAgB,aAAa,OAAyD;AACpF,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,SAAgB,cAAc,OAAyB;AACrD,KAAI,EAAE,iBAAiB,OACrB,QAAO;AAGT,QAAO,MAAM,SAAS,gBAAgB,cAAc,MAAM,MAAM;;AAGlE,SAAgB,iBAAiB,OAAyC;AACxE,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,cAAb,cAAiC,MAAM;CACrC,OAAO;;AAGT,SAAgB,cAAc,OAAsC;AAClE,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,oBAAb,cAAuC,YAAY;CACjD,OAAO;;AAGT,SAAgB,oBAAoB,OAA4C;AAC9E,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,IAAa,wBAAb,cAA2C,YAAY;CACrD,OAAO;;AAGT,SAAgB,wBAAwB,OAAgD;AACtF,QAAO,iBAAiB,SAAS,MAAM,SAAS;;AAGlD,SAAS,eAAe,OAAwB;AAC9C,KAAI,OAAO,UAAU,SACnB,QAAO,4BAA4B;AAGrC,KAAI,SAAS,OAAO,UAAU,SAC5B,KAAI;AACF,SAAO,4BAA4B,KAAK,UAAU,MAAM;UACjD,WAAW;AAElB,SAAO,8DADc,qBAAqB,QAAQ,UAAU,UAAU,OAAO,UAAU,CACL,KAAK,OAAO,MAAM;;AAIxG,QAAO,OAAO,oBAAoB,OAAO,MAAM,gBAAgB,QAAQ;;AAGzE,SAAgB,YAAY,OAAuB;AACjD,KAAI,iBAAiB,MACnB,QAAO;AAGT,QAAO,IAAI,MAAM,eAAe,MAAM,CAAC;;AAYzC,SAAgB,iBAAiB,KAA6B;CAC5D,MAAM,QAAQ,IAAI,QAAQ,iBAAiB,IAAI,MAAM,GAAG;CAExD,MAAM,QAAQ,IAAI,MAAM,IAAI,SAAS,UAAU,SAAY,EAAE,OAAO,GAAG,OAAU;AACjF,OAAM,OAAO,IAAI,QAAQ;AACzB,OAAM,QAAQ,IAAI;AAElB,QAAO;;AAGT,SAAgB,eAAe,GAA6B;CAC1D,MAAM,QAAQ,YAAY,EAAE;CAC5B,MAAM,QAAQ,MAAM,QAAQ,eAAe,MAAM,MAAM,GAAG;AAE1D,QAAO;EACL,MAAM,MAAM;EACZ,SAAS,MAAM;EACf,OAAO,MAAM;EACb,GAAI,MAAM,UAAU,UAAa,EAAE,OAAO;EAC3C;;AAYH,SAAgB,aAAgB,QAAsD;AACpF,KAAI,OAAO,MACT,OAAM,OAAO,iBAAiB,QAAQ,OAAO,QAAQ,iBAAiB,OAAO,MAAM;AAErF,QAAO,OAAO;;AAGhB,SAAgB,gBAAmB,QAA6D;AAC9F,KAAI,OAAO,MACT,QAAO,EAAE,OAAO,eAAe,OAAO,MAAM,EAAE;AAEhD,QAAO,EAAE,OAAO,OAAO,OAAO;;AAGhC,SAAgB,kBAAqB,QAA6D;AAChG,KAAI,OAAO,MACT,QAAO,EAAE,OAAO,iBAAiB,OAAO,MAAM,EAAE;AAElD,QAAO,EAAE,OAAO,OAAO,OAAO;;AAGhC,SAAgB,aAAgB,UAAqC;AACnE,KAAI;AAEF,SAAO,EAAE,OADK,UAAU,EACR;UACT,OAAO;AACd,SAAO,EAAE,OAAO,YAAY,MAAM,EAAE;;;AAIxC,eAAsB,kBAAqB,UAAuD;AAChG,KAAI;AAEF,SAAO,EAAE,OADK,MAAM,UAAU,EACd;UACT,OAAO;AACd,SAAO,EAAE,OAAO,YAAY,MAAM,EAAE;;;AAIxC,SAAgB,iBAAoB,UAAsD;AAExF,QAAO,gBADQ,aAAa,SAAS,CACP;;AAGhC,eAAsB,sBACpB,UAC4C;AAE5C,QAAO,gBADQ,MAAM,kBAAkB,SAAS,CAClB"}
package/dist/index.cjs CHANGED
@@ -53,6 +53,7 @@ exports.PAxisName = require_spec.PAxisName;
53
53
  exports.PColumnName = require_spec.PColumnName;
54
54
  exports.PFrameDriverError = require_errors.PFrameDriverError;
55
55
  exports.PFrameError = require_errors.PFrameError;
56
+ exports.PFrameSpecDriverError = require_errors.PFrameSpecDriverError;
56
57
  exports.PTableAbsent = require_data_types.PTableAbsent;
57
58
  exports.PTableNA = require_data_types.PTableNA;
58
59
  exports.PlId = require_plid.PlId;
@@ -124,6 +125,7 @@ exports.isPColumnSpec = require_spec$1.isPColumnSpec;
124
125
  exports.isPColumnSpecResult = require_spec$1.isPColumnSpecResult;
125
126
  exports.isPFrameDriverError = require_errors.isPFrameDriverError;
126
127
  exports.isPFrameError = require_errors.isPFrameError;
128
+ exports.isPFrameSpecDriverError = require_errors.isPFrameSpecDriverError;
127
129
  exports.isPTableAbsent = require_data_types.isPTableAbsent;
128
130
  exports.isPTableNA = require_data_types.isPTableNA;
129
131
  exports.isPTableValueAxis = require_data_types.isPTableValueAxis;
package/dist/index.d.ts CHANGED
@@ -44,12 +44,12 @@ import { DataExprAxisRef, DataExprColumnRef, DataQuery, DataQueryBooleanExpressi
44
44
  import { collectSpecQueryColumns, isBooleanExpression, mapSpecQueryColumns, sortSpecQuery, traverseQuerySpec } from "./drivers/pframe/query/utils.js";
45
45
  import { PFrameDriver, PFrameHandle, PTableHandle } from "./drivers/pframe/driver.js";
46
46
  import { CompositeLinkerMap, LinkerMap } from "./drivers/pframe/linker_columns.js";
47
+ import { AxisQualification, ColumnAxesWithQualifications, DiscoverColumnsConstraints, DiscoverColumnsLinkerStep, DiscoverColumnsMappingVariant, DiscoverColumnsRequest, DiscoverColumnsResponse, DiscoverColumnsResponseHit, DiscoverColumnsResponseQualifications, DiscoverColumnsStepInfo, MatcherMap, MultiAxisSelector, MultiColumnSelector, PFrameSpecDriver, SpecFrameHandle, StringMatcher } from "./drivers/pframe/spec_driver.js";
47
48
  import { FileRange, ImportFileHandle, ImportFileHandleIndex, ImportFileHandleUpload, ListFilesResult, LocalImportFileHandle, LsDriver, LsEntry, OpenDialogFilter, OpenDialogOps, OpenMultipleFilesResponse, OpenSingleFileResponse, StorageEntry, StorageHandle, StorageHandleLocal, StorageHandleRemote, getFileNameFromHandle, getFilePathFromHandle, isImportFileHandleIndex, isImportFileHandleUpload } from "./drivers/ls.js";
48
- import { AxisQualification, ColumnAxesWithQualifications, DiscoverColumnsConstraints, DiscoverColumnsMappingVariant, DiscoverColumnsRequest, DiscoverColumnsResponse, DiscoverColumnsResponseHit, DiscoverColumnsResponseQualifications, MatcherMap, MultiAxisSelector, MultiColumnSelector, PSpecDriver, SpecFrameHandle, StringMatcher } from "./drivers/pspec.js";
49
49
  import { ChunkedStreamReader, ChunkedStreamReaderOptions, ErrorHandlerStatus } from "./drivers/ChunkedStreamReader.js";
50
50
  import "./drivers/index.js";
51
51
  import { DriverKit } from "./driver_kit.js";
52
- import { AbortError, PFrameDriverError, PFrameError, ResultOrError, SerializedError, UiError, deserializeError, deserializeResult, ensureError, hasAbortError, isAbortError, isAggregateError, isPFrameDriverError, isPFrameError, serializeError, serializeResult, unwrapResult, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback } from "./errors.js";
52
+ import { AbortError, PFrameDriverError, PFrameError, PFrameSpecDriverError, ResultOrError, SerializedError, UiError, deserializeError, deserializeResult, ensureError, hasAbortError, isAbortError, isAggregateError, isPFrameDriverError, isPFrameError, isPFrameSpecDriverError, serializeError, serializeResult, unwrapResult, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback } from "./errors.js";
53
53
  import { PlId, PlIdBytes, PlIdLength, digestPlId, plId, uniquePlId } from "./plid.js";
54
54
  import { ValueWithUTag, ValueWithUTagAndAuthor } from "./utag.js";
55
55
  import { ValueOrError, mapValueInVOE } from "./value_or_error.js";
@@ -57,4 +57,4 @@ import { Base64Compatible, Base64Encoded, base64Decode, base64Encode } from "./b
57
57
  import { assertNever, uniqueBy } from "./util.js";
58
58
  import { BasicHttpAuth, HttpAuth, parseHttpAuth, serializeHttpAuth } from "./httpAuth.js";
59
59
  import { ResourceTypeName, ResourceTypePrefix } from "./resource_types.js";
60
- export { AAxisSelector, ADomain, AbortError, AllRequiresFeatureFlags, AllSupportsFeatureFlags, AnchorAxisIdOrRefBasic, AnchorAxisRef, AnchorAxisRefByIdx, AnchorAxisRefByMatcher, AnchorAxisRefByName, AnchorDomainRef, AnchoredColumnMatchStrategy, AnchoredIdDeriver, AnchoredPColumnId, AnchoredPColumnSelector, Annotation, AnnotationJson, AnyFunction, AnyLogHandle, ArchiveFormat, ArrayTypeUnion, ArtificialColumnJoinEntry, Assert, AssertKeysEqual, AuthorMarker, AxesId, AxesSpec, AxisFilter, AxisFilterByIdx, AxisFilterByName, AxisFilterValue, AxisId, AxisQualification, AxisSpec, AxisSpecNormalized, AxisTree, AxisValueType, Base64Compatible, Base64Encoded, BasicHttpAuth, BinaryChunk, BinaryPartitionedDataInfo, BinaryPartitionedDataInfoEntries, BlobDriver, BlobHandleAndSize, BlobLike, BlobToURLDriver, BlockCodeFeatureFlags, BlockCodeKnownFeatureFlags, BlockCodeWithInfo, BlockConfigContainer, BlockConfigGeneric, BlockConfigV3Generic, BlockConfigV4Generic, BlockOutputsBase, BlockRenderingMode, BlockSection, BlockSectionDelimiter, BlockSectionLink, BlockSectionLinkAppearance, BlockState, BlockStateV3, BlockUIURL, Branded, CalculateTableDataRequest, CalculateTableDataResponse, CanonicalizedJson, ChunkedStreamReader, ChunkedStreamReaderOptions, Code, ColumnAxesWithQualifications, ColumnFilter, ColumnJoinEntry, ColumnValueType, CompositeLinkerMap, ConstantAxisFilter, ContentHandler, DataExprAxisRef, DataExprColumnRef, DataInfo, DataInfoEntries, DataQuery, DataQueryBooleanExpression, DataQueryColumn, DataQueryExpression, DataQueryFilter, DataQueryInlineColumn, DataQueryJoinEntry, DataQueryOuterJoin, DataQuerySliceAxes, DataQuerySort, DataQuerySparseToDenseColumn, DataQuerySymmetricJoin, DefaultNavigationState, DiscoverColumnsConstraints, DiscoverColumnsMappingVariant, DiscoverColumnsRequest, DiscoverColumnsResponse, DiscoverColumnsResponseHit, DiscoverColumnsResponseQualifications, Domain, DomainJson, DriverKit, ErrorHandlerStatus, FileLike, FileRange, FilterKeysByPrefix, FilterSpec, FilterSpecLeaf, FilterSpecNode, FilterSpecOfType, FilterSpecType, FilteredPColumn, FilteredPColumnId, FindColumnsRequest, FindColumnsResponse, FolderURL, FrontendDriver, FullJoin, FullPTableColumnData, GetContentOptions, HttpAuth, ImportFileHandle, ImportFileHandleIndex, ImportFileHandleUpload, ImportProgress, ImportStatus, IncompatibleFlagsError, InferFilterSpecCommonLeaf, InferFilterSpecCommonNode, InferFilterSpecLeaf, InferFilterSpecLeafColumn, InlineColumnJoinEntry, InnerJoin, Is, IsSubtypeOf, JoinEntry, JsonCompatible, JsonDataInfo, JsonDataInfoEntries, JsonPartitionedDataInfo, JsonPartitionedDataInfoEntries, JsonSerializable, LegacyAxisSelector, LinkerMap, ListFilesResult, ListOptionBase, LiveLogHandle, LocalBlobHandle, LocalBlobHandleAndSize, LocalImportFileHandle, LogsDriver, LsDriver, LsEntry, MatcherMap, Metadata, MetadataJson, MultiAxisSelector, MultiColumnSelector, NativePObjectId, NavigationState, OpenDialogFilter, OpenDialogOps, OpenMultipleFilesResponse, OpenSingleFileResponse, Option, OuterJoin, OutputWithStatus, PAxisName, PColumn, PColumnDataEntry, PColumnIdAndSpec, PColumnInfo, PColumnKey, PColumnLazy, PColumnName, PColumnSelector, PColumnSpec, PColumnSpecId, PColumnValue, PColumnValues, PColumnValuesEntry, PDataColumnSpec, PFrame, PFrameDef, PFrameDriver, PFrameDriverError, PFrameError, PFrameHandle, PObject, PObjectId, PObjectSpec, PSpecDriver, PSpecPredicate, PTable, PTableAbsent, PTableColumnId, PTableColumnIdAxis, PTableColumnIdColumn, PTableColumnSpec, PTableColumnSpecAxis, PTableColumnSpecColumn, PTableDef, PTableDefV2, PTableHandle, PTableNA, PTableRecordFilter, PTableRecordSingleValueFilterV2, PTableShape, PTableSorting, PTableValue, PTableValueAxis, PTableValueBranded, PTableValueData, PTableValueDataBranded, PTableValueDouble, PTableValueFloat, PTableValueInt, PTableValueLong, PTableValueString, PTableVector, PTableVectorTyped, PUniversalColumnSpec, PVectorData, PVectorDataBytes, PVectorDataDouble, PVectorDataFloat, PVectorDataInt, PVectorDataLong, PVectorDataString, PVectorDataTyped, ParquetChunk, ParquetChunkMapping, ParquetChunkMappingAxis, ParquetChunkMappingColumn, ParquetChunkMetadata, ParquetChunkStats, ParquetPartitionedDataInfo, ParquetPartitionedDataInfoEntries, PartitionedDataInfoEntries, PlId, PlIdBytes, PlIdLength, PlRef, ProgressLogWithInfo, RangeBytes, ReadyLogHandle, Ref, RemoteBlobHandle, RemoteBlobHandleAndSize, ResolveAnchorsOptions, ResourceTypeName, ResourceTypePrefix, ResultCollection, ResultOrError, ResultPoolEntry, RootFilterSpec, RuntimeCapabilities, SUniversalPColumnId, SerializedError, SingleAxisSelector, SingleValueAndPredicateV2, SingleValueEqualPredicate, SingleValueGreaterOrEqualPredicate, SingleValueGreaterPredicate, SingleValueIEqualPredicate, SingleValueInSetPredicate, SingleValueIsNAPredicate, SingleValueLessOrEqualPredicate, SingleValueLessPredicate, SingleValueMatchesPredicate, SingleValueNotPredicateV2, SingleValueOrPredicateV2, SingleValuePredicateV2, SingleValueStringContainsFuzzyPredicate, SingleValueStringContainsPredicate, SingleValueStringIContainsFuzzyPredicate, SingleValueStringIContainsPredicate, SlicedColumnJoinEntry, SpecExprAxisRef, SpecExprColumnRef, SpecFrameHandle, SpecQuery, SpecQueryBooleanExpression, SpecQueryColumn, SpecQueryExpression, SpecQueryFilter, SpecQueryInlineColumn, SpecQueryJoinEntry, SpecQueryOuterJoin, SpecQuerySliceAxes, SpecQuerySort, SpecQuerySparseToDenseColumn, SpecQuerySymmetricJoin, StorageEntry, StorageHandle, StorageHandleLocal, StorageHandleRemote, StreamingApiResponse, StreamingApiResponseHandleOutdated, StreamingApiResponseOk, StringMatcher, StringifiedJson, SupportedRequirement, TableRange, UiError, UniqueValuesRequest, UniqueValuesResponse, UniversalPColumnId, ValueOrError, ValueType, ValueTypeSupported, ValueWithUTag, ValueWithUTagAndAuthor, assertNever, base64Decode, base64Encode, bigintReplacer, canonicalizeAxisId, canonicalizeAxisWithParents, canonicalizeJson, checkBlockFlag, collectSpecQueryColumns, createPlRef, dataInfoToEntries, deriveNativeId, deserializeError, deserializeResult, digestPlId, ensureError, ensurePColumn, entriesToDataInfo, executePSpecPredicate, extractAllColumns, extractAllRequirements, extractAllSupports, extractCodeWithInfo, extractConfigGeneric, getArrayFromAxisTree, getAxesId, getAxesTree, getAxisId, getColumnIdAndSpec, getDenormalizedAxesList, getFileNameFromHandle, getFilePathFromHandle, getNormalizedAxesList, getPColumnSpecId, getPTableColumnId, getSetFromAxisTree, getTypeFromPColumnOrAxisSpec, hasAbortError, isAbortError, isAggregateError, isAnchoredPColumnId, isAxisId, isBlockUIURL, isBooleanExpression, isDataInfo, isDataInfoEntries, isFilteredPColumn, isFolderURL, isImportFileHandleIndex, isImportFileHandleUpload, isLabelColumn, isLinkerColumn, isLiveLog, isPColumn, isPColumnResult, isPColumnSpec, isPColumnSpecResult, isPFrameDriverError, isPFrameError, isPTableAbsent, isPTableNA, isPTableValueAxis, isPartitionedDataInfoEntries, isPlRef, legacyColumnSelectorsToPredicate, mapDataInfo, mapDataInfoEntries, mapJoinEntry, mapPObjectData, mapPTableDef, mapPTableDefV2, mapSpecQueryColumns, mapValueInVOE, matchAxis, matchAxisId, matchPColumn, newRangeBytesOpt, pTableValue, pTableValueBranded, parseColumnId, parseHttpAuth, parseJson, plId, plRefsEqual, readAnnotation, readAnnotationJson, readAnnotationJsonOrThrow, readDomain, readDomainJson, readDomainJsonOrThrow, readMetadata, readMetadataJson, readMetadataJsonOrThrow, resolveAnchors, serializeError, serializeHttpAuth, serializeResult, sortJoinEntry, sortPTableDef, sortSpecQuery, stringifyColumnId, stringifyJson, traverseQuerySpec, uniqueBy, uniquePlId, unwrapResult, validateRangeBytes, visitDataInfo, withEnrichments, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback };
60
+ export { AAxisSelector, ADomain, AbortError, AllRequiresFeatureFlags, AllSupportsFeatureFlags, AnchorAxisIdOrRefBasic, AnchorAxisRef, AnchorAxisRefByIdx, AnchorAxisRefByMatcher, AnchorAxisRefByName, AnchorDomainRef, AnchoredColumnMatchStrategy, AnchoredIdDeriver, AnchoredPColumnId, AnchoredPColumnSelector, Annotation, AnnotationJson, AnyFunction, AnyLogHandle, ArchiveFormat, ArrayTypeUnion, ArtificialColumnJoinEntry, Assert, AssertKeysEqual, AuthorMarker, AxesId, AxesSpec, AxisFilter, AxisFilterByIdx, AxisFilterByName, AxisFilterValue, AxisId, AxisQualification, AxisSpec, AxisSpecNormalized, AxisTree, AxisValueType, Base64Compatible, Base64Encoded, BasicHttpAuth, BinaryChunk, BinaryPartitionedDataInfo, BinaryPartitionedDataInfoEntries, BlobDriver, BlobHandleAndSize, BlobLike, BlobToURLDriver, BlockCodeFeatureFlags, BlockCodeKnownFeatureFlags, BlockCodeWithInfo, BlockConfigContainer, BlockConfigGeneric, BlockConfigV3Generic, BlockConfigV4Generic, BlockOutputsBase, BlockRenderingMode, BlockSection, BlockSectionDelimiter, BlockSectionLink, BlockSectionLinkAppearance, BlockState, BlockStateV3, BlockUIURL, Branded, CalculateTableDataRequest, CalculateTableDataResponse, CanonicalizedJson, ChunkedStreamReader, ChunkedStreamReaderOptions, Code, ColumnAxesWithQualifications, ColumnFilter, ColumnJoinEntry, ColumnValueType, CompositeLinkerMap, ConstantAxisFilter, ContentHandler, DataExprAxisRef, DataExprColumnRef, DataInfo, DataInfoEntries, DataQuery, DataQueryBooleanExpression, DataQueryColumn, DataQueryExpression, DataQueryFilter, DataQueryInlineColumn, DataQueryJoinEntry, DataQueryOuterJoin, DataQuerySliceAxes, DataQuerySort, DataQuerySparseToDenseColumn, DataQuerySymmetricJoin, DefaultNavigationState, DiscoverColumnsConstraints, DiscoverColumnsLinkerStep, DiscoverColumnsMappingVariant, DiscoverColumnsRequest, DiscoverColumnsResponse, DiscoverColumnsResponseHit, DiscoverColumnsResponseQualifications, DiscoverColumnsStepInfo, Domain, DomainJson, DriverKit, ErrorHandlerStatus, FileLike, FileRange, FilterKeysByPrefix, FilterSpec, FilterSpecLeaf, FilterSpecNode, FilterSpecOfType, FilterSpecType, FilteredPColumn, FilteredPColumnId, FindColumnsRequest, FindColumnsResponse, FolderURL, FrontendDriver, FullJoin, FullPTableColumnData, GetContentOptions, HttpAuth, ImportFileHandle, ImportFileHandleIndex, ImportFileHandleUpload, ImportProgress, ImportStatus, IncompatibleFlagsError, InferFilterSpecCommonLeaf, InferFilterSpecCommonNode, InferFilterSpecLeaf, InferFilterSpecLeafColumn, InlineColumnJoinEntry, InnerJoin, Is, IsSubtypeOf, JoinEntry, JsonCompatible, JsonDataInfo, JsonDataInfoEntries, JsonPartitionedDataInfo, JsonPartitionedDataInfoEntries, JsonSerializable, LegacyAxisSelector, LinkerMap, ListFilesResult, ListOptionBase, LiveLogHandle, LocalBlobHandle, LocalBlobHandleAndSize, LocalImportFileHandle, LogsDriver, LsDriver, LsEntry, MatcherMap, Metadata, MetadataJson, MultiAxisSelector, MultiColumnSelector, NativePObjectId, NavigationState, OpenDialogFilter, OpenDialogOps, OpenMultipleFilesResponse, OpenSingleFileResponse, Option, OuterJoin, OutputWithStatus, PAxisName, PColumn, PColumnDataEntry, PColumnIdAndSpec, PColumnInfo, PColumnKey, PColumnLazy, PColumnName, PColumnSelector, PColumnSpec, PColumnSpecId, PColumnValue, PColumnValues, PColumnValuesEntry, PDataColumnSpec, PFrame, PFrameDef, PFrameDriver, PFrameDriverError, PFrameError, PFrameHandle, PFrameSpecDriver, PFrameSpecDriverError, PObject, PObjectId, PObjectSpec, PSpecPredicate, PTable, PTableAbsent, PTableColumnId, PTableColumnIdAxis, PTableColumnIdColumn, PTableColumnSpec, PTableColumnSpecAxis, PTableColumnSpecColumn, PTableDef, PTableDefV2, PTableHandle, PTableNA, PTableRecordFilter, PTableRecordSingleValueFilterV2, PTableShape, PTableSorting, PTableValue, PTableValueAxis, PTableValueBranded, PTableValueData, PTableValueDataBranded, PTableValueDouble, PTableValueFloat, PTableValueInt, PTableValueLong, PTableValueString, PTableVector, PTableVectorTyped, PUniversalColumnSpec, PVectorData, PVectorDataBytes, PVectorDataDouble, PVectorDataFloat, PVectorDataInt, PVectorDataLong, PVectorDataString, PVectorDataTyped, ParquetChunk, ParquetChunkMapping, ParquetChunkMappingAxis, ParquetChunkMappingColumn, ParquetChunkMetadata, ParquetChunkStats, ParquetPartitionedDataInfo, ParquetPartitionedDataInfoEntries, PartitionedDataInfoEntries, PlId, PlIdBytes, PlIdLength, PlRef, ProgressLogWithInfo, RangeBytes, ReadyLogHandle, Ref, RemoteBlobHandle, RemoteBlobHandleAndSize, ResolveAnchorsOptions, ResourceTypeName, ResourceTypePrefix, ResultCollection, ResultOrError, ResultPoolEntry, RootFilterSpec, RuntimeCapabilities, SUniversalPColumnId, SerializedError, SingleAxisSelector, SingleValueAndPredicateV2, SingleValueEqualPredicate, SingleValueGreaterOrEqualPredicate, SingleValueGreaterPredicate, SingleValueIEqualPredicate, SingleValueInSetPredicate, SingleValueIsNAPredicate, SingleValueLessOrEqualPredicate, SingleValueLessPredicate, SingleValueMatchesPredicate, SingleValueNotPredicateV2, SingleValueOrPredicateV2, SingleValuePredicateV2, SingleValueStringContainsFuzzyPredicate, SingleValueStringContainsPredicate, SingleValueStringIContainsFuzzyPredicate, SingleValueStringIContainsPredicate, SlicedColumnJoinEntry, SpecExprAxisRef, SpecExprColumnRef, SpecFrameHandle, SpecQuery, SpecQueryBooleanExpression, SpecQueryColumn, SpecQueryExpression, SpecQueryFilter, SpecQueryInlineColumn, SpecQueryJoinEntry, SpecQueryOuterJoin, SpecQuerySliceAxes, SpecQuerySort, SpecQuerySparseToDenseColumn, SpecQuerySymmetricJoin, StorageEntry, StorageHandle, StorageHandleLocal, StorageHandleRemote, StreamingApiResponse, StreamingApiResponseHandleOutdated, StreamingApiResponseOk, StringMatcher, StringifiedJson, SupportedRequirement, TableRange, UiError, UniqueValuesRequest, UniqueValuesResponse, UniversalPColumnId, ValueOrError, ValueType, ValueTypeSupported, ValueWithUTag, ValueWithUTagAndAuthor, assertNever, base64Decode, base64Encode, bigintReplacer, canonicalizeAxisId, canonicalizeAxisWithParents, canonicalizeJson, checkBlockFlag, collectSpecQueryColumns, createPlRef, dataInfoToEntries, deriveNativeId, deserializeError, deserializeResult, digestPlId, ensureError, ensurePColumn, entriesToDataInfo, executePSpecPredicate, extractAllColumns, extractAllRequirements, extractAllSupports, extractCodeWithInfo, extractConfigGeneric, getArrayFromAxisTree, getAxesId, getAxesTree, getAxisId, getColumnIdAndSpec, getDenormalizedAxesList, getFileNameFromHandle, getFilePathFromHandle, getNormalizedAxesList, getPColumnSpecId, getPTableColumnId, getSetFromAxisTree, getTypeFromPColumnOrAxisSpec, hasAbortError, isAbortError, isAggregateError, isAnchoredPColumnId, isAxisId, isBlockUIURL, isBooleanExpression, isDataInfo, isDataInfoEntries, isFilteredPColumn, isFolderURL, isImportFileHandleIndex, isImportFileHandleUpload, isLabelColumn, isLinkerColumn, isLiveLog, isPColumn, isPColumnResult, isPColumnSpec, isPColumnSpecResult, isPFrameDriverError, isPFrameError, isPFrameSpecDriverError, isPTableAbsent, isPTableNA, isPTableValueAxis, isPartitionedDataInfoEntries, isPlRef, legacyColumnSelectorsToPredicate, mapDataInfo, mapDataInfoEntries, mapJoinEntry, mapPObjectData, mapPTableDef, mapPTableDefV2, mapSpecQueryColumns, mapValueInVOE, matchAxis, matchAxisId, matchPColumn, newRangeBytesOpt, pTableValue, pTableValueBranded, parseColumnId, parseHttpAuth, parseJson, plId, plRefsEqual, readAnnotation, readAnnotationJson, readAnnotationJsonOrThrow, readDomain, readDomainJson, readDomainJsonOrThrow, readMetadata, readMetadataJson, readMetadataJsonOrThrow, resolveAnchors, serializeError, serializeHttpAuth, serializeResult, sortJoinEntry, sortPTableDef, sortSpecQuery, stringifyColumnId, stringifyJson, traverseQuerySpec, uniqueBy, uniquePlId, unwrapResult, validateRangeBytes, visitDataInfo, withEnrichments, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback };
package/dist/index.js CHANGED
@@ -8,7 +8,7 @@ import { isLiveLog } from "./drivers/log.js";
8
8
  import { assertNever, uniqueBy } from "./util.js";
9
9
  import { getFileNameFromHandle, getFilePathFromHandle, isImportFileHandleIndex, isImportFileHandleUpload } from "./drivers/ls.js";
10
10
  import { dataInfoToEntries, entriesToDataInfo, isDataInfo, isDataInfoEntries, isPartitionedDataInfoEntries, mapDataInfo, mapDataInfoEntries, visitDataInfo } from "./drivers/pframe/data_info.js";
11
- import { AbortError, PFrameDriverError, PFrameError, UiError, deserializeError, deserializeResult, ensureError, hasAbortError, isAbortError, isAggregateError, isPFrameDriverError, isPFrameError, serializeError, serializeResult, unwrapResult, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback } from "./errors.js";
11
+ import { AbortError, PFrameDriverError, PFrameError, PFrameSpecDriverError, UiError, deserializeError, deserializeResult, ensureError, hasAbortError, isAbortError, isAggregateError, isPFrameDriverError, isPFrameError, isPFrameSpecDriverError, serializeError, serializeResult, unwrapResult, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback } from "./errors.js";
12
12
  import { bigintReplacer, canonicalizeJson, parseJson, stringifyJson } from "./json.js";
13
13
  import { Annotation, AnnotationJson, Domain, DomainJson, PAxisName, PColumnName, ValueType, canonicalizeAxisId, canonicalizeAxisWithParents, getArrayFromAxisTree, getAxesId, getAxesTree, getAxisId, getColumnIdAndSpec, getDenormalizedAxesList, getNormalizedAxesList, getPColumnSpecId, getSetFromAxisTree, getTypeFromPColumnOrAxisSpec, isAxisId, isLabelColumn, isLinkerColumn, matchAxisId, readAnnotation, readAnnotationJson, readAnnotationJsonOrThrow, readDomain, readDomainJson, readDomainJsonOrThrow, readMetadata, readMetadataJson, readMetadataJsonOrThrow } from "./drivers/pframe/spec/spec.js";
14
14
  import { PTableAbsent, PTableNA, isPTableAbsent, isPTableNA, isPTableValueAxis, pTableValue, pTableValueBranded } from "./drivers/pframe/data_types.js";
@@ -35,4 +35,4 @@ import { base64Decode, base64Encode } from "./base64.js";
35
35
  import { parseHttpAuth, serializeHttpAuth } from "./httpAuth.js";
36
36
  import { ResourceTypeName, ResourceTypePrefix } from "./resource_types.js";
37
37
 
38
- export { AbortError, AllRequiresFeatureFlags, AllSupportsFeatureFlags, AnchoredIdDeriver, Annotation, AnnotationJson, ChunkedStreamReader, Code, DefaultNavigationState, Domain, DomainJson, IncompatibleFlagsError, LinkerMap, PAxisName, PColumnName, PFrameDriverError, PFrameError, PTableAbsent, PTableNA, PlId, PlIdBytes, PlIdLength, PlRef, RangeBytes, ResourceTypeName, ResourceTypePrefix, RuntimeCapabilities, UiError, ValueType, assertNever, base64Decode, base64Encode, bigintReplacer, canonicalizeAxisId, canonicalizeAxisWithParents, canonicalizeJson, checkBlockFlag, collectSpecQueryColumns, createPlRef, dataInfoToEntries, deriveNativeId, deserializeError, deserializeResult, digestPlId, ensureError, ensurePColumn, entriesToDataInfo, executePSpecPredicate, extractAllColumns, extractAllRequirements, extractAllSupports, extractCodeWithInfo, extractConfigGeneric, getArrayFromAxisTree, getAxesId, getAxesTree, getAxisId, getColumnIdAndSpec, getDenormalizedAxesList, getFileNameFromHandle, getFilePathFromHandle, getNormalizedAxesList, getPColumnSpecId, getPTableColumnId, getSetFromAxisTree, getTypeFromPColumnOrAxisSpec, hasAbortError, isAbortError, isAggregateError, isAnchoredPColumnId, isAxisId, isBlockUIURL, isBooleanExpression, isDataInfo, isDataInfoEntries, isFilteredPColumn, isFolderURL, isImportFileHandleIndex, isImportFileHandleUpload, isLabelColumn, isLinkerColumn, isLiveLog, isPColumn, isPColumnResult, isPColumnSpec, isPColumnSpecResult, isPFrameDriverError, isPFrameError, isPTableAbsent, isPTableNA, isPTableValueAxis, isPartitionedDataInfoEntries, isPlRef, legacyColumnSelectorsToPredicate, mapDataInfo, mapDataInfoEntries, mapJoinEntry, mapPObjectData, mapPTableDef, mapPTableDefV2, mapSpecQueryColumns, mapValueInVOE, matchAxis, matchAxisId, matchPColumn, newRangeBytesOpt, pTableValue, pTableValueBranded, parseColumnId, parseHttpAuth, parseJson, plId, plRefsEqual, readAnnotation, readAnnotationJson, readAnnotationJsonOrThrow, readDomain, readDomainJson, readDomainJsonOrThrow, readMetadata, readMetadataJson, readMetadataJsonOrThrow, resolveAnchors, serializeError, serializeHttpAuth, serializeResult, sortJoinEntry, sortPTableDef, sortSpecQuery, stringifyColumnId, stringifyJson, traverseQuerySpec, uniqueBy, uniquePlId, unwrapResult, validateRangeBytes, visitDataInfo, withEnrichments, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback };
38
+ export { AbortError, AllRequiresFeatureFlags, AllSupportsFeatureFlags, AnchoredIdDeriver, Annotation, AnnotationJson, ChunkedStreamReader, Code, DefaultNavigationState, Domain, DomainJson, IncompatibleFlagsError, LinkerMap, PAxisName, PColumnName, PFrameDriverError, PFrameError, PFrameSpecDriverError, PTableAbsent, PTableNA, PlId, PlIdBytes, PlIdLength, PlRef, RangeBytes, ResourceTypeName, ResourceTypePrefix, RuntimeCapabilities, UiError, ValueType, assertNever, base64Decode, base64Encode, bigintReplacer, canonicalizeAxisId, canonicalizeAxisWithParents, canonicalizeJson, checkBlockFlag, collectSpecQueryColumns, createPlRef, dataInfoToEntries, deriveNativeId, deserializeError, deserializeResult, digestPlId, ensureError, ensurePColumn, entriesToDataInfo, executePSpecPredicate, extractAllColumns, extractAllRequirements, extractAllSupports, extractCodeWithInfo, extractConfigGeneric, getArrayFromAxisTree, getAxesId, getAxesTree, getAxisId, getColumnIdAndSpec, getDenormalizedAxesList, getFileNameFromHandle, getFilePathFromHandle, getNormalizedAxesList, getPColumnSpecId, getPTableColumnId, getSetFromAxisTree, getTypeFromPColumnOrAxisSpec, hasAbortError, isAbortError, isAggregateError, isAnchoredPColumnId, isAxisId, isBlockUIURL, isBooleanExpression, isDataInfo, isDataInfoEntries, isFilteredPColumn, isFolderURL, isImportFileHandleIndex, isImportFileHandleUpload, isLabelColumn, isLinkerColumn, isLiveLog, isPColumn, isPColumnResult, isPColumnSpec, isPColumnSpecResult, isPFrameDriverError, isPFrameError, isPFrameSpecDriverError, isPTableAbsent, isPTableNA, isPTableValueAxis, isPartitionedDataInfoEntries, isPlRef, legacyColumnSelectorsToPredicate, mapDataInfo, mapDataInfoEntries, mapJoinEntry, mapPObjectData, mapPTableDef, mapPTableDefV2, mapSpecQueryColumns, mapValueInVOE, matchAxis, matchAxisId, matchPColumn, newRangeBytesOpt, pTableValue, pTableValueBranded, parseColumnId, parseHttpAuth, parseJson, plId, plRefsEqual, readAnnotation, readAnnotationJson, readAnnotationJsonOrThrow, readDomain, readDomainJson, readDomainJsonOrThrow, readMetadata, readMetadataJson, readMetadataJsonOrThrow, resolveAnchors, serializeError, serializeHttpAuth, serializeResult, sortJoinEntry, sortPTableDef, sortSpecQuery, stringifyColumnId, stringifyJson, traverseQuerySpec, uniqueBy, uniquePlId, unwrapResult, validateRangeBytes, visitDataInfo, withEnrichments, wrapAndSerialize, wrapAndSerializeAsync, wrapAsyncCallback, wrapCallback };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@milaboratories/pl-model-common",
3
- "version": "1.27.0",
3
+ "version": "1.29.0",
4
4
  "description": "Platforma SDK Model",
5
5
  "files": [
6
6
  "./dist/**/*",
@@ -19,16 +19,16 @@
19
19
  "dependencies": {
20
20
  "canonicalize": "~2.1.0",
21
21
  "zod": "~3.23.8",
22
- "@milaboratories/pl-error-like": "1.12.9",
23
- "@milaboratories/helpers": "1.14.0"
22
+ "@milaboratories/helpers": "1.14.0",
23
+ "@milaboratories/pl-error-like": "1.12.9"
24
24
  },
25
25
  "devDependencies": {
26
26
  "@vitest/coverage-istanbul": "^4.0.18",
27
27
  "typescript": "~5.9.3",
28
28
  "vitest": "^4.0.18",
29
+ "@milaboratories/build-configs": "1.5.2",
29
30
  "@milaboratories/ts-builder": "1.3.0",
30
- "@milaboratories/ts-configs": "1.2.2",
31
- "@milaboratories/build-configs": "1.5.2"
31
+ "@milaboratories/ts-configs": "1.2.2"
32
32
  },
33
33
  "scripts": {
34
34
  "build": "ts-builder build --target node",
@@ -7,5 +7,4 @@ export * from "./log";
7
7
  export * from "./ls";
8
8
 
9
9
  export * from "./pframe";
10
- export * from "./pspec";
11
10
  export * from "./ChunkedStreamReader";
@@ -15,3 +15,4 @@ export * from "./spec";
15
15
  export * from "./driver";
16
16
 
17
17
  export * from "./linker_columns";
18
+ export * from "./spec_driver";
@@ -303,7 +303,7 @@ export function isLinkerColumn(column: PColumnSpec): boolean {
303
303
  */
304
304
  export type AxisSpec = {
305
305
  /** Type of the axis value. Should not use non-key types like float or double. */
306
- readonly type: ValueType;
306
+ readonly type: AxisValueType;
307
307
 
308
308
  /** Name of the axis */
309
309
  readonly name: string;
@@ -706,7 +706,7 @@ export interface PColumnInfo extends PColumnIdAndSpec {
706
706
  export interface AxisId {
707
707
  /** Type of the axis or column value. For an axis should not use non-key
708
708
  * types like float or double. */
709
- readonly type: ValueType;
709
+ readonly type: AxisValueType;
710
710
 
711
711
  /** Name of the axis or column */
712
712
  readonly name: string;
@@ -1,16 +1,26 @@
1
1
  import type { Branded } from "@milaboratories/helpers";
2
2
  import type {
3
- ValueType,
4
- SingleAxisSelector,
5
3
  AxisSpec,
4
+ AxesSpec,
5
+ AxesId,
6
6
  PColumnIdAndSpec,
7
7
  PColumnSpec,
8
- } from "./pframe";
9
-
10
- // --- Discover columns types (duplicated from middle-layer internal_api) ---
8
+ SingleAxisSelector,
9
+ AxisValueType,
10
+ ColumnValueType,
11
+ } from "./spec";
12
+ import type { PTableColumnId, PTableColumnSpec } from "./table_common";
11
13
 
12
14
  /** Matches a string value either exactly or by regex pattern */
13
- export type StringMatcher = { type: "exact"; value: string } | { type: "regex"; value: string };
15
+ export type StringMatcher =
16
+ | {
17
+ type: "exact";
18
+ value: string;
19
+ }
20
+ | {
21
+ type: "regex";
22
+ value: string;
23
+ };
14
24
 
15
25
  /** Map of key to array of string matchers (OR-ed per key, AND-ed across keys) */
16
26
  export type MatcherMap = Record<string, StringMatcher[]>;
@@ -18,7 +28,7 @@ export type MatcherMap = Record<string, StringMatcher[]>;
18
28
  /** Selector for matching axes by various criteria */
19
29
  export interface MultiAxisSelector {
20
30
  /** Match any of the axis types listed here */
21
- readonly type?: ValueType[];
31
+ readonly type?: AxisValueType[];
22
32
  /** Match any of the axis names listed here */
23
33
  readonly name?: StringMatcher[];
24
34
  /** Match requires all the domains listed here */
@@ -33,7 +43,7 @@ export interface MultiAxisSelector {
33
43
  * Multiple selectors are OR-ed: a column matches if it satisfies any selector. */
34
44
  export interface MultiColumnSelector {
35
45
  /** Match any of the value types listed here */
36
- readonly type?: ValueType[];
46
+ readonly type?: ColumnValueType[];
37
47
  /** Match any of the names listed here */
38
48
  readonly name?: StringMatcher[];
39
49
  /** Match requires all the domains listed here */
@@ -78,14 +88,30 @@ export interface DiscoverColumnsConstraints {
78
88
 
79
89
  /** Request for discovering columns compatible with a given axes integration */
80
90
  export interface DiscoverColumnsRequest {
81
- /** Column filters (OR-ed); empty array matches all columns */
82
- columnFilter?: MultiColumnSelector[];
91
+ /** Include columns matching these selectors (OR-ed); empty or omitted matches all columns */
92
+ includeColumns?: MultiColumnSelector[];
93
+ /** Exclude columns matching these selectors (OR-ed); applied after include filter */
94
+ excludeColumns?: MultiColumnSelector[];
83
95
  /** Already integrated axes with qualifications */
84
96
  axes: ColumnAxesWithQualifications[];
97
+ /** Maximum number of hops allowed between provided axes integration and returned hits (0 = direct only) */
98
+ maxHops?: number;
85
99
  /** Constraints controlling axes matching and qualification behavior */
86
100
  constraints: DiscoverColumnsConstraints;
87
101
  }
88
102
 
103
+ /** Linker step: traversal through a linker column */
104
+ export interface DiscoverColumnsLinkerStep {
105
+ type: "linker";
106
+ /** The linker column traversed in this step */
107
+ linker: PColumnIdAndSpec;
108
+ /** Axis qualifications produced when matching the linker's many-side axes */
109
+ qualifications: AxisQualification[];
110
+ }
111
+
112
+ /** A step traversed during path-based column discovery. Discriminated by `type`. */
113
+ export type DiscoverColumnsStepInfo = DiscoverColumnsLinkerStep;
114
+
89
115
  /** Qualifications info for a discover columns response mapping variant */
90
116
  export interface DiscoverColumnsResponseQualifications {
91
117
  /** Qualifications for each query (already-integrated) column set */
@@ -108,6 +134,8 @@ export interface DiscoverColumnsResponseHit {
108
134
  hit: PColumnIdAndSpec;
109
135
  /** Possible ways to integrate this column with the existing set */
110
136
  mappingVariants: DiscoverColumnsMappingVariant[];
137
+ /** Linker steps traversed to reach this hit; empty for direct matches */
138
+ path: DiscoverColumnsStepInfo[];
111
139
  }
112
140
 
113
141
  /** Response from discover columns */
@@ -116,8 +144,6 @@ export interface DiscoverColumnsResponse {
116
144
  hits: DiscoverColumnsResponseHit[];
117
145
  }
118
146
 
119
- // --- Spec driver ---
120
-
121
147
  /** Handle to a spec-only PFrame (no data, synchronous operations). */
122
148
  export type SpecFrameHandle = Branded<string, "SpecFrameHandle">;
123
149
 
@@ -128,7 +154,7 @@ export type SpecFrameHandle = Branded<string, "SpecFrameHandle">;
128
154
  * operates on column specifications only. All methods are synchronous
129
155
  * because the underlying WASM PFrame computes results immediately.
130
156
  */
131
- export interface PSpecDriver {
157
+ export interface PFrameSpecDriver {
132
158
  /** Create a spec-only PFrame from column specs. Returns a handle. */
133
159
  createSpecFrame(specs: Record<string, PColumnSpec>): SpecFrameHandle;
134
160
 
@@ -140,4 +166,16 @@ export interface PSpecDriver {
140
166
 
141
167
  /** Dispose a spec frame, freeing WASM resources. */
142
168
  disposeSpecFrame(handle: SpecFrameHandle): void;
169
+
170
+ /** Expand index-based parentAxes in AxesSpec to resolved AxisId parents in AxesId. */
171
+ expandAxes(spec: AxesSpec): AxesId;
172
+
173
+ /** Collapse resolved AxisId parents back to index-based parentAxes in AxesSpec. */
174
+ collapseAxes(ids: AxesId): AxesSpec;
175
+
176
+ /** Find the index of an axis matching the given selector. Returns -1 if not found. */
177
+ findAxis(spec: AxesSpec, selector: SingleAxisSelector): number;
178
+
179
+ /** Find the flat index of a table column matching the given selector. Returns -1 if not found. */
180
+ findTableColumn(tableSpec: PTableColumnSpec[], selector: PTableColumnId): number;
143
181
  }
package/src/errors.ts CHANGED
@@ -44,6 +44,14 @@ export function isPFrameDriverError(error: unknown): error is PFrameDriverError
44
44
  return error instanceof Error && error.name === "PFrameError.Driver";
45
45
  }
46
46
 
47
+ export class PFrameSpecDriverError extends PFrameError {
48
+ name = "PFrameError.SpecDriver";
49
+ }
50
+
51
+ export function isPFrameSpecDriverError(error: unknown): error is PFrameSpecDriverError {
52
+ return error instanceof Error && error.name === "PFrameError.SpecDriver";
53
+ }
54
+
47
55
  function stringifyValue(value: unknown): string {
48
56
  if (typeof value === "string") {
49
57
  return `String value was thrown: ${value}`;