shinkansen-gears 1.0.48 → 1.0.52

package/jsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "baseUrl": "./",
+    "paths": {
+      "shinkansen-sprockets/*": [
+        "src/*",
+        "stories/*"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-gears",
-  "version": "1.0.48",
+  "version": "1.0.52",
   "description": "Shinkansen Gears",
   "keywords": [
     "Shinkansen",
@@ -31,7 +31,7 @@
     "pregulp": "npm run nvm",
     "gulp": "gulp --color",
     "prelint": "npm run nvm",
-    "lint": "cross-env NODE_ENV=production eslint . .storybook --ext .mjs --ext .cjs --ext .jsx",
+    "lint": "cross-env NODE_ENV=production eslint . .storybook --ext .mjs --ext .cjs --ext .jsx --ext .mts",
     "lint:fix": "npm run lint -- --fix",
     "pretest": "npm run nvm",
     "test": "cross-env NODE_ENV=test jest --collect-coverage false --verbose --run-in-band",
@@ -60,6 +60,9 @@
     "@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.2",
+    "@typescript-eslint/parser": "^5.59.2",
     "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",

package/src/gears/forward/index.d.mts

@@ -0,0 +1,9 @@
+import React from 'react'
+
+interface ForwardProps {
+  pathname: string
+}
+
+declare const Forward: (props: ForwardProps) => React.JSX.Element
+
+export default Forward

package/src/gears/index.d.mts

@@ -0,0 +1,13 @@
+import React from 'react'
+
+interface GearsProps {
+  reverse: {},
+  forward: {},
+  pattern: string
+}
+
+declare const Gears: (props: GearsProps) => React.JSX.Element
+
+export function renderReverse (reverse: {}, pattern: string | void): React.JSX.Element | null
+export function renderForward (forward: {}, pattern: string | void): React.JSX.Element | null
+export default Gears

package/src/gears/index.jsx

@@ -9,6 +9,10 @@ import {
 import Reverse from './reverse/index.jsx'
 import Forward from './forward/index.jsx'
 
+/**
+ *  @param {{} | void} reverse
+ *  @param {string | void} pattern
+ */
 export function renderReverse (reverse, pattern) {
   if (Rails.go(reverse, pattern)) {
     const pathname = Rails.to(reverse, pattern)
@@ -23,6 +27,10 @@ export function renderReverse (reverse, pattern) {
   return null
 }
 
+/**
+ *  @param {{} | void} forward
+ *  @param {string | void} pattern
+ */
 export function renderForward (forward, pattern) {
   if (Rails.go(forward, pattern)) {
     const pathname = Rails.to(forward, pattern)
@@ -43,10 +51,10 @@ export default class Gears extends Component {
   /**
    *  Convert latest 'props' to an Immutable.Map() and store in 'state'
    *
-   *  @param {Object} props   Latest props
-   *  @param {Object} state   Current state
+   *  @param {{reverse: Immutable.Map<{}, {}>, forward: Immutable.Map<{}, {}>}} props   Latest props
+   *  @param {{reverse: Immutable.Map<{}, {}>, forward: Immutable.Map<{}, {}>}} state   Current state
    */
-  static getDerivedStateFromProps ({ reverse, forward }, { reverse: R, forward: F }) { // console.log('[Gears]getDerivedStateFromProps()')
+  static getDerivedStateFromProps ({ reverse, forward }, { reverse: R, forward: F }) {
     const r = Immutable.Map(reverse)
     const f = Immutable.Map(forward)
 
@@ -60,8 +68,9 @@ export default class Gears extends Component {
    *  Compare latest 'props' and 'state' for changes to 'pattern', 'reverse' or 'forward'
    *
    *  @param {Object} props   Latest props
+   *  @param {Object} state   Current state
    */
-  shouldComponentUpdate ({ pattern }, state) { // console.log('(Gears)shouldComponentUpdate()', { pattern }, state)
+  shouldComponentUpdate ({ pattern }, state) {
     const {
       pattern: PATTERN
     } = this.props
@@ -84,7 +93,7 @@ export default class Gears extends Component {
     )
   }
 
-  render () { // console.log('(Gears)render()')
+  render () {
     const {
       reverse,
       forward,

package/src/gears/reverse/index.d.mts

@@ -0,0 +1,9 @@
+import React from 'react'
+
+interface ReverseProps {
+  pathname: string
+}
+
+declare const Reverse: (props: ReverseProps) => React.JSX.Element
+
+export default Reverse

package/src/index.d.mts

@@ -0,0 +1,5 @@
+import type GearsComponent from './gears/index.mjs'
+
+declare module 'shinkansen-gears' {
+  export const Gears: typeof GearsComponent
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "es2020",
+    "target": "es2020",
+    "moduleResolution": "node",
+    "noEmit": true,
+    "strict": true,
+    "isolatedModules": true,
+    "noImplicitAny": true,
+    "allowSyntheticDefaultImports": true,
+    "jsx": "react",
+    "baseUrl": "./",
+    "paths": {
+      "shinkansen-sprockets/*": [
+        "src/*"
+      ]
+    }
+  },
+  "include": [
+    "src/*"
+  ]
+}