moved demo stuff into demo folder and excluded it from dts

forman · forman · commit 4773d1dfa7a0 · 2024-10-14T15:22:29.000+02:00
diff --git a/dashi/index.html b/dashi/index.html
@@ -8,6 +8,6 @@
   </head>
   <body>
     <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
+    <script type="module" src="/src/demo/main.tsx"></script>
   </body>
 </html>
diff --git a/dashi/package-lock.json b/dashi/package-lock.json
diff --git a/dashi/package.json b/dashi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "dashi",
   "private": true,
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "scripts": {
     "dev": "vite",
diff --git a/dashi/src/demo/App.tsx b/dashi/src/demo/App.tsx
@@ -1,12 +1,12 @@
 import { CssBaseline, ThemeProvider, createTheme } from "@mui/material";
 import Typography from "@mui/material/Typography";
 
-import { initAppStore } from "../actions/initAppStore";
-import ExtensionsInfo from "./ExtensionInfo";
-import PanelsControl from "./PanelsControl";
-import PanelsRow from "./PanelsRow";
+import { initSystemStore } from "../store/actions/initSystemStore";
+import ExtensionsInfo from "./components/ExtensionInfo";
+import PanelsControl from "./components/PanelsControl";
+import PanelsRow from "./components/PanelsRow";
 
-initAppStore();
+initSystemStore();
 
 // MUI's default font family
 const fontFamily = "Roboto, Arial, sans-serif";
diff --git a/dashi/src/demo/components/ExtensionInfo.tsx b/dashi/src/demo/components/ExtensionInfo.tsx
@@ -1,10 +1,10 @@
 import Typography from "@mui/material/Typography";
 
-import useAppStore from "../store/appStore";
+import { useExtensions, useContributionsResult } from "../../hooks";
 
 function ExtensionsInfo() {
-  const contributionsResult = useAppStore((state) => state.contributionsResult);
-  const extensions = useAppStore((state) => state.extensions);
+  const extensions = useExtensions();
+  const contributionsResult = useContributionsResult();
   if (contributionsResult.status === "ok") {
     return (
       <div style={{ display: "flex", gap: 5 }}>
diff --git a/dashi/src/demo/components/Panel.tsx b/dashi/src/demo/components/Panel.tsx
@@ -1,10 +1,10 @@
 import { CSSProperties, ReactElement } from "react";
 import CircularProgress from "@mui/material/CircularProgress";
 
-import { PropertyChangeHandler } from "../model/event";
-import { Contribution } from "../model/contribution";
-import { ContributionState } from "../state/contribution";
-import DashiComponent from "../components/DashiComponent";
+import { PropertyChangeHandler } from "../../model/event";
+import { Contribution } from "../../model/contribution";
+import { ContributionState } from "../../state/contribution";
+import DashiComponent from "../../components/DashiComponent";
 
 const panelContainerStyle: CSSProperties = {
   display: "flex",
diff --git a/dashi/src/demo/components/PanelsControl.tsx b/dashi/src/demo/components/PanelsControl.tsx
@@ -2,17 +2,15 @@ import Checkbox from "@mui/material/Checkbox";
 import FormControlLabel from "@mui/material/FormControlLabel";
 import FormGroup from "@mui/material/FormGroup";
 
-import useAppStore from "../store/appStore";
-import { hidePanel } from "../actions/hidePanel";
-import { showPanel } from "../actions/showPanel";
-import { ContribPoint } from "../model/extension";
+import { useContributionStatesRecord } from "../../hooks";
+import { hidePanel } from "../../store/actions/hidePanel";
+import { showPanel } from "../../store/actions/showPanel";
+import { ContribPoint } from "../../model/extension";
 
 const contribPoint: ContribPoint = "panels";
 
 function PanelsControl() {
-  const contributionStatesRecord = useAppStore(
-    (state) => state.contributionStatesRecord,
-  );
+  const contributionStatesRecord = useContributionStatesRecord();
   const panelStates = contributionStatesRecord[contribPoint];
   if (!panelStates) {
     // Ok, not ready yet
diff --git a/dashi/src/demo/components/PanelsRow.tsx b/dashi/src/demo/components/PanelsRow.tsx
@@ -1,18 +1,17 @@
 import React from "react";
-import useAppStore from "../store/appStore";
-import applyPropertyChange from "../actions/applyPropertyChange";
-import { PropertyChangeEvent } from "../model/event";
+import {
+  useContributionModelsRecord,
+  useContributionStatesRecord,
+} from "../../hooks";
+import applyPropertyChange from "../../store/actions/applyPropertyChange";
+import { PropertyChangeEvent } from "../../model/event";
 import Panel from "./Panel";
 
 const contribPoint = "panels";
 
 function PanelsRow() {
-  const contributionModelsRecord = useAppStore(
-    (state) => state.contributionModelsRecord,
-  );
-  const contributionStatesRecord = useAppStore(
-    (state) => state.contributionStatesRecord,
-  );
+  const contributionModelsRecord = useContributionModelsRecord();
+  const contributionStatesRecord = useContributionStatesRecord();
   const panelModels = contributionModelsRecord[contribPoint];
   const panelStates = contributionStatesRecord[contribPoint];
   if (!panelModels || !panelStates) {
diff --git a/dashi/src/demo/index.css b/dashi/src/demo/index.css
diff --git a/dashi/src/demo/main.tsx b/dashi/src/demo/main.tsx
@@ -1,7 +1,7 @@
 import React from "react";
 import ReactDOM from "react-dom/client";
 
-import App from "./app/App";
+import App from "./App";
 
 import "@fontsource/roboto/300.css";
 import "@fontsource/roboto/400.css";
diff --git a/dashi/src/hooks.ts b/dashi/src/hooks.ts
@@ -0,0 +1,10 @@
+import systemStore from "./store/system";
+
+export const useSystemStore = systemStore;
+export const useExtensions = () => useSystemStore((state) => state.extensions);
+export const useContributionsResult = () =>
+  useSystemStore((state) => state.contributionsResult);
+export const useContributionStatesRecord = () =>
+  useSystemStore((state) => state.contributionStatesRecord);
+export const useContributionModelsRecord = () =>
+  useSystemStore((state) => state.contributionModelsRecord);
diff --git a/dashi/src/state/system.ts b/dashi/src/state/system.ts
@@ -0,0 +1,16 @@
+import { ContribPoint, Contributions, Extension } from "../model/extension";
+import { Contribution } from "../model/contribution";
+import { ApiResult } from "../utils/fetchApiResult";
+import { ContributionState } from "./contribution";
+
+export interface SystemState {
+  // API call result GET /contributions
+  contributionsResult: ApiResult<Contributions>;
+  // All extensions
+  extensions: Extension[];
+  // A record that maps contribPoint --> Contribution[]
+  contributionModelsRecord: Record<ContribPoint, Contribution[]>;
+  // A record that maps contribPoint --> ContributionState[]
+  contributionStatesRecord: Record<ContribPoint, ContributionState[]>;
+}
+
diff --git a/dashi/src/store/actions/applyPropertyChange.test.ts b/dashi/src/store/actions/applyPropertyChange.test.ts
@@ -1,9 +1,9 @@
 import { describe, it, expect } from "vitest";
 
-import { ComponentState, PlotState } from "../state/component";
-import { ContribPoint } from "../model/extension";
-import { ContributionState } from "../state/contribution";
-import { StateChangeRequest } from "../model/callback";
+import { ComponentState, PlotState } from "../../state/component";
+import { ContribPoint } from "../../model/extension";
+import { ContributionState } from "../../state/contribution";
+import { StateChangeRequest } from "../../model/callback";
 import {
   applyComponentStateChange,
   applyContributionChangeRequests,
diff --git a/dashi/src/store/actions/applyPropertyChange.ts b/dashi/src/store/actions/applyPropertyChange.ts
@@ -1,32 +1,33 @@
-import appStore from "../store/appStore";
-import { fetchStateChangeRequests } from "../api";
-import fetchApiResult from "../utils/fetchApiResult";
+import systemStore from "../system";
+import { fetchStateChangeRequests } from "../../api";
+import fetchApiResult from "../../utils/fetchApiResult";
 import {
   ComponentState,
   ContainerState,
   isContainerState,
-} from "../state/component";
-import { ContribPoint } from "../model/extension";
+} from "../../state/component";
+import { ContribPoint } from "../../model/extension";
 import {
   Callback,
   CallbackRef,
   CallbackRequest,
   Input,
   StateChange,
   StateChangeRequest,
-} from "../model/callback";
-import { PropertyChangeEvent } from "../model/event";
-import { Contribution } from "../model/contribution";
-import { ContributionState } from "../state/contribution";
-import { updateArray } from "../utils/updateArray";
+} from "../../model/callback";
+import { PropertyChangeEvent } from "../../model/event";
+import { Contribution } from "../../model/contribution";
+import { ContributionState } from "../../state/contribution";
+import { updateArray } from "../../utils/updateArray";
+
 
 export default function applyPropertyChange(
   contribPoint: ContribPoint,
   contribIndex: number,
   contribEvent: PropertyChangeEvent,
 ) {
   const { contributionModelsRecord, contributionStatesRecord } =
-    appStore.getState();
+    systemStore.getState();
   const contributionModels = contributionModelsRecord[contribPoint];
   const contributionStates = contributionStatesRecord[contribPoint];
   const contributionModel = contributionModels[contribIndex];
@@ -156,13 +157,13 @@ export function getInputValues(
 export function applyStateChangeRequests(
   stateChangeRequests: StateChangeRequest[],
 ) {
-  const { contributionStatesRecord } = appStore.getState();
+  const { contributionStatesRecord } = systemStore.getState();
   const contributionStatesRecordNew = applyContributionChangeRequests(
     contributionStatesRecord,
     stateChangeRequests,
   );
   if (contributionStatesRecordNew !== contributionStatesRecord) {
-    appStore.setState({
+    systemStore.setState({
       contributionStatesRecord: contributionStatesRecordNew,
     });
   }
diff --git a/dashi/src/store/actions/hidePanel.ts b/dashi/src/store/actions/hidePanel.ts
diff --git a/dashi/src/store/actions/initSystemStore.ts b/dashi/src/store/actions/initSystemStore.ts
@@ -1,12 +1,12 @@
-import appStore from "../store/appStore";
-import fetchApiResult from "../utils/fetchApiResult";
-import { fetchContributions } from "../api";
-import { Contribution } from "../model/contribution";
-import { ContributionState } from "../state/contribution";
-import { ContribPoint } from "../model/extension";
+import systemStore from "../system";
+import fetchApiResult from "../../utils/fetchApiResult";
+import { fetchContributions } from "../../api";
+import { Contribution } from "../../model/contribution";
+import { ContributionState } from "../../state/contribution";
+import { ContribPoint } from "../../model/extension";
 
-export function initAppStore() {
-  const set = appStore.setState;
+export function initSystemStore() {
+  const set = systemStore.setState;
 
   set({ contributionsResult: { status: "pending" } });
   fetchApiResult(fetchContributions).then((contributionsResult) => {
diff --git a/dashi/src/store/actions/setComponentVisibility.ts b/dashi/src/store/actions/setComponentVisibility.ts
@@ -1,15 +1,15 @@
-import { fetchInitialComponentState } from "../api";
-import appStore from "../store/appStore";
-import { ContribPoint } from "../model/extension";
-import fetchApiResult from "../utils/fetchApiResult";
+import systemStore from "../system";
+import { fetchInitialComponentState } from "../../api";
+import { ContribPoint } from "../../model/extension";
+import fetchApiResult from "../../utils/fetchApiResult";
 import { updateContributionState } from "./updateContributionState";
 
 export function setComponentVisibility(
   contribPoint: ContribPoint,
   panelIndex: number,
   visible: boolean,
 ) {
-  const { contributionStatesRecord } = appStore.getState();
+  const { contributionStatesRecord } = systemStore.getState();
   const contributionStates = contributionStatesRecord[contribPoint];
   const contributionState = contributionStates[panelIndex];
   if (contributionState.visible === visible) {
@@ -43,7 +43,7 @@ function getLayoutInputValues(
   contribPoint: ContribPoint,
   contribIndex: number,
 ): unknown[] {
-  const { contributionModelsRecord } = appStore.getState();
+  const { contributionModelsRecord } = systemStore.getState();
   const contributionModels = contributionModelsRecord[contribPoint];
   const contributionModel = contributionModels[contribIndex];
   const inputs = contributionModel.layout!.inputs;
diff --git a/dashi/src/store/actions/showPanel.ts b/dashi/src/store/actions/showPanel.ts
diff --git a/dashi/src/store/actions/updateContributionState.ts b/dashi/src/store/actions/updateContributionState.ts
@@ -1,16 +1,16 @@
-import appStore from "../store/appStore";
-import { updateArray } from "../utils/updateArray";
-import { ContributionState } from "../state/contribution";
-import { ContribPoint } from "../model/extension";
+import systemStore from "../system";
+import { updateArray } from "../../utils/updateArray";
+import { ContributionState } from "../../state/contribution";
+import { ContribPoint } from "../../model/extension";
 
 export function updateContributionState(
   contribPoint: ContribPoint,
   panelIndex: number,
   panelState: Partial<ContributionState>,
 ) {
-  const { contributionStatesRecord } = appStore.getState();
+  const { contributionStatesRecord } = systemStore.getState();
   const contribStates = contributionStatesRecord[contribPoint]!;
-  appStore.setState({
+  systemStore.setState({
     contributionStatesRecord: {
       ...contributionStatesRecord,
       [contribPoint]: updateArray<ContributionState>(
diff --git a/dashi/src/store/appStore.ts b/dashi/src/store/appStore.ts
diff --git a/dashi/src/store/system.ts b/dashi/src/store/system.ts
diff --git a/dashi/vite.config.ts b/dashi/vite.config.ts

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "dashi",`
`3`	`3`	`"private": true,`
`4`		`- "version": "0.0.2",`
	`4`	`+ "version": "0.0.3",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"scripts": {`
`7`	`7`	`"dev": "vite",`