@lowerdeck/error 1.0.7 → 1.0.9

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "@lowerdeck/error",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "src/**",
+    "dist/**",
+    "README.md",
+    "package.json"
+  ],
   "author": "Tobias Herber",
   "license": "Apache 2",
   "type": "module",
@@ -21,15 +27,15 @@
   "scripts": {
     "test": "vitest run --passWithNoTests",
     "lint": "prettier src/**/*.ts --check",
-    "build": "microbundle"
+    "build": "rm -rf ./dist && microbundle"
   },
   "dependencies": {
-    "@lowerdeck/case": "^1.0.8",
-    "@lowerdeck/validation": "^1.0.3"
+    "@lowerdeck/case": "^1.0.9",
+    "@lowerdeck/validation": "^1.0.4"
   },
   "devDependencies": {
     "microbundle": "^0.15.1",
-    "@lowerdeck/tsconfig": "^1.0.0",
+    "@lowerdeck/tsconfig": "^1.0.1",
     "typescript": "5.8.2",
     "vitest": "^3.1.2"
   }

package/src/defaultErrors.ts

@@ -25,7 +25,9 @@ export let badRequestError = createError({
   message: 'The request is invalid.'
 });
 
-export function notFoundError(p1: { entity: string; id?: string } & Partial<ErrorData<'not_found', 404>>): ReturnType<typeof createError>;
+export function notFoundError(
+  p1: { entity: string; id?: string } & Partial<ErrorData<'not_found', 404>>
+): ReturnType<typeof createError>;
 export function notFoundError(p1: string, p2?: string | null): ReturnType<typeof createError>;
 export function notFoundError(p1: any, p2?: any): ReturnType<typeof createError> {
   let entity = typeof p1 == 'string' ? p1 : p1.entity;

package/src/error.test.ts

@@ -20,7 +20,7 @@ describe('createError', () => {
     };
     let errorRecord = createError(data);
     let response = errorRecord.toResponse();
-    expect(response).toEqual({ ...data, __typename: 'error', ok: false });
+    expect(response).toEqual({ ...data, object: 'error', ok: false });
   });
 
   test('should create an error record with a response function that can be extended', () => {
@@ -33,7 +33,7 @@ describe('createError', () => {
     let response = errorRecord({ hint: 'This is a hint' }).toResponse();
     expect(response).toEqual({
       ...data,
-      __typename: 'error',
+      object: 'error',
       ok: false,
       hint: 'This is a hint'
     });
@@ -69,6 +69,6 @@ describe('ServiceError', () => {
     });
     let apiError = new ServiceError(errorRecord);
     let response = apiError.toResponse();
-    expect(response).toEqual({ ...errorRecord.data, __typename: 'error', ok: false });
+    expect(response).toEqual({ ...errorRecord.data, object: 'error', ok: false });
   });
 });

package/src/error.ts

@@ -8,31 +8,39 @@ export interface ErrorData<Code extends string, Status extends number> {
   [key: string]: any;
 }
 
+export type ErrorRecordExtension<Code extends string, Status extends number> = <
+  NewCode extends string = Code
+>(
+  extension?: Partial<ErrorData<NewCode, Status>>
+) => ErrorRecord<NewCode, Status>;
+
 export type ErrorRecord<Code extends string, Status extends number> = {
-  __typename: 'error';
+  object: 'error';
   data: ErrorData<Code, Status>;
-  toResponse: () => ErrorData<Code, Status> & { __typename: 'error'; ok: false };
-} & ((extension?: Partial<ErrorData<Code, Status>>) => ErrorRecord<Code, Status>);
+  toResponse: () => ErrorData<Code, Status> & { object: 'error'; ok: false };
+} & ErrorRecordExtension<Code, Status>;
 
 export let createError = <Code extends string, Status extends number>(
   data: ErrorData<Code, Status>
 ): ErrorRecord<Code, Status> => {
   return Object.assign(
-    (extension: Partial<ErrorData<Code, Status>> = {}): ErrorRecord<Code, Status> =>
+    <NewCode extends string = Code>(
+      extension: Partial<ErrorData<NewCode, Status>> = {}
+    ): ErrorRecord<NewCode, Status> =>
       createError({
         ...data,
         ...extension
-      }),
+      }) as any,
     {
-      __typename: 'error' as const,
+      object: 'error' as const,
       data,
-      toResponse: () => ({ __typename: 'error' as const, ok: false as const, ...data })
+      toResponse: () => ({ object: 'error' as const, ok: false as const, ...data })
     }
