zerde 0.1.5 → 0.1.7

package/dist/index.d.ts

@@ -1,8 +1,9 @@
+import { ErrorLike, isErrorLike, serializeError } from "serialize-error";
 import { ParseOptions as ParseOptions$1 } from "jsonc-parser";
 import { CreateNodeOptions, DocumentOptions, ParseOptions as ParseOptions$2, SchemaOptions, ToJSOptions, ToStringOptions } from "yaml";
-import * as neverthrow4 from "neverthrow";
-import * as neverthrow3 from "neverthrow";
+import * as neverthrow0$1 from "neverthrow";
 import * as neverthrow0 from "neverthrow";
+import * as neverthrow1 from "neverthrow";
 import { ResultAsync } from "neverthrow";
 import { StandardSchemaV1, StandardSchemaV1 as StandardSchemaV1$1 } from "@standard-schema/spec";
 
@@ -24,6 +25,21 @@ declare function parseYAML(stringifiedContent: string, parseOptions?: ParseYAMLO
 type StringifyYAMLOptions = CreateNodeOptions & DocumentOptions & ParseOptions$2 & SchemaOptions & ToStringOptions;
 declare function stringifyYAML(unknownContent: unknown, stringifyOptions?: StringifyYAMLOptions): string;
 //#endregion
+//#region src/hashing.d.ts
+declare const _HASH_: unique symbol;
+type Base10Hash = number & {
+  readonly [_HASH_]: 10;
+};
+type Base16Hash = string & {
+  readonly [_HASH_]: 16;
+};
+type Base36Hash = string & {
+  readonly [_HASH_]: 36;
+};
+declare function hashBase10(unknownContent: unknown): Base10Hash;
+declare function hashBase16(unknownContent: unknown): Base16Hash;
+declare function hashBase36(unknownContent: unknown): Base36Hash;
+//#endregion
 //#region src/utils.d.ts
 type ErrorInfo<T> = T & {
   cause: unknown;
@@ -55,7 +71,7 @@ declare const parseIt: (stringifiedContent: string, parseOptions: Partial<{
   json: ParseJSONOptions;
   yaml: ParseYAMLOptions;
   format: string;
-}>) => neverthrow4.Result<unknown, ParseError>;
+}>) => neverthrow0$1.Result<unknown, ParseError>;
 //#endregion
 //#region src/schema.d.ts
 interface StringSchema extends StandardSchemaV1$1<string> {
@@ -82,7 +98,7 @@ declare const stringifyIt: (unknownContent: unknown, formatAndStringifyOptions:
   yaml: StringifyYAMLOptions;
 }> & {
   format: string;
-}>) => neverthrow3.Result<string, StringifyError>;
+}>) => neverthrow0.Result<string, StringifyError>;
 //#endregion
 //#region src/typeHelpers.d.ts
 type ObjectKeys<T extends object> = `${Exclude<keyof T, symbol>}`;
@@ -112,18 +128,18 @@ declare class Zerde {
   parseOptions: ParseOptions;
   stringifyOptions: StringifyOptions;
   constructor(options?: ZerdeOptions);
-  parse: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, parseOptions?: string | ParseOptions) => neverthrow0.ResultAsync<StandardSchemaV1$1.InferOutput<Schema>, ParseError | ValidationError>;
-  stringify: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, stringifyOptions?: string | StringifyOptions) => neverthrow0.ResultAsync<string, ValidationError | StringifyError>;
+  parse: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, parseOptions?: string | ParseOptions) => neverthrow1.ResultAsync<StandardSchemaV1$1.InferOutput<Schema>, ParseError | ValidationError>;
+  stringify: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, stringifyOptions?: string | StringifyOptions) => neverthrow1.ResultAsync<string, ValidationError | StringifyError>;
 }
 declare const zerde: Zerde;
 declare const zparse: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, parseOptions?: string | Partial<{
   json: ParseJSONOptions;
   yaml: ParseYAMLOptions;
   format: string;
-}> | undefined) => neverthrow0.ResultAsync<StandardSchemaV1$1.InferOutput<Schema>, ParseError | ValidationError>;
+}> | undefined) => neverthrow1.ResultAsync<StandardSchemaV1$1.InferOutput<Schema>, ParseError | ValidationError>;
 declare const zstringify: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, stringifyOptions?: string | Partial<{
   json: StringifyJSONOptions;
   yaml: StringifyYAMLOptions;
-}> | undefined) => neverthrow0.ResultAsync<string, ValidationError | StringifyError>;
+}> | undefined) => neverthrow1.ResultAsync<string, ValidationError | StringifyError>;
 //#endregion
