/** * Representing a URL-safe, Base64 encoded string. * * For a non-URL-safe alternative, @see Base64 * * This module is heavily inspired by the `validator.js` module * [`isBase64`](https://github.com/validatorjs/validator.js/blob/master/src/lib/isBase64.js). * * @since 0.0.2 */ 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 Str from 'fp-ts/string' import * as TD from 'io-ts/TaskDecoder' import * as t from 'io-ts/Type' import { pipe } from 'fp-ts/function' import * as fc from 'fast-check' import * as Arb from '../internal/ArbitraryBase' import { urlifyBase64 } from '../internal/util' /** * @since 0.0.2 * @internal */ interface Base64UrlBrand { readonly Base64Url: unique symbol } /** * Representing a URL-safe, Base64 encoded string. * * For a non-URL-safe alternative, @see Base64 * * Heavily inspired by the `validator.js` module * [`isBase64`](https://github.com/validatorjs/validator.js/blob/master/src/lib/isBase64.js). * * @since 0.0.2 * @category Model */ export type Base64Url = string & Base64UrlBrand /** * @since 0.0.2 * @category Model */ export type SchemableParams = HKT2 /** * @since 0.0.2 * @category Model */ export type SchemableParams1 = Kind /** * @since 0.0.3 * @category Model */ export type SchemableParams2 = Kind2 /** * @since 0.0.2 * @category Model */ export type SchemableParams2C = Kind2 /** * @since 0.0.2 * @internal */ const urlSafeBase64 = /^[A-Z0-9_-]*$/i /** * @since 0.0.2 * @category Refinements */ export const isBase64Url = (s: string): s is Base64Url => urlSafeBase64.test(s) /** * @since 0.0.2 * @category Instances */ export const Decoder: SchemableParams2C = pipe( D.string, D.refine(isBase64Url, 'Base64Url') ) /** * @since 0.0.2 * @category Instances */ export const Eq: SchemableParams1 = Str.Eq /** * @since 0.0.2 * @category Instances */ export const Guard: SchemableParams1 = pipe(G.string, G.refine(isBase64Url)) /** * @since 0.0.2 * @category Instances */ export const TaskDecoder: SchemableParams2C = pipe( TD.string, TD.refine(isBase64Url, 'Base64Url') ) /** * @since 0.0.2 * @category Instances */ export const Type: SchemableParams1 = pipe( t.string, t.refine(isBase64Url, 'Base64Url') ) /** * @since 0.0.3 * @category Instances */ export const Encoder: SchemableParams2 = Enc.id() /** * @since 0.0.3 * @category Instances */ export const Arbitrary: SchemableParams1 = fc .base64String() .map(urlifyBase64) as Arb.Arbitrary