-  );
+  ) as any;
 };
 
 export class ServiceError<InnerError extends ErrorRecord<any, any>> extends Error {
-  __typename = 'ServiceError' as const;
+  object = 'ServiceError' as const;
 
   private _parent: Error | null = null;
 
@@ -60,12 +68,12 @@ export class ServiceError<InnerError extends ErrorRecord<any, any>> extends Erro
   static fromResponse(raw: ErrorData<any, any>) {
     let data = raw;
     delete data.ok;
-    delete data.__typename;
+    delete data.object;
 
     return new ServiceError(createError(data));
   }
 }
 
 export let isServiceError = (e: any): e is ServiceError<any> => {
-  return e?.__typename === 'ServiceError' || e?.__typename === 'ErrorRecord';
+  return e?.object === 'ServiceError' || e?.object === 'ErrorRecord';
 };

package/.turbo/turbo-build.log

@@ -1,12 +0,0 @@
-
-$ microbundle
-No name was provided for external module '@lowerdeck/case' in output.globals – guessing '_case'
-Build "@lowerdeck/error" to dist:
-      2.02 kB: index.cjs.gz
-      1.73 kB: index.cjs.br
-       1332 B: index.module.js.gz
-       1080 B: index.module.js.br
-      2.03 kB: index.module.js.gz
-      1.73 kB: index.module.js.br
-       2.1 kB: index.umd.js.gz
-      1.79 kB: index.umd.js.br

package/.turbo/turbo-test.log

