@ocelescope/resources 0.0.0 → 0.1.0

package/README.md

@@ -1,29 +1,30 @@
-# react-components-starter
+# @ocelescope/resources
 
-A starter for creating a React component library.
+Helpers and React UI components for rendering and exporting Ocelescope
+**resources** (the visual artifacts produced by plugins and modules, such as
+graphs, tables and plots).
 
-## Development
-
-- Install dependencies:
+## Installation
 
 ```bash
-npm install
+pnpm add @ocelescope/resources
 ```
 
-- Run the playground:
+## Usage
 
-```bash
-npm run play
+```tsx
+import {
+  ResourceViewer,
+  Visualization,
+  ResourceModal,
+  ResourceSelect,
+} from "@ocelescope/resources";
 ```
 
-- Run the unit tests:
+## About
 
-```bash
-npm run test
-```
+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.
 
-- Build the library:
-
-```bash
-npm run build
-```
+📖 Documentation: <https://www.ocelescope.org>

package/dist/index.d.ts

@@ -1,27 +1,49 @@
+import { Select } from "@mantine/core";
 import { GetResourceResponse } from "@ocelescope/api-base";
+import { ComponentProps } from "react";
 
+//#region src/components/ResourceModal/ResourceModal.d.ts
+declare const ResourceModal: React.FC<{
+  id: string;
+  onClose: () => void;
+}>;
+//#endregion
+//#region src/components/ResourceSelect/ResourceSelect.d.ts
+declare const ResourceSelect: React.FC<ComponentProps<typeof Select> & {
+  type: string;
+}>;
+//#endregion
 //#region src/types/index.d.ts
 type RequireType<T> = T extends {
   type?: infer L;
 } ? Omit<T, "type"> & {
   type: L;
 } : T;
-type VisulizationsType = RequireType<NonNullable<GetResourceResponse["visualization"]>>;
+type VisualizationsType = RequireType<NonNullable<GetResourceResponse["visualization"]>>;
+type VisualizationsTypes = NonNullable<VisualizationsType["type"]>;
+type VisualizationByType<T extends VisualizationsTypes> = Extract<VisualizationsType, {
+  type: T;
+}>;
 //#endregion
 //#region src/components/ResourceView/index.d.ts
-declare const Visualization: React.FC<{
-  visualization: VisulizationsType;
+type ExtraMenuItem = {
+  icon: React.ReactNode;
+  label: string;
+  onClick: () => void;
+};
+type VisualizationProps<T extends VisualizationsTypes> = {
+  visualization: VisualizationByType<T>;
   isPreview?: boolean;
-}>;
+  menuItems?: ExtraMenuItem[];
+};
+declare const Visualization: ({
+  visualization,
+  isPreview,
+  menuItems
+}: VisualizationProps<VisualizationsTypes>) => import("react").JSX.Element;
 declare const ResourceViewer: React.FC<{
   id: string;
   isPreview?: boolean;
 }>;
 //#endregion
-//#region src/components/ResourceModal/ResourceModal.d.ts
-declare const ResourceModal: React.FC<{
-  id: string;
-  onClose: () => void;
-}>;
-//#endregion
-export { ResourceModal, ResourceViewer, Visualization };
+export { ResourceModal, ResourceSelect, ResourceViewer, Visualization, type VisualizationsType };