@devp0nt/error0 1.0.0-next.50 → 1.0.0-next.51

package/src/plugins/expected.test.ts

@@ -11,7 +11,7 @@ describe('expectedPlugin', () => {
   })
 
   it('can be used to control error tracker behavior', () => {
-    const AppError = Error0.use(statusPlugin).use(expectedPlugin({ hideWhenPublic: false }))
+    const AppError = Error0.use(statusPlugin).use(expectedPlugin({ isPublic: true }))
     const errorExpected = new AppError('test', { status: 400, expected: true })
     const errorUnexpected = new AppError('test', { status: 400, expected: false })
     const usualError = new Error('test')
@@ -30,7 +30,7 @@ describe('expectedPlugin', () => {
   })
 
   it('resolves to false when any cause has false', () => {
-    const AppError = Error0.use(expectedPlugin({ hideWhenPublic: false }))
+    const AppError = Error0.use(expectedPlugin({ isPublic: true }))
     const root = new AppError('root', { expected: true })
     const middle = new AppError('middle', { expected: false, cause: root })
     const leaf = new AppError('leaf', { expected: false, cause: middle })
@@ -39,9 +39,28 @@ describe('expectedPlugin', () => {
   })
 
   it('treats undefined expected as unexpected', () => {
-    const AppError = Error0.use(expectedPlugin({ hideWhenPublic: false }))
+    const AppError = Error0.use(expectedPlugin({ isPublic: true }))
     const error = new AppError('without expected')
     expect(error.expected).toBe(false)
     expect(error.isExpected()).toBe(false)
   })
+
+  it('supports override', () => {
+    const AppError = Error0.use(statusPlugin).use(
+      expectedPlugin({
+        isPublic: true,
+        override: (error) => {
+          return error.message.includes('CRITICAL') ? false : undefined
+        },
+      }),
+    )
+    const errorNonCritical = new AppError('USUAL: test', { status: 400 })
+    const errorNonCriticalExpected = new AppError('USUAL: test', { status: 400, expected: true })
+    const errorCritical = new AppError('CRITICAL: test', { status: 400 })
+    const errorCriticalExpected = new AppError('CRITICAL: test', { status: 400, expected: true })
+    expect(errorNonCritical.expected).toBe(false) // becouse expected was not provided at all
+    expect(errorNonCriticalExpected.expected).toBe(true)
+    expect(errorCritical.expected).toBe(false)
+    expect(errorCriticalExpected.expected).toBe(false)
+  })
 })

package/src/plugins/expected.ts

@@ -1,6 +1,20 @@
 import { Error0 } from '../index.js'
 
-const isExpected = (flow: unknown[]) => {
+const isExpected = ({
+  flow,
+  error,
+  override,
+}: {
+  flow: unknown[]
+  error: Error0
+  override?: (error: any) => boolean | undefined
+}) => {
+  if (override) {
+    const overridden = override(error)
+    if (overridden !== undefined) {
+      return overridden
+    }
+  }
   let expected = false
   for (const value of flow) {
     if (value === false) {
@@ -13,13 +27,16 @@ const isExpected = (flow: unknown[]) => {
   return expected
 }
 
-export const expectedPlugin = ({ hideWhenPublic = true }: { hideWhenPublic?: boolean } = {}) =>
+export const expectedPlugin = <TError extends Error0>({
+  isPublic = false,
+  override,
+}: { isPublic?: boolean; override?: (error: TError) => boolean | undefined } = {}) =>
   Error0.plugin()
     .prop('expected', {
       init: (input: boolean) => input,
-      resolve: ({ flow }) => isExpected(flow),
-      serialize: ({ resolved, isPublic }) => {
-        if (hideWhenPublic && isPublic) {
+      resolve: ({ flow, error }) => isExpected({ flow, error, override }),
+      serialize: ({ resolved, isPublic: _isPublic }) => {
+        if (isPublic && _isPublic) {
           return undefined
         }
         return resolved
@@ -27,5 +44,5 @@ export const expectedPlugin = ({ hideWhenPublic = true }: { hideWhenPublic?: boo
       deserialize: ({ value }) => (typeof value === 'boolean' ? value : undefined),
     })
     .method('isExpected', (error) => {
-      return isExpected(error.flow('expected'))
+      return isExpected({ flow: error.flow('expected'), error, override })
     })

package/src/plugins/meta.ts

@@ -28,7 +28,7 @@ const toJsonSafe = (input: unknown): Json | undefined => {
 const isMetaRecord = (value: unknown): value is Record<string, unknown> =>
   typeof value === 'object' && value !== null && !Array.isArray(value)
 
-export const metaPlugin = ({ hideWhenPublic = true }: { hideWhenPublic?: boolean } = {}) =>
+export const metaPlugin = ({ isPublic = false }: { isPublic?: boolean } = {}) =>
   Error0.plugin().prop('meta', {
     init: (input: Record<string, unknown>) => input,
     resolve: ({ flow }) => {
@@ -44,8 +44,8 @@ export const metaPlugin = ({ hideWhenPublic = true }: { hideWhenPublic?: boolean
       }
       return merged
     },
-    serialize: ({ resolved, isPublic }) => {
-      if (hideWhenPublic && isPublic) {
+    serialize: ({ resolved, isPublic: _isPublic }) => {
+      if (!isPublic && _isPublic) {
         return undefined
       }
       return toJsonSafe(resolved)

package/src/plugins/stack-merge.test.ts

@@ -54,11 +54,4 @@ describe('stackMergePlugin', () => {
     `)
     expect(mergedStack2Public).toBeUndefined()
   })
-
-  it('by default serializes stack of this error only', () => {
-    const AppError = Error0.use(statusPlugin).use(codePlugin).use(stackMergePlugin())
-    const error = new AppError('test', { status: 400, code: 'NOT_FOUND' })
-    const json = AppError.serialize(error, false)
-    expect(json.stack).toBe(error.stack)
-  })
 })

package/src/plugins/stack-merge.ts

@@ -1,12 +1,12 @@
 import { Error0 } from '../index.js'
 
 export const stackMergePlugin = ({
-  hideWhenPublic = true,
+  isPublic = false,
   delimiter = '\n',
-}: { hideWhenPublic?: boolean; delimiter?: string } = {}) =>
+}: { isPublic?: boolean; delimiter?: string } = {}) =>
   Error0.plugin().stack({
-    serialize: ({ error, isPublic }) => {
-      if (hideWhenPublic && isPublic) {
+    serialize: ({ error, isPublic: _isPublic }) => {
+      if (!isPublic && _isPublic) {
         return undefined
       }
       return error

package/src/plugins/status.ts

@@ -1,9 +1,10 @@
 import { Error0 } from '../index.js'
 
 export const statusPlugin = <TStatuses extends Record<string, number> = Record<never, number>>({
+  isPublic = false,
   statuses,
   strict = false,
-}: { statuses?: TStatuses; strict?: boolean } = {}) => {
+}: { isPublic?: boolean; statuses?: TStatuses; strict?: boolean } = {}) => {
   const statusValues = statuses ? Object.values(statuses) : undefined
   const isStatusValue = (value: unknown): value is number =>
     typeof value === 'number' && (!statusValues || !strict || statusValues.includes(value))
@@ -23,7 +24,12 @@ export const statusPlugin = <TStatuses extends Record<string, number> = Record<n
   return Error0.plugin().prop('status', {
     init: (status: number | Extract<keyof TStatuses, string>) => convertStatusValue(status),
     resolve: ({ flow }) => flow.find(Boolean),
-    serialize: ({ resolved }) => resolved,
+    serialize: ({ resolved, isPublic: _isPublic }) => {
+      if (!isPublic && _isPublic) {
+        return undefined
+      }
+      return resolved
+    },
     deserialize: ({ value }) => (typeof value === 'number' ? value : undefined),
   })
 }

package/src/plugins/tags.ts

@@ -1,10 +1,10 @@
 import { Error0 } from '../index.js'
 
 export const tagsPlugin = <TTag extends string>({
-  hideWhenPublic = true,
+  isPublic = false,
   tags,
   strict = true,
-}: { hideWhenPublic?: boolean; tags?: TTag[] | readonly TTag[]; strict?: boolean } = {}) => {
+}: { isPublic?: boolean; tags?: TTag[] | readonly TTag[]; strict?: boolean } = {}) => {
   function hasTag(error: Error0, tag: TTag): boolean
   function hasTag(error: Error0, tag: TTag[], policy: 'every' | 'some'): boolean
   function hasTag(error: Error0, tag: TTag | TTag[], policy?: 'every' | 'some'): boolean {
@@ -34,8 +34,8 @@ export const tagsPlugin = <TTag extends string>({
         }
         return merged.length > 0 ? Array.from(new Set(merged)) : undefined
       },
-      serialize: ({ resolved, isPublic }) => {
-        if (hideWhenPublic && isPublic) {
+      serialize: ({ resolved, isPublic: _isPublic }) => {
+        if (!isPublic && _isPublic) {
           return undefined
         }
         return resolved

package/dist/cjs/plugins/cause-serialize.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/plugins/cause-serialize.ts"],"sourcesContent":["import { Error0 } from '../index.js'\n\nexport const causeSerializePlugin = ({ hideWhenPublic = true }: { hideWhenPublic?: boolean } = {}) =>\n  Error0.plugin().cause({\n    serialize: ({ value, error, isPublic }) => {\n      if (hideWhenPublic && isPublic) {\n        return undefined\n      }\n      const ctor = error.constructor as typeof Error0\n      if (ctor.is(value)) {\n        return ctor.serialize(value, isPublic)\n      }\n      return undefined\n    },\n  })\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,eAAuB;AAEhB,MAAM,uBAAuB,CAAC,EAAE,iBAAiB,KAAK,IAAkC,CAAC,MAC9F,gBAAO,OAAO,EAAE,MAAM;AAAA,EACpB,WAAW,CAAC,EAAE,OAAO,OAAO,SAAS,MAAM;AACzC,QAAI,kBAAkB,UAAU;AAC9B,aAAO;AAAA,IACT;AACA,UAAM,OAAO,MAAM;AACnB,QAAI,KAAK,GAAG,KAAK,GAAG;AAClB,aAAO,KAAK,UAAU,OAAO,QAAQ;AAAA,IACvC;AACA,WAAO;AAAA,EACT;AACF,CAAC;","names":[]}

package/dist/cjs/plugins/cause-serialize.d.cts

@@ -1,7 +0,0 @@
-import { PluginError0 } from '../index.cjs';
-
-declare const causeSerializePlugin: ({ hideWhenPublic }?: {
-    hideWhenPublic?: boolean;
-}) => PluginError0<Record<never, never>, Record<never, never>>;
-
-export { causeSerializePlugin };

package/dist/esm/plugins/cause-serialize.d.ts

@@ -1,7 +0,0 @@
-import { PluginError0 } from '../index.js';
-
-declare const causeSerializePlugin: ({ hideWhenPublic }?: {
-    hideWhenPublic?: boolean;
-}) => PluginError0<Record<never, never>, Record<never, never>>;
-
-export { causeSerializePlugin };

package/dist/esm/plugins/cause-serialize.js

@@ -1,17 +0,0 @@
-import { Error0 } from "../index.js";
-const causeSerializePlugin = ({ hideWhenPublic = true } = {}) => Error0.plugin().cause({
-  serialize: ({ value, error, isPublic }) => {
-    if (hideWhenPublic && isPublic) {
-      return void 0;
-    }
-    const ctor = error.constructor;
-    if (ctor.is(value)) {
-      return ctor.serialize(value, isPublic);
-    }
-    return void 0;
-  }
-});
-export {
-  causeSerializePlugin
-};
-//# sourceMappingURL=cause-serialize.js.map

package/dist/esm/plugins/cause-serialize.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/plugins/cause-serialize.ts"],"sourcesContent":["import { Error0 } from '../index.js'\n\nexport const causeSerializePlugin = ({ hideWhenPublic = true }: { hideWhenPublic?: boolean } = {}) =>\n  Error0.plugin().cause({\n    serialize: ({ value, error, isPublic }) => {\n      if (hideWhenPublic && isPublic) {\n        return undefined\n      }\n      const ctor = error.constructor as typeof Error0\n      if (ctor.is(value)) {\n        return ctor.serialize(value, isPublic)\n      }\n      return undefined\n    },\n  })\n"],"mappings":"AAAA,SAAS,cAAc;AAEhB,MAAM,uBAAuB,CAAC,EAAE,iBAAiB,KAAK,IAAkC,CAAC,MAC9F,OAAO,OAAO,EAAE,MAAM;AAAA,EACpB,WAAW,CAAC,EAAE,OAAO,OAAO,SAAS,MAAM;AACzC,QAAI,kBAAkB,UAAU;AAC9B,aAAO;AAAA,IACT;AACA,UAAM,OAAO,MAAM;AACnB,QAAI,KAAK,GAAG,KAAK,GAAG;AAClB,aAAO,KAAK,UAAU,OAAO,QAAQ;AAAA,IACvC;AACA,WAAO;AAAA,EACT;AACF,CAAC;","names":[]}

package/src/plugins/cause-serialize.ts

@@ -1,15 +0,0 @@
-import { Error0 } from '../index.js'
-
-export const causeSerializePlugin = ({ hideWhenPublic = true }: { hideWhenPublic?: boolean } = {}) =>
-  Error0.plugin().cause({
-    serialize: ({ value, error, isPublic }) => {
-      if (hideWhenPublic && isPublic) {
-        return undefined
-      }
-      const ctor = error.constructor as typeof Error0
-      if (ctor.is(value)) {
-        return ctor.serialize(value, isPublic)
-      }
-      return undefined
-    },
-  })