daiquiri-ui 2025.12.1__tar.gz → 2026.2.0__tar.gz

daiquiri_ui-2026.2.0/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.scss]
+indent_size = 4

daiquiri_ui-2026.2.0/.env

@@ -0,0 +1,18 @@
+# Please override any of the environment variables below either in your shell
+# or in your own `.env.local` and/or `.env.<environment>.local` files:
+# https://create-react-app.dev/docs/adding-custom-environment-variables#what-other-env-files-can-be-used
+
+#GENERATE_SOURCEMAP=false
+#export NODE_OPTIONS=--max_old_space_size=4096
+NODE_OPTIONS=--max_old_space_size=4096
+DISABLE_ESLINT_PLUGIN=true
+
+# Ignore more recent version of ESLint
+SKIP_PREFLIGHT_CHECK=true
+
+# In development, the API URL is set to http://localhost:8080/api
+# This controls whether to use HTTPS instead
+VITE_HTTPS=false
+
+# Override the default API URL in dev/prod
+VITE_API_URL=

daiquiri_ui-2026.2.0/.eslintignore

@@ -0,0 +1,7 @@
+build
+styleguide
+dist
+
+# Monorepo packages
+/docusaurus/
+/lib/

daiquiri_ui-2026.2.0/.eslintrc.cjs

@@ -0,0 +1,5 @@
+const { getDependencies } = require('eslint-config-galex/dist/getDependencies');
+
+const { createConfig } = require('./eslint.shared.cjs');
+
+module.exports = createConfig(__dirname, getDependencies());

daiquiri_ui-2026.2.0/.gitignore

@@ -0,0 +1,28 @@
+/node_modules/
+
+/dist/
+/build/
+/bundle/
+/coverage/
+/styleguide/
+
+/docusaurus/.docusaurus/
+/docusaurus/node_modules/
+/docusaurus/build/
+/docusaurus/.cache-loader
+
+/lib/node_modules/
+/lib/dist/
+/lib/dist-ts/
+/lib/tsconfig.build.tsbuildinfo
+
+/public/search_index.json
+/public/meta.json
+
+.env.local
+.env.*.local
+
+.DS_Store
+*.log*
+*.sublime*
+.project

daiquiri_ui-2026.2.0/.gitlab-ci.yml

