zerde 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +25 -13
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ParseOptions as ParseOptions$1 } from "jsonc-parser";
|
|
2
2
|
import { CreateNodeOptions, DocumentOptions, ParseOptions as ParseOptions$2, SchemaOptions, ToJSOptions, ToStringOptions } from "yaml";
|
|
3
|
-
import * as
|
|
3
|
+
import * as neverthrow4 from "neverthrow";
|
|
4
|
+
import * as neverthrow3 from "neverthrow";
|
|
4
5
|
import * as neverthrow0 from "neverthrow";
|
|
5
|
-
import * as neverthrow1 from "neverthrow";
|
|
6
6
|
import { ResultAsync } from "neverthrow";
|
|
7
7
|
import { StandardSchemaV1, StandardSchemaV1 as StandardSchemaV1$1 } from "@standard-schema/spec";
|
|
8
8
|
|
|
@@ -34,7 +34,10 @@ declare class EnhancedError<T = unknown> extends Error {
|
|
|
34
34
|
declare function extractFormatSuffix(format: string): string;
|
|
35
35
|
//#endregion
|
|
36
36
|
//#region src/parse.d.ts
|
|
37
|
-
declare class ParseError extends EnhancedError {
|
|
37
|
+
declare class ParseError extends EnhancedError {
|
|
38
|
+
readonly tag = "ParseError";
|
|
39
|
+
constructor(cause: unknown);
|
|
40
|
+
}
|
|
38
41
|
type ParseOptions = Partial<{
|
|
39
42
|
json: ParseJSONOptions;
|
|
40
43
|
yaml: ParseYAMLOptions;
|
|
@@ -52,7 +55,7 @@ declare const parseIt: (stringifiedContent: string, parseOptions: Partial<{
|
|
|
52
55
|
json: ParseJSONOptions;
|
|
53
56
|
yaml: ParseYAMLOptions;
|
|
54
57
|
format: string;
|
|
55
|
-
}>) =>
|
|
58
|
+
}>) => neverthrow4.Result<unknown, ParseError>;
|
|
56
59
|
//#endregion
|
|
57
60
|
//#region src/schema.d.ts
|
|
58
61
|
interface StringSchema extends StandardSchemaV1$1<string> {
|
|
@@ -62,7 +65,10 @@ interface StringSchema extends StandardSchemaV1$1<string> {
|
|
|
62
65
|
declare function parseString(message?: string): StringSchema;
|
|
63
66
|
//#endregion
|
|
64
67
|
//#region src/stringify.d.ts
|
|
65
|
-
declare class StringifyError extends EnhancedError {
|
|
68
|
+
declare class StringifyError extends EnhancedError {
|
|
69
|
+
readonly tag = "StringifyError";
|
|
70
|
+
constructor(cause: unknown);
|
|
71
|
+
}
|
|
66
72
|
type StringifyOptions = Partial<{
|
|
67
73
|
json: StringifyJSONOptions;
|
|
68
74
|
yaml: StringifyYAMLOptions;
|
|
@@ -76,7 +82,7 @@ declare const stringifyIt: (unknownContent: unknown, formatAndStringifyOptions:
|
|
|
76
82
|
yaml: StringifyYAMLOptions;
|
|
77
83
|
}> & {
|
|
78
84
|
format: string;
|
|
79
|
-
}>) =>
|
|
85
|
+
}>) => neverthrow3.Result<string, StringifyError>;
|
|
80
86
|
//#endregion
|
|
81
87
|
//#region src/typeHelpers.d.ts
|
|
82
88
|
type ObjectKeys<T extends object> = `${Exclude<keyof T, symbol>}`;
|
|
@@ -85,9 +91,15 @@ declare const objectEntries: <Type extends Record<string, unknown>>(value: Type)
|
|
|
85
91
|
type Prettify<T> = { [K in keyof T]: T[K] } & {};
|
|
86
92
|
//#endregion
|
|
87
93
|
//#region src/validate.d.ts
|
|
94
|
+
interface ValidationIssue extends StandardSchemaV1$1.Issue {
|
|
95
|
+
input: unknown;
|
|
96
|
+
}
|
|
97
|
+
type ValidationIssues = ReadonlyArray<ValidationIssue>;
|
|
88
98
|
declare class ValidationError extends EnhancedError {
|
|
89
|
-
readonly
|
|
90
|
-
|
|
99
|
+
readonly tag = "ValidationError";
|
|
100
|
+
readonly originalValue: unknown;
|
|
101
|
+
readonly issues: ValidationIssues;
|
|
102
|
+
constructor(originalValue: unknown, issues: ValidationIssues);
|
|
91
103
|
}
|
|
92
104
|
declare const validateIt: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema) => ResultAsync<StandardSchemaV1$1.InferOutput<Schema>, ValidationError>;
|
|
93
105
|
//#endregion
|
|
@@ -100,18 +112,18 @@ declare class Zerde {
|
|
|
100
112
|
parseOptions: ParseOptions;
|
|
101
113
|
stringifyOptions: StringifyOptions;
|
|
102
114
|
constructor(options?: ZerdeOptions);
|
|
103
|
-
parse: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, parseOptions?: string | ParseOptions) =>
|
|
104
|
-
stringify: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, stringifyOptions?: string | StringifyOptions) =>
|
|
115
|
+
parse: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, parseOptions?: string | ParseOptions) => neverthrow0.ResultAsync<StandardSchemaV1$1.InferOutput<Schema>, ParseError | ValidationError>;
|
|
116
|
+
stringify: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, stringifyOptions?: string | StringifyOptions) => neverthrow0.ResultAsync<string, ValidationError | StringifyError>;
|
|
105
117
|
}
|
|
106
118
|
declare const zerde: Zerde;
|
|
107
119
|
declare const zparse: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, parseOptions?: string | Partial<{
|
|
108
120
|
json: ParseJSONOptions;
|
|
109
121
|
yaml: ParseYAMLOptions;
|
|
110
122
|
format: string;
|
|
111
|
-
}> | undefined) =>
|
|
123
|
+
}> | undefined) => neverthrow0.ResultAsync<StandardSchemaV1$1.InferOutput<Schema>, ParseError | ValidationError>;
|
|
112
124
|
declare const zstringify: <Schema extends StandardSchemaV1$1>(unknownContent: unknown, schema: Schema, stringifyOptions?: string | Partial<{
|
|
113
125
|
json: StringifyJSONOptions;
|
|
114
126
|
yaml: StringifyYAMLOptions;
|
|
115
|
-
}> | undefined) =>
|
|
127
|
+
}> | undefined) => neverthrow0.ResultAsync<string, ValidationError | StringifyError>;
|
|
116
128
|
//#endregion
|
|
117
|
-
export { EnhancedError, ErrorInfo, ParseError, ParseJSONOptions, ParseOptions, ParseYAMLOptions, Prettify, type StandardSchemaV1, StringSchema, StringifyError, StringifyJSONOptions, StringifyOptions, StringifyYAMLOptions, ValidationError, Zerde, ZerdeOptions, defaultParseJSONOptions, defaultParseOptions, defaultStringifyJSONOptions, defaultStringifyOptions, extractFormatSuffix, objectEntries, objectKeys, parseIt, parseJSON, parseString, parseYAML, stringifyIt, stringifyJSON, stringifyYAML, validateIt, zerde, zparse, zstringify };
|
|
129
|
+
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 };
|
package/dist/index.js
CHANGED
|
@@ -1 +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
|
|
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};
|