@opencor/opencor 0.20250826.0 → 0.20250827.0

package/src/libopencor/locUiJsonApi.ts

@@ -1,485 +0,0 @@
-import * as jsonschema from 'jsonschema'
-
-import * as common from '../common/common.js'
-
-import { EIssueType, type IIssue } from './locLoggerApi.js'
-
-export interface IUiJson {
-  input: IUiJsonInput[]
-  output: IUiJsonOutput
-  parameters: IUiJsonParameter[]
-}
-
-export type IUiJsonInput = IUiJsonDiscreteInput | IUiJsonScalarInput
-
-interface IUiJsonDiscreteInput {
-  defaultValue: number
-  id?: string
-  name: string
-  possibleValues: IUiJsonDiscreteInputPossibleValue[]
-  visible?: string
-}
-
-export interface IUiJsonDiscreteInputPossibleValue {
-  name: string
-  value: number
-}
-
-interface IUiJsonScalarInput {
-  defaultValue: number
-  id?: string
-  maximumValue: number
-  minimumValue: number
-  name: string
-  stepValue?: number
-  visible?: string
-}
-
-export interface IUiJsonOutput {
-  data: IUiJsonOutputData[]
-  plots: IUiJsonOutputPlot[]
-}
-
-export interface IUiJsonOutputData {
-  id: string
-  name: string
-}
-
-export interface IUiJsonOutputPlot {
-  xAxisTitle: string
-  xValue: string
-  yAxisTitle: string
-  yValue: string
-}
-
-export interface IUiJsonParameter {
-  name: string
-  value: string
-}
-
-export function uiJsonIssues(uiJson: IUiJson | undefined): IIssue[] {
-  // Make sure that we have some UI JSON.
-
-  if (uiJson === undefined) {
-    return [
-      {
-        type: EIssueType.WARNING,
-        description: 'UI JSON: no UI JSON was provided.'
-      }
-    ]
-  }
-
-  // Check the UI JSON against our schema.
-
-  const validator = new jsonschema.Validator()
-  const schema: jsonschema.Schema = {
-    additionalProperties: false,
-    properties: {
-      input: {
-        items: {
-          oneOf: [
-            {
-              additionalProperties: false,
-              properties: {
-                defaultValue: {
-                  required: true,
-                  type: 'number'
-                },
-                id: {
-                  type: 'string'
-                },
-                name: {
-                  required: true,
-                  type: 'string'
-                },
-                possibleValues: {
-                  items: {
-                    additionalProperties: false,
-                    properties: {
-                      name: {
-                        required: true,
-                        type: 'string'
-                      },
-                      value: {
-                        required: true,
-                        type: 'number'
-                      }
-                    },
-                    type: 'object'
-                  },
-                  minItems: 1,
-                  required: true,
-                  type: 'array'
-                },
-                visible: {
-                  type: 'string'
-                }
-              }
-            },
-            {
-              additionalProperties: false,
-              properties: {
-                defaultValue: {
-                  required: true,
-                  type: 'number'
-                },
-                id: {
-                  type: 'string'
-                },
-                maximumValue: {
-                  required: true,
-                  type: 'number'
-                },
-                minimumValue: {
-                  required: true,
-                  type: 'number'
-                },
-                name: {
-                  required: true,
-                  type: 'string'
-                },
-                stepValue: {
-                  type: 'number'
-                },
-                visible: {
-                  type: 'string'
-                }
-              }
-            }
-          ],
-          type: 'object'
-        },
-        minItems: 1,
-        required: true,
-        type: 'array'
-      },
-      output: {
-        additionalProperties: false,
-        minItems: 1,
-        properties: {
-          data: {
-            items: {
-              additionalProperties: false,
-              properties: {
-                id: {
-                  required: true,
-                  type: 'string'
-                },
-                name: {
-                  required: true,
-                  type: 'string'
-                }
-              },
-              type: 'object'
-            },
-            minItems: 1,
-            required: true,
-            type: 'array'
-          },
-          plots: {
-            items: {
-              additionalProperties: false,
-              properties: {
-                xAxisTitle: {
-                  required: true,
-                  type: 'string'
-                },
-                xValue: {
-                  required: true,
-                  type: 'string'
-                },
-                yAxisTitle: {
-                  required: true,
-                  type: 'string'
-                },
-                yValue: {
-                  required: true,
-                  type: 'string'
-                }
-              },
-              type: 'object'
-            },
-            maxItems: 9,
-            minItems: 1,
-            required: true,
-            type: 'array'
-          }
-        },
-        required: true,
-        type: 'object'
-      },
-      parameters: {
-        items: {
-          additionalProperties: false,
-          properties: {
-            name: {
-              required: true,
-              type: 'string'
-            },
-            value: {
-              required: true,
-              type: 'string'
-            }
-          },
-          minItems: 1,
-          required: true,
-          type: 'object'
-        },
-        required: true,
-        type: 'array'
-      }
-    },
-    type: 'object'
-  }
-
-  const validatorRes = validator.validate(uiJson, schema, { nestedErrors: true })
-
-  if (!validatorRes.valid) {
-    const res: IIssue[] = []
-
-    for (const issue of String(validatorRes).split('\n')) {
-      if (issue !== '') {
-        res.push({
-          type: EIssueType.WARNING,
-          description: `UI JSON: ${common.formatIssue(issue)}`
-        })
-      }
-    }
-
-    return res
-  }
-
-  // Make sure that the input information makes sense.
-
-  const res: IIssue[] = []
-  const inputIdUsed: Record<string, boolean> = {}
-
-  for (const input of uiJson.input) {
-    if (input.id !== undefined) {
-      if (input.id === '') {
-        res.push({
-          type: EIssueType.WARNING,
-          description: 'UI JSON: an input id must not be empty.'
-        })
-      }
-
-      if (inputIdUsed[input.id]) {
-        res.push({
-          type: EIssueType.WARNING,
-          description: `UI JSON: an input id must be unique (${input.id} is used more than once).`
-        })
-      }
-
-      inputIdUsed[input.id] = true
-    }
-
-    if (input.name === '') {
-      res.push({
-        type: EIssueType.WARNING,
-        description: 'UI JSON: an input name must not be empty.'
-      })
-    }
-
-    function isDiscreteInput(input: IUiJsonInput): input is IUiJsonDiscreteInput {
-      return 'possibleValues' in input
-    }
-
-    if (isDiscreteInput(input)) {
-      for (const possibleValue of input.possibleValues) {
-        if (possibleValue.name === '') {
-          res.push({
-            type: EIssueType.WARNING,
-            description: 'UI JSON: an input possible value name must not be empty.'
-          })
-        }
-      }
-
-      const values = input.possibleValues.map((value) => {
-        return value.value
-      })
-      const valueUsed: Record<number, boolean> = {}
-
-      for (const value of values) {
-        if (valueUsed[value]) {
-          res.push({
-            type: EIssueType.WARNING,
-            description:
-              'UI JSON: an input possible value must have a unique value (' +
-              String(value) +
-              ' is used more than once).'
-          })
-        }
-
-        valueUsed[value] = true
-      }
-
-      if (!values.includes(input.defaultValue)) {
-        res.push({
-          type: EIssueType.WARNING,
-          description:
-            'UI JSON: an input default value (' +
-            String(input.defaultValue) +
-            ') must be one of the possible values (' +
-            values.join(', ') +
-            ').'
-        })
-      }
-    }
-
-    function isScalarInput(input: IUiJsonInput): input is IUiJsonScalarInput {
-      return 'minimumValue' in input && 'maximumValue' in input
-    }
-
-    if (isScalarInput(input)) {
-      if (input.minimumValue >= input.maximumValue) {
-        res.push({
-          type: EIssueType.WARNING,
-          description:
-            'UI JSON: an input minimum value (' +
-            String(input.minimumValue) +
-            ') must be lower than the maximum value (' +
-            String(input.maximumValue) +
-            ').'
-        })
-      }
-
-      if (input.defaultValue < input.minimumValue || input.defaultValue > input.maximumValue) {
-        res.push({
-          type: EIssueType.WARNING,
-          description:
-            'UI JSON: an input default value (' +
-            String(input.defaultValue) +
-            ') must be greater or equal than the minimum value (' +
-            String(input.minimumValue) +
-            ') and lower or equal than the maximum value (' +
-            String(input.maximumValue) +
-            ').'
-        })
-      }
-
-      const range = input.maximumValue - input.minimumValue
-
-      if (input.stepValue !== undefined) {
-        if (input.stepValue <= 0 || input.stepValue > range) {
-          res.push({
-            type: EIssueType.WARNING,
-            description:
-              'UI JSON: an input step value (' +
-              String(input.stepValue) +
-              ') must be greater than zero and lower or equal than the range value (' +
-              String(range) +
-              ').'
-          })
-        }
-
-        if (!Number.isInteger(range / input.stepValue)) {
-          res.push({
-            type: EIssueType.WARNING,
-            description:
-              'UI JSON: an input step value (' +
-              String(input.stepValue) +
-              ') must be a factor of the range value (' +
-              String(range) +
-              ').'
-          })
-        }
-      } else {
-        if (!Number.isInteger(range)) {
-          res.push({
-            type: EIssueType.WARNING,
-            description:
-              'UI JSON: a (default) input step value (1) must be a factor of the range value (' + String(range) + ').'
-          })
-        }
-      }
-    }
-
-    if (input.visible !== undefined) {
-      if (input.visible === '') {
-        res.push({
-          type: EIssueType.WARNING,
-          description: 'UI JSON: an input visible must not be empty.'
-        })
-      }
-    }
-  }
-
-  // Make sure that the output information makes sense.
-
-  const outputIdUsed: Record<string, boolean> = {}
-
-  for (const outputData of uiJson.output.data) {
-    if (outputData.id === '') {
-      res.push({
-        type: EIssueType.WARNING,
-        description: 'UI JSON: an output data id must not be empty.'
-      })
-    }
-
-    if (outputIdUsed[outputData.id]) {
-      res.push({
-        type: EIssueType.WARNING,
-        description: `UI JSON: an output data id must be unique (${outputData.id} is used more than once).`
-      })
-    }
-
-    outputIdUsed[outputData.id] = true
-
-    if (outputData.name === '') {
-      res.push({
-        type: EIssueType.WARNING,
-        description: 'UI JSON: an output data name must not be empty.'
-      })
-    }
-  }
-
-  for (const outputPlot of uiJson.output.plots) {
-    if (outputPlot.xAxisTitle === '') {
-      res.push({
-        type: EIssueType.WARNING,
-        description: 'UI JSON: an output plot X axis title must not be empty.'
-      })
-    }
-
-    if (outputPlot.xValue === '') {
-      res.push({
-        type: EIssueType.WARNING,
-        description: 'UI JSON: an output plot X value must not be empty.'
-      })
-    }
-
-    if (outputPlot.yAxisTitle === '') {
-      res.push({
-        type: EIssueType.WARNING,
-        description: 'UI JSON: an output plot Y axis title must not be empty.'
-      })
-    }
-
-    if (outputPlot.yValue === '') {
-      res.push({
-        type: EIssueType.WARNING,
-        description: 'UI JSON: an output plot Y value must not be empty.'
-      })
-    }
-  }
-
-  // Make sure that the parameters information makes sense.
-
-  for (const parameter of uiJson.parameters) {
-    if (parameter.name === '') {
-      res.push({
-        type: EIssueType.WARNING,
-        description: 'UI JSON: a parameter name must not be empty.'
-      })
-    }
-
-    if (parameter.value === '') {
-      res.push({
-        type: EIssueType.WARNING,
-        description: 'UI JSON: a parameter value must not be empty.'
-      })
-    }
-  }
-
-  return res
-}