@@ -0,0 +1,164 @@
+image: node:22-bookworm
+
+stages:
+  - check
+  - build
+  - deploy
+  - package
+  - publish
+
+.install:
+  before_script:
+    - npm install -g pnpm@latest-10
+    - pnpm config set store-dir .pnpm-store
+    - pnpm install
+  cache:
+    key:
+      files:
+        - pnpm-lock.yaml
+    paths:
+      - .pnpm-store
+
+Lint:
+  stage: check
+  extends: .install
+  script:
+    - pnpm prettier
+    - pnpm tsc
+    - pnpm eslint
+    - pnpm stylelint
+
+Lint-lib:
+  stage: check
+  extends: .install
+  script:
+    - pnpm --filter @esrf/daiquiri-lib lint:eslint
+    - pnpm --filter @esrf/daiquiri-lib lint:tsc
+
+.test:
+  stage: check
+  extends: .install
+  script:
+    - pnpm test $VITEST_ARGS
+  artifacts:
+    paths:
+      - junit-report.xml
+    reports:
+      junit: junit-report.xml
+  variables:
+    VITEST_ARGS: 'run --coverage'
+  coverage: '/All files(?:[^|]*\|){4}\s*(\S+)/'
+
+Test:
+  extends: .test
+  except:
+    - main
+    - tags
+
+Test with coverage:
+  extends: .test
+  artifacts:
+    when: always
+    paths:
+      - coverage
+    expire_in: 7 days
+  only:
+    - main
+    - tags
+
+Build:
+  stage: build
+  extends: .install
+  script:
+    - CI=false pnpm build # don't let warnings fail the build
+  needs: [] # don't download previous artifacts
+  artifacts:
+    paths:
+      - pysrc/daiquiri_ui/static
+
+Build-lib:
+  stage: build
+  extends: .install
+  script:
+    - cd lib
+    - pnpm build
+  needs: []
+  artifacts:
+    paths:
+      - lib/dist
+
+Docusaurus:
+  stage: build
+  extends: .install
+  script:
+    - cd docusaurus
+    - BASE_URL=/daiquiri-ui pnpm build
+  needs: []
+  artifacts:
+    paths:
+      - docusaurus/build
+
+pages:
+  stage: deploy
+  script:
+    - rm -rf public
+    - mv docusaurus/build public
+  needs:
+    - Docusaurus
+  artifacts:
+    paths:
+      - public
+  only:
+    - main
+    - tags
+
+Publish-lib:
+  stage: publish
+  needs:
+    - Build-lib
+  extends: .install
+  script:
+    - |
+      VERSION=$(echo $CI_COMMIT_TAG | awk -F'-v' '{print $2}')
+      echo "publish daiquiri-lib version: ${VERSION}"
+      if [[ "$VERSION" != "" ]]; then
+        cd lib
+        npm config set //registry.npmjs.org/:_authToken "$NPM_AUTH_TOKEN"
+        pnpm publish --access public --no-git-checks
+      fi
+  rules:
+    - if: $CI_COMMIT_TAG =~ /lib-v\d+.\d+.\d+/
+
+package:
+  stage: package
+  image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/continuumio/miniconda3:latest
+  script:
+    - pip install build
+    - python -m build
+  artifacts:
+    paths:
+      - dist
+    expire_in: 7 days
+  interruptible: true
+
+pypi:
+  stage: publish
+  image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/continuumio/miniconda3:latest
+  script:
+    - pip install twine
+    - twine upload dist/*
+  rules:
+    - if: $CI_COMMIT_TAG =~ /ui-\d+.\d+.\d+/
+  interruptible: true
+
+Analyse:
+  stage: deploy
+  extends: .install
+  script:
+    - pnpm analyze --html bundle/index.html
+  needs:
+    - Build
+  artifacts:
+    paths:
+      - bundle
+  when: manual

daiquiri_ui-2026.2.0/.npmrc

@@ -0,0 +1,5 @@
+# Save exact dependency versions in `package.json`
+save-prefix=""
+
+# Run pre/post scripts, like `prebuild`, automatically
+enable-pre-post-scripts=true

daiquiri_ui-2026.2.0/.prettierignore

@@ -0,0 +1,10 @@
+/.pnpm-store/
+/pnpm-lock.yaml
+
+/build/
+/bundle/
+/coverage/
+/styleguide/
+
+/public/meta.json
+/public/search_index.json

daiquiri_ui-2026.2.0/.prettierrc

@@ -0,0 +1,20 @@
+{
+  "singleQuote": true,
+  "overrides": [
+    {
+      "files": ["*.scss"],
+      "options": {
+        "tabWidth": 4,
+        "trailingComma": "none"
+      }
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "options": {
+        "trailingComma": "none",
+        "arrowParens": "avoid",
+        "endOfLine": "auto"
+      }
+    }
+  ]
+}

daiquiri_ui-2026.2.0/.stylelintrc.json

@@ -0,0 +1,14 @@
+{
+  "extends": [
+    "stylelint-config-sass-guidelines",
+    "stylelint-config-idiomatic-order",
+    "stylelint-config-prettier"
+  ],
+  "rules": {
+    "order/properties-alphabetical-order": null,
+    "max-nesting-depth": 3,
+    "declaration-property-value-disallowed-list": {
+      "/^border/": []
+    }
+  }
+}

daiquiri_ui-2026.2.0/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "editorconfig.editorconfig",
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint",
+    "stylelint.vscode-stylelint",
+    "unifiedjs.vscode-mdx"
+  ]
+}

daiquiri_ui-2026.2.0/.vscode/settings.json

@@ -0,0 +1,28 @@
+{
+  "javascript.format.enable": false,
+  "typescript.format.enable": false,
+  "json.format.enable": false,
+
+  "css.validate": false,
+  "scss.validate": false,
+
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.stylelint": "explicit"
+  },
+
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.enablePromptUseWorkspaceTsdk": true,
+  "typescript.preferences.importModuleSpecifier": "relative",
+
+  "eslint.codeAction.disableRuleComment": { "location": "sameLine" },
+
+  "stylelint.snippet": ["css", "scss"],
+  "stylelint.validate": ["css", "scss"],
+  "stylelint.reportNeedlessDisables": true,
+  "stylelint.reportInvalidScopeDisables": true,
+
+  "mdx.experimentalLanguageServer": true
+}

daiquiri_ui-2026.2.0/CONTRIBUTING.md

@@ -0,0 +1,137 @@
+# Contributing
+
+- [Quick start](#quick-start-)
+- [Development](#development)
+  - [`pnpm` cheat sheet](#pnpm-cheat-sheet)
+  - [Dependency management](#dependency-management)
+  - [Why not Node 18?](#why-not-node-18)
+- [Building for production](#building-for-production)
+- [Testing](#testing)
+- [Code quality](#code-quality)
+  - [Editor integration](#editor-integration)
+- [CI](#ci)
+
+## Quick start 🚀
+
+To get started, you'll need:
+
+- [Node 16](https://nodejs.org/) - e.g. `nvm install 16`, `volta install node@16`, etc.
+- [pnpm 8](https://pnpm.io/) - e.g. `npm install -g pnpm@8`, `volta install pnpm@8`, etc.
+
+Then, install the dependencies and start the development server with:
+
+```bash
+pnpm install
+pnpm start
+```
+
+To start the Daiquiri UI documentation site in development, run:
+
+```bash
+pnpm styleguide
+```
+
+## Development
+
+Daiquiri UI is set up with [Create React App](https://reactjs.org/docs/create-a-new-react-app.html). The documentation site is based on [Docusaurus](https://docusaurus.io/).
+
+In development, the back-end API's `baseUrl` is changed automatically to `http://localhost:8080/api`. If HTTPS is required, set environment variable `VITE_HTTPS=true`. If a completely different `baseUrl` is required, set environment variable `VITE_API_URL=http://myhost:1233/api`.
+
+### `pnpm` cheat sheet
+
+- `pnpm install` - install dependencies
+- `pnpm add [-D] <pkg-name>` - [add a dependency](https://pnpm.io/cli/add)
+- `pnpm [run] <script> [--<arg>]` - run a script
+- `pnpm [exec] <binary>` - run a binary located in `node_modules/.bin`
+  (equivalent to `npx <pkg-name>` for a package installed in the workspace)
+- `pnpm dlx <pkg-name>` - fetch a package from the registry and run its default
+  command binary (equivalent to `npx <pkg-name>`)
+- `pnpm why <pkg-name>` - show all packages that depend on the specified package
+- `pnpm outdated` - list outdated dependencies
+- `pnpm up -L <pkg-name>` - update a package to the latest version
+
+### Dependency management
+
+1. Run `pnpm outdated` to list dependencies that can be upgraded.
+1. Read the changelogs and release notes of the dependencies you'd like to
+   upgrade. Look for potential breaking changes, and for bug fixes and new
+   features that may help improve the codebase.
+1. Run `pnpm up -L <pkg-name>` to upgrade a dependency to the latest version.
+   Alternatively, you can also edit `package.json` manually and run
+   `pnpm install`, but make sure to specify an exact dependency version rather
+   than a range (i.e. don't prefix the version with a caret or a tilde).
+
+Beware of the following dependency and versioning requirements:
+
+- `stylelint-config-sass-guidelines` requires `postcss` to be installed explicitly; its version must match the one installed by `react-scripts>css-loader`.
+- `@testing-library/user-event` requires `@testing-library/dom` to be installed explicitly; its version must match the one installed by `@testing-library/react`.
+- `babel-preset-react-app` must be installed explicitly for linting to work in VSCode.
+- The major version number of `@types/node` must match the version of Node
+  specified in the `engine` field of `package.json`.
+- The major version numbers of
+  [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) packages
+  must match the major version numbers of their corresponding dependencies (e.g.
+  `@types/jest@27` for `jest@27`).
+
+Note that `pnpm` offers multiple solutions for dealing with peer dependency
+version conflicts and other package resolution issues:
+[`pnpm.overrides`](https://pnpm.io/package_json#pnpmoverrides),
+[`pnpm.packageExtensions`](https://pnpm.io/package_json#pnpmpackageextensions),
+[`pnpm.peerDependenciesRules`](https://pnpm.io/package_json#pnpmpeerdependencyrules), etc.
+
+### Why not Node 18?
+
+`fabric` has a dependency on [`node-canvas`](https://github.com/Automattic/node-canvas/releases) (`canvas` on the NPM registry), which itself is based on [Cairo](https://www.cairographics.org/). On install, `node-canvas` has to download a pre-built binary from GitHub. Unfortunately, as of [v2.9.3](https://github.com/Automattic/node-canvas/releases/tag/v2.9.3), pre-built binaries for Node 18 (`node-v108`) are not yet provided. This is the reason why `daiquiri-ui` currently requires Node 16.
+
+## Building for production
+
+- `pnpm build` - build Daiquiri UI for production to `/build`
+- `pnpm serve` - serve the content of the `/build` folder to double check that the production build worked as expected
+- `pnpm styleguide-build` - build the documentation site for production to `/styleguide`
+- `pnpm styleguide-preview` - serve the content of the `/styleguide` folder
+
+For Daiquiri UI's production build to work locally, set environment variable `REACT_APP_API_URL=https://localhost:8080/api` when running `pnpm build`.
+
+## Testing
+
+The tests run with [Jest](https://jestjs.io/) and make use of [React Testing Library](https://testing-library.com/docs/react-testing-library/intro). You can run them with `pnpm test`.
+
+A basic test framework is provided that can be used to quickly mock api resources and mount components - cf. `src/helpers/tests`.
+
+## Code quality
+
+- Code linting uses ESLint with the [eslint-config-galex](https://github.com/ljosberinn/eslint-config-galex) configuration.
+- Code style is enforced with [Prettier](https://prettier.io/).
+- CSS is written using the SASS preprocessor and style enforced using [stylelint](https://github.com/stylelint/stylelint).
+
+The following code quality scripts are available:
+
+- `pnpm prettier` - check that all files have been formatted with Prettier
+- `pnpm prettier-fix` - format all files with Prettier
+- `pnpm eslint` - lint all TS and JS files with ESLint
+- `pnpm eslint-fix` - auto-fix all fixable linting errors in JS/TS files
+- `pnpm stylelint`: lint SCSS files with stylelint
+- `pnpm stylelint-fix`: auto-fix all fixable linting errors in SCSS files
+- `pnpm tsc` - type-check the project with `tsc`
+- `pnpm analyze` - inspect the size and content of the JS bundles (run after
+  `pnpm build`)
+
+### Editor integration
+
+Most editors support fixing and formatting files automatically on save. The
+configuration for VSCode is provided out of the box, so all you need to do is
+install the recommended extensions.
+
+## CI
+
+Gitlab CI runs an extensive pipeline when pushing to a branch or to `master`, which includes:
+
+- linting of JS and TS files with ESlint;
+- linting of SCSS files with stylelint;
+- type-checking of TS files with `tsc`
+- code formatting with Prettier;
+- testing with Jest;
+- generating [code coverage](https://ui.gitlab-pages.esrf.fr/daiquiri-ui/coverage/) (`master` and tags only);
+- building Daiquiri UI (to make sure there are no errors);
+- building and deploying the documentation site (`master` and tags only);
+- [bundle analysis](https://github.com/danvk/source-map-explorer) [report](https://ui.gitlab-pages.esrf.fr/daiquiri-ui/bundle) (manual trigger).

daiquiri_ui-2026.2.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: daiquiri-ui
+Version: 2026.2.0
+Summary: Daiquiri UI
+Author-email: ESRF <bcu@esrf.fr>
+License-Expression: MIT
+Project-URL: Repository, https://gitlab.esrf.fr/ui/daiquiri-ui
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Daiquiri UI
+
+A react/redux client for https://gitlab.esrf.fr/ui/daiquiri
+
+Latest documentation can be found at https://ui.gitlab-pages.esrf.fr/daiquiri-ui

daiquiri_ui-2026.2.0/RELEASE.md

@@ -0,0 +1,22 @@
+This repository is a workspace which contain multiple projects.
+
+This document talk about some of the workflows use for releasing
+part of this projects.
+
+# `daiquiri-ui` on `pypi`
+
+`daiquiri-ui` can be packaged as a python project in `pypi`.
+
+## Create git tag in gitlab
+
+The creation of a git tag is the only manual thing to do.
+
+I will trigger automatically the release, with the gitlab workflow.
+
+The tag have to follow the following template:
+
+`ui-YYYY.MM.MICRO`
+
+- `YYYY` the year of the release, in 4 digits
+- `MM` the month of the release, in 1 or 2 digits (`1` and not `01`)
+- `MICRO`, a number from 0 to increment for every new fix

daiquiri_ui-2026.2.0/docusaurus/.eslintignore

@@ -0,0 +1,2 @@
+/.docusaurus/
+/build/

daiquiri_ui-2026.2.0/docusaurus/.eslintrc.js

@@ -0,0 +1,5 @@
+const { getDependencies } = require('eslint-config-galex/dist/getDependencies');
+
+const { createConfig } = require('../eslint.shared');
+
+module.exports = createConfig(__dirname, getDependencies());

daiquiri_ui-2026.2.0/docusaurus/babel.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  presets: [
+    require.resolve('@docusaurus/core/lib/babel/preset'),
+    [
+      '@babel/preset-react',
+      {
+        runtime: 'automatic',
+        development: process.env.BABEL_ENV === 'development'
+      }
+    ]
+  ]
+};

daiquiri_ui-2026.2.0/docusaurus/docs/blisswebui/components/SessionButton.mdx

@@ -0,0 +1,35 @@
+import useBaseUrl from '@docusaurus/useBaseUrl';
+import DaiquiriCode from '@site/src/DaiquiriCode';
+import { BlissWebUiBadge } from '@site/src/Badge';
+import PropTable from '@site/src/PropTable';
+
+<BlissWebUiBadge />
+
+# SessionButton
+
+A component to call a function from the session.
+
+## User options
+
+<PropTable component="SessionButtonOptions" />
+
+## Example
+
+```yaml
+name: Test
+icon: fa-cog
+children:
+  - type: hardware
+    id: $sx
+  - type: hardware
+    id: $sy
+
+  - type: sessionbutton
+    function: mv # <- this calls the standard `mv` command from bliss
+    args:
+      - $sx
+      - 0.1
+      - $sy
+      - 1.2
+    label: Reset center
+```

daiquiri_ui-2026.2.0/docusaurus/docs/blisswebui/components/SessionMonitor.mdx

@@ -0,0 +1,31 @@
+import useBaseUrl from '@docusaurus/useBaseUrl';
+import DaiquiriCode from '@site/src/DaiquiriCode';
+import { BlissWebUiBadge } from '@site/src/Badge';
+import PropTable from '@site/src/PropTable';
+
+<BlissWebUiBadge />
+
+# SessionMonitor
+
+A component to display the result of a call from the BLISS session.
+
+## User options
+
+<PropTable component="SessionMonitorOptions" />
+
+## Example
+
+```yaml
+name: Test
+icon: fa-cog
+children:
+  - type: hardware
+    id: $sx
+  - type: hardware
+    id: $sy
+
+  - type: sessionmonitor
+    title: Float
+    function: get_mon_randfloat
+    polling_period: 2 # in seconds
+```

daiquiri_ui-2026.2.0/docusaurus/docs/blisswebui/components/index.mdx

@@ -0,0 +1,4 @@
+---
+sidebar_position: 3
+title: Components
+---

daiquiri_ui-2026.2.0/docusaurus/docs/blisswebui/index.mdx

@@ -0,0 +1,47 @@
+---
+sidebar_position: 4
+---
+
+# blisswebui
+
+Bliss Web UI provides a mechanism to create simple user interfaces to monitor BLISS objects.
+
+It is built using shared UI components from [daiquiri-ui](https://ui.gitlab-pages.esrf.fr/daiquiri-ui/)
+to provide a consistent user experience beteween applications.
+
+![blisswebui](@site/docs/images/blisswebui.png)
+
+## Installation
+
+Bliss Web UI is actually exposed by the BLISS session as part of the BLISS REST web service.
+It can be installed in the BLISS environment the following.
+
+```
+pip install blisswebui
+```
+
+:::info
+For more information related to the installation take a look at
+the [BLISS REST API documentation](https://bliss.gitlab-pages.esrf.fr/bliss/master/blissapi.html)
+:::
+
+## Configuration
+
+BLISS web UI is a lightweigth service, which does not provide server side API, except what BLISS provides.
+
+As result the resources and configuration are provided by static Beacon files only.
+
+Everything inside the `webui` folder i.e. `beacon://webui/config.yml` is considered to be a BLISS web ui resource.
+
+As it's not a BLISS configuration this root folder have to contain an `__init__.yml` with `bliss_ignored: true`:
+
+```yaml title="webui/__init__.yml"
+bliss_ignored: true
+```
+
+## Features
+
+There is actually mostly 2 high level features.
+
+- [Monitors](./monitor)
+- [Layouts](./layout)