shinkansen-pinion 1.0.63 → 1.0.65

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-pinion",
-  "version": "1.0.63",
+  "version": "1.0.65",
   "description": "Shinkansen Pinion",
   "keywords": [
     "Shinkansen",
@@ -32,7 +32,7 @@
     "pregulp": "npm run nvm",
     "gulp": "gulp --color",
     "prelint": "npm run nvm",
-    "lint": "eslint . .storybook --ext .mjs --ext .cjs",
+    "lint": "eslint . .storybook --ext .mjs --ext .cjs --ext .jsx --ext .mts --ext .cts",
     "lint:fix": "npm run lint -- --fix",
     "pretest": "npm run nvm",
     "test": "cross-env NODE_ENV=test jest --collect-coverage false --verbose --run-in-band",
@@ -53,13 +53,16 @@
     "@babel/preset-env": "^7.21.5",
     "@babel/preset-react": "^7.18.6",
     "@babel/register": "^7.21.0",
-    "@modernpoacher/design-system": "1.0.6",
-    "@modernpoacher/hooks": "^1.0.396",
+    "@modernpoacher/design-system": "1.0.7",
+    "@modernpoacher/hooks": "^1.0.397",
     "@sequencemedia/gulp": "^1.0.7",
     "@storybook/addon-actions": "6.5.12",
     "@storybook/addon-essentials": "6.5.12",
     "@storybook/addon-links": "6.5.12",
     "@storybook/react": "6.5.12",
+    "@types/react": "^18.2.6",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
     "autoprefixer": "^10.4.14",
     "babel-plugin-module-resolver": "^5.0.0",
     "core-js": "^3.30.2",
@@ -70,6 +73,7 @@
     "enzyme-adapter-react-16": "^1.15.7",
     "eslint": "^8.40.0",
     "eslint-config-standard": "^17.0.0",
+    "eslint-config-standard-with-typescript": "^34.0.1",
     "eslint-import-resolver-babel-module": "^5.3.2",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-node": "^11.1.0",
@@ -99,10 +103,10 @@
     "regenerator-runtime": "^0.13.11",
     "rimraf": "^5.0.0",
     "sass": "^1.62.1",
-    "shinkansen-cogs": "1.5.63",
-    "shinkansen-rails": "1.0.32",
-    "shinkansen-signals": "1.1.15",
-    "shinkansen-sprockets": "1.0.61",
+    "shinkansen-cogs": "1.5.65",
+    "shinkansen-rails": "1.0.34",
+    "shinkansen-signals": "1.1.17",
+    "shinkansen-sprockets": "1.0.63",
     "vinyl-paths": "^5.0.0"
   },
   "imports": {

package/src/components/common/index.mjs

@@ -4,4 +4,4 @@ const log = debug('shinkansen-pinion/components/common')
 
 log('`shinkansen` is awake')
 
-export * as textContent from './text-content/index.cjs'
+export * as TextContent from './text-content/index.cjs'

package/src/components/common/text-content/index.jsx

@@ -1,6 +1,16 @@
+/**
+ * TextContent component
+ *
+ * @typedef {import('shinkansen-pinion/components/common/text-content').TextContentProps} TextContentProps
+ */
+
 import React from 'react'
 import PropTypes from 'prop-types'
 
+/**
+ * @param {TextContentProps}
+ * @returns {React.JSX.Element}
+ */
 const TextContent = ({ textContent }) => (
   <span className='text-content'>
     {textContent}

package/src/pinion/index.jsx

@@ -1,3 +1,13 @@
+/**
+ * Pinion component
+ *
+ * @typedef {import('shinkansen-pinion/pinion').PinionType} PinionType
+ * @typedef {import('shinkansen-pinion/pinion').ParamsType} ParamsType
+ * @typedef {import('shinkansen-pinion/pinion').GroupProps} GroupProps
+ * @typedef {import('shinkansen-pinion/pinion').FieldProps} FieldProps
+ * @typedef {import('shinkansen-pinion/pinion').PinionProps} PinionProps
+ */
+
 import React from 'react'
 import PropTypes from 'prop-types'
 import debug from 'debug'
@@ -33,7 +43,13 @@ const getKey = (value, index) => `${value}-${index}`
 const getDefaultValue = (field) => Reflect.has(field, 'defaultValue') ? Reflect.get(field, 'defaultValue') : ''
 const getValue = (field) => Reflect.has(field, 'value') ? Reflect.get(field, 'value') : getDefaultValue(field)
 
-/* eslint-disable-next-line react/prop-types */
+/**
+ * @param {PinionTypes.MetaType}
+ * @param {PinionTypes.ElementsEnumType}
+ * @param {ParamsType}
+ * @param {PinionTypes.OnChangeType} onChange
+ * @returns {React.JSX.Element}
+ */
 export function renderToRadiosForEnum ({ items = [], selectedItems = [], uri }, { title, description, enum: { id, name = id, isRequired = false } }, { components, errors }, onChange) {
   log('renderToRadiosForEnum')
 
@@ -62,7 +78,13 @@ export function renderToRadiosForEnum ({ items = [], selectedItems = [], uri },
   )
 }
 
-/* eslint-disable-next-line react/prop-types */
+/**
+ * @param {PinionTypes.MetaType}
+ * @param {PinionTypes.ElementsAnyOfType}
+ * @param {ParamsType}
+ * @param {PinionTypes.OnChangeType} onChange
+ * @returns {React.JSX.Element}
+ */
 export function renderToRadiosForAnyOf ({ items = [], selectedItems = [], uri }, { title, description, anyOf: { id, name = id, isRequired = false } }, { components, errors }, onChange) {
   log('renderToRadiosForAnyOf')
 
@@ -88,7 +110,13 @@ export function renderToRadiosForAnyOf ({ items = [], selectedItems = [], uri },
   )
 }
 
-/* eslint-disable-next-line react/prop-types */
+/**
+ * @param {PinionTypes.MetaType}
+ * @param {PinionTypes.ElementsOneOfType}
+ * @param {ParamsType}
+ * @param {PinionTypes.OnChangeType} onChange
+ * @returns {React.JSX.Element}
+ */
 export function renderToRadiosForOneOf ({ items = [], selectedItems = [], uri }, { title, description, oneOf: { id, name = id, isRequired = false } }, { components, errors }, onChange) {
   log('renderToRadiosForOneOf')
 
@@ -114,7 +142,13 @@ export function renderToRadiosForOneOf ({ items = [], selectedItems = [], uri },
   )
 }
 
-/* eslint-disable-next-line react/prop-types */
+/**
+ * @param {PinionTypes.MetaType}
+ * @param {PinionTypes.ElementsEnumType}
+ * @param {ParamsType}
+ * @param {PinionTypes.OnChangeType} onChange
+ * @returns {React.JSX.Element}
+ */
 export function renderToSelectForEnum ({ items = [], selectedItems = [], uri }, { title, description, enum: { id, name = id, isRequired = false } }, { components, errors }, onChange) {
   log('renderToSelectForEnum')
 
@@ -138,7 +172,13 @@ export function renderToSelectForEnum ({ items = [], selectedItems = [], uri },
   )
 }
 
-/* eslint-disable-next-line react/prop-types */
+/**
+ * @param {PinionTypes.MetaType}
+ * @param {PinionTypes.ElementsAnyOfType}
+ * @param {ParamsType}
+ * @param {PinionTypes.OnChangeType} onChange
+ * @returns {React.JSX.Element}
+ */
 export function renderToSelectForAnyOf ({ items = [], selectedItems = [], uri }, { title, description, anyOf: { id, name = id, isRequired = false } }, { components, errors }, onChange) {
   log('renderToSelectForAnyOf')
 
@@ -162,7 +202,13 @@ export function renderToSelectForAnyOf ({ items = [], selectedItems = [], uri },
   )
 }
 
-/* eslint-disable-next-line react/prop-types */
+/**
+ * @param {PinionTypes.MetaType}
+ * @param {PinionTypes.ElementsOneOfType}
+ * @param {ParamsType}
+ * @param {PinionTypes.OnChangeType} onChange
+ * @returns {React.JSX.Element}
+ */
 export function renderToSelectForOneOf ({ items = [], selectedItems = [], uri }, { title, description, oneOf: { id, name = id, isRequired = false } }, { components, errors }, onChange) {
   log('renderToSelectForOneOf')
 
@@ -186,6 +232,13 @@ export function renderToSelectForOneOf ({ items = [], selectedItems = [], uri },
   )
 }
 
+/**
+ * @param {PinionTypes.MetaType} meta
+ * @param {PinionTypes.ElementsFieldType} elements
+ * @param {ParamsType} params
+ * @param {PinionTypes.OnChangeType} onChange
+ * @returns {React.JSX.Element}
+ */
 export function renderToField (meta, elements, params, onChange) {
   log('renderToField')
 
@@ -220,14 +273,18 @@ export function renderToField (meta, elements, params, onChange) {
   )
 }
 
-export function GroupComponent ({ component, meta, elements, params, onChange }) {
+export function ComponentGroup ({ component, meta, elements, params, onChange }) {
 
 }
 
-export function FieldComponent ({ component, meta, elements, params, onChange }) {
+export function ComponentField ({ component, meta, elements, params, onChange }) {
 
 }
 
+/**
+ * @param {GroupProps}
+ * @returns {React.JSX.Element}
+ */
 export function Group ({ meta, elements, params, onChange }) {
   log('Group')
 
@@ -281,6 +338,10 @@ Group.defaultProps = {
   onChange
 }
 
+/**
+ * @param {FieldProps}
+ * @returns {React.JSX.Element}
+ */
 export function Field ({ meta, elements, params, onChange }) {
   log('Field')
 
@@ -318,6 +379,12 @@ Field.defaultProps = {
   onChange
 }
 
+/**
+ * @param {PinionTypes.PinionType}
+ * @param {ParamsType} params
+ * @param {PinionTypes.OnChangeType} onChange
+ * @returns {React.JSX.Element}
+ */
 export function renderGroup ({ meta, elements }, params, onChange) { // eslint-disable-line
   log('renderGroup')
 
@@ -325,7 +392,7 @@ export function renderGroup ({ meta, elements }, params, onChange) { // eslint-d
     const component = getComponent(meta)
 
     return (
-      <GroupComponent
+      <ComponentGroup
         component={component}
         meta={meta}
         elements={elements}
@@ -345,6 +412,12 @@ export function renderGroup ({ meta, elements }, params, onChange) { // eslint-d
   )
 }
 
+/**
+ * @param {PinionType}
+ * @param {ParamsType} params
+ * @param {PinionTypes.OnChangeType} onChange
+ * @returns {React.JSX.Element}
+ */
 export function renderField ({ meta, elements }, params, onChange) { // eslint-disable-line
   log('renderField')
 
@@ -352,7 +425,7 @@ export function renderField ({ meta, elements }, params, onChange) { // eslint-d
     const component = getComponent(meta)
 
     return (
-      <FieldComponent
+      <ComponentField
         component={component}
         meta={meta}
         elements={elements}
@@ -372,6 +445,10 @@ export function renderField ({ meta, elements }, params, onChange) { // eslint-d
   )
 }
 
+/**
+ * @param {PinionProps}
+ * @returns {React.JSX.Element}
+ */
 export default function Pinion ({ pinion, params, onChange }) {
   log('Pinion')