/** * Natural branded newtype string. * * Represents integers: * * ```math * { z | z ∈ ℤ, z >= 0, z <= 2 ** 53 - 1 } * ``` * * @since 0.0.1 */ import { Kind, Kind2, URIS, URIS2, HKT2 } from 'fp-ts/HKT' import * as D from 'io-ts/Decoder' import * as Enc from 'io-ts/Encoder' import * as Eq_ from 'fp-ts/Eq' import * as G from 'io-ts/Guard' import * as Pred from 'fp-ts/Predicate' import * as TD from 'io-ts/TaskDecoder' import * as t from 'io-ts/Type' import * as Str from 'fp-ts/string' import { pipe, unsafeCoerce } from 'fp-ts/function' import * as Arb from '../internal/ArbitraryBase' import * as Nat from '../number/Natural' import { Natural } from '../number/Natural' import { isInt } from '../number/Int' /** * @since 0.0.1 * @internal */ interface NaturalStringBrand { readonly NaturalString: unique symbol } /** * Natural branded newtype. * * Represents integers: * * ```math * { z | z ∈ ℤ, z >= 0, z <= 2 ** 53 - 1 } * ``` * * @since 0.0.1 * @category Model */ export type NaturalString = string & NaturalStringBrand /** * @since 0.0.1 * @category Model */ export type SchemableParams = HKT2 /** * @since 0.0.1 * @category Model */ export type SchemableParams1 = Kind /** * @since 0.0.3 * @category Model */ export type SchemableParams2 = Kind2 /** * @since 0.0.1 * @category Model */ export type SchemableParams2C = Kind2 /** * @since 0.0.1 * @category Refinements */ export const isNaturalString = (n: string): n is NaturalString => pipe( n, Number, Pred.and(isInt)(n => n >= 0) ) /** * @since 0.0.1 * @category Instances */ export const Decoder: SchemableParams2C = pipe( D.string, D.refine(isNaturalString, 'Natural') ) /** * @since 0.0.1 * @category Instances */ export const Eq: SchemableParams1 = Str.Eq /** * @since 0.0.1 * @category Instances */ export const Guard: SchemableParams1 = pipe(G.string, G.refine(isNaturalString)) /** * @since 0.0.1 * @category Instances */ export const TaskDecoder: SchemableParams2C = pipe( TD.string, TD.refine(isNaturalString, 'Natural') ) /** * @since 0.0.1 * @category Instances */ export const Type: SchemableParams1 = pipe( t.string, t.refine(isNaturalString, 'Natural') ) /** * @since 0.0.3 * @category Instances */ export const Encoder: SchemableParams2 = Enc.id() /** * @since 0.0.3 * @category Instances */ export const Arbitrary: SchemableParams1 = Nat.Arbitrary.map(n => n.toString() ) as Arb.Arbitrary /** * @since 0.0.1 * @category Destructors */ export const toNatural: (n: NaturalString) => Natural = n => unsafeCoerce(parseInt(n))