shinkansen-gears 1.0.57 → 1.0.60

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-gears",
-  "version": "1.0.57",
+  "version": "1.0.60",
   "description": "Shinkansen Gears",
   "keywords": [
     "Shinkansen",
@@ -13,7 +13,6 @@
   ],
   "main": "./src/index.cjs",
   "type": "module",
-  "types": "/src/index.d.mts",
   "author": "Jonathan Perry for Modern Poacher Limited <modernpoacher@modernpoacher.com>",
   "license": "MIT",
   "engines": {
@@ -32,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 --ext .mts",
+    "lint": "cross-env NODE_ENV=production 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",
@@ -54,16 +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.2",
-    "@typescript-eslint/parser": "^5.59.2",
+    "@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",
@@ -104,10 +103,12 @@
     "regenerator-runtime": "^0.13.11",
     "rimraf": "^5.0.0",
     "sass": "^1.62.1",
-    "shinkansen-rails": "^1.0.32",
+    "shinkansen-rails": "1.0.34",
     "vinyl-paths": "^5.0.0"
   },
   "imports": {
+    "#gears-reverse": "./src/gears/reverse/index.cjs",
+    "#gears": "./src/gears/index.cjs",
     "#build/gulp/build/*": "./build/gulp/build/*.mjs",
     "#build/gulp/build": "./build/gulp/build/index.mjs",
     "#build/gulp/transform": "./build/gulp/transform/index.mjs",

package/src/gears/forward/index.jsx

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import('shinkansen-gears/gears/forward').ForwardProps} ForwardProps
+ */
+
 import React from 'react'
 import PropTypes from 'prop-types'
 
@@ -5,6 +9,10 @@ import {
   Link
 } from 'react-router-dom'
 
+/**
+ * @param {ForwardProps}
+ * @returns {React.JSX.Element}
+ */
 function Forward ({ pathname }) {
   const key = pathname.concat('-forward')
   const to = {

package/src/gears/index.jsx

@@ -1,3 +1,8 @@
+/**
+ * @typedef {import('shinkansen-gears/gears').GearsProps} GearsProps
+ * @typedef {import('shinkansen-gears/gears').GearsState} GearsState
+ */
+
 import React, { Component } from 'react'
 import PropTypes from 'prop-types'
 import Immutable from 'immutable'
@@ -10,8 +15,7 @@ import Reverse from './reverse/index.jsx'
 import Forward from './forward/index.jsx'
 
 /**
- *  @param {{} | void} reverse
- *  @param {string | void} pattern
+ * @type {(reverse: {}, pattern: string | void): React.JSX.Element | null}
  */
 export function renderReverse (reverse, pattern) {
   if (Rails.go(reverse, pattern)) {
@@ -28,8 +32,7 @@ export function renderReverse (reverse, pattern) {
 }
 
 /**
- *  @param {{} | void} forward
- *  @param {string | void} pattern
+ * @type {(reverse: {}, pattern: string | void): React.JSX.Element | null}
  */
 export function renderForward (forward, pattern) {
   if (Rails.go(forward, pattern)) {
@@ -46,13 +49,17 @@ export function renderForward (forward, pattern) {
 }
 
 export default class Gears extends Component {
+  /**
+   *  @type {GearsState}
+   */
   state = {} // define state
 
   /**
    *  Convert latest 'props' to an Immutable.Map() and store in 'state'
    *
-   *  @param {{reverse: Immutable.Map<{}, {}>, forward: Immutable.Map<{}, {}>}} props   Latest props
-   *  @param {{reverse: Immutable.Map<{}, {}>, forward: Immutable.Map<{}, {}>}} state   Current state
+   * @param {GearsProps} props   Latest props
+   * @param {GearsState} state   Current state
+   * @returns {GearsState} Derived state
    */
   static getDerivedStateFromProps ({ reverse, forward }, { reverse: R, forward: F }) {
     const r = Immutable.Map(reverse)
@@ -67,8 +74,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
+   * @param {{ pattern: string }} props   Latest props
+   * @param {GearsState} state   Current state
+   * @returns {boolean}
    */
   shouldComponentUpdate ({ pattern }, state) {
     const {

package/src/gears/reverse/index.jsx

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import('shinkansen-gears/gears/reverse').ReverseProps} ReverseProps
+ */
+
 import React from 'react'
 import PropTypes from 'prop-types'
 
@@ -5,6 +9,10 @@ import {
   Link
 } from 'react-router-dom'
 
+/**
+ * @param {ReverseProps}
+ * @returns {React.JSX.Element}
+ */
 function Reverse ({ pathname }) {
   const key = pathname.concat('-reverse')
   const to = {

package/src/index.d.cts

@@ -0,0 +1,43 @@
+declare module 'shinkansen-gears/gears/reverse' {
+  import React from 'react'
+
+  export type ReverseProps = {
+    pathname: string
+  }
+
+  export default function Reverse (props: ReverseProps): React.JSX.Element
+}
+
+declare module 'shinkansen-gears/gears/forward' {
+  import React from 'react'
+
+  export type ForwardProps = {
+    pathname: string
+  }
+
+  export default function Forward (props: ForwardProps): React.JSX.Element
+}
+
+declare module 'shinkansen-gears/gears' {
+  import React from 'react'
+  import Immutable from 'immutable'
+
+  export type GearsProps = {
+    reverse: {},
+    forward: {},
+    pattern: string
+  }
+
+  export type GearsState = {
+    reverse?: Immutable.Map<{}, {}>
+    forward?: Immutable.Map<{}, {}>
+  }
+
+  export function renderReverse (reverse: {}, pattern: string | void): React.JSX.Element | null
+  export function renderForward (forward: {}, pattern: string | void): React.JSX.Element | null
+  export default class Gears extends React.Component<GearsProps, GearsState> {}
+}
+
+declare module 'shinkansen-gears' {
+  export { default as Gears } from 'shinkansen-gears/gears'
+}

package/src/index.mjs

@@ -1,5 +1,9 @@
 import debug from 'debug'
 
+/**
+  * @typedef {import('shinkansen-gears').Gears} Gears
+ */
+
 const log = debug('shinkansen-gears')
 
 log('`shinkansen` is awake')

package/jsconfig.json

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

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

@@ -1,9 +0,0 @@
-import React from 'react'
-
-type ForwardProps = {
-  pathname: string
-}
-
-type ForwardComponent = React.Component<ForwardProps>
-
-export default ForwardComponent

package/src/gears/index.d.mts

@@ -1,18 +0,0 @@
-import React from 'react'
-
-import ReverseComponent from './reverse/index.mjs'
-import ForwardComponent from './forward/index.mjs'
-
-type GearsProps = {
-  reverse: {},
-  forward: {},
-  pattern: string
-}
-
-type GearsComponent = React.ComponentClass<GearsProps>
-
-declare const Gears: GearsComponent
-
-export function renderReverse (reverse: {}, pattern: string | void): ReverseComponent | null
-export function renderForward (forward: {}, pattern: string | void): ForwardComponent | null
-export default Gears

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

@@ -1,9 +0,0 @@
-import React from 'react'
-
-type ReverseProps = {
-  pathname: string
-}
-
-type ReverseComponent = React.Component<ReverseProps>
-
-export default ReverseComponent

package/src/index.d.mts

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

package/tsconfig.json

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