Custom schema type from docs is not compilable

[m-i-c-h-a-l]

Package version

3.0.1

Describe the bug

I tried to create a custom schema from docs https://vinejs.dev/docs/extend/custom_schema_types, but the class is not compilable, I got error:

Non-abstract class 'VineMoney' does not implement inherited abstract member [SUBTYPE] from class 'BaseLiteralType<string, Money, Money>'.

Reproduction repo

No response

[GustavoSabel]

I found a way that works:

import { dinero, Dinero } from 'dinero.js'
import vine, { BaseLiteralType, symbols } from '@vinejs/vine'
import type { FieldOptions, Validation } from '@vinejs/vine/types'

type Money = Dinero<number>

export class VineMoney extends BaseLiteralType<string, Money, Money> {
  constructor(options?: FieldOptions, validations?: Validation<any>[]) {
    super(options, validations || [isMoney()])
  }

  clone() {
    return new VineMoney(
      this.cloneOptions(),
      this.cloneValidations()
    ) as this
  }

  // you need do add this line
  [symbols.SUBTYPE] = 'money'
}

but I'm not sure if it's the correct approach.

[flozdra]

Since the 4.0.0 update (refactoring the bail mode), we also need to check field.isDefined in the validation rule to allow schema to be .optional() :

const isMoneyRule = vine.createRule(function isMoney(value: unknown, _, field: FieldContext) => {
  if (!field.isDefined) {
    return false
  }

  // ...
})

However, the rule will fail if the field is missing.

[thetutlage]

@flozdra

we also need to check field.isDefined in the validation rule to allow schema to be .optional()

Nope. If the field is not defined or if it misses the data-type validation, then the additional rules won't be called even when bail mode is disabled.

However, if you are create a dataType rule (which is in this case), then yes, you will have to check for isDefined. The string rule implementation can be used as a reference.

https://github.com/vinejs/vine/blob/4.x/src/schema/string/rules.ts#L36-L47