@@ -1,21 +0,0 @@
-
-$ vitest run --passWithNoTests
-[?25l
- RUN  v3.2.4 /Users/tobias/code/metorial/metorial-enterprise/oss/src/packages/shared/error
-
-[?2026h
- ❯ src/defaultErrors.test.ts [queued]
-
- Test Files 0 passed (2)
-      Tests 0 passed (0)
-   Start at 10:23:43
-   Duration 101ms
-[?2026l ✓ src/error.test.ts (6 tests) 2ms
- ✓ src/defaultErrors.test.ts (1 test) 1ms
-
- Test Files  2 passed (2)
-      Tests  7 passed (7)
-   Start at  10:23:43
-   Duration  242ms (transform 57ms, setup 0ms, collect 75ms, tests 4ms, environment 0ms, prepare 83ms)
-
-[?25h

package/CHANGELOG.md

@@ -1,60 +0,0 @@
-# @lowerdeck/error
-
-## 1.0.7
-
-### Patch Changes
-
-- Fix default entry point
-- Updated dependencies
-  - @lowerdeck/validation@1.0.3
-  - @lowerdeck/case@1.0.8
-
-## 1.0.6
-
-### Patch Changes
-
-- update versions
-- Updated dependencies
-  - @lowerdeck/validation@1.0.2
-  - @lowerdeck/case@1.0.7
-
-## 1.0.5
-
-### Patch Changes
-
-- sync
-- Updated dependencies
-  - @lowerdeck/case@1.0.6
-
-## 1.0.4
-
-### Patch Changes
-
-- Fix dist
-- Updated dependencies
-  - @lowerdeck/case@1.0.5
-
-## 1.0.3
-
-### Patch Changes
-
-- Fix versions
-- Updated dependencies
-  - @lowerdeck/case@1.0.4
-
-## 1.0.2
-
-### Patch Changes
-
-- Update case
-- Updated dependencies
-  - @lowerdeck/case@1.0.3
-
-## 1.0.1
-
-### Patch Changes
-
-- Fix exports
-- Updated dependencies
-  - @lowerdeck/validation@1.0.1
-  - @lowerdeck/case@1.0.1

package/dist/index.modern.js

@@ -1,2 +0,0 @@
-import{Cases as e}from"@lowerdeck/case";function t(){return t=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var s=arguments[t];for(var r in s)({}).hasOwnProperty.call(s,r)&&(e[r]=s[r])}return e},t.apply(null,arguments)}let s=e=>Object.assign((r={})=>s(t({},e,r)),{__typename:"error",data:e,toResponse:()=>t({__typename:"error",ok:!1},e)});class r extends Error{get parent(){return this._parent}constructor(e){super(e.data.message),this.error=void 0,this.__typename="ServiceError",this._parent=null,this.error=e}setParent(e){return this._parent=e,this}get data(){return this.error.data}toResponse(){return this.error.toResponse()}static fromResponse(e){let t=e;return delete t.ok,delete t.__typename,new r(s(t))}}let o=e=>"ServiceError"===(null==e?void 0:e.__typename)||"ErrorRecord"===(null==e?void 0:e.__typename),a=e=>s(t({status:400,code:"invalid_data",message:"The provided data is invalid.",hint:"Make sure the data you are sending follows the specification outlined in the documentation."},e)),n=s({status:500,code:"internal_server_error",message:"An internal server error occurred."}),i=s({status:400,code:"bad_request",message:"The request is invalid."});function d(r,o){let a="string"==typeof r?r:r.entity,n="string"==typeof r?o:r.id;return s(t({status:404,code:"not_found",message:`The requested ${e.toKebabCase(a)} could not be found.`,hint:"Make sure the resource you are trying to access exists, that you have access to it and that it has not been deleted.",entity:a,id:null!=n?n:void 0},"string"==typeof r?{}:r))}let u=s({status:401,code:"unauthorized",message:"You are not authorized to access this resource.",hint:"Make sure you are logged in and have the correct permissions to access this resource."}),c=s({status:403,code:"forbidden",message:"You do not have permission to access this resource."}),l=s({status:400,code:"invalid_version",message:"The endpoint does not support the requested version."}),h=s({status:409,code:"conflict",message:"A similar resource already exists."}),m=s({status:410,code:"gone",message:"The requested resource is no longer available."}),p=s({status:402,code:"payment_required",message:"Payment is required to access this resource."}),g=s({status:412,code:"precondition_failed",message:"The precondition of the request failed."}),_=s({status:406,code:"not_acceptable",message:"The requested resource is not acceptable."}),y=s({status:501,code:"not_implemented",message:"The requested resource is not implemented."}),v=s({status:429,code:"too_many_requests",message:"You have made too many requests in a short period of time.",hint:"Please wait a moment and try again."}),f=s({status:504,code:"timeout",message:"The request timed out."}),q=s({status:405,code:"method_not_allowed",message:"The requested method is not allowed for this resource."});export{r as ServiceError,i as badRequestError,h as conflictError,s as createError,c as forbiddenError,m as goneError,n as internalServerError,l as invalidVersion,o as isServiceError,q as methodNotAllowedError,_ as notAcceptableError,d as notFoundError,y as notImplementedError,p as paymentRequiredError,g as preconditionFailedError,f as timeoutError,v as tooManyRequestsError,u as unauthorizedError,a as validationError};
-//# sourceMappingURL=index.modern.js.map

package/dist/index.modern.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.modern.js","sources":["../src/error.ts","../src/defaultErrors.ts"],"sourcesContent":["export interface ErrorData<Code extends string, Status extends number> {\n  status: Status;\n  code: Code;\n  message: string;\n  hint?: string;\n  description?: string;\n  reason?: string;\n  [key: string]: any;\n}\n\nexport type ErrorRecord<Code extends string, Status extends number> = {\n  __typename: 'error';\n  data: ErrorData<Code, Status>;\n  toResponse: () => ErrorData<Code, Status> & { __typename: 'error'; ok: false };\n} & ((extension?: Partial<ErrorData<Code, Status>>) => ErrorRecord<Code, Status>);\n\nexport let createError = <Code extends string, Status extends number>(\n  data: ErrorData<Code, Status>\n): ErrorRecord<Code, Status> => {\n  return Object.assign(\n    (extension: Partial<ErrorData<Code, Status>> = {}): ErrorRecord<Code, Status> =>\n      createError({\n        ...data,\n        ...extension\n      }),\n    {\n      __typename: 'error' as const,\n      data,\n      toResponse: () => ({ __typename: 'error' as const, ok: false as const, ...data })\n    }\n  );\n};\n\nexport class ServiceError<InnerError extends ErrorRecord<any, any>> extends Error {\n  __typename = 'ServiceError' as const;\n\n  private _parent: Error | null = null;\n\n  public get parent() {\n    return this._parent;\n  }\n\n  constructor(private readonly error: InnerError) {\n    super(error.data.message);\n  }\n\n  setParent(parent: Error) {\n    this._parent = parent;\n    return this;\n  }\n\n  get data() {\n    return this.error.data;\n  }\n\n  toResponse() {\n    return this.error.toResponse();\n  }\n\n  static fromResponse(raw: ErrorData<any, any>) {\n    let data = raw;\n    delete data.ok;\n    delete data.__typename;\n\n    return new ServiceError(createError(data));\n  }\n}\n\nexport let isServiceError = (e: any): e is ServiceError<any> => {\n  return e?.__typename === 'ServiceError' || e?.__typename === 'ErrorRecord';\n};\n","import { Cases } from '@lowerdeck/case';\nimport { ValidationError } from '@lowerdeck/validation';\nimport { ErrorData, createError } from './error';\n\nexport let validationError = (\n  d: { errors: ValidationError[]; entity: string } & Partial<ErrorData<'invalid_data', 400>>\n) =>\n  createError({\n    status: 400,\n    code: 'invalid_data',\n    message: 'The provided data is invalid.',\n    hint: 'Make sure the data you are sending follows the specification outlined in the documentation.',\n    ...d\n  });\n\nexport let internalServerError = createError({\n  status: 500,\n  code: 'internal_server_error',\n  message: 'An internal server error occurred.'\n});\n\nexport let badRequestError = createError({\n  status: 400,\n  code: 'bad_request',\n  message: 'The request is invalid.'\n});\n\nexport function notFoundError(p1: { entity: string; id?: string } & Partial<ErrorData<'not_found', 404>>): ReturnType<typeof createError>;\nexport function notFoundError(p1: string, p2?: string | null): ReturnType<typeof createError>;\nexport function notFoundError(p1: any, p2?: any): ReturnType<typeof createError> {\n  let entity = typeof p1 == 'string' ? p1 : p1.entity;\n  let id = typeof p1 == 'string' ? p2 : p1.id;\n\n  return createError({\n    status: 404,\n    code: 'not_found',\n    message: `The requested ${Cases.toKebabCase(entity)} could not be found.`,\n    hint: 'Make sure the resource you are trying to access exists, that you have access to it and that it has not been deleted.',\n    entity,\n    id: id ?? undefined,\n\n    ...(typeof p1 == 'string' ? {} : p1)\n  });\n}\n\nexport let unauthorizedError = createError({\n  status: 401,\n  code: 'unauthorized',\n  message: 'You are not authorized to access this resource.',\n  hint: 'Make sure you are logged in and have the correct permissions to access this resource.'\n});\n\nexport let forbiddenError = createError({\n  status: 403,\n  code: 'forbidden',\n  message: 'You do not have permission to access this resource.'\n});\n\nexport let invalidVersion = createError({\n  status: 400,\n  code: 'invalid_version',\n  message: 'The endpoint does not support the requested version.'\n});\n\nexport let conflictError = createError({\n  status: 409,\n  code: 'conflict',\n  message: 'A similar resource already exists.'\n});\n\nexport let goneError = createError({\n  status: 410,\n  code: 'gone',\n  message: 'The requested resource is no longer available.'\n});\n\nexport let paymentRequiredError = createError({\n  status: 402,\n  code: 'payment_required',\n  message: 'Payment is required to access this resource.'\n});\n\nexport let preconditionFailedError = createError({\n  status: 412,\n  code: 'precondition_failed',\n  message: 'The precondition of the request failed.'\n});\n\nexport let notAcceptableError = createError({\n  status: 406,\n  code: 'not_acceptable',\n  message: 'The requested resource is not acceptable.'\n});\n\nexport let notImplementedError = createError({\n  status: 501,\n  code: 'not_implemented',\n  message: 'The requested resource is not implemented.'\n});\n\nexport let tooManyRequestsError = createError({\n  status: 429,\n  code: 'too_many_requests',\n  message: 'You have made too many requests in a short period of time.',\n  hint: 'Please wait a moment and try again.'\n});\n\nexport let timeoutError = createError({\n  status: 504,\n  code: 'timeout',\n  message: 'The request timed out.'\n});\n\nexport let methodNotAllowedError = createError({\n  status: 405,\n  code: 'method_not_allowed',\n  message: 'The requested method is not allowed for this resource.'\n});\n"],"names":["createError","data","Object","assign","extension","_extends","__typename","toResponse","ok","ServiceError","Error","parent","this","_parent","constructor","error","super","message","setParent","fromResponse","raw","isServiceError","e","validationError","d","status","code","hint","internalServerError","badRequestError","notFoundError","p1","p2","entity","id","Cases","toKebabCase","undefined","unauthorizedError","forbiddenError","invalidVersion","conflictError","goneError","paymentRequiredError","preconditionFailedError","notAcceptableError","notImplementedError","tooManyRequestsError","timeoutError","methodNotAllowedError"],"mappings":"gQAgBW,IAAAA,EACTC,GAEOC,OAAOC,OACZ,CAACC,EAA8C,CAAA,IAC7CJ,EAAWK,EACNJ,CAAAA,EAAAA,EACAG,IAEP,CACEE,WAAY,QACZL,OACAM,WAAYA,IAAAF,EAAA,CAASC,WAAY,QAAkBE,IAAI,GAAmBP,WAKnEQ,UAA+DC,MAK1E,UAAWC,GACT,OAAWC,KAACC,OACd,CAEAC,WAAAA,CAA6BC,GAC3BC,MAAMD,EAAMd,KAAKgB,SAASL,KADCG,WAR7BT,EAAAA,KAAAA,WAAa,eAELO,KAAAA,QAAwB,KAMHD,KAAKG,MAALA,CAE7B,CAEAG,SAAAA,CAAUP,GAER,OADAC,KAAKC,QAAUF,EAEjBC,IAAA,CAEA,QAAIX,GACF,OAAOW,KAAKG,MAAMd,IACpB,CAEAM,UAAAA,GACE,OAAOK,KAAKG,MAAMR,YACpB,CAEA,mBAAOY,CAAaC,GAClB,IAAInB,EAAOmB,EAIX,cAHOnB,EAAKO,UACLP,EAAKK,WAEL,IAAIG,EAAaT,EAAYC,GACtC,EAGS,IAAAoB,EAAkBC,GACF,kBAAjB,MAADA,OAAC,EAADA,EAAGhB,aAAmD,iBAAjB,MAADgB,OAAC,EAADA,EAAGhB,YCjErCiB,EACTC,GAEAxB,EAAWK,GACToB,OAAQ,IACRC,KAAM,eACNT,QAAS,gCACTU,KAAM,+FACHH,IAGII,EAAsB5B,EAAY,CAC3CyB,OAAQ,IACRC,KAAM,wBACNT,QAAS,uCAGAY,EAAkB7B,EAAY,CACvCyB,OAAQ,IACRC,KAAM,cACNT,QAAS,4BAKK,SAAAa,EAAcC,EAASC,GACrC,IAAIC,EAAsB,iBAANF,EAAiBA,EAAKA,EAAGE,OACzCC,EAAkB,iBAANH,EAAiBC,EAAKD,EAAGG,GAEzC,OAAOlC,EAAWK,EAAA,CAChBoB,OAAQ,IACRC,KAAM,YACNT,QAAS,iBAAiBkB,EAAMC,YAAYH,yBAC5CN,KAAM,uHACNM,SACAC,SAAIA,EAAAA,OAAMG,GAEO,iBAANN,EAAiB,CAAE,EAAGA,GAErC,CAEW,IAAAO,EAAoBtC,EAAY,CACzCyB,OAAQ,IACRC,KAAM,eACNT,QAAS,kDACTU,KAAM,0FAGGY,EAAiBvC,EAAY,CACtCyB,OAAQ,IACRC,KAAM,YACNT,QAAS,wDAGAuB,EAAiBxC,EAAY,CACtCyB,OAAQ,IACRC,KAAM,kBACNT,QAAS,yDAGAwB,EAAgBzC,EAAY,CACrCyB,OAAQ,IACRC,KAAM,WACNT,QAAS,uCAGAyB,EAAY1C,EAAY,CACjCyB,OAAQ,IACRC,KAAM,OACNT,QAAS,mDAGA0B,EAAuB3C,EAAY,CAC5CyB,OAAQ,IACRC,KAAM,mBACNT,QAAS,iDAGA2B,EAA0B5C,EAAY,CAC/CyB,OAAQ,IACRC,KAAM,sBACNT,QAAS,4CAGA4B,EAAqB7C,EAAY,CAC1CyB,OAAQ,IACRC,KAAM,iBACNT,QAAS,8CAGA6B,EAAsB9C,EAAY,CAC3CyB,OAAQ,IACRC,KAAM,kBACNT,QAAS,+CAGA8B,EAAuB/C,EAAY,CAC5CyB,OAAQ,IACRC,KAAM,oBACNT,QAAS,6DACTU,KAAM,wCAGGqB,EAAehD,EAAY,CACpCyB,OAAQ,IACRC,KAAM,UACNT,QAAS,2BAGAgC,EAAwBjD,EAAY,CAC7CyB,OAAQ,IACRC,KAAM,qBACNT,QAAS"}

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "@lowerdeck/tsconfig/base.json",
-  "exclude": ["dist"],
-  "include": ["src"],
-  "compilerOptions": {
-    "outDir": "dist",
-    "lib": ["es2021"],
-    "target": "ES2019"
-  }
-}