shinkansen-sprockets 1.1.463 → 1.2.0

package/src/transformers/check-answers/index.d.mts

@@ -1,3 +1,11 @@
 declare module '#sprockets/transformers/check-answers' {
   export default function transform (answer: SprocketsTypes.AnswerDefinitionType): SprocketsTypes.FieldChangeType
 }
+
+declare module 'shinkansen-sprockets/transformers/check-answers' {
+  export type AnswerDefinitionType = SprocketsTypes.AnswerDefinitionType
+
+  export type FieldChangeType = SprocketsTypes.FieldChangeType
+
+  export { default } from '#sprockets/transformers/check-answers'
+}

package/src/transformers/check-answers/index.mjs

@@ -5,8 +5,8 @@ const log = debug('shinkansen-sprockets/transformers/check-answers')
 log('`shinkansen` is awake')
 
 /**
- * @param {SprocketsTypes.AnswerDefinitionType}
- * @returns {FieldChangeType}
+ *  @param {SprocketsTypes.AnswerDefinitionType}
+ *  @returns {FieldChangeType}
  */
 export default function transform ({ changeAnswer: { text, href } }) {
   log('transform')

package/src/transformers/common/index.mjs

@@ -8,10 +8,10 @@ const log = debug('shinkansen-sprockets/transformers/common')
 log('`shinkansen` is awake')
 
 /**
- * @param {string} href
- * @param {string} text
- * @param {number} index
- * @returns {string}
+ *  @param {string} href
+ *  @param {string} text
+ *  @param {number} index
+ *  @returns {string}
  */
 export function getKey (href, text, index) {
   return (

package/src/transformers/error-message/index.d.mts

@@ -1,3 +1,11 @@
 declare module '#sprockets/transformers/error-message' {
   export default function transform (error: SprocketsTypes.ErrorDefinitionType): SprocketsTypes.FieldErrorType
 }
+
+declare module 'shinkansen-sprockets/transformers/error-message' {
+  export type ErrorDefinitionType = SprocketsTypes.ErrorDefinitionType
+
+  export type FieldErrorType = SprocketsTypes.FieldErrorType
+
+  export { default } from '#sprockets/transformers/error-message'
+}

package/src/transformers/error-message/index.mjs

@@ -142,6 +142,10 @@ export function getErrorTextForUnknown () {
   return 'Unknown'
 }
 
+/**
+ *  @param {{ expectedType?: string }} params
+ *  @returns {string}
+ */
 export function getErrorTextForTypeInvalid ({ expectedType } = {}) {
   log('getErrorTextForTypeInvalid')
 
@@ -163,6 +167,10 @@ export function getErrorTextForTypeInvalid ({ expectedType } = {}) {
   }
 }
 
+/**
+ *  @param {{ type?: string, params?: Record<PropertyKey, unknown> }} params
+ *  @returns {string}
+ */
 export function getErrorTextByType ({ type, params } = {}) {
   log('getErrorTextByType')
 
@@ -221,8 +229,8 @@ export function getErrorTextByType ({ type, params } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {string}
+ *  @param {{ uri?: string }} [params]
+ *  @returns {string}
  */
 export function getErrorHref ({ uri = '' } = {}) {
   log('getErrorHref')
@@ -231,8 +239,8 @@ export function getErrorHref ({ uri = '' } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {SprocketsTypes.FieldErrorType}
+ *  @param {SprocketsTypes.ErrorDefinitionType} error
+ *  @returns {SprocketsTypes.FieldErrorType}
  */
 export default function transform (error) { // , components) {
   log('transform')

package/src/transformers/error-summary/index.d.mts

@@ -1,3 +1,11 @@
 declare module '#sprockets/transformers/error-summary' {
   export default function transform (error: SprocketsTypes.ErrorDefinitionType): SprocketsTypes.FieldErrorType
 }
+
+declare module 'shinkansen-sprockets/transformers/error-summary' {
+  export type ErrorDefinitionType = SprocketsTypes.ErrorDefinitionType
+
+  export type FieldErrorType = SprocketsTypes.FieldErrorType
+
+  export { default } from '#sprockets/transformers/error-summary'
+}

package/src/transformers/error-summary/index.mjs

@@ -142,6 +142,10 @@ export function getErrorTextForUnknown () {
   return 'Unknown'
 }
 
+/**
+ *  @param {{ expectedType?: string }} params
+ *  @returns {string}
+ */
 export function getErrorTextForTypeInvalid ({ expectedType } = {}) {
   log('getErrorTextForTypeInvalid')
 
@@ -164,8 +168,8 @@ export function getErrorTextForTypeInvalid ({ expectedType } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {string}
+ *  @param {{ type?: string, params?: Record<PropertyKey, unknown> }} params
+ *  @returns {string}
  */
 export function getErrorTextByType ({ type, params } = {}) {
   log('getErrorTextByType')
@@ -225,8 +229,8 @@ export function getErrorTextByType ({ type, params } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {string}
+ *  @param {{ uri?: string }} [params]
+ *  @returns {string}
  */
 export function getErrorHref ({ uri = '' } = {}) {
   log('getErrorHref')
@@ -235,8 +239,8 @@ export function getErrorHref ({ uri = '' } = {}) {
 }
 
 /**
- * @param {SprocketsTypes.ErrorDefinitionType}
- * @returns {SprocketsTypes.FieldErrorType}
+ *  @param {SprocketsTypes.ErrorDefinitionType} error
+ *  @returns {SprocketsTypes.FieldErrorType}
  */
 export default function transform (error) { // , components) {
   log('transform')