-export { EnhancedError, ErrorInfo, ParseError, ParseJSONOptions, ParseOptions, ParseYAMLOptions, Prettify, type StandardSchemaV1, StringSchema, StringifyError, StringifyJSONOptions, StringifyOptions, StringifyYAMLOptions, ValidationError, ValidationIssue, ValidationIssues, Zerde, ZerdeOptions, defaultParseJSONOptions, defaultParseOptions, defaultStringifyJSONOptions, defaultStringifyOptions, extractFormatSuffix, objectEntries, objectKeys, parseIt, parseJSON, parseString, parseYAML, stringifyIt, stringifyJSON, stringifyYAML, validateIt, zerde, zparse, zstringify };
+export { Base10Hash, Base16Hash, Base36Hash, EnhancedError, ErrorInfo, type ErrorLike, ParseError, ParseJSONOptions, ParseOptions, ParseYAMLOptions, Prettify, type StandardSchemaV1, StringSchema, StringifyError, StringifyJSONOptions, StringifyOptions, StringifyYAMLOptions, ValidationError, ValidationIssue, ValidationIssues, Zerde, ZerdeOptions, defaultParseJSONOptions, defaultParseOptions, defaultStringifyJSONOptions, defaultStringifyOptions, extractFormatSuffix, hashBase10, hashBase16, hashBase36, isErrorLike, objectEntries, objectKeys, parseIt, parseJSON, parseString, parseYAML, serializeError, stringifyIt, stringifyJSON, stringifyYAML, validateIt, zerde, zparse, zstringify };

package/dist/index.js

