shinkansen-engine 1.2.473 → 1.2.475

package/docs/array.md

@@ -0,0 +1,232 @@
+
+## 3. Array
+
+Arrays contain _one_ or _several_ values, which can be any type (including other arrays). Our Stories contain _single-value_ layouts which you can explore under _Controls_.
+
+Whether _items is an object_ or _items is an array_ depends on how Zashiki interprets the JSON Schema (assuming that Zashiki has mechanically translated a JSON Schema into a description, and the description hasn't been generated manually). It matters for validating the _document_ according to the _schema_, but for humans the distinction may seem arbitrary. Our stories account for both structures.
+
+### Array (_Items is an object_)
+
+- [String](#3---1---1-array-items-is-an-object---string)
+- [String (_Enum_)](#3---1---1---1-array-items-is-an-object---string-enum)
+- [String (_Any of_)](#3---1---1---2-array-items-is-an-object---string-any-of)
+- [String (_One of_)](#3---1---1---3-array-items-is-an-object---string-one-of)
+- [Number](#3---1---2-array-items-is-an-object---number)
+- [Number (_Enum_)](#3---1---2---1-array-items-is-an-object---number-enum)
+- [Number (_Any of_)](#3---1---2---2-array-items-is-an-object---number-any-of)
+- [Number (_One of_)](#3---1---2---3-array-items-is-an-object---number-one-of)
+- [Boolean](#3---1---3-array-items-is-an-object---boolean)
+- [Boolean (_Enum_)](#3---1---3---1-array-items-is-an-object---boolean-enum)
+- [Boolean (_Any of_)](#3---1---3---2-array-items-is-an-object---boolean-any-of)
+- [Boolean (_One of_)](#3---1---3---3-array-items-is-an-object---boolean-one-of)
+- [Null](#3---1---4-array-items-is-an-object---null)
+- [Null (_Enum_)](#3---1---4---1-array-items-is-an-object---null-enum)
+- [Null (_Any of_)](#3---1---4---2-array-items-is-an-object---null-any-of)
+- [Null (_One of_)](#3---1---4---3-array-items-is-an-object---null-one-of)
+
+### Array (_Items is an array_)
+
+- [String](#3---2---1-array-items-is-an-array---string)
+- [String (_Enum_)](#3---2---1---1-array-items-is-an-array---string-enum)
+- [String (_Any of_)](#3---2---1---2-array-items-is-an-array---string-any-of)
+- [String (_One of_)](#3---2---1---3-array-items-is-an-array---string-one-of)
+- [Number](#3---2---2-array-items-is-an-array---number)
+- [Number (_Enum_)](#3---2---2---1-array-items-is-an-array---number-enum)
+- [Number (_Any of_)](#3---2---2---2-array-items-is-an-array---number-any-of)
+- [Number (_One of_)](#3---2---2---3-array-items-is-an-array---number-one-of)
+- [Boolean](#3---2---3-array-items-is-an-array---boolean)
+- [Boolean (_Enum_)](#3---2---3---1-array-items-is-an-array---boolean-enum)
+- [Boolean (_Any of_)](#3---2---3---2-array-items-is-an-array---boolean-any-of)
+- [Boolean (_One of_)](#3---2---3---3-array-items-is-an-array---boolean-one-of)
+- [Null](#3---2---4-array-items-is-an-array---null)
+- [Null (_Enum_)](#3---2---4---1-array-items-is-an-array---null-enum)
+- [Null (_Any of_)](#3---2---4---2-array-items-is-an-array---null-any-of)
+- [Null (_One of_)](#3---2---4---3-array-items-is-an-array---null-one-of)
+
+### 3 - 1 - 1. Array (_Items is an object_) - String
+
+![Array layout](images/array-object-string.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 1 - 1. Array (_Items is an object_) - String (_Enum_)
+
+![Array layout for `enum`](images/array-object-string-enum.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 1 - 2. Array (_Items is an object_) - String (_Any Of_)
+
+![Array layout from `anyOf`](images/array-object-string-any-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 1 - 3. Array (_Items is an object_) - String (_One Of_)
+
+![Array layout from `oneOf`](images/array-object-string-one-of.png)
+
+### 3 - 1 - 2. Array (_Items is an object_) - Number
+
+![Array layout](images/array-object-number.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 2 - 1. Array (_Items is an object_) - Number (_Enum_)
+
+![Array layout for `enum`](images/array-object-number-enum.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 2 - 2. Array (_Items is an object_) - Number (_Any Of_)
+
+![Array layout from `anyOf`](images/array-object-number-any-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 2 - 3. Array (_Items is an object_) - Number (_One Of_)
+
+![Array layout from `oneOf`](images/array-object-number-one-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 3. Array (_Items is an object_) - Boolean
+
+![Array layout](images/array-object-boolean.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 3 - 1. Array (_Items is an object_) - Boolean (_Enum_)
+
+![Array layout for `enum`](images/array-object-boolean-enum.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 3 - 2. Array (_Items is an object_) - Boolean (_Any Of_)
+
+![Array layout from `anyOf`](images/array-object-boolean-any-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 3 - 3. Array (_Items is an object_) - Boolean (_One Of_)
+
+![Array layout from `oneOf`](images/array-object-boolean-one-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 4. Array (_Items is an object_) - Null
+
+![Array layout](images/array-object-string.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 4 - 1. Array (_Items is an object_) - Null (_Enum_)
+
+![Array layout for `enum`](images/array-object-null-enum.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 4 - 2. Array (_Items is an object_) - Null (_Any Of_)
+
+![Array layout from `anyOf`](images/array-object-null-any-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 1 - 4 - 3. Array (_Items is an object_) - Null (_One Of_)
+
+![Array layout from `oneOf`](images/array-object-null-one-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 1. Array (_Items is an array_) - String
+
+![Array layout](images/array-array-string.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 1 - 1. Array (_Items is an array_) - String (_Enum_)
+
+![Array layout for `enum`](images/array-array-string-enum.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 1 - 2. Array (_Items is an array_) - String (_Any Of_)
+
+![Array layout from `anyOf`](images/array-array-string-any-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 1 - 3. Array (_Items is an array_) - String (_One Of_)
+
+![Array layout from `oneOf`](images/array-array-string-one-of.png)
+
+### 3 - 2 - 2. Array (_Items is an array_) - Number
+
+![Array layout for `enum`](images/array-array-number.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 2 - 1. Array (_Items is an array_) - Number (_Enum_)
+
+![Array layout for `enum`](images/array-array-number-enum.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 2 - 2. Array (_Items is an array_) - Number (_Any Of_)
+
+![Array layout from `anyOf`](images/array-array-number-any-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 2 - 3. Array (_Items is an array_) - Number (_One Of_)
+
+![Array layout from `oneOf`](images/array-array-number-one-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 3. Array (_Items is an array_) - Boolean
+
+![Array layout for `enum`](images/array-array-boolean.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 3 - 1. Array (_Items is an array_) - Boolean (_Enum_)
+
+![Array layout for `enum`](images/array-array-boolean-enum.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 3 - 2. Array (_Items is an array_) - Boolean (_Any Of_)
+
+![Array layout from `anyOf`](images/array-array-boolean-any-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 3 - 3. Array (_Items is an array_) - Boolean (_One Of_)
+
+![Array layout from `oneOf`](images/array-array-boolean-one-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 4. Array (_Items is an array_) - Null
+
+![Array layout for `enum`](images/array-array-null.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 4 - 1. Array (_Items is an array_) - Null (_Enum_)
+
+![Array layout for `enum`](images/array-array-null-enum.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 4 - 2. Array (_Items is an array_) - Null (_Any Of_)
+
+![Array layout from `anyOf`](images/array-array-null-any-of.png)
+
+_Back to [Array](#3-array)_
+
+### 3 - 2 - 4 - 3. Array (_Items is an array_) - Null (_One Of_)
+
+![Array layout from `oneOf`](images/array-array-null-one-of.png)
+
+_Back to [Array](#3-array)_

package/docs/boolean.md

@@ -0,0 +1,25 @@
+## 5. Boolean
+
+![Boolean layout](images/boolean.png)
+
+- [Boolean (_Enum_)](#5---1-boolean-enum)
+- [Boolean (_Any of_)](#5---2-boolean-any-of)
+- [Boolean (_One of_)](#5---3-boolean-one-of)
+
+### 5 - 1. Boolean (_Enum_)
+
+![Boolean layout for `enum`](images/boolean-enum.png)
+
+_Back to [Boolean](#5-boolean)_
+
+### 5 - 2. Boolean (_Any Of_)
+
+![Boolean layout from `anyOf`](images/boolean-any-of.png)
+
+_Back to [Boolean](#5-boolean)_
+
+### 5 - 3. Boolean (_One Of_)
+
+![Boolean layout from `oneOf`](images/boolean-one-of.png)
+
+_Back to [Boolean](#5-boolean)_

package/docs/null.md

@@ -0,0 +1,25 @@
+## 6. Null
+
+![Null layout](images/null.png)
+
+- [Null (_Enum_)](#6---1-null-enum)
+- [Null (_Any of_)](#6---2-null-any-of)
+- [Null (_One of_)](#6---3-null-one-of)
+
+### 6 - 1. Null (_Enum_)
+
+![Null layout for `enum`](images/null-enum.png)
+
+_Back to [Null](#6-null)_
+
+### 6 - 2. Null (_Any Of_)
+
+![Null layout from `anyOf`](images/null-any-of.png)
+
+_Back to [Null](#6-null)_
+
+### 6 - 3. Null (_One Of_)
+
+![Null layout from `oneOf`](images/null-one-of.png)
+
+_Back to [Null](#6-null)_

package/docs/number.md

@@ -0,0 +1,25 @@
+## 2. Number
+
+![Number layout](images/number.png)
+
+- [Number (_Enum_)](#2---1-number-enum)
+- [Number (_Any of_)](#2---2-number-any-of)
+- [Number (_One of_)](#2---3-number-one-of)
+
+### 2 - 1. Number (_Enum_)
+
+![Number layout for `enum`](images/number-enum.png)
+
+_Back to [Number](#2-number)_
+
+### 2 - 2. Number (_Any Of_)
+
+![Number layout from `anyOf`](images/number-any-of.png)
+
+_Back to [Number](#2-number)_
+
+### 2 - 3. Number (_One Of_)
+
+![Number layout from `oneOf`](images/number-one-of.png)
+
+_Back to [Number](#2-number)_

package/docs/object.md

@@ -0,0 +1,116 @@
+## 4. Object
+
+Objects contain _one_ or _several_ values, which can be any type (including other objects). Our Stories contain _single-value_ layouts which you can explore under _Controls_.
+
+- [Object - String](#4---1-object---string)
+- [Object - String (_Enum_)](#4---1---1-object---string-enum)
+- [Object - String (_Any of_)](#4---1---2-object---string-any-of)
+- [Object - String (_One of_)](#4---1---3-object---string-one-of)
+- [Object - Number](#4---2-object---number)
+- [Object - Number (_Enum_)](#4---2---1-object---number-enum)
+- [Object - Number (_Any of_)](#4---2---2-object---number-any-of)
+- [Object - Number (_One of_)](#4---2---3-object---number-one-of)
+- [Object - Boolean](#4---3-object---boolean)
+- [Object - Boolean (_Enum_)](#4---3---1-object---boolean-enum)
+- [Object - Boolean (_Any of_)](#4---3---2-object---boolean-any-of)
+- [Object - Boolean (_One of_)](#4---3---3-object---boolean-one-of)
+- [Object - Null](#4---4-object---null)
+- [Object - Null (_Enum_)](#4---4---1-object---null-enum)
+- [Object - Null (_Any of_)](#4---4---2-object---null-any-of)
+- [Object - Null (_One of_)](#4---4---3-object---null-one-of)
+
+### 4 - 1. Object - String
+
+![Object layout](images/object-string.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 1 - 1. Object - String (_Enum_)
+
+![Object layout for `enum`](images/object-string-enum.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 1 - 2. Object - String (_Any Of_)
+
+![Object layout from `anyOf`](images/object-string-any-of.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 1 - 3. Object - String (_One Of_)
+
+![Object layout from `oneOf`](images/object-string-one-of.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 2. Object - Number
+
+![Object layout for `enum`](images/object-number.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 2 - 1. Object - Number (_Enum_)
+
+![Object layout for `enum`](images/object-number-enum.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 2 - 2. Object - Number (_Any Of_)
+
+![Object layout from `anyOf`](images/object-number-any-of.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 2 - 3. Object - Number (_One Of_)
+
+![Object layout from `oneOf`](images/object-number-one-of.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 3. Object - Boolean
+
+![Object layout](images/object-boolean.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 3 - 1. Object - Boolean (_Enum_)
+
+![Object layout for `enum`](images/object-boolean-enum.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 3 - 2. Object - Boolean (_Any Of_)
+
+![Object layout from `anyOf`](images/object-boolean-any-of.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 3 - 3. Object - Boolean (_One Of_)
+
+![Object layout from `oneOf`](images/object-boolean-one-of.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 4. Object - Null
+
+![Object layout](images/object-null.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 4 - 1. Object - Null (_Enum_)
+
+![Object layout for `enum`](images/object-null-enum.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 4 - 2. Object - Null (_Any Of_)
+
+![Object layout from `anyOf`](images/object-null-any-of.png)
+
+_Back to [Object](#4-object)_
+
+### 4 - 4 - 3. Object - Null (_One Of_)
+
+![Object layout from `oneOf`](images/object-null-one-of.png)
+
+_Back to [Object](#4-object)_

package/docs/string.md

@@ -0,0 +1,25 @@
+## 1. String
+
+![String layout](images/string.png)
+
+- [String (_Enum_)](#1---1-string-enum)
+- [String (_Any of_)](#1---2-string-any-of)
+- [String (_One of_)](#1---3-string-one-of)
+
+### 1 - 1. String (_Enum_)
+
+![String layout for `enum`](images/string-enum.png)
+
+_Back to [String](#1-string)_
+
+### 1 - 2. String (_Any Of_)
+
+![String layout from `anyOf`](images/string-any-of.png)
+
+_Back to [String](#1-string)_
+
+### 1 - 3. String (_One Of_)
+
+![String layout from `oneOf`](images/string-one-of.png)
+
+_Back to [String](#1-string)_

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-engine",
-  "version": "1.2.473",
+  "version": "1.2.475",
   "description": "Shinkansen Engine",
   "keywords": [
     "Shinkansen",
@@ -96,13 +96,13 @@
     "remove-files-webpack-plugin": "^1.5.0",
     "sass": "^1.81.0",
     "sass-loader": "^16.0.3",
-    "shinkansen-cogs": "1.7.270",
+    "shinkansen-cogs": "1.7.271",
     "shinkansen-gears": "1.1.442",
     "shinkansen-pantograph": "1.3.303",
-    "shinkansen-pinion": "1.1.508",
+    "shinkansen-pinion": "1.1.511",
     "shinkansen-rails": "1.0.252",
     "shinkansen-signals": "1.1.182",
-    "shinkansen-sprockets": "1.1.429",
+    "shinkansen-sprockets": "1.1.430",
     "shinkansen-transmission": "2.2.204",
     "sinon": "^19.0.2",
     "storybook": "7.6.20",

package/jsconfig.json

@@ -1,5 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": "."
-  }
-}

package/transform.sh

@@ -1,4 +0,0 @@
-#!/bin/bash
-
-DEBUG="${DEBUG:-shinkansen-cogs*}"
-node -e 'import("./build/transform.mjs").then(({ default: transform }) => transform())'

package/tsconfig.json

@@ -1,71 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "ESNext",
-    "target": "ESNext",
-    "allowJs": true,
-    "checkJs": false,
-    "allowSyntheticDefaultImports": true,
-    "noEmit": true,
-    "strict": true,
-    "isolatedModules": true,
-    "baseUrl": ".",
-    "paths": {
-      "#engine/common": [
-        "src/common/index.mjs"
-      ],
-      "#engine/components": [
-        "src/components/index.mjs"
-      ],
-      "#engine/components/*": [
-        "src/components/*/index.mjs"
-      ],
-      "#engine/components/gears/forward": [
-        "src/components/gears/forward/index.cjs"
-      ],
-      "#engine/components/gears/reverse": [
-        "src/components/gears/reverse/index.cjs"
-      ],
-      "#engine/engine": [
-        "src/engine/index.jsx"
-      ],
-      "#engine/engine/*": [
-        "src/engine/*/index.jsx"
-      ],
-      "#engine/transformers": [
-        "src/transformers/index.mjs"
-      ],
-      "#engine/transformers/*": [
-        "src/transformers/*/index.mjs"
-      ],
-      "#stories/components/*": [
-        "stories/components/*/index.stories.jsx"
-      ],
-      "#stories/definitions/*": [
-        "stories/definitions/*.json"
-      ],
-      "#stories/engine/*": [
-        "stories/engine/*/index.stories.jsx"
-      ],
-      "#stories/errors": [
-        "stories/errors.mjs"
-      ],
-      "#stories/state": [
-        "stories/state/index.jsx"
-      ],
-      "#stories/state/*": [
-        "stories/state/*/index.jsx"
-      ]
-    }
-  },
-  "include": [
-    "src/**/*",
-    "node_modules/shinkansen-cogs/src/**/*",
-    "node_modules/shinkansen-gears/src/**/*",
-    "node_modules/shinkansen-pantograph/src/**/*",
-    "node_modules/shinkansen-pinion/src/**/*",
-    "node_modules/shinkansen-rails/src/**/*",
-    "node_modules/shinkansen-signals/src/**/*",
-    "node_modules/shinkansen-sprockets/src/**/*",
-    "node_modules/shinkansen-transmission/src/**/*"
-  ]
-}

package/webpack.config.mjs

@@ -1,129 +0,0 @@
-import {
-  join
-} from 'node:path'
-
-import Webpack from 'webpack'
-
-import {
-  CleanWebpackPlugin as CleanPlugin
-} from 'clean-webpack-plugin'
-import MiniCssExtractPlugin from 'mini-css-extract-plugin'
-import RemoveFilesPlugin from 'remove-files-webpack-plugin'
-
-import {
-  storybookPath as STORYBOOK_PATH,
-  modulePath as MODULE_PATH
-} from '#build/paths'
-
-const {
-  EnvironmentPlugin,
-  SourceMapDevToolPlugin
-} = Webpack
-
-export default {
-  mode: 'production',
-  entry: {
-    'preview-head': join(STORYBOOK_PATH, 'sass/preview-head.scss')
-  },
-  output: {
-    path: join(STORYBOOK_PATH, 'css')
-  },
-  stats: {
-    colors: true
-  },
-  module: {
-    rules: [
-      {
-        test: /\.scss$/i,
-        use: [
-          MiniCssExtractPlugin.loader,
-          {
-            loader: 'css-loader',
-            options: {
-              importLoaders: 1,
-              sourceMap: false,
-              url: false
-            }
-          },
-          {
-            loader: 'postcss-loader',
-            options: {
-              sourceMap: false,
-              postcssOptions: {
-                config: false,
-                plugins: [
-                  'postcss-import',
-                  'postcss-discard-comments',
-                  'postcss-discard-empty',
-                  [
-                    'postcss-map', {
-                      maps: [
-                        join(MODULE_PATH, '@modernpoacher/design-system/src/tokens/palette.json')
-                      ]
-                    }
-                  ],
-                  [
-                    'autoprefixer', {
-                      remove: false
-                    }
-                  ],
-                  [
-                    'perfectionist', {
-                      trimLeadingZero: false,
-                      sourcemap: true,
-                      indentSize: 2,
-                      format: 'expanded',
-                      syntax: 'scss'
-                    }
-                  ]
-                ]
-              }
-            }
-          },
-          {
-            loader: 'sass-loader',
-            options: {
-              sourceMap: false,
-              sassOptions: {
-                loadPaths: [
-                  join(MODULE_PATH, '@modernpoacher/design-system/src/sass')
-                ]
-              }
-            }
-          }
-        ]
-      }
-    ]
-  },
-  plugins: [
-    new CleanPlugin({
-      verbose: false,
-      cleanOnceBeforeBuildPatterns: [
-        join(STORYBOOK_PATH, 'css/*.css'),
-        join(STORYBOOK_PATH, 'css/*.css.map')
-      ]
-    }),
-    new EnvironmentPlugin({
-      NODE_ENV: 'production'
-    }),
-    new SourceMapDevToolPlugin({
-      test: /\.css$/i,
-      filename: '[name].css.map'
-    }),
-    new MiniCssExtractPlugin({
-      filename: '[name].css'
-    }),
-    new RemoveFilesPlugin({
-      after: {
-        test: [
-          {
-            folder: join(STORYBOOK_PATH, 'css'),
-            method (filePath) {
-              return /\.js$/m.test(filePath)
-            }
-          }
-        ]
-      }
-    })
-  ]
-}