@ocelescope/core 0.10.2 → 0.11.0

package/dist/index.d.ts

@@ -5,7 +5,6 @@ import { ComponentProps, ComponentType, JSX, SVGProps } from "react";
 import { Dropzone, FileWithPath } from "@mantine/dropzone";
 import { ViewerConfig, ViewerProps } from "@r4pm/components";
 import { GetStaticPaths, GetStaticProps, NextApiRequest, NextApiResponse } from "next";
-//#region src/components/AttributeTable.d.ts
 type OcelVersion$1 = "original" | "filtered";
 declare const AttributesTable: React.FC<{
   ocelId: string;
@@ -15,22 +14,21 @@ declare const AttributesTable: React.FC<{
   hideRange?: boolean;
   hideValues?: boolean;
   ocelVersion?: OcelVersion$1;
+  viewId?: string;
   alwaysExpandable?: boolean;
   visibleAttributes?: string[];
   height?: string | number;
   className?: string;
   style?: React.CSSProperties;
 }>;
-//#endregion
-//#region src/components/BarList/BarList.d.ts
 export declare const BarList: React.FC<{
   data: Record<string, number>;
   labelHeader: string;
   valueHeader?: string;
   maxVisibleItems?: number;
+  className?: string;
+  style?: React.CSSProperties;
 }>;
-//#endregion
-//#region src/components/charts/types.d.ts
 /** One row of a tidy result: a value per column. */
 type Row = Record<string, unknown>;
 /** A tidy table: its rows, and the type its source reported per column. */
@@ -104,16 +102,12 @@ interface Series {
    * zero. Plotly decides the axis from what it is given. */
   values: Array<number | string>;
 }
-//#endregion
-//#region src/components/charts/BarChart.d.ts
 interface BarChartProps extends CartesianChartProps {
   /** Stack the traces instead of standing them side by side. */
   stacked?: boolean;
   /** Bars along the x axis, which long category names need. */
   horizontal?: boolean;
 }
-//#endregion
-//#region src/components/charts/HistogramChart.d.ts
 interface HistogramChartProps extends Omit<ChartProps, "series"> {
   /** Column holding each bin's upper edge; `x` holds its lower one. A row
    * without a lower edge counts everything below its upper one, and the
@@ -121,8 +115,6 @@ interface HistogramChartProps extends Omit<ChartProps, "series"> {
    * stretching the axis. */
   xEnd: string;
 }
-//#endregion
-//#region src/components/charts/LineChart.d.ts
 interface LineChartProps extends CartesianChartProps {
   /** Hold each value until the next one, instead of sloping between them.
    * What a thing was worth between two readings is what it last read. */
@@ -132,26 +124,16 @@ interface LineChartProps extends CartesianChartProps {
    * line colour, so the association stays visible without separate plots. */
   yAxes?: "shared" | "independent";
 }
-//#endregion
-//#region src/components/charts/PieChart.d.ts
 interface PieChartProps extends ChartProps {
   /** The hole in the middle, as a share of the radius. 0 for a full pie. */
   hole?: number;
 }
-//#endregion
-//#region src/components/charts/SunburstChart.d.ts
 interface SunburstChartProps extends ChartProps {
   /** The rings, innermost first. Defaults to the category, then the series. */
   path?: readonly string[];
 }
-//#endregion
-//#region src/components/charts/AreaChart.d.ts
 type AreaChartProps = CartesianChartProps;
-//#endregion
-//#region src/components/charts/ScatterChart.d.ts
 type ScatterChartProps = CartesianChartProps;
-//#endregion
-//#region src/components/charts/index.d.ts
 interface OcelChartProps extends ChartOptions, ViewerConfig {
   /** DuckDB SQL over the OCEL's stored tables: `events`, `objects`, `e2o`,
    * `o2o`, `object_changes`. One `SELECT`; the backend refuses anything else. */
@@ -173,8 +155,6 @@ export declare const PieChart: import("react").ComponentType<PieChartProps>;
 export declare const SunburstChart: import("react").ComponentType<SunburstChartProps>;
 export declare const SqlChart: import("react").ComponentType<SqlChartProps>;
 export declare const OcelChart: import("react").ComponentType<OcelChartProps>;
-//#endregion
-//#region src/components/Dropzone/Dropzone.d.ts
 export declare const FileDropzone: React.FC<{
   onUpload: (files: FileWithPath[]) => void;
   accept?: ComponentProps<typeof Dropzone>["accept"];
@@ -185,25 +165,17 @@ export declare const FileDropzone: React.FC<{
     description?: React.ReactNode;
   };
 }>;
-//#endregion
-//#region src/components/Dropzone/FullScreenUpload.d.ts
 export declare const FullScreenUpload: React.FC<{
   onSuccess?: () => void;
   accept?: ComponentProps<typeof Dropzone.FullScreen>["accept"];
   label?: React.ReactNode;
   active?: boolean;
 }>;
-//#endregion
-//#region src/components/EventHandler.d.ts
 export declare const sseHandler: (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
-//#endregion
-//#region src/components/HelpModal/HelpModal.d.ts
 export declare const HelpModal: React.FC<{
   visible: boolean;
   onClose: () => void;
 }>;
-//#endregion
-//#region src/lib/config.d.ts
 type Author = {
   name: string;
   link?: string;
@@ -231,8 +203,6 @@ export type OcelescopeConfig = {
 };
 export declare const defineModule: (def: ModuleDefinition) => ModuleDefinition;
 export declare const defineModuleRoute: (def: ModuleRouteDefinition) => ModuleRouteDefinition;
-//#endregion
-//#region src/components/ModulePage.d.ts
 type ModulePageProps = {
   moduleName: string;
   routeName: string;
@@ -244,17 +214,9 @@ export declare const createModulesPage: (config: OcelescopeConfig) => {
     getInitialProps?(context: import("next").NextPageContext): ModulePageProps | Promise<ModulePageProps>;
   };
 };
-//#endregion
-//#region src/components/OcelescopeApp.d.ts
 export declare const OcelescopeApp: (config: OcelescopeConfig) => React.FC<any>;
-//#endregion
-//#region src/components/OcelescopeDocument.d.ts
 export declare const OcelescopeDocument: React.FC;
-//#endregion
-//#region src/components/OcelSelect/OcelSelect.d.ts
 export declare const OcelSelect: ({ value, ...props }: Omit<ComponentProps<typeof Select<string>>, "data">) => import("react").JSX.Element;
-//#endregion
-//#region src/components/Pickers/types.d.ts
 /** Picking one value, or none. */
 interface SingleSelection<T> {
   multiple?: false;
@@ -301,6 +263,8 @@ interface OcelSource {
   ocelId?: string;
   /** The unfiltered log, for choices that must not shift under a filter. */
   ocelVersion?: "filtered" | "original";
+  /** A view of the OCEL; takes precedence over `ocelVersion`. */
+  viewId?: string;
 }
 /** The props of a picker that reads its choices from an OCEL endpoint. */
 type OcelPickerProps<T> = OcelSource & PickerProps & Selection<T>;
@@ -322,29 +286,19 @@ type AttributeRef = {
   objectType: string;
   name: string;
 };
-//#endregion
-//#region src/components/Pickers/ActivityPicker.d.ts
 type ActivityPickerProps = OcelPickerProps<string>;
-//#endregion
-//#region src/components/Pickers/ObjectTypePicker.d.ts
 type ObjectTypePickerProps = OcelPickerProps<string> & {
   /** Offer only the object types that events of this activity relate to. */
   activity?: string;
 };
-//#endregion
-//#region src/components/Pickers/EventPicker.d.ts
 type EventPickerProps = OcelPickerProps<string> & {
   /** How many ids a search turns up. */
   limit?: number;
 };
-//#endregion
-//#region src/components/Pickers/ObjectPicker.d.ts
 type ObjectPickerProps = OcelPickerProps<string> & {
   /** How many ids a search turns up. */
   limit?: number;
 };
-//#endregion
-//#region src/components/Pickers/EventAttributePicker.d.ts
 type EventAttributePickerProps = OcelPickerProps<string> & {
   /** Offer only what events of this type carry. Without it, every attribute
    * any event in the log carries. */
@@ -352,8 +306,6 @@ type EventAttributePickerProps = OcelPickerProps<string> & {
   /** Offer only attributes of these value types, e.g. `["int", "float"]`. */
   valueTypes?: readonly ValueType[];
 };
-//#endregion
-//#region src/components/Pickers/ObjectAttributePicker.d.ts
 type ObjectAttributePickerProps = OcelPickerProps<string> & {
   /** Offer only what objects of this type carry. Without it, every attribute
    * any object in the log carries. */
@@ -361,8 +313,6 @@ type ObjectAttributePickerProps = OcelPickerProps<string> & {
   /** Offer only attributes of these value types, e.g. `["int", "float"]`. */
   valueTypes?: readonly ValueType[];
 };
-//#endregion
-//#region src/components/Pickers/AttributePicker.d.ts
 type AttributePickerProps = OcelPickerProps<AttributeRef> & {
   /** The activity whose attributes, and whose related objects'
    * attributes, are offered. */
@@ -375,22 +325,16 @@ type AttributePickerProps = OcelPickerProps<AttributeRef> & {
   /** Offer only attributes of these value types, e.g. `["int", "float"]`. */
   valueTypes?: readonly ValueType[];
 };
-//#endregion
-//#region src/components/Pickers/E2ORelationPicker.d.ts
 type E2ORelationPickerProps = OcelPickerProps<Relation> & {
   /** Offer only relations of events of this type. Without it, every event
    * type's, grouped by event type. */
   activity?: string;
 };
-//#endregion
-//#region src/components/Pickers/O2ORelationPicker.d.ts
 type O2ORelationPickerProps = OcelPickerProps<Relation> & {
   /** Offer only relations of objects of this type. Without it, every object
    * type's, grouped by object type. */
   objectType?: string;
 };
-//#endregion
-//#region src/components/Pickers/internal/options.d.ts
 /** A heading that options are shown together under. */
 interface PickerGroup {
   label: string;
@@ -430,8 +374,6 @@ type OptionPickerProps<T> = PickerProps & Selection<T> & {
    * of them a search turned up. Defaults to the number of options. */
   total?: number;
 };
-//#endregion
-//#region src/components/Pickers/index.d.ts
 export declare const OptionPicker: <T>(props: OptionPickerProps<T>) => JSX.Element;
 export declare const ActivityPicker: ComponentType<ActivityPickerProps>;
 export declare const ObjectTypePicker: ComponentType<ObjectTypePickerProps>;
@@ -442,8 +384,6 @@ export declare const ObjectAttributePicker: ComponentType<ObjectAttributePickerP
 export declare const AttributePicker: ComponentType<AttributePickerProps>;
 export declare const E2ORelationPicker: ComponentType<E2ORelationPickerProps>;
 export declare const O2ORelationPicker: ComponentType<O2ORelationPickerProps>;
-//#endregion
-//#region src/components/RelationTable.d.ts
 type RelationType = "o2o" | "e2o";
 type Direction = "source" | "target";
 type OcelVersion = "original" | "filtered";
@@ -456,6 +396,7 @@ declare const RelationTable: React.FC<{
   hideRange?: boolean;
   hideTotal?: boolean;
   ocelVersion?: OcelVersion;
+  viewId?: string;
   visibleRelations?: {
     source: string;
     target: string;
@@ -464,25 +405,17 @@ declare const RelationTable: React.FC<{
   className?: string;
   style?: React.CSSProperties;
 }>;
-//#endregion
-//#region src/components/UploadModal/UploadModal.d.ts
 export declare const UploadModal: React.FC<{
   visible: boolean;
   onClose: () => void;
 }>;
-//#endregion
-//#region src/components/UploadSection/UploadSection.d.ts
 export declare const UploadSection: React.FC<{
   onSuccess?: () => void;
 }>;
-//#endregion
-//#region src/hooks/useCurrentOCEL.d.ts
 export declare const useCurrentOcel: () => {
   id: string | null;
   setCurrentOcel: (id: string) => void;
 };
-//#endregion
-//#region src/hooks/useDownload.d.ts
 export declare const useDownloadFile: () => (path: string) => Promise<void>;
 export declare const useDownloadOCEL: () => {
   download: (ocelId: string, params?: import("@ocelescope/api-base").DownloadOCELParams | undefined) => void;
@@ -499,12 +432,8 @@ export declare const useDownloadResource: () => {
 export declare const useDownloadResourceAsPnml: () => {
   download: (resourceId: string) => void;
 };
-//#endregion
-//#region src/hooks/useInvalidate.d.ts
 type InvalidationRouteName = "ocels" | "resources" | "tasks" | "plugins" | "discoveryMethods";
 export declare const useInvalidate: () => (routeNames: InvalidationRouteName[]) => Promise<void>;
-//#endregion
-//#region src/hooks/useOcelQuery.d.ts
 interface OcelQueryOptions {
   /** DuckDB SQL over the OCEL's stored tables: `events`, `objects`, `e2o`,
    * `o2o`, `object_changes`. One `SELECT`; the backend refuses anything else. */
@@ -711,11 +640,7 @@ export declare const useOcelQuery: ({ sql, parameters, ocelVersion, enabled }: O
     [dataTagErrorSymbol]: unknown;
   };
 };
-//#endregion
-//#region src/lib/attributes.d.ts
 export declare const formatAttributeValue: (type: ValueType, value: string | number) => string | number;
-//#endregion
-//#region src/lib/env.d.ts
 export declare const env: {
   appVersion: string;
   projectPage: string;
@@ -729,8 +654,6 @@ export declare const env: {
   requestEnvironmentUrl: string;
   contactEmail: string;
 };
-//#endregion
-//#region src/lib/getModuleRoute.d.ts
 export declare const getModuleRoute: ({ moduleName, routeName, query }: {
   moduleName: string;
   routeName?: string;
@@ -741,5 +664,4 @@ export declare const getModuleRoute: ({ moduleName, routeName, query }: {
   } | undefined;
   pathname: string;
 };
-//#endregion
 export { type ActivityPickerProps, type AreaChartProps, type AttributePickerProps, type AttributeRef, AttributesTable, type BarChartProps, type CartesianChartProps, type ChartOptions, type ChartProps, type ChartType, type E2ORelationPickerProps, type EventAttributePickerProps, type EventPickerProps, type HistogramChartProps, type LineChartProps, type MultiSelection, type O2ORelationPickerProps, type ObjectAttributePickerProps, type ObjectPickerProps, type ObjectTypePickerProps, type OcelChartProps, type OcelPickerProps, type OcelQueryOptions, type OcelSource, type OptionPickerProps, type PickerGroup, type PickerOption, type PickerProps, type PieChartProps, type Relation, RelationTable, type Row, type ScatterChartProps, type Selection, type Series, type SingleSelection, type SqlChartProps, type SunburstChartProps };