@ocelescope/core 0.0.1 → 0.1.0

package/README.md

@@ -1,29 +1,97 @@
-# react-components-starter
+# @ocelescope/core
 
-A starter for creating a React component library.
+Core React component and style library for [Ocelescope](https://github.com/promi4s/ocelescope).
+It provides the application shell, the module system and the shared UI building
+blocks that every Ocelescope frontend module is built on.
 
-## Development
+It is built on [Mantine](https://mantine.dev/) for UI and
+[TanStack Query](https://tanstack.com/query) for data fetching, and is designed
+to run inside a [Next.js](https://nextjs.org/) (Pages Router) app.
 
-- Install dependencies:
+## Installation
 
 ```bash
-npm install
+pnpm add @ocelescope/core
 ```
 
-- Run the playground:
+`@ocelescope/core` relies on a number of peer dependencies (notably `react`,
+`react-dom`, `next`, `@mantine/*`, `@tanstack/react-query`, `dayjs` and
+`zustand`). When building a full app you normally install them alongside the
+Ocelescope packages — see the [app template](https://github.com/promi4s/ocelescope)
+for a complete setup.
 
-```bash
-npm run play
+## Usage
+
+### Setting up the app (Next.js Pages Router)
+
+```tsx
+// pages/_app.tsx
+import "@ocelescope/core/styles.css";
+import { OcelescopeApp } from "@ocelescope/core";
+import config from "../ocelescope.config";
+
+export default OcelescopeApp(config);
 ```
 
-- Run the unit tests:
+```tsx
+// pages/_document.tsx
+import { OcelescopeDocument } from "@ocelescope/core";
 
-```bash
-npm run test
+export default OcelescopeDocument;
 ```
 
-- Build the library:
+```tsx
+// pages/[[...slug]].tsx — renders the registered modules
+import { createModulesPage } from "@ocelescope/core";
+import config from "../ocelescope.config";
 
-```bash
-npm run build
+const page = createModulesPage(config);
+
+export const getStaticPaths = page.getStaticPaths;
+export const getStaticProps = page.getStaticProps;
+export default page.ModulePage;
+```
+
+```ts
+// ocelescope.config.ts — register modules
+import type { OcelescopeConfig } from "@ocelescope/core";
+import ocelot from "@ocelescope/ocelot";
+
+export default {
+  modules: [ocelot],
+} satisfies OcelescopeConfig;
 ```
+
+### Defining a module
+
+A module bundles metadata and one or more routes:
+
+```tsx
+import { defineModule, defineModuleRoute } from "@ocelescope/core";
+import { TableIcon } from "lucide-react";
+import EventsView from "./routes/events";
+
+const eventsRoute = defineModuleRoute({
+  name: "events",
+  label: "Events",
+  requiresOcel: true,
+  component: EventsView,
+});
+
+export default defineModule({
+  name: "example",
+  label: "Example",
+  description: "An example Ocelescope module",
+  authors: [{ name: "Your Name" }],
+  icon: TableIcon,
+  routes: [eventsRoute],
+});
+```
+
+## About
+
+Part of [Ocelescope](https://github.com/promi4s/ocelescope), a framework for
+working with Object-Centric Event Logs (OCEL) developed at the Chair of Process
+and Data Science (PADS), RWTH Aachen University.
+
+📖 Documentation: <https://www.ocelescope.org>

package/dist/index.d.ts

@@ -1,8 +1,47 @@
-import * as react0 from "react";
-import { SVGProps } from "react";
-import * as next0 from "next";
-import { GetStaticPaths, GetStaticProps } from "next";
+import { MantineStyleProps } from "@mantine/core";
+import { AggregatedAttribute, RelationCountSummary, TypedAttribute, ValueType } from "@ocelescope/api-base";
+import { DataTableColumn } from "mantine-datatable";
+import { ComponentProps, SVGProps } from "react";
+import { Dropzone, FileWithPath } from "@mantine/dropzone";
+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;
+  entityType?: "events" | "objects";
+  extraColumns?: DataTableColumn<AggregatedAttribute>[];
+  subTableExtraColumns?: DataTableColumn<TypedAttribute>[];
+  hideRange?: boolean;
+  hideValues?: boolean;
+  ocelVersion?: OcelVersion$1;
+  alwaysExpandable?: boolean;
+  visibleAttributes?: string[];
+}>;
+//#endregion
+//#region src/components/BarList/BarList.d.ts
+declare const BarList: React.FC<{
+  data: Record<string, number>;
+  labelHeader: string;
+  valueHeader?: string;
+  maxVisibleItems?: number;
+}>;
+//#endregion
+//#region src/components/Dropzone/Dropzone.d.ts
+declare const FileDropzone: React.FC<{
+  onUpload: (files: FileWithPath[]) => void;
+  accept?: ComponentProps<typeof Dropzone>["accept"];
+  content: {
+    accept?: React.ReactNode;
+    reject?: React.ReactNode;
+    idle?: React.ReactNode;
+    description?: React.ReactNode;
+  };
+}>;
+//#endregion
+//#region src/components/EventHandler.d.ts
+declare const sseHandler: (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+//#endregion
 //#region src/lib/config.d.ts
 type Author = {
   name: string;
@@ -23,24 +62,25 @@ type ModuleRouteDefinition = {
   component: React.ComponentType;
 };
 type OcelescopeConfig = {
-  homePage?: React.FC;
   modules?: readonly ModuleDefinition[];
+  navbarGroups?: {
+    title?: string;
+    modulesNames: string[];
+  }[];
 };
 declare const defineModule: (def: ModuleDefinition) => ModuleDefinition;
 declare const defineModuleRoute: (def: ModuleRouteDefinition) => ModuleRouteDefinition;
 //#endregion
 //#region src/components/ModulePage.d.ts
 type ModulePageProps = {
-  moduleProps?: {
-    moduleName: string;
-    routeName: string;
-  };
+  moduleName: string;
+  routeName: string;
 };
 declare const createModulesPage: (config: OcelescopeConfig) => {
   getStaticPaths: GetStaticPaths;
   getStaticProps: GetStaticProps<ModulePageProps>;
-  ModulePage: react0.FunctionComponent<ModulePageProps> & {
-    getInitialProps?(context: next0.NextPageContext): ModulePageProps | Promise<ModulePageProps>;
+  ModulePage: import("react").FunctionComponent<ModulePageProps> & {
+    getInitialProps?(context: import("next").NextPageContext): ModulePageProps | Promise<ModulePageProps>;
   };
 };
 //#endregion
@@ -50,12 +90,84 @@ declare const OcelescopeApp: (config: OcelescopeConfig) => React.FC<any>;
 //#region src/components/OcelescopeDocument.d.ts
 declare const OcelescopeDocument: React.FC;
 //#endregion
+//#region src/components/OcelSelect/OcelSelect.d.ts
+type OcelSelectProps = {
+  extension?: string;
+  value?: string | null;
+  onChange?: (value: string | null) => void;
+  label?: React.ReactNode;
+  description?: React.ReactNode;
+  error?: React.ReactNode;
+  placeholder?: string;
+  required?: boolean;
+  disabled?: boolean;
+  w?: MantineStyleProps["w"];
+};
+declare const OcelSelect: React.FC<OcelSelectProps>;
+//#endregion
+//#region src/components/RelationTable.d.ts
+type RelationType = "o2o" | "e2o";
+type Direction = "source" | "target";
+type OcelVersion = "original" | "filtered";
+declare const RelationTable: React.FC<{
+  ocelId: string;
+  relationType?: RelationType;
+  direction?: Direction;
+  extraColumns?: DataTableColumn<RelationCountSummary>[];
+  subTableExtraColumns?: DataTableColumn<RelationCountSummary>[];
+  hideRange?: boolean;
+  hideTotal?: boolean;
+  ocelVersion?: OcelVersion;
+  visibleRelations?: {
+    source: string;
+    target: string;
+  }[];
+}>;
+//#endregion
+//#region src/components/UploadModal/UploadModal.d.ts
+declare const UploadModal: React.FC<{
+  visible: boolean;
+  onClose: () => void;
+}>;
+//#endregion
+//#region src/components/UploadSection/UploadSection.d.ts
+declare const UploadSection: React.FC<{
+  onSuccess?: () => void;
+}>;
+//#endregion
 //#region src/hooks/useCurrentOCEL.d.ts
 declare const useCurrentOcel: () => {
   id: string | null;
   setCurrentOcel: (id: string) => void;
 };
 //#endregion
+//#region src/hooks/useDownload.d.ts
+declare const useDownloadFile: () => (path: string) => Promise<void>;
+declare const useDownloadOCEL: () => {
+  download: (ocelId: string | null, params?: import("@ocelescope/api-base").DownloadOCELParams | undefined) => void;
+};
+declare const useDownloadFlatOCEL: () => {
+  download: (ocelId: string | null, params?: import("@ocelescope/api-base").DownloadFlatLogParams | undefined) => void;
+};
+declare const useDownloadResource: () => {
+  download: (resourceId: string) => void;
+};
+declare const useDownloadResourceAsPnml: () => {
+  download: (resourceId: string) => void;
+};
+//#endregion
+//#region src/hooks/useInvalidate.d.ts
+type InvalidationRouteName = "ocels" | "resources" | "tasks" | "plugins";
+declare const useInvalidate: () => (routeNames: InvalidationRouteName[]) => Promise<void>;
+//#endregion
+//#region src/lib/attributes.d.ts
+declare const formatAttributeValue: (type: ValueType, value: string | number) => string | number;
+//#endregion
+//#region src/lib/env.d.ts
+declare const env: {
+  projectPage: string;
+};
+//#endregion
 //#region src/lib/getModuleRoute.d.ts
 declare const getModuleRoute: ({
   moduleName,
@@ -63,13 +175,13 @@ declare const getModuleRoute: ({
   query
 }: {
   moduleName: string;
-  routeName: string;
+  routeName?: string;
   query?: Record<string, string>;
 }) => {
   query?: {
     [x: string]: string;
-  };
+  } | undefined;
   pathname: string;
 };
 //#endregion
-export { ModuleDefinition, ModuleRouteDefinition, OcelescopeApp, OcelescopeConfig, OcelescopeDocument, createModulesPage, defineModule, defineModuleRoute, getModuleRoute, useCurrentOcel };
+export { AttributesTable, BarList, FileDropzone, ModuleDefinition, ModuleRouteDefinition, OcelSelect, OcelescopeApp, OcelescopeConfig, OcelescopeDocument, RelationTable, UploadModal, UploadSection, createModulesPage, defineModule, defineModuleRoute, env, formatAttributeValue, getModuleRoute, sseHandler, useCurrentOcel, useDownloadFile, useDownloadFlatOCEL, useDownloadOCEL, useDownloadResource, useDownloadResourceAsPnml, useInvalidate };