@bramas/simulant-ui 0.1.0 → 0.1.1

package/dist/SimulatorApp.jsx

@@ -205,6 +205,15 @@ export const SimulatorApp = (props) => {
         const schema = editorSchema();
         return schema ? formValues(schema, projectUserSettings()) : projectUserSettings() ?? {};
     });
+    const settingsWarnings = createMemo(() => {
+        projectRevision();
+        try {
+            return Projects[project()].settingsWarnings?.(projectUserSettings()) ?? [];
+        }
+        catch (e) {
+            return [`Could not check initial settings: ${e instanceof Error ? e.message : String(e)}`];
+        }
+    });
     /** The task's verdict on the current configuration, with what it means under the task's goal. */
     const verdict = createMemo(() => {
         redrawTick();
@@ -458,10 +467,6 @@ export const SimulatorApp = (props) => {
             {notice().text}
           </pre>)}
       </Show>
-      <Show when={setupLog()}>
-        <div class="sim-notice sim-error"><mark>{setupLog()}</mark></div>
-      </Show>
-
       <Show when={modelShown() && description()}>
         {d => <ModelView description={d()} simulation={project()} onCopyLink={() => copy(`${shareLink(effectiveSettings(), currentPath())}#model`)}/>}
       </Show>
@@ -529,7 +534,7 @@ export const SimulatorApp = (props) => {
         </div>
 
         <div class="sim-panels">
-          <section class="sim-card">
+          <section class="sim-card sim-settings">
             <h3>
               Settings
               <span class="sim-spacer" style={{ flex: 1 }}/>
@@ -538,6 +543,16 @@ export const SimulatorApp = (props) => {
             <Show when={editorSchema()} keyed>
               {schema => (<GenericEditor schema={schema} value={projectUserSettings()} onInput={(v) => batch(() => { setProjectUserSettings(v); goTo([0]); })}/>)}
             </Show>
+            <Show when={setupLog()}>
+              <div class="sim-notice sim-error sim-settings-feedback" role="alert"><mark>{setupLog()}</mark></div>
+            </Show>
+            <Show when={!setupLog() && settingsWarnings().length > 0}>
+              <div class="sim-notice sim-settings-warning sim-settings-feedback" role="alert">
+                <strong>Initial settings warning</strong>
+                <For each={settingsWarnings()}>{warning => <div>{warning}</div>}</For>
+                <div>You can still explore this execution. Checks over the declared domains do not cover settings outside them.</div>
+              </div>
+            </Show>
           </section>
           <section class="sim-card">
             <h3>Saved settings</h3>

package/dist/sim/describe.js

@@ -182,10 +182,13 @@ export function describeExperiment(exp, sources, revision, lean) {
         },
         {
             label: 'Synchrony',
-            value: model.round === 'fsync' ? 'FSYNC (fully synchronous)' : 'SSYNC (semi-synchronous)',
+            value: model.round === 'fsync' ? 'FSYNC (fully synchronous)' : model.round === 'sequential' ? 'Sequential (fair)' : 'SSYNC (semi-synchronous)',
             note: model.round === 'fsync'
                 ? 'Every agent able to act is activated in every round.'
-                : 'In every round, the adversary activates a nonempty set of the agents able to act. Only fair executions count: every agent that keeps acting is activated infinitely often.',
+                : (model.round === 'sequential'
+                    ? 'In every round, the adversary activates exactly one agent able to act (or none if no agent can act). '
+                    : 'In every round, the adversary activates a nonempty set of the agents able to act. ')
+                    + 'Only fair executions count: every agent that keeps acting is activated infinitely often.',
             refs: modelRef('round'),
         },
         {
@@ -281,14 +284,14 @@ export function describeExperiment(exp, sources, revision, lean) {
                 {
                     label: 'Goal',
                     value: GOALS[task.goal].formula,
-                    note: `${model.round === 'ssync' ? 'Over every fair execution' : 'Over every execution'}: ${GOALS[task.goal].text}.`,
+                    note: `${model.round !== 'fsync' ? 'Over every fair execution' : 'Over every execution'}: ${GOALS[task.goal].text}.`,
                     refs: refTo('goal', task.name),
                 },
                 {
                     label: 'Adversary',
                     value: 'Unrestricted',
                     note: 'No fairness assumption forces an adversary choice (a hazard to appear, a missing edge to return)'
-                        + (model.round === 'ssync' ? ', apart from fair activation.' : '.'),
+                        + (model.round !== 'fsync' ? ', apart from fair activation.' : '.'),
                 },
             ],
         },
@@ -327,10 +330,12 @@ export function describeExperiment(exp, sources, revision, lean) {
         hook('beforeLook', 'Components update their state, all reading the same configuration.'),
         {
             phase: 'Activation',
-            what: (model.round === 'fsync' ? 'Every agent able to act is activated.' : 'A nonempty set of the agents able to act is activated.')
+            what: (model.round === 'fsync' ? 'Every agent able to act is activated.'
+                : model.round === 'sequential' ? 'Exactly one agent able to act is activated (none if no agent can act).'
+                    : 'A nonempty set of the agents able to act is activated.')
                 + (model.frame.kind === 'dynamicReflection' ? " Each activated agent's orientation is chosen." : ''),
             choices: [
-                ...(model.round === 'ssync' ? ['activated agents (fair)'] : []),
+                ...(model.round !== 'fsync' ? ['activated agents (fair)'] : []),
                 ...(model.frame.kind === 'dynamicReflection' ? ['orientations'] : []),
             ],
         },

package/dist/sim/project.js

@@ -1,4 +1,4 @@
-import { parameterValues, System } from "@bramas/simulant-engine/system";
+import { parameterDomainViolations, parameterValues, System } from "@bramas/simulant-engine/system";
 import { checkFirstBranch, checkSetting, checkSettings, stateGraph } from "@bramas/simulant-engine/check";
 import { formatDiagnostic } from "@bramas/simulant-vite-plugin/module";
 import { isRenderer } from "../renderers/define.js";
@@ -239,6 +239,11 @@ export function simProject(module, experiment, opts = {}) {
         setup: setup,
         execute: (model) => simExecution(model.system),
         normalizeSettings,
+        settingsWarnings: settings => {
+            const params = paramsOf(settings);
+            return parameterDomainViolations(need().exp, params)
+                .map(name => `${name} = ${JSON.stringify(params[name])} is outside its declared parameter domain.`);
+        },
         subscribe: listener => {
             listeners.add(listener);
             return () => { listeners.delete(listener); };

package/dist/simulator.css

@@ -395,6 +395,15 @@
   border-color: var(--sim-failure);
 }
 
+.sim-settings-feedback {
+  font-family: inherit;
+  margin: 0;
+}
+
+.sim-settings-warning {
+  white-space: normal;
+}
+
 .sim-toast {
   position: fixed;
   bottom: 1.25rem;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bramas/simulant-ui",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": false,
   "license": "CECILL-B",
   "type": "module",
@@ -31,11 +31,11 @@
     }
   },
   "dependencies": {
-    "@bramas/simulant-core": "0.1.0",
-    "@bramas/simulant-lean-gen": "0.1.0",
-    "@bramas/simulant-vite-plugin": "0.1.0",
-    "@bramas/simulant-engine": "0.1.0",
-    "@bramas/simulant-lang": "0.1.0"
+    "@bramas/simulant-lang": "0.1.1",
+    "@bramas/simulant-lean-gen": "0.1.1",
+    "@bramas/simulant-engine": "0.1.1",
+    "@bramas/simulant-core": "0.1.1",
+    "@bramas/simulant-vite-plugin": "0.1.1"
   },
   "peerDependencies": {
     "solid-js": "^1.9.3"

package/src/SimulatorApp.tsx

@@ -223,6 +223,15 @@ export const SimulatorApp: Component<SimulatorAppProps> = (props) => {
     return schema ? formValues(schema, projectUserSettings()) : projectUserSettings() ?? {};
   });
 
+  const settingsWarnings = createMemo(() => {
+    projectRevision();
+    try {
+      return Projects[project()].settingsWarnings?.(projectUserSettings()) ?? [];
+    } catch (e) {
+      return [`Could not check initial settings: ${e instanceof Error ? e.message : String(e)}`];
+    }
+  });
+
   /** The task's verdict on the current configuration, with what it means under the task's goal. */
   const verdict = createMemo(() => {
     redrawTick();
@@ -469,10 +478,6 @@ export const SimulatorApp: Component<SimulatorAppProps> = (props) => {
           </pre>
         )}
       </Show>
-      <Show when={setupLog()}>
-        <div class="sim-notice sim-error"><mark>{setupLog()}</mark></div>
-      </Show>
-
       <Show when={modelShown() && description()}>
         {d => <ModelView description={d()} simulation={project()} onCopyLink={() => copy(`${shareLink(effectiveSettings(), currentPath())}#model`)} />}
       </Show>
@@ -553,7 +558,7 @@ export const SimulatorApp: Component<SimulatorAppProps> = (props) => {
         </div>
 
         <div class="sim-panels">
-          <section class="sim-card">
+          <section class="sim-card sim-settings">
             <h3>
               Settings
               <span class="sim-spacer" style={{ flex: 1 }} />
@@ -568,6 +573,16 @@ export const SimulatorApp: Component<SimulatorAppProps> = (props) => {
                 />
               )}
             </Show>
+            <Show when={setupLog()}>
+              <div class="sim-notice sim-error sim-settings-feedback" role="alert"><mark>{setupLog()}</mark></div>
+            </Show>
+            <Show when={!setupLog() && settingsWarnings().length > 0}>
+              <div class="sim-notice sim-settings-warning sim-settings-feedback" role="alert">
+                <strong>Initial settings warning</strong>
+                <For each={settingsWarnings()}>{warning => <div>{warning}</div>}</For>
+                <div>You can still explore this execution. Checks over the declared domains do not cover settings outside them.</div>
+              </div>
+            </Show>
           </section>
           <section class="sim-card">
             <h3>Saved settings</h3>

package/src/sim/describe.ts

@@ -187,10 +187,13 @@ export function describeExperiment(exp: Experiment, sources: Record<string, stri
     },
     {
       label: 'Synchrony',
-      value: model.round === 'fsync' ? 'FSYNC (fully synchronous)' : 'SSYNC (semi-synchronous)',
+      value: model.round === 'fsync' ? 'FSYNC (fully synchronous)' : model.round === 'sequential' ? 'Sequential (fair)' : 'SSYNC (semi-synchronous)',
       note: model.round === 'fsync'
         ? 'Every agent able to act is activated in every round.'
-        : 'In every round, the adversary activates a nonempty set of the agents able to act. Only fair executions count: every agent that keeps acting is activated infinitely often.',
+        : (model.round === 'sequential'
+          ? 'In every round, the adversary activates exactly one agent able to act (or none if no agent can act). '
+          : 'In every round, the adversary activates a nonempty set of the agents able to act. ')
+          + 'Only fair executions count: every agent that keeps acting is activated infinitely often.',
       refs: modelRef('round'),
     },
     {
@@ -285,14 +288,14 @@ export function describeExperiment(exp: Experiment, sources: Record<string, stri
         {
           label: 'Goal',
           value: GOALS[task.goal].formula,
-          note: `${model.round === 'ssync' ? 'Over every fair execution' : 'Over every execution'}: ${GOALS[task.goal].text}.`,
+          note: `${model.round !== 'fsync' ? 'Over every fair execution' : 'Over every execution'}: ${GOALS[task.goal].text}.`,
           refs: refTo('goal', task.name),
         },
         {
           label: 'Adversary',
           value: 'Unrestricted',
           note: 'No fairness assumption forces an adversary choice (a hazard to appear, a missing edge to return)'
-            + (model.round === 'ssync' ? ', apart from fair activation.' : '.'),
+            + (model.round !== 'fsync' ? ', apart from fair activation.' : '.'),
         },
       ],
     },
@@ -333,10 +336,12 @@ export function describeExperiment(exp: Experiment, sources: Record<string, stri
     hook('beforeLook', 'Components update their state, all reading the same configuration.'),
     {
       phase: 'Activation',
-      what: (model.round === 'fsync' ? 'Every agent able to act is activated.' : 'A nonempty set of the agents able to act is activated.')
+      what: (model.round === 'fsync' ? 'Every agent able to act is activated.'
+        : model.round === 'sequential' ? 'Exactly one agent able to act is activated (none if no agent can act).'
+          : 'A nonempty set of the agents able to act is activated.')
         + (model.frame.kind === 'dynamicReflection' ? " Each activated agent's orientation is chosen." : ''),
       choices: [
-        ...(model.round === 'ssync' ? ['activated agents (fair)'] : []),
+        ...(model.round !== 'fsync' ? ['activated agents (fair)'] : []),
         ...(model.frame.kind === 'dynamicReflection' ? ['orientations'] : []),
       ],
     },

package/src/sim/project.ts

@@ -6,7 +6,7 @@
  * `draw`, the algorithm view from the algorithm's source and line table.
  */
 import type { Experiment, Type } from '@bramas/simulant-lang/ir';
-import { parameterValues, System } from '@bramas/simulant-engine/system';
+import { parameterDomainViolations, parameterValues, System } from '@bramas/simulant-engine/system';
 import { checkFirstBranch, checkSetting, checkSettings, stateGraph, type CheckResult } from '@bramas/simulant-engine/check';
 import type { EditorField, EditorSchema } from '@bramas/simulant-core/types/editor-schema';
 import type { AlgorithmSource, CheckOptions, ModelDescription, ProjectType, ProjectUpdate } from '@bramas/simulant-core/types/project';
@@ -269,6 +269,11 @@ export function simProject(module: SimSources, experiment: string, opts: SimProj
     setup: setup as ProjectType<any, any>['setup'],
     execute: (model: SimModel) => simExecution(model.system),
     normalizeSettings,
+    settingsWarnings: settings => {
+      const params = paramsOf(settings);
+      return parameterDomainViolations(need().exp, params)
+        .map(name => `${name} = ${JSON.stringify(params[name])} is outside its declared parameter domain.`);
+    },
     subscribe: listener => {
       listeners.add(listener);
       return () => { listeners.delete(listener); };

package/src/simulator.css

@@ -395,6 +395,15 @@
   border-color: var(--sim-failure);
 }
 
+.sim-settings-feedback {
+  font-family: inherit;
+  margin: 0;
+}
+
+.sim-settings-warning {
+  white-space: normal;
+}
+
 .sim-toast {
   position: fixed;
   bottom: 1.25rem;