package/src/libopencor/locVersionApi.ts

@@ -1,17 +0,0 @@
-import { electronApi } from '../common/electronApi.js'
-
-import { _cppLocApi, _wasmLocApi } from './locApi.js'
-
-// Some general methods.
-
-export function cppVersion(): boolean {
-  return electronApi !== undefined
-}
-
-export function wasmVersion(): boolean {
-  return !cppVersion()
-}
-
-export function version(): string {
-  return cppVersion() ? _cppLocApi.version() : _wasmLocApi.versionString()
-}

package/src/libopencor/src/common.cpp

@@ -1,67 +0,0 @@
-#include "common.h"
-
-libOpenCOR::FileManager fileManager = libOpenCOR::FileManager::instance();
-std::map<libOpenCOR::FilePtr, FileData> fileData;
-
-libOpenCOR::FilePtr valueToFile(const Napi::Value &pValue)
-{
-    return fileManager.file(pValue.ToString().Utf8Value());
-}
-
-libOpenCOR::SedDocumentPtr valueToSedDocument(const Napi::Value &pValue)
-{
-    return fileData[valueToFile(pValue)].sedDocument;
-}
-
-libOpenCOR::SedInstancePtr valueToSedInstance(const Napi::Value &pValue)
-{
-    return fileData[valueToFile(pValue)].sedInstance;
-}
-
-int32_t valueToInt32(const Napi::Value &pValue)
-{
-    return pValue.As<Napi::Number>().Int32Value();
-}
-
-double valueToDouble(const Napi::Value &pValue)
-{
-    return pValue.As<Napi::Number>().DoubleValue();
-}
-
-std::string valueToString(const Napi::Value &pValue)
-{
-    return pValue.As<Napi::String>().Utf8Value();
-}
-
-void untrackFileData(libOpenCOR::FilePtr pFile)
-{
-    fileData.erase(pFile);
-}
-
-napi_value issues(const Napi::CallbackInfo &pInfo, libOpenCOR::IssuePtrs pIssues)
-{
-    auto env = pInfo.Env();
-    auto res = Napi::Array::New(env);
-
-    for (const auto &issue : pIssues) {
-        auto object = Napi::Object::New(env);
-
-        object.Set("type", Napi::Number::New(env, static_cast<int>(issue->type())));
-        object.Set("description", Napi::String::New(env, issue->description()));
-
-        res.Set(res.Length(), object);
-    }
-
-    return res;
-}
-
-napi_value doublesToNapiArray(const Napi::Env &pEnv, const std::vector<double> &pDoubles)
-{
-    auto array = Napi::Array::New(pEnv, pDoubles.size());
-
-    for (size_t i = 0; i < pDoubles.size(); ++i) {
-        array[i] = Napi::Number::New(pEnv, pDoubles[i]);
-    }
-
-    return array;
-}

package/src/libopencor/src/common.h

@@ -1,27 +0,0 @@
-#pragma once
-
-#include <libopencor>
-
-#include <napi.h>
-
-struct FileData
-{
-    libOpenCOR::SedDocumentPtr sedDocument;
-    libOpenCOR::SedInstancePtr sedInstance;
-};
-
-extern libOpenCOR::FileManager fileManager;
-extern std::map<libOpenCOR::FilePtr, FileData> fileData;
-
-libOpenCOR::FilePtr valueToFile(const Napi::Value &pValue);
-libOpenCOR::SedDocumentPtr valueToSedDocument(const Napi::Value &pValue);
-libOpenCOR::SedInstancePtr valueToSedInstance(const Napi::Value &pValue);
-int32_t valueToInt32(const Napi::Value &pValue);
-double valueToDouble(const Napi::Value &pValue);
-std::string valueToString(const Napi::Value &pValue);
-
-void untrackFileData(libOpenCOR::FilePtr pFile);
-
-napi_value issues(const Napi::CallbackInfo &pInfo, libOpenCOR::IssuePtrs pIssues);
-
-napi_value doublesToNapiArray(const Napi::Env &pEnv, const std::vector<double> &pDoubles);

package/src/libopencor/src/file.cpp

@@ -1,72 +0,0 @@
-#include "common.h"
-#include "file.h"
-
-#include <libopencor>
-
-// FileManager API.
-
-void fileManagerUnmanage(const Napi::CallbackInfo &pInfo)
-{
-    auto files = fileManager.files();
-    auto path = pInfo[0].ToString().Utf8Value();
-
-    for (auto file : files) {
-        if (file->path() == path) {
-            untrackFileData(file);
-
-            fileManager.unmanage(file);
-
-            break;
-        }
-    }
-}
-
-// File API.
-
-napi_value fileContents(const Napi::CallbackInfo &pInfo)
-{
-    auto file = valueToFile(pInfo[0]);
-    auto res = file->contents();
-
-    return Napi::Buffer<unsigned char>::Copy(pInfo.Env(), res.data(), res.size());
-}
-
-void fileCreate(const Napi::CallbackInfo &pInfo)
-{
-    auto contents = (pInfo[1].Type() == napi_object) ? pInfo[1].As<Napi::Buffer<unsigned char>>() : Napi::Buffer<unsigned char>();
-    auto file = libOpenCOR::File::create(pInfo[0].ToString().Utf8Value(), contents.IsEmpty());
-
-    if (!contents.IsEmpty()) {
-        file->setContents(std::vector<unsigned char>(contents.Data(), contents.Data() + contents.Length()));
-    }
-
-    // Keep track of the file so that it doesn't get garbage collected.
-
-    fileData[file] = {};
-}
-
-napi_value fileIssues(const Napi::CallbackInfo &pInfo)
-{
-    return issues(pInfo, valueToFile(pInfo[0])->issues());
-}
-
-napi_value fileType(const Napi::CallbackInfo &pInfo)
-{
-    auto file = valueToFile(pInfo[0]);
-
-    return Napi::Number::New(pInfo.Env(), static_cast<int>(file->type()));
-}
-
-napi_value fileUiJson(const Napi::CallbackInfo &pInfo)
-{
-    auto file = valueToFile(pInfo[0]);
-    auto uiJson = file->childFile("simulation.json");
-
-    if (uiJson == nullptr) {
-        return pInfo.Env().Undefined();
-    }
-
-    auto res = uiJson->contents();
-
-    return Napi::Buffer<unsigned char>::Copy(pInfo.Env(), res.data(), res.size());
-}

package/src/libopencor/src/file.h

@@ -1,15 +0,0 @@
-#pragma once
-
-#include <napi.h>
-
-// FileManager API.
-
-void fileManagerUnmanage(const Napi::CallbackInfo &pInfo);
-
-// File API.
-
-napi_value fileContents(const Napi::CallbackInfo &pInfo);
-void fileCreate(const Napi::CallbackInfo &pInfo);
-napi_value fileIssues(const Napi::CallbackInfo &pInfo);
-napi_value fileType(const Napi::CallbackInfo &pInfo);
-napi_value fileUiJson(const Napi::CallbackInfo &pInfo);