@@ -1 +1 @@
-import{parse as e}from"jsonc-parser";import{configure as t}from"safe-stable-stringify";import{parse as n,stringify as r}from"yaml";import{ResultAsync as i,fromThrowable as a}from"neverthrow";const o={allowEmptyContent:!1,allowTrailingComma:!1,disallowComments:!0};function s(t,n){let r={...o,...n},i=[],a=e(t,i,r);if(i.length>0)throw SyntaxError(`Could not parse JSON`,{cause:i});return a}const c=0,l=t({bigint:!1,circularValue:TypeError,deterministic:!0,strict:!0});function u(e,t){let n=l(e,null,t);if(n===void 0)throw SyntaxError(`safe-stable-stringify should have thrown an error if trying to stringify an invalid json object`);return n}function d(e,t){return n(e,t)}function f(e,t){return r(e,{sortMapEntries:!0,...t})}const p=Object.keys,m=Object.entries;var h=class extends Error{constructor(e,t){super(e,{cause:t.cause}),this.name=this.constructor.name}};const g=[`.`,`/`,`\\`,`+`];function _(e){let t=e.trim().toLowerCase();if(!t)return t;let n=t.indexOf(`;`);n>0&&(t=t.slice(0,n));let r=Math.max(...g.map(e=>t.lastIndexOf(e)));return r<0?t:t.slice(r+1)}if(import.meta.vitest){let{describe:e,it:t,expect:n}=import.meta.vitest,r={lowercase:`json`,uppercase:`JSON`,mixedcase:`jSoN`,extension:`.json`,file:`file.json`,"file with path":`some/path/to/file.json`,"file with a windows path":`some\\path\\to\\file.json`,"basic media type":`application/json`,"complex media type":`application/customFormat+json`,"media type with charset":`application/customFormat+json; charset=utf-8`};e(`extractFormatSuffix`,()=>{for(let[e,i]of m(r)){let r=`Can handle ${e}: ${i}`;t(r,()=>{n(_(i)).toEqual(`json`)})}})}var v=class extends h{tag=`ParseError`;constructor(e){super(`Could not parse content`,{cause:e}),this.name=`ParseError`}};const y={json:o,yaml:{}},b=a((e,t)=>{let{format:n,...r}=t,i=p(r).sort().at(0)??``,a=_(n??i);return a===`yaml`||a===`yml`?d(e,r.yaml):a===`json`?s(e,r.json):e},e=>new v(e));function x(e=`Invalid type`){return{type:`string`,message:e,"~standard":{version:1,vendor:`StandardSchema`,validate(t){return typeof t==`string`?{value:t}:{issues:[{message:e}]}}}}}var S=class extends h{tag=`StringifyError`;constructor(e){super(`Could not stringify content`,{cause:e}),this.name=`StringifyError`}};const C={json:c,yaml:{}},w=a((e,t)=>{if(typeof e==`string`)return e;let{format:n,...r}=t,i=_(n??``);return i===`yaml`||i===`yml`?f(e,r.yaml):u(e,r.json)},e=>new S(e));var T=class extends h{tag=`ValidationError`;originalValue;issues;constructor(e,t){super(`Content was not valid`,{cause:void 0}),this.originalValue=e,this.issues=t,this.name=`ValidationError`}};const E=i.fromThrowable(async(e,t)=>{let n=await t[`~standard`].validate(e);if(n.issues){let t=n.issues.map(t=>({...t,input:D(e,t)}));throw new T(e,t)}return n.value},e=>e);function D(e,t){let n=e;for(let e of t.path??[])n=n[e];return n}if(import.meta.vitest){let{describe:e,it:t,expect:n}=import.meta.vitest,r=[[`simpleObject`,[`hello`],{hello:`world`},`world`],[`nestedObject`,[`deeply`,`nested`,`object`],{deeply:{nested:{object:`someValue`}}},`someValue`],[`array`,[1],[`zero`,`one`],`one`],[`noPath`,void 0,{hello:`world`},{hello:`world`}]];e(`extractOriginalInput`,()=>{for(let[e,i,a,o]of r){let r={message:`something went wrong`,path:i};t(`Can handle ${e}`,()=>{n(D(a,r)).toEqual(o)})}})}var O=class{parseOptions;stringifyOptions;constructor(e={}){this.parseOptions={...y,...e.parse},this.stringifyOptions={...C,...e.stringify}}parse=(e,t,n)=>{if(typeof e==`string`){let r=typeof n==`string`?{format:n}:n,i={...this.parseOptions,...r};return b(e,i).asyncAndThen(e=>E(e,t))}return E(e,t)};stringify=(e,t,n)=>{let r=typeof n==`string`?{format:n}:n,i={...this.stringifyOptions,...r};return E(e,t).andThen(e=>w(e,i))}};const k=new O,A=k.parse,j=k.stringify;export{h as EnhancedError,v as ParseError,S as StringifyError,T as ValidationError,O as Zerde,o as defaultParseJSONOptions,y as defaultParseOptions,c as defaultStringifyJSONOptions,C as defaultStringifyOptions,_ as extractFormatSuffix,m as objectEntries,p as objectKeys,b as parseIt,s as parseJSON,x as parseString,d as parseYAML,w as stringifyIt,u as stringifyJSON,f as stringifyYAML,E as validateIt,k as zerde,A as zparse,j as zstringify};
+import{isErrorLike as e,serializeError as t,serializeError as n}from"serialize-error";import{parse as r}from"jsonc-parser";import{configure as i}from"safe-stable-stringify";import{parse as a,stringify as o}from"yaml";import{ResultAsync as s,fromThrowable as c}from"neverthrow";const l={allowEmptyContent:!1,allowTrailingComma:!1,disallowComments:!0};function u(e,t){try{return JSON.parse(e)}catch{let n={...l,...t},i=[],a=r(e,i,n);if(i.length>0)throw SyntaxError(`Could not parse JSON`,{cause:i});return a}}const d=0,f=i({bigint:!1,circularValue:TypeError,deterministic:!0,strict:!0});function p(e,t){let r=Error.isError(e)?n(e):e,i=f(r,null,t);if(i===void 0)throw SyntaxError(`safe-stable-stringify should have thrown an error if trying to stringify an invalid json object`);return i}function m(e,t){return a(e,t)}function h(e,t){return o(e,{sortMapEntries:!0,...t})}const g=16,_=36;function v(e){let t=p(e),n=t.length,r=2166136261;for(let e=0;e<n;e++)r^=t.charCodeAt(e),r+=(r<<1)+(r<<4)+(r<<7)+(r<<8)+(r<<24);return r>>>0}function y(e){return v(e)}function b(e){return v(e).toString(g)}function x(e){return v(e).toString(_)}const S=Object.keys,C=Object.entries;var w=class extends Error{constructor(e,t){super(e,{cause:t.cause}),this.name=this.constructor.name}};const T=[`.`,`/`,`\\`,`+`];function E(e){let t=e.trim().toLowerCase();if(!t)return t;let n=t.indexOf(`;`);n>0&&(t=t.slice(0,n));let r=Math.max(...T.map(e=>t.lastIndexOf(e)));return r<0?t:t.slice(r+1)}if(import.meta.vitest){let{describe:e,it:t,expect:n}=import.meta.vitest,r={lowercase:`json`,uppercase:`JSON`,mixedcase:`jSoN`,extension:`.json`,file:`file.json`,"file with path":`some/path/to/file.json`,"file with a windows path":`some\\path\\to\\file.json`,"basic media type":`application/json`,"complex media type":`application/customFormat+json`,"media type with charset":`application/customFormat+json; charset=utf-8`};e(`extractFormatSuffix`,()=>{for(let[e,i]of C(r)){let r=`Can handle ${e}: ${i}`;t(r,()=>{n(E(i)).toEqual(`json`)})}})}var D=class extends w{tag=`ParseError`;constructor(e){super(`Could not parse content`,{cause:e}),this.name=`ParseError`}};const O={json:l,yaml:{}},k=c((e,t)=>{let{format:n,...r}=t,i=S(r).sort().at(0)??``,a=E(n??i);return a===`yaml`||a===`yml`?m(e,r.yaml):a===`json`?u(e,r.json):e},e=>new D(e));function A(e=`Invalid type`){return{type:`string`,message:e,"~standard":{version:1,vendor:`StandardSchema`,validate(t){return typeof t==`string`?{value:t}:{issues:[{message:e}]}}}}}var j=class extends w{tag=`StringifyError`;constructor(e){super(`Could not stringify content`,{cause:e}),this.name=`StringifyError`}};const M={json:d,yaml:{}},N=c((e,t)=>{if(typeof e==`string`)return e;let{format:n,...r}=t,i=E(n??``);return i===`yaml`||i===`yml`?h(e,r.yaml):p(e,r.json)},e=>new j(e));var P=class extends w{tag=`ValidationError`;originalValue;issues;constructor(e,t){super(`Content was not valid`,{cause:void 0}),this.originalValue=e,this.issues=t,this.name=`ValidationError`}};const F=s.fromThrowable(async(e,t)=>{let n=await t[`~standard`].validate(e);if(n.issues){let t=n.issues.map(t=>({...t,input:I(e,t)}));throw new P(e,t)}return n.value},e=>e);function I(e,t){let n=e;for(let e of t.path??[])n=n[e];return n}if(import.meta.vitest){let{describe:e,it:t,expect:n}=import.meta.vitest,r=[[`simpleObject`,[`hello`],{hello:`world`},`world`],[`nestedObject`,[`deeply`,`nested`,`object`],{deeply:{nested:{object:`someValue`}}},`someValue`],[`array`,[1],[`zero`,`one`],`one`],[`noPath`,void 0,{hello:`world`},{hello:`world`}]];e(`extractOriginalInput`,()=>{for(let[e,i,a,o]of r){let r={message:`something went wrong`,path:i};t(`Can handle ${e}`,()=>{n(I(a,r)).toEqual(o)})}})}var L=class{parseOptions;stringifyOptions;constructor(e={}){this.parseOptions={...O,...e.parse},this.stringifyOptions={...M,...e.stringify}}parse=(e,t,n)=>{if(typeof e==`string`){let r=typeof n==`string`?{format:n}:n,i={...this.parseOptions,...r};return k(e,i).asyncAndThen(e=>F(e,t))}return F(e,t)};stringify=(e,t,n)=>{let r=typeof n==`string`?{format:n}:n,i={...this.stringifyOptions,...r};return F(e,t).andThen(e=>N(e,i))}};const R=new L,z=R.parse,B=R.stringify;export{w as EnhancedError,D as ParseError,j as StringifyError,P as ValidationError,L as Zerde,l as defaultParseJSONOptions,O as defaultParseOptions,d as defaultStringifyJSONOptions,M as defaultStringifyOptions,E as extractFormatSuffix,y as hashBase10,b as hashBase16,x as hashBase36,e as isErrorLike,C as objectEntries,S as objectKeys,k as parseIt,u as parseJSON,A as parseString,m as parseYAML,t as serializeError,N as stringifyIt,p as stringifyJSON,h as stringifyYAML,F as validateIt,R as zerde,z as zparse,B as zstringify};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "zerde",
-    "version": "0.1.5",
+    "version": "0.1.7",
     "description": "parsing, and stringifying combined with schema validation",
     "keywords": [
         "parse",
@@ -44,10 +44,11 @@
         "test:watch": "vitest"
     },
     "dependencies": {
-        "@standard-schema/spec": "^1.0.0",
+        "@standard-schema/spec": "^1.1.0",
         "jsonc-parser": "^3.3.1",
         "neverthrow": "^8.2.0",
         "safe-stable-stringify": "^2.5.0",
-        "yaml": "^2.8.2"
+        "serialize-error": "^13.0.1",
+        "yaml": "^2.8.3"
